rubocop-git2 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 971494e62d00b8014fc19631734832640325d7cdda40489802c2fae1fd500004
-  data.tar.gz: 27194c03771bd5855c83331fb25dfdd77e0e507be9f49af740a2021c5a97bcef
+  metadata.gz: 4b3ebd323c15d20d452fff488d6f4710bb97104acf4cddab72faaaa2421f461a
+  data.tar.gz: 3f502393adaf844a52f37bd9c85b5bca049c5c1fffa39bfd04391bd63ec6abac
 SHA512:
-  metadata.gz: '009a9ab5e998a0e3e1e837ed28ad773c319f198233c6d7e447c4a09ae793af43297043441730df0b041ff17db35022ed9b6ab9f814cfdc444e1606c381a0ba8c'
-  data.tar.gz: 2cc49969985c8ff0e9b98d51bf83a4897ef22d0acd224ac946bef250ca3d37280164d64b43f65347a2830739a532e635cd84e2f1c38708e3784008e8a73edecb
+  metadata.gz: a301bd97fbefb05b71880a7e927ebc48b7789f040a3dfe4e85fe4f7731e68b2fa03b44f05a760525599f345b57d23b1bc9112c85c9ad0ae948a0de5d748e8dd5
+  data.tar.gz: 00ec8f7a896238519a26f0c3007e65c8eedf0743d576f93cd7086e58e137615b3d9fb620e8b1c42a41bb9f87e5e9c52e243be0b82bcb0d7ae71affed6e6d2f17

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -1,11 +1,15 @@
 AllCops:
   NewCops: enable
+  SuggestExtensions: false
   TargetRubyVersion: 2.6 # really 2.4, but 2.6 is lowest supported by rubocop
 
+# warning! changes here might break specs that test config evaluation.
+Gemspec/RequireMFA:
+  Enabled: false
 Layout/DotPosition:
   Enabled: false
 Metrics/BlockLength:
-  Exclude: ['test/**/*.rb']
+  Exclude: ['spec/**/*.rb']
 Style/Documentation:
   Enabled: false
 Style/FrozenStringLiteralComment:
@@ -14,6 +18,8 @@ Style/ClassAndModuleChildren:
   Enabled: false
 Style/IfUnlessModifier:
   Enabled: false
+Style/Lambda:
+  Enabled: false
 Style/SelectByRegexp:
   Enabled: false
 Style/StringLiterals:

data/CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [0.1.5] - 2023-03-27
+
+### Fixed
+
+- stop using unsafe `YAML.load` on rubocop.yml
+
 ## [0.1.4] - 2023-03-24
 
 First release as `rubocop-git2`.

data/Gemfile

@@ -3,5 +3,5 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'bundler'
-gem 'minitest'
 gem 'rake'
+gem 'rspec'

data/README.md

@@ -9,16 +9,45 @@ RuboCop for git diff.
 
 ## Installation
 
-Add or install `rubocop-git2`. NOT YET RELEASED - will happen soon!
+Add or install `rubocop-git2`.
 
 ## Usage
 
+### Examples
+
+```sh
+# check unstaged changes
+rubocop-git
+
+# check staged changes
+rubocop-git --staged
+
+# positional arguments are passed as git refs to git diff, e.g.:
+
+# check both staged and unstaged changes
+rubocop-git HEAD
+
+# check the previous commit
+rubocop-git HEAD~1 HEAD
+
+# check changes between two tags
+rubocop-git v1.0.0 v1.0.1
+
+# check all changes in a branch in github actions
+bundle exec rubocop-git origin/${{ github.base_ref }}
+```
+
+### Options
+
+Output of `rubocop-git --help`:
+
     Usage: rubocop-git [options] [[commit] commit]
         -c, --config FILE                Specify configuration file
-        -r, --require FILE               Require Ruby file
         -d, --debug                      Display debug info
         -D, --display-cop-names          Display cop names in offense messages
-            --only COP1,COP2             Run only specific cops or departments
-            --cached                     git diff --cached
-            --staged                     synonym of --cached
+        -f, --format FORMAT              Set output format (see rubocop --help)
             --hound                      Hound compatibility mode
+            --only COP1,COP2             Run only specific cops or departments
+        -r, --require FILE               Require Ruby file
+            --staged                     Inspect staged changes
+            --version                    Display version

data/Rakefile

@@ -1,16 +1,8 @@
 require 'bundler/gem_tasks'
-require 'rake/testtask'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
-task default: %i[test selftest]
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
 
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'test'
-  t.libs << 'lib'
-  t.test_files = FileList['test/**/*_test.rb']
-end
-
-desc 'Run RuboCop::Git over itself'
-task :selftest do
-  require_relative 'lib/rubocop/git'
-  RuboCop::Git::Runner.new.run(commits: ['v0.0.4'])
-end
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "rubocop-git2"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/rubocop/git/cli.rb

