rubycritic 3.5.2 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0537a727706d7903c2a5de836b5536a686efa8ffcdd25c883e99405ca9610bd0
-  data.tar.gz: 9d4a3d3c1d3fe703556a7e2b8a98353845c8fb85260244b8a5ea8152d4173857
+  metadata.gz: db2b8e076626a6a29d140f9f6552b6f5829e0f8d258b9cc47afa4fc1f21acbcc
+  data.tar.gz: 6ef348632806a7a388aebadb6d53eec20870f0efc93459433debeda020126f00
 SHA512:
-  metadata.gz: 6580fd04f39137829c4f4b022a246c12625aca43c2d88ddd3de5dd2729bd7ddbbbfbccc4cbd0e6cf9e71045a318ce623af547f6d869bf92c67b3e1efa7b64e2c
-  data.tar.gz: 3c8d5bd2a02452c2addc0460fb203f255ab2095230588c890af64610b75fc8badea7c791081c47c98ba53537d80554f448861fbfb4ddccb11d93fa4efabc9824
+  metadata.gz: b081e071ffad334bb27a1e469f5debe08bd2b3cc563cf1c5196c745539c237eb640297df2936461913a1b1fc4a714a8365786191bbe016725c94a96f80b7dd74
+  data.tar.gz: a937c6a4142b87a414b513492517d4defccdf06d182b1a846fea149142d6bf10d06c42dcf62fad5edd8746d7eb7236d427d12109f0e3b13573577dc6902848c7

data/CHANGELOG.md

@@ -1,4 +1,14 @@
-# master [(unreleased)](https://github.com/whitesmith/rubycritic/compare/v3.5.2...master)
+# master [(unreleased)](https://github.com/whitesmith/rubycritic/compare/v4.0.0...master)
+
+# 4.0.0 / 2019-02-27 [(commits)](https://github.com/whitesmith/rubycritic/compare/v3.5.1...v4.0.0)
+
+* [FEATURE] Allow generating reports in multiple formats in one run (by [@katafrakt])
+* [FEATURE] Allow to accept a config file (by [@mfbmina])
+* [CHANGE] Update `reek` to 5.3 (by [@taitran19][] and [@onumis][])
+* [CHANGE] Update `parser` to 2.6.0 (by [@onumis][])
+* [CHANGE] Update `tty-which` to 0.4.0 (by [@onumis][])
+* [CHANGE] Drop support for ruby 2.1 and 2.2 (by [@onumis][])
+* [CHANGE] Fix rubocop offenses (by [@AllanSiqueira][] and [@harman28][])
 
 # 3.5.2 / 2018-09-27 [(commits)](https://github.com/whitesmith/rubycritic/compare/v3.5.1...v3.5.2)
 
@@ -253,3 +263,7 @@
 [@HemanthMudalaiah]: https://github.com/HemanthMudalaiah
 [@SuperSandro2000]: https://github.com/SuperSandro2000
 [@antoineLeclercq]: https://github.com/antoineLeclercq
+[@mfbmina]: https://github.com/mfbmina
+[@taitran19]: https://github.com/taitran19
+[@AllanSiqueira]: https://github.com/AllanSiqueira
+[@harman28]: https://github.com/harman28

data/README.md

@@ -125,6 +125,25 @@ $ rubycritic --help
 | `--suppress-ratings`        | Suppress letter ratings                                                                        |
 | `--no-browser`              | Do not open html report with browser                                                           |
 
+You also can use a config file. Just create a `.rubycritic.yml` on your project root path.
+
+Here are one example:
+```
+mode_ci:
+  enabled: true # default is false
+  branch: 'production' # default is master
+branch: 'production' # default is master
+path: '/tmp/mycustompath' # Set path where report will be saved (tmp/rubycritic by default)
+threshhold_score: 10 # default is 0
+deduplicate_symlinks: true # default is false
+suppress_ratings: true # default is false
+no_browser: true # default is false
+format: console # Available values are: html, json, console, lint. Default value is html.
+minimum_score: 95 # default is 0
+paths: # Files to analyse.
+  - 'app/controllers/'
+  - 'app/models/'
+```
 
 ### Analyzer Configuration
 

