skunk 0.5.2 → 0.5.4

data/lib/skunk/{cli/commands → commands}/status_sharer.rb

@@ -4,7 +4,7 @@ require "net/http"
 require "net/https"
 require "json"
 
-require "skunk/cli/commands/status_reporter"
+require "skunk/commands/status_reporter"
 
 module Skunk
   module Command
@@ -38,7 +38,6 @@ module Skunk
         ENV["SHARE_URL"] || DEFAULT_URL
       end
 
-      # rubocop:disable Style/HashSyntax
       def json_summary
         result = {
           total_skunk_score: total_skunk_score,
@@ -56,7 +55,6 @@ module Skunk
 
         result
       end
-      # rubocop:enable Style/HashSyntax
 
       def json_results
         sorted_modules.map(&:to_hash)

data/lib/skunk/commands/version.rb

@@ -0,0 +1,20 @@
+# 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
+
+      def sharing?
+        false
+      end
+    end
+  end
+end

data/lib/skunk/generators/json/simple.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require "rubycritic/generators/json/simple"
+
+module Skunk
+  module Generator
+    module Json
+      # Generates a JSON report for the analysed modules.
+      class Simple < RubyCritic::Generator::Json::Simple
+        def data
+          {
+            analysed_modules_count: analysed_modules_count,
+            skunk_score_average: skunk_score_average,
+            skunk_score_total: skunk_score_total,
+            worst_pathname: worst&.pathname,
+            worst_score: worst&.skunk_score,
+            files: files
+          }
+        end
+
+        private
+
+        def analysed_modules_count
+          @analysed_modules_count ||= non_test_modules.count
+        end
+
+        def skunk_score_average
+          return 0 if analysed_modules_count.zero?
+
+          (skunk_score_total.to_d / analysed_modules_count).to_f.round(2)
+        end
+
+        def skunk_score_total
+          @skunk_score_total ||= non_test_modules.sum(&:skunk_score)
+        end
+
+        def non_test_modules
+          @non_test_modules ||= @analysed_modules.reject do |a_module|
+            module_path = a_module.pathname.dirname.to_s
+            module_path.start_with?("test", "spec") || module_path.end_with?("test", "spec")
+          end
+        end
+
+        def worst
+          @worst ||= sorted_modules.first
+        end
+
+        def sorted_modules
+          @sorted_modules ||= non_test_modules.sort_by(&:skunk_score).reverse!
+        end
+
+        def files
+          @files ||= sorted_modules.map(&:to_hash)
+        end
+      end
+    end
+  end
+end

data/lib/skunk/generators/json_report.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "rubycritic/generators/json_report"
+
+require "skunk/generators/json/simple"
+
+module Skunk
+  module Generator
+    # Generates a JSON report for the analysed modules.
+    class JsonReport < RubyCritic::Generator::JsonReport
+      def initialize(analysed_modules)
+        super
+        @analysed_modules = analysed_modules
+      end
+
+      private
+
+      def generator
+        Skunk::Generator::Json::Simple.new(@analysed_modules)
+      end
+    end
+  end
+end

data/lib/skunk/reporter.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Skunk
+  # Pick the right report generator based on the format specified in the
+  # configuration. If the format is not supported, it will default to ConsoleReport.
+  module Reporter
+    REPORT_GENERATOR_CLASS_FORMATS = %i[json].freeze
+
+    def self.generate_report(analysed_modules)
+      RubyCritic::Config.formats.uniq.each do |format|
+        report_generator_class(format).new(analysed_modules).generate_report
+      end
+    end
+
+    def self.report_generator_class(config_format)
+      if REPORT_GENERATOR_CLASS_FORMATS.include? config_format
+        require "skunk/generators/#{config_format}_report"
+        Generator.const_get("#{config_format.capitalize}Report")
+      else
+        require "skunk/generators/console_report"
+        Generator::ConsoleReport
+      end
+    end
+  end
+end

data/lib/skunk/rubycritic/analysed_module.rb

@@ -10,30 +10,38 @@ module RubyCritic
     # Returns a numeric value that represents the skunk_score of a module:
     #
     # If module is perfectly covered, skunk score is the same as the
-    # `churn_times_cost`
+    # `cost`
     #
     # If module has no coverage, skunk score is a penalized value of
-    # `churn_times_cost`
+    # `cost`
     #
-    # For now the skunk_score is calculated by multiplying `churn_times_cost`
+    # For now the skunk_score is calculated by multiplying `cost`
     # times the lack of coverage.
     #
     # For example:
     #
-    # When `churn_times_cost` is 100 and module is perfectly covered:
+    # When `cost` is 100 and module is perfectly covered:
     # skunk_score => 100
     #
-    # When `churn_times_cost` is 100 and module is not covered at all:
+    # When `cost` is 100 and module is not covered at all:
     # skunk_score => 100 * 100 = 10_000
     #
-    # When `churn_times_cost` is 100 and module is covered at 75%:
+    # When `cost` is 100 and module is covered at 75%:
     # skunk_score => 100 * 25 (percentage uncovered) = 2_500
     #
     # @return [Float]
     def skunk_score
       return cost.round(2) if coverage == PERFECT_COVERAGE
 
-      (cost * (PERFECT_COVERAGE - coverage.to_i)).round(2)
+      (cost * penalty_factor).round(2)
+    end
+
+    # Returns a numeric value that represents the penalty factor based
+    # on the lack of code coverage (not enough test cases for this module)
+    #
+    # @return [Integer]
+    def penalty_factor
+      PERFECT_COVERAGE - coverage.to_i
     end
 
     # Returns the value of churn times cost.
@@ -53,7 +61,6 @@ module RubyCritic
     #   - coverage
     #
     # @return [Hash]
-    # rubocop:disable Style/HashSyntax
     def to_hash
       {
         file: pathname.to_s,
@@ -64,6 +71,5 @@ 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.2"
+  VERSION = "0.5.4"
 end

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.2"]
+  spec.required_ruby_version = [">= 2.4.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.
@@ -39,19 +39,18 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "rubycritic", ">= 4.5.2", "< 5.0"
-  spec.add_dependency "terminal-table", "~> 1.8.0"
+  spec.add_dependency "terminal-table", "~> 3.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 "debug"
+  spec.add_development_dependency "minitest", "< 6"
   spec.add_development_dependency "minitest-around", "~> 0.5.0"
   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 "reek"
+  spec.add_development_dependency "rubocop"
   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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skunk
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.4
 platform: ruby
 authors:
 - Ernesto Tagwerker
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-04-27 00:00:00.000000000 Z
+date: 2025-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubycritic
@@ -36,56 +36,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.0
+        version: '3.0'
 - !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: codecov
+  name: debug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.16
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.1.16
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 5.8.4
+        version: '6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 5.8.4
+        version: '6'
 - !ruby/object:Gem::Dependency
   name: minitest-around
   requirement: !ruby/object:Gem::Requirement
@@ -146,30 +146,30 @@ dependencies:
   name: reek
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 6.0.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -198,20 +198,6 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.5.0
-- !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
@@ -243,10 +229,9 @@ files:
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
 - CHANGELOG.md
-- CODEOWNERS
 - CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - Gemfile
-- Gemfile-Ruby-2-4
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -254,19 +239,22 @@ files:
 - 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/shareable.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/command_factory.rb
+- lib/skunk/commands/base.rb
+- lib/skunk/commands/compare.rb
+- lib/skunk/commands/compare_score.rb
+- lib/skunk/commands/default.rb
+- lib/skunk/commands/help.rb
+- lib/skunk/commands/output.rb
+- lib/skunk/commands/shareable.rb
+- lib/skunk/commands/status_reporter.rb
+- lib/skunk/commands/status_sharer.rb
+- lib/skunk/commands/version.rb
+- lib/skunk/generators/json/simple.rb
+- lib/skunk/generators/json_report.rb
+- lib/skunk/reporter.rb
 - lib/skunk/rubycritic/analysed_module.rb
 - lib/skunk/rubycritic/analysed_modules_collection.rb
 - lib/skunk/version.rb
@@ -292,16 +280,13 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ">="
     - !ruby/object:Gem::Version
       version: 2.4.0
-  - - "<"
-    - !ruby/object:Gem::Version
-      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
+rubygems_version: 3.5.16
 signing_key:
 specification_version: 4
 summary: A library to assess code quality vs. code coverage

data/CODEOWNERS

@@ -1,5 +0,0 @@
-  
-# These code owners will be the default owners to everything in the repository.
-# Unless a posterior rule has precedence, they will be automatically requested
-# for review when a pull request is opened.
-*       @fastruby/black-bunny-brigade

data/Gemfile-Ruby-2-4

@@ -1,10 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
-
-# Specify your gem's dependencies in skunk.gemspec
-gemspec
-
-gem "simplecov", "< 0.19.0"

data/lib/skunk/cli/command_factory.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-require "rubycritic/command_factory"
-
-module Skunk
-  module Cli
-    # Knows how to calculate the command that was request by the CLI user
-    class CommandFactory < RubyCritic::CommandFactory
-      COMMAND_CLASS_MODES = %i[version help default compare].freeze
-
-      # Returns the command class based on the command that was executed
-      #
-      # @param mode
-      # @return [Class]
-      def self.command_class(mode)
-        mode = mode.to_s.split("_").first.to_sym
-        if COMMAND_CLASS_MODES.include? mode
-          require "skunk/cli/commands/#{mode}"
-          Command.const_get(mode.capitalize)
-        else
-          require "skunk/cli/commands/default"
-          Command::Default
-        end
-      end
-    end
-  end
-end

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

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-require "rubycritic/commands/base"
-require "skunk/cli/commands/status_reporter"
-
-module Skunk
-  module Cli
-    module Command
-      # Base class for `Skunk` commands. It knows how to build a command with
-      # options. It always uses a [Skunk::Command::StatusReporter] as its
-      # reporter object.
-      class Base < RubyCritic::Command::Base
-        def initialize(options)
-          @options = options
-          @status_reporter = Skunk::Command::StatusReporter.new(@options)
-        end
-
-        def share(_); end
-      end
-    end
-  end
-end

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

@@ -1,66 +0,0 @@
-# frozen_string_literal: true
-
-require "rubycritic/commands/compare"
-require "skunk/rubycritic/analysed_modules_collection"
-require "skunk/cli/commands/output"
-require "skunk/cli/commands/shareable"
-require "skunk/cli/commands/compare_score"
-
-# nodoc #
-module Skunk
-  module Cli
-    module Command
-      # Knows how to compare two branches and their skunk score average
-      class Compare < RubyCritic::Command::Compare
-        include Skunk::Cli::Command::Shareable
-
-        def initialize(options)
-          super
-          @options = options
-          @status_reporter = Skunk::Command::StatusReporter.new(options)
-        end
-
-        def execute
-          compare_branches
-          status_reporter
-        end
-
-        # switch branch and analyse files but don't generate a report
-        def analyse_branch(branch)
-          ::RubyCritic::SourceControlSystem::Git.switch_branch(::RubyCritic::Config.send(branch))
-          critic = critique(branch)
-          ::RubyCritic::Config.send(:"#{branch}_score=", critic.skunk_score_average)
-          ::RubyCritic::Config.root = branch_directory(branch)
-        end
-
-        # generate report only for modified files but don't report it
-        def analyse_modified_files
-          modified_files = ::RubyCritic::Config
-                           .feature_branch_collection
-                           .where(::RubyCritic::SourceControlSystem::Git.modified_files)
-          ::RubyCritic::AnalysedModulesCollection.new(modified_files.map(&:path),
-                                                      modified_files)
-          ::RubyCritic::Config.root = "#{::RubyCritic::Config.root}/compare"
-        end
-
-        # create a txt file with the branch score details
-        def build_details
-          details = CompareScore.new(
-            ::RubyCritic::Config.base_branch,
-            ::RubyCritic::Config.feature_branch,
-            ::RubyCritic::Config.base_branch_score.to_f.round(2),
-            ::RubyCritic::Config.feature_branch_score.to_f.round(2)
-          ).message
-
-          Skunk::Command::Output.create_directory(::RubyCritic::Config.compare_root_directory)
-          File.open(build_details_path, "w") { |file| file.write(details) }
-          puts details
-        end
-
-        def build_details_path
-          "#{::RubyCritic::Config.compare_root_directory}/build_details.txt"
-        end
-      end
-    end
-  end
-end

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

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-# nodoc #
-module Skunk
-  module Cli
-    module Command
-      # Knows how to describe score evolution between two branches
-      class CompareScore
-        def initialize(base_branch, feature_branch, base_branch_score, feature_branch_score)
-          @base_branch = base_branch
-          @feature_branch = feature_branch
-          @base_branch_score = base_branch_score
-          @feature_branch_score = feature_branch_score
-        end
-
-        def message
-          "Base branch (#{@base_branch}) "\
-            "average skunk score: #{@base_branch_score} \n"\
-            "Feature branch (#{@feature_branch}) "\
-            "average skunk score: #{@feature_branch_score} \n"\
-            "#{score_evolution_message}"
-        end
-
-        def score_evolution_message
-          "Skunk score average is #{score_evolution} #{score_evolution_appreciation} \n"
-        end
-
-        def score_evolution_appreciation
-          @feature_branch_score > @base_branch_score ? "worse" : "better"
-        end
-
-        def score_evolution
-          return "Infinitely" if @base_branch_score.zero?
-
-          precentage = (100 * (@base_branch_score - @feature_branch_score) / @base_branch_score)
-          "#{precentage.round(0).abs}%"
-        end
-      end
-    end
-  end
-end