rubycritic 3.4.0 → 3.5.0

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

@@ -10,6 +10,13 @@ module RubyCritic
 
         def initialize(analysed_modules)
           @analysed_modules = analysed_modules
+          set_header_links if Config.compare_branches_mode?
+        end
+
+        def set_header_links
+          @base_path = code_index_path(Config.base_root_directory, file_name)
+          @feature_path = code_index_path(Config.feature_root_directory, file_name)
+          @build_path = code_index_path(Config.compare_root_directory, file_name)
         end
 
         def file_name

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

@@ -15,6 +15,13 @@ module RubyCritic
           @score = analysed_modules.score
           @max_score = AnalysedModulesCollection::MAX_SCORE
           @summary = analysed_modules.summary
+          set_header_links if Config.compare_branches_mode?
+        end
+
+        def set_header_links
+          @base_path = code_index_path(Config.base_root_directory, file_name)
+          @feature_path = code_index_path(Config.feature_root_directory, file_name)
+          @build_path = code_index_path(Config.compare_root_directory, file_name)
         end
 
         def file_name

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

@@ -12,6 +12,13 @@ module RubyCritic
           @smells = analysed_modules.flat_map(&:smells).uniq
           @analysed_module_names = analysed_module_names(analysed_modules)
           @show_status = (Config.mode == :default)
+          set_header_links if Config.compare_branches_mode?
+        end
+
+        def set_header_links
+          @base_path = code_index_path(Config.base_root_directory, file_name)
+          @feature_path = code_index_path(Config.feature_root_directory, file_name)
+          @build_path = code_index_path(Config.compare_root_directory, file_name)
         end
 
         def file_name

data/lib/rubycritic/generators/html/templates/code_index.html.erb

@@ -23,6 +23,16 @@
             <tr>
               <td>
                 <% unless Config.suppress_ratings %>
+                  <% if Config.build_mode? %>
+                    <% master_analysed_module = Config.base_branch_collection.find(analysed_module.pathname) %>
+                    <% if master_analysed_module.cost > analysed_module.cost %>
+                      <span class="glyphicon glyphicon-arrow-up green-color"></span>
+                    <% elsif master_analysed_module.cost < analysed_module.cost %>
+                      <span class="glyphicon glyphicon-arrow-down red-color"></span>
+                    <% else %>
+                      <span class="empty-span glyphicon"></span>
+                    <% end %>
+                  <% end %>
                   <div class="rating <%= analysed_module.rating.to_s.downcase %>"><%= analysed_module.rating %></div>
                 <% end %>
               </td>

data/lib/rubycritic/generators/html/templates/layouts/application.html.erb

@@ -19,6 +19,13 @@
     <header class="navbar navbar-default navbar-fixed-top">
       <a href="#menu-toggle" class="btn btn-default hidden-lg visible-sm-* hidden-md visible-xs-* pull-left" id="menu-toggle"><i class="fa fa-bars" aria-hidden="true"></i></a>
       <a href="<%= file_path('overview.html') %>"><img src="<%= image_path('logo.png') %>" title="Ruby Critic Logo" width="55"><span class="logo">RUBYCRITIC</span></a>
+      <% if Config.compare_branches_mode? %>
+        <ul class="nav navbar-nav navbar-right">
+          <a href="<%= @base_path %>"><span class="branch"><%= Config.base_branch %></span></a>
+          <a href="<%= @feature_path %>"><span class="branch"><%= Config.feature_branch %></span></a>
+          <a href="<%= @build_path %>"><span class="branch">Build</span></a>
+        </ul>
+      <% end %>
     </header>
     <div id="wrapper">
       <!-- Sidebar -->

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

@@ -27,7 +27,16 @@ module RubyCritic
     end
 
     def smell_location_path(location)
-      file_path("#{location.pathname.sub_ext('.html')}#L#{location.line}")
+      smell_location = "#{location.pathname.sub_ext('.html')}#L#{location.line}"
+      if Config.compare_branches_mode?
+        file_path("#{File.expand_path(Config.feature_root_directory)}/#{smell_location}")
+      else
+        file_path(smell_location)
+      end
+    end
+
+    def code_index_path(root_directory, file_name)
+      file_path("#{File.expand_path(root_directory)}/#{file_name}")
     end
 
     private

data/lib/rubycritic/source_control_systems/git.rb

