rubocop-packaging 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 72be16aa270e6a0acac89f70963f75e8c4510932a76cf254bf8d4b54e4a25f43
-  data.tar.gz: 68e3647ae5c13139e5fdf799bdc6e32b2e51df23c0ca676e60d2b6e29e3f0f0c
+  metadata.gz: ccfa9bb6e8043ae716d5349730d77dd122ad9fec2b6b6c278f79db7a604ba7aa
+  data.tar.gz: f9a8b7c4fe1c3793827d27681af59a94495cb8f59e39e727c058ce6ce3a2f448
 SHA512:
-  metadata.gz: c938f05cabce5bccc176fc40ecb62c029718884f7cfbdcd35c7cdfe712164ef86827d3e1eb93ae64f03ebf3ee7ea086acfa1967082d65fdefd9fed851987a42e
-  data.tar.gz: d7830f8e572577ba14554c2e8589ee99ae9898b91451143ab6b441c30d80930608ad97421582e38fdea212f047a826821ee1f83adbfd6f4261182af7b9bae9de
+  metadata.gz: cfd44f46a045f09ac6647f22e68e5351fe9d5640c061fe4fe37ec789f3b6bf0f4fbbee527edfcfafe25135cb2f86e37b45d446a1181b455de9064ca97270431a
+  data.tar.gz: 68fb8cc0cdcb1e2bc8682c5e3aef39bcaa02ebd131ea70927cd18f5f2b63dabbafe1c5da49c54e878ee48ffbec90a83eece281251bd06d28afe15389f00896cd

data/README.md

@@ -10,7 +10,7 @@ environment without any problems.
 ## Documentation
 
 A detailed documentation, explaining what this extension is doing and the
