rubocop-zuno 3.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4260a4f2d8b1f8b20a9c677bfed64b64351d402a03e48995fcdebfadb725b891
+  data.tar.gz: cfca4a71374fae4119d8b6d670603262e676c5efc34d4a7fb30ff96be8f4e17b
+SHA512:
+  metadata.gz: 12238ab2f81cf94b91075efe8bdabb950679a94099840ef30ac0f4680d0ac482a74d0330faa9442d69fd8a69de1ce45747b31526a721f5c1b4b64feb294d2212
+  data.tar.gz: 036a548cacb38b0004ece7ac07a4b89c7b3e838182298d8725070ff0e4656432000c352d21971e826818e7d5d053ef83233c07255cb9a84f73123ad95ad71d44

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2025 Zuno
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,114 @@
+# Rubocop Zuno
+
+[![Gem Version](https://badge.fury.io/rb/rubocop-zuno.svg)](https://badge.fury.io/rb/rubocop-zuno)
+[![CI](https://github.com/zuno-tech/rubocop-zuno/actions/workflows/ci.yml/badge.svg)](https://github.com/zuno-tech/rubocop-zuno/actions/workflows/ci.yml)
+
+Base [Rubocop](https://rubocop.org) settings for all Zuno Ruby projects.
+
+## Requirements
+
+- Ruby >= 3.0
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+group :development, :test do
+  # ...
+  gem "rubocop-zuno"
+end
+```
+
+And then execute:
+
+```sh
+bundle
+```
+
+## Usage
+
+Put this into your .rubocop.yml.
+
+```yml
+require:
+  - rubocop-zuno
+```
+
+To enable additional configuration for `rubocop-rails` and `rubocop-rspec`, add the following to your .rubocop.yml:
+
+```yml
+inherit_gem:
+  rubocop-zuno:
+    - 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[Zuno/Name]'
+[create] lib/rubocop/cop/zuno/name.rb
+[create] spec/rubocop/cop/zuno/name_spec.rb
+[modify] lib/rubocop/cop/boxt_cops.rb - `require_relative 'zuno/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.
+
+### Additional Extensions/Cops
+
+The following Rubocop gems are also installed with this gem:
+
+- [rubocop-faker](https://github.com/koic/rubocop-faker)
+- [rubocop-performance](https://github.com/rubocop/rubocop-performance)
+- [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 these add the following to your `.rubocop.yml` file.
+
+```yml
+inherit_gem:
+  rubocop-zuno:
+  # .... add cops
+
+require:
+  - rubocop-faker # if your project is using the Faker gem then add this
+  - rubocop-performance # Add this for performance cops
+  - 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
+```
+
+## Editor Plugins
+
+There are also some useful Rubocop editor plugins to help with in-editor linting.
+
+### Atom
+
+- [linter-rubocop](https://atom.io/packages/linter-rubocop)
+- [rubocop-auto-correct](https://atom.io/packages/rubocop-auto-correct)
+
+### RubyMine
+
+- [rubocop](https://www.jetbrains.com/help/ruby/rubocop.html)
+
+### VSCode
+
+- [ruby-rubocop](https://marketplace.visualstudio.com/items?itemName=misogi.ruby-rubocop)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/zuno/boxt_rubocop.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+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] do |_task, args|
+  require "rubocop"
+
+  cop_name = args.fetch(:cop) do
+    warn "usage: bundle exec rake 'new_cop[Zuno/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/zuno_cops.rb")
+  generator.inject_config(config_file_path: "config/default.yml")
+
+  puts generator.todo
+end

data/VERSION

@@ -0,0 +1 @@
+3.0.0

data/config/default.yml

@@ -0,0 +1,75 @@
+AllCops:
+  Exclude:
+    - "**/*/schema.rb"
+    - Gemfile.lock
+    - node_modules/**/*
+    - tmp/**/*
+    - vendor/**/*
+  NewCops: enable
+
+Zuno/ApiPathFormat:
+  Description: "Ensure that the API path uses kebab case"
+  Enabled: false
+
+Zuno/ApiTypeParameters:
+  Description: "Ensure that API parameters are typed"
+  Enabled: false
+
+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/HashSyntax:
+  EnforcedShorthandSyntax: "always"
+
+# Setting this to a max of 3 as 2 is too restrictive for some of our code
+Style/SafeNavigationChainLength:
+  Max: 3
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes

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

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Zuno
+      # 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")
+      #
+      # @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 < RuboCop::Cop::Base
+        def_node_matcher :path_defining_method_with_string_path, <<~PATTERN
+          (send nil? {:get | :post | :put | :patch | :delete | :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/zuno/api_type_parameters.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Zuno
+      # This cop ensures that each parameter in a Grape API has a type specified.
+      #
+      # @example
+      #   # bad
+      #   requires :name
+      #   optional :age
+      #
+      #   # good
+      #   requires :name, type: String
+      #   optional :age, type: Integer
+      #
+      class ApiTypeParameters < RuboCop::Cop::Base
+        API_MESSAGE = "Ensure each parameter has a type specified, e.g., `type: String`."
+        ENTITY_MESSAGE = "Ensure each parameter has a type specified, e.g., `documentation: { type: String }`."
+
+        def_node_matcher :param_declaration, <<-PATTERN
+          (send nil? {:optional :requires :expose} _ $...)
+        PATTERN
+
+        def_node_search :param_with_type, <<-PATTERN
+          (send nil? {:optional :requires} _ (hash <(pair (sym :type) $_) ...>))
+        PATTERN
+
+        def_node_search :entity_with_type_documentation, <<-PATTERN
+          (send nil? :expose _ (hash <(pair (sym :documentation) (hash <(pair (sym :type) $_) ...>)) ...>))
+        PATTERN
+
+        def on_send(node)
+          param_declaration(node) do
+            next unless grape_api_class?(node) || grape_entity_class?(node)
+
+            if grape_api_class?(node) && param_with_type(node).none?
+              add_offense(node, message: API_MESSAGE)
+            elsif grape_entity_class?(node) && entity_with_type_documentation(node).none?
+              add_offense(node, message: ENTITY_MESSAGE)
+            end
+          end
+        end
+
+        private
+
+        def grape_api_class?(node)
+          grape_parent_class?(node, "Grape::API")
+        end
+
+        def grape_entity_class?(node)
+          grape_parent_class?(node, "Grape::Entity")
+        end
+
+        def grape_parent_class?(node, class_name)
+          node.each_ancestor(:class).any? do |ancestor|
+            ancestor.children.any? do |child|
+              child&.source == class_name
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/zuno_cops.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require_relative "zuno/api_path_format"
+require_relative "zuno/api_type_parameters"

data/lib/rubocop/zuno/inject.rb

@@ -0,0 +1,25 @@
+# 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 Zuno
+    # 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)
+
+        # Using Rails.logger here will cause an error.
+        # See https://github.com/zuno-tech/rubocop-zuno/pull/187
+        # rubocop:disable Rails/Output
+        puts "configuration from #{path}" if ConfigLoader.debug?
+        # rubocop:enable Rails/Output
+        config = ConfigLoader.merge_with_default(config, path)
+        ConfigLoader.instance_variable_set(:@default_configuration, config)
+      end
+    end
+  end
+end

data/lib/rubocop/zuno/version.rb

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

data/lib/rubocop/zuno.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative "zuno/version"
+
+module RuboCop
+  module Zuno
+    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-zuno.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "rubocop"
+
+require_relative "rubocop/zuno"
+require_relative "rubocop/zuno/version"
+require_relative "rubocop/zuno/inject"
+
+RuboCop::Zuno::Inject.defaults!
+
+require_relative "rubocop/cop/zuno_cops"

data/rails.yml

@@ -0,0 +1,20 @@
+Rails/ApplicationController:
+  Exclude:
+    - spec/**/*
+    - test/**/*
+
+Rails/SkipsModelValidations:
+  Exclude:
+    - db/migrate/**/*
+    - lib/tasks/**/*
+    - spec/**/*
+    - test/**/*
+
+Rails/UnknownEnv:
+  Environments:
+    - cucumber
+    - development
+    - production
+    - qa
+    - test
+    - uat

data/rspec.yml

@@ -0,0 +1,30 @@
+# Excluding as we set up the rake specs as 'describe "rake namespace:task", type: :task do' which determines what task
+# is being tested, and this cop doesn't like having a describe block without a class or module name.
+RSpec/DescribeClass:
+  Exclude:
+    - spec/tasks/**/*
+
+# Avoid opening modules and defining specs within them
+RSpec/DescribedClassModuleWrapping:
+  Enabled: true
+
+# This is to prevent Rubocop from bugging on a spec helper that doesn't contain an example, which the support ones don't
+RSpec/LeadingSubject:
+  Exclude:
+    - spec/support
+
+# Allow arrays, hashes, and method calls to be counted as one line in examples
+RSpec/ExampleLength:
+  CountAsOne: ["array", "hash", "method_call"]
+
+# Because 5 is a bit mean
+RSpec/MultipleMemoizedHelpers:
+  Max: 10
+
+# Allow there to be a max of 4 example groups deep in Rspec tests
+RSpec/NestedGroups:
+  Max: 4
+
+# Multi-line examples must have a description
+RSpec/ExampleWithoutDescription:
+  EnforcedStyle: single_line_only

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-zuno
+version: !ruby/object:Gem::Version
+  version: 3.0.0
+platform: ruby
+authors:
+- Zuno
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.81.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.81.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.27.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.27.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.26.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.26.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.33.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.33.4
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.7.1
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.31.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.31.0
+description: Base Rubocop settings for all Zuno Ruby projects
+email:
+- developers@zuno.tech
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- VERSION
+- config/default.yml
+- lib/rubocop-zuno.rb
+- lib/rubocop/cop/zuno/api_path_format.rb
+- lib/rubocop/cop/zuno/api_type_parameters.rb
+- lib/rubocop/cop/zuno_cops.rb
+- lib/rubocop/zuno.rb
+- lib/rubocop/zuno/inject.rb
+- lib/rubocop/zuno/version.rb
+- rails.yml
+- rspec.yml
+homepage: https://github.com/zuno-tech/rubocop-zuno
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Base Rubocop settings for all Zuno Ruby projects
+test_files: []