@@ -1,76 +1,72 @@
 require_relative '../git'
 require 'optparse'
 
-module RuboCop
-  module Git
-    class CLI
-      def run(args = ARGV)
-        @options = Options.new
-        parse_arguments(args)
-        Runner.new.run(@options)
-      end
-
-      private
+class RuboCop::Git::CLI
+  def run(args = ARGV.dup)
+    @options = RuboCop::Git::Options.new
+    parse_arguments(args)
+    RuboCop::Git::Runner.new.run(@options)
+  end
 
-      def parse_arguments(args)
-        @options.commits = option_parser.parse(args)
-      rescue OptionParser::InvalidOption, Options::Invalid => ex
-        warn "ERROR: #{ex.message}"
-        $stderr.puts
-        warn option_parser
-        exit 1
-      end
+  private
 
-      def option_parser
-        @option_parser ||= OptionParser.new do |opt|
-          opt.banner << ' [[commit] commit]'
+  def parse_arguments(args)
+    args << '--staged' if args.delete('--cached') # support synonymous flag
+    @options.commits = option_parser.parse(args)
+  rescue OptionParser::InvalidOption, Options::Invalid => e
+    warn "ERROR: #{e.message}"
+    $stderr.puts
+    warn option_parser
+    exit 1
+  end
 
-          opt.on('-c', '--config FILE',
-                 'Specify configuration file') do |config|
-            @options.config = config
-          end
+  # rubocop:disable Metrics
+  def option_parser
+    @option_parser ||= OptionParser.new do |opt|
+      opt.banner << ' [[commit] commit]'
 
-          opt.on('-r', '--require FILE',
-                 'Require Ruby file') do |file|
-            require file
-          end
+      opt.on('-c', '--config FILE',
+             'Specify configuration file') do |config|
+        @options.config = config
+      end
 
-          opt.on('-d', '--debug', 'Display debug info') do
-            @options.rubocop[:debug] = true
-          end
+      opt.on('-d', '--debug', 'Display debug info') do
+        @options.rubocop[:debug] = true
+      end
 
-          opt.on('-D', '--display-cop-names',
-                 'Display cop names in offense messages') do
-            @options.rubocop[:display_cop_names] = true
-          end
+      opt.on('-D', '--display-cop-names',
+             'Display cop names in offense messages') do
+        @options.rubocop[:display_cop_names] = true
+      end
 
-          opt.on('--only COP1,COP2', Array) do |args|
-            @options.rubocop[:only] = args
-          end
+      opt.on('-f', '--format FORMAT',
+             'Set output format (see rubocop --help)') do |format|
+        @options.format = format
+      end
 
-          opt.on('--cached', 'git diff --cached') do
-            @options.cached = true
-          end
+      opt.on('--hound', 'Hound compatibility mode') do
+        @options.hound = true
+      end
 
-          opt.on('--staged', 'synonym of --cached') do
-            @options.cached = true
-          end
+      opt.on('--only COP1,COP2', Array,
+             'Run only specific cops or departments') do |args|
+        @options.rubocop[:only] = args
+      end
 
-          opt.on('--hound', 'Hound compatibility mode') do
-            @options.hound = true
-          end
+      opt.on('-r', '--require FILE',
+             'Require Ruby file') do |file|
+        require file
+      end
 
-          opt.on('-f', '--format FORMAT',
-                 'Choose an output formatter') do |format|
-            @options.format = format
-          end
+      opt.on('--staged', 'Inspect staged changes') do
+        @options.cached = true
+      end
 
-          opt.on('--version', 'Display version') do
-            puts RuboCop::Git::VERSION
-            exit 0
-          end
-        end
+      opt.on('--version', 'Display version') do
+        puts RuboCop::Git::VERSION
+        exit 0
       end
     end
   end
+  # rubocop:enable Metrics
 end

data/lib/rubocop/git/commit.rb

@@ -1,22 +1,18 @@
 require 'shellwords'
 
-module RuboCop
-  module Git
-    # ref. https://github.com/thoughtbot/hound/blob/d2f3933/app/models/commit.rb
-    class Commit
-      def initialize(options)
-        @options = options
-      end
+class RuboCop::Git::Commit
+  # ref. https://github.com/thoughtbot/hound/blob/d2f3933/app/models/commit.rb
+  def initialize(options)
+    @options = options
+  end
 
-      def file_content(filename)
-        if @options.cached
-          `git show :#{filename.shellescape}`
-        elsif @options.commit_last
-          `git show #{@options.commit_last.shellescape}:#{filename.shellescape}`
-        else
-          File.read(filename)
-        end
-      end
+  def file_content(filename)
+    if @options.cached
+      `git show :#{filename.shellescape}`
+    elsif @options.commit_last
+      `git show #{@options.commit_last.shellescape}:#{filename.shellescape}`
+    else
+      File.read(filename)
     end
   end
 end

