rubocop_pr 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aef722f12c0f5f554bd332fc359161edf289e9585995e0b991ed8f55951dd9c3
-  data.tar.gz: 6fd6c986ed8a4c9549ac86e813fce081029a2cef663263cc69208887dfe4764c
+  metadata.gz: 3ff53c3508b18d189344f9f2c7bab5d07f1337772c416784309b840fb8d88d72
+  data.tar.gz: dd7fe6f7ad3e2030193a53c17ca48a3a9f17c7dfdd8e523c855cb8dae5d1b80c
 SHA512:
-  metadata.gz: fe66335b20d16dafff9f16e701af1189d5cb18acf0f26598b06643478f1d17a35729d997c2b1d26258ea7562c4cc5dad09eaf2133705743806566b7cd66d4bcc
-  data.tar.gz: b4d56f5d0b50393aa252671ab04cfb850c1df2eb8855fdf0bed9e18f8eaf8e2b3d1426ada8e0d9623a740dc0fd3f4594c751974da0723fe3a7f361b9174879f1
+  metadata.gz: b5d22dabd6c3241deb4ee2ceb158892a622cb306c5a0de3f65ebb3a91b8c9eb2642764783179b88bc3ed4b99d507a22ba57f147dfea9d88e52338b3ca1fec22f
+  data.tar.gz: 70f7bd4221e41fa826c8a89304aee2a38ceeb76a650bf68fdc9dad451d7ce820fc773aa68e941aa322fc7ffdff5a354181e4aec3e74b9b79ae56b6e044c0dabd

data/.rubocop.yml

@@ -8,4 +8,7 @@ Metrics/BlockLength:
   ExcludedMethods: ['describe', 'context']
 
 Metrics/AbcSize:
-  Max: 20
+  Max: 20
+
+Metrics/ClassLength:
+  Max: 150

data/README.md

@@ -38,15 +38,21 @@ Or install it yourself as:
 
 ```bash
 Usage: rubocop_pr [options]
-    -u, --hub-version [version]      Set manually minimum required version of 'hub' utility for github (default: 2.12.3)
-    -b, --branch [branch]            internal branch with '.rubocop_todo.yml' (default: 'rubocop_todo_branch')
-    -m, --master [branch]            branch which will be the base for all PR's (default: 'master')
     -r, --post-checkout [command]    Running after each git checkout (default: "")
-    -l, --limit [limit]              Limit the PS's for one run (default: 10)
-    -g, --repository [name]          Set repository host (default: github)
-    -o, --origin [origin]            origin option for 'git push' (default: 'origin')
     -c, --continue                   Continue previous session (default: false)
+    -b, --branch [branch]            internal branch with '.rubocop_todo.yml' (default: 'rubocop_todo_branch')
+    -m, --master [branch]            branch which will be the base for all PR's (default: 'master')
     -v, --version                    Display version
+    -o, --origin [origin]            origin option for 'git push' (default: 'origin')
+    -u, --hub-version [version]      Set manually minimum required version of 'hub' utility for github (default: 2.12.3)
+    -i, --issue-labels [labels]      Labels for created issues, separated by comma (default: rubocop)
+    -p [labels],                     Labels for created pull requests, separated by comma (default: rubocop)
+        --pull-request-labels
+    -a, --issue-assignees [name]     Issue assignees, separated by comma  (default: "")
+    -t [name],                       Pull request assignees, separated by comma (default: "")
+        --pull-request-assignees
+    -g, --repository [name]          Set repository host (default: github)
+    -l, --limit [limit]              Limit the PS's for one run (default: 10)
     -h, --help                       Display help
 ```
 

data/lib/rubocop_pr/cli/process_cop.rb

@@ -0,0 +1,54 @@
+module RubocopPr
+  class CLI
+    # Cop processor
+    class ProcessCop
+      attr_reader :options, :git, :repository, :cop
+
+      def initialize(git:, repository:, cop:, options:)
+        @git = git
+        @repository = repository
+        @cop = cop
+        @options = options
+      end
+
+      def call
+        return false if exit_early?
+        checkout_to_target_branch_throw_master_branch
+        git.commit_all(issue.title)
+        git.push
+        create_pr
+      end
+
+      private
+
+      def rubocop
+        @rubocop ||= RubocopPr::Rubocop.new(git: git)
+      end
+
+      def exit_early?
+        return true if options.continue && cop_was_processed? || git.status.blank?
+        Rubocop.correct!
+
+        git.checkout Rubocop::TODO_FILENAME
+        git.status.blank?
+      end
+
+      def cop_was_processed?
+        git.branch.match cop.branch
+      end
+
+      def issue
+        @issue ||= repository.issue(cop: cop, **options.to_h).create
+      end
+
+      def checkout_to_target_branch_throw_master_branch
+        git.checkout(options.master_branch)
+        git.checkout("#{issue.number}-#{cop.branch}")
+      end
+
+      def create_pr
+        repository.pull_request(cop: cop, body: "Closes ##{issue.number}", **options.to_h).create
+      end
+    end
+  end
+end