data/lib/rubycritic/analysers/helpers/ast_node.rb

@@ -16,24 +16,21 @@ module Parser
       def recursive_children
         children.each do |child|
           next unless child.is_a?(Parser::AST::Node)
+
           yield child
           child.recursive_children { |grand_child| yield grand_child }
         end
       end
 
-      def get_module_names
-        children_modules = children
-                           .select { |child| child.is_a?(Parser::AST::Node) }
-                           .flat_map(&:get_module_names)
+      def module_names
+        ast_node_children = children.select do |child|
+          child.is_a?(Parser::AST::Node)
+        end
+
+        children_modules = ast_node_children.flat_map(&:module_names)
 
         if MODULE_TYPES.include?(type)
-          if children_modules.empty?
-            [module_name]
-          else
-            children_modules.map do |children_module|
-              "#{module_name}::#{children_module}"
-            end
-          end
+          module_names_with_children children_modules
         else
           children_modules
         end
@@ -41,6 +38,16 @@ module Parser
 
       private
 
+      def module_names_with_children(children_modules)
+        if children_modules.empty?
+          [module_name]
+        else
+          children_modules.map do |children_module|
+            "#{module_name}::#{children_module}"
+          end
+        end
+      end
+
       def module_name
         name_segments = []
         current_node = children[0]
@@ -61,7 +68,7 @@ module RubyCritic
         0
       end
 
-      def get_module_names
+      def module_names
         []
       end
     end

data/lib/rubycritic/analysers/helpers/modules_locator.rb

@@ -13,7 +13,7 @@ module RubyCritic
     end
 
     def names
-      names = node.get_module_names
+      names = node.module_names
       if names.empty?
         name_from_path
       else

data/lib/rubycritic/analysers/helpers/reek.rb

@@ -5,7 +5,7 @@ require 'reek'
 module RubyCritic
   class Reek < ::Reek::Examiner
     def initialize(analysed_module)
-      super(analysed_module, configuration: ::Reek::Configuration::AppConfiguration.from_path)
+      super(analysed_module, configuration: ::Reek::Configuration::AppConfiguration.from_default_path)
     end
   end
 end

data/lib/rubycritic/analysers/smells/flay.rb

@@ -15,14 +15,7 @@ module RubyCritic
 
       def run
         @flay.hashes.each do |structural_hash, nodes|
-          smell = create_smell(structural_hash, nodes)
-          nodes.map(&:file).uniq.each do |file|
-            @analysed_modules[file].smells << smell
-          end
-
-          nodes.each do |node|
-            @analysed_modules[node.file].duplication += node.mass
-          end
+          analyze_modules(structural_hash, nodes)
           print green '.'
         end
         puts ''
@@ -72,6 +65,15 @@ module RubyCritic
       def cost(mass)
         mass / 25
       end
+
+      def analyze_modules(structural_hash, nodes)
+        nodes.map(&:file).uniq.each do |file|
+          @analysed_modules[file].smells << create_smell(structural_hash, nodes)
+        end
+        nodes.each do |node|
+          @analysed_modules[node.file].duplication += node.mass
+        end
+      end
     end
   end
 end

data/lib/rubycritic/cli/application.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'rubycritic'
+require 'rubycritic/browser'
 require 'rubycritic/cli/options'
 require 'rubycritic/command_factory'
 
@@ -15,9 +16,9 @@ module RubyCritic
       end
 
       def execute
-        parsed_options = @options.parse
+        parsed_options = @options.parse.to_h
 
-        reporter = RubyCritic::CommandFactory.create(parsed_options.to_h).execute
+        reporter = RubyCritic::CommandFactory.create(parsed_options).execute
         print(reporter.status_message)
         reporter.status
       rescue OptionParser::InvalidOption => error

data/lib/rubycritic/cli/options.rb

@@ -1,115 +1,27 @@
 # frozen_string_literal: true
 