data/lib/rubocop/git/commit_file.rb

@@ -1,6 +1,5 @@
-module RuboCop::Git
 # c.f. https://github.com/thoughtbot/hound/blob/d2f3933/app/models/commit_file.rb
-class CommitFile
+class RuboCop::Git::CommitFile
   def initialize(file, commit)
     @file = file
     @commit = commit
@@ -15,11 +14,9 @@ class CommitFile
   end
 
   def content
-    @content ||= begin
-      unless removed?
-        @commit.file_content(filename)
-      end
-    end
+    @content ||= unless removed?
+                   @commit.file_content(filename)
+                 end
   end
 
   def relevant_line?(line_number)
@@ -41,7 +38,6 @@ class CommitFile
   private
 
   def patch
-    Patch.new(@file.patch)
+    RuboCop::Git::Patch.new(@file.patch)
   end
 end
-end

data/lib/rubocop/git/diff_parser.rb

@@ -1,31 +1,25 @@
-module RuboCop
-  module Git
-    class DiffParser
-      class << self
-        def parse(diff)
-          new.parse(diff)
-        end
-      end
-
-      def parse(diff)
-        files    = []
-        in_patch = false
-
-        diff.each_line do |line|
-          case line
-          when /^diff --git/
-            in_patch = false
-          when %r{^\+{3} b/(?<path>[^\t\n\r]+)}
-            files << PseudoResource.new(Regexp.last_match[:path])
-          when /^@@/
-            in_patch = true
-          end
+class RuboCop::Git::DiffParser
+  def self.parse(diff)
+    new.parse(diff)
+  end
 
-          files.last.patch << line if in_patch
-        end
+  def parse(diff) # rubocop:disable Metrics/MethodLength
+    files    = []
+    in_patch = false
 
-        files
+    diff.each_line do |line|
+      case line
+      when /^diff --git/
+        in_patch = false
+      when %r{^\+{3} b/(?<path>[^\t\n\r]+)}
+        files << RuboCop::Git::PseudoResource.new(Regexp.last_match[:path])
+      when /^@@/
+        in_patch = true
       end
+
+      files.last.patch << line if in_patch
     end
+
+    files
   end
 end

data/lib/rubocop/git/file_violation.rb

@@ -1,5 +1,2 @@
-module RuboCop::Git
 # ref. https://github.com/thoughtbot/hound/blob/d2f3933/app/models/file_violation.rb
-class FileViolation < Struct.new(:filename, :offenses)
-end
-end
+RuboCop::Git::FileViolation = Struct.new(:filename, :offenses)

data/lib/rubocop/git/line.rb

@@ -1,8 +1,6 @@
-module RuboCop::Git
 # similar to https://github.com/thoughtbot/hound/blob/d2f3933/app/models/line.rb
-class Line < Struct.new(:content, :line_number, :patch_position)
-  def ==(other_line)
-    content == other_line.content
+RuboCop::Git::Line = Struct.new(:content, :line_number, :patch_position) do
+  def ==(other)
+    content == other.content
   end
 end
-end

data/lib/rubocop/git/options.rb

