fastlane-plugin-patch 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5a9f0ea20fda14d47e1b04015ebc7048990beca0
+  data.tar.gz: 9f044357df62f527a53cf2c48451e3050d6faa9a
+SHA512:
+  metadata.gz: dfe86d539223d6a2e65724b1bd1d70566b978abae84f5820e7c0352178a937f1eaf2761402b33bbafc5345b54153315f9bc433720b90d5a9ab1cd50ad9f1e8ce
+  data.tar.gz: 12c460257e0c22777678fb6e8637d6cf27a5805f1e46241167136fb8af01434b73332d22854b033e20bd56a29a4b020b16e6a950bbd0bce9a348060568276ede

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Jimmy Dee <jgvdthree@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,145 @@
+# patch plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-patch)
+[![Gem](https://img.shields.io/gem/v/fastlane-plugin-patch.svg?style=flat)](https://rubygems.org/gems/fastlane-plugin-patch)
+[![Downloads](https://img.shields.io/gem/dt/fastlane-plugin-patch.svg?style=flat)](https://rubygems.org/gems/fastlane-plugin-patch)
+[![License](https://img.shields.io/badge/license-MIT-green.svg?style=flat)](https://github.com/jdee/fastlane-plugin-patch/blob/master/LICENSE)
+[![CircleCI](https://img.shields.io/circleci/project/github/jdee/fastlane-plugin-patch.svg)](https://circleci.com/gh/jdee/fastlane-plugin-patch)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-patch`, add it to your project by running:
+
+```bash
+fastlane add_plugin patch
+```
+
+## About 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"
+)
+```
+
+This action matches one or all occurrences of a specified regular expression and
+modifies the file contents based on the optional `:mode` parameter. By default,
+the action appends the specified text to the pattern match. It can also prepend
+the text or replace the pattern match with the text. Use an optional `:global`
+parameter to apply the patch to all instances of the regular expression.
+
+The `regexp`, `text`, `mode` and `global` options may be specified in a YAML file to
+define a patch, e.g.:
+
+**patch.yaml**:
+```yaml
+regexp: '^\s*</application>'
+mode: prepend
+text: "        <meta-data android:name='foo' android:value='bar' />\n"
+global: false
+```
+
+**Fastfile**:
+```Ruby
+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"
+)
+```
+
+```Ruby
+revert_patch(
+  files: "examples/PatchTestAndroid/app/src/main/AndroidManifest.xml",
+  patch: "patch.yaml"
+)
+```
+
+Patches using the `:replace` mode cannot be reverted.
+
+### Options
+
+|key|description|type|optional|default value|
+|---|-----------|----|--------|-------------|
+|:files|Absolute or relative path(s) to one or more files to patch|Array or String|no| |
+|:regexp|A regular expression to match|Regexp|yes| |
+|:text|Text to append to the match|String|yes| |
+|:global|If true, patch all occurrences of the pattern|Boolean|yes|false|
+|: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| |
+
+The :regexp and :text options must be set either in a patch file specified using the
+:patch argument or via arguments in the Fastfile.
+
+## 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`.
+
+The examples folder contains an empty Android project called PatchTestAndroid. There is an example
+patch at the repo root in `patch.yaml` that will add a `meta-data` key to the end of the `application`
+element in the Android project's manifest. The Fastfile includes two lanes: `apply` and `revert`.
+
+Apply the patch to `examples/PatchTestAndroid/app/src/main/AndroidManifest.xml`:
+```bash
+fastlane apply
+```
+
+Revert the patch:
+```bash
+fastlane revert
+```
+
+## Run tests for this plugin
+
+To run both the tests, and code style validation, run
+
+```
+rake
+```
+
+To automatically fix many of the styling issues, use
+```
+rubocop -a
+```
+
+## Issues and Feedback
+
+For any other issues and feedback about this plugin, please submit it to this repository.
+
+## Troubleshooting
+
+If you have trouble using plugins, check out the [Plugins Troubleshooting](https://docs.fastlane.tools/plugins/plugins-troubleshooting/) guide.
+
+## Using _fastlane_ Plugins
+
+For more information about how the `fastlane` plugin system works, check out the [Plugins documentation](https://docs.fastlane.tools/plugins/create-plugin/).
+
+## About _fastlane_
+
+_fastlane_ is the easiest way to automate beta deployments and releases for your iOS and Android apps. To learn more, check out [fastlane.tools](https://fastlane.tools).

data/lib/fastlane/plugin/patch.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/patch/version'
+
+module Fastlane
+  module Patch
+    # Return all .rb files inside the "actions" and "helper" directory
+    def self.all_classes
+      Dir[File.expand_path('**/{actions,helper}/*.rb', File.dirname(__FILE__))]
+    end
+  end
+end
+
+# By default we want to import all available actions and helpers
+# A plugin can contain any number of actions and plugins
+Fastlane::Patch.all_classes.each do |current|
+  require current
+end

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

@@ -0,0 +1,124 @@
+require 'yaml'
+
+module Fastlane
+  module Actions
+    class ApplyPatchAction < 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 = Fastlane::Helper::PatchHelper
+        helper.files_from_params(params).each do |file|
+          modified_contents = File.open(file, "r") do |f|
+            helper.apply_patch f.read,
+                               params[:regexp],
+                               params[:text],
+                               params[:global],
+                               params[:mode],
+                               params[:offset]
+          end
+
+          File.open(file, "w") { |f| f.write modified_contents }
+        end
+      rescue => e
+        UI.user_error! "Error in ApplyPatchAction: #{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_patch action.
+        EOF
+      end
+
+      def self.example_code
+        [
+          <<-EOF
+            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"
+            )
+          EOF,
+          <<-EOF
+            apply_patch(
+              files: "examples/PatchTestAndroid/app/src/main/AndroidManifest.xml",
+              patch: "patch.yaml"
+            )
+          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)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

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

@@ -0,0 +1,123 @@
+require 'yaml'
+
+module Fastlane
+  module Actions
+    class RevertPatchAction < 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 = Fastlane::Helper::PatchHelper
+        helper.files_from_params(params).each do |file|
+          modified_contents = File.open(file, "r") do |f|
+            helper.revert_patch f.read,
+                                params[:regexp],
+                                params[:text],
+                                params[:global],
+                                params[:mode],
+                                params[:offset]
+          end
+
+          File.open(file, "w") { |f| f.write modified_contents }
+        end
+      rescue => e
+        UI.user_error! "Error in RevertPatchAction: #{e.message}\n#{e.backtrace}"
+      end
+
+      def self.description
+        "Revert the action of apply_patch"
+      end
+
+      def self.authors
+        ["Jimmy Dee"]
+      end
+
+      def self.details
+        <<-EOF
+          Revert a patch by specifying the arguments provided to apply_patch
+          using arguments or the same YAML patch files.
+        EOF
+      end
+
+      def self.example_code
+        [
+          <<-EOF
+            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"
+            )
+          EOF,
+          <<-EOF
+            revert_patch(
+              files: "examples/PatchTestAndroid/app/src/main/AndroidManifest.xml",
+              patch: "patch.yaml"
+            )
+          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 or :prepend",
+                                  optional: true,
+                             default_value: :append,
+                                      type: Symbol),
+          FastlaneCore::ConfigItem.new(key: :patch,
+                               description: "A YAML file specifying patch data",
+                                  optional: true,
+                                      type: String)
+        ]
+      end
+
+      def self.is_supported?(platform)
+        true
+      end
+    end
+  end
+end

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

@@ -0,0 +1,84 @@
+module Fastlane
+  module Helper
+    class PatchHelper
+      class << self
+        # Add the specified text after the specified pattern.
+        # Returns a modified copy of the string.
+        #
+        # :contents: A string to modify, e.g. the contents of a file
+        # :regexp: A regular expression specifying a pattern to be matched
+        # :text: Text to be appended to the specified pattern
+        # :global: Boolean flag. If true, patch all occurrences of the regex.
+        # :mode: :append, :prepend or :replace to specify how to apply the patch
+        # :offset: Starting position for matching
+        def apply_patch(contents, regexp, text, global, mode, offset)
+          search_position = offset
+          while (matches = regexp.match(contents, search_position))
+            patched_pattern =
+              case mode
+              when :append
+                "#{matches[0]}#{text}"
+              when :prepend
+                "#{text}#{matches[0]}"
+              when :replace
+                text
+              else
+                raise ArgumentError, "Invalid mode argument. Specify :append, :prepend or :replace."
+              end
+
+            contents = "#{matches.pre_match}#{patched_pattern}#{matches.post_match}"
+            search_position = matches.pre_match.length + patched_pattern.length
+            break unless global
+          end
+          contents
+        end
+
+        # Reverts a patch. Use the same arguments that were supplied to apply_patch.
+        # The mode argument can only be :append or :prepend. Patches using :replace
+        # cannot be reverted.
+        # Returns a modified copy of the string.
+        #
+        # :contents: A string to modify, e.g. the contents of a file
+        # :regexp: A regular expression specifying a pattern to be matched
+        # :text: Text to be appended to the specified pattern
+        # :global: Boolean flag. If true, patch all occurrences of the regex.
+        # :mode: :append or :prepend. :replace patches cannot be reverted automatically.
+        # :offset: Starting position for matching
+        def revert_patch(contents, regexp, text, global, mode, offset)
+          search_position = offset
+          regexp_string = regexp.to_s
+
+          patched_regexp =
+            case mode
+            when :append
+              /#{regexp_string}#{Regexp.quote(text)}/m
+            when :prepend
+              /#{Regexp.quote(text)}#{regexp_string}/m
+            else
+              raise ArgumentError, "Invalid mode argument. Specify :append or :prepend."
+            end
+
+          while (matches = patched_regexp.match(contents, search_position))
+            reverted_text = matches[0].sub(text, '')
+            contents = "#{matches.pre_match}#{reverted_text}#{matches.post_match}"
+            search_position = matches.pre_match.length + reverted_text.length
+            break unless global
+          end
+
+          contents
+        end
+
+        def files_from_params(params)
+          case params[:files]
+          when Array
+            params[:files].map(&:to_s)
+          when String
+            params[:files].split(",")
+          else
+            raise ArgumentError, "Invalid type #{params[:files].class} for :files option. Specify an Array or a String."
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+module Fastlane
+  module Patch
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-patch
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jimmy Dee
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.47.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.47.0
+description: 
+email: jgvdthree@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/patch.rb
+- lib/fastlane/plugin/patch/actions/apply_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
+homepage: https://github.com/jdee/fastlane-plugin-patch
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: Apply and revert pattern-based patches to any text file.
+test_files: []
+has_rdoc: