Finish PatchHelper specs and update README

Author: jdee

README.md

@@ -14,13 +14,21 @@ fastlane add_plugin patch
 
 Apply and revert pattern-based patches to any text file.
 
+This is a very preliminary plugin to apply and revert patches to text files. One
+of the main intended use cases for this plugin is source-code modification, e.g.
+when automatically integrating an SDK.
+
+Please provide any feedback via issues in this repo.
+
 ### apply_patch action
 
 ```Ruby
-apply_patch files: "examples/PatchTestAndroid/app/src/main/AndroidManifest.xml",
-            regexp: %r{^\s*</application>},
-            mode: :prepend,
-            text: "        <meta-data android:name=\"foo\" android:value=\"bar\" />\n"
+apply_patch(
+  files: "examples/PatchTestAndroid/app/src/main/AndroidManifest.xml",
+  regexp: %r{^\s*</application>},
+  mode: :prepend,
+  text: "        <meta-data android:name=\"foo\" android:value=\"bar\" />\n"
+)
 ```
 
 This action matches one or all occurrences of a specified regular expression and
@@ -42,24 +50,30 @@ global: false
 
 **Fastfile**:
 ```Ruby
-apply_patch files: "examples/PatchTestAndroid/app/src/main/AndroidManifest.xml",
-            patch: "patch.yaml"
+apply_patch(
+  files: "examples/PatchTestAndroid/app/src/main/AndroidManifest.xml",
+  patch: "patch.yaml"
+)
 ```
 
 ### revert_patch action
 
 Revert patches by passing the same arguments to the `revert_patch` action:
 
 ```Ruby
-revert_patch files: "examples/PatchTestAndroid/app/src/main/AndroidManifest.xml",
-             regexp: %r{^\s*</application>},
-             mode: :prepend,
-             text: "        <meta-data android:name=\"foo\" android:value=\"bar\" />\n"
+revert_patch(
+  files: "examples/PatchTestAndroid/app/src/main/AndroidManifest.xml",
+  regexp: %r{^\s*</application>},
+  mode: :prepend,
+  text: "        <meta-data android:name=\"foo\" android:value=\"bar\" />\n"
+)
 ```
 
 ```Ruby
-revert_patch files: "examples/PatchTestAndroid/app/src/main/AndroidManifest.xml",
-             patch: "patch.yaml"
+revert_patch(
+  files: "examples/PatchTestAndroid/app/src/main/AndroidManifest.xml",
+  patch: "patch.yaml"
+)
 ```
 
 Patches using the `:replace` mode cannot be reverted.

lib/fastlane/plugin/patch/actions/apply_patch_action.rb

@@ -31,8 +31,7 @@ def self.run(params)
         helper = Fastlane::Helper::PatchHelper
         helper.files_from_params(params).each do |file|
           modified_contents = File.open(file, "r") do |f|
-            contents = f.read
-            helper.apply_patch contents,
+            helper.apply_patch f.read,
                                params[:regexp],
                                params[:text],
                                params[:global],
@@ -54,13 +53,12 @@ def self.authors
         ["Jimmy Dee"]
       end
 
-      def self.return_value
-        # If your method provides a return value, you can describe here what it does
-      end
-
       def self.details
-        # Optional:
-        "More to come"
+        <<-EOF
+          This is a very preliminary plugin to apply and revert patches to text files. One
+          of the main intended use cases for this plugin is source-code modification, e.g.
+          when automatically integrating an SDK.
+        EOF
       end
 
       def self.available_options
@@ -74,7 +72,7 @@ def self.available_options
                                   optional: true,
                                       type: Regexp),
           FastlaneCore::ConfigItem.new(key: :text,
-                               description: "Text to append to the match",
+                               description: "Text used to modify to the match",
                                   optional: true,
                                       type: String),
           FastlaneCore::ConfigItem.new(key: :global,
@@ -100,10 +98,6 @@ def self.available_options
       end
 
       def self.is_supported?(platform)
-        # Adjust this if your plugin only works for a particular platform (iOS vs. Android, for example)
-        # See: https://github.com/fastlane/fastlane/blob/master/fastlane/docs/Platforms.md
-        #
-        # [:ios, :mac, :android].include?(platform)
         true
       end
     end

lib/fastlane/plugin/patch/actions/revert_patch_action.rb

@@ -31,8 +31,7 @@ def self.run(params)
         helper = Fastlane::Helper::PatchHelper
         helper.files_from_params(params).each do |file|
           modified_contents = File.open(file, "r") do |f|
-            contents = f.read
-            helper.revert_patch contents,
+            helper.revert_patch f.read,
                                 params[:regexp],
                                 params[:text],
                                 params[:global],
@@ -54,13 +53,12 @@ def self.authors
         ["Jimmy Dee"]
       end
 
-      def self.return_value
-        # If your method provides a return value, you can describe here what it does
-      end
-
       def self.details
-        # Optional:
-        "More to come"
+        <<-EOF
+          This is a very preliminary plugin to apply and revert patches to text files. One
+          of the main intended use cases for this plugin is source-code modification, e.g.
+          when automatically integrating an SDK.
+        EOF
       end
 
       def self.available_options
@@ -74,7 +72,7 @@ def self.available_options
                                   optional: true,
                                       type: Regexp),
           FastlaneCore::ConfigItem.new(key: :text,
-                               description: "Text to append to the match",
+                               description: "Text used to modify to the match",
                                   optional: true,
                                       type: String),
           FastlaneCore::ConfigItem.new(key: :global,
@@ -100,10 +98,6 @@ def self.available_options
       end
 
       def self.is_supported?(platform)
-        # Adjust this if your plugin only works for a particular platform (iOS vs. Android, for example)
-        # See: https://github.com/fastlane/fastlane/blob/master/fastlane/docs/Platforms.md
-        #
-        # [:ios, :mac, :android].include?(platform)
         true
       end
     end

lib/fastlane/plugin/patch/helper/patch_helper.rb

@@ -75,7 +75,7 @@ def files_from_params(params)
           when String
             params[:files].split(",")
           else
-            raise ArgumentError "Invalid type #{params[:files].class} for :files option. Specify an Array or a String."
+            raise ArgumentError, "Invalid type #{params[:files].class} for :files option. Specify an Array or a String."
           end
         end
       end

spec/patch_helper_spec.rb

@@ -108,4 +108,20 @@
       end
     end
   end
+
+  describe 'files_from_params' do
+    it 'returns an array of strings when an array is passed' do
+      expect(helper.files_from_params(files: [:a, :b, :c])).to eq %w{a b c}
+    end
+
+    it 'splits at commas when a string is passed' do
+      expect(helper.files_from_params(files: 'a,b,c')).to eq %w{a b c}
+    end
+
+    it 'raises for any other type' do
+      expect do
+        helper.files_from_params(files: true)
+      end.to raise_error ArgumentError
+    end
+  end
 end