@@ -1,94 +1,93 @@
-module RuboCop
-  module Git
-    class Options
-      class Invalid < StandardError; end
-
-      HOUND_DEFAULT_CONFIG_FILE =
-        File.expand_path('../../../../hound.yml', __FILE__)
-
-      attr_accessor :config
-      attr_reader   :cached, :hound, :rubocop, :format
-
-      def initialize(hash_options = nil)
-        @config  = nil
-        @cached  = false
-        @hound   = false
-        @format = RuboCop::Formatter::ClangStyleFormatter
-        @rubocop = {}
-        @commits = []
-
-        from_hash(hash_options) if hash_options
-      end
-
-      def cached=(cached_)
-        if cached_ && !@commits.empty?
-          fail Invalid, 'cached and commit cannot be specified together'
-        end
-        @cached = !!cached_
-      end
-
-      def hound=(hound_)
-        @hound = !!hound_
-      end
-
-      def rubocop=(rubocop_)
-        unless rubocop_.nil? || rubocop_.is_a?(Hash)
-          fail Invalid, "invalid rubocop: #{rubocop_.inspect}"
-        end
-        @rubocop = rubocop_.to_h
-      end
-
-      def commits=(commits)
-        unless commits.is_a?(Array) && commits.length <= 2
-          fail Invalid, "invalid commits: #{commits.inspect}"
-        end
-        if !commits.empty? && cached
-          fail Invalid, 'cached and commit cannot be specified together'
-        end
-        @commits = commits
-      end
-
-      def format=(format)
-        formatters =
-          RuboCop::Formatter::FormatterSet::BUILTIN_FORMATTERS_FOR_KEYS
-        formatter_key = formatters.keys.find do |key|
-          key.start_with?(format)
-        end
-        @format = formatters[formatter_key] if formatter_key
-      end
-
-      def config_file
-        if hound
-          HOUND_DEFAULT_CONFIG_FILE
-        elsif config
-          config
-        elsif File.exist?(RuboCop::ConfigLoader::DOTFILE)
-          RuboCop::ConfigLoader::DOTFILE
-        else
-          RuboCop::ConfigLoader::DEFAULT_FILE
-        end
-      end
-
-      def commit_first
-        @commits.first
-      end
-
-      def commit_last
-        @commits.length == 1 ? false : @commits.last
-      end
-
-      private
-
-      def from_hash(hash_options)
-        hash_options = hash_options.dup
-        %w(config cached hound rubocop commits).each do |key|
-          value = hash_options.delete(key) || hash_options.delete(key.to_sym)
-          public_send("#{key}=", value)
-        end
-        unless hash_options.empty?
-          fail Invalid, "invalid keys: #{hash_options.keys.join(' ')}"
-        end
-      end
+class RuboCop::Git::Options
+  class Invalid < StandardError; end
+
+  HOUND_DEFAULT_CONFIG_FILE =
+    File.expand_path('../../../hound.yml', __dir__)
+
+  attr_accessor :config
+  attr_reader   :cached, :hound, :rubocop, :format
+
+  def initialize(hash_options = nil)
+    @config  = nil
+    @cached  = false
+    @hound   = false
+    @format = RuboCop::Formatter::ClangStyleFormatter
+    @rubocop = {}
+    @commits = []
+
+    from_hash(hash_options) if hash_options
+  end
+
+  def cached=(cached_)
+    if cached_ && !@commits.empty?
+      raise Invalid, 'cached and commit cannot be specified together'
+    end
+
+    @cached = !!cached_
+  end
+
+  def hound=(hound_)
+    @hound = !!hound_
+  end
+
+  def rubocop=(rubocop_)
+    unless rubocop_.nil? || rubocop_.is_a?(Hash)
+      raise Invalid, "invalid rubocop: #{rubocop_.inspect}"
+    end
+
+    @rubocop = rubocop_.to_h
+  end
+
+  def commits=(commits)
+    unless commits.is_a?(Array) && commits.length <= 2
+      raise Invalid, "invalid commits: #{commits.inspect}"
+    end
+    if !commits.empty? && cached
+      raise Invalid, 'cached and commit cannot be specified together'
     end
+
+    @commits = commits
+  end
+
+  def format=(format)
+    formatters =
+      RuboCop::Formatter::FormatterSet::BUILTIN_FORMATTERS_FOR_KEYS
+    formatter_key = formatters.keys.find do |key|
+      key.start_with?(format)
+    end
+    @format = formatters[formatter_key] if formatter_key
+  end
+
+  def config_file
+    if hound
+      HOUND_DEFAULT_CONFIG_FILE
+    elsif config
+      config
+    elsif File.exist?(RuboCop::ConfigLoader::DOTFILE)
+      RuboCop::ConfigLoader::DOTFILE
+    else
+      RuboCop::ConfigLoader::DEFAULT_FILE
+    end
+  end
+
+  def commit_first
+    @commits.first
+  end
+
+  def commit_last
+    @commits.length == 1 ? false : @commits.last
+  end
+
+  private
+
+  def from_hash(hash_options)
+    hash_options = hash_options.dup
+    %w[config cached hound rubocop commits].each do |key|
+      value = hash_options.delete(key) || hash_options.delete(key.to_sym)
+      public_send("#{key}=", value)
+    end
+    return if hash_options.empty?
+
+    raise Invalid, "invalid keys: #{hash_options.keys.join(' ')}"
   end
 end

data/lib/rubocop/git/patch.rb

@@ -1,9 +1,8 @@
-module RuboCop::Git
 # copy from https://github.com/thoughtbot/hound/blob/5269fa5/app/models/patch.rb
-class Patch
-  RANGE_INFORMATION_LINE = /^@@ .+\+(?<line_number>\d+),/
-  MODIFIED_LINE = /^\+(?!\+|\+)/
-  NOT_REMOVED_LINE = /^[^-]/
+class RuboCop::Git::Patch
+  RANGE_INFORMATION_LINE = /^@@ .+\+(?<line_number>\d+),/.freeze
+  MODIFIED_LINE = /^\+(?!\+|\+)/.freeze
+  NOT_REMOVED_LINE = /^[^-]/.freeze
 
   def initialize(body)
     @body = body || ''
