boxt_ruby_style_guide 7.2.0 → 7.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad901e73bc30af6e1eee0a142fb2ca9422abceb733bc5e31f4652014c43dcb9b
-  data.tar.gz: bfabdeb23f3c4448d7192a27786ba9b8febebf669358a449bbab57c9b24103e6
+  metadata.gz: 7fdb78910aef325a37d80abf635b2c675d190e63669133b14f19ebcad1c480d9
+  data.tar.gz: 5c58cb56cfeb23d4769f8681bd21c16b5f39a3401ecbb6a016b3ba7cdf1c68f7
 SHA512:
-  metadata.gz: 80994cd501fc8e71b7bd94215b12db3ae55186349fefe1a81a0e03095f2b1f92ce165074ace9042f5c469e3636e1512e137de6170edd931a85a261cc61c3fc70
-  data.tar.gz: 55c6bc374533770ea2ff28b774247a71670314b46b5c2ee4324d1d1a8ea74ff905d6b023d9746aa814ae88a9b3174f9975bd6675f8c022eaa7d8c8732e4191b1
+  metadata.gz: be5aa640996292e3d526e91a27fb2365eebb84c2e2c02f32f0a1d2b47dbe04340e0e11f15a30d9b6c60a2b25a56430dce48a950cf2522b227ce0f51acb99c58d
+  data.tar.gz: 667f275e3560ec91b6c20ca8bdd6f58cfc7f079c1207812d891af364e5a086823e0f7679c8e0537598c9dd4f03d230c7853b8828787a481eb2a8e5b023adfc28

data/Rakefile

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

data/VERSION

@@ -1 +1 @@
-7.2.0
+7.6.0

data/default.yml

@@ -1,33 +1,39 @@
 AllCops:
-  TargetRubyVersion: 2.7.1
   Exclude:
     - "**/*/schema.rb"
-    - "Gemfile.lock"
-    - "node_modules/**/*"
-    - "tmp/**/*"
-    - "vendor/**/*"
+    - Gemfile.lock
+    - node_modules/**/*
+    - tmp/**/*
+    - vendor/**/*
+  TargetRubyVersion: 2.7.1
 Layout/LineLength:
-  Max: 120 # Increase line length to 120
   Exclude:
-    - "config/routes.rb"
+    - config/routes.rb
+  Max: 120
+Metrics/AbcSize:
+  Exclude:
+    - db/migrate/**/*
 Metrics/BlockLength:
   Exclude:
     - "*.gemspec"
-    - "Gemfile"
-    - "config/routes.rb"
-    - "spec/**/*"
-    - "test/**/*"
+    - Gemfile
+    - config/routes.rb
+    - db/migrate/**/*
+    - spec/**/*
+    - test/**/*
 Metrics/ClassLength:
   Exclude:
-    - "spec/**/*"
-    - "test/**/*"
+    - db/migrate/**/*
+    - spec/**/*
+    - test/**/*
 Metrics/MethodLength:
   Exclude:
-    - "spec/**/*"
-    - "test/**/*"
+    - db/migrate/**/*
+    - spec/**/*
+    - test/**/*
+Style/Documentation:
+  Enabled: false
 Style/DoubleNegation:
   Enabled: false
-Style/Documentation:
-  Enabled: false # Disable Style/Documentation because...
 Style/StringLiterals:
-  EnforcedStyle: double_quotes # Use double quotes ALL THE TIME!!!
+  EnforcedStyle: double_quotes

data/lib/boxt_ruby_style_guide.rb

@@ -4,17 +4,13 @@ require "boxt_ruby_style_guide/railtie" if defined?(Rails)
 require "boxt_ruby_style_guide/version"
 
 module BoxtRubyStyleGuide
-  class << self
-    def install_tasks
-      Dir[File.join(gem_spec.gem_dir, "tasks/*.rake")].each do |file|
-        load(file)
-      end
-    end
+  module_function
 
