fastlane-plugin-patch 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e43a5073e5e6f001a9bac1edc8d5c01269365664
-  data.tar.gz: 6a43c19f97495874c41cf06267c9090305e4fe89
+  metadata.gz: d6f15eb1e0e061b321516b1b0e2d10078fdc9862
+  data.tar.gz: 937b14b6afd6fa88b64bfe0cdf8a8d34399eea51
 SHA512:
-  metadata.gz: d693bb861b0a1d6ccf36acac47d7068a5f6c8093deb6e100fcd5b18c2dd98bb21c055eabc12ad9b5ac28e695ef8b8c533b736a7a2a911351e0904f5835d1cb4b
-  data.tar.gz: 006cc262c53603c6c2411e3197354e75792dcb4518474c6b43f245be10b697ea5f5835b0f3fea57964be6c687a0e87c30dfbb6592becdef6299dd8af5ff701db
+  metadata.gz: df39ffa6eb89432594b8ca3f1cc711aa50a8f1b5b51ea017d66be7d7578097ae4de76118b32b4a2b431038e046a03a44d0e686465d254c9599c1a2fe1b64b4ac
+  data.tar.gz: 407a273c955a255c4073a49e29b3aeadf47a62e665c5c7bfee6f53a07813159f8ff3f5e1610c79362f410e66034aa530b9a1bffdbd9d0c4e4123d144e131000f

data/README.md

@@ -24,10 +24,10 @@ when automatically integrating an SDK.
 
 Please provide any feedback via issues in this repo.
 
-### apply_patch action
+### patch action
 
 ```Ruby
-apply_patch(
+patch(
   files: "examples/PatchTestAndroid/app/src/main/AndroidManifest.xml",
   regexp: %r{^\s*</application>},
   mode: :prepend,
@@ -54,7 +54,7 @@ global: false
 
 **Fastfile**:
 ```Ruby
