rubocop-packaging 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ccfa9bb6e8043ae716d5349730d77dd122ad9fec2b6b6c278f79db7a604ba7aa
-  data.tar.gz: f9a8b7c4fe1c3793827d27681af59a94495cb8f59e39e727c058ce6ce3a2f448
+  metadata.gz: 4e096b94cc72a619f1accaa3fda9021424a1954ddd3364d34df4c36e66cb8926
+  data.tar.gz: d96b87bbb45fd4448665e6578039f3c167818a78894066953cd4a87a0af3e2de
 SHA512:
-  metadata.gz: cfd44f46a045f09ac6647f22e68e5351fe9d5640c061fe4fe37ec789f3b6bf0f4fbbee527edfcfafe25135cb2f86e37b45d446a1181b455de9064ca97270431a
-  data.tar.gz: 68fb8cc0cdcb1e2bc8682c5e3aef39bcaa02ebd131ea70927cd18f5f2b63dabbafe1c5da49c54e878ee48ffbec90a83eece281251bd06d28afe15389f00896cd
+  metadata.gz: 2d5f7400a946fc39f6de1907f01445d13e3935299058db606edef6e1527dae2efeb944921bee5e7bce5dfddc73d8e4fd39c1cc3a16105b0e1dcdb550a8962e71
+  data.tar.gz: f122820131b25c3fe87ce4c4abe5cce1f9fa22bed5e0bbf60e5fe68273ca4f8a089a7479ca9bf11a85d34227cae8878fd6875c0b7a3216e0bb7377aee73b27ac

data/README.md

@@ -10,7 +10,10 @@ 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://packaging.rubystyle.guide/).
+reasoning behind it, can be found here: https://docs.rubocop.org/rubocop-packaging/
+
+We also have a [packaging-style-guide](https://packaging.rubystyle.guide/),
+listing some good and bad examples and the rationale behind these cops.
 
 In case anything is not clear, please feel free to raise an issue, asking
 for more explanation!

data/config/default.yml

@@ -1,23 +1,36 @@
 # This is the default configuration file.
 
 Packaging/BundlerSetupInTests:
-  Description: 'Avoid using `bundler/setup` in your tests.'
+  Description: >-
+                 Using `bundler/setup` in tests is redundant. Consider
+                 removing it.
   Enabled: true
   VersionAdded: '0.4'
+  VersionChanged: '0.5'
 
 Packaging/GemspecGit:
-  Description: 'Use pure Ruby alternative instead of `git ls-files`.'
+  Description: >-
+                 Using `bundler/setup` in tests is redundant. Consider
+                 Avoid using git to produce lists of files. Downstreams
+                 often need to build your package in an environment
+                 that does not have git (on purpose). Use some pure
+                 Ruby alternative, like `Dir` or `Dir.glob`.
   Enabled: true
   VersionAdded: '0.1'
   VersionChanged: '0.1'
 
-Packaging/RequireRelativeHardcodingLib:
-  Description: 'Avoid using `require_relative` with relative path to lib.'
+Packaging/RequireHardcodingLib:
+  Description: >-
+                 Avoid using `require` with relative path to lib. Use
+                 `require` with absolute path instead.
   Enabled: true
-  VersionAdded: '0.2'
-  VersionChanged: '0.3'
+  VersionAdded: '0.4'
+  VersionChanged: '0.5'
 
-Packaging/RequireWithRelativePath:
-  Description: 'Avoid using `require` with relative path.'
+Packaging/RequireRelativeHardcodingLib:
+  Description: >-
+                 Avoid using `require_relative` with relative path to
+                 lib. Use `require` with absolute path instead.
   Enabled: true
-  VersionAdded: '0.4'
+  VersionAdded: '0.2'
+  VersionChanged: '0.5'

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

@@ -19,10 +19,12 @@ module RuboCop # :nodoc:
       #
       class BundlerSetupInTests < Base
         include RuboCop::Packaging::LibHelperModule
+        include RangeHelp
+        extend AutoCorrector
 
         # 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."
+        MSG = "Using `bundler/setup` in tests is redundant. Consider removing it."
 
         def_node_matcher :bundler_setup?, <<~PATTERN
           (send nil? :require
@@ -45,7 +47,17 @@ module RuboCop # :nodoc:
         def on_send(node)
           return unless bundler_setup?(node)
 
-          add_offense(node)
+          add_offense(node) do |corrector|
+            autocorrect(corrector, node)
+          end
+        end
+
+        # Called from on_send, this method helps to autocorrect
+        # the offenses flagged by this cop.
+        def autocorrect(corrector, node)
+          range = range_by_whole_lines(node.source_range, include_final_newline: true)
+
+          corrector.remove(range)
         end
 
         # This method is called from inside `#def_node_matcher`.

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

@@ -29,6 +29,8 @@ module RuboCop # :nodoc:
       #   end
       #
       #   # good
+      #   require "rake/file_list"
+      #
       #   Gem::Specification.new do |spec|
       #     spec.files         = Rake::FileList["**/*"].exclude(*File.read(".gitignore").split)
       #   end
@@ -51,9 +53,9 @@ module RuboCop # :nodoc:
         # 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. " \
-          "Downstreams often need to build your package in an environment " \
-          "that does not have git (on purpose). " \
-          "Use some pure Ruby alternative, like `Dir` or `Dir.glob`."
+              "Downstreams often need to build your package in an environment " \
+              "that does not have git (on purpose). " \
+              "Use some pure Ruby alternative, like `Dir` or `Dir.glob`."
 
         def_node_search :xstr, <<~PATTERN
           (block

data/lib/rubocop/cop/packaging/{require_with_relative_path.rb → require_hardcoding_lib.rb}

@@ -34,18 +34,21 @@ module RuboCop # :nodoc:
       #   # good
       #   require "baz/qux"
       #
-      class RequireWithRelativePath < Base
+      class RequireHardcodingLib < Base
         include RuboCop::Packaging::LibHelperModule
+        extend AutoCorrector
 
         # 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/`."
+        MSG = "Avoid using `require` with relative path to `lib/`. " \
+              "Use `require` with absolute path instead."
 
         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?)))}
