skunk 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d3c745cc66587d122f3765510fae8271ff4f9fe050a01b98de8691e247f2948
-  data.tar.gz: 8bc479b7593c3fdcfc2555649e2a3c08d77ef624eda2148d9ba5c6b56e62d1e8
+  metadata.gz: 6c775bb1b34ac224cae3a0485f7279207f2454d2b03cec80f8033d596722b244
+  data.tar.gz: f24e05b044b854d5389ae7ca3f4b1399f2cea4ea154940dafc6ebae7ed3e8c35
 SHA512:
-  metadata.gz: f2537c79bc13dcdc590d52076f46934ed522489cd2c4afe82aea8aca4064e274ece9391c9813188dffd79a23a080e46e36809afdd9c9731de528cfb84adbe3ac
-  data.tar.gz: a8b72fddcd6118858c4cf161c1aa99f3de087e22794cc3c6f68a8b1e1e6d94b2d9f1015a995aed65fd69305e254173b5f4ce615a8d5fe042893fe652274ca394
+  metadata.gz: 0ee6532b02608d746f58317d525da5c0350522326f6431ef2a078d20d721ac5656aea422229915abb70a64f24d4a9b7ed687ce6a69b8bdba75d571b88257b4a1
+  data.tar.gz: 5c6a3555e1b9e9ac3bba2497b71229350ef493dcbe59f203a01b1175009bfc47fa0821fd061543e8ef72bfaf3e0b4b671271a4c35b3a46f8eba0e6cd311ada0c

data/.github/workflows/main.yml

@@ -0,0 +1,19 @@
+# .github/workflows/ci.yml
+
+name: CI
+on: [push, pull_request]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v1
+      - name: Setup Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: 2.6.x
+      - name: Build and run tests
+        run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3
+          bundle exec rake

data/.github/workflows/skunk.yml

@@ -0,0 +1,24 @@
+name: Skunk
+on: [push, pull_request]
+
+jobs:
+  skunk:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v1
+      - name: Setup Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: 2.6.x
+      - name: Run Skunk on Project
+        run: |
+          gem install skunk
+          CURRENT_BRANCH="$(git rev-parse --abbrev-ref HEAD)"
+          if [[ "$CURRENT_BRANCH" -ne "master" ]]; then
+            echo "Executing within branch: $CURRENT_BRANCH"
+            skunk lib/
+          else
+            echo "Executing within master branch"
+            skunk lib/ -b master
+          fi

data/CHANGELOG.md

@@ -4,13 +4,35 @@ 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]
+## [Unreleased] [(commits)](https://github.com/fastruby/skunk/compare/v0.4.0...HEAD)
 
-## [0.2.0] - 2019-10-15
+## [Unreleased] [(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][])
+
+## [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][])
+
+## [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][])
+
+## [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][])
+
+## [0.2.0] - 2019-10-16 [(commits)](https://github.com/fastruby/skunk/compare/v0.1.0...v0.2.0)
 ### Changed
-- Now `skunk` will not report status for files that start with `test/` or `spec/`
+- [FEATURE] Now `skunk` will not report status for files that start with `test/` or `spec/` (by [@etagwerker][])
 
-## [0.1.0] - 2019-10-15
+## [0.1.0] - 2019-10-16
 ### Added
-- Now `skunk` uses `rubycritic-simplecov` to generate a console report with a list
-of files and their "StinkScore"
+- [FEATURE] Now `skunk` uses `rubycritic-simplecov` to generate a console report with a list
+of files and their "StinkScore" (by [@etagwerker][])

data/Gemfile.lock

@@ -2,7 +2,7 @@ PATH
   remote: .
   specs:
     skunk (0.3.2)
-      rubycritic (~> 4.2.1)
+      rubycritic (~> 4.0)
       terminal-table (~> 1.8.0)
 
 GEM
@@ -31,7 +31,7 @@ GEM
       path_expander (~> 1.0)
       ruby_parser (~> 3.0)
       sexp_processor (~> 4.0)
