rubocop-dry-import 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 85d7c48439ed60d9252a754f9f30c10a936d66e7005ee1786ae03c0a14999779
+  data.tar.gz: fede65640799eef6f9fc7ab33f9f0d758d9e947057c1a20789220577c3c143ca
+SHA512:
+  metadata.gz: a02c84254590d9b1c82bd9a2bf7e0a09e9c41047cee910ead491695bba8f615e91b075c428af636f90dde7733e414931a79989cc288f7b68403e027d7edd672b
+  data.tar.gz: 9fc2060a4c3c733a1c076b63dc9bc211ce1f32531254f2582d3d42e4dab536d8eea3d515ad8619299a1d137ee6edeb7b09279c9fac25b047d9e2bb00472ab243

data/.rubocop_todo.yml

@@ -0,0 +1,23 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2025-11-08 19:30:09 UTC using RuboCop version 1.81.7.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
+Metrics/AbcSize:
+  Max: 18
+
+# Offense count: 1
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+# AllowedMethods: refine
+Metrics/BlockLength:
+  Max: 65
+
+# Offense count: 2
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+Metrics/MethodLength:
+  Max: 14

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 seriousdev-gh
+
+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,85 @@
+# RuboCop Dry Import
+
+A custom [RuboCop](https://github.com/rubocop/rubocop) extension that detects **unused `Import` dependencies** in classes using [dry-rb’s dependency injection](https://dry-rb.org/gems/dry-auto_inject/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rubocop-dry-import', require: false
+```
+
+## Usage
+
+Add the extension to your `.rubocop.yml`:
+
+```yaml
+require:
+  - rubocop-dry-import
+
+Dry/UnusedImport:
+  Enabled: true
+  ImportName: 'Import' # Optional, defaults to "Import"
+```
+
+Run RuboCop as usual:
+
+```bash
+bundle exec rubocop
+```
+
+## Example
+
+```ruby
+class FooService
+  include Import['service_a', 'service_b']
+
+  def call
+    service_b.call
+  end
+end
+```
+
+**Offense:**
+```
+Include Import['service_a', 'service_b']
+               ^^^^^^^^^^^ Imported dependency `service_a` is not used in the class.
+```
+
+**Autocorrect:** Not available (yet).
+
+## Development
+
+Clone and setup:
+
+```bash
+git clone https://github.com/seriousdev-gh/rubocop-dry-import
+cd rubocop-dry-import
+bundle install
+```
+
+Run tests:
+
+```bash
+bundle exec rspec
+```
+
+Run RuboCop locally:
+
+```bash
+bundle exec rubocop --require rubocop-dry-import path/to/file.rb
+```
+
+## Contributing
+
+1. Fork the project.
+2. Create your feature branch (`git checkout -b feature/new-cop`).
+3. Commit your changes (`git commit -am 'Add new cop'`).
+4. Push to the branch (`git push origin feature/new-cop`).
+5. Open a Pull Request.
+
+## License
+
+This project is licensed under the [MIT License](LICENSE).
+

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/config/default.yml

@@ -0,0 +1,3 @@
+Dry/UnusedImport:
+  Enabled: true
+  InjectorName: 'Import'

data/lib/rubocop/cop/dry/unused_import.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Dry
+      class UnusedImport < Base
+        MSG = 'Imported dependency `%<name>s` is not used in the class.'
+
+        def_node_matcher :possible_injector_include?, <<~PATTERN
+          (send nil? :include
+            (send
+              (const nil? $_) :[] ...))
+        PATTERN
+
+        # search for method calls
+        def on_send(node)
+          # search for method calls with specific pattern `include <included_const_name>[<...>]`
+          possible_injector_include?(node) do |included_const_name|
+            next if included_const_name.to_s != injector_name
+
+            injector_call_node = node.arguments.first
+            class_node = node.parent
+
+            imported = extract_imported_methods(injector_call_node)
+            break if imported.empty?
+
+            unused = filter_unused_imported_methods(class_node, imported.dup)
+            unused.each do |name, import_node|
+              add_offense(import_node, message: format(MSG, name:))
+            end
+          end
+        end
+
+        private
+
+        def injector_name
+          cop_config['InjectorName'] || 'Import'
+        end
+
+        def extract_imported_methods(injector_call_node)
+          imported_methods = {}
+
+          injector_call_node.arguments.each do |arg|
+            case arg.type
+            when :str, :sym
+              name = arg.value.to_s.split('.').last
+              imported_methods[name.to_s] = arg
+            when :hash
+              arg.pairs.each do |pair_node|
+                name = pair_node.key.value
+                imported_methods[name.to_s] = pair_node
+              end
+            end
+          end
+
+          imported_methods
+        end
+
+        def filter_unused_imported_methods(class_node, imported)
+          class_node.each_descendant(:send).each do |node|
+            break if imported.empty?
+
+            name = node.method_name.to_s
+            imported.delete(name) if imported.key?(name)
+          end
+
+          imported
+        end
+      end
+    end
+  end
+end

data/lib/rubocop_dry_import/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RuboCopDryImport
+  VERSION = '0.1.0'
+end

data/lib/rubocop_dry_import.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative 'rubocop_dry_import/version'
+require_relative 'rubocop/cop/dry/unused_import'
+
+module RuboCopDryImport
+  def self.inject!
+    path = File.expand_path(__dir__)
+    RuboCop::ConfigLoader.default_configuration = RuboCop::ConfigLoader.default_configuration.merge(
+      YAML.safe_load_file(File.join(path, 'config', 'default.yml'), aliases: true)
+    )
+  end
+end

data/rubocop-dry-import.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative 'lib/rubocop_dry_import/version'
+
+Gem::Specification.new do |spec|
+  spec.name                  = 'rubocop-dry-import'
+  spec.version               = RuboCopDryImport::VERSION
+  spec.authors               = ['seriousdev-gh']
+  spec.email                 = ['borisdrovnin@gmail.com']
+
+  spec.summary               = 'RuboCop extension that detects unused dry-rb Import dependencies.'
+  spec.description           = 'rubocop-dry-import adds a RuboCop cop (Dry/UnusedImport) that warns when imported ' \
+                               'dependencies via dry-rb’s Import or AutoInject are not used within the class.'
+  spec.homepage              = 'https://github.com/seriousdev-gh/rubocop-dry-import'
+  spec.license               = 'MIT'
+  spec.required_ruby_version = '>= 3.2.0'
+
+  spec.metadata['source_code_uri']       = spec.homepage
+  spec.metadata['rubygems_mfa_required'] = 'true'
+
+  spec.files = IO.popen(%w[git ls-files -z], chdir: __dir__, err: IO::NULL) do |ls|
+    ls.readlines("\x0", chomp: true).reject do |f|
+      f.start_with?(*%w[bin/ Gemfile .gitignore .rspec spec/ .github/ example/ .rubocop.yml])
+    end
+  end
+
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'rubocop', '>= 1.0', '< 2.0'
+
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-dry-import
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- seriousdev-gh
+bindir: exe
+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.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: rubocop-dry-import adds a RuboCop cop (Dry/UnusedImport) that warns when
+  imported dependencies via dry-rb’s Import or AutoInject are not used within the
+  class.
+email:
+- borisdrovnin@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop_todo.yml"
+- LICENSE.txt
+- README.md
+- Rakefile
+- config/default.yml
+- lib/rubocop/cop/dry/unused_import.rb
+- lib/rubocop_dry_import.rb
+- lib/rubocop_dry_import/version.rb
+- rubocop-dry-import.gemspec
+homepage: https://github.com/seriousdev-gh/rubocop-dry-import
+licenses:
+- MIT
+metadata:
+  source_code_uri: https://github.com/seriousdev-gh/rubocop-dry-import
+  rubygems_mfa_required: 'true'
+  allowed_push_host: https://rubygems.org
+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.7.2
+specification_version: 4
+summary: RuboCop extension that detects unused dry-rb Import dependencies.
+test_files: []