skunk 0.5.1 → 0.5.3

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.

data/lib/skunk/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Skunk
-  VERSION = "0.5.1"
+  VERSION = "0.5.3"
 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"]
 
   # 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."
@@ -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 "debug"
   spec.add_development_dependency "minitest", "~> 5.8.4"
   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.1
+  version: 0.5.3
 platform: ruby
 authors:
 - Ernesto Tagwerker
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-18 00:00:00.000000000 Z
+date: 2023-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubycritic
@@ -36,42 +36,42 @@ 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
@@ -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,11 @@ files:
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
 - CHANGELOG.md
-- CODEOWNERS
 - CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - Gemfile
 - Gemfile-Ruby-2-4
+- Gemfile-Ruby-2-5
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -254,23 +241,24 @@ 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/rubycritic/analysed_module.rb
 - 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 +269,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:
@@ -291,16 +279,13 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ">="
     - !ruby/object:Gem::Version
       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.9
+rubygems_version: 3.4.21
 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/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

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

@@ -1,49 +0,0 @@
-# frozen_string_literal: true
-
-require "rubycritic/commands/default"
-require "rubycritic/analysers_runner"
-require "rubycritic/revision_comparator"
-require "rubycritic/reporter"
-
-require "skunk/cli/commands/base"
-require "skunk/cli/commands/shareable"
-require "skunk/cli/commands/status_reporter"
-
-module Skunk
-  module Cli
-    module Command
-      # Default command runs a critique using RubyCritic and uses
-      # Skunk::Command::StatusReporter to report status
-      class Default < RubyCritic::Command::Default
-        include Skunk::Cli::Command::Shareable
-
-        def initialize(options)
-          super
-          @options = options
-          @status_reporter = Skunk::Command::StatusReporter.new(options)
-        end
-
-        # It generates a report and it returns an instance of
-        # Skunk::Command::StatusReporter
-        #
-        # @return [Skunk::Command::StatusReporter]
-        def execute
-          RubyCritic::Config.formats = []
-
-          report(critique)
-
-          status_reporter
-        end
-
-        # It connects the Skunk::Command::StatusReporter with the collection
-        # of analysed modules.
-        #
-        # @param [RubyCritic::AnalysedModulesCollection] A collection of analysed modules
-        def report(analysed_modules)
-          status_reporter.analysed_modules = analysed_modules
-          status_reporter.score = analysed_modules.score
-        end
-      end
-    end
-  end
-end

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

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-require "skunk/cli/commands/base"
-require "rubycritic/commands/help"
-
-module Skunk
-  module Cli
-    module Command
-      # Knows how to guide user into using `skunk` properly
-      class Help < Skunk::Cli::Command::Base
-        # Outputs a help message
-        def execute
-          puts options[:help_text]
-          status_reporter
-        end
-
-        private
-
-        attr_reader :options, :status_reporter
-      end
-    end
-  end
-end

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

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module Skunk
-  module Cli
-    module Command
-      # This is a module that will be used for sharing reports to a server
-      module Shareable
-        # It shares the report using SHARE_URL or https://skunk.fastruby.io. It
-        # will post all results in JSON format and return a status message.
-        #
-        # @param [Skunk::Command::StatusReporter] A status reporter with analysed modules
-        # :reek:FeatureEnvy
-        def share(reporter)
-          sharer = Skunk::Command::StatusSharer.new(@options)
-          sharer.status_reporter = reporter
-          sharer.share
-        end
-      end
-    end
-  end
-end