+           (send nil? :require (send (send (const nil? :File) :dirname {(str _) (send nil? _)}) :+ (str #falls_in_lib_with_file_dirname_plus_str?)))
+           (send nil? :require (dstr (begin (send (const nil? :File) :dirname {(str _) (send nil? _)})) (str #falls_in_lib_with_file_dirname_plus_str?)))}
         PATTERN
 
         # Extended from the Base class.
@@ -64,28 +67,40 @@ module RuboCop # :nodoc:
         def on_send(node)
           return unless require?(node)
 
-          add_offense(node)
+          add_offense(node) do |corrector|
+            corrector.replace(node, good_require_call)
+          end
+        end
+
+        # Called from on_send, this method helps to replace
+        # the "bad" require call with the "good" one.
+        def good_require_call
+          good_call = @str.sub(%r{^.*/lib/}, "")
+          %(require "#{good_call}")
         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?
+          @str = str
+          target_falls_in_lib?(str) && inspected_file_is_not_in_lib_or_gemspec?
         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?
+          @str = str
+          target_falls_in_lib_using_file?(str) && inspected_file_is_not_in_lib_or_gemspec?
         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 = str
           str.prepend(".")
-          target_falls_in_lib?(str)
+          target_falls_in_lib?(str) && inspected_file_is_not_in_lib_or_gemspec?
         end
       end
     end

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

@@ -29,11 +29,12 @@ module RuboCop # :nodoc:
       #
       class RequireRelativeHardcodingLib < Base
         include RuboCop::Packaging::LibHelperModule
+        extend AutoCorrector
 
         # 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."
+              "Use `require` with absolute path instead."
 
         def_node_matcher :require_relative, <<~PATTERN
           (send nil? :require_relative
@@ -56,14 +57,24 @@ module RuboCop # :nodoc:
         def on_send(node)
           return unless require_relative(node)
 
-          add_offense(node)
+          add_offense(node) do |corrector|
+            corrector.replace(node, good_require_call)
+          end
+        end
+
+        # Called from on_send, this method helps to replace the
+        # "bad" require_relative call with the "good" one.
+        def good_require_call
+          good_call = File.expand_path(@str, @file_directory).delete_prefix("#{root_dir}/lib/")
+          %(require "#{good_call}")
         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?
+          @str = str
+          target_falls_in_lib?(str) && inspected_file_is_not_in_lib_or_gemspec?
         end
       end
     end

data/lib/rubocop/cop/packaging_cops.rb

@@ -2,5 +2,5 @@
 
 require_relative "packaging/bundler_setup_in_tests"
 require_relative "packaging/gemspec_git"
+require_relative "packaging/require_hardcoding_lib"
 require_relative "packaging/require_relative_hardcoding_lib"
-require_relative "packaging/require_with_relative_path"

data/lib/rubocop/packaging/lib_helper_module.rb

@@ -30,6 +30,12 @@ module RuboCop # :nodoc:
       def inspected_file_is_gemspec?
         @file_path.end_with?("gemspec")
       end
+
+      # This method determines if the inspected file is not in lib/ or
+      # isn't a gemspec file.
+      def inspected_file_is_not_in_lib_or_gemspec?
+        !inspected_file_falls_in_lib? && !inspected_file_is_gemspec?
+      end
     end
   end
 end

data/lib/rubocop/packaging/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-packaging
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Utkarsh Gupta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-03 00:00:00.000000000 Z
+date: 2020-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bump
@@ -109,8 +109,8 @@ files:
 - 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_hardcoding_lib.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
@@ -130,7 +130,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="