fastlane-plugin-maintenance 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f621164e8f2d3a86dbd19c4711d5de9153191496b1104e17407305c5281e452e
+  data.tar.gz: b38c6d50dadc89b40ecc7f755ef585287fd4bc1b68dc3b0ee6a92eebce30a2bc
+SHA512:
+  metadata.gz: 5dcada27fe1bdb35840dfef49b5574295f05e93d87a7d0605f5c1fc2b66b801c9e3e78e35ccd8ffdba740f8629db10a8db0c0ed9d911c0d687f28bae125b0b09
+  data.tar.gz: 6f35db1f5ecac7e7ca0dd5c8c47e28243094e8a803ea91db68f1056b44853c8530940bedee183009f46a28ee5ee63c7cf54c15cd92aaff722a60e69f69356c5a

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,62 @@
+# maintenance plugin
+
+[![fastlane Plugin Badge](https://rawcdn.githack.com/fastlane/fastlane/master/fastlane/assets/plugin-badge.svg)](https://rubygems.org/gems/fastlane-plugin-maintenance)
+
+## Getting Started
+
+This project is a [_fastlane_](https://github.com/fastlane/fastlane) plugin. To get started with `fastlane-plugin-maintenance`, add it to your project by running:
+
+```bash
+fastlane add_plugin maintenance
+```
+
+## About maintenance
+
+Maintenance actions for plugin repos. May be run as standalone actions from the
+command line.
+
+### update_rubocop action
+
+```bash
+bundle exec fastlane run update_rubocop
+```
+
+Updates rubocop to the latest version. Pins your gemspec to a new version of rubocop if
+necessary. Runs rubocop -a to auto-correct many offenses. Adjusts TargetRubyVersion.
+Automatically corrects namespace changes. Disables any remaining failing Cops in your
+.rubocop.yml with a TODO note. Run from the command line with no arguments.
+
+## Example
+
+Check out the [example `Fastfile`](fastlane/Fastfile) to see how to use this plugin. Try it by cloning the repo, running `fastlane install_plugins` and `bundle exec fastlane test`.
+
+**Note to author:** Please set up a sample project to make it easy for users to explore what your plugin does. Provide everything that is necessary to try out the plugin in this project (including a sample Xcode/Android project if necessary)
+
+## 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/maintenance.rb

@@ -0,0 +1,16 @@
+require 'fastlane/plugin/maintenance/version'
+
+module Fastlane
+  module Maintenance
+    # 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::Maintenance.all_classes.each do |current|
+  require current
+end

data/lib/fastlane/plugin/maintenance/actions/update_rubocop_action.rb

@@ -0,0 +1,203 @@
+require "fastlane/action"
+
+require "active_support/core_ext/array"
+require "active_support/core_ext/string"
+require "pattern_patch"
+require "rubygems"
+require "set"
+require "yaml"
+
+module Fastlane
+  module Actions
+    class UpdateRubocopAction < Action
+      class << self
+        def run(params)
+          unless Gem::Version.new(Fastlane::VERSION) >= Gem::Version.new("2.69.0")
+            UI.important "This action requires fastlane >= 2.69.0."
+            return false
+          end
+
+          spec = latest_rubocop_gemspec
+          UI.message "Latest: #{spec.name} #{spec.version}"
+          requirement = rubocop_requirement_from_repo
+          UI.message "requirement from gemspec: #{requirement}"
+          unless requirement.satisfied_by? spec.version
+            UI.important "updating gemspec requirement to #{spec.version}"
+            update_rubocop_requirement spec.version
+          end
+
+          sh "bundle update --quiet rubocop"
+
+          run_rubocop
+        end
+
+        def description
+          "Updates rubocop to the latest version. Pins your gemspec to a new version of rubocop if " \
+          "necessary. Runs rubocop -a to auto-correct many offenses. Adjusts TargetRubyVersion. " \
+          "Automatically corrects namespace changes. Disables any remaining failing Cops in your " \
+          ".rubocop.yml with a TODO note. Run from the command line with no arguments."
+        end
+
+        def authors
+          ["Jimmy Dee"]
+        end
+
+        def example_code
+          [
+            "bundle exec fastlane run update_rubocop"
+          ]
+        end
+
+        def latest_rubocop_gemspec
+          spec_tuple = Gem::SpecFetcher.fetcher.detect :latest do |name_tuple|
+            name_tuple.name == 'rubocop'
+          end.first
+
+          name_tuple = spec_tuple.first
+          source = spec_tuple.second
+          source.fetch_spec name_tuple
+        end
+
+        def gemspec_path
+          Dir[File.expand_path("*.gemspec")].first
+        end
+
+        def gemspec
+          return @gemspec if @gemspec
+          # rubocop: disable Security/Eval
+          @gemspec = eval(File.read(gemspec_path))
+          # rubocop: enable Security/Eval
+          @gemspec
+        end
+
+        def rubocop_dependency
+          gemspec.development_dependencies.find { |d| d.name == "rubocop" }
+        end
+
+        def rubocop_requirement_from_repo
+          rubocop_dependency.requirement
+        end
+
+        def update_rubocop_requirement(version)
+          PatternPatch::Patch.new(
+            regexp: /(\.add_development_dependency.*rubocop['")\]}]).*$/,
+            text: %(\\1, '#{version}'),
+            mode: :replace
+          ).apply gemspec_path
+        end
+
+        def run_rubocop
+          adjust_target_ruby_version
+
+          UI.message "1. Running rubocop --auto-correct. This may fail."
+          sh "bundle exec rubocop --auto-correct", print_command_output: false do |status|
+            if status.success?
+              UI.success "Done ✅"
+              return
+            end
+          end
+
+          UI.message "2. Running rubocop --display-cop-names for further automated fixes. This may fail."
+          sh "bundle exec rubocop --display-cop-names", print_command_output: false do |status, output, command|
+            if status.success?
+              UI.success "Done ✅"
+              return
+            end
+
+            UI.message "Adjusting changed namespaces and disabling failing cops."
+
+            output.split("\n").each do |line|
+              case line
+              when /has the wrong namespace/
+                adjust_namespace line
+              else
+                add_failing_cop line
+              end
+            end
+
+            disable_failing_cops
+          end
+
+          UI.message "3. Running rubocop --auto-correct to verify changes. This should pass."
+          sh "bundle exec rubocop --auto-correct", print_command_output: false do |status, output, command|
+            if status.success?
+              UI.success "Done ✅"
+              return
+            end
+
+            UI.important "rubocop still detects offenses. These have to be fixed manually."
+            output.split("\n").each do |line|
+              UI.message line
+            end
+          end
+
+          false
+        end
+
+        def adjust_namespace(line)
+          matches = %r{^(.*): (\w+)/(\w+) has the wrong namespace - should be (\w+)}.match line
+          UI.user_error! "Failed to scan #{line.inspect}" unless matches
+
+          path, old_namespace, cop, new_namespace = *matches[1..4]
+
+          UI.important "#{path}: #{old_namespace}/#{cop} -> #{new_namespace}/#{cop}"
+
+          PatternPatch::Patch.new(
+            regexp: %r{#{old_namespace}/#{cop}},
+            text: "#{new_namespace}/#{cop}",
+            mode: :replace,
+            global: true
+          ).apply path
+
+          true
+        end
+
+        def add_failing_cop(line)
+          matches = %r{^.+: [A-Z]: (\w+/\w+):}.match line
+          return unless matches
+
+          @failing_cops ||= Set.new
+          @failing_cops << matches[1]
+        end
+
+        def disable_failing_cops
+          return unless @failing_cops
+
+          UI.message ""
+          UI.important "Temporarily disabling the following cops in .rubocop.yml"
+          @failing_cops.each do |cop|
+            UI.important " #{cop}"
+          end
+
+          insertion = "# --- update_rubocop ---\n"
+          insertion << "# TODO: Review these failing cops, adjust code and re-enable as necessary.\n\n"
+          insertion << @failing_cops.map { |c| "#{c}:\n  Enabled: false\n" }.join("\n")
+          insertion << "# --- update_rubocop ---\n\n"
+
+          PatternPatch::Patch.new(
+            regexp: /\A/,
+            text: insertion,
+            mode: :prepend
+          ).apply ".rubocop.yml"
+        end
+
+        def adjust_target_ruby_version
+          rubocop_config = YAML.load_file ".rubocop.yml"
+          versions = rubocop_config.map { |k, v| v['TargetRubyVersion'] }.compact.map(&:to_f).uniq
+          return unless versions.any? { |v| v < 2.1 }
+
+          version = [versions.max, 2.1].max
+
+          UI.important "Updating TargetRubyVersion to #{version}"
+
+          PatternPatch::Patch.new(
+            regexp: /(TargetRubyVersion\s*:\s*)\d\.\d(.*)$/,
+            text: "\\1#{version}\\2",
+            mode: :replace,
+            global: true
+          ).apply ".rubocop.yml"
+        end
+      end
+    end
+  end
+end

data/lib/fastlane/plugin/maintenance/helper/maintenance_helper.rb

@@ -0,0 +1,12 @@
+module Fastlane
+  module Helper
+    class MaintenanceHelper
+      # class methods that you define here become available in your action
+      # as `Helper::MaintenanceHelper.your_method`
+      #
+      def self.show_message
+        UI.message("Hello from the maintenance plugin helper!")
+      end
+    end
+  end
+end

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

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

metadata

@@ -0,0 +1,175 @@
+--- !ruby/object:Gem::Specification
+name: fastlane-plugin-maintenance
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jimmy Dee
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-12-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pattern_patch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.4
+- !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: fastlane
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.69.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.69.0
+- !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: 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
+  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_junit_formatter
+  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.52.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.52.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'
+description: 
+email: jgvdthree@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/fastlane/plugin/maintenance.rb
+- lib/fastlane/plugin/maintenance/actions/update_rubocop_action.rb
+- lib/fastlane/plugin/maintenance/helper/maintenance_helper.rb
+- lib/fastlane/plugin/maintenance/version.rb
+homepage: https://github.com/jdee/fastlane-plugin-maintenance
+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.7.3
+signing_key: 
+specification_version: 4
+summary: Maintenance actions for plugin repos.
+test_files: []