-require 'optparse'
-require 'rubycritic/browser'
+require 'rubycritic/cli/options/argv'
+require 'rubycritic/cli/options/file'
 
 module RubyCritic
   module Cli
     class Options
+      attr_reader :argv_options, :file_options
+
       def initialize(argv)
-        @argv = argv
-        self.parser = OptionParser.new
+        @argv_options = Argv.new(argv)
+        @file_options = File.new
       end
 
-      # rubocop:disable Metrics/MethodLength
       def parse
-        parser.new do |opts|
-          opts.banner = 'Usage: rubycritic [options] [paths]'
-
-          opts.on('-p', '--path [PATH]', 'Set path where report will be saved (tmp/rubycritic by default)') do |path|
-            @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],
-            'Report smells in the given format:',
-            '  html (default; will open in a browser)',
-            '  json',
-            '  console',
-            '  lint'
-          ) do |format|
-            self.format = format
-          end
-
-          opts.on('-s', '--minimum-score [MIN_SCORE]', 'Set a minimum score') do |min_score|
-            self.minimum_score = Float(min_score)
-          end
-
-          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
-
-          opts.on('--deduplicate-symlinks', 'De-duplicate symlinks based on their final target') do
-            self.deduplicate_symlinks = true
-          end
+        argv_options.parse
+        file_options.parse
 
-          opts.on('--suppress-ratings', 'Suppress letter ratings') do
-            self.suppress_ratings = true
-          end
-
-          opts.on('--no-browser', 'Do not open html report with browser') do
-            self.no_browser = true
-          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)
         self
       end
 
       def to_h
-        {
-          mode: mode,
-          root: root,
-          format: format,
-          deduplicate_symlinks: deduplicate_symlinks,
-          paths: paths,
-          suppress_ratings: suppress_ratings,
-          help_text: parser.help,
-          minimum_score: minimum_score || 0,
-          no_browser: no_browser,
-          base_branch: base_branch,
-          feature_branch: feature_branch,
-          threshold_score: threshold_score || 0
-        }
-      end
-      # rubocop:enable Metrics/MethodLength
-
-      private
-
-      attr_accessor :mode, :root, :format, :deduplicate_symlinks,
-                    :suppress_ratings, :minimum_score, :no_browser,
-                    :parser, :base_branch, :feature_branch, :threshold_score
-      def paths
-        if @argv.empty?
-          ['.']
-        else
-          @argv
-        end
-      end
-
-      def set_current_branch
-        self.feature_branch = SourceControlSystem::Git.current_branch
+        file_options.to_h.merge(argv_options.to_h)
       end
     end
   end

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

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+require 'optparse'
+
+module RubyCritic
+  module Cli
+    class Options
+      class Argv
+        def initialize(argv)
+          @argv = argv
+          self.parser = OptionParser.new
+        end
+
+        # rubocop:disable Metrics/MethodLength
+        def parse
+          parser.new do |opts|
+            opts.banner = 'Usage: rubycritic [options] [paths]'
+
+            opts.on('-p', '--path [PATH]', 'Set path where report will be saved (tmp/rubycritic by default)') do |path|
+              @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
+
+            formats = []
+            self.formats = formats
+            opts.on(
+              '-f', '--format [FORMAT]',
+              %i[html json console lint],
+              'Report smells in the given format:',
+              '  html (default; will open in a browser)',
+              '  json',
+              '  console',
+              '  lint'
+            ) do |format|
+              formats << format
+            end
+
+            opts.on('-s', '--minimum-score [MIN_SCORE]', 'Set a minimum score') do |min_score|
+              self.minimum_score = Float(min_score)
+            end
+
+            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
+
+            opts.on('--deduplicate-symlinks', 'De-duplicate symlinks based on their final target') do
+              self.deduplicate_symlinks = true
+            end
+
+            opts.on('--suppress-ratings', 'Suppress letter ratings') do
+              self.suppress_ratings = true
+            end
+
+            opts.on('--no-browser', 'Do not open html report with browser') do
+              self.no_browser = true
+            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
+          {
+            mode: mode,
+            root: root,
+            formats: formats,
+            deduplicate_symlinks: deduplicate_symlinks,
+            paths: paths,
+            suppress_ratings: suppress_ratings,
+            help_text: parser.help,
+            minimum_score: minimum_score,
+            no_browser: no_browser,
+            base_branch: base_branch,
+            feature_branch: feature_branch,
+            threshold_score: threshold_score
+          }
+        end
+        # rubocop:enable Metrics/MethodLength
+
+        private
+
+        attr_accessor :mode, :root, :formats, :deduplicate_symlinks,
+                      :suppress_ratings, :minimum_score, :no_browser,
+                      :parser, :base_branch, :feature_branch, :threshold_score
+        def paths
+          @argv unless @argv.empty?
+        end
+
+        def set_current_branch
+          self.feature_branch = SourceControlSystem::Git.current_branch
+        end
+      end
+    end
+  end
+end

