rubocop-kanso 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 910ab5b15db7363d252c4dc3223683c3f160704667ab58c5175288c8228fced4
+  data.tar.gz: abbdd4e0a7dc33cdba401ca61cb88a8d8b2fd9d32562d4579dc03a7783cf2c3a
+SHA512:
+  metadata.gz: b1c4473924f20aa5b934244097920c132d34664317ff266be1ee5c7691b384dd797c971ddbe53ce2269ed9aaff8e8b69ed15723dbe8b66952ab2413491ed2017
+  data.tar.gz: 2c35aa3a09baa4a9aeed17215d132cdd1f6afc60125e6ec7bbbc80002f886a9cf334fbbfb0020cfe93ab3ca57a29983b7f4d9c7fd695f3a87a14539ad30ba259

data/lib/config/default.yml

@@ -0,0 +1,15 @@
+Kanso/NoRailsHelperRequire:
+  Description: 'Disallows requiring rails_helper in specs'
+  Enabled: true
+  VersionAdded: '1.0.0'
+  Include:
+    - '**/*_spec.rb'
+    - '**/spec/**/*.rb'
+
+Kanso/NoRSpecDescribe:
+  Description: 'Enforces using describe instead of RSpec.describe'
+  Enabled: true
+  VersionAdded: '1.0.0'
+  Include:
+    - '**/*_spec.rb'
+    - '**/spec/**/*.rb'

data/lib/rubocop/cop/kanso/no_rails_helper_require.rb

@@ -0,0 +1,49 @@
+module RuboCop
+  module Cop
+    module Kanso
+      class NoRailsHelperRequire < Base
+        extend AutoCorrector
+        include RangeHelp
+
+        MSG = 'Do not require "rails_helper" in spec files. ' \
+              'Configure .rspec file with `--require spec_helper` and `--require rails_helper` instead.'.freeze
+        RESTRICT_ON_SEND = [:require].freeze
+
+        def_node_matcher :rails_helper_require?, <<~PATTERN
+          (send nil? :require
+            (str #rails_helper?))
+        PATTERN
+
+        def rails_helper?(str)
+          str == 'rails_helper'
+        end
+
+        def on_send(node)
+          return unless rails_helper_require?(node)
+
+          add_offense(node) do |corrector|
+            corrector.remove(removal_range(node))
+          end
+        end
+
+        private
+
+        def removal_range(node)
+          range = range_by_whole_lines(node.source_range, include_final_newline: true)
+          extend_range_for_blank_line(range, node.source_range.source_buffer)
+        end
+
+        def extend_range_for_blank_line(range, source_buffer)
+          return range unless blank_line_follows?(range, source_buffer)
+
+          Parser::Source::Range.new(source_buffer, range.begin_pos, range.end_pos + 1)
+        end
+
+        def blank_line_follows?(range, source_buffer)
+          end_pos = range.end_pos
+          end_pos < source_buffer.source.length && source_buffer.source[end_pos] == "\n"
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/kanso/no_rspec_describe.rb

@@ -0,0 +1,25 @@
+module RuboCop
+  module Cop
+    module Kanso
+      class NoRSpecDescribe < Base
+        extend AutoCorrector
+
+        MSG = 'Use `describe` instead of `RSpec.describe`.'.freeze
+
+        def_node_matcher :rspec_describe?, <<~PATTERN
+          (send
+            (const nil? :RSpec) :describe
+            ...)
+        PATTERN
+
+        def on_send(node)
+          return unless rspec_describe?(node)
+
+          add_offense(node.loc.expression.begin.join(node.loc.selector)) do |corrector|
+            corrector.replace(node.loc.expression.begin.join(node.loc.selector), 'describe')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/kanso_cops.rb

@@ -0,0 +1,2 @@
+require_relative 'kanso/no_rails_helper_require'
+require_relative 'kanso/no_rspec_describe'

data/lib/rubocop/kanso/inject.rb

@@ -0,0 +1,14 @@
+module RuboCop
+  module Kanso
+    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)
+        puts "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/kanso/plugin.rb

@@ -0,0 +1,28 @@
+require 'lint_roller'
+
+module RuboCop
+  module Kanso
+    class Plugin < LintRoller::Plugin
+      def about
+        LintRoller::About.new(
+          name: 'rubocop-kanso',
+          version: VERSION,
+          homepage: 'https://github.com/egracens/rubocop-kanso',
+          description: 'RuboCop extension focusing on simplicity and eliminating redundancy.'
+        )
+      end
+
+      def supported?(context)
+        context.engine == :rubocop
+      end
+
+      def rules(_context)
+        LintRoller::Rules.new(
+          type: :path,
+          config_format: :rubocop,
+          value: Pathname.new(__dir__).join('../../config/default.yml')
+        )
+      end
+    end
+  end
+end

data/lib/rubocop/kanso/version.rb

@@ -0,0 +1,5 @@
+module RuboCop
+  module Kanso
+    VERSION = '1.0.0'.freeze
+  end
+end

data/lib/rubocop/kanso.rb

@@ -0,0 +1,9 @@
+module RuboCop
+  module Kanso
+    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, :CONFIG)
+  end
+end

data/lib/rubocop-kanso.rb

@@ -0,0 +1,5 @@
+require 'rubocop'
+
+require_relative 'rubocop/kanso/version'
+require_relative 'rubocop/kanso/plugin'
+require_relative 'rubocop/cop/kanso_cops'

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-kanso
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Vlad Petrovsky
+bindir: exe
+cert_chain: []
+date: 2025-08-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lint_roller
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.72'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.72'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 'RuboCop extension focusing on simplicity and eliminating redundancy. '
+email:
+- egracens@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/config/default.yml
+- lib/rubocop-kanso.rb
+- lib/rubocop/cop/kanso/no_rails_helper_require.rb
+- lib/rubocop/cop/kanso/no_rspec_describe.rb
+- lib/rubocop/cop/kanso_cops.rb
+- lib/rubocop/kanso.rb
+- lib/rubocop/kanso/inject.rb
+- lib/rubocop/kanso/plugin.rb
+- lib/rubocop/kanso/version.rb
+homepage: https://github.com/egracens/rubocop-kanso
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/egracens/rubocop-kanso
+  rubygems_mfa_required: 'true'
+  default_lint_roller_plugin: RuboCop::Kanso::Plugin
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: RuboCop cops for lightweight code - simplicity through elimination (簡素)
+test_files: []