boxt_ruby_style_guide 7.4.0 → 7.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00a10b1e139e15aa28f133847e8a102bba235fd15840b8da636cc2658cbbd821
-  data.tar.gz: '0683e861cc45e0177b5e9f96c4ac05e47ae77b99314978463fa9178da217277d'
+  metadata.gz: bb14b8f791b4feded3f27f40c3bb50de7087c97f6c68177831a0d480e52e3860
+  data.tar.gz: db0f26c2a9cd3f5dc8137a74c03819f0744a09c64be7cdad45eb250994dd2ee3
 SHA512:
-  metadata.gz: 65c4b44b3a1eb0077bcaf1dc2be3035439fd7b9b0771409f1b02483ac81f5d2b744768f6901206e600f9cbb3fec0743ef585e52f89fabac58250ebcfc44b6891
-  data.tar.gz: 3d3b1cc9df23483d023e55b1029e47d98cfdc62982c366f8992b5ef6ee95077f216f9368498447d478c9ebe7530cd7e2e1fb94c5147702c706409e369a2f8ed1
+  metadata.gz: 07e967593138ce3ac4fe0aea5f6eca2a53c46611e2a3694a3a582abd0d5e52fcbb1a461d8e3917d2fecdae8529f70be656bc849bdaed13391695cfa6f2c027ca
+  data.tar.gz: 301463c3158cc8f859b408fbf8a0fc8a4c4cb8bcb102d64d7af2ab0a53d606753c1b61e574b6cea6eaa8d4ce1b44b44358ad8b59a349e21886889737b5725155

data/README.md

@@ -41,10 +41,10 @@ Add a `.rubocop.yml` file to the root of your project with the following setting
 inherit_gem:
   boxt_ruby_style_guide:
     - default.yml # use default cops
-    - pending.yml # use pending cops 
+    - pending.yml # use pending cops
     - rails.yml # use Rails cops - see Additional Extensions/Cops
-    - rails-pending.yml # use pending rails cops 
-    - rspec.yml # use rspec cops 
+    - rails-pending.yml # use pending rails cops
+    - rspec.yml # use rspec cops
 ```
 
 ### Additional Extensions/Cops
@@ -60,7 +60,7 @@ To enable add the following to your `.rubocop.yml` file.
 ```yml
 inherit_gem:
   boxt_ruby_style_guide:
-  # .... add cops 
+  # .... add cops
 
 require:
   - rubocop-faker # if your project is using the Faker gem then add this
@@ -75,9 +75,17 @@ Lint tasks to run against files listed as changed by Git.
 To run `rubocop` against any changed files use:
 
 ```sh
-rake lint:rubocop
+rake lint:rubocop RUBOCOP_LINT_BASE=your-base-branch
 ```
 
+To run `rubocop` with autofix, use one of the following:
+
+```sh
+rake lint:rubocop_a RUBOCOP_LINT_BASE=your-base-branch
+rake lint:rubocop_A RUBOCOP_LINT_BASE=your-base-branch
+```
+
+
 If there are no changed files the commands will run against all files.
 
 ## Editor Plugins

data/VERSION

@@ -1 +1 @@
-7.4.0
+7.7.3

data/default.yml

@@ -1,11 +1,11 @@
 AllCops:
   Exclude:
     - "**/*/schema.rb"
-    - Gemfile.lock
-    - node_modules/**/*
-    - tmp/**/*
-    - vendor/**/*
-  TargetRubyVersion: 2.7.1
+    - "Gemfile.lock"
+    - "node_modules/**/*"
+    - "tmp/**/*"
+    - "vendor/**/*"
+  TargetRubyVersion: 2.7.2
 Layout/LineLength:
   Exclude:
     - config/routes.rb

data/lib/boxt_ruby_style_guide/filepath_matcher.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module BoxtRubyStyleGuide
+  ##
+  # Sanitizes a list of filepaths based on Rubocops exclusions
+  class FilepathMatcher
+    require "yaml"
+
+    ##
+    # Compare a given filepath with a grep-style filename pattern
+    FILEPATH_PATTERN_MATCH = proc do |filepath, pattern|
+      File.fnmatch(pattern, filepath, File::FNM_PATHNAME)
+    end
+
+    ##
+    # Array of file patterns to make sure we only check files that are Ruby files
+    INCLUDE_PATTERNS = %w[
+      Gemfile
+      Rakefile
+      *.gemspec
+      **/*.rb
+      **/*.rake
+    ].freeze
+
+    ##
+    # Array of the excluded files from Rubocop default.yml config
+    EXCLUDE_PATTERNS = YAML.load_file(
+      BoxtRubyStyleGuide.root.join("default.yml")
+    ).dig("AllCops", "Exclude")
+
+    attr_reader :filepaths
+
+    def initialize(*filepaths)
+      @filepaths = filepaths
+    end
+
+    def all_matches
+      filepaths.select do |filepath|
+        filepath_proc = FILEPATH_PATTERN_MATCH.curry.call(filepath)
+        INCLUDE_PATTERNS.any?(filepath_proc) && EXCLUDE_PATTERNS.none?(filepath_proc)
+      end
+    end
+  end
+end