data/lib/rubycritic/cli/options/file.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+require 'yaml'
+
+module RubyCritic
+  module Cli
+    class Options
+      class File
+        attr_reader :filename, :options
+
+        def initialize(filename = './.rubycritic.yml')
+          @filename = filename
+          @options = {}
+        end
+
+        def parse
+          @options = YAML.load_file(filename) if ::File.file?(filename)
+        end
+
+        # rubocop:disable Metrics/MethodLength
+        def to_h
+          {
+            mode: mode,
+            root: root,
+            formats: formats,
+            deduplicate_symlinks: deduplicate_symlinks,
+            paths: paths,
+            suppress_ratings: suppress_ratings,
+            minimum_score: minimum_score,
+            no_browser: no_browser,
+            base_branch: base_branch,
+            feature_branch: feature_branch,
+            threshold_score: threshold_score
+          }
+        end
+        # rubocop:enable Metrics/MethodLength
+
+        private
+
+        def base_branch
+          return options.dig('mode_ci', 'branch') || 'master' if options.dig('mode_ci', 'enabled').to_s == 'true'
+
+          options['branch']
+        end
+
+        def mode
+          if options.dig('mode_ci', 'enabled').to_s == 'true'
+            :ci
+          elsif base_branch
+            :compare_branches
+          end
+        end
+
+        def feature_branch
+          SourceControlSystem::Git.current_branch if base_branch
+        end
+
+        def root
+          options['path']
+        end
+
+        def threshold_score
+          options['threshold_score']
+        end
+
+        def deduplicate_symlinks
+          value_for(options['deduplicate_symlinks'])
+        end
+
+        def suppress_ratings
+          value_for(options['suppress_ratings'])
+        end
+
+        def no_browser
+          value_for(options['no_browser'])
+        end
+
+        def formats
+          formats = options['formats'] || []
+          formats.select do |format|
+            %w[html json console lint].include?(format)
+          end
+        end
+
+        def minimum_score
+          options['minimum_score']
+        end
+
+        def paths
+          options['paths']
+        end
+
+        def value_for(value)
+          value = value.to_s
+          value == 'true' unless value.empty?
+        end
+      end
+    end
+  end
+end

data/lib/rubycritic/command_factory.rb

@@ -4,25 +4,18 @@ require 'rubycritic/configuration'
 
 module RubyCritic
   class CommandFactory
+    COMMAND_CLASS_MODES = %i[version help ci compare default].freeze
+
     def self.create(options = {})
       Config.set(options)
       command_class(Config.mode).new(options)
     end
 
     def self.command_class(mode)
-      case mode
-      when :version
-        require 'rubycritic/commands/version'
-        Command::Version
-      when :help
-        require 'rubycritic/commands/help'
-        Command::Help
-      when :ci
-        require 'rubycritic/commands/ci'
-        Command::Ci
-      when :compare_branches
-        require 'rubycritic/commands/compare'
-        Command::Compare
+      mode = mode.to_s.split('_').first.to_sym
+      if COMMAND_CLASS_MODES.include? mode
+        require "rubycritic/commands/#{mode}"
+        Command.const_get(mode.capitalize)
       else
         require 'rubycritic/commands/default'
         Command::Default

