skunk 0.4.2 → 0.5.0

data/lib/skunk/rubycritic/analysed_modules_collection.rb

@@ -5,10 +5,10 @@ require "rubycritic/core/analysed_modules_collection"
 module RubyCritic
   # nodoc #
   class AnalysedModulesCollection
-    def stink_score_average
+    def skunk_score_average
       num_modules = @modules.size
       if num_modules.positive?
-        map(&:stink_score).reduce(:+) / num_modules.to_f
+        sum(&:skunk_score) / num_modules.to_f
       else
         0.0
       end

data/lib/skunk/version.rb

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

data/samples/engines/spec/nested_sample_spec.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+def hello
+  puts "hello world"
+end

data/samples/rubycritic/analysed_module.rb

@@ -3,34 +3,34 @@
 require "rubycritic/core/analysed_module"
 
 module RubyCritic
-  # Monkey-patches RubyCritic::AnalysedModule to add a stink_score method
+  # Monkey-patches RubyCritic::AnalysedModule to add a skunk_score method
   class AnalysedModule
     PERFECT_COVERAGE = 100
 
-    # Returns a numeric value that represents the stink_score of a module:
+    # Returns a numeric value that represents the skunk_score of a module:
     #
-    # If module is perfectly covered, stink score is the same as the
+    # If module is perfectly covered, skunk score is the same as the
     # `churn_times_cost`
     #
-    # If module has no coverage, stink score is a penalized value of
+    # If module has no coverage, skunk score is a penalized value of
     # `churn_times_cost`
     #
-    # For now the stink_score is calculated by multiplying `churn_times_cost`
+    # For now the skunk_score is calculated by multiplying `churn_times_cost`
     # times the lack of coverage.
     #
     # For example:
     #
     # When `churn_times_cost` is 100 and module is perfectly covered:
-    # stink_score => 100
+    # skunk_score => 100
     #
     # When `churn_times_cost` is 100 and module is not covered at all:
-    # stink_score => 100 * 100 = 10_000
+    # skunk_score => 100 * 100 = 10_000
     #
     # When `churn_times_cost` is 100 and module is covered at 75%:
-    # stink_score => 100 * 25 (percentage uncovered) = 2_500
+    # skunk_score => 100 * 25 (percentage uncovered) = 2_500
     #
     # @return [Float]
-    def stink_score
+    def skunk_score
       return cost.round(2) if coverage == PERFECT_COVERAGE
 
       (cost * (PERFECT_COVERAGE - coverage.to_i)).round(2)

data/skunk.gemspec

@@ -11,9 +11,11 @@ Gem::Specification.new do |spec|
   spec.email         = ["ernesto+github@ombulabs.com"]
   spec.licenses      = ["MIT"]
   spec.summary       = "A library to assess code quality vs. code coverage"
-  spec.description   = "Knows how to calculate the StinkScore for a Ruby file"
+  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"]
+
   # 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.
   if spec.respond_to?(:metadata)
@@ -36,16 +38,20 @@ 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.0"
+  spec.add_dependency "rubycritic", ">= 4.5.2", "< 5.0"
   spec.add_dependency "terminal-table", "~> 1.8.0"
 
-  spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "byebug", "~> 11"
+  spec.add_development_dependency "codecov", "~> 0.1.16"
   spec.add_development_dependency "minitest", "~> 5.8.4"
   spec.add_development_dependency "minitest-around", "~> 0.5.0"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "reek", "~> 5.4.0"
-  spec.add_development_dependency "rubocop", "< 1.0"
-  spec.add_development_dependency "simplecov", "~> 0.17.1"
+  spec.add_development_dependency "minitest-stub_any_instance", "~> 1.0.2"
+  spec.add_development_dependency "minitest-stub-const", "~> 0.6"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "reek", "~> 6.0.0"
+  spec.add_development_dependency "rubocop", "~> 1.0"
+  spec.add_development_dependency "simplecov", "~> 0.18"
   spec.add_development_dependency "simplecov-console", "0.5.0"
+  spec.add_development_dependency "vcr", "~> 6.0.0"
+  spec.add_development_dependency "webmock", "~> 3.10.0"
 end

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: skunk
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Ernesto Tagwerker
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-02-09 00:00:00.000000000 Z
+date: 2021-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubycritic
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.5.2
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: 4.5.2
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: terminal-table
   requirement: !ruby/object:Gem::Requirement
@@ -39,33 +45,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 1.8.0
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '11'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: codecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11'
+        version: 0.1.16
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '11'
+        version: 0.1.16
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -94,46 +100,74 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.5.0
+- !ruby/object:Gem::Dependency
+  name: minitest-stub_any_instance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.2
+- !ruby/object:Gem::Dependency
+  name: minitest-stub-const
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: reek
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.4.0
+        version: 6.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 5.4.0
+        version: 6.0.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
@@ -142,14 +176,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.1
+        version: '0.18'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.17.1
+        version: '0.18'
 - !ruby/object:Gem::Dependency
   name: simplecov-console
   requirement: !ruby/object:Gem::Requirement
@@ -164,7 +198,35 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.5.0
-description: Knows how to calculate the StinkScore for a Ruby file
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.10.0
+description: Knows how to calculate the SkunkScore for a set of Ruby modules
 email:
 - ernesto+github@ombulabs.com
 executables:
@@ -172,36 +234,43 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
 - ".github/workflows/main.yml"
 - ".github/workflows/skunk.yml"
 - ".gitignore"
 - ".reek.yml"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
-- ".travis.yml"
 - CHANGELOG.md
