skunk 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a8741b921c9257b475b2bae0741cc039e8afef0556312667e57ba7986f10f7fa
-  data.tar.gz: 79cc09d05f4a7ac2de50461e3ec1c9351ab68803fd33c7d9166b0d1046051891
+  metadata.gz: 97336bcac813e609a69fe0782edbd188a72cc24919cd5ded18b9b3515bebfecb
+  data.tar.gz: 94a04712f97e7e36f00aedc1d046775c565714dab38fb08e698ba6196fc1981b
 SHA512:
-  metadata.gz: 29cd83b1f165c6e52c0196495428c80f388fd7ca7b633fe01455665632337a8a07b4bcfa26c8d29c34a23101d69ccadf858cb1615aa66812aac603850899c6df
-  data.tar.gz: 6b22ce77d18d98dc8f53275dfde28453a5b877a9b6e30b30fe6393321daad3ae655f13502924ba42991efe4876765e0e0317dc1e1fa3c2e4b1a769ea10f01304
+  metadata.gz: 9996fece8b920f5de38bbd57629e9b64b78865d421a7f51011a3c63233ef60960086dfc0c73723d17bb52911b9167e624e20284cdcece502286feaa70996ee1e
+  data.tar.gz: 327565f1b417f77a2af14c77cb1d7d6e74057491ed154312fe189cb3997eb3526d47a6f1a73cc5600204c2aa95483f9ad117a506870128b8fcb8b85380cdca0d

data/.github/workflows/main.yml

@@ -87,3 +87,18 @@ jobs:
           gem install bundler
           bundle install --jobs 4 --retry 3
           bundle exec rake
+  test-ruby-3-1-x:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v1
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.1
+          bundler-cache: true
+      - name: Build and run tests
+        run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3
+          bundle exec rake

data/.reek.yml

@@ -26,3 +26,4 @@ detectors:
     exclude:
     - Skunk::Cli::Command::Compare#analyse_modified_files
     - Skunk::Cli::Command::Compare#build_details_path
+    - Skunk::Cli::Command::Shareable#sharing?

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2021-02-12 01:27:25 UTC using RuboCop version 1.9.1.
+# on 2021-08-31 01:33:08 UTC using RuboCop version 1.9.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -26,13 +26,6 @@ Layout/HeredocIndentation:
   Exclude:
     - 'lib/skunk/cli/commands/status_reporter.rb'
 
-# Offense count: 1
-# Configuration parameters: AllowedMethods.
-# AllowedMethods: enums
-Lint/ConstantDefinitionInBlock:
-  Exclude:
-    - 'test/lib/skunk/cli/commands/help_test.rb'
-
 # Offense count: 2
 Lint/MissingSuper:
   Exclude:
@@ -48,7 +41,7 @@ Metrics/AbcSize:
 # Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
 # IgnoredMethods: refine
 Metrics/BlockLength:
-  Max: 72
+  Max: 76
 
 # Offense count: 2
 # Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.

data/CHANGELOG.md