data/lib/rubycritic/commands/compare.rb

@@ -70,6 +70,7 @@ module RubyCritic
       # 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.')
@@ -98,7 +99,7 @@ module RubyCritic
       def critique(branch)
         module_collection = AnalysersRunner.new(paths).run
         Config.send(:"#{branch}_collection=", module_collection)
-        RevisionComparator.new(paths).set_statuses(module_collection)
+        RevisionComparator.new(paths).statuses = module_collection
       end
     end
   end

data/lib/rubycritic/commands/default.rb

@@ -11,7 +11,7 @@ module RubyCritic
     class Default < Base
       def initialize(options)
         super
-        @paths = options[:paths]
+        @paths = options[:paths] || ['.']
         Config.source_control_system = SourceControlSystem::Base.create
       end
 
@@ -22,7 +22,7 @@ module RubyCritic
 
       def critique
         analysed_modules = AnalysersRunner.new(paths).run
-        RevisionComparator.new(paths).set_statuses(analysed_modules)
+        RevisionComparator.new(paths).statuses = analysed_modules
       end
 
       def report(analysed_modules)

data/lib/rubycritic/commands/status_reporter.rb

@@ -29,7 +29,7 @@ module RubyCritic
       end
 
       def satisfy_minimum_score_rule
-        score >= @options[:minimum_score]
+        score >= @options[:minimum_score].to_f
       end
 
       def update_status_message

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module RubyCritic
   module Command
     module Utils

data/lib/rubycritic/configuration.rb

@@ -5,7 +5,7 @@ require 'rubycritic/source_control_systems/base'
 module RubyCritic
   class Configuration
     attr_reader :root
-    attr_accessor :source_control_system, :mode, :format, :deduplicate_symlinks,
+    attr_accessor :source_control_system, :mode, :formats, :deduplicate_symlinks,
                   :suppress_ratings, :open_with, :no_browser, :base_branch,
                   :feature_branch, :base_branch_score, :feature_branch_score,
                   :base_root_directory, :feature_root_directory,
@@ -15,14 +15,14 @@ module RubyCritic
     def set(options)
       self.mode = options[:mode] || :default
       self.root = options[:root] || 'tmp/rubycritic'
-      self.format = options[:format] || :html
-      self.deduplicate_symlinks = options[:deduplicate_symlinks] || false
-      self.suppress_ratings = options[:suppress_ratings] || false
+      self.formats = options[:formats] || [:html]
+      self.deduplicate_symlinks = options[:deduplicate_symlinks]
+      self.suppress_ratings = options[:suppress_ratings]
       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]
+      self.threshold_score = options[:threshold_score].to_i
     end
 
     def root=(path)
@@ -45,13 +45,11 @@ module RubyCritic
     end
 
     def self.compare_branches_mode?
-      mode = Config.mode
-      mode == :compare_branches || mode == :ci
+      %i[compare_branches ci].include?(Config.mode)
     end
 
     def self.build_mode?
-      mode = Config.mode
-      (mode == :compare_branches || mode == :ci) && !Config.no_browser
+      !Config.no_browser && %i[compare_branches ci].include?(Config.mode)
     end
 
     def self.method_missing(method, *args, &block)

data/lib/rubycritic/core/analysed_modules_collection.rb

@@ -68,7 +68,7 @@ module RubyCritic
 
     def average_cost
       num_modules = @modules.size
-      if num_modules > 0
+      if num_modules.positive?
         map { |mod| limited_cost_for(mod) }.reduce(:+) / num_modules.to_f
       else
         0.0
@@ -80,10 +80,16 @@ module RubyCritic
     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)
+      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/base.rb

@@ -45,7 +45,7 @@ module RubyCritic
           @root_directory ||= Pathname.new(Config.root)
         end
 
-        def get_binding
+        def base_binding
           binding
         end
       end

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