@@ -9,7 +9,11 @@ module RubyCritic
       GIT_EXECUTABLE = TTY::Which.which('git')
 
       def self.git(arg)
-        `#{GIT_EXECUTABLE} #{arg}`
+        if Gem.win_platform?
+          `\"#{GIT_EXECUTABLE}\" #{arg}`
+        else
+          `#{GIT_EXECUTABLE} #{arg}`
+        end
       end
 
       def git(arg)
@@ -47,6 +51,28 @@ module RubyCritic
         travel_to_original_state if stash_successful
       end
 
+      def self.switch_branch(branch)
+        uncommitted_changes? ? `git checkout #{branch}` : abort('Uncommitted changes are present.')
+      end
+
+      def self.uncommitted_changes?
+        `git ls-files --other --exclude-standard --directory`.empty? && `git status --porcelain`.empty?
+      end
+
+      def self.modified_files
+        modified_files = `git diff --name-status #{Config.base_branch} #{Config.feature_branch}`
+        modified_files.split("\n").map do |line|
+          next if line.start_with?('D')
+          file_name = line.split("\t")[1]
+          file_name
+        end.compact
+      end
+
+      def self.current_branch
+        branch_list = `git branch`
+        branch_list.match(/\*.*$/)[0].gsub('* ', '')
+      end
+
       private
 
       def stash_changes

data/lib/rubycritic/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RubyCritic
-  VERSION = '3.4.0'.freeze
+  VERSION = '3.5.0'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubycritic
 version: !ruby/object:Gem::Version
-  version: 3.4.0
+  version: 3.5.0
 platform: ruby
 authors:
 - Guilherme Simoes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-22 00:00:00.000000000 Z
+date: 2018-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: flay
@@ -330,14 +330,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.53'
+        version: 0.53.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.53'
+        version: 0.53.0
 description: RubyCritic is a tool that wraps around various static analysis gems to
   provide a quality report of your Ruby code.
 email:
@@ -347,12 +347,6 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rubocop.yml"
-- ".rubocop_todo.yml"
-- ".todo.reek"
-- ".travis.yml"
-- ".yardopts"
 - CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
@@ -361,25 +355,6 @@ files:
 - ROADMAP.md
 - Rakefile
 - bin/rubycritic
-- docs/building-own-code-climate.md
-- docs/core-metrics.md
-- docs/jenkins-pr-reviews.md
-- features/command_line_interface/minimum_score.feature
-- features/command_line_interface/options.feature
-- features/rake_task.feature
-- features/step_definitions/rake_task_steps.rb
-- features/step_definitions/rubycritic_steps.rb
-- features/step_definitions/sample_file_steps.rb
-- features/support/env.rb
-- images/churn-vs-complexity.png
-- images/code.png
-- images/logo.png
-- images/overview.png
-- images/rating.png
-- images/reek.png
-- images/smell-details.png
-- images/smells.png
-- images/whitesmith.png
 - lib/rubycritic.rb
 - lib/rubycritic/analysers/attributes.rb
 - lib/rubycritic/analysers/churn.rb
@@ -403,9 +378,11 @@ files:
 - lib/rubycritic/command_factory.rb
 - lib/rubycritic/commands/base.rb
 - lib/rubycritic/commands/ci.rb
+- lib/rubycritic/commands/compare.rb
 - lib/rubycritic/commands/default.rb
 - lib/rubycritic/commands/help.rb
 - lib/rubycritic/commands/status_reporter.rb
+- lib/rubycritic/commands/utils/build_number_file.rb
 - lib/rubycritic/commands/version.rb
 - lib/rubycritic/configuration.rb
 - lib/rubycritic/core/analysed_module.rb
@@ -478,57 +455,6 @@ files:
 - lib/rubycritic/source_control_systems/perforce.rb
 - lib/rubycritic/source_locator.rb
 - lib/rubycritic/version.rb
