rubycritic 3.4.0 → 3.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 65dd42190e2ce5eb0a6067eaf3a9c158eec42c89
-  data.tar.gz: 8e2633b8d064349f4f412dad2a4993c8def5a6c1
+  metadata.gz: 6299ec37fabeb3fb630a70326b39377eee3aa4c4
+  data.tar.gz: c82518cf3a9c6120e109399fb967ede60a38b7bf
 SHA512:
-  metadata.gz: 6ed0426b235e89803c2930852b3a88f49176d049526c64d36be0e4d3ec1708f049c672d51030bfb43c32e0f6476d41da9dad4c72e8964e5821ac2647dee8f4c5
-  data.tar.gz: 266453f2ae7cadbb4373adddaf33d15bde1bac2d46aeb3b26c71a519d72ccc1e6ddc74e7ec501db1ceb3c6587083e70184642d066d2a44f7ce445c4cee1718d0
+  metadata.gz: e9df974efb0abbf35414284b494b4295a8b927d8c5d7c7a688dcb22666dfb7b2d2b183fa0621f1b50a70fe82f5e9376f7d5c5b3022305ce850fdfbd100b5d730
+  data.tar.gz: e57225932ea86556058a25b9f06fe6068457edd1d127abdbdbda126d040dc62a8964eb4bc6abcda4f4b39ba43aa7626078ba81d8cd6e7ff966e4ec10be72a8cc

data/CHANGELOG.md

@@ -1,6 +1,12 @@
-# master [(unreleased)](https://github.com/whitesmith/rubycritic/compare/v3.4.0...master)
+# master [(unreleased)](https://github.com/whitesmith/rubycritic/compare/v3.5.0...master)
 
-* 
+# 3.5.0 / 2018-09-03 [(commits)](https://github.com/whitesmith/rubycritic/compare/v3.4.0...v3.5.0)
+
+* [CHANGE] Add ability to compare only the modified files between two branches. Refactored option `--mode-ci`, added `--branch` and `--maximum-decrease` (by [@HemanthMudalaiah][])
+* [CHANGE] Optimized all images (by [@SuperSandro2000][])
+* [BUGFIX] Fixed opening report in chrome on windows (by [@SuperSandro2000][])
+* [BUGFIX] Fixed churn on windows (by [@SuperSandro2000][])
+* [BUGFIX] Fixed gem not installing under restricted windows environments (by [@onumis][])
 
 # 3.4.0 / 2018-03-22 [(commits)](https://github.com/whitesmith/rubycritic/compare/v3.3.0...v3.4.0)
 
@@ -236,3 +242,5 @@
 [@nightscape]: https://github.com/nightscape
 [@nbekirov]: https://github.com/nbekirov
 [@joshrpowell]: https://github.com/joshrpowell
+[@HemanthMudalaiah]: https://github.com/HemanthMudalaiah
+[@SuperSandro2000]: https://github.com/SuperSandro2000

data/README.md

