rubocop-hanami 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9d0cdb245fcc1d369d11881b9ebc6064cc09dfe3acf0267fd2329fe3cd0f662c
+  data.tar.gz: 9649a91707ea8b596f96edb4e6c636a3ed6fe1b323a1533c1395c032178b4116
+SHA512:
+  metadata.gz: b0c2d75c9f70db90f82d4bb707b315a178972c6a761f681264f3b6739cffe155c80e76c74e253dcd8bd5ccd6e35e878410eb1b3989c641e5c9125493506da7b1
+  data.tar.gz: 38031749617b42962b73ef90165d04ca176b5c2160265c3207a2a847f1314d70dc3886bda2e4feb865d9d9fed473635601e9b96279041c761345b029c5023770

data/CHANGELOG.md

@@ -0,0 +1,20 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [v0.1.0] - 2026-10-07
+
+### Added
+
+- `Hanami/SliceExports`, which flags a slice that never calls `export`, an `export` that takes anything but a
+  literal array of strings, and a key that matches `ForbiddenExports` or misses every `AllowedExports` pattern.
+  `ParentClasses` names the superclasses that mark a class as a slice, `Hanami::Slice` by default.
+  `RequireExport: false` lets a slice leave out `export`.
+
+[Unreleased]: https://github.com/aaronmallen/rubocop-hanami/compare/0.1.0...HEAD
+[v0.1.0]: https://github.com/aaronmallen/rubocop-hanami/releases/tag/0.1.0

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Aaron Allen
+
+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/config/default.yml

@@ -0,0 +1,11 @@
+Hanami/SliceExports:
+  Description: Checks that each slice exports a literal list of allowed keys.
+  Enabled: true
+  VersionAdded: "0.1.0"
+  Include:
+    - "**/config/slices/*.rb"
+    - "**/slices/*/config/slice.rb"
+  ForbiddenExports: []
+  ParentClasses:
+    - Hanami::Slice
+  RequireExport: true

data/lib/rubocop/cop/hanami/slice_exports.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Hanami
+      # Checks that every slice calls `export` with a literal array of keys, and that each key
+      # passes `AllowedExports` and `ForbiddenExports`. A slice that never calls `export` lets
+      # every other slice import any key from its container.
+      #
+      # Both settings take strings, matched exactly, and regular expressions. `ParentClasses` names
+      # the superclasses that mark a class as a slice, for an app whose slices inherit from a base
+      # class of its own. Set `RequireExport` to false to let a slice leave out `export` and check
+      # only the keys of the slices that call it.
+      #
+      # @example
+      #   # bad
+      #   class Admin::Slice < Hanami::Slice
+      #   end
+      #
+      #   # bad
+      #   class Admin::Slice < Hanami::Slice
+      #     export KEYS
+      #   end
+      #
+      #   # good
+      #   class Admin::Slice < Hanami::Slice
+      #     export ["repos.queries"]
+      #   end
+      #
+      # @example AllowedExports: ['repos.queries', !ruby/regexp /\Aoperations\./]
+      #   # bad
+      #   export ["repos.mutations"]
+      #
+      #   # good
+      #   export ["repos.queries", "operations.create"]
+      #
+      # @example ParentClasses: ['MyApp::Slice']
+      #   # bad
+      #   class Admin::Slice < MyApp::Slice
+      #   end
+      #
+      # @example RequireExport: false
+      #   # good
+      #   class Admin::Slice < Hanami::Slice
+      #   end
+      #
+      # @example ForbiddenExports: ['repos.mutations']
+      #   # bad
+      #   export ["repos.mutations"]
+      class SliceExports < Base
+        MSG_FORBIDDEN = "`%<key>s` matches ForbiddenExports."
+        MSG_LITERAL = "Export a literal array of strings."
+        MSG_MISSING = "Call `export`; a slice without it lets other slices import every key."
+        MSG_NOT_ALLOWED = "`%<key>s` matches none of AllowedExports."
+
+        def_node_matcher :export_argument, "(send nil? :export $_)"
+
+        def on_class(node)
+          return unless slice_class?(node)
+
+          arguments = node.each_descendant(:send).filter_map { |send| export_argument(send) }
+          return add_offense(node.identifier, message: MSG_MISSING) if arguments.empty? && cop_config["RequireExport"]
+
+          arguments.each { |argument| check(argument) }
+        end
+
+        private
+
+        def check(argument)
+          return add_offense(argument, message: MSG_LITERAL) unless argument.array_type?
+
+          argument.each_value do |value|
+            next add_offense(value, message: MSG_LITERAL) unless value.str_type?
+
+            message = message_for(value.value)
+            add_offense(value, message: format(message, key: value.value)) if message
+          end
+        end
+
+        def matches?(setting, key)
+          Array(cop_config[setting]).any? { |pattern| pattern.is_a?(Regexp) ? pattern.match?(key) : pattern == key }
+        end
+
+        def message_for(key)
+          return MSG_FORBIDDEN if matches?("ForbiddenExports", key)
+
+          MSG_NOT_ALLOWED if cop_config.key?("AllowedExports") && !matches?("AllowedExports", key)
+        end
+
+        def slice_class?(node)
+          parent = node.parent_class
+          parent&.const_type? && Array(cop_config["ParentClasses"]).include?(parent.const_name)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/hanami/plugin.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require "lint_roller"
+
+module RuboCop
+  module Hanami
+    # Hands RuboCop the default configuration for every cop in the Hanami department.
+    class Plugin < LintRoller::Plugin
+      def about
+        LintRoller::About.new(
+          name: "rubocop-hanami",
+          version: Gem.loaded_specs["rubocop-hanami"].version.to_s,
+          homepage: "https://github.com/aaronmallen/rubocop-hanami",
+          description: "A collection of RuboCop cops for Hanami.",
+        )
+      end
+
+      def rules(_context)
+        LintRoller::Rules.new(
+          type: :path,
+          config_format: :rubocop,
+          value: Pathname.new(__dir__).join("../../../config/default.yml"),
+        )
+      end
+
+      def supported?(context)
+        context.engine == :rubocop
+      end
+    end
+  end
+end

data/lib/rubocop-hanami.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require "rubocop"
+
+require_relative "rubocop/hanami/plugin"
+require_relative "rubocop/cop/hanami/slice_exports"

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-hanami
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aaron Allen
+bindir: bin
+cert_chain: []
+date: 1980-01-02 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.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !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'
+description: A collection of RuboCop cops that check Hanami apps and slices.
+email:
+- hello@aaronmallen.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- config/default.yml
+- lib/rubocop-hanami.rb
+- lib/rubocop/cop/hanami/slice_exports.rb
+- lib/rubocop/hanami/plugin.rb
+homepage: https://github.com/aaronmallen/rubocop-hanami
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/aaronmallen/rubocop-hanami/issues
+  changelog_uri: https://github.com/aaronmallen/rubocop-hanami/blob/main/CHANGELOG.md
+  default_lint_roller_plugin: RuboCop::Hanami::Plugin
+  homepage_uri: https://github.com/aaronmallen/rubocop-hanami
+  rubygems_mfa_required: 'true'
+  source_code_uri: https://github.com/aaronmallen/rubocop-hanami
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.20
+specification_version: 4
+summary: RuboCop cops for Hanami
+test_files: []