@@ -42,8 +42,8 @@ module RubyCritic
             file_code << Line.new(file_directory, line_text, line_smells).render
           end
 
-          file_body = TEMPLATE.result(get_binding { file_code.join })
-          LAYOUT_TEMPLATE.result(get_binding { file_body })
+          file_body = TEMPLATE.result(base_binding { file_code.join })
+          LAYOUT_TEMPLATE.result(base_binding { file_body })
         end
       end
     end

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

@@ -24,8 +24,8 @@ module RubyCritic
         end
 
         def render
-          index_body = TEMPLATE.result(get_binding)
-          LAYOUT_TEMPLATE.result(get_binding { index_body })
+          index_body = TEMPLATE.result(base_binding)
+          LAYOUT_TEMPLATE.result(base_binding { index_body })
         end
       end
     end

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

@@ -29,8 +29,8 @@ module RubyCritic
         end
 
         def render
-          index_body = TEMPLATE.result(get_binding)
-          LAYOUT_TEMPLATE.result(get_binding { index_body })
+          index_body = TEMPLATE.result(base_binding)
+          LAYOUT_TEMPLATE.result(base_binding { index_body })
         end
       end
     end

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

@@ -26,8 +26,8 @@ module RubyCritic
         end
 
         def render
-          index_body = TEMPLATE.result(get_binding)
-          LAYOUT_TEMPLATE.result(get_binding { index_body })
+          index_body = TEMPLATE.result(base_binding)
+          LAYOUT_TEMPLATE.result(base_binding { index_body })
         end
 
         private

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

@@ -4,7 +4,7 @@
     <div class="row">
       <!--Page Title -->
       <div class="Page_Title">
-	<h3>Overview</h3>
+       <h3>Overview</h3>
       </div>
       <!--End Page Title -->
       <div class="Content_Wrapper">

data/lib/rubycritic/reporter.rb

@@ -2,21 +2,18 @@
 
 module RubyCritic
   module Reporter
+    REPORT_GENERATOR_CLASS_FORMATS = %i[json console lint].freeze
+
     def self.generate_report(analysed_modules)
-      report_generator_class.new(analysed_modules).generate_report
+      Config.formats.uniq.each do |format|
+        report_generator_class(format).new(analysed_modules).generate_report
+      end
     end
 
-    def self.report_generator_class
-      case Config.format
-      when :json
-        require 'rubycritic/generators/json_report'
-        Generator::JsonReport
-      when :console
-        require 'rubycritic/generators/console_report'
-        Generator::ConsoleReport
-      when :lint
-        require 'rubycritic/generators/lint_report'
-        Generator::LintReport
+    def self.report_generator_class(config_format)
+      if REPORT_GENERATOR_CLASS_FORMATS.include? config_format
+        require "rubycritic/generators/#{config_format}_report"
+        Generator.const_get("#{config_format.capitalize}Report")
       else
         require 'rubycritic/generators/html_report'
         Generator::HtmlReport

data/lib/rubycritic/revision_comparator.rb

@@ -14,17 +14,16 @@ module RubyCritic
       @paths = paths
     end
 
-    def set_statuses(analysed_modules_now)
-      if Config.source_control_system.revision?
-        analysed_modules_before = load_cached_analysed_modules
-        if analysed_modules_before
-          SmellsStatusSetter.set(
-            analysed_modules_before.flat_map(&:smells),
-            analysed_modules_now.flat_map(&:smells)
-          )
-        end
-      end
-      analysed_modules_now
+    def statuses=(analysed_modules_now)
+      return unless Config.source_control_system.revision?
+
+      analysed_modules_before = load_cached_analysed_modules
+      return unless analysed_modules_before
+
+      SmellsStatusSetter.set(
+        analysed_modules_before.flat_map(&:smells),
+        analysed_modules_now.flat_map(&:smells)
+      )
     end
 
     private

data/lib/rubycritic/source_control_systems/base.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'English'
 require 'shellwords'
 
 module RubyCritic