@@ -18,7 +17,7 @@ class Patch
       when RANGE_INFORMATION_LINE
         line_number = Regexp.last_match[:line_number].to_i
       when MODIFIED_LINE
-        line = Line.new(content, line_number, patch_position)
+        line = RuboCop::Git::Line.new(content, line_number, patch_position)
         hash[line_number] = line
         line_number += 1
       when NOT_REMOVED_LINE
@@ -33,4 +32,3 @@ class Patch
     @body.each_line
   end
 end
-end

data/lib/rubocop/git/pseudo_pull_request.rb

@@ -1,36 +1,33 @@
-module RuboCop
-  module Git
-    # ref. https://github.com/thoughtbot/hound/blob/d2f3933/app/models/pull_request.rb
-    class PseudoPullRequest
-      HOUND_CONFIG_FILE = '.hound.yml'
+# ref. https://github.com/thoughtbot/hound/blob/d2f3933/app/models/pull_request.rb
+class RuboCop::Git::PseudoPullRequest
+  HOUND_CONFIG_FILE = '.hound.yml'.freeze
 
-      def initialize(files, options)
-        @files = files
-        @options = options
-      end
+  def initialize(files, options)
+    @files = files
+    @options = options
+  end
 
-      def pull_request_files
-        @files.map do |file|
-          build_commit_file(file)
-        end
-      end
+  def pull_request_files
+    @files.map do |file|
+      build_commit_file(file)
+    end
+  end
 
-      def config
-        return unless @options.hound
-        File.read(HOUND_CONFIG_FILE)
-      rescue Errno::ENOENT
-        nil
-      end
+  def config
+    return unless @options.hound
 
-      private
+    File.read(HOUND_CONFIG_FILE)
+  rescue Errno::ENOENT
+    nil
+  end
 
-      def build_commit_file(file)
-        CommitFile.new(file, head_commit)
-      end
+  private
 
-      def head_commit
-        @head_commit ||= Commit.new(@options)
-      end
-    end
+  def build_commit_file(file)
+    RuboCop::Git::CommitFile.new(file, head_commit)
+  end
+
+  def head_commit
+    @head_commit ||= RuboCop::Git::Commit.new(@options)
   end
 end

data/lib/rubocop/git/pseudo_resource.rb

@@ -1,24 +1,20 @@
-module RuboCop
-  module Git
-    class PseudoResource
-      attr_reader :patch, :pwd, :file_relative_path
+class RuboCop::Git::PseudoResource
+  attr_reader :patch, :pwd, :file_relative_path
 
-      alias filename file_relative_path
+  alias filename file_relative_path
 
-      def initialize(file_relative_path, pwd = Dir.pwd)
-        @file_relative_path = file_relative_path
-        @pwd = pwd
-        @patch = ''
-      end
+  def initialize(file_relative_path, pwd = Dir.pwd)
+    @file_relative_path = file_relative_path
+    @pwd = pwd
+    @patch = ''
+  end
 
-      def absolute_path
-        filename
-        File.join(pwd, filename)
-      end
+  def absolute_path
+    filename
+    File.join(pwd, filename)
+  end
 
-      def status
-        'modified'
-      end
-    end
+  def status
+    'modified'
   end
 end

data/lib/rubocop/git/runner.rb

@@ -1,75 +1,73 @@
 require 'shellwords'
 
-module RuboCop
-  module Git
-    # ref. https://github.com/thoughtbot/hound/blob/d2f3933/app/services/build_runner.rb
-    class Runner
-      def initialize(exit_on_offence: true)
-        @exit_on_offence = exit_on_offence
-      end
-
-      def run(options = {})
-        options = Options.new(options) unless options.is_a?(Options)
-
-        @options = options
-        @files = DiffParser.parse(git_diff(options))
-
-        display_violations($stdout)
-
-        ok = violations_with_valid_offences.none?
-        exit(1) if @exit_on_offence && !ok
-        ok
-      end
-
-      private
-
-      def violations
-        @violations ||= style_checker.violations
-      end
-
-      def violations_with_valid_offences
-        @violations_with_valid_offences ||= violations.select { |v| valid_offences(v).any? }
-      end
-
-      def valid_offences(violation)
-        offenses = violation.offenses
-        offenses = offenses.reject(&:disabled?) if offenses.first.respond_to?(:disabled?)
-        offenses.compact.sort.freeze
-      end
-
-      def style_checker
-        StyleChecker.new(
-          pull_request.pull_request_files,
-          @options.rubocop,
-          @options.config_file,
-          pull_request.config
-        )
-      end
-
-      def pull_request
-        @pull_request ||= PseudoPullRequest.new(@files, @options)
-      end
-
-      def git_diff(options)
-        args = %w(diff --diff-filter=AMCR --find-renames --find-copies)
-
-        args << '--cached' if options.cached
-        args << options.commit_first.shellescape if options.commit_first
-        args << options.commit_last.shellescape if options.commit_last
-
-        `git #{args.join(' ')}`
-      end
-
-      def display_violations(io)
-        formatter = @options.format.new(io)
-        formatter.started(@files)
-
-        violations.map do |violation|
-          formatter.file_finished(violation.filename, valid_offences(violation))
-        end
-
-        formatter.finished(@files.map(&:filename).freeze)
-      end
+# ref. https://github.com/thoughtbot/hound/blob/d2f3933/app/services/build_runner.rb
+class RuboCop::Git::Runner
+  def initialize(exit_on_offence: true)
+    @exit_on_offence = exit_on_offence
+  end
+
+  def run(options = {})
+    unless options.is_a?(RuboCop::Git::Options)
+      options = RuboCop::Git::Options.new(options)
     end