@@ -112,16 +112,18 @@ For a full list of the command-line options run:
 $ rubycritic --help
 ```
 
-| Command flag             | Description                                           |
-|--------------------------|-------------------------------------------------------|
-| `-v` / `--version`       | Displays the current version and exits                |
-| `-p` / `--path`          | Set path where report will be saved (tmp/rubycritic by default) |
-| `-f` / `--format`        | Report smells in the given format: `html` (default; will open in a browser), `json`, `console`. |
-| `-s` / `--minimum-score` | Set a minimum score (FLOAT: ex: 96.28)                |
-| `--mode-ci`              | Use CI mode (faster, but only analyses last commit)   |
-| `--deduplicate-symlinks` | De-duplicate symlinks based on their final target     |
-| `--suppress-ratings`     | Suppress letter ratings                               |
-| `--no-browser`           | Do not open html report with browser                  |
+| Command flag                | Description                                                                                    |
+|-----------------------------|------------------------------------------------------------------------------------------------|
+| `-v` / `--version`          | Displays the current version and exits                                                         |
+| `-p` / `--path`             | Set path where report will be saved (tmp/rubycritic by default)                                |
+| `-f` / `--format`           | Report smells in the given format: `html` (default; will open in a browser), `json`, `console` |
+| `-s` / `--minimum-score`    | Set a minimum score (FLOAT: ex: 96.28), default: 0                                             |
+| `-m` / `--mode-ci`          | Use CI mode. Faster, analyses diffs w.r.t base_branch (default: master), see -b                |
+| `-b` / `--branch`           | Set branch to compare                                                                          |
+| `-t` / `--maximum-decrease` | Set a threshold for score difference between two branches (works only with -b), default: 0     |
+| `--deduplicate-symlinks`    | De-duplicate symlinks based on their final target                                              |
+| `--suppress-ratings`        | Suppress letter ratings                                                                        |
+| `--no-browser`              | Do not open html report with browser                                                           |
 
 
 ### Analyzer Configuration

data/lib/rubycritic/cli/options.rb

@@ -20,6 +20,17 @@ module RubyCritic
             @root = path
           end
 
+          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('-t', '--maximum-decrease [MAX_DECREASE]',
+                  'Set a threshold for score difference between two branches (works only with -b)') do |threshold_score|
+            self.threshold_score = Integer(threshold_score)
+          end
+
           opts.on(
             '-f', '--format [FORMAT]',
             %i[html json console lint],
@@ -36,7 +47,10 @@ module RubyCritic
             self.minimum_score = Float(min_score)
           end
 
-          opts.on('-m', '--mode-ci', 'Use CI mode (faster, but only analyses last commit)') do
+          opts.on('-m', '--mode-ci [BASE_BRANCH]',
+                  'Use CI mode (faster, analyses diffs w.r.t base_branch (default: master))') do |branch|
+            self.base_branch = branch || 'master'
+            set_current_branch
             self.mode = :ci
           end
 
@@ -73,7 +87,10 @@ module RubyCritic
           suppress_ratings: suppress_ratings,
           help_text: parser.help,
           minimum_score: minimum_score || 0,
-          no_browser: no_browser
+          no_browser: no_browser,
+          base_branch: base_branch,
+          feature_branch: feature_branch,
+          threshold_score: threshold_score || 0
         }
       end
       # rubocop:enable Metrics/MethodLength
@@ -81,7 +98,8 @@ module RubyCritic
       private
 
       attr_accessor :mode, :root, :format, :deduplicate_symlinks,
-                    :suppress_ratings, :minimum_score, :no_browser, :parser
+                    :suppress_ratings, :minimum_score, :no_browser,
+                    :parser, :base_branch, :feature_branch, :threshold_score
       def paths
         if @argv.empty?
           ['.']
@@ -89,6 +107,10 @@ module RubyCritic
           @argv
         end
       end
+
+      def set_current_branch
+        self.feature_branch = SourceControlSystem::Git.current_branch
+      end
     end
   end
 end

data/lib/rubycritic/command_factory.rb

@@ -20,6 +20,9 @@ module RubyCritic
       when :ci
         require 'rubycritic/commands/ci'
         Command::Ci
+      when :compare_branches
+        require 'rubycritic/commands/compare'
+        Command::Compare
       else
         require 'rubycritic/commands/default'
         Command::Default

data/lib/rubycritic/commands/ci.rb

@@ -4,17 +4,11 @@ require 'rubycritic/source_control_systems/base'
 require 'rubycritic/analysers_runner'
 require 'rubycritic/reporter'
 require 'rubycritic/commands/default'
+require 'rubycritic/commands/compare'
 
 module RubyCritic
   module Command
-    class Ci < Default
-      def critique
-        AnalysersRunner.new(paths).run
-      end
-
-      private
-
-      attr_reader :paths
+    class Ci < Compare
     end
   end
 end

data/lib/rubycritic/commands/compare.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+require 'rubycritic/source_control_systems/base'
+require 'rubycritic/analysers_runner'
+require 'rubycritic/revision_comparator'
+require 'rubycritic/reporter'
+require 'rubycritic/commands/base'
+require 'rubycritic/commands/default'
+require 'rubycritic/commands/utils/build_number_file'
+
+module RubyCritic
+  module Command
+    class Compare < Default
+      def initialize(options)
+        super
+        @build_number = 0
+      end
+
+      def execute
+        compare_branches
+        status_reporter.score = Config.feature_branch_score
+        status_reporter
+      end
+
+      private
+
+      attr_reader :paths, :status_reporter
+
+      def compare_branches
+        @build_number = Utils::BuildNumberFile.new.update_build_number
+        set_root_paths
+        original_no_browser_config = Config.no_browser
+        Config.no_browser = true
+        analyse_branch(:base_branch)
+        analyse_branch(:feature_branch)
+        Config.no_browser = original_no_browser_config
+        analyse_modified_files
+        compare_code_quality
+      end
+
+      def set_root_paths
+        Config.base_root_directory = Pathname.new(branch_directory(:base_branch))
+        Config.feature_root_directory = Pathname.new(branch_directory(:feature_branch))
+        Config.compare_root_directory = Pathname.new("#{Config.root}/compare")
+      end
+
+      # switch branch and analyse files
+      def analyse_branch(branch)
+        SourceControlSystem::Git.switch_branch(Config.send(branch))
+        critic = critique(branch)
+        Config.send(:"#{branch}_score=", critic.score)
+        Config.root = branch_directory(branch)
+        report(critic)
+      end
+
+      # generate report only for modified files
+      def analyse_modified_files
+        modified_files = Config.feature_branch_collection.where(SourceControlSystem::Git.modified_files)
+        analysed_modules = AnalysedModulesCollection.new(modified_files.map(&:path), modified_files)
+        Config.root = "#{Config.root}/compare"
+        report(analysed_modules)
+      end
+
+      def compare_code_quality
+        build_details
+        compare_threshold
+      end
+
+      # mark build as failed if the diff b/w the score of
+      # two branches is greater than threshold value
+      def compare_threshold
+        return unless mark_build_fail?
+        print("Threshold: #{Config.threshold_score}\n")
+        print("Difference: #{(Config.base_branch_score - Config.feature_branch_score).abs}\n")
+        abort('The score difference between the two branches is over the threshold.')
+      end
+
+      def mark_build_fail?
+        Config.threshold_score > 0 && threshold_reached?
+      end
+
+      def threshold_reached?
+        (Config.base_branch_score - Config.feature_branch_score) > Config.threshold_score
+      end
+
+      def branch_directory(branch)
+        "#{Config.root}/compare/#{Config.send(branch)}"
+      end
+
+      # create a txt file with the branch score details
+      def build_details
+        details = "Base branch (#{Config.base_branch}) score: #{Config.base_branch_score} \n"\
+                  "Feature branch (#{Config.feature_branch}) score: #{Config.feature_branch_score} \n"
+        File.open("#{Config.compare_root_directory}/build_details.txt", 'w') { |file| file.write(details) }
+      end
+
+      # store the analysed moduled collection based on the branch
+      def critique(branch)
+        module_collection = AnalysersRunner.new(paths).run
+        Config.send(:"#{branch}_collection=", module_collection)
+        RevisionComparator.new(paths).set_statuses(module_collection)
+      end
+    end
+  end
+end

data/lib/rubycritic/commands/utils/build_number_file.rb

@@ -0,0 +1,35 @@
+module RubyCritic
+  module Command
+    module Utils
+      class BuildNumberFile
+        attr_reader :file, :build_number
+
+        def initialize
+          open_build_number_file
+        end
+
+        # keep track of the number of builds and
+        # use this build number to create separate directory for each build
+        def update_build_number
+          @build_number = file.read.to_i + 1
+          write_build_number
+          build_number
+        end
+
+        def write_build_number
+          file.rewind
+          file.write(build_number)
+          file.close
+        end
+
+        def open_build_number_file
+          root = Config.root
+          FileUtils.mkdir_p(root) unless File.directory?(root)
+          location = "#{root}/build_number.txt"
+          File.new(location, 'a') unless File.exist?(location)
+          @file = File.open(location, 'r+')
+        end
+      end
+    end
+  end
+end

data/lib/rubycritic/configuration.rb

@@ -6,7 +6,11 @@ module RubyCritic
   class Configuration
     attr_reader :root
     attr_accessor :source_control_system, :mode, :format, :deduplicate_symlinks,
-                  :suppress_ratings, :open_with, :no_browser
+                  :suppress_ratings, :open_with, :no_browser, :base_branch,
+                  :feature_branch, :base_branch_score, :feature_branch_score,
+                  :base_root_directory, :feature_root_directory,
+                  :compare_root_directory, :threshold_score, :base_branch_collection,
+                  :feature_branch_collection
 
     def set(options)
       self.mode = options[:mode] || :default
@@ -16,6 +20,9 @@ module RubyCritic
       self.suppress_ratings = options[:suppress_ratings] || false
       self.open_with = options[:open_with]
       self.no_browser = options[:no_browser]
+      self.base_branch = options[:base_branch]
+      self.feature_branch = options[:feature_branch]
+      self.threshold_score = options[:threshold_score]
     end
 
     def root=(path)
@@ -37,6 +44,16 @@ module RubyCritic
       configuration.set(options)
     end
 
+    def self.compare_branches_mode?
+      mode = Config.mode
+      mode == :compare_branches || mode == :ci
+    end
+
+    def self.build_mode?
+      mode = Config.mode
+      (mode == :compare_branches || mode == :ci) && !Config.no_browser
+    end
+
     def self.method_missing(method, *args, &block)
       configuration.public_send(method, *args, &block)
     end

data/lib/rubycritic/core/analysed_modules_collection.rb

@@ -17,9 +17,14 @@ module RubyCritic
     ZERO_SCORE_COST = 16.0
     COST_MULTIPLIER = MAX_SCORE / ZERO_SCORE_COST
 
-    def initialize(paths)
+    def initialize(paths, modules = nil)
       @modules = SourceLocator.new(paths).pathnames.map do |pathname|
-        AnalysedModule.new(pathname: pathname)
+        if modules
+          analysed_module = modules.find { |mod| mod.pathname == pathname }
+          build_analysed_module(analysed_module)
+        else
+          AnalysedModule.new(pathname: pathname)
+        end
       end
     end
 
@@ -27,13 +32,21 @@ module RubyCritic
       @modules.each(&block)
     end
 
+    def where(module_paths)
+      @modules.find_all { |mod| module_paths.include? mod.path }
+    end
+
+    def find(module_path)
+      @modules.find { |mod| mod.pathname == module_path }
+    end
+
     def to_json(*options)
       @modules.to_json(*options)
     end
 
     def score
       if @modules.any?
-        MAX_SCORE - average_limited_cost * COST_MULTIPLIER
+        (MAX_SCORE - average_limited_cost * COST_MULTIPLIER).round(2)
       else
         0.0
       end
@@ -65,5 +78,12 @@ module RubyCritic
     def limited_cost_for(mod)
       [mod.cost, COST_LIMIT].min
     end
+
+    def build_analysed_module(analysed_module)
+      AnalysedModule.new(pathname: analysed_module.pathname, name: analysed_module.name,
+                         smells: analysed_module.smells, churn: analysed_module.churn,
+                         committed_at: analysed_module.committed_at, complexity: analysed_module.complexity,
+                         duplication: analysed_module.duplication, methods_count: analysed_module.methods_count)
+    end
   end
 end

data/lib/rubycritic/generators/html/assets/stylesheets/application.css

@@ -531,6 +531,7 @@ span.metric {
   margin-left: 20px;
 }
 
+
 .filter-table {
   text-align: right;
 }
@@ -548,3 +549,22 @@ span.metric {
   border: 1px solid #ccc;
   border-radius: 4px;
 }
+
+.branch{
+  font-size: 15px;
+  color: #9b111d;
+  font-weight: bold;
+  display: inline-block;
+  padding: 13px;
+}
+
+.green-color {
+  color: #00A900;
+}
+.red-color {
+  color: #ED0000;
+}
+.empty-span{
+  height: 17px;
+  width: 17px;
+}

data/lib/rubycritic/generators/html/base.rb

@@ -18,7 +18,7 @@ module RubyCritic
         include ViewHelpers
 
         def file_href
-          "file://#{file_pathname}"
+          "file:///#{file_pathname}"
         end
 
         def file_pathname

data/lib/rubycritic/generators/html/code_file.rb

@@ -13,6 +13,13 @@ module RubyCritic
         def initialize(analysed_module)
           @analysed_module = analysed_module
           @pathname = @analysed_module.pathname
+          set_header_links if Config.compare_branches_mode?
+        end
+
+        def set_header_links
+          @base_path = code_index_path(Config.base_root_directory, file_location)
+          @feature_path = code_index_path(Config.feature_root_directory, file_location)
+          @build_path = code_index_path(Config.compare_root_directory, file_location)
         end
 
         def file_directory
@@ -23,6 +30,10 @@ module RubyCritic
           @pathname.basename.sub_ext('.html')
         end
 
+        def file_location
+          @pathname.sub_ext('.html')
+        end
+
         def render
           file_code = []
           File.readlines(@pathname).each.with_index(LINE_NUMBER_OFFSET) do |line_text, line_number|