data/lib/rubocop_pr/cli.rb

@@ -15,35 +15,19 @@ module RubocopPr
     def run!
       EnvironmentChecker.call(repository, options)
       run
+      git.checkout Rubocop::TODO_FILENAME
       git.checkout(options.master_branch)
     end
 
     private
 
     def run
-      rubocop.inject(0) do |counter, cop|
-        next counter if git.status.blank?
-        next counter if options.continue && git.branch =~ /#{branch_suffix(cop)}\s/
-        next counter unless rubocop.corrected?
-        process_cop(cop)
+      rubocop.each do |cop|
+        break if options.limit <= 0
 
-        break if counter >= options.limit - 1
-        counter + 1
+        ProcessCop.new(git: git, repository: repository, cop: cop, options: options).call
+        options.limit -= 1
       end
     end
-
-    def process_cop(cop)
-      git.checkout(options.master_branch)
-      title = "Fix Rubocop #{cop} warnings"
-      issue_number = repository.create_issue(title: title)
-      git.checkout("#{issue_number}-#{branch_suffix(cop)}")
-      git.commit_all(title)
-      git.push
-      repository.create_pull_request(title: title, body: "Closes ##{issue_number}")
-    end
-
-    def branch_suffix(cop)
-      "rubocop-fix-#{cop.underscore.tr('/_', '-')}"
-    end
   end
 end

data/lib/rubocop_pr/cop.rb

@@ -0,0 +1,18 @@
+module RubocopPr
+  # Simple representation of the Cop
+  class Cop
+    attr_reader :name
+
+    def initialize(name:)
+      @name = name
+    end
+
+    def to_s
+      name.to_s
+    end
+
+    def branch
+      "rubocop-fix-#{name.underscore.tr('/_', '-')}"
+    end
+  end
+end

data/lib/rubocop_pr/options.rb

@@ -17,24 +17,19 @@ module RubocopPr
 
     private
 
-    def build_parser # rubocop:disable Metrics/MethodLength
-      @parser = OptionParser.new do |opts|
+    attr_accessor :opts
+
+    # options will be printed in order, as they are declared in this file
+    def build_parser
+      @parser = OptionParser.new do |op|
+        self.opts = op
         opts.banner = 'Usage: rubocop_pr [options]'
 
-        add_hub_version_option(opts)
-        add_rubocop_todo_branch_option(opts)
-        add_master_branch_option(opts)
-        add_post_checkout_option(opts)
-        add_limit_option(opts)
-        add_repository_option(opts)
-        add_git_origin_option(opts)
-        add_continue_option(opts)
-        add_version_option(opts)
-        add_on_tail(opts)
+        private_methods(false).map(&:to_s).select { |m| m.start_with?('add_') }.each { |m| send m }
       end
     end
 
-    def add_limit_option(opts)
+    def add_limit_option
       @options.limit = 10
       msg = "Limit the PS's for one run (default: 10)"
       opts.on('-l [limit]', '--limit [limit]', Integer, msg) do |v|
@@ -42,7 +37,7 @@ module RubocopPr
       end
     end
 
-    def add_post_checkout_option(opts)
+    def add_post_checkout_option
       @options.post_checkout = ''
       msg = 'Running after each git checkout (default: "")'
       opts.on('-r [command]', '--post-checkout [command]', String, msg) do |v|
@@ -50,7 +45,7 @@ module RubocopPr
       end
     end
 
-    def add_rubocop_todo_branch_option(opts)
+    def add_rubocop_todo_branch_option
       @options.rubocop_todo_branch = 'rubocop_todo_branch'
       msg = "internal branch with '.rubocop_todo.yml' (default: 'rubocop_todo_branch')"
       opts.on('-b [branch]', '--branch [branch]', String, msg) do |v|
@@ -58,7 +53,7 @@ module RubocopPr
       end
     end
 
-    def add_master_branch_option(opts)
+    def add_master_branch_option
       @options.master_branch = 'master'
       msg = "branch which will be the base for all PR's (default: 'master')"
       opts.on('-m [branch]', '--master [branch]', String, msg) do |v|
