boxt_rubocop 0.0.47 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 231009180ee1b9b0868430b15b773ca50a8101ffb8a66a1398e5b1bb78f366fb
-  data.tar.gz: bdc82cf8a6f8bf3a928c088bd260b22bafbc4ed26db8e2a43b4b6fef3acbadde
+  metadata.gz: 1744a7d3b5eec56f26ffb86af39b0bf4ff4178a59f9480f4129fcbccbff30c0e
+  data.tar.gz: d0a3ab0c0b3946e9800c3b254c856a24d960e521f6f70e21296c57fd602855b3
 SHA512:
-  metadata.gz: ffc8ad1b40e20af26e8075a98e8bea4dec62c049d7bf2fe5af26df988748a710ebcd4ca121ad698a95a2b61e0c312161296c8a500fc1e2a75c4ad9f4e8047ebc
-  data.tar.gz: 87b2a5ef84b0c422310df7b798b7a436b130869f80ff4588ec649c3808b22c18cac971bfc4e67b81a0286a8f827397bfbb3034aee947c06b47996c23ea675dc8
+  metadata.gz: 3790f37f11cb18067d2e9419ec525d35b04938f47422529fd6be992962cd90e5309d55ad727b8a9e364a95d26831ed797dd24f647e35bbc30eac61a478402433
+  data.tar.gz: 52c2d7a75751ea244e9f89687fbcc83a69e47171e8f922ce364d7b4059ed36fc4379d81f105efd400dc8611a68f00a42b38f54752eee11deb8bbf388f8f85bbf

data/README.md

@@ -28,16 +28,37 @@ bundle
 
 ## Usage
 
-Add a `.rubocop.yml` file to the root of your project with the following settings:
+Put this into your .rubocop.yml.
+
+```yml
+require:
+ - boxt_rubocop
+ ```
+
+To enable additional configuration for `rubocop-rails` and `rubocop-rspec`, add the following to your .rubocop.yml:
 
 ```yml
 inherit_gem:
   boxt_rubocop:
-    - default.yml # use default cops
     - rails.yml # use Rails cops - see Additional Extensions/Cops
     - rspec.yml # use rspec cops - see Additional Extensions/Cops
 ```
 