-reasoning behind it, can be found here: [packaging-style-guide](https://github.com/utkarsh2102/packaging-style-guide).
+reasoning behind it, can be found here: [packaging-style-guide](https://packaging.rubystyle.guide/).
 
 In case anything is not clear, please feel free to raise an issue, asking
 for more explanation!

data/config/default.yml

@@ -1,5 +1,10 @@
 # This is the default configuration file.
 
+Packaging/BundlerSetupInTests:
+  Description: 'Avoid using `bundler/setup` in your tests.'
+  Enabled: true
+  VersionAdded: '0.4'
+
 Packaging/GemspecGit:
   Description: 'Use pure Ruby alternative instead of `git ls-files`.'
   Enabled: true
@@ -11,3 +16,8 @@ Packaging/RequireRelativeHardcodingLib:
   Enabled: true
   VersionAdded: '0.2'
   VersionChanged: '0.3'
+
+Packaging/RequireWithRelativePath:
+  Description: 'Avoid using `require` with relative path.'
+  Enabled: true
+  VersionAdded: '0.4'

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

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require "rubocop/packaging/lib_helper_module"
+
+module RuboCop # :nodoc:
+  module Cop # :nodoc:
+    module Packaging # :nodoc:
+      # This cop flags the `require "bundler/setup"` calls if they're
+      # made from inside the tests directory.
+      #
+      # @example
+      #
+      #   # bad
+      #   require "foo"
+      #   require "bundler/setup"
+      #
+      #   # good
+      #   require "foo"
+      #
+      class BundlerSetupInTests < Base
+        include RuboCop::Packaging::LibHelperModule
+
+        # This is the message that will be displayed when RuboCop::Packaging finds
+        # an offense of using `require "bundler/setup"` in the tests directory.
+        MSG = "Avoid using `bundler/setup` in your tests."
+
+        def_node_matcher :bundler_setup?, <<~PATTERN
+          (send nil? :require
+            (str #bundler_setup_in_test_dir?))
+        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 bundler_setup?(node)
+
+          add_offense(node)
+        end
+
+        # This method is called from inside `#def_node_matcher`.
+        # It flags an offense if the `require "bundler/setup"`
+        # call is made from the tests directory.
+        def bundler_setup_in_test_dir?(str)
+          str.eql?("bundler/setup") && falls_in_test_dir?
+        end
+
+        # This method determines if the call is made *from* the tests directory.
+        def falls_in_test_dir?
+          %w[spec specs test tests].any? { |dir| File.expand_path(@file_directory).start_with?("#{root_dir}/#{dir}") }
+        end
+      end
+    end
+  end
+end

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

@@ -7,9 +7,6 @@ module RuboCop # :nodoc:
       # and suggests to use a plain Ruby alternative, like `Dir`,
       # `Dir.glob`, or `Rake::FileList` instead.
       #
-      # More information about the GemspecGit cop can be found here:
-      # https://github.com/utkarsh2102/packaging-style-guide#gemspec-git
-      #
       # @example
       #
       #   # bad
@@ -50,7 +47,7 @@ module RuboCop # :nodoc:
       #     spec.executables   = Dir.glob("bin/*").map{ |f| File.basename(f) }
       #   end
       #
-      class GemspecGit < Cop
+      class GemspecGit < Base
         # This is the message that will be displayed when RuboCop finds an
         # offense of using `git ls-files`.
         MSG = "Avoid using git to produce lists of files. " \
@@ -72,13 +69,12 @@ module RuboCop # :nodoc:
         # https://github.com/rubocop-hq/rubocop/blob/59543c8e2b66bff249de131fa9105f3eb11e9edb/lib/rubocop/cop/cop.rb#L13-L25
         #
         # Processing of the AST happens here.
-        def investigate(processed_source)
+        def on_new_investigation
           return if processed_source.blank?
 
           xstr(processed_source.ast).each do |node|
             add_offense(
-              processed_source.ast,
-              location: node.loc.expression,
+              node.loc.expression,
               message: MSG
             )
           end

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

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "rubocop/packaging/lib_helper_module"
+
 module RuboCop # :nodoc:
   module Cop # :nodoc:
     module Packaging # :nodoc:
@@ -7,9 +9,6 @@ module RuboCop # :nodoc:
       # mapping to the "lib" directory, except originating from lib/ or
       # the gemspec file, and suggests to use `require` instead.
       #
-      # More information about the RequireRelativeHardcodingLib cop can be found here:
-      # https://github.com/utkarsh2102/packaging-style-guide#require-relative-hardcoding-lib
-      #
       # @example
       #
       #   # bad
@@ -29,6 +28,8 @@ module RuboCop # :nodoc:
       #   require_relative "spec/foo/bar"
       #
       class RequireRelativeHardcodingLib < Base
+        include RuboCop::Packaging::LibHelperModule
+
         # 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. " \
@@ -58,33 +59,12 @@ module RuboCop # :nodoc:
           add_offense(node)
         end
 
-        # For determining the root directory of the project.
-        def root_dir
-          RuboCop::ConfigLoader.project_root
-        end
-
         # This method is called from inside `#def_node_matcher`.
         # It flags an offense if the `require_relative` call is made
         # from anywhere except the "lib" directory.
         def falls_in_lib?(str)
           target_falls_in_lib?(str) && !inspected_file_falls_in_lib? && !inspected_file_is_gemspec?
         end
-
-        # This method determines if the `require_relative` call is made
-        # to the "lib" directory.
-        def target_falls_in_lib?(str)
-          File.expand_path(str, @file_directory).start_with?("#{root_dir}/lib")
-        end
-
-        # This method determines if that call is made *from* the "lib" directory.
-        def inspected_file_falls_in_lib?
-          @file_path.start_with?("#{root_dir}/lib")
-        end
-
-        # This method determines if that call is made *from* the "gemspec" file.
-        def inspected_file_is_gemspec?
-          @file_path.end_with?("gemspec")
-        end
       end
     end
   end

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

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+require "rubocop/packaging/lib_helper_module"
+
+module RuboCop # :nodoc:
+  module Cop # :nodoc:
+    module Packaging # :nodoc:
+      # This cop flags the `require` calls, from anywhere mapping to
+      # the "lib" directory, except originating from lib/.
+      #
+      # @example
+      #
+      #   # bad
+      #   require "../lib/foo/bar"
+      #
+      #   # good
+      #   require "foo/bar"
+      #
+      #   # bad
+      #   require File.expand_path("../../lib/foo", __FILE__)
+      #
+      #   # good
+      #   require "foo"
+      #
+      #   # bad
+      #   require File.expand_path("../../../lib/foo/bar/baz/qux", __dir__)
+      #
+      #   # good
+      #   require "foo/bar/baz/qux"
+      #
+      #   # bad
+      #   require File.dirname(__FILE__) + "/../../lib/baz/qux"
+      #
+      #   # good
+      #   require "baz/qux"
+      #
+      class RequireWithRelativePath < Base
+        include RuboCop::Packaging::LibHelperModule
+
+        # This is the message that will be displayed when RuboCop::Packaging
+        # finds an offense of using `require` with relative path to lib.
+        MSG = "Avoid using `require` with relative path to `lib/`."
+
+        def_node_matcher :require?, <<~PATTERN
+          {(send nil? :require (str #falls_in_lib?))
+           (send nil? :require (send (const nil? :File) :expand_path (str #falls_in_lib?) (send nil? :__dir__)))
+           (send nil? :require (send (const nil? :File) :expand_path (str #falls_in_lib_using_file?) (str _)))
+           (send nil? :require (send (send (const nil? :File) :dirname {(str _) (send nil? _)}) :+ (str #falls_in_lib_with_file_dirname_plus_str?)))}
+        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?(node)
+
+          add_offense(node)
+        end
+
+        # This method is called from inside `#def_node_matcher`.
+        # It flags an offense if the `require` call is made from
+        # anywhere except the "lib" directory.
+        def falls_in_lib?(str)
+          target_falls_in_lib?(str) && !inspected_file_falls_in_lib?
+        end
+
+        # This method is called from inside `#def_node_matcher`.
+        # It flags an offense if the `require` call (using the __FILE__
+        # arguement) is made from anywhere except the "lib" directory.
+        def falls_in_lib_using_file?(str)
+          target_falls_in_lib_using_file?(str) && !inspected_file_falls_in_lib?
+        end
+
+        # This method preprends a "." to the string that starts with "/".
+        # And then determines if that call is made to "lib/".
+        def falls_in_lib_with_file_dirname_plus_str?(str)
+          str.prepend(".")
+          target_falls_in_lib?(str)
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/packaging_cops.rb

@@ -1,4 +1,6 @@
 # frozen_string_literal: true
 
+require_relative "packaging/bundler_setup_in_tests"
 require_relative "packaging/gemspec_git"
 require_relative "packaging/require_relative_hardcoding_lib"
+require_relative "packaging/require_with_relative_path"

data/lib/rubocop/packaging/lib_helper_module.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module RuboCop # :nodoc:
+  module Packaging # :nodoc:
+    # This helper module extracts the methods which can be used
+    # in other cop classes.
+    module LibHelperModule
+      # For determining the root directory of the project.
+      def root_dir
+        RuboCop::ConfigLoader.project_root
+      end
+
+      # This method determines if the calls are made to the "lib" directory.
+      def target_falls_in_lib?(str)
+        File.expand_path(str, @file_directory).start_with?("#{root_dir}/lib")
+      end
+
+      # This method determines if the calls (using the __FILE__ argument)
+      # are made to the "lib" directory.
+      def target_falls_in_lib_using_file?(str)
+        File.expand_path(str, @file_path).start_with?("#{root_dir}/lib")
+      end
+
+      # This method determines if that call is made *from* the "lib" directory.
+      def inspected_file_falls_in_lib?
+        @file_path.start_with?("#{root_dir}/lib")
+      end
+
+      # This method determines if that call is made *from* the "gemspec" file.
+      def inspected_file_is_gemspec?
+        @file_path.end_with?("gemspec")
+      end
+    end
+  end
+end

data/lib/rubocop/packaging/version.rb

@@ -2,6 +2,6 @@
 
 module RuboCop
   module Packaging
-    VERSION = "0.3.0"
+    VERSION = "0.4.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-packaging
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Utkarsh Gupta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-19 00:00:00.000000000 Z
+date: 2020-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bump
@@ -107,11 +107,14 @@ files:
 - README.md
 - config/default.yml
 - lib/rubocop-packaging.rb
+- lib/rubocop/cop/packaging/bundler_setup_in_tests.rb
 - lib/rubocop/cop/packaging/gemspec_git.rb
 - lib/rubocop/cop/packaging/require_relative_hardcoding_lib.rb
+- lib/rubocop/cop/packaging/require_with_relative_path.rb
 - lib/rubocop/cop/packaging_cops.rb
 - lib/rubocop/packaging.rb
 - lib/rubocop/packaging/inject.rb
+- lib/rubocop/packaging/lib_helper_module.rb
 - lib/rubocop/packaging/version.rb
 homepage: https://github.com/utkarsh2102/rubocop-packaging
 licenses: