skunk 0.3.1 → 0.5.0

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

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+require "net/http"
+require "net/https"
+require "json"
+
+require "skunk/cli/commands/status_reporter"
+
+module Skunk
+  module Command
+    # Knows how to share status to an API
+    class StatusSharer < Skunk::Command::StatusReporter
+      attr_reader :status_message
+
+      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
+        return "" if not_sharing?
+
+        response = post_payload
+
+        @status_message =
+          if Net::HTTPOK === response
+            data = JSON.parse response.body
+            "Shared at: #{File.join(base_url, data['id'])}"
+          else
+            "Error sharing report: #{response}"
+          end
+      end
+
+      private
+
+      # :reek:UtilityFunction
+      def base_url
+        ENV["SHARE_URL"] || DEFAULT_URL
+      end
+
+      def json_summary
+        result = {
+          total_skunk_score: total_skunk_score,
+          analysed_modules_count: analysed_modules_count,
+          skunk_score_average: skunk_score_average,
+          skunk_version: Skunk::VERSION
+        }
+
+        if worst
+          result[:worst_skunk_score] = {
+            file: worst.pathname.to_s,
+            skunk_score: worst.skunk_score
+          }
+        end
+
+        result
+      end
+
+      def json_results
+        sorted_modules.map(&:to_hash)
+      end
+
+      # :reek:UtilityFunction
+      def not_sharing?
+        ENV["SHARE"] != "true" && ENV["SHARE_URL"].to_s == ""
+      end
+
+      def payload
+        JSON.generate(
+          "entries" => json_results,
+          "summary" => json_summary,
+          "options" => {
+            "compare" => "false"
+          }
+        )
+      end
+
+      # :reek:TooManyStatements
+      def post_payload
+        req = Net::HTTP::Post.new(url)
+        req.body = payload
+
+        http = Net::HTTP.new(url.hostname, url.port)
+        if url.scheme == "https"
+          http.use_ssl = true
+          http.ssl_version = :TLSv1_2
+        end
+
+        http.start do |connection|
+          connection.request req
+        end
+      end
+
+      def url
+        URI(File.join(base_url, "reports"))
+      end
+    end
+  end
+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.rb

@@ -1,10 +1,34 @@
 # frozen_string_literal: true
 
-require "rubycritic/cli/options"
+require "skunk/cli/options/argv"
+require "rubycritic/cli/options/file"
 
 module Skunk
   module Cli
-    class Options < RubyCritic::Cli::Options
+    # Knows how to parse options passed to the CLI application
+    class Options
+      attr_reader :argv_options, :file_options
+
+      def initialize(argv)
+        @argv_options = Argv.new(argv)
+        @file_options = RubyCritic::Cli::Options::File.new
+      end
+
+      def parse
+        argv_options.parse
+        file_options.parse
+        self
+      end
+
+      # :reek:NilCheck
+      def to_h
+        file_hash = file_options.to_h
+        argv_hash = argv_options.to_h
+
+        file_hash.merge(argv_hash) do |_, file_option, argv_option|
+          Array(argv_option).empty? ? file_option : argv_option
+        end
+      end
     end
   end
 end

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require "rubycritic/cli/options/argv"
+
+module Skunk
+  module Cli
+    # :nodoc:
+    class Options
+      # Extends RubyCritic::Cli::Options::Argv to parse a subset of the
+      # parameters accepted by RubyCritic
+      class Argv < RubyCritic::Cli::Options::Argv
+        # :reek:Attribute
+        attr_accessor :output_filename
+
+        def parse # rubocop:disable Metrics/MethodLength
+          parser.new do |opts|
+            opts.banner = "Usage: skunk [options] [paths]\n"
+
+            opts.on("-b", "--branch BRANCH", "Set branch to compare") do |branch|
+              self.base_branch = String(branch)
+              set_current_branch
+              self.mode = :compare_branches
+            end
+
+            opts.on("-o", "--out FILE", "Output report to file") do |filename|
+              self.output_filename = filename
+            end
+
+            opts.on_tail("-v", "--version", "Show gem's version") do
+              self.mode = :version
+            end
+
+            opts.on_tail("-h", "--help", "Show this message") do
+              self.mode = :help
+            end
+          end.parse!(@argv)
+        end
+
+        def to_h
+          super.merge(output_filename: output_filename)
+        end
+      end
+    end
+  end
+end

data/lib/skunk/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)
@@ -41,7 +41,27 @@ module RubyCritic
     # @return [Integer]
     def churn_times_cost
       safe_churn = churn.positive? ? churn : 1
-      @churn_times_cost ||= safe_churn * cost
+      @churn_times_cost ||= (safe_churn * cost).round(2)
+    end
+
+    # Returns a hash with these attributes:
+    #   - file
+    #   - skunk_score
+    #   - churn_times_cost
+    #   - churn
+    #   - cost
+    #   - coverage
+    #
+    # @return [Hash]
+    def to_hash
+      {
+        file: pathname.to_s,
+        skunk_score: skunk_score,
+        churn_times_cost: churn_times_cost,
+        churn: churn,
+        cost: cost.round(2),
+        coverage: coverage.round(2)
+      }
     end
   end
 end

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.3.1"
+  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)
@@ -30,22 +32,26 @@ Gem::Specification.new do |spec|
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
   spec.files = Dir.chdir(File.expand_path(__dir__)) do
-    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(bin|test|spec|features)/}) }
   end
   spec.bindir        = "exe"
   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.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.3.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Ernesto Tagwerker
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-11-19 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.2.1
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 4.2.1
+        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,33 +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
-- bin/console
-- bin/setup
 - 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
@@ -209,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
@@ -217,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: []