boxt_rubocop 0.0.46 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa5d1260e94c7453988486a997b27b365683b5d3d7882790a16ed1e2f01379dd
-  data.tar.gz: 16d46fc9f195a2202aee79dfa07843646becc222b5f149708cda9c7bed7be360
+  metadata.gz: 341e8b143a6ca39495d4ecb8f4ac3b4abb9e2035407202d8692fafd01ea32f2b
+  data.tar.gz: 41f53ec76d4e3f54adde9d56aaf4b04bc07c67cf35a0174f01479bbaa2473094
 SHA512:
-  metadata.gz: 44f9204e8bc18bf304f0fd1ac76838a112ee77deed65352cde3a621abc15b61a7a7480e84cb41616cd28e3f0b7859ed04a1179207153f98d6a362965e560ddd8
-  data.tar.gz: '085b6047775c0413aefbf1fba1d118bb9ac063ac2e9d0c91915d04462700c2d0b374a974b4e1b4ce8c12b60801531cd813087a824af0e348efcd28fd58faba28'
+  metadata.gz: d5b071c38cc59d28d142aef6b24869a1d1e3a2dfbb02d1ab65faa3a7ad6eeed31b7bea037f600cdd3a6a7dc89b91f5816cd1abd9548920b94e3c13a7773a0aeb
+  data.tar.gz: 433ef4aced8b97690fb92a2a2346d40c944ad56caaf8304f547d40900f731ba8edb625055bc2e0d49e8ae96af73354e1604a063c2b390c3f4b778cd67e131bf7

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.46
+1.0.0

data/lib/boxt_rubocop.rb

@@ -1,15 +1,11 @@
 # frozen_string_literal: true
 
-require "boxt_rubocop/version"
-
-module BoxtRubocop
-  module_function
-
-  ##
-  # Provide a root path helper for the gem root dir
-  #
-  # Returns Pathname
-  def root
-    Pathname.new(File.dirname(__dir__))
-  end
-end
+require "rubocop"
+
+require_relative "rubocop/boxt"
+require_relative "rubocop/boxt/version"
+require_relative "rubocop/boxt/inject"
+
+RuboCop::Boxt::Inject.defaults!
+
+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

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Boxt
+      # Clients expect to interface with our API using kebab-case.
+      #
+      # This cop ensures that our API paths are formatted using the correct case.
+      #
+      # Underscores are acceptable in path variables (e.g. "/path/:path_id/update")
+      #
+      # API style guide: https://github.com/boxt/boxt-docs/blob/main/coding-styles/api.md#camel-cased-endpoints
+      #
+      # @example
+      #   # bad
+      #   post "/admin/orders/:order_id/contact_details/update"
+      #   get  "/installation_days"
+      #   namespace "password_resets"
+      #   namespace :password_resets
+      #
+      #   # good
+      #   post "/admin/orders/:order_id/contact-details/update"
+      #   get  "/installation-days"
+      #   namespace "password-resets"
+      #
+      class ApiPathFormat < Base
+        def_node_matcher :path_defining_method_with_string_path, <<~PATTERN
+          (send nil? {:post | :get | :namespace} (:str $_))
+        PATTERN
+
+        def_node_matcher :namespace_with_symbol, <<~PATTERN
+          (send nil? :namespace (:sym $_))
+        PATTERN
+
+        MSG = "Use kebab-case for the API path"
+
+        def on_send(node)
+          path_defining_method_with_string_path(node) do |path|
+            add_offense(node) if path_name_does_not_follow_kebab_case?(path)
+          end
+
+          namespace_with_symbol(node) do |path|
+            add_offense(node) if path.to_s.include?("_")
+          end
+        end
+
+        private
+
+        def path_name_does_not_follow_kebab_case?(path)
+          path.split("/").any? { |split| !split.start_with?(":") && split.include?("_") }
+        end
+      end
+    end
+  end
+end

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.46
+  version: 1.0.0
 platform: ruby
 authors:
 - Boxt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-09-19 00:00:00.000000000 Z
+date: 2023-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -105,9 +105,12 @@ files:
 - README.md
 - Rakefile
 - VERSION
-- 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/default.yml

@@ -1,60 +0,0 @@
-AllCops:
-  Exclude:
-    - "**/*/schema.rb"
-    - Gemfile.lock
-    - node_modules/**/*
-    - tmp/**/*
-    - vendor/**/*
-  NewCops: enable
-
-Layout/ClassStructure:
-  Enabled: true
-
-Layout/LineLength:
-  Exclude:
-    - config/routes.rb
-    - config/routes/*
-  Max: 120
-
-Metrics/AbcSize:
-  Exclude:
-    - db/migrate/**/*
-
-Metrics/BlockLength:
-  CountAsOne: ["array", "hash"]
-  Exclude:
-    - "*.gemspec"
-    - Gemfile
-    - config/environments/*
-    - config/routes.rb
-    - config/routes/*
-    - db/migrate/**/*
-    - lib/tasks/**/*
-    - spec/**/*
-    - test/**/*
-
-Metrics/ClassLength:
-  CountAsOne: ["array", "hash"]
-  Exclude:
-    - db/migrate/**/*
-    - spec/**/*
-    - test/**/*
-
-Metrics/MethodLength:
-  CountAsOne: ["array", "heredoc", "hash"]
-  Exclude:
-    - db/migrate/**/*
-    - spec/**/*
-    - test/**/*
-
-Metrics/ModuleLength:
-  CountAsOne: ["array", "hash"]
-
-Style/Documentation:
-  Enabled: false
-
-Style/DoubleNegation:
-  Enabled: false
-
-Style/StringLiterals:
-  EnforcedStyle: double_quotes

data/lib/boxt_rubocop/version.rb

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