-apply_patch(
+patch(
   files: "examples/PatchTestAndroid/app/src/main/AndroidManifest.xml",
   patch: "patch.yaml"
 )
@@ -65,7 +65,7 @@ apply_patch(
 Capture groups may be used in `:replace` mode.
 
 ```Ruby
-apply_patch(
+patch(
   files: "MyPod.podspec",
   regexp: /(s.name\s*=\s*)"MyPod"/,
   text: '\1"MyOtherPod"',
@@ -73,23 +73,25 @@ apply_patch(
 )
 ```
 
-### revert_patch action
+#### Revert patches
 
-Revert patches by passing the same arguments to the `revert_patch` action:
+Revert patches by passing the optional `:revert` parameter:
 
 ```Ruby
-revert_patch(
+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"
+  text: "        <meta-data android:name=\"foo\" android:value=\"bar\" />\n",
+  revert: true
 )
 ```
 
 ```Ruby
-revert_patch(
+patch(
   files: "examples/PatchTestAndroid/app/src/main/AndroidManifest.xml",
   patch: "patch.yaml"
+  revert: true
 )
 ```
 
@@ -106,10 +108,14 @@ Patches using the `:replace` mode cannot be reverted.
 |:mode|:append, :prepend or :replace|Symbol|yes|:append|
 |:offset|Offset from which to start matching|Integer|yes|0|
 |:patch|A YAML file specifying patch data|String|yes| |
+|:revert|Set to true to revert the specified patch rather than apply it|Boolean|yes|false|
 
 The :regexp and :text options must be set either in a patch file specified using the
 :patch argument or via arguments in the Fastfile.
 
+**Note**: The `apply_patch` and `revert_patch` actions have been deprecated in favor of a single
+`patch` action with an optional `:revert` parameter.
+
 ## Example
 
 Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin. Try it by cloning the repo, and running `fastlane install_plugins`.

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

@@ -122,6 +122,16 @@ YAML files. Revert the same patches with the revert_patch action.
       def self.is_supported?(platform)
         true
       end
+
+      def self.deprecated_notes
+        <<-EOF
+Please use the patch action instead.
+        EOF
+      end
+
+      def self.category
+        :deprecated
+      end
     end
   end
 end

data/lib/fastlane/plugin/patch/actions/patch_action.rb

@@ -0,0 +1,153 @@
+require 'yaml'
+
+module Fastlane
+  module Actions
+    class PatchAction < Action
+      def self.run(params)
+        if params[:patch]
+          # raises
+          patch = YAML.load_file params[:patch]
+
+          # If the :patch option is present, load these params from the
+          # specified file. Action args override.
+          %w{regexp text mode global}.each do |option|
+            value = patch[option]
+            next if value.nil?
+
+            case option.to_sym
+            when :regexp
+              params[:regexp] = /#{value}/
+            when :mode
+              params[:mode] = value.to_sym
+            else
+              params[option.to_sym] = value
+            end
+          end
+        end
+
+        UI.user_error! "Must specify :regexp and :text either in a patch or via arguments" if
+          params[:regexp].nil? || params[:text].nil?
+
+        helper = Helper::PatchHelper
+        files = helper.files_from_params params
+        UI.user_error! "Must specify at least one file to patch using the :files option" if files.empty?
+
+        files.each do |file|
+          modified_contents = File.open(file, "r") do |f|
+            if params[:revert]
+              helper.revert_patch f.read,
+                                  params[:regexp],
+                                  params[:text],
+                                  params[:global],
+                                  params[:mode],
+                                  params[:offset]
+            else
+              helper.apply_patch f.read,
+                                 params[:regexp],
+                                 params[:text],
+                                 params[:global],
+                                 params[:mode],
+                                 params[:offset]
+            end
+          end
+
+          File.open(file, "w") { |f| f.write modified_contents }
+        end
+      rescue => e
+        UI.user_error! "Error in PatchAction: #{e.message}\n#{e.backtrace}"
+      end
+
+      def self.description
+        "Apply pattern-based patches to any text file."
+      end
+
+      def self.authors
+        ["Jimmy Dee"]
+      end
+
+      def self.details
+        <<-EOF
+Append or prepend text to a specified pattern in a list of files or
+replace it, once or globally. Patches are specified by arguments or
+YAML files. Revert the same patches with the revert option.
+        EOF
+      end
+
+      def self.example_code
+        [
+          <<-EOF
+            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"
+            )
+          EOF,
+          <<-EOF
+            patch(
+              files: "examples/PatchTestAndroid/app/src/main/AndroidManifest.xml",
+              patch: "patch.yaml"
+            )
+          EOF,
+          <<-EOF
+            patch(
+              files: "examples/PatchTestAndroid/app/src/main/AndroidManifest.xml",
+              patch: "patch.yaml",
+              revert: true
+            )
+          EOF
+
+        ]
+      end
+
+      def self.available_options
+        [
+          FastlaneCore::ConfigItem.new(key: :files,
+                               description: "Absolute or relative path(s) to one or more files to patch",
+                                  optional: false,
+                                 is_string: false),
+          FastlaneCore::ConfigItem.new(key: :regexp,
+                               description: "A regular expression to match",
+                                  optional: true,
+                                      type: Regexp),
+          FastlaneCore::ConfigItem.new(key: :text,
+                               description: "Text used to modify to the match",
+                                  optional: true,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :global,
+                               description: "If true, patch all occurrences of the pattern",
+                                  optional: true,
+                             default_value: false,
+                                 is_string: false),
+          FastlaneCore::ConfigItem.new(key: :offset,
+                               description: "Offset from which to start matching",
+                                  optional: true,
+                             default_value: 0,
+                                      type: Integer),
+          FastlaneCore::ConfigItem.new(key: :mode,
+                               description: ":append, :prepend or :replace",
+                                  optional: true,
+                             default_value: :append,
+                                      type: Symbol),
+          FastlaneCore::ConfigItem.new(key: :patch,
+                               description: "A YAML file specifying patch data",
+                                  optional: true,
+                                      type: String),
+          FastlaneCore::ConfigItem.new(key: :revert,
+                               description: "Set to true to revert the specified patch rather than apply it",
+                                  optional: true,
+                             default_value: false,
+                                 is_string: false)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+
+      def self.category
+        :project
+      end
+    end
+  end
+end

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

@@ -121,6 +121,16 @@ using arguments or the same YAML patch files.
       def self.is_supported?(platform)
         true
       end
+
+      def self.deprecated_notes
+        <<-EOF
+Please use the patch action with the :revert option instead.
+        EOF
+      end
+
+      def self.category
+        :deprecated
+      end
     end
   end
 end

data/lib/fastlane/plugin/patch/version.rb

@@ -1,5 +1,5 @@
 module Fastlane
   module Patch
-    VERSION = "0.2.0"
+    VERSION = "0.3.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fastlane-plugin-patch
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Jimmy Dee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-12 00:00:00.000000000 Z
+date: 2017-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -132,6 +132,7 @@ files:
 - README.md
 - lib/fastlane/plugin/patch.rb
 - lib/fastlane/plugin/patch/actions/apply_patch_action.rb
+- lib/fastlane/plugin/patch/actions/patch_action.rb
 - lib/fastlane/plugin/patch/actions/revert_patch_action.rb
 - lib/fastlane/plugin/patch/helper/patch_helper.rb
 - lib/fastlane/plugin/patch/version.rb
@@ -155,7 +156,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Apply and revert pattern-based patches to any text file.