boxt_ruby_style_guide 7.7.2 → 7.9.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28eca289d2e48ea7d90efe79f6815253121c1876e5066033cfe11ad802f8c901
-  data.tar.gz: 1608aaac5753d5f00865542d18f1f0daf9b0bf7852aff5139ab65079feca23f8
+  metadata.gz: f80925ef4cebf042e32849792ad200553a71646704fba299a502940649b66cd4
+  data.tar.gz: 672f8b91fc0218521b17f5857235eef8eede17ba4c7812f4e4a9253030df079c
 SHA512:
-  metadata.gz: 431b69e3a82bf76119f8e7b7936042dc3ef64ee6dcdce6d6c6e9244140cab9b4e7fa8e5cfffbd31245e9026af5fe4a127e8166c9261a0a0d6fd80710423bcf88
-  data.tar.gz: 6440d530e3bde18b2645cac87e48c3a987bfdc0992f11b905db068ea51ba3ba955733ba207c3719793e8e71ec6c8eee52a1b93d2e5e6d373ed476ede390a2973
+  metadata.gz: efac4d096f3d5772db668628c832a9df08e4e3756d2c62a7915063b9233b0ffa06768da9bebd92bc62053cdeadaae129bbd11d2f15c43c896eb1bd24a3020d55
+  data.tar.gz: e13776ce69c0bbd8102f41a9259d89dac66dcf5a7728960fbd3686352b14791e61032486680bf3fbc4aaa6372779bec78219a75fdaefa94e065f5d905a748fa0

data/README.md

@@ -1,12 +1,11 @@
 # 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)
+
 Ruby style guide and base Rubocop settings for Boxt Ruby projects.
 
 For the most part we are using [this Ruby style guide](https://github.com/bbatsov/ruby-style-guide) as the base guide, with any deviations can be found in the `default.yml`.
 
-[![Gem Version](https://badge.fury.io/rb/boxt_ruby_style_guide.png)](https://badge.fury.io/rb/boxt_ruby_style_guide)
-[![CircleCI](https://circleci.com/gh/boxt/boxt_ruby_style_guide/tree/master.svg?style=svg)](https://circleci.com/gh/boxt/boxt_ruby_style_guide/tree/master)
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -24,15 +23,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
 
 Add a `.rubocop.yml` file to the root of your project with the following settings:
@@ -53,6 +43,7 @@ The following Rubocop gems are also installed with this gem:
 
 * [rubocop-faker](https://github.com/koic/rubocop-faker)
 * [rubocop-rails](https://github.com/rubocop-hq/rubocop-rails)
+* [rubocop-rake](https://github.com/rubocop-hq/rubocop-rake)
 * [rubocop-rspec](https://github.com/rubocop-hq/rubocop-rspec)
 
 To enable add the following to your `.rubocop.yml` file.
@@ -65,6 +56,7 @@ inherit_gem:
 require:
   - rubocop-faker # if your project is using the Faker gem then add this
   - rubocop-rails # if your project is a Rails app/engine then add this, plus the - rails.yml setting above
+  - rubocop-rake # if your project is using rake then add this
   - rubocop-rspec # if your project is using rspec then add this, plus the - rspec.yml setting above
 ```
 
@@ -75,14 +67,14 @@ 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
+RUBOCOP_LINT_BASE=your-base-branch rake lint:rubocop 
 ```
 
 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
+RUBOCOP_LINT_BASE=your-base-branch rake lint:rubocop -a 
+RUBOCOP_LINT_BASE=your-base-branch rake lint:rubocop -A
 ```
 
 

data/Rakefile

@@ -10,4 +10,5 @@ RSpec::Core::RakeTask.new(:spec) do |t|
   t.pattern = Dir.glob("spec/**/*_spec.rb")
 end
 
+desc "Map rake test to rake spec"
 task test: :spec

data/VERSION

@@ -1 +1 @@
-7.7.2
+7.9.2

data/default.yml

@@ -5,7 +5,7 @@ AllCops:
     - "node_modules/**/*"
     - "tmp/**/*"
     - "vendor/**/*"
-  TargetRubyVersion: 2.7.1
+  TargetRubyVersion: 2.7.2
 Layout/LineLength:
   Exclude:
     - config/routes.rb

data/lib/boxt_ruby_style_guide/git_diff.rb

@@ -15,7 +15,7 @@ module BoxtRubyStyleGuide
 
     attr_reader :base
 
-    def initialize(base = "master")
+    def initialize(base:)
       @base = base
     end
 

data/lib/tasks/lint.rake

@@ -1,55 +1,30 @@
 # frozen_string_literal: true
 
 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"
-
-##
-# Name of the master Rubocop lint task to run
-RUBOCOP_TASK_NAME = :"lint:execute_rubocop"
-
-##
-# Pattern for matching autofix options
-AUTO_REGEX = /\A-a\Z/i.freeze
+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
-    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
-
-  desc "Runs rubocop against all files using -A (hard autofix) option"
-  task :rubocop_A do
-    Rake::Task[RUBOCOP_TASK_NAME].invoke("-A")
-  end
+    file_paths = sanitized_file_paths
+    puts "File paths: #{file_paths.join(', ')}"
 
-  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 #{sanitized_file_paths.join(" ")} #{auto_flag}".strip)
+    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 matching Ruby files changed"
+      puts "No Ruby files changed"
     end
   end
 end
 
 private
 
-# Returns Array
+# Returns an array of files
 def sanitized_file_paths
-  base = ENV.fetch("RUBOCOP_LINT_BASE", BASE_BRANCH)
-  changed_files = BoxtRubyStyleGuide::GitDiff.new(base).all
+  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,63 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: boxt_ruby_style_guide
 version: !ruby/object:Gem::Version
-  version: 7.7.2
+  version: 7.9.2
 platform: ruby
 authors:
 - Boxt
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-19 00:00:00.000000000 Z
+date: 2021-02-16 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
+        version: '1.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: '1.4'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.92.0
+        version: 1.10.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        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'
+        version: 1.10.0
 - !ruby/object:Gem::Dependency
   name: rubocop-faker
   requirement: !ruby/object:Gem::Requirement
@@ -78,126 +58,42 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.8.1
+        version: 2.9.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.8.1
+        version: 2.9.1
 - !ruby/object:Gem::Dependency
-  name: rubocop-rspec
+  name: rubocop-rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.43.2
+        version: 0.5.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.43.2
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !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
+        version: 0.5.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
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.9'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.9'
-- !ruby/object:Gem::Dependency
-  name: rspec-nc
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.3'
-- !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.19'
-  type: :development
+        version: 2.2.0
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.19'
+        version: 2.2.0
 description: Ruby styleguide info for the BOXT projects, as well as config settings
   for Rubocop
 email:
@@ -225,7 +121,7 @@ homepage: https://github.com/boxt/ruby-style-guide
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -240,8 +136,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: []