boxt_ruby_style_guide 8.5.1 → 9.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b1063f1ad100f533865999a851ee2af7970193805e6d98aed67fcc19d738817
-  data.tar.gz: dbe3898f75c24f22544dbc4f012e06ab9adb80620f12f3d33c54153a7eec29c6
+  metadata.gz: 0b6c99e3e3fb5828e9b5dbec10c8612d6b0841f019685367c345ac78928a0f82
+  data.tar.gz: f08f3542b536055ac7b95d855f0e3a8a58d17d1ecda6cf329c37b4aed8b61c02
 SHA512:
-  metadata.gz: 59a972205dba30e8f5653ffabbc7d6ef2abcec0bc186c35e5e5abc9469a314de3cc2e41cf726b0d3a72f9012fed6a440cdd2b86d700d91a7123da6be20fdfa04
-  data.tar.gz: b7b630ec7251fe98990b537c522371c2d1c8a8442ba103742febe607cf295396cbe00e2ec34cfd190cc298729756312c24342040e5d397d169a6d1dc41703356
+  metadata.gz: 2dd53905fed000e8821df54c25d377b9dec190b84924ad4086bacd5aee3b200b5a39e0080bdea489866acbe4268ac910c6e72594f7040b86babd1cc70feb44d8
+  data.tar.gz: 5e375c601ebeb517be15c383c472008b31753bfa89bbad63971c92afc5b25f2db96bf296e0fbda73977c7e9b33a4de20e755c4fc9efb07ac2c4d409b9122fdfc

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.5.1
+9.0.2

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

metadata

@@ -1,43 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: boxt_ruby_style_guide
 version: !ruby/object:Gem::Version
-  version: 8.5.1
+  version: 9.0.2
 platform: ruby
 authors:
 - Boxt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-08 00:00:00.000000000 Z
+date: 2022-01-07 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.22.3
+        version: 1.24.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.22.3
+        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.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.12.4
+        version: 2.13.0
 - !ruby/object:Gem::Dependency
   name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
@@ -86,16 +72,16 @@ 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
-description: Ruby styleguide info for the BOXT projects, as well as config settings
-  for Rubocop
+        version: 2.7.0
+description: Ruby style guide info for BOXT projects, as well as config settings for
+  Rubocop
 email:
 - developers@boxt.co.uk
 executables: []
@@ -108,17 +94,14 @@ 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
 licenses:
 - MIT
-metadata: {}
+metadata:
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -137,5 +120,5 @@ requirements: []
 rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
-summary: Ruby styleguide info for the BOXT Ruby projects
+summary: Ruby style guide info for BOXT Ruby projects
 test_files: []

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