@@ -66,7 +61,7 @@ module RubocopPr
       end
     end
 
-    def add_git_origin_option(opts)
+    def add_git_origin_option
       @options.git_origin = 'origin'
       msg = "origin option for 'git push' (default: 'origin')"
       opts.on('-o [origin]', '--origin [origin]', String, msg) do |v|
@@ -74,7 +69,7 @@ module RubocopPr
       end
     end
 
-    def add_hub_version_option(opts)
+    def add_hub_version_option
       @options.hub_version = HUB_VERSION
       msg = "Set manually minimum required version of 'hub' utility for github (default: #{HUB_VERSION})"
       opts.on('-u [version] ', '--hub-version [version]', msg) do |v|
@@ -82,7 +77,39 @@ module RubocopPr
       end
     end
 
-    def add_repository_option(opts)
+    def add_issue_labels_option
+      @options.issue_labels = ['rubocop']
+      msg = 'Labels for created issues, separated by comma (default: rubocop)'
+      opts.on('-i [labels] ', '--issue-labels [labels]', Array, msg) do |v|
+        @options.issue_labels = v
+      end
+    end
+
+    def add_pull_request_labels_option
+      @options.pull_request_labels = ['rubocop']
+      msg = 'Labels for created pull requests, separated by comma (default: rubocop)'
+      opts.on('-p [labels] ', '--pull-request-labels [labels]', Array, msg) do |v|
+        @options.pull_request_labels = v
+      end
+    end
+
+    def add_issue_assignees_option
+      @options.issue_assignees = []
+      msg = 'Issue assignees, separated by comma  (default: "")'
+      opts.on('-a [name] ', '--issue-assignees [name]', Array, msg) do |v|
+        @options.issue_assignees = v
+      end
+    end
+
+    def add_pull_request_assignees_option
+      @options.pull_request_assignees = []
+      msg = 'Pull request assignees, separated by comma (default: "")'
+      opts.on('-t [name] ', '--pull-request-assignees [name]', Array, msg) do |v|
+        @options.pull_request_assignees = v
+      end
+    end
+
+    def add_repository_option
       @options.repository = 'github'
       msg = 'Set repository host (default: github)'
       opts.on('-g [name] ', '--repository [name]', msg) do |v|
@@ -90,21 +117,21 @@ module RubocopPr
       end
     end
 
-    def add_continue_option(opts)
+    def add_continue_option
       @options.continue = false
       opts.on('-c', '--continue', 'Continue previous session (default: false)') do |_v|
         @options.continue = true
       end
     end
 
-    def add_version_option(opts)
+    def add_version_option
       opts.on('-v', '--version', 'Display version') do
         puts RubocopPr::VERSION
         exit
       end
     end
 
-    def add_on_tail(opts)
+    def add_on_tail
       opts.on_tail('-h', '--help', 'Display help') do
         puts opts
         exit

data/lib/rubocop_pr/repositories/github.rb

@@ -2,18 +2,72 @@ module RubocopPr
   module Repositories
     # Github repository
     class Github < RubocopPr::Repository
-      # The representation of the Issue
-      class Issue
-        attr_reader :title, :body
+      # Base class for working with `hub` utility
+      class Base
+        attr_reader :title, :body, :cop, :number
 
-        def initialize(title:, **other)
-          @title = title
-          @body = other[:body] || default_body
+        def initialize(cop:, **options)
+          @cop = cop
+          @options = options
+          @title = options.delete(:title) || default_title
+          @body = options.delete(:body) || default_body
         end
 
         def create
-          link = `hub issue create -m '#{title}' -m '#{body}'`
-          link.split('/').last.to_i
+          @number = `#{build_command}`.split('/').last.to_i
+          self
+        end
+
+        def assignees
+          @assignees ||= Array options[:assignees]
+        end
+
+        def labels
+          @labels ||= Array options[:labels]
+        end
+
+        def build_command
+          [command, cli_options].join ' '
+        end
+
+        private
+
+        attr_reader :options
+
+        def command
+          raise NotImplemented
+        end
+
+        def cli_options
+          [].tap do |opt|
+            opt << "-m '#{title}'"
+            opt << "-m '#{body}'" unless body.blank?
+            opt << "-a '#{assignees.join(',')}'" unless assignees.blank?
+            opt << "-l '#{labels.join(',')}'" unless labels.blank?
+          end.join(' ')
+        end
+
+        def default_title
+          "Fix Rubocop #{cop} warnings"
+        end
+
+        def default_body
+          ''
+        end
+      end
+
+      # The representation of the Issue
+      class Issue < Base
+        def initialize(cop:, **opt)
+          super
+          @assignees = Array opt[:issue_assignees]
+          @labels = Array opt[:issue_labels]
+        end
+
+        private
+
+        def command
+          'hub issue create'
         end
 
         def default_body
