skunk 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5df324d3763ea965d25b6eb21bb3b97969d5bb51ea89e64c198d05c81c9afd09
-  data.tar.gz: 98e25d9fc2d2224a286a103bd74f98c97709a6004d785638b43ed08a68302da6
+  metadata.gz: a8741b921c9257b475b2bae0741cc039e8afef0556312667e57ba7986f10f7fa
+  data.tar.gz: 79cc09d05f4a7ac2de50461e3ec1c9351ab68803fd33c7d9166b0d1046051891
 SHA512:
-  metadata.gz: 7ba5745cb720777d96ece4a927132cfea50eac70eee257a6f24bca3da94e91643a2ee5aaef5bd5bc7b50da00b2da20b024c2789ae26f5ef6297af1cb8d1bd352
-  data.tar.gz: ae78c2425cc2d0ffa2b43ed0774fe3a4ae408d42784e7d1fcb7bc7ae76341cded3266f82c55bb6d814eabc0318378278c2a51b469cd8e097757516650588f0bb
+  metadata.gz: 29cd83b1f165c6e52c0196495428c80f388fd7ca7b633fe01455665632337a8a07b4bcfa26c8d29c34a23101d69ccadf858cb1615aa66812aac603850899c6df
+  data.tar.gz: 6b22ce77d18d98dc8f53275dfde28453a5b877a9b6e30b30fe6393321daad3ae655f13502924ba42991efe4876765e0e0317dc1e1fa3c2e4b1a769ea10f01304

data/.reek.yml

@@ -9,14 +9,10 @@ detectors:
     - Skunk::Command::StatusReporter#table
   InstanceVariableAssumption:
     exclude:
-    - Skunk::Cli::Command::Default
     - Skunk::Cli::Options::Argv
     - RubyCritic::AnalysedModulesCollection
   IrresponsibleModule:
     exclude:
-    - Skunk::Cli::Command::Help
-    - Skunk::Cli::Options::Argv
-    - Skunk::Cli::Options
     - RubyCritic::AnalysedModulesCollection
   NestedIterators:
     exclude:
@@ -28,6 +24,5 @@ detectors:
     - Skunk::Cli::Options::Argv#parse
   UtilityFunction:
     exclude:
-    - capture_output_streams
-    - Skunk::Command::Compare#analyse_modified_files
-    - Skunk::Command::Compare#build_details_path
+    - Skunk::Cli::Command::Compare#analyse_modified_files
+    - Skunk::Cli::Command::Compare#build_details_path

data/.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2020-11-18 21:57:13 UTC using RuboCop version 1.3.1.
+# on 2021-02-12 01:27:25 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
@@ -40,24 +40,25 @@ Lint/MissingSuper:
     - 'lib/skunk/cli/commands/base.rb'
 
 # Offense count: 1
-# Configuration parameters: IgnoredMethods.
+# Configuration parameters: IgnoredMethods, CountRepeatedAttributes.
 Metrics/AbcSize:
   Max: 18
 
-# Offense count: 5
-# Configuration parameters: CountComments, CountAsOne, ExcludedMethods.
-# ExcludedMethods: refine
+# Offense count: 7
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
+# IgnoredMethods: refine
 Metrics/BlockLength:
-  Max: 64
+  Max: 72
 
 # Offense count: 2
-# Configuration parameters: CountComments, CountAsOne, ExcludedMethods.
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
 Metrics/MethodLength:
   Max: 13
 
 # Offense count: 1
 # Configuration parameters: EnforcedStyle, CheckMethodNames, CheckSymbols, AllowedIdentifiers.
 # SupportedStyles: snake_case, normalcase, non_integer
+# AllowedIdentifiers: capture3, iso8601, rfc1123_date, rfc822, rfc2822, rfc3339
 Naming/VariableNumber:
   Exclude:
     - 'lib/skunk/cli/commands/status_sharer.rb'

data/CHANGELOG.md

@@ -5,7 +5,12 @@ 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.0...HEAD)
+## [Unreleased] [(commits)](https://github.com/fastruby/skunk/compare/v0.5.1...HEAD)
+
+## [0.5.1] [(commits)](https://github.com/fastruby/skunk/compare/v0.5.0...v0.5.1)
+
+* [BUGFIX] Fix bug related to compare plus share code (by [@etagwerker]())
+
 ## [0.5.0] [(commits)](https://github.com/fastruby/skunk/compare/v0.4.2...v0.5.0)
 
 * [FEATURE] Share your results using an environment variable (by [@rahulpuroht]() and [@etagwerker]())

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

@@ -3,47 +3,63 @@
 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 Command
-    # Knows how to compare two branches and their skunk score average
-    class Compare < RubyCritic::Command::Compare
-      # 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
+  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
 
-      # 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
+        def initialize(options)
+          super
+          @options = options
+          @status_reporter = Skunk::Command::StatusReporter.new(options)
+        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 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"
+        def build_details_path
+          "#{::RubyCritic::Config.compare_root_directory}/build_details.txt"
+        end
       end
     end
   end

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

@@ -2,37 +2,39 @@
 
 # nodoc #
 module Skunk
-  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
+  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 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_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_appreciation
+          @feature_branch_score > @base_branch_score ? "worse" : "better"
+        end
 
-      def score_evolution
-        return "Infinitely" if @base_branch_score.zero?
+        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}%"
+          precentage = (100 * (@base_branch_score - @feature_branch_score) / @base_branch_score)
+          "#{precentage.round(0).abs}%"
+        end
       end
     end
   end

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

@@ -6,6 +6,7 @@ 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
@@ -14,6 +15,8 @@ module Skunk
       # 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
@@ -40,17 +43,6 @@ module Skunk
           status_reporter.analysed_modules = analysed_modules
           status_reporter.score = analysed_modules.score
         end
-
-        # 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

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

@@ -0,0 +1,21 @@
+# 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

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

@@ -15,7 +15,6 @@ module Skunk
       DEFAULT_URL = "https://skunk.fastruby.io"
       def status_reporter=(status_reporter)
         self.analysed_modules = status_reporter.analysed_modules
-        self.score = analysed_modules.score
       end
 
       def share

data/lib/skunk/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skunk
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Ernesto Tagwerker
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-02-09 00:00:00.000000000 Z
+date: 2021-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubycritic
@@ -261,6 +261,7 @@ files:
 - 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
@@ -299,7 +300,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.0.9
 signing_key:
 specification_version: 4
 summary: A library to assess code quality vs. code coverage