+
+    @options = options
+    @files = RuboCop::Git::DiffParser.parse(git_diff(options))
+
+    display_violations($stdout)
+
+    ok = violations_with_valid_offences.none?
+    exit(1) if @exit_on_offence && !ok
+    ok
+  end
+
+  private
+
+  def violations
+    @violations ||= style_checker.violations
+  end
+
+  def violations_with_valid_offences
+    @violations_with_valid_offences ||= violations.select { |v| valid_offences(v).any? }
+  end
+
+  def valid_offences(violation)
+    offenses = violation.offenses
+    offenses = offenses.reject(&:disabled?) if offenses.first.respond_to?(:disabled?)
+    offenses.compact.sort.freeze
+  end
+
+  def style_checker
+    RuboCop::Git::StyleChecker.new(
+      pull_request.pull_request_files,
+      @options.rubocop,
+      @options.config_file,
+      pull_request.config
+    )
+  end
+
+  def pull_request
+    @pull_request ||= RuboCop::Git::PseudoPullRequest.new(@files, @options)
+  end
+
+  def git_diff(options)
+    args = %w[diff --diff-filter=AMCR --find-renames --find-copies]
+
+    args << '--cached' if options.cached
+    args << options.commit_first.shellescape if options.commit_first
+    args << options.commit_last.shellescape if options.commit_last
+
+    `git #{args.join(' ')}`
+  end
+
+  def display_violations(io)
+    formatter = @options.format.new(io)
+    formatter.started(@files)
+
+    violations.map do |violation|
+      formatter.file_finished(violation.filename, valid_offences(violation))
+    end
+
+    formatter.finished(@files.map(&:filename).freeze)
   end
 end

data/lib/rubocop/git/style_checker.rb

