boxt_ruby_style_guide 8.6.0 → 9.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b848d450aca559043327a5023b63c46ab860192f81bb522731c52430e54d0ba3
-  data.tar.gz: 8124ee02a9e37c20d88c8219eef01a16edde84bee60c7c44e50f82a7c904127a
+  metadata.gz: e80a3139b64281d1d480508fa3ce7dc0c1b62210218768199f23ae16d49a2b32
+  data.tar.gz: 6538b9a8cb4f0898a26d47dd57702f2aaa7d7c2a791f2af25755484dd92ade5d
 SHA512:
-  metadata.gz: 57197bca670c43219c3cc77e71a26f10d7a7e398a24e00fdea650d58ba54a464c048a233ec7f47b0bb3d1c8a276a58f0d2cd8e7a5621be50afba5c5a783c4aa0
-  data.tar.gz: 81fa5b4fa6fa80ac6a591d90ac85ef806775a6bd9decb64c3c9743ded14b403b9c97942c3a84a34c60efd11ba2b60c1a4ba72e2a3a4fb3add989246672ecbeac
+  metadata.gz: 1cb669ffed52b30d9cb8cbf48688889101c9dc33e2dd49edc9f863ea2b1f198aedd20ed6b9781c8827665abf9d232938f931dc0a549e58708aa1a5d66a41781f
+  data.tar.gz: 4d00c2cad890ce8532508684afdebf6ebbaf7181b6de62fc02086503ba60fb28bc8666001752cd12e7b18429b3a9787600172b90743cd65d7130074247162682

data/README.md

@@ -1,6 +1,7 @@
 # BOXT Ruby Style Guide
 
-[![Gem Version](https://badge.fury.io/rb/boxt_ruby_style_guide.png)](https://badge.fury.io/rb/boxt_ruby_style_guide)
+[![Gem Version](https://badge.fury.io/rb/boxt_ruby_style_guide.svg)](https://badge.fury.io/rb/boxt_ruby_style_guide)
+[![CI](https://github.com/boxt/boxt_ruby_style_guide/actions/workflows/ci.yml/badge.svg)](https://github.com/boxt/boxt_ruby_style_guide/actions/workflows/ci.yml)
 
 Ruby style guide and base Rubocop settings for Boxt Ruby projects.
 
@@ -23,6 +24,10 @@ And then execute:
 bundle
 ```
 
+## Requirements
+
+* Ruby 2.7 or above
+
 ## Usage
 
 Add a `.rubocop.yml` file to the root of your project with the following settings:
@@ -38,6 +43,7 @@ inherit_gem:
 ### NewCops
 
 `NewCops` is enabled by default.
+
 ### Additional Extensions/Cops
 
 The following Rubocop gems are also installed with this gem:
@@ -61,26 +67,6 @@ require:
   - rubocop-rspec # if your project is using rspec then add this, plus the - rspec.yml setting above
 ```
 
-## Lint Tasks
-
-Lint tasks to run against files listed as changed by Git.
-
-To run `rubocop` against any changed files use:
-
-```sh
-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
 
 There are also some useful Rubocop editor plugins to help with in-editor linting.

data/Rakefile

@@ -4,8 +4,6 @@ require "bundler/gem_tasks"
 require "rake/testtask"
 require "rspec/core/rake_task"
 
-import "lib/tasks/lint.rake"
-
 RSpec::Core::RakeTask.new(:spec) do |t|
   t.pattern = Dir.glob("spec/**/*_spec.rb")
 end

data/VERSION

@@ -1 +1 @@
-8.6.0
+9.1.0

data/default.yml

@@ -6,10 +6,10 @@ AllCops:
     - tmp/**/*
     - vendor/**/*
   NewCops: enable
-  TargetRubyVersion: 2.7
 Layout/LineLength:
   Exclude:
     - config/routes.rb
+    - config/routes/*
   Max: 120
 Metrics/AbcSize:
   Exclude:

data/lib/boxt_ruby_style_guide.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require "boxt_ruby_style_guide/railtie" if defined?(Rails)
 require "boxt_ruby_style_guide/version"
 
 module BoxtRubyStyleGuide

data/rspec.yml

@@ -3,8 +3,10 @@
 RSpec/DescribeClass:
   Exclude:
     - spec/tasks/**/*
-
 # This is to prevent Rubocop from bugging on a spec helper that doesn't contain an example, which the support ones don't
 RSpec/LeadingSubject:
   Exclude:
     - spec/support
+# Allow there to be a max of 4 example groups deep in Rspec tests
+RSpec/NestedGroups:
+  Max: 4

metadata

@@ -1,43 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: boxt_ruby_style_guide
 version: !ruby/object:Gem::Version
-  version: 8.6.0
+  version: 9.1.0
 platform: ruby
 authors:
 - Boxt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-16 00:00:00.000000000 Z
+date: 2022-01-11 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'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.23.0
+        version: 1.24.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.23.0
+        version: 1.24.1
 - !ruby/object:Gem::Dependency
   name: rubocop-faker
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +44,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.12.4
+        version: 2.13.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.12.4
+        version: 2.13.1
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +72,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.6.0
+        version: 2.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.6.0
+        version: 2.7.0
 description: Ruby style guide info for BOXT projects, as well as config settings for
   Rubocop
 email:
@@ -108,11 +94,7 @@ 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
 - rails.yml
 - rspec.yml
 homepage: https://github.com/boxt/ruby-style-guide
@@ -135,7 +117,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.2.33
 signing_key:
 specification_version: 4
 summary: Ruby style guide info for BOXT Ruby projects

data/lib/boxt_ruby_style_guide/filepath_matcher.rb

@@ -1,44 +0,0 @@
-# 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

@@ -1,36 +0,0 @@
-# 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 ||= git.diff(base).name_status.select { |_, stat| TEST_STATUSES.include?(stat) }.keys
-    end
-
-    private
-
-    def git
-      @git ||= Git.open(".")
-    end
-  end
-end

data/lib/boxt_ruby_style_guide/railtie.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-require "rails"
-
-module BoxtRubyStyleGuide
-  class Railtie < Rails::Railtie
-    rake_tasks do
-      files = BoxtRubyStyleGuide.root.join("lib", "tasks", "*.rake")
-      Dir[files].each { |file| load(file) }
-    end
-  end
-end

data/lib/tasks/lint.rake

@@ -1,30 +0,0 @@
-# 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"
-
-namespace :lint do
-  desc "Runs rubocop against all files with committed changes different from base branch"
-  task :rubocop do
-    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
-
-# 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