+- CODEOWNERS
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
+- Gemfile-Ruby-2-4
 - LICENSE.txt
 - README.md
 - Rakefile
 - exe/skunk
+- fastruby-logo.png
 - lib/skunk.rb
 - lib/skunk/cli/application.rb
 - lib/skunk/cli/command_factory.rb
 - lib/skunk/cli/commands/base.rb
 - lib/skunk/cli/commands/compare.rb
+- lib/skunk/cli/commands/compare_score.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/status_sharer.rb
 - lib/skunk/cli/commands/version.rb
 - lib/skunk/cli/options.rb
 - lib/skunk/cli/options/argv.rb
 - lib/skunk/rubycritic/analysed_module.rb
 - lib/skunk/rubycritic/analysed_modules_collection.rb
 - lib/skunk/version.rb
+- logo.png
+- samples/engines/spec/nested_sample_spec.rb
 - samples/rubycritic/analysed_module.rb
 - skunk.gemspec
 homepage: https://github.com/fastruby/skunk
@@ -212,7 +281,7 @@ metadata:
   homepage_uri: https://github.com/fastruby/skunk
   source_code_uri: https://github.com/fastruby/skunk
   changelog_uri: https://github.com/fastruby/skunk/changelog
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -220,15 +289,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.4.0
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: A library to assess code quality vs. code coverage
 test_files: []

data/.travis.yml

@@ -1,5 +0,0 @@
-language: ruby
-rvm:
- - 2.5
- - 2.6
- - 2.7

data/Gemfile.lock

@@ -1,119 +0,0 @@
-PATH
-  remote: .
-  specs:
-    skunk (0.4.2)
-      rubycritic (~> 4.0)
-      terminal-table (~> 1.8.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    addressable (2.7.0)
-      public_suffix (>= 2.0.2, < 5.0)
-    ansi (1.5.0)
-    ast (2.4.0)
-    axiom-types (0.1.1)
-      descendants_tracker (~> 0.0.4)
-      ice_nine (~> 0.11.0)
-      thread_safe (~> 0.3, >= 0.3.1)
-    byebug (11.0.1)
-    codeclimate-engine-rb (0.4.1)
-      virtus (~> 1.0)
-    coercible (1.0.0)
-      descendants_tracker (~> 0.0.1)
-    descendants_tracker (0.0.4)
-      thread_safe (~> 0.3, >= 0.3.1)
-    docile (1.3.2)
-    equalizer (0.0.11)
-    erubis (2.7.0)
-    flay (2.12.1)
-      erubis (~> 2.7.0)
-      path_expander (~> 1.0)
-      ruby_parser (~> 3.0)
-      sexp_processor (~> 4.0)
-    flog (4.6.4)
-      path_expander (~> 1.0)
-      ruby_parser (~> 3.1, > 3.1.0)
-      sexp_processor (~> 4.8)
-    ice_nine (0.11.2)
-    jaro_winkler (1.5.4)
-    json (2.2.0)
-    kwalify (0.7.2)
-    launchy (2.4.3)
-      addressable (~> 2.3)
-    minitest (5.8.5)
-    minitest-around (0.5.0)
-      minitest (~> 5.0)
-    parallel (1.19.0)
-    parser (2.6.5.0)
-      ast (~> 2.4.0)
-    path_expander (1.1.0)
-    psych (3.1.0)
-    public_suffix (4.0.3)
-    rainbow (3.0.0)
-    rake (10.5.0)
-    reek (5.4.1)
-      codeclimate-engine-rb (~> 0.4.0)
-      kwalify (~> 0.7.0)
-      parser (>= 2.5.0.0, < 2.7, != 2.5.1.1)
-      psych (~> 3.1.0)
-      rainbow (>= 2.0, < 4.0)
-    rubocop (0.76.0)
-      jaro_winkler (~> 1.5.1)
-      parallel (~> 1.10)
-      parser (>= 2.6)
-      rainbow (>= 2.2.2, < 4.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 1.7)
-    ruby-progressbar (1.10.1)
-    ruby_parser (3.14.2)
-      sexp_processor (~> 4.9)
-    rubycritic (4.3.3)
-      flay (~> 2.8)
-      flog (~> 4.4)
-      launchy (= 2.4.3)
-      parser (>= 2.6.0)
-      rainbow (~> 3.0)
-      reek (~> 5.0, < 6.0)
-      ruby_parser (~> 3.8)
-      simplecov (>= 0.17.0)
-      tty-which (~> 0.4.0)
-      virtus (~> 1.0)
-    sexp_processor (4.14.0)
-    simplecov (0.17.1)
-      docile (~> 1.1)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-console (0.5.0)
-      ansi
-      simplecov
-      terminal-table
-    simplecov-html (0.10.2)
-    terminal-table (1.8.0)
-      unicode-display_width (~> 1.1, >= 1.1.1)
-    thread_safe (0.3.6)
-    tty-which (0.4.2)
-    unicode-display_width (1.6.0)
-    virtus (1.0.5)
-      axiom-types (~> 0.1)
-      coercible (~> 1.0)
-      descendants_tracker (~> 0.0, >= 0.0.3)
-      equalizer (~> 0.0, >= 0.0.9)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 2.0)
-  byebug (~> 11)
-  minitest (~> 5.8.4)
-  minitest-around (~> 0.5.0)
-  rake (~> 10.0)
-  reek (~> 5.4.0)
-  rubocop (< 1.0)
-  simplecov (~> 0.17.1)
-  simplecov-console (= 0.5.0)
-  skunk!
-
-BUNDLED WITH
-   2.0.2