@@ -1,6 +1,5 @@
-module RuboCop::Git
-# ref. https://github.com/thoughtbot/hound/blob/d2f3933/app/models/style_checker.rb
-class StyleChecker
+class RuboCop::Git::StyleChecker
+  # ref. https://github.com/thoughtbot/hound/blob/d2f3933/app/models/style_checker.rb
   def initialize(modified_files,
                  rubocop_options,
                  config_file,
@@ -13,7 +12,10 @@ class StyleChecker
 
   def violations
     file_violations = @modified_files.map do |modified_file|
-      FileViolation.new(modified_file.absolute_path, offenses(modified_file))
+      RuboCop::Git::FileViolation.new(
+        modified_file.absolute_path,
+        offenses(modified_file)
+      )
     end
 
     file_violations.select do |file_violation|
@@ -35,9 +37,10 @@ class StyleChecker
   end
 
   def style_guide
-    @style_guide ||= StyleGuide.new(@rubocop_options,
-                                    @config_file,
-                                    @custom_config)
+    @style_guide ||= RuboCop::Git::StyleGuide.new(
+      @rubocop_options,
+      @config_file,
+      @custom_config
+    )
   end
 end
-end

data/lib/rubocop/git/style_guide.rb

@@ -1,10 +1,9 @@
-module RuboCop::Git
 # ref. https://github.com/thoughtbot/hound/blob/d2f3933/app/models/style_guide.rb
-class StyleGuide
-  def initialize(rubocop_options, config_file, override_config_content = nil)
+class RuboCop::Git::StyleGuide
+  def initialize(rubocop_options, config_file, custom_config = nil)
     @rubocop_options = rubocop_options
     @config_file = config_file
-    @override_config_content = override_config_content
+    @custom_config = custom_config
   end
 
   def violations(file)
@@ -77,8 +76,8 @@ class StyleGuide
   end
 
   def override_config
-    if @override_config_content
-      config_content = YAML.load(@override_config_content)
+    if @custom_config
+      config_content = RuboCop::Config.load_yaml_configuration(@custom_config)
       override_config = RuboCop::Config.new(config_content, "")
       override_config.add_missing_namespaces
       override_config.make_excludes_absolute
@@ -88,4 +87,3 @@ class StyleGuide
     end
   end
 end
-end

data/lib/rubocop/git/version.rb

@@ -1,5 +1,5 @@
 module RuboCop
   module Git
-    VERSION = '0.1.4'.freeze
+    VERSION = '0.1.5'.freeze
   end
 end

data/lib/rubocop/git.rb

@@ -1,7 +1,7 @@
-require_relative 'git/version'
 require 'rubocop'
 
 module RuboCop::Git
+  autoload :CLI,               "#{__dir__}/git/cli"
   autoload :Commit,            "#{__dir__}/git/commit"
   autoload :CommitFile,        "#{__dir__}/git/commit_file"
   autoload :DiffParser,        "#{__dir__}/git/diff_parser"
@@ -14,4 +14,5 @@ module RuboCop::Git
   autoload :Runner,            "#{__dir__}/git/runner"
   autoload :StyleChecker,      "#{__dir__}/git/style_checker"
   autoload :StyleGuide,        "#{__dir__}/git/style_guide"
+  autoload :VERSION,           "#{__dir__}/git/version"
 end

data/rubocop-git.gemspec

@@ -5,14 +5,14 @@ Gem::Specification.new do |spec|
   spec.version       = RuboCop::Git::VERSION
   spec.authors       = ['Masaki Takeuchi', 'Janosch Müller']
   spec.email         = ['janosch84@gmail.com']
-  spec.summary       = %q{RuboCop for git diff.}
-  spec.description   = %q{RuboCop for git diff.}
+  spec.summary       = 'RuboCop for git diff.'
+  spec.description   = 'RuboCop for git diff.'
   spec.homepage      = 'https://github.com/jaynetics/rubocop-git2'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
   spec.required_ruby_version = '>= 2.6.0'

data/spec/rubocop/git/cli_spec.rb

@@ -0,0 +1,7 @@
+describe RuboCop::Git::CLI do
+  it "fails with invalid options" do
+    expect { subject.run(["--gru\u00DF"]) }
+      .to output(/Usage/).to_stderr
+      .and raise_error(SystemExit)
+  end
+end

data/spec/rubocop/git/options_spec.rb

@@ -0,0 +1,17 @@
+describe RuboCop::Git::Options do
+  it "fails with no options" do
+    expect { RuboCop::Git::Options.new({}) }.to raise_error(/invalid/)
+  end
+
+  it "fails with unknown options" do
+    expect { RuboCop::Git::Options.new({ foo: 1 }) }.to raise_error(/invalid/)
+  end
+
+  it "can pass string hash options" do
+    RuboCop::Git::Options.new("rubocop" => {}, "commits" => [])
+  end
+
+  it "can pass symbol hash options" do
+    RuboCop::Git::Options.new(rubocop: {}, commits: [])
+  end
+end

data/spec/rubocop/git/runner_spec.rb

@@ -0,0 +1,52 @@
+describe RuboCop::Git::Runner do
+  it "exits with violations" do
+    options = RuboCop::Git::Options.new
+    options.commits = ["v0.0.4", "v0.0.5"]
+    expect { RuboCop::Git::Runner.new.run(options) }
+      .to output(%r{Layout/TrailingWhitespace}).to_stdout
+      .and raise_error(SystemExit)
+  end
+
+  it "enables cops passed via --only flag" do
+    # WITHOUT only flag
+    options = RuboCop::Git::Options.new
+    options.commits = ["v0.0.0", "v0.0.4"]
+    output = capture_stdout do
+      res = RuboCop::Git::Runner.new(exit_on_offence: false).run(options)
+      expect(res).to eq false
+    end
+    # check that rubocop's default `Include:` applies
+    expect(output).not_to include 'bad_ruby.txt'
+    # check that cop disabled via rubocop.yml isn't used
+    expect(output).not_to include 'Style/FrozenStringLiteralComment'
+    # check that enabled cop is used
+    expect(output).to include 'Style/MutableConstant'
+
+    # WITH only flag
+    options.rubocop[:only] = ["Style/FrozenStringLiteralComment"]
+    output = capture_stdout do
+      res = RuboCop::Git::Runner.new(exit_on_offence: false).run(options)
+      expect(res).to eq false
+    end
+    # check that rubocop's default `Include:` applies
+    expect(output).to include 'Rakefile'
+    # check that passed cop is used despite being disabled in rubocop.yml
+    expect(output).to include 'Style/FrozenStringLiteralComment'
+    # check that other enabled cop isn't used
+    expect(output).not_to include 'Style/MutableConstant'
+  end
+
+  it "fails with no options" do
+    expect { RuboCop::Git::Runner.new.run({}) }.to raise_error(/invalid/)
+  end
+
+  def capture_stdout(&block)
+    captured_stream = StringIO.new
+    original_stream = $stdout
+    $stdout = captured_stream
+    block.call
+    captured_stream.string
+  ensure
+    $stdout = original_stream
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'rubocop/git'

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-git2
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Masaki Takeuchi
 - Janosch Müller
 autorequire:
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2023-03-24 00:00:00.000000000 Z
+date: 2023-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -35,13 +35,16 @@ extra_rdoc_files: []
 files:
 - ".github/workflows/tests.yml"
 - ".gitignore"
+- ".rspec"
 - ".rubocop.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/rubocop-git
+- bin/console
+- bin/setup
+- exe/rubocop-git
 - hound.yml
 - lib/rubocop/git.rb
 - lib/rubocop/git/cli.rb
@@ -59,11 +62,11 @@ files:
 - lib/rubocop/git/style_guide.rb
 - lib/rubocop/git/version.rb
 - rubocop-git.gemspec
-- test/bad_ruby.txt
-- test/rubocop/git/cli_test.rb
-- test/rubocop/git/options_test.rb
-- test/rubocop/git/runner_test.rb
-- test/test_helper.rb
+- spec/bad_ruby.txt
+- spec/rubocop/git/cli_spec.rb
+- spec/rubocop/git/options_spec.rb
+- spec/rubocop/git/runner_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/jaynetics/rubocop-git2
 licenses:
 - MIT
@@ -87,9 +90,4 @@ rubygems_version: 3.4.1
 signing_key:
 specification_version: 4
 summary: RuboCop for git diff.
-test_files:
-- test/bad_ruby.txt
-- test/rubocop/git/cli_test.rb
-- test/rubocop/git/options_test.rb
-- test/rubocop/git/runner_test.rb
-- test/test_helper.rb
+test_files: []

data/test/rubocop/git/cli_test.rb

@@ -1,12 +0,0 @@
-require_relative '../../test_helper'
-require 'rubocop/git/cli'
-
-describe RuboCop::Git::CLI do
-  it 'fail with invalid options' do
-    _ do
-      _out, _err = capture_io do
-        RuboCop::Git::CLI.new.run(['--gruß'])
-      end
-    end.must_raise(SystemExit)
-  end
-end

data/test/rubocop/git/options_test.rb

@@ -1,18 +0,0 @@
-require_relative '../../test_helper'
-require 'rubocop/git/options'
-
-describe RuboCop::Git::Options do
-  it 'fail with no options' do
-    _ do
-      RuboCop::Git::Options.new({})
-    end.must_raise(RuboCop::Git::Options::Invalid)
-  end
-
-  it 'can pass string hash options' do
-    RuboCop::Git::Options.new('rubocop' => {}, 'commits' => [])
-  end
-
-  it 'can pass symbol hash options' do
-    RuboCop::Git::Options.new(rubocop: {}, commits: [])
-  end
-end

data/test/rubocop/git/runner_test.rb

@@ -1,43 +0,0 @@
-require_relative '../../test_helper'
-require 'rubocop/git/runner'
-
-describe RuboCop::Git::Runner do
-  it 'exit with violations' do
-    options = RuboCop::Git::Options.new
-    options.commits = ["v0.0.4", "v0.0.5"]
-    _ do
-      capture_io do
-        RuboCop::Git::Runner.new.run(options)
-      end
-    end.must_raise(SystemExit)
-  end
-
-  it 'enables cops passed via --only flag' do
-    options = RuboCop::Git::Options.new
-    options.commits = ["v0.0.0"]
-    out, _err = capture_io do
-      res = RuboCop::Git::Runner.new(exit_on_offence: false).run(options)
-      res.must_equal(false)
-    end
-    _(out).must_match('Style/MutableConstant')
-    _(out).wont_match('Style/FrozenStringLiteralComment')
-    _(out).wont_match('bad_ruby.txt') # check that default `Include:` applies
-
-    options.rubocop[:only] = ['Style/FrozenStringLiteralComment']
-    out, _err = capture_io do
-      res = RuboCop::Git::Runner.new(exit_on_offence: false).run(options)
-      res.must_equal(false)
-    end
-    _(out).wont_match('Style/MutableConstant')
-    _(out).must_match('Style/FrozenStringLiteralComment')
-    _(out).must_match('Rakefile') # check that default `Include:` applies
-  end
-
-  it 'fail with no options' do
-    _ do
-      _out, _err = capture_io do
-        RuboCop::Git::Runner.new.run({})
-      end
-    end.must_raise(RuboCop::Git::Options::Invalid)
-  end
-end

data/test/test_helper.rb

@@ -1,2 +0,0 @@
-require 'minitest/autorun'
-require 'rubocop/git'