-    flog (4.6.3)
+    flog (4.6.4)
       path_expander (~> 1.0)
       ruby_parser (~> 3.1, > 3.1.0)
       sexp_processor (~> 4.8)
@@ -49,7 +49,7 @@ GEM
       ast (~> 2.4.0)
     path_expander (1.1.0)
     psych (3.1.0)
-    public_suffix (4.0.1)
+    public_suffix (4.0.3)
     rainbow (3.0.0)
     rake (10.5.0)
     reek (5.4.1)
@@ -68,11 +68,11 @@ GEM
     ruby-progressbar (1.10.1)
     ruby_parser (3.14.1)
       sexp_processor (~> 4.9)
-    rubycritic (4.2.2)
+    rubycritic (4.3.2)
       flay (~> 2.8)
       flog (~> 4.4)
       launchy (= 2.4.3)
-      parser (~> 2.6.0)
+      parser (>= 2.6.0)
       rainbow (~> 3.0)
       reek (~> 5.0, < 6.0)
       ruby_parser (~> 3.8)
@@ -92,7 +92,7 @@ GEM
     terminal-table (1.8.0)
       unicode-display_width (~> 1.1, >= 1.1.1)
     thread_safe (0.3.6)
-    tty-which (0.4.1)
+    tty-which (0.4.2)
     unicode-display_width (1.6.0)
     virtus (1.0.5)
       axiom-types (~> 0.1)

data/README.md

@@ -1,13 +1,13 @@
 # Skunk
 
