boxt_ruby_style_guide 7.6.0 → 7.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7fdb78910aef325a37d80abf635b2c675d190e63669133b14f19ebcad1c480d9
-  data.tar.gz: 5c58cb56cfeb23d4769f8681bd21c16b5f39a3401ecbb6a016b3ba7cdf1c68f7
+  metadata.gz: 3269906781941588a2da2ed478c324852a270245e9aeb64cddc877835d6ede19
+  data.tar.gz: 9b1255d5557fd33a70e3cb5f6fccf61d5c7ac44f37055bff8e193108927e00d8
 SHA512:
-  metadata.gz: be5aa640996292e3d526e91a27fb2365eebb84c2e2c02f32f0a1d2b47dbe04340e0e11f15a30d9b6c60a2b25a56430dce48a950cf2522b227ce0f51acb99c58d
-  data.tar.gz: 667f275e3560ec91b6c20ca8bdd6f58cfc7f079c1207812d891af364e5a086823e0f7679c8e0537598c9dd4f03d230c7853b8828787a481eb2a8e5b023adfc28
+  metadata.gz: d1ce04bee4be54bdc9b5bdb4fa55695d364e32546f0c7a0fa93fb458c72d38510cc48667f51809387e39ab12e37058592a3ac4ea3d43e7910177e17f2da6179b
+  data.tar.gz: 4516330c35be5df90616fa65cf8370afa368b441fe3d495da0e5b9542bafd12d0218b1a331eeaa3c548cf93d3ea4f1a26098c5ad7da25ff6b8906dd5b4f543b6

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.6.0
+7.7.0

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)
+    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,62 +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").delete("\s")
-  (
-    (#{RUBY_DIRS.join('|')})\\/.+\\.(rb|rake)
-    |^
-    (Gemfile|Rakefile|.+\\.gemspec)
-  \Z)
-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(<<~BASH)
-      RUBOCOP_CHANGED_FILES=`#{diff_file_paths}`
-      if [ -z "$RUBOCOP_CHANGED_FILES" ]; then
-        echo "No matching Ruby files changed"
-      else
-        bundle exec rubocop $RUBOCOP_CHANGED_FILES
-      fi
-    BASH
+    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
 
-  private
+  desc "Runs rubocop against all files using -A (hard autofix) option"
+  task :rubocop_A do
+    Rake::Task[RUBOCOP_TASK_NAME].invoke("-A")
+  end
 
-  # 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)
-    "git diff -r --name-only --diff-filter=d #{base_branch} | egrep '#{GREP_PATTERN}'"
+  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 $RUBOCOP_CHANGED_FILES #{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.6.0
+  version: 7.7.0
 platform: ruby
 authors:
 - Boxt
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-12 00:00:00.000000000 Z
+date: 2020-10-19 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
@@ -100,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
@@ -170,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