-- rubycritic.gemspec
-- test/analysers_test_helper.rb
-- test/lib/rubycritic/analysers/churn_test.rb
-- test/lib/rubycritic/analysers/complexity_test.rb
-- test/lib/rubycritic/analysers/helpers/methods_counter_test.rb
-- test/lib/rubycritic/analysers/helpers/modules_locator_test.rb
-- test/lib/rubycritic/analysers/smells/flay_test.rb
-- test/lib/rubycritic/analysers/smells/flog_test.rb
-- test/lib/rubycritic/analysers/smells/reek_test.rb
-- test/lib/rubycritic/analysis_summary_test.rb
-- test/lib/rubycritic/browser_test.rb
-- test/lib/rubycritic/commands/status_reporter_test.rb
-- test/lib/rubycritic/configuration_test.rb
-- test/lib/rubycritic/core/analysed_module_test.rb
-- test/lib/rubycritic/core/analysed_modules_collection_test.rb
-- test/lib/rubycritic/core/location_test.rb
-- test/lib/rubycritic/core/smell_test.rb
-- test/lib/rubycritic/core/smells_array_test.rb
-- test/lib/rubycritic/generators/console_report_test.rb
-- test/lib/rubycritic/generators/json_report_test.rb
-- test/lib/rubycritic/generators/lint_report_test.rb
-- test/lib/rubycritic/generators/turbulence_test.rb
-- test/lib/rubycritic/generators/view_helpers_test.rb
-- test/lib/rubycritic/revision_comparator_test.rb
-- test/lib/rubycritic/smells_status_setter_test.rb
-- test/lib/rubycritic/source_control_systems/base_test.rb
-- test/lib/rubycritic/source_control_systems/double_test.rb
-- test/lib/rubycritic/source_control_systems/git_test.rb
-- test/lib/rubycritic/source_control_systems/interfaces/basic.rb
-- test/lib/rubycritic/source_control_systems/interfaces/time_travel.rb
-- test/lib/rubycritic/source_control_systems/mercurial_test.rb
-- test/lib/rubycritic/source_control_systems/perforce_test.rb
-- test/lib/rubycritic/source_locator_test.rb
-- test/lib/rubycritic/version_test.rb
-- test/samples/empty.rb
-- test/samples/flay/smelly.rb
-- test/samples/flay/smelly2.rb
-- test/samples/flog/complex.rb
-- test/samples/flog/smelly.rb
-- test/samples/location/dir1/file1.rb
-- test/samples/location/file0.rb
-- test/samples/location/file0_symlink.rb
-- test/samples/location/file_with_different_extension.py
-- test/samples/location/file_with_no_extension
-- test/samples/methods_count.rb
-- test/samples/module_names.rb
-- test/samples/no_methods.rb
-- test/samples/reek/not_smelly.rb
-- test/samples/reek/smelly.rb
-- test/samples/unparsable.rb
-- test/test_helper.rb
 homepage: https://github.com/whitesmith/rubycritic
 licenses:
 - MIT
@@ -553,54 +479,4 @@ rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: RubyCritic is a Ruby code quality reporter
-test_files:
-- test/analysers_test_helper.rb
-- test/lib/rubycritic/analysers/churn_test.rb
-- test/lib/rubycritic/analysers/complexity_test.rb
-- test/lib/rubycritic/analysers/helpers/methods_counter_test.rb
-- test/lib/rubycritic/analysers/helpers/modules_locator_test.rb
-- test/lib/rubycritic/analysers/smells/flay_test.rb
-- test/lib/rubycritic/analysers/smells/flog_test.rb
-- test/lib/rubycritic/analysers/smells/reek_test.rb
-- test/lib/rubycritic/analysis_summary_test.rb
-- test/lib/rubycritic/browser_test.rb
-- test/lib/rubycritic/commands/status_reporter_test.rb
-- test/lib/rubycritic/configuration_test.rb
-- test/lib/rubycritic/core/analysed_module_test.rb
-- test/lib/rubycritic/core/analysed_modules_collection_test.rb
-- test/lib/rubycritic/core/location_test.rb
-- test/lib/rubycritic/core/smell_test.rb
-- test/lib/rubycritic/core/smells_array_test.rb
-- test/lib/rubycritic/generators/console_report_test.rb
-- test/lib/rubycritic/generators/json_report_test.rb
-- test/lib/rubycritic/generators/lint_report_test.rb
-- test/lib/rubycritic/generators/turbulence_test.rb
-- test/lib/rubycritic/generators/view_helpers_test.rb
-- test/lib/rubycritic/revision_comparator_test.rb
-- test/lib/rubycritic/smells_status_setter_test.rb
-- test/lib/rubycritic/source_control_systems/base_test.rb
-- test/lib/rubycritic/source_control_systems/double_test.rb
-- test/lib/rubycritic/source_control_systems/git_test.rb
-- test/lib/rubycritic/source_control_systems/interfaces/basic.rb
-- test/lib/rubycritic/source_control_systems/interfaces/time_travel.rb
-- test/lib/rubycritic/source_control_systems/mercurial_test.rb
-- test/lib/rubycritic/source_control_systems/perforce_test.rb
-- test/lib/rubycritic/source_locator_test.rb
-- test/lib/rubycritic/version_test.rb
-- test/samples/empty.rb
-- test/samples/flay/smelly.rb
-- test/samples/flay/smelly2.rb
-- test/samples/flog/complex.rb
-- test/samples/flog/smelly.rb
-- test/samples/location/dir1/file1.rb
-- test/samples/location/file0.rb
-- test/samples/location/file0_symlink.rb
-- test/samples/location/file_with_different_extension.py
-- test/samples/location/file_with_no_extension
-- test/samples/methods_count.rb
-- test/samples/module_names.rb
-- test/samples/no_methods.rb
-- test/samples/reek/not_smelly.rb
-- test/samples/reek/smelly.rb
-- test/samples/unparsable.rb
-- test/test_helper.rb
+test_files: []

