rubocop-packaging 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7763971e3ccedea64e6db97b4ec6351d489b99fe36110f4d01374a67bce0c0d1
+  data.tar.gz: 4e4e52ee808aba2ba256a757c225802cff30bafe9521ec33a259dbfe7f037e42
+SHA512:
+  metadata.gz: c2cdd53a7671b724141244e0efec24e8a4eeffbe3a4e9830b3eb6b80fbf487f74649e552b465b6b17f537d985278d7da38bba14fc9a816d781adee54aefb55d3
+  data.tar.gz: 9f16cf74a99ab1d56e01ad056440d2329013a441a62618eccc4e1ee2a6052ed7df4fd5565f095468feb7739c863ca957f9199a8a4e3c8db1de92958e5bf802c6

data/LICENSE

@@ -0,0 +1,25 @@
+MIT License
+===========
+
+Copyright (©) 2020 Utkarsh Gupta <utkarsh@debian.org>
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+ 
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+ 
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,86 @@
+# RuboCop::Packaging
+
+`RuboCop::Packaging` is an extension of [RuboCop](https://rubocop.org/),
+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).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rubocop-packaging'
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install rubocop-packaging
+```
+
+## Usage
+
+You need to tell RuboCop to load the Packaging extension. There are three
+ways to do this:
+
+### RuboCop configuration file
+
+Put this into your `.rubocop.yml` file:
+
+```yaml
+require: rubocop-packaging
+```
+
+Alternatively, use the following array notation when specifying multiple
+extensions:
+
+```yaml
+require:
+  - rubocop-other-extension
+  - rubocop-packaging
+```
+
+Now you can run `rubocop` and it will automatically load the RuboCop Packaging
+cops together with the standard cops.
+
+### Command line
+
+```bash
+rubocop --require rubocop-packaging
+```
+
+### Rake task
+
+```ruby
+RuboCop::RakeTask.new do |task|
+  task.requires << 'rubocop-packaging'
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then,
+run `rake spec` to run the tests. 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`.
+
+## Contributing
+
+As always, bug reports and pull requests are heartily welcomed! 💖  
+This project is intended to be a safe and welcoming space for collaboration.
+
+## License
+`rubocop-packaging` is available as open-source under the
+[MIT License](https://github.com/utkarsh2102/rubocop-packaging/blob/master/LICENSE).

data/config/default.yml

@@ -0,0 +1,6 @@
+# This is the default configuration file.
+
+Packaging/GemspecGit:
+  Description: 'Use pure Ruby alternative instead of `git ls-files`.'
+  Enabled: true
+  VersionAdded: '0.86'

data/lib/rubocop-packaging.rb

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

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

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+module RuboCop # :nodoc:
+  module Cop # :nodoc:
+    module Packaging # :nodoc:
+      # This cop is used to identify the usage of `git ls-files`
+      # and suggests to use a plain Ruby alternative, like `Dir`,
+      # `Dir.glob` or `Rake::FileList` instead.
+      #
+      # @example
+      #
+      #   # bad
+      #   Gem::Specification.new do |spec|
+      #     spec.files = `git ls-files`.split('\n')
+      #   end
+      #
+      #   # bad
+      #   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
+      #   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) }
+      #   end
+      #
+      #   # good
+      #   Gem::Specification.new do |spec|
+      #     spec.files         = Dir['lib/**/*', 'LICENSE', 'README.md']
+      #     spec.test_files    = Dir['spec/**/*']
+      #   end
+      #
+      #   # good
+      #   Gem::Specification.new do |spec|
+      #     spec.files         = Rake::FileList['**/*'].exclude(*File.read('.gitignore').split)
+      #   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) }
+      #   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`.'
+
+        def_node_search :xstr, <<~PATTERN
+          (block
+            (send
+              (const
+                (const {cbase nil?} :Gem) :Specification) :new)
+            (args
+              (arg _)) `$(xstr (str #starts_with_git?)))
+        PATTERN
+
+        # Extended from the Cop class.
+        # More about the `#investigate` method can be found here:
+        # 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)
+          xstr(processed_source.ast).each do |node|
+            add_offense(
+              processed_source.ast,
+              location: node.loc.expression,
+              message: MSG
+            )
+          end
+        end
+
+        # This method is called from inside `#def_node_search`.
+        # It is used to find strings which start with 'git'.
+        def starts_with_git?(str)
+          str.start_with?('git')
+        end
+      end
+    end
+  end
+end

data/lib/rubocop/cop/packaging_cops.rb

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

data/lib/rubocop/packaging.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+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         = YAML.safe_load(CONFIG_DEFAULT.read).freeze
+
+    private_constant(:CONFIG_DEFAULT, :PROJECT_ROOT)
+  end
+end

data/lib/rubocop/packaging/inject.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Packaging
+    # 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/packaging/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RuboCop
+  module Packaging
+    VERSION = '0.1.0'
+  end
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: rubocop-packaging
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Utkarsh Gupta
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-06-17 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
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.75.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.75.0
+description: |
+  A collection of RuboCop cops to check for downstream compatability issues in the
+  Ruby code.
+email:
+- utkarsh@debian.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- config/default.yml
+- lib/rubocop-packaging.rb
+- lib/rubocop/cop/packaging/gemspec_git.rb
+- lib/rubocop/cop/packaging_cops.rb
+- lib/rubocop/packaging.rb
+- lib/rubocop/packaging/inject.rb
+- lib/rubocop/packaging/version.rb
+homepage: https://github.com/utkarsh2102/rubocop-packaging
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/utkarsh2102/rubocop-packaging
+  source_code_uri: https://github.com/utkarsh2102/rubocop-packaging
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Automatic downstream compatability checking tool for Ruby code
+test_files: []