rubocop-packaging 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 894fe9c595554ef57074560709460860e5e141db808fc6ce0f1f4ea4f77b9b40
-  data.tar.gz: 7240c56db4e1d92daff4be2682950002813a961222c68d4495c4f128ff61c964
+  metadata.gz: 8a302f7a6e19e06fa73adecfaa4be36d8db647d2aef3571554d4246b222306c6
+  data.tar.gz: af9c1d6e9435f94adbdaaf8a256291e3546fe3dfc024f36abf462c1e1b707046
 SHA512:
-  metadata.gz: b04c5603ec6d43e01cdc911c7eaa5d86a1aa76bf9e7ad57bd0e1827e607e3abb83f8390c2086a72baeb5bde2132bab38ef11534d502a4f9358bf30cf4f69d984
-  data.tar.gz: ed936cc2d3baea1ccc054ca2d058dbf7132f67edc4ab38f524271b419d611c7f8479c5906843e32a2bcb9b0af462ac58b7aef075bfcc7fabe0dde3fd6c62900d
+  metadata.gz: 11fc92be8299fb440ed62524b58d9d0684e520ad30879c86c2a79d16a6880248090f595a50ace1bc8569f551ad0b5e56ae5773398a6b2f4c91232b1e31009612
+  data.tar.gz: b50af49a31c46beb60f283604bb2877b0bd461bcd702adacf39f635d48603484782f52ef923b9fe960f035c0ce9bda3fe7d0fa1be17bf0076864445ab7571183

data/config/default.yml

@@ -3,4 +3,10 @@
 Packaging/GemspecGit:
   Description: 'Use pure Ruby alternative instead of `git ls-files`.'
   Enabled: true
-  VersionAdded: '0.86'
+  VersionAdded: '0.1'
+  VersionChanged: '0.1'
+
+Packaging/RelativeRequireToLib:
+  Description: 'Avoid using `require_relative` with relative path to lib.'
+  Enabled: true
+  VersionAdded: '0.2'

data/lib/rubocop/cop/packaging/relative_require_to_lib.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module RuboCop # :nodoc:
+  module Cop # :nodoc:
+    module Packaging # :nodoc:
+      # This cop is used to identify the `require_relative` calls,
+      # mapping to the "lib" directory and suggests to use `require`
+      # instead.
+      #
+      # @example
+      #
+      #   # bad
+      #   require_relative 'lib/foo.rb'
+      #
+      #   # bad
+      #   require_relative '../../lib/foo/bar'
+      #
+      #   # good
+      #   require 'foo.rb'
+      #
+      #   # good
+      #   require 'foo/bar'
+      #
+      #   # good
+      #   require_relative 'spec_helper'
+      #   require_relative 'foo/bar'
+      #
+      class RelativeRequireToLib < Base
+        # This is the message that will be displayed when RuboCop finds an
+        # offense of using `require_relative` with relative path to lib.
+        MSG = 'Avoid using `require_relative` with relative path to lib. ' \
+          'Use `require` instead.'
+
+        def_node_matcher :require_relative, <<~PATTERN
+          (send nil? :require_relative
+            (str #target_falls_in_lib?))
+        PATTERN
+
+        # Extended from the Base class.
+        # More about the `#on_new_investigation` method can be found here:
+        # https://github.com/rubocop-hq/rubocop/blob/343f62e4555be0470326f47af219689e21c61a37/lib/rubocop/cop/base.rb
+        #
+        # Processing of the AST happens here.
+        def on_new_investigation
+          @file_path = processed_source.file_path
+          @file_directory = File.dirname(@file_path)
+        end
+
+        # Extended from AST::Traversal.
+        # More about the `#on_send` method can be found here:
+        # https://github.com/rubocop-hq/rubocop-ast/blob/08d0f49a47af1e9a30a6d8f67533ba793c843d67/lib/rubocop/ast/traversal.rb#L112
+        def on_send(node)
+          return unless require_relative(node)
+
+          add_offense(node)
+        end
+
+        # This method is called from inside `#def_node_matcher`.
+        # It is used to find paths which starts with "lib".
+        def target_falls_in_lib?(str)
+          root_dir = RuboCop::ConfigLoader.project_root
+          File.expand_path(str, @file_directory).start_with?(root_dir + '/lib')
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/packaging_cops.rb

@@ -1,3 +1,4 @@
 # frozen_string_literal: true
 
 require_relative 'packaging/gemspec_git'
+require_relative 'packaging/relative_require_to_lib'

data/lib/rubocop/packaging/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Packaging
-    VERSION = '0.1.1'
+    VERSION = '0.2.0'
   end
 end

metadata

@@ -1,43 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-packaging
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Utkarsh Gupta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-03 00:00:00.000000000 Z
+date: 2020-07-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bump
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: '0.8'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: '0.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.13.0
+        version: '0.13'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -84,16 +84,16 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.75.0
+        version: '0.88'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.75.0
+        version: '0.88'
 description: |
   A collection of RuboCop cops to check for downstream compatability issues in the
   Ruby code.
@@ -108,6 +108,7 @@ files:
 - config/default.yml
 - lib/rubocop-packaging.rb
 - lib/rubocop/cop/packaging/gemspec_git.rb
+- lib/rubocop/cop/packaging/relative_require_to_lib.rb
 - lib/rubocop/cop/packaging_cops.rb
 - lib/rubocop/packaging.rb
 - lib/rubocop/packaging/inject.rb