data/.gitignore

@@ -1,23 +0,0 @@
-*.gem
-*.rbc
-.bundle
-.config
-.yardoc
-Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
-test/tmp
-test/version_tmp
-test/samples/report.json
-tmp
-.idea/
-.ruby-gemset
-.ruby-version
-.DS_Store
-.byebug_history

data/.rubocop.yml

@@ -1,37 +0,0 @@
-AllCops:
-  DisplayCopNames: true
-  Include:
-    - '**/*.gemspec'
-    - '**/*.rake'
-    - '**/Gemfile'
-    - '**/Rakefile'
-  Exclude:
-    - 'test/samples/**/*'
-    - 'tmp/**/*'
-    - 'vendor/**/*'
-
-Metrics/BlockLength:
-  Enabled: false
-
-Metrics/LineLength:
-  Max: 120
-
-Style/Documentation:
-  Enabled: false
-
-Security/MarshalLoad:
-  Enabled: false
-  Include:
-    - 'lib/rubycritic/serializer.rb'
-
-Style/RedundantFreeze:
-  Enabled: false
-  Include:
-    - 'lib/rubycritic/core/smell.rb'
-    - 'lib/rubycritic/generators/json/simple.rb'
-    - 'lib/rubycritic/revision_comparator.rb'
-    - 'lib/rubycritic/source_control_systems/perforce.rb'
-    - 'lib/rubycritic/source_locator.rb'
-    - 'lib/rubycritic/version.rb'
-
-inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -1,45 +0,0 @@
-# Offense count: 1
-Metrics/AbcSize:
-  Exclude:
-    - 'lib/rubycritic/analysers/smells/flay.rb'
-    - 'lib/rubycritic/cli/options.rb'
-
-# Offense count: 6
-# Configuration parameters: CountComments.
-Metrics/MethodLength:
-  Exclude:
-    - 'lib/rubycritic/analysers/helpers/ast_node.rb'
-    - 'lib/rubycritic/analysers/smells/flay.rb'
-    - 'lib/rubycritic/command_factory.rb'
-    - 'lib/rubycritic/core/analysed_module.rb'
-    - 'lib/rubycritic/reporter.rb'
-    - 'lib/rubycritic/revision_comparator.rb'
-    - 'lib/rubycritic/platforms/base.rb'
-
-# Offense count: 4
-Naming/AccessorMethodName:
-  Exclude:
-    - 'lib/rubycritic/analysers/helpers/ast_node.rb'
-    - 'lib/rubycritic/generators/html/base.rb'
-    - 'lib/rubycritic/revision_comparator.rb'
-
-# Offense count: 1
-Style/ClassVars:
-  Exclude:
-    - 'lib/rubycritic/source_control_systems/base.rb'
-
-# Offense count: 3
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-# SupportedStyles: use_perl_names, use_english_names
-Style/SpecialGlobalVars:
-  Enabled: false
-
-# Offense count: 1
-Style/MethodMissing:
-  Exclude:
-    - 'lib/rubycritic/configuration.rb'
-
-# Offense count: 3
-Layout/IndentHeredoc:
-  Enabled: false