@@ -5,52 +5,63 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased] [(commits)](https://github.com/fastruby/skunk/compare/v0.5.1...HEAD)
+## main [(unreleased)](https://github.com/fastruby/skunk/compare/v0.5.2...HEAD)
 
-## [0.5.1] [(commits)](https://github.com/fastruby/skunk/compare/v0.5.0...v0.5.1)
+* <INSERT YOUR FEATURE OR BUGFIX HERE>
+## v0.5.2 / 2022-04-27 [(commits)](https://github.com/fastruby/skunk/compare/v0.5.1...v0.5.2)
 
-* [BUGFIX] Fix bug related to compare plus share code (by [@etagwerker]())
+* [FEATURE: Support more rubies](https://github.com/fastruby/skunk/pull/92)
+* [BUGFIX: Fixed share issue with version command](https://github.com/fastruby/skunk/pull/83)
+* [FEATURE: Add PR Template](https://github.com/fastruby/skunk/pull/72)
+* [BUGFIX: Fix Sponsorship logo path in README](https://github.com/fastruby/skunk/pull/73)
+* [BUGFIX: Test with Ruby 3.1](https://github.com/fastruby/skunk/pull/85)
+* [BUGFIX: Fix changelog uri](https://github.com/fastruby/skunk/pull/90)
 
-## [0.5.0] [(commits)](https://github.com/fastruby/skunk/compare/v0.4.2...v0.5.0)
+## v0.5.1 / 2021-02-17 [(commits)](https://github.com/fastruby/skunk/compare/v0.5.0...v0.5.1)
 
-* [FEATURE] Share your results using an environment variable (by [@rahulpuroht]() and [@etagwerker]())
-* [FEATURE] Rename the tech debt metric: StinkScore => SkunkScore. It's a little friendlier.
-* [FEATURE] Add `--out=file.txt` support to the command line (by [@manuca]())
-* [BUGFIX] Skip both nested and top level spec and test folders
+* [BUGFIX: Fix bug related to compare plus share code](https://github.com/fastruby/skunk/pull/69)
 
-## [0.4.2] [(commits)](https://github.com/fastruby/skunk/compare/v0.4.1...v0.4.2)
-* [BUGFIX] Fixes table width issues by rounding values (by [@etagwerker]())
+## v0.5.0 / 2020-09-18 [(commits)](https://github.com/fastruby/skunk/compare/v0.4.2...v0.5.0)
 
-## [0.4.1] [(commits)](https://github.com/fastruby/skunk/compare/v0.4.0...v0.4.1)
-* [BUGFIX] Fixes table width issues (by [@etagwerker]())
+* [FEATURE: Share your results using an environment variable](https://github.com/fastruby/skunk/pull/56)
+* [FEATURE: Rename the tech debt metric: StinkScore => SkunkScore. It's a little friendlier.](https://github.com/fastruby/skunk/pull/36)
+* [FEATURE: Add `--out=file.txt` support to the command line](https://github.com/fastruby/skunk/pull/47)
+* [BUGFIX: Skip both nested and top level spec and test folders](https://github.com/fastruby/skunk/pull/65)
 
-## [0.4.0] [(commits)](https://github.com/fastruby/skunk/compare/v0.3.2...v0.4.0)
-* [FEATURE] Add `--version` support to the command line. (by [@bronzdoc]())
-* [FEATURE] Stop accepting `-p <path>` in the command line. It's redundant and it's not working anyway. (by [@etagwerker]())
-* [BUGFIX] Change "StinkScore" formula to skip `churn_times_cost` (by [@etagwerker]())
-* [BUGFIX] Fixes #12 (by [@sebastian-palma]())
+## v0.4.2 / 2020-02-09 [(commits)](https://github.com/fastruby/skunk/compare/v0.4.1...v0.4.2)
 
-## [0.3.2] - 2019-11-23 [(commits)](https://github.com/fastruby/skunk/compare/v0.3.1...v0.3.2)
-### Changed
-* [BUGFIX] Change "StinkScore" formula to skip `churn_times_cost` (by [@etagwerker]())
+* [BUGFIX: Fixes table width issues by rounding values](https://github.com/fastruby/skunk/commit/80e2e4743bcb79619f9bb5aed9808bac1ca78231)
 
-## [0.3.1] - 2019-11-19 [(commits)](https://github.com/fastruby/skunk/compare/v0.3.0...v0.3.1)
-### Changed
-* [BUGFIX] Change "StinkScore" formula to skip `churn_times_cost` (by [@etagwerker]())
+## v0.4.1 / 2020-02-09 [(commits)](https://github.com/fastruby/skunk/compare/v0.4.0...v0.4.1)
 
-## [0.3.0] - 2019-11-19 [(commits)](https://github.com/fastruby/skunk/compare/v0.2.0...v0.3.0)
-### Changed
-* [FEATURE] Added Travis CI badge to README (by [@themayurkumbhar]())
-* [FEATURE] Now you can compare "StinkScore" between branches (by [@etagwerker]())
-* [BUGFIX] Add contributor covenant doc (by [@etagwerker]())
-* [BUGFIX] Make sure tests work even you don't have a `coverage/.resultset.json` file (by [@etagwerker]())
-* [BUGFIX] Make tests easier to maintain (by [@etagwerker]())
+* [BUGFIX: Fixes table width issues](https://github.com/fastruby/skunk/commit/372bc506f408e3647ce48b7bc149234c9da71168)
 
-## [0.2.0] - 2019-10-16 [(commits)](https://github.com/fastruby/skunk/compare/v0.1.0...v0.2.0)
-### Changed
-- [FEATURE] Now `skunk` will not report status for files that start with `test/` or `spec/` (by [@etagwerker]())
+## v0.4.0 / 2020-02-08 [(commits)](https://github.com/fastruby/skunk/compare/v0.3.2...v0.4.0)
 
-## [0.1.0] - 2019-10-16
-### Added
-- [FEATURE] Now `skunk` uses `rubycritic-simplecov` to generate a console report with a list
-of files and their "StinkScore" (by [@etagwerker]())
+* [FEATURE: Add `--version` support to the command line.](https://github.com/fastruby/skunk/pull/18)
+* [FEATURE: Stop accepting `-p <path>` in the command line. It's redundant and it's not working anyway.](https://github.com/fastruby/skunk/commit/40976c65a1176b47d3b67f75cd7b4ec92d7c4c88)
+* [BUGFIX: Create compare_root_directory when it does not exist](https://github.com/fastruby/skunk/pull/23) (#12)
+
+## v0.3.2 / 2019-11-23 [(commits)](https://github.com/fastruby/skunk/compare/v0.3.1...v0.3.2)
+
+* [BUGFIX: Make variable binding friendly to avoid warning](https://github.com/fastruby/skunk/pull/20)
+
+## v0.3.1 / 2019-11-19 [(commits)](https://github.com/fastruby/skunk/compare/v0.3.0...v0.3.1)
+
+* [BUGFIX: Change "StinkScore" formula to skip `churn_times_cost`](https://github.com/fastruby/skunk/pull/14)
+
+## v0.3.0 / 2019-11-19 [(commits)](https://github.com/fastruby/skunk/compare/v0.2.0...v0.3.0)
+
+* [FEATURE: Added Travis CI badge to README](https://github.com/fastruby/skunk/pull/3)
+* [FEATURE: Now you can compare "StinkScore" between branches](https://github.com/fastruby/skunk/pull/11)
+* [BUGFIX Add contributor covenant doc](https://github.com/fastruby/skunk/commit/c765a6406f0d53043e8d1c51309d6372196e9f94)
+* [BUGFIX Make sure tests work even you don't have a `coverage/.resultset.json` file](https://github.com/fastruby/skunk/pull/7)
+* [BUGFIX: Make tests easier to maintain](https://github.com/fastruby/skunk/pull/10)
+
+## v0.2.0 / 2019-10-16 [(commits)](https://github.com/fastruby/skunk/compare/v0.1.0...v0.2.0)
+
+* [FEATURE: Now `skunk` will not report status for files that start with `test/` or `spec/`](https://github.com/fastruby/skunk/commit/6f1a3c60967abb114576e71084d80e12b0f0235f) (by
+
+## v0.1.0 / 2019-10-16
+
+* [FEATURE: Now `skunk` uses `rubycritic-simplecov` to generate a console report with a list of files and their "StinkScore"](https://github.com/fastruby/skunk/commit/2ccc5b885b5e12135d963e779566d27d6eefa140)

data/README.md

@@ -1,6 +1,6 @@
 # Skunk
 
-![skunk](https://github.com/fastruby/skunk/raw/master/logo.png)
+![skunk](logo.png)
 
 [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v1.4%20adopted-ff69b4.svg)](CODE_OF_CONDUCT.md) [![Build Status](https://travis-ci.org/fastruby/skunk.svg?branch=master)](https://travis-ci.org/fastruby/skunk) [![Maintainability](https://api.codeclimate.com/v1/badges/3e33d701ced16eee2420/maintainability)](https://codeclimate.com/github/fastruby/skunk/maintainability) [![Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://rubydoc.info/gems/skunk) [![codecov](https://codecov.io/gh/fastruby/skunk/branch/master/graph/badge.svg)](https://codecov.io/gh/fastruby/skunk)
 
@@ -225,10 +225,20 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/fastruby/skunk/issues.
+Bug reports and pull requests are welcome on GitHub at [https://github.com/fastruby/skunk](https://github.com/fastruby/skunk). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/fastruby/skunk/blob/main/CODE_OF_CONDUCT.md).
+
+When Submitting a Pull Request:
+
+* If your PR closes any open GitHub issues, please include `Closes #XXXX` in your comment.
+
+* Please include a summary of the change and which issue is fixed or which feature is introduced.
+
+* If changes to the behavior are made, clearly describe what changes.
+
+* If changes to the UI are made, please include screenshots of the before and after.
 
 ## Sponsorship
 
-![FastRuby.io | Rails Upgrade Services](https://github.com/fastruby/skunk/raw/master/fastruby-logo.png)
+![FastRuby.io | Rails Upgrade Services](fastruby-logo.png)
 
 `skunk` is maintained and funded by [FastRuby.io](https://fastruby.io). The names and logos for FastRuby.io are trademarks of The Lean Software Boutique LLC.

data/lib/skunk/cli/application.rb

@@ -30,8 +30,10 @@ module Skunk
         reporter = command.execute
 
         print(reporter.status_message)
-        share_status_message = command.share(reporter)
-        print(share_status_message)
+        if command.sharing?
+          share_status_message = command.share(reporter)
+          print(share_status_message)
+        end
 
         reporter.status
       rescue OptionParser::InvalidOption => e

data/lib/skunk/cli/commands/help.rb

@@ -14,6 +14,10 @@ module Skunk
           status_reporter
         end
 
+        def sharing?
+          false
+        end
+
         private
 
         attr_reader :options, :status_reporter

data/lib/skunk/cli/commands/shareable.rb

@@ -15,6 +15,12 @@ module Skunk
           sharer.status_reporter = reporter
           sharer.share
         end
+
+        # @return [Boolean] If the environment is set to share to an external
+        # service
+        def sharing?
+          ENV["SHARE"] == "true"
+        end
       end
     end
   end

data/lib/skunk/cli/commands/status_reporter.rb

@@ -75,7 +75,7 @@ TEMPL
         width = max.pathname.to_s.length + HEADINGS_WITHOUT_FILE_WIDTH
         {
           style: {
-            width: width
+            width: width # rubocop:disable Style/HashSyntax
           }
         }
       end

data/lib/skunk/cli/commands/status_sharer.rb

@@ -38,6 +38,7 @@ module Skunk
         ENV["SHARE_URL"] || DEFAULT_URL
       end
 
+      # rubocop:disable Style/HashSyntax
       def json_summary
         result = {
           total_skunk_score: total_skunk_score,
@@ -55,6 +56,7 @@ module Skunk
 
         result
       end
+      # rubocop:enable Style/HashSyntax
 
       def json_results
         sorted_modules.map(&:to_hash)

data/lib/skunk/cli/commands/version.rb

@@ -4,12 +4,18 @@ require "rubycritic/commands/version"
 
 # nodoc #
 module Skunk
-  module Command
-    # Shows skunk version
-    class Version < RubyCritic::Command::Version
-      def execute
-        print Skunk::VERSION
-        status_reporter
+  module Cli
+    module Command
+      # Shows skunk version
+      class Version < RubyCritic::Command::Version
+        def execute
+          print Skunk::VERSION
+          status_reporter
+        end
+
+        def sharing?
+          false
+        end
       end
     end
   end

data/lib/skunk/cli/options/argv.rb

@@ -37,7 +37,7 @@ module Skunk
         end
 
         def to_h
-          super.merge(output_filename: output_filename)
+          super.merge(output_filename: output_filename) # rubocop:disable Style/HashSyntax
         end
       end
     end

data/lib/skunk/rubycritic/analysed_module.rb

@@ -53,6 +53,7 @@ module RubyCritic
     #   - coverage
     #
     # @return [Hash]
+    # rubocop:disable Style/HashSyntax
     def to_hash
       {
         file: pathname.to_s,
@@ -63,5 +64,6 @@ module RubyCritic
         coverage: coverage.round(2)
       }
     end
+    # rubocop:enable Style/HashSyntax
   end
 end

data/lib/skunk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Skunk
-  VERSION = "0.5.1"
+  VERSION = "0.5.2"
 end

data/pull_request_template.md

@@ -0,0 +1,11 @@
+**IMPORTANT**: Please read the README before submitting pull requests for this project. Additionally, if your PR closes any open GitHub issue, make sure you include Closes #XXXX in your comment.
+
+- [ ] Add an entry to `CHANGELOG.md` that links to this PR under the "main (unreleased)" heading.
+
+Description:
+
+Please include a summary of the change and which issue is fixed or which feature is introduced.
+
+If changes to the behavior are made, clearly describe what changes.
+
+I will abide by the [code of conduct](https://github.com/fastruby/skunk/blob/main/CODE_OF_CONDUCT.md).

data/skunk.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |spec|
   spec.description   = "Knows how to calculate the SkunkScore for a set of Ruby modules"
   spec.homepage      = "https://github.com/fastruby/skunk"
 
-  spec.required_ruby_version = [">= 2.4.0", "< 3.1.0"]
+  spec.required_ruby_version = [">= 2.4.0", "< 3.2"]
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
 
     spec.metadata["homepage_uri"] = spec.homepage
     spec.metadata["source_code_uri"] = "https://github.com/fastruby/skunk"
-    spec.metadata["changelog_uri"] = "https://github.com/fastruby/skunk/changelog"
+    spec.metadata["changelog_uri"] = "https://github.com/fastruby/skunk/blob/main/CHANGELOG.md"
   else
     raise "RubyGems 2.0 or newer is required to protect against " \
       "public gem pushes."

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skunk
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - Ernesto Tagwerker
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-18 00:00:00.000000000 Z
+date: 2022-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubycritic
@@ -271,6 +271,7 @@ files:
 - lib/skunk/rubycritic/analysed_modules_collection.rb
 - lib/skunk/version.rb
 - logo.png
+- pull_request_template.md
 - samples/engines/spec/nested_sample_spec.rb
 - samples/rubycritic/analysed_module.rb
 - skunk.gemspec
@@ -281,7 +282,7 @@ metadata:
   allowed_push_host: https://www.rubygems.org
   homepage_uri: https://github.com/fastruby/skunk
   source_code_uri: https://github.com/fastruby/skunk
-  changelog_uri: https://github.com/fastruby/skunk/changelog
+  changelog_uri: https://github.com/fastruby/skunk/blob/main/CHANGELOG.md
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -293,14 +294,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.4.0
   - - "<"
     - !ruby/object:Gem::Version
-      version: 3.1.0
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.9
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: A library to assess code quality vs. code coverage