+## Creating new custom cops
+
+Use the rake task new_cop to generate a cop template:
+
+```sh
+$ bundle exec rake 'new_cop[Boxt/Name]'
+[create] lib/rubocop/cop/boxt/name.rb
+[create] spec/rubocop/cop/boxt/name_spec.rb
+[modify] lib/rubocop/cop/boxt_cops.rb - `require_relative 'boxt/name'` was injected.
+[modify] A configuration for the cop is added into config/default.yml.
+
+```
+
+Documentation on creating a new cop can be found [here](https://docs.rubocop.org/rubocop/1.56/development.html#create-a-new-cop).
+
 ### NewCops
 
 `NewCops` is enabled by default.

data/Rakefile

@@ -1,12 +1,30 @@
 # frozen_string_literal: true
 
 require "bundler/gem_tasks"
-require "rake/testtask"
 require "rspec/core/rake_task"
 
-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
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList["spec/**/*_spec.rb"]
+end
+
+desc "Generate a new cop with a template"
+task :new_cop, [:cop] => :environment do |_task, args|
+  require "rubocop"
+
+  cop_name = args.fetch(:cop) do
+    warn "usage: bundle exec rake 'new_cop[Boxt/Name]'"
+    exit!
+  end
+
+  generator = RuboCop::Cop::Generator.new(cop_name)
+
+  generator.write_source
+  generator.write_spec
+  generator.inject_require(root_file_path: "lib/rubocop/cop/boxt_cops.rb")
+  generator.inject_config(config_file_path: "config/default.yml")
+
+  puts generator.todo
+end

data/VERSION

@@ -1 +1 @@
-0.0.47
+1.0.1

data/{default.yml → config/default.yml}

@@ -1,6 +1,3 @@
-require:
-  - ./lib/rubocop/cop/boxt/api_path_format.rb
-
 AllCops:
   Exclude:
     - "**/*/schema.rb"
@@ -10,6 +7,10 @@ AllCops:
     - vendor/**/*
   NewCops: enable
 
+Boxt/ApiPathFormat:
+  Description: 'Ensure that the API path uses kebab case'
+  Enabled: false
+
 Layout/ClassStructure:
   Enabled: true
 

data/lib/boxt_rubocop.rb

@@ -1,18 +1,11 @@
 # frozen_string_literal: true
 
-require "boxt_rubocop/version"
+require "rubocop"
 
-# Require all custom cops defined in rubocop/cop/**/*.rb
-Dir[File.join(__dir__, "rubocop", "cop", "**", "*.rb")].sort.each { |file| require file }
+require_relative "rubocop/boxt"
+require_relative "rubocop/boxt/version"
+require_relative "rubocop/boxt/inject"
 
-module BoxtRubocop
-  module_function
+RuboCop::Boxt::Inject.defaults!
 
-  ##
-  # Provide a root path helper for the gem root dir
-  #
-  # Returns Pathname
-  def root
-    Pathname.new(File.dirname(__dir__))
-  end
-end
+require_relative "rubocop/cop/boxt_cops"

data/lib/rubocop/boxt/inject.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# The original code is from https://github.com/rubocop/rubocop-rspec/blob/master/lib/rubocop/rspec/inject.rb
+# See https://github.com/rubocop/rubocop-rspec/blob/master/MIT-LICENSE.md
+module RuboCop
+  module Boxt
+    # Because RuboCop doesn't yet support plugins, we have to monkey patch in a
+    # bit of our configuration.
+    module Inject
+      def self.defaults!
+        path = CONFIG_DEFAULT.to_s
+        hash = ConfigLoader.send(:load_yaml_configuration, path)
+        config = Config.new(hash, path).tap(&:make_excludes_absolute)
+        Rails.logger.debug { "configuration from #{path}" } if ConfigLoader.debug?
+        config = ConfigLoader.merge_with_default(config, path)
+        ConfigLoader.instance_variable_set(:@default_configuration, config)
+      end
+    end
+  end
+end

data/lib/rubocop/boxt/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Boxt
+    VERSION = File.read(File.join(File.dirname(__FILE__), "../../../VERSION")).split("\n").first
+  end
+end

data/lib/rubocop/boxt.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative "boxt/version"
+
+module RuboCop
+  module Boxt
+    class Error < StandardError; end
+    PROJECT_ROOT   = Pathname.new(__dir__).parent.parent.expand_path.freeze
+    CONFIG_DEFAULT = PROJECT_ROOT.join("config", "default.yml").freeze
+    CONFIG         = YAML.safe_load(CONFIG_DEFAULT.read).freeze
+
+    private_constant(:CONFIG_DEFAULT, :PROJECT_ROOT)
+  end
+end

data/lib/rubocop/cop/boxt/api_path_format.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "rubocop"
-
 module RuboCop
   module Cop
     module Boxt
@@ -25,7 +23,7 @@ module RuboCop
       #   get  "/installation-days"
       #   namespace "password-resets"
       #
-      class ApiPathFormat < ::RuboCop::Cop::Base
+      class ApiPathFormat < Base
         def_node_matcher :path_defining_method_with_string_path, <<~PATTERN
           (send nil? {:post | :get | :namespace} (:str $_))
         PATTERN

data/lib/rubocop/cop/boxt_cops.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative "boxt/api_path_format"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: boxt_rubocop
 version: !ruby/object:Gem::Version
-  version: 0.0.47
+  version: 1.0.1
 platform: ruby
 authors:
 - Boxt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-26 00:00:00.000000000 Z
+date: 2023-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -105,10 +105,13 @@ files:
 - README.md
 - Rakefile
 - VERSION
-- default.yml
+- config/default.yml
 - lib/boxt_rubocop.rb
-- lib/boxt_rubocop/version.rb
+- lib/rubocop/boxt.rb
+- lib/rubocop/boxt/inject.rb
+- lib/rubocop/boxt/version.rb
 - lib/rubocop/cop/boxt/api_path_format.rb
+- lib/rubocop/cop/boxt_cops.rb
 - rails.yml
 - rspec.yml
 homepage: https://github.com/boxt/boxt_rubocop

data/lib/boxt_rubocop/version.rb

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-module BoxtRubocop
-  VERSION = File.read("VERSION").split("\n").first
-end