@@ -23,17 +77,17 @@ module RubocopPr
       end
 
       # The representation of the PR
-      class PullRequest
-        attr_reader :title, :body
-
-        def initialize(title:, **other)
-          @title = title
-          @body = other[:body] || ''
+      class PullRequest < Base
+        def initialize(cop:, **opt)
+          super
+          @assignees = Array opt[:pull_request_assignees]
+          @labels = Array opt[:pull_request_labels]
         end
 
-        def create
-          link = `hub pull-request create -m '#{title}' -m '#{body}'`
-          link.split('/').last.to_i
+        private
+
+        def command
+          'hub pull-request create'
         end
       end
 
@@ -42,12 +96,12 @@ module RubocopPr
           super + [RubocopPr::Repositories::Github::Checks::VerifyHubVersion]
         end
 
-        def create_issue(*args)
-          Issue.new(*args).create
+        def issue(*args)
+          Issue.new(*args)
         end
 
-        def create_pull_request(*args)
-          PullRequest.new(*args).create
+        def pull_request(*args)
+          PullRequest.new(*args)
         end
       end
     end

data/lib/rubocop_pr/rubocop.rb

@@ -5,6 +5,16 @@ module RubocopPr
 
     TODO_FILENAME = '.rubocop_todo.yml'.freeze
 
+    class << self
+      def generate_todo
+        system 'bundle exec rubocop --auto-gen-config'
+      end
+
+      def correct!
+        system 'bundle exec rubocop -a'
+      end
+    end
+
     attr_reader :branch, :git
 
     def initialize(**options)
@@ -13,36 +23,25 @@ module RubocopPr
     end
 
     def todo
-      YAML.safe_load(read_or_generate_todo)
+      @todo ||= YAML.safe_load(read_or_generate_todo)
     end
 
     def each
-      git.checkout(branch)
-      todos_backup = todo
-      todos_backup.keys.sort.reverse_each do |cop|
+      todo.keys.sort.reverse_each do |cop|
         git.checkout(branch)
-        todos = todos_backup.dup
-        todos.delete cop
-        File.open(TODO_FILENAME, 'w') { |f| f.write todos.blank? ? '' : YAML.dump(todos) }
-        yield cop
+        File.open(TODO_FILENAME, 'w') do |f|
+          f.write todo.except(cop.to_s).blank? ? '' : YAML.dump(todo.except(cop.to_s))
+        end
+        yield Cop.new(name: cop)
       end
     end
 
     def read_or_generate_todo
+      git.checkout(branch)
       return File.read(TODO_FILENAME) if File.exist?(TODO_FILENAME)
-      generate_todo
+      self.class.generate_todo
       git.commit_all('Generate initial Rubocop todo file')
       File.read(TODO_FILENAME)
     end
-
-    def generate_todo
-      `bundle exec rubocop --auto-gen-config`
-    end
-
-    def corrected?
-      `bundle exec rubocop -a`
-      git.checkout TODO_FILENAME
-      !git.status.blank?
-    end
   end
 end

data/lib/rubocop_pr/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RubocopPr
-  VERSION = '0.2.1'.freeze
+  VERSION = '0.2.2'.freeze
 end

data/lib/rubocop_pr.rb

@@ -10,6 +10,8 @@ require 'pry'
 require 'rubocop_pr/version'
 require 'rubocop_pr/options'
 require 'rubocop_pr/environment_checker'
+require 'rubocop_pr/cli/process_cop'
+require 'rubocop_pr/cop'
 require 'rubocop_pr/rubocop'
 require 'rubocop_pr/git'
 require 'rubocop_pr/repository'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop_pr
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - kvokka
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-08 00:00:00.000000000 Z
+date: 2019-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -152,6 +152,8 @@ files:
 - exe/rubocop_pr
 - lib/rubocop_pr.rb
 - lib/rubocop_pr/cli.rb
+- lib/rubocop_pr/cli/process_cop.rb
+- lib/rubocop_pr/cop.rb
 - lib/rubocop_pr/environment_checker.rb
 - lib/rubocop_pr/git.rb
 - lib/rubocop_pr/options.rb