rubocop-packaging 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a302f7a6e19e06fa73adecfaa4be36d8db647d2aef3571554d4246b222306c6
-  data.tar.gz: af9c1d6e9435f94adbdaaf8a256291e3546fe3dfc024f36abf462c1e1b707046
+  metadata.gz: 72be16aa270e6a0acac89f70963f75e8c4510932a76cf254bf8d4b54e4a25f43
+  data.tar.gz: 68e3647ae5c13139e5fdf799bdc6e32b2e51df23c0ca676e60d2b6e29e3f0f0c
 SHA512:
-  metadata.gz: 11fc92be8299fb440ed62524b58d9d0684e520ad30879c86c2a79d16a6880248090f595a50ace1bc8569f551ad0b5e56ae5773398a6b2f4c91232b1e31009612
-  data.tar.gz: b50af49a31c46beb60f283604bb2877b0bd461bcd702adacf39f635d48603484782f52ef923b9fe960f035c0ce9bda3fe7d0fa1be17bf0076864445ab7571183
+  metadata.gz: c938f05cabce5bccc176fc40ecb62c029718884f7cfbdcd35c7cdfe712164ef86827d3e1eb93ae64f03ebf3ee7ea086acfa1967082d65fdefd9fed851987a42e
+  data.tar.gz: d7830f8e572577ba14554c2e8589ee99ae9898b91451143ab6b441c30d80930608ad97421582e38fdea212f047a826821ee1f83adbfd6f4261182af7b9bae9de

data/README.md

@@ -5,9 +5,15 @@ which is a Ruby static code analyzer (a.k.a. linter) and code formatter.
 
 It helps enforcing some of the guidelines that are expected of upstream
 maintainers so that the downstream can build their packages in a clean
-environment without any problems.  
-Some of the other basic guidelines can be found
-[here](https://wiki.debian.org/Teams/Ruby/RubyExtras/UpstreamDevelopers).
+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).
+
+In case anything is not clear, please feel free to raise an issue, asking
+for more explanation!
 
 ## Installation
 

data/config/default.yml

@@ -6,7 +6,8 @@ Packaging/GemspecGit:
   VersionAdded: '0.1'
   VersionChanged: '0.1'
 
-Packaging/RelativeRequireToLib:
+Packaging/RequireRelativeHardcodingLib:
   Description: 'Avoid using `require_relative` with relative path to lib.'
   Enabled: true
   VersionAdded: '0.2'
+  VersionChanged: '0.3'

data/lib/rubocop-packaging.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require 'rubocop'
+require "rubocop"
 
-require_relative 'rubocop/packaging'
-require_relative 'rubocop/packaging/version'
-require_relative 'rubocop/packaging/inject'
+require_relative "rubocop/packaging"
+require_relative "rubocop/packaging/version"
+require_relative "rubocop/packaging/inject"
 
 RuboCop::Packaging::Inject.defaults!
 
-require_relative 'rubocop/cop/packaging_cops'
+require_relative "rubocop/cop/packaging_cops"

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

@@ -3,56 +3,60 @@
 module RuboCop # :nodoc:
   module Cop # :nodoc:
     module Packaging # :nodoc:
-      # This cop is used to identify the usage of `git ls-files`
+      # This cop flags the usage of `git ls-files` in gemspec
       # and suggests to use a plain Ruby alternative, like `Dir`,
-      # `Dir.glob` or `Rake::FileList` instead.
+      # `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
       #   Gem::Specification.new do |spec|
-      #     spec.files = `git ls-files`.split('\n')
+      #     spec.files         = `git ls-files`.split("\n")
+      #     spec.test_files    = `git ls-files -- spec`.split("\n")
       #   end
       #
-      #   # bad
+      #   # good
       #   Gem::Specification.new do |spec|
-      #     spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
-      #       `git ls-files -z`.split('\\x0').reject { |f| f.match(%r{^(test|spec|features)/}) }
-      #     end
+      #     spec.files         = Dir["lib/**/*", "LICENSE", "README.md"]
+      #     spec.test_files    = Dir["spec/**/*"]
       #   end
       #
       #   # bad
       #   Gem::Specification.new do |spec|
