rubocop-changes 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 37daad64414834e07edb588962bdf3916e67fc450a2e3746ab5e45272f5fb72e
-  data.tar.gz: 5737ea89aa55ce98e89019537e4f54774729b1a19292f40fa2755591721f2763
+  metadata.gz: 4c897309c9346d0df738a04adecd0c9f340b26170b5a64884604dec19510afe2
+  data.tar.gz: 1e1c3ceeba53c55debf3b4eda2929a4f95b4a013ffd310b63e3c32acb6492da5
 SHA512:
-  metadata.gz: 96a3aa06fd3bcc04f9556b73a88adc391c1ef4509070aa5386b73442a7b5c1092a02cb904f3f1d34cd679cb90e77d42632181c567ddcd2d38f33e451ad28694a
-  data.tar.gz: f9511dabaa54358cfb3760ca31dbdb4f351d6e1c86d4a0cc3ad5385569a10a2ebda81c801b7d8536ebb67ee80e5e654a12a1be477b94df5280141872d275f702
+  metadata.gz: 62707c10b740a9ba47bc2b816790178bd09c1be20d6db3a402dafb49b1b49ec65de247adf52aa46c2dd51935ec95854e818f4bbfcf078ab5f62d3af0d6d97a9e
+  data.tar.gz: edf2057141d1e7425ca57c728e3e8258de031b6a64dcd401de5627a07921bd0688ce505861b4ffdf47c5406165dd73af7c5549683848e95c81a98bc14df367b4

data/.rubocop.yml

@@ -1,2 +1,5 @@
 Style/Documentation:
   Enabled: false
+
+Metrics/LineLength:
+  Max: 120

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rubocop-changes (0.1.2)
+    rubocop-changes (0.2.0)
       git_diff_parser (~> 3.2)
       rubocop (~> 0.59)
 

data/README.md

@@ -1,7 +1,7 @@
 # Rubocop::Changes
 
