boxt_ruby_style_guide 7.5.0 → 7.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c98e2c24a98ee1a1b71ff68d8ac9e1a71fc828e7dd426fdca7cdb7d1d46bd95
-  data.tar.gz: d391b2f458db7d6c95e85674ccbacbd44c1b75e4b2cae553d42885e44797e1d2
+  metadata.gz: 7e8f3ee70573d3493385981a232a6b08389bdf815827b097aa7a24478f7e5a80
+  data.tar.gz: 7a7fede5a038a4e0b764b3ad629d83bafeeed03d9b980c4b851baefbf777c45a
 SHA512:
-  metadata.gz: c682a374a5084e2abc80665481fcd9df82f99b301064916153d5d6dd8ed587d226f83698627ab804a98e449fffe0d78fa16e8e7ccfcd0f8c60a13add8196b545
-  data.tar.gz: '09e6a7393ba970d72171d6e85660a4482594f54de05d9f63ae4248aca894992110073f20bfb9fe9b9feab3c8d2d31399e687fa935b57a6a073e1c4807da9d31a'
+  metadata.gz: ffe098e6a1fa3323b8897fbf5cdbff05b0e4e37d66988fdecb15a0f866b7e110c430f6ce427bc15c7ce82fa9a4165029ee514788046c451ea271b6fa65a78bdd
+  data.tar.gz: 3a090c5cd4ce2bd4055866e9587842a759800b580c4cc196bc936c5005da60052789e117153bb3bb38175d6197176c6a5fba54ab193c5daea931f16dde00ae63

data/README.md

@@ -24,13 +24,6 @@ And then execute:
 bundle
 ```
 
-To make the lint rake tasks available to non Rails apps and gems, add the following to the project's `Rakefile`:
-
-```ruby
-require "boxt_ruby_style_guide"
-BoxtRubyStyleGuide.install_tasks
-```
-
 Rails apps should have access to the lint tasks by default.
 
 ## Usage
@@ -41,10 +34,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 +53,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 +68,17 @@ Lint tasks to run against files listed as changed by Git.
 To run `rubocop` against any changed files use:
 
 ```sh
-rake lint:rubocop
+RUBOCOP_LINT_BASE=your-base-branch rake lint:rubocop 
 ```
 
+To run `rubocop` with autofix, use one of the following:
+
+```sh
+RUBOCOP_LINT_BASE=your-base-branch rake lint:rubocop -a 
+RUBOCOP_LINT_BASE=your-base-branch rake lint:rubocop -A
+```
+
+
 If there are no changed files the commands will run against all files.
 
 ## Editor Plugins

data/VERSION

@@ -1 +1 @@
-7.5.0
+7.8.0

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:)
+      @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

@@ -1,61 +1,30 @@
 # frozen_string_literal: true
 
 require "boxt_ruby_style_guide"
+require "boxt_ruby_style_guide/filepath_matcher"
+require "boxt_ruby_style_guide/git_diff"
 require "rubocop"
 
-##
-# 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
-
-##
-# 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
-
 namespace :lint do
   desc "Runs rubocop against all files with committed changes different from base branch"
   task :rubocop do
-    exec("rubocop #{diff_file_paths};")
+    file_paths = sanitized_file_paths
+    puts "File paths: #{file_paths.join(', ')}"
+
+    if file_paths.any?
+      auto_flag_opt = ARGV.select { |a| ["-a", "-A"].include?(a) }.first
+      exec("bundle exec rubocop #{file_paths.join(' ')} #{auto_flag_opt}".strip)
+    else
+      puts "No Ruby files changed"
+    end
   end
+end
 
-  private
+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 --name-only #{base_branch} HEAD | egrep '#{GREP_PATTERN}'
-    BASH
-    file_paths = `#{command}`
-    file_paths.gsub(/\n|\r/, " ")
-  end
+# Returns an array of files
+def sanitized_file_paths
+  base = ENV.fetch("RUBOCOP_LINT_BASE", "main")
+  changed_files = BoxtRubyStyleGuide::GitDiff.new(base: base).all
+  BoxtRubyStyleGuide::FilepathMatcher.new(*changed_files).all_matches
 end

metadata

@@ -1,49 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: boxt_ruby_style_guide
 version: !ruby/object:Gem::Version
-  version: 7.5.0
+  version: 7.8.0
 platform: ruby
 authors:
 - Boxt
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-03 00:00:00.000000000 Z
+date: 2020-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: git
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.92.0
+        version: '1.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.92.0
+        version: '1.4'
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
-      - !ruby/object:Gem::Version
-        version: '5'
-    - - "<"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '7'
-  type: :development
+        version: 1.4.2
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
-      - !ruby/object:Gem::Version
-        version: '5'
-    - - "<"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '7'
+        version: 1.4.2
 - !ruby/object:Gem::Dependency
   name: rubocop-faker
   requirement: !ruby/object:Gem::Requirement
@@ -78,14 +72,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.43.2
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.43.2
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -100,6 +94,54 @@ 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: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
 - !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
@@ -181,7 +225,7 @@ homepage: https://github.com/boxt/ruby-style-guide
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -196,8 +240,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Ruby styleguide info for the BOXT Ruby projects
 test_files: []