-      #     spec.files         = `git ls-files`.split('\n')
-      #     spec.test_files    = `git ls-files -- test/{functional,unit}/*`.split('\n')
-      #     spec.executables   = `git ls-files -- bin/*`.split('\n').map{ |f| File.basename(f) }
+      #     spec.files = Dir.chdir(File.expand_path(__dir__)) do
+      #       `git ls-files -z`.split("\\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+      #     end
       #   end
       #
       #   # good
       #   Gem::Specification.new do |spec|
-      #     spec.files         = Dir['lib/**/*', 'LICENSE', 'README.md']
-      #     spec.test_files    = Dir['spec/**/*']
+      #     spec.files         = Rake::FileList["**/*"].exclude(*File.read(".gitignore").split)
       #   end
       #
-      #   # good
+      #   # bad
       #   Gem::Specification.new do |spec|
-      #     spec.files         = Rake::FileList['**/*'].exclude(*File.read('.gitignore').split)
+      #     spec.files         = `git ls-files -- lib/`.split("\n")
+      #     spec.test_files    = `git ls-files -- test/{functional,unit}/*`.split("\n")
+      #     spec.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
       #   end
       #
       #   # good
       #   Gem::Specification.new do |spec|
-      #     spec.files         = Dir.glob('lib/**/*')
-      #     spec.test_files    = Dir.glob('test/{functional,test}/*')
-      #     spec.executables   = Dir.glob('bin/*').map{ |f| File.basename(f) }
+      #     spec.files         = Dir.glob("lib/**/*")
+      #     spec.test_files    = Dir.glob("test/{functional,test}/*")
+      #     spec.executables   = Dir.glob("bin/*").map{ |f| File.basename(f) }
       #   end
       #
       class GemspecGit < Cop
         # 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`.'
+        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`."
 
         def_node_search :xstr, <<~PATTERN
           (block
@@ -81,9 +85,9 @@ module RuboCop # :nodoc:
         end
 
         # This method is called from inside `#def_node_search`.
-        # It is used to find strings which start with 'git'.
+        # It is used to find strings which start with "git".
         def starts_with_git?(str)
-          str.start_with?('git')
+          str.start_with?("git")
         end
       end
     end

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

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module RuboCop # :nodoc:
+  module Cop # :nodoc:
+    module Packaging # :nodoc:
+      # This cop flags the `require_relative` calls, from anywhere
+      # 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
+      #   require_relative "lib/foo.rb"
+      #
+      #   # good
+      #   require "foo.rb"
+      #
+      #   # bad
+      #   require_relative "../../lib/foo/bar"
+      #
+      #   # good
+      #   require "foo/bar"
+      #
+      #   # good
+      #   require_relative "spec_helper"
+      #   require_relative "spec/foo/bar"
+      #
+      class RequireRelativeHardcodingLib < 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 #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
+
+        # 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
+end

data/lib/rubocop/cop/packaging_cops.rb

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

data/lib/rubocop/packaging.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
-require 'rubocop/packaging/version'
+require "rubocop/packaging/version"
 
 module RuboCop
   # RuboCop Packaging project namespace
   module Packaging
     PROJECT_ROOT   = Pathname.new(__dir__).parent.parent.expand_path.freeze
-    CONFIG_DEFAULT = PROJECT_ROOT.join('config', 'default.yml').freeze
+    CONFIG_DEFAULT = PROJECT_ROOT.join("config", "default.yml").freeze
     CONFIG         = YAML.safe_load(CONFIG_DEFAULT.read).freeze
 
     private_constant(:CONFIG_DEFAULT, :PROJECT_ROOT)

data/lib/rubocop/packaging/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubocop-packaging
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Utkarsh Gupta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-07-24 00:00:00.000000000 Z
+date: 2020-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bump
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.88'
+        version: '0.89'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.88'
+        version: '0.89'
 description: |
   A collection of RuboCop cops to check for downstream compatability issues in the
   Ruby code.
@@ -108,7 +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/require_relative_hardcoding_lib.rb
 - lib/rubocop/cop/packaging_cops.rb
 - lib/rubocop/packaging.rb
 - lib/rubocop/packaging/inject.rb

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

@@ -1,67 +0,0 @@
-# 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