-[![Gem Version](http://img.shields.io/gem/v/rubocop-changes.svg?style=flat)](http://badge.fury.io/rb/rubocop-changes)
-[![Build Status](http://img.shields.io/travis/fcsonline/rubocop-changes/master.svg?style=flat)](https://travis-ci.org/fcsonline/rubocop-changes)
+[![Gem Version](https://img.shields.io/gem/v/rubocop-changes)](https://rubygems.org/gems/rubocop-changes)
+[![Build Status](https://img.shields.io/travis/com/fcsonline/rubocop-changes/master)](https://travis-ci.com/fcsonline/rubocop-changes)
 
 `rubocop-changes` runs rubocop and shows only the offenses you introduced since
 the fork point of your git branch. Will not complain about existing offenses in
@@ -34,21 +34,25 @@ Or install it yourself as:
 
     $ bundle exec rubocop-changes
 
-## Alternatives
+## Other gems
 
-There are similar projects out there, but all of them show all Rubocop offenses for all changes files:
+There are similar projects out there, like
+[rubocop-git](https://github.com/m4i/rubocop-git),
+[diffcop](https://github.com/yohira0616/diffcop),
+[nexocop](https://github.com/SimpleNexus/nexocop), but not all of them offer
+differences at line level. Only
+[rubocop-git](https://github.com/m4i/rubocop-git) offer this nice feature but
+you have to craft the commit id to get the proper fork point of your pull
+request.
 
-- https://github.com/m4i/rubocop-git
-- https://github.com/packsaddle/rubocop-select
-- https://github.com/mcgain/rubocop-diff
-- https://github.com/yohira0616/diffcop
-- https://github.com/SimpleNexus/nexocop
+rubocop-changes does this diff out of the box without specify any commit id. If
+you want to get the offense comparing from one specific commit, you can pass
+the argument `commit` to the command.
 
 ## Ideas
 
 Those are some ideas to improve `rubocop-changes`:
 
-- [ ] Let users specify which formatter to use for the output
 - [ ] Let users specify the rubocop config file
 
 ## Development

data/exe/rubocop-changes

@@ -1,9 +1,17 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
+require 'rubocop'
+
 require 'rubocop/changes/checker'
+require 'rubocop/changes/options'
+
+args = Rubocop::Changes::Options.new.parse!
 
-checker = Rubocop::Changes::Checker.new
-offenses = checker.run
+offenses = Rubocop::Changes::Checker.new(
+  format: args.format,
+  quiet: args.quiet,
+  commit: args.commit
+).run
 
 exit offenses.count.positive? ? 1 : 0

data/lib/rubocop/changes/checker.rb

@@ -9,28 +9,37 @@ require 'rubocop/changes/shell'
 
 module Rubocop
   module Changes
+    class UnknownFormat < StandardError; end
     class UnknownForkPointError < StandardError; end
 
     class Checker
+      def initialize(format:, quiet:, commit:)
+        @format = format
+        @quiet = quiet
+        @commit = commit
+      end
+
       def run
         raise UnknownForkPointError if fork_point.empty?
+        raise UnknownFormat if formatter_klass.nil?
 
-        # TODO: Let users choose the formatter
-        formatter = RuboCop::Formatter::SimpleTextFormatter.new($stdout)
-
-        formatter.started('')
-
-        print_offenses(formatter)
-
-        formatter.finished(ruby_changed_files)
+        print_offenses! unless quiet
 
         checks.map(&:offenses).flatten
       end
 
       private
 
+      attr_reader :format, :quiet, :commit
+
       def fork_point
-        @fork_point ||= Shell.run('git merge-base HEAD origin/master')
+        @fork_point ||= Shell.run(command)
+      end
+
+      def command
+        return 'git merge-base HEAD origin/master' unless commit
+
+        "git log -n 1 --pretty=format:\"%h\" #{commit}"
       end
 
       def diff
@@ -76,13 +85,35 @@ module Rubocop
         checks.map { |check| check.offended_lines.size }.inject(0, :+)
       end
 
-      def print_offenses(formatter)
+      def print_offenses!
+        formatter.started(checks)
+
         checks.each do |check|
-          print_offenses_for_check(formatter, check)
+          print_offenses_for_check(check)
         end
+
+        formatter.finished(ruby_changed_files)
+      end
+
+      def formatter
+        @formatter ||= formatter_klass.new($stdout)
+      end
+
+      def formatter_klass
+        @formatter_klass ||= formatters[format]
+      end
+
+      def formatters
+        rubocop_formatters.map do |key, value|
+          [key.gsub(/[\[\]]/, '').to_sym, value]
+        end.to_h
+      end
+
+      def rubocop_formatters
+        RuboCop::Formatter::FormatterSet::BUILTIN_FORMATTERS_FOR_KEYS
       end
 
-      def print_offenses_for_check(formatter, check)
+      def print_offenses_for_check(check)
         offenses = check.offenses.map do |offense|
           RuboCop::Cop::Offense.new(
             offense.severity,

data/lib/rubocop/changes/options.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require 'optparse'
+
+module Rubocop
+  module Changes
+    class Options
+      Options = Struct.new(:format, :quiet, :commit)
+
+      def initialize
+        @args = Options.new(:simple, false, nil) # Defaults
+      end
+
+      def parse!
+        OptionParser.new do |opts|
+          opts.banner = 'Usage: rubocop-changes [options]'
+
+          parse_formatter!(opts)
+          parse_commit!(opts)
+          parse_quiet!(opts)
+          parse_help!(opts)
+          parse_version!(opts)
+        end.parse!
+
+        args
+      end
+
+      private
+
+      attr_reader :args
+
+      def formatter_values
+        formatters = RuboCop::Formatter::FormatterSet::BUILTIN_FORMATTERS_FOR_KEYS
+
+        formatters.keys.map do |key|
+          key.gsub(/[\[\]]/, '').to_sym
+        end
+      end
+
+      def parse_formatter!(opts)
+        opts.on(
+          '-f',
+          '--formatter [FORMATER]',
+          formatter_values,
+          "Select format type (#{formatter_values.join(', ')})"
+        ) do |t|
+          args.format = t
+        end
+      end
+
+      def parse_commit!(opts)
+        opts.on(
+          '-c',
+          '--commit [COMMIT_ID]',
+          'Compare from some specific point on git history'
+        ) do |c|
+          args.commit = c
+        end
+      end
+
+      def parse_quiet!(opts)
+        opts.on('-q', '--quiet', 'Be quiet') do |v|
+          args.quiet = v
+        end
+      end
+
+      def parse_help!(opts)
+        opts.on('-h', '--help', 'Prints this help') do
+          puts opts
+          exit
+        end
+      end
+
+      def parse_version!(opts)
+        opts.on('--version', 'Display version') do
+          puts Rubocop::Changes::VERSION
+          exit 0
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/changes/version.rb

@@ -2,6 +2,6 @@
 
 module Rubocop
   module Changes
-    VERSION = '0.1.2'
+    VERSION = '0.2.0'
   end
 end

data/rubocop-changes.gemspec

@@ -10,10 +10,10 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Ferran Basora']
   spec.email         = ['fcsonline@gmail.com']
 
-  spec.summary       = "Rubocop on changed lines from forked point"
+  spec.summary       = 'Rubocop on changed lines from git fork point'
   spec.description   = <<-DESCRIPTION
     rubocop-changes will run rubocop on changed lines from forked point in your main branch.
-    It will not complain about existing offenses in master branch.
+    It will not complain about existing offenses in master branch on your git prioject.
     This gem is perfect as a Continuous Integration tool
   DESCRIPTION
 
@@ -26,8 +26,9 @@ Gem::Specification.new do |spec|
   }
 
   # Specify which files should be added to the gem when it is released.
-  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  # The `git ls-files -z` loads the files in the RubyGem that have been added
+  # into git.
+  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
   spec.bindir        = 'exe'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-changes
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Ferran Basora
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-29 00:00:00.000000000 Z
+date: 2019-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: git_diff_parser
@@ -96,7 +96,7 @@ dependencies:
         version: '3.0'
 description: |2
       rubocop-changes will run rubocop on changed lines from forked point in your main branch.
-      It will not complain about existing offenses in master branch.
+      It will not complain about existing offenses in master branch on your git prioject.
       This gem is perfect as a Continuous Integration tool
 email:
 - fcsonline@gmail.com
@@ -123,6 +123,7 @@ files:
 - lib/rubocop/changes.rb
 - lib/rubocop/changes/check.rb
 - lib/rubocop/changes/checker.rb
+- lib/rubocop/changes/options.rb
 - lib/rubocop/changes/shell.rb
 - lib/rubocop/changes/version.rb
 - rubocop-changes.gemspec
@@ -151,5 +152,5 @@ rubyforge_project:
 rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
-summary: Rubocop on changed lines from forked point
+summary: Rubocop on changed lines from git fork point
 test_files: []