rubocop-dependency 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0f0316c1f3ef845942c446d2eb9f332406088df236203770d0bc49609805f373
+  data.tar.gz: 8814b0ce0eee121c597f408276e4c81707d283e54f0981f807fbdad2232dd5aa
+SHA512:
+  metadata.gz: 741d66c429a907657b24b3e7b8cd8efe71d55e8e9254caada358f449aef1d058970e255b7af824eda475631dee538a9ca2ac21dd6ca830aa946e3fbb4df9814a
+  data.tar.gz: eb9a850a6a827336eb7d8b4c1dd25532044ec781fe162b9eb2132d18d34a22a1e5885fd841329816c53c5319dacc58e71c3167b2d9ba801b6fb17727c1cbf58d

data/README.md

@@ -0,0 +1,57 @@
+# Rubocop::Dependency
+
+[![Coverage Status](https://coveralls.io/repos/github/keik/rubocop-dependency/badge.svg?branch=circleci)](https://coveralls.io/github/keik/rubocop-dependency?branch=circleci)
+
+Code style checking for dependencies control, as an extension to [RuboCop](https://github.com/rubocop/rubocop).
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rubocop-dependency', require: false
+```
+
+## Usage
+
+Put this into your .rubocop.yml.
+
+```
+require: rubocop-dependency
+```
+
+## Cops
+
+Dependency/OverBoundary
+
+Check not to refer constants over dependency boundaries which given from `Rules` config.
+
+When the following `Rules` is given,
+
+```
+Rules:                      // Array of each rules
+  - BannedConsts: Foo       // Array<String> | String. Ba
+    FromNamespacePatterns:  // Array<String> | String. This value is used as Regexp pattern
+      - \ABar(\W|\z)
+```
+
+The following code is considered problems.
+
+```
+class Bar
+  Foo
+  ^^^ Const `Foo` cannot use from namespace `Bar`.
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/keik/rubocop-dependency.

data/config/default.yml

@@ -0,0 +1,4 @@
+Dependency/OverBoundary:
+  Description: 'Rectrict which constants can be referred in a given namespace.'
+  Enabled: false
+  Rules: []

data/lib/rubocop/cop/dependency/over_boundary.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Cop
+    module Dependency
+      # Check not to refer constants over dependency boundaries which given from `Rules` config.
+      #
+      # @example
+      #   # Rules:
+      #   #   - BannedConsts: Foo
+      #   #     FromNamespacePatterns:
+      #   #       - \ABar(\W|\z)
+      #
+      #   class Bar
+      #     # Bad. Cannot refer Foo from Bar namespace
+      #     Foo
+      #   end
+      #
+      class OverBoundary < Base
+        def on_const(node)
+          const_name = node.const_name
+          parent_module_name = node.parent_module_name
+
+          if cop_config['Rules']
+             .select { |rule|
+               Array(rule['BannedConsts']).include?(const_name)
+             }
+             .any? { |rule|
+               Array(rule['FromNamespacePatterns']).any? { |from_pattern|
+                 Regexp.new(from_pattern).match?(parent_module_name)
+               }
+             }
+            add_offense(node, message: "Const `#{const_name}` cannot use from namespace `#{parent_module_name}`.")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/dependency_cops.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require_relative 'dependency/over_boundary'

data/lib/rubocop/dependency/inject.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# The original code is from https://github.com/rubocop-hq/rubocop-rspec/blob/master/lib/rubocop/rspec/inject.rb
+# See https://github.com/rubocop-hq/rubocop-rspec/blob/master/MIT-LICENSE.md
+module RuboCop
+  module Dependency
+    # 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)
+        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/dependency/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Dependency
+    VERSION = "0.1.1"
+  end
+end

data/lib/rubocop/dependency.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative "dependency/version"
+
+module RuboCop
+  module Dependency
+    class Error < StandardError; end
+    # Your code goes here...
+    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-dependency.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require 'rubocop'
+
+require_relative 'rubocop/dependency'
+require_relative 'rubocop/dependency/version'
+require_relative 'rubocop/dependency/inject'
+
+RuboCop::Dependency::Inject.defaults!
+
+require_relative 'rubocop/cop/dependency_cops'

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-dependency
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- KATO Kei
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-09-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov-lcov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |2
+      Code style checking for dependencies control.
+      A plugin for the RuboCop code style enforcing & linting tool.
+email:
+- k4t0.kei@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- config/default.yml
+- lib/rubocop-dependency.rb
+- lib/rubocop/cop/dependency/over_boundary.rb
+- lib/rubocop/cop/dependency_cops.rb
+- lib/rubocop/dependency.rb
+- lib/rubocop/dependency/inject.rb
+- lib/rubocop/dependency/version.rb
+homepage: https://github.com/keik/rubocop-dependency
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/keik/rubocop-dependency
+  source_code_uri: https://github.com/keik/rubocop-dependency
+  changelog_uri: https://github.com/keik/rubocop-dependency/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Code style checking for dependencies control.
+test_files: []