@@ -21,8 +22,8 @@ module RubyCritic
           supported_system.new
         else
           puts 'RubyCritic can provide more feedback if you use '\
-               "a #{connected_system_names} repository. "\
-               'Churn will not be calculated.'
+                "a #{connected_system_names} repository. "\
+                'Churn will not be calculated.'
           Double.new
         end
       end

data/lib/rubycritic/source_control_systems/git.rb

@@ -21,7 +21,7 @@ module RubyCritic
       end
 
       def self.supported?
-        git('branch 2>&1') && $?.success?
+        git('branch 2>&1') && $CHILD_STATUS.success?
       end
 
       def self.to_s
@@ -37,7 +37,7 @@ module RubyCritic
       end
 
       def revision?
-        head_reference && $?.success?
+        head_reference && $CHILD_STATUS.success?
       end
 
       def head_reference
@@ -63,6 +63,7 @@ module RubyCritic
         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

data/lib/rubycritic/source_control_systems/mercurial.rb

@@ -6,7 +6,7 @@ module RubyCritic
       register_system
 
       def self.supported?
-        `hg verify 2>&1` && $?.success?
+        `hg verify 2>&1` && $CHILD_STATUS.success?
       end
 
       def self.to_s

data/lib/rubycritic/source_control_systems/perforce.rb

@@ -35,6 +35,7 @@ module RubyCritic
         root_size = root.size
         target_size = target.size
         return false if target_size < root_size
+
         target[0...root_size] == root &&
           (target_size == root_size || [File::ALT_SEPARATOR, File::SEPARATOR].include?(target[root_size]))
       end

data/lib/rubycritic/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubycritic
 version: !ruby/object:Gem::Version
-  version: 3.5.2
+  version: 4.0.0
 platform: ruby
 authors:
 - Guilherme Simoes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-27 00:00:00.000000000 Z
+date: 2019-02-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: flay
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.5.0
+        version: 2.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.5.0
+        version: 2.6.0
 - !ruby/object:Gem::Dependency
   name: rainbow
   requirement: !ruby/object:Gem::Requirement
@@ -86,14 +86,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.4'
+        version: 5.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '4.4'
+        version: 5.3.0
 - !ruby/object:Gem::Dependency
   name: ruby_parser
   requirement: !ruby/object:Gem::Requirement
@@ -114,14 +114,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.4.0
 - !ruby/object:Gem::Dependency
   name: virtus
   requirement: !ruby/object:Gem::Requirement
@@ -140,82 +140,82 @@ dependencies:
   name: aruba
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.12'
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.12.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.12'
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.12.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 2.0.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.0
+        version: 2.0.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '9.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '10.0'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '9.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '10.0'
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.2.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.0'
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.2.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: diff-lcs
   requirement: !ruby/object:Gem::Requirement
@@ -234,110 +234,116 @@ dependencies:
   name: fakefs
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.10'
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.10.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.10'
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.10.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.3'
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.3.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.3'
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.3.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.3'
 - !ruby/object:Gem::Dependency
   name: minitest-around
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.4.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.4.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.0
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.1.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.1.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.0'
     - - ">="
       - !ruby/object:Gem::Version
         version: 11.0.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '12.0'
     - - ">="
       - !ruby/object:Gem::Version
         version: 11.0.0
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.53.0
+        version: 0.65.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.53.0
+        version: 0.65.0
 description: RubyCritic is a tool that wraps around various static analysis gems to
   provide a quality report of your Ruby code.
 email:
@@ -374,6 +380,8 @@ files:
 - lib/rubycritic/browser.rb
 - lib/rubycritic/cli/application.rb
 - lib/rubycritic/cli/options.rb
+- lib/rubycritic/cli/options/argv.rb
+- lib/rubycritic/cli/options/file.rb
 - lib/rubycritic/colorize.rb
 - lib/rubycritic/command_factory.rb
 - lib/rubycritic/commands/base.rb
@@ -467,15 +475,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.1.0
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: RubyCritic is a Ruby code quality reporter