-[![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)
+[![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)
 
 A RubyCritic extension to calculate StinkScore for a file or project.
 
 ## What is the StinkScore?
 
-The StinkScore is a value that assesses the quality of a module. It takes into
-account:
+The StinkScore is a value that assesses the technical debt of a module. It takes
+into account:
 
 - Code Complexity
 - Code Smells
@@ -19,7 +19,7 @@ refactoring adventure. It will help you answer these questions:
 - What can I do to pay off technical debt?
 - What are the most complicated files with the least code coverage?
 - What are good candidates for your next test-writing efforts?
-- What are good candidates for your nest refactoring efforts?
+- What are good candidates for your next refactoring efforts?
 
 The formula is not perfect and it is certainly controversial, so any feedback is
 welcome as a new issue!
@@ -42,6 +42,18 @@ Or install it yourself as:
 
 ## Usage
 
+### Help details
+
+There are not that many options but here they are:
+
+```
+skunk -h
+Usage: skunk [options] [paths]
+    -b, --branch BRANCH              Set branch to compare
+    -v, --version                    Show gem's version
+    -h, --help                       Show this message
+```
+
 ### Getting a sorted list of stinkiest files
 
 To get the best results, make sure that you have `coverage/.resultset.json` in
@@ -58,9 +70,6 @@ Then get a list of stinky files:
 
 ```
 $ skunk
-warning: parser/current is loading parser/ruby26, which recognizes
-warning: 2.6.5-compliant syntax, but you are running 2.6.2.
-warning: please see https://github.com/whitequark/parser#compatibility-with-ruby-mri.
 running flay smells
 
 running flog smells

data/bin/skunk

@@ -0,0 +1 @@
+../exe/skunk

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

@@ -2,6 +2,7 @@
 
 require "rubycritic/commands/compare"
 require "skunk/rubycritic/analysed_modules_collection"
+require "skunk/cli/commands/output"
 
 # nodoc #
 module Skunk
@@ -29,9 +30,10 @@ module Skunk
       # create a txt file with the branch score details
       def build_details
         details = "Base branch (#{::RubyCritic::Config.base_branch}) "\
-                  "average stink score: #{::RubyCritic::Config.base_branch_score} \n"\
-                  "Feature branch (#{::RubyCritic::Config.feature_branch}) "\
-                  "average stink score: #{::RubyCritic::Config.feature_branch_score} \n"
+          "average stink score: #{::RubyCritic::Config.base_branch_score} \n"\
+          "Feature branch (#{::RubyCritic::Config.feature_branch}) "\
+          "average stink score: #{::RubyCritic::Config.feature_branch_score} \n"
+        Skunk::Command::Output.create_directory(::RubyCritic::Config.compare_root_directory)
         File.open(build_details_path, "w") { |file| file.write(details) }
         puts details
       end

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

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Skunk
+  module Command
+    # Implements the needed methods for a successful compare output
+    class Output
+      def self.create_directory(directory)
+        FileUtils.mkdir_p(directory) unless File.exist?(directory)
+      end
+    end
+  end
+end

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

@@ -11,6 +11,8 @@ module Skunk
       attr_accessor :analysed_modules
 
       HEADINGS = %w[file stink_score churn_times_cost churn cost coverage].freeze
+      HEADINGS_WITHOUT_FILE = HEADINGS - %w[file]
+      HEADINGS_WITHOUT_FILE_WIDTH = HEADINGS_WITHOUT_FILE.size * 15 # padding
 
       TEMPLATE = ERB.new(<<-TEMPL
 <%= _ttable %>\n
@@ -66,9 +68,11 @@ TEMPL
       end
 
       def table_options
+        max = sorted_modules.max_by { |a_mod| a_mod.pathname.to_s.length }
+        width = max.pathname.to_s.length + HEADINGS_WITHOUT_FILE_WIDTH
         {
           style: {
-            width: 200
+            width: width
           }
         }
       end

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "rubycritic/commands/version"
+
+# nodoc #
+module Skunk
+  module Command
+    # Shows skunk version
+    class Version < RubyCritic::Command::Version
+      def execute
+        print Skunk::VERSION
+        status_reporter
+      end
+    end
+  end
+end

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

@@ -13,13 +13,6 @@ module Skunk
           parser.new do |opts|
             opts.banner = "Usage: skunk [options] [paths]\n"
 
-            opts.on(
-              "-p", "--path [PATH]",
-              "Set path where report will be saved (tmp/skunk by default)"
-            ) do |path|
-              @root = path
-            end
-
             opts.on("-b", "--branch BRANCH", "Set branch to compare") do |branch|
               self.base_branch = String(branch)
               set_current_branch

data/lib/skunk/version.rb

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

data/skunk.gemspec

@@ -36,7 +36,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "rubycritic", "~> 4.2.1"
+  spec.add_dependency "rubycritic", "~> 4.0"
   spec.add_dependency "terminal-table", "~> 1.8.0"
 
   spec.add_development_dependency "bundler", "~> 2.0"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skunk
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Ernesto Tagwerker
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-23 00:00:00.000000000 Z
+date: 2020-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubycritic
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.2.1
+        version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.2.1
+        version: '4.0'
 - !ruby/object:Gem::Dependency
   name: terminal-table
   requirement: !ruby/object:Gem::Requirement
@@ -172,6 +172,8 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/main.yml"
+- ".github/workflows/skunk.yml"
 - ".gitignore"
 - ".reek.yml"
 - ".rubocop.yml"
@@ -186,6 +188,7 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- bin/skunk
 - exe/skunk
 - lib/skunk.rb
 - lib/skunk/cli/application.rb
@@ -194,7 +197,9 @@ files:
 - lib/skunk/cli/commands/compare.rb
 - lib/skunk/cli/commands/default.rb
 - lib/skunk/cli/commands/help.rb
+- lib/skunk/cli/commands/output.rb
 - lib/skunk/cli/commands/status_reporter.rb
+- lib/skunk/cli/commands/version.rb
 - lib/skunk/cli/options.rb
 - lib/skunk/cli/options/argv.rb
 - lib/skunk/rubycritic/analysed_module.rb
@@ -225,7 +230,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A library to assess code quality vs. code coverage