-    private
-
-    def gem_spec
-      Gem::Specification.find_by_name("boxt_ruby_style_guide")
-    end
+  ##
+  # Provide a root path helper for the gem root dir
+  #
+  # Returns Pathname
+  def root
+    Pathname.new(File.dirname(__dir__))
   end
 end

data/lib/boxt_ruby_style_guide/railtie.rb

@@ -5,7 +5,7 @@ require "rails"
 module BoxtRubyStyleGuide
   class Railtie < Rails::Railtie
     rake_tasks do
-      files = File.join(File.dirname(__FILE__), "../../tasks/*.rake")
+      files = BoxtRubyStyleGuide.root.join("lib", "tasks", "*.rake")
       Dir[files].each { |file| load(file) }
     end
   end

data/lib/tasks/lint.rake

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require "boxt_ruby_style_guide"
+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").delete("\s")
+  (
+    (#{RUBY_DIRS.join('|')})\\/.+\\.(rb|rake)
+    |^
+    (Gemfile|Rakefile|.+\\.gemspec)
+  \Z)
+STRING
+
+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
+  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)
+    "git diff -r --name-only --diff-filter=d #{base_branch} | egrep '#{GREP_PATTERN}'"
+  end
+end

data/rails.yml

@@ -1,29 +1,11 @@
-# Rails specific cops
-Rails/ApplicationController:
-  Exclude:
-    - "spec/**/*"
-    - "test/**/*"
-Rails/SkipsModelValidations:
-  Exclude:
-    - "db/migrate/**/*"
-    - "lib/tasks/**/*"
-    - "spec/**/*"
-    - "test/**/*"
-Rails/UnknownEnv:
-  Environments:
-    - cucumber
-    - development
-    - production
-    - qa
-    - test
-    - uat
-
-# These rails cops are currently pending and will be enabled by default at some point, but adding for now to stop
-# Rubocop or VSCode complaining...
 Rails/ActiveRecordCallbacksOrder:
   Enabled: true
 Rails/AfterCommitOverride:
   Enabled: true
+Rails/ApplicationController:
+  Exclude:
+    - spec/**/*
+    - test/**/*
 Rails/FindById:
   Enabled: true
 Rails/Inquiry:
@@ -44,8 +26,22 @@ Rails/RenderPlainText:
   Enabled: true
 Rails/ShortI18n:
   Enabled: true
+Rails/SkipsModelValidations:
+  Exclude:
+    - db/migrate/**/*
+    - lib/tasks/**/*
+    - spec/**/*
+    - test/**/*
 Rails/SquishedSQLHeredocs:
   Enabled: true
+Rails/UnknownEnv:
+  Environments:
+    - cucumber
+    - development
+    - production
+    - qa
+    - test
+    - uat
 Rails/WhereExists:
   Enabled: true
 Rails/WhereNot:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: boxt_ruby_style_guide
 version: !ruby/object:Gem::Version
-  version: 7.2.0
+  version: 7.6.0
 platform: ruby
 authors:
 - Boxt
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-25 00:00:00.000000000 Z
+date: 2020-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -16,14 +16,34 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.91.1
+        version: 0.92.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.91.1
+        version: 0.92.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: rubocop-faker
   requirement: !ruby/object:Gem::Requirement
@@ -128,14 +148,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: '0.19'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.18'
+        version: '0.19'
 description: Ruby styleguide info for the BOXT projects, as well as config settings
   for Rubocop
 email:
@@ -152,6 +172,7 @@ files:
 - lib/boxt_ruby_style_guide.rb
 - lib/boxt_ruby_style_guide/railtie.rb
 - lib/boxt_ruby_style_guide/version.rb
+- lib/tasks/lint.rake
 - pending.yml
 - rails-pending.yml
 - rails.yml
@@ -160,7 +181,7 @@ homepage: https://github.com/boxt/ruby-style-guide
 licenses:
 - MIT
 metadata: {}
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -175,8 +196,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
-signing_key:
+rubygems_version: 3.1.2
+signing_key: 
 specification_version: 4
 summary: Ruby styleguide info for the BOXT Ruby projects
 test_files: []