data/lib/boxt_ruby_style_guide/git_diff.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module BoxtRubyStyleGuide
+  # Returns a list of files that have changed, as detected by `git-diff`
+  #
+  # TODO: Write tests for this to ensure we're pulling the desired diff files
+  # see: https://github.com/ruby-git/ruby-git
+  class GitDiff
+    require "git"
+
+    ##
+    # List of Git statuses we should test
+    # See: https://git-scm.com/docs/git-status#_short_format
+    TEST_STATUSES = %w[M A U].freeze
+
+    attr_reader :base
+
+    def initialize(base = "master")
+      @base = base
+    end
+
+    ##
+    # A list of the local file paths of Ruby files with committed changes.
+    #
+    # Returns Array
+    def all
+      @all ||= begin
+        git.diff(base).name_status.select { |_, stat| TEST_STATUSES.include?(stat) }.keys
+      end
+    end
+
+    private
+
+    def git
+      @git ||= Git.open(".")
+    end
+  end
+end

data/lib/tasks/lint.rake

@@ -3,60 +3,53 @@
 require "boxt_ruby_style_guide"
 require "rubocop"
 
+require "boxt_ruby_style_guide/git_diff"
+require "boxt_ruby_style_guide/filepath_matcher"
+
 ##
 # The base branch to compare HEAD with for changes
 BASE_BRANCH = "develop"
 
 ##
-# Directories containing Ruby files to lint
-RUBY_DIRS = %w[app lib test spec].freeze
+# Name of the master Rubocop lint task to run
+RUBOCOP_TASK_NAME = :"lint:execute_rubocop"
 
 ##
-# Grep file pattern to make sure we only check files that are Ruby files
-# This pattern matches the following:
-#
-# - Gemfile
-# - Rakefile
-# - *.gemspec
-# - app/**/*.{rb,rake}
-# - lib/**/*.{rb,rake}
-# - test/**/*.{rb,rake}
-# - spec/**/*.{rb,rake}
-#
-GREP_PATTERN = <<~STRING.delete("\n")
-  (
-    (#{RUBY_DIRS.join('|')})\\/.+\\.(rb|rake)
-    |^
-    (Gemfile|Rakefile|.+\\.gemspec)
-  )
-STRING
+# Pattern for matching autofix options
+AUTO_REGEX = /\A-a\Z/i.freeze
 
 namespace :lint do
   desc "Runs rubocop against all files with committed changes different from base branch"
   task :rubocop do
-    exec("rubocop #{diff_file_paths};")
+    Rake::Task[RUBOCOP_TASK_NAME].invoke
+  end
+
+  desc "Runs rubocop against all files using -a (soft autofix) option"
+  task :rubocop_a do
+    Rake::Task[RUBOCOP_TASK_NAME].invoke("-a")
+  end
+
+  desc "Runs rubocop against all files using -A (hard autofix) option"
+  task :rubocop_A do
+    Rake::Task[RUBOCOP_TASK_NAME].invoke("-A")
   end
 
-  private
-
-  # A list of the local file paths of Ruby files with committed changes.
-  #
-  #   Run a git diff-tree command with the following otions:
-  #     -r recursive
-  #     --name-only Only return the name of the files
-  #     --diff-filter Filter out results that have been deleted on HEAD
-  #
-  #   Pipe the output from this command through grep to match only Ruby files in the
-  #     desired directories
-  #
-  # Returns String
-  def diff_file_paths
-    base_branch = ENV.fetch("RUBOCOP_LINT_BASE", BASE_BRANCH)
-    command = <<~BASH
-      git diff-tree -r --name-only --diff-filter=d #{base_branch} HEAD \
-        | egrep '#{GREP_PATTERN}'
-    BASH
-    file_paths = `#{command}`
-    file_paths.gsub(/\n|\r/, " ")
+  task :execute_rubocop, [:auto_flag] do |_t, args|
+    if sanitized_file_paths.any?
+      # Sanitize args to make sure only a single "a" or "A" is accepted
+      auto_flag = AUTO_REGEX.match(args[:auto_flag])
+      exec("bundle exec rubocop #{sanitized_file_paths.join(" ")} #{auto_flag}".strip)
+    else
+      puts "No matching Ruby files changed"
+    end
   end
 end
+
+private
+
+# Returns Array
+def sanitized_file_paths
+  base = ENV.fetch("RUBOCOP_LINT_BASE", BASE_BRANCH)
+  changed_files = BoxtRubyStyleGuide::GitDiff.new(base).all
+  BoxtRubyStyleGuide::FilepathMatcher.new(*changed_files).all_matches
+end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: boxt_ruby_style_guide
 version: !ruby/object:Gem::Version
-  version: 7.4.0
+  version: 7.7.3
 platform: ruby
 authors:
 - Boxt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-01 00:00:00.000000000 Z
+date: 2020-10-23 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -31,6 +45,9 @@ dependencies:
     - - ">"
       - !ruby/object:Gem::Version
         version: '5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -38,6 +55,9 @@ dependencies:
     - - ">"
       - !ruby/object:Gem::Version
         version: '5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: rubocop-faker
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +114,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: bundler-audit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0.1
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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
@@ -164,6 +212,8 @@ files:
 - VERSION
 - default.yml
 - lib/boxt_ruby_style_guide.rb
+- lib/boxt_ruby_style_guide/filepath_matcher.rb
+- lib/boxt_ruby_style_guide/git_diff.rb
 - lib/boxt_ruby_style_guide/railtie.rb
 - lib/boxt_ruby_style_guide/version.rb
 - lib/tasks/lint.rake