rubycritic-simplecov 4.1.0

data/lib/rubycritic/generators/html_report.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+require 'rubycritic/configuration'
+require 'rubycritic/generators/html/overview'
+require 'rubycritic/generators/html/smells_index'
+require 'rubycritic/generators/html/code_index'
+require 'rubycritic/generators/html/simple_cov_index'
+require 'rubycritic/generators/html/code_file'
+
+module RubyCritic
+  module Generator
+    class HtmlReport
+      ASSETS_DIR = File.expand_path('html/assets', __dir__)
+
+      def initialize(analysed_modules)
+        @analysed_modules = analysed_modules
+      end
+
+      def generate_report
+        create_directories_and_files
+        copy_assets_to_report_directory
+        puts "New critique at #{report_location}"
+        browser.open unless Config.no_browser
+      end
+
+      def browser
+        @browser ||= RubyCritic::Browser.new(report_location)
+      end
+
+      private
+
+      def create_directories_and_files
+        Array(generators).each do |generator|
+          FileUtils.mkdir_p(generator.file_directory)
+          File.open(generator.file_pathname, 'w+') do |file|
+            file.write(generator.render)
+          end
+        end
+      end
+
+      def generators
+        [overview_generator, code_index_generator, smells_index_generator, simple_cov_index_generator] + file_generators
+      end
+
+      def overview_generator
+        @overview_generator ||= Html::Overview.new(@analysed_modules)
+      end
+
+      def code_index_generator
+        Html::CodeIndex.new(@analysed_modules)
+      end
+
+      def smells_index_generator
+        Html::SmellsIndex.new(@analysed_modules)
+      end
+
+      def simple_cov_index_generator
+        Html::SimpleCovIndex.new(@analysed_modules)
+      end
+
+      def file_generators
+        @analysed_modules.map do |analysed_module|
+          Html::CodeFile.new(analysed_module)
+        end
+      end
+
+      def copy_assets_to_report_directory
+        FileUtils.cp_r(ASSETS_DIR, Config.root)
+      end
+
+      def report_location
+        overview_generator.file_href
+      end
+    end
+  end
+end

data/lib/rubycritic/generators/json/simple.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'rubycritic/version'
+require 'pathname'
+
+module RubyCritic
+  module Generator
+    module Json
+      class Simple
+        def initialize(analysed_modules)
+          @analysed_modules = analysed_modules
+        end
+
+        FILE_NAME = 'report.json'.freeze
+
+        def render
+          JSON.dump(data)
+        end
+
+        def data
+          {
+            metadata: {
+              rubycritic: {
+                version: RubyCritic::VERSION
+              }
+            },
+            analysed_modules: @analysed_modules,
+            score: @analysed_modules.score
+          }
+        end
+
+        def file_directory
+          @file_directory ||= Pathname.new(Config.root)
+        end
+
+        def file_pathname
+          Pathname.new(file_directory).join FILE_NAME
+        end
+      end
+    end
+  end
+end

data/lib/rubycritic/generators/json_report.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'rubycritic/generators/json/simple'
+
+module RubyCritic
+  module Generator
+    class JsonReport
+      def initialize(analysed_modules)
+        @analysed_modules = analysed_modules
+      end
+
+      def generate_report
+        FileUtils.mkdir_p(generator.file_directory)
+        File.open(generator.file_pathname, 'w+') do |file|
+          file.write(generator.render)
+        end
+      end
+
+      private
+
+      def generator
+        Json::Simple.new(@analysed_modules)
+      end
+    end
+  end
+end

data/lib/rubycritic/generators/lint_report.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'rubycritic/generators/text/lint'
+
+module RubyCritic
+  module Generator
+    class LintReport
+      def initialize(analysed_modules)
+        @analysed_modules = analysed_modules
+      end
+
+      def generate_report
+        FileUtils.mkdir_p(generator.file_directory)
+        File.open(generator.file_pathname, 'w+') do |file|
+          file.write(reports.join("\n"))
+        end
+      end
+
+      def generator
+        Text::Lint
+      end
+
+      def reports
+        @analysed_modules.sort.map do |mod|
+          generator.new(mod).render
+        end
+      end
+    end
+  end
+end

data/lib/rubycritic/generators/text/lint.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'erb'
+module RubyCritic
+  module Generator
+    module Text
+      class Lint
+        class << self
+          TEMPLATE_PATH = File.expand_path('templates/lint.erb', __dir__)
+          FILE_NAME = 'lint.txt'.freeze
+
+          def file_directory
+            @file_directory ||= Pathname.new(Config.root)
+          end
+
+          def file_pathname
+            Pathname.new(file_directory).join FILE_NAME
+          end
+
+          def erb_template
+            @erb_template ||= ERB.new(File.read(TEMPLATE_PATH), nil, '-')
+          end
+        end
+
+        def initialize(analysed_module)
+          @analysed_module = analysed_module
+        end
+
+        def render
+          erb_template.result(binding)
+        end
+
+        private
+
+        def erb_template
+          self.class.erb_template
+        end
+      end
+    end
+  end
+end

data/lib/rubycritic/generators/text/list.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'rainbow'
+
+module RubyCritic
+  module Generator
+    module Text
+      class List
+        class << self
+          TEMPLATE_PATH = File.expand_path('templates/list.erb', __dir__)
+
+          def erb_template
+            @erb_template ||= ERB.new(File.read(TEMPLATE_PATH), nil, '-')
+          end
+        end
+
+        RATING_TO_COLOR = {
+          'A' => :green,
+          'B' => :green,
+          'C' => :yellow,
+          'D' => :orange,
+          'F' => :red
+        }.freeze
+
+        def initialize(analysed_module)
+          @analysed_module = analysed_module
+        end
+
+        def render
+          erb_template.result(binding)
+        end
+
+        private
+
+        def erb_template
+          self.class.erb_template
+        end
+
+        def color
+          @color ||= RATING_TO_COLOR[@analysed_module.rating.to_s]
+        end
+      end
+    end
+  end
+end

data/lib/rubycritic/generators/text/templates/lint.erb

@@ -0,0 +1,3 @@
+<%- @analysed_module.smells.each do |smell| -%>
+<%= smell.locations.first.to_s %>: <%= smell.to_s %>
+<%- end -%>

data/lib/rubycritic/generators/text/templates/list.erb

@@ -0,0 +1,12 @@
+<%= Rainbow(@analysed_module.name.to_s).foreground(color) %>:
+  Rating:       <%= Rainbow(@analysed_module.rating.to_s).foreground(color) %>
+  Churn:        <%= @analysed_module.churn %>
+  Complexity:   <%= @analysed_module.complexity %>
+  Duplication:  <%= @analysed_module.duplication %>
+  Smells:       <%= @analysed_module.smells.count %>
+<%- @analysed_module.smells.each do |smell| -%>
+    * <%= smell %>
+  <%- smell.locations.each do |location| -%>
+      - <%= location %>
+  <%- end -%>
+<%- end -%>

data/lib/rubycritic/rake_task.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require 'rake'
+require 'rake/tasklib'
+require 'English'
+require 'rubycritic/cli/application'
+
+module RubyCritic
+  #
+  # A rake task that runs RubyCritic on a set of source files.
+  #
+  # This will create a task that can be run with:
+  #
+  #   rake rubycritic
+  #
+  # Example:
+  #
+  #   require 'rubycritic/rake_task'
+  #
+  #   RubyCritic::RakeTask.new do |task|
+  #     task.paths = FileList['lib/**/*.rb', 'spec/**/*.rb']
+  #   end
+  #
+  class RakeTask < ::Rake::TaskLib
+    # Name of RubyCritic task. Defaults to :rubycritic.
+    attr_writer :name
+
+    # Glob pattern to match source files. Defaults to FileList['.'].
+    attr_writer :paths
+
+    # Use verbose output. If this is set to true, the task will print
+    # the rubycritic command to stdout. Defaults to false.
+    attr_writer :verbose
+
+    # You can pass all the options here in that are shown by "rubycritic -h" except for
+    # "-p / --path" since that is set separately. Defaults to ''.
+    attr_writer :options
+
+    def initialize(name = :rubycritic)
+      @name    = name
+      @paths   = FileList['.']
+      @options = ''
+      @verbose = false
+
+      yield self if block_given?
+      define_task
+    end
+
+    private
+
+    attr_reader :name, :paths, :verbose, :options
+
+    def define_task
+      desc 'Run RubyCritic'
+      task(name) { run_task }
+    end
+
+    def run_task
+      if verbose
+        puts "\n\n!!! Running `#{name}` rake command\n"
+        puts "!!! Inspecting #{paths} #{options.empty? ? '' : "with options #{options}"}\n\n"
+      end
+      application = RubyCritic::Cli::Application.new(options_as_arguments + paths)
+      application.execute
+    end
+
+    def options_as_arguments
+      options.split(/\s+/)
+    end
+  end
+end

data/lib/rubycritic/reporter.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module RubyCritic
+  module Reporter
+    REPORT_GENERATOR_CLASS_FORMATS = %i[json console lint].freeze
+
+    def self.generate_report(analysed_modules)
+      RubyCritic::Config.formats.uniq.each do |format|
+        report_generator_class(format).new(analysed_modules).generate_report
+      end
+      RubyCritic::Config.formatters.each do |formatter|
+        report_generator_class_from_formatter(formatter).new(analysed_modules).generate_report
+      end
+    end
+
+    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
+      end
+    end
+
+    def self.report_generator_class_from_formatter(formatter)
+      require_path, class_name = formatter.sub(/([^:]):([^:])/, '\1\;\2').split('\;', 2)
+      class_name ||= require_path
+      require require_path unless require_path == class_name
+      class_from_path(class_name)
+    end
+
+    def self.class_from_path(path)
+      path.split('::').inject(Object) { |obj, klass| obj.const_get klass }
+    rescue NameError => error
+      raise "Could not create reporter for class #{path}. Error: #{error}!"
+    end
+  end
+end

data/lib/rubycritic/revision_comparator.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'rubycritic/serializer'
+require 'rubycritic/analysers_runner'
+require 'rubycritic/smells_status_setter'
+require 'rubycritic/version'
+require 'digest/md5'
+
+module RubyCritic
+  class RevisionComparator
+    SNAPSHOTS_DIR_NAME = 'snapshots'.freeze
+
+    def initialize(paths)
+      @paths = paths
+    end
+
+    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
+
+    def load_cached_analysed_modules
+      Serializer.new(revision_file).load if File.file?(revision_file)
+    end
+
+    def revision_file
+      @revision_file ||= File.join(
+        Config.root,
+        SNAPSHOTS_DIR_NAME,
+        VERSION,
+        Digest::MD5.hexdigest(Marshal.dump(@paths)),
+        Config.source_control_system.head_reference
+      )
+    end
+  end
+end

data/lib/rubycritic/serializer.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+
+module RubyCritic
+  class Serializer
+    def initialize(file)
+      @file = file
+    end
+
+    def load
+      Marshal.load(File.binread(@file))
+    end
+
+    def dump(content)
+      create_file_directory
+      File.open(@file, 'w+') do |file|
+        Marshal.dump(content, file)
+      end
+    end
+
+    private
+
+    def create_file_directory
+      FileUtils.mkdir_p(file_directory)
+    end
+
+    def file_directory
+      File.dirname(@file)
+    end
+  end
+end

data/lib/rubycritic/smells_status_setter.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module RubyCritic
+  module SmellsStatusSetter
+    def self.set(smells_before, smells_now)
+      old_smells = smells_now & smells_before
+      set_status(old_smells, :old)
+      new_smells = smells_now - smells_before
+      set_status(new_smells, :new)
+    end
+
+    def self.set_status(smells, status)
+      smells.each { |smell| smell.status = status }
+    end
+
+    private_class_method :set_status
+  end
+end

data/lib/rubycritic/source_control_systems/base.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'English'
+require 'shellwords'
+
+module RubyCritic
+  module SourceControlSystem
+    class Base
+      @@systems = []
+
+      def self.register_system
+        @@systems << self
+      end
+
+      def self.systems
+        @@systems
+      end
+
+      def self.create
+        supported_system = systems.find(&:supported?)
+        if supported_system
+          supported_system.new
+        else
+          puts 'RubyCritic can provide more feedback if you use '\
+                "a #{connected_system_names} repository. "\
+                'Churn will not be calculated.'
+          Double.new
+        end
+      end
+
+      def self.connected_system_names
+        "#{systems[0...-1].join(', ')} or #{systems[-1]}"
+      end
+    end
+  end
+end
+
+require 'rubycritic/source_control_systems/double'
+require 'rubycritic/source_control_systems/git'
+require 'rubycritic/source_control_systems/mercurial'
+require 'rubycritic/source_control_systems/perforce'

data/lib/rubycritic/source_control_systems/double.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module RubyCritic
+  module SourceControlSystem
+    class Double < Base
+      def revisions_count(_path)
+        0
+      end
+
+      def date_of_last_commit(_path)
+        nil
+      end
+
+      def revision?
+        false
+      end
+    end
+  end
+end

data/lib/rubycritic/source_control_systems/git.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+require 'tty/which'
+
+module RubyCritic
+  module SourceControlSystem
+    class Git < Base
+      register_system
+      GIT_EXECUTABLE = TTY::Which.which('git')
+
+      def self.git(arg)
+        if Gem.win_platform?
+          `\"#{GIT_EXECUTABLE}\" #{arg}`
+        else
+          `#{GIT_EXECUTABLE} #{arg}`
+        end
+      end
+
+      def git(arg)
+        self.class.git(arg)
+      end
+
+      def self.supported?
+        git('branch 2>&1') && $CHILD_STATUS.success?
+      end
+
+      def self.to_s
+        'Git'
+      end
+
+      def revisions_count(path)
+        git("log --follow --format=%h #{path.shellescape}").count("\n")
+      end
+
+      def date_of_last_commit(path)
+        git("log -1 --date=iso --format=%ad #{path.shellescape}").chomp!
+      end
+
+      def revision?
+        head_reference && $CHILD_STATUS.success?
+      end
+
+      def head_reference
+        git('rev-parse --verify HEAD').chomp!
+      end
+
+      def travel_to_head
+        stash_successful = stash_changes
+        yield
+      ensure
+        travel_to_original_state if stash_successful
+      end
+
+      def self.switch_branch(branch)
+        uncommitted_changes? ? abort('Uncommitted changes are present.') : `git checkout #{branch}`
+      end
+
+      def self.uncommitted_changes?
+        !`git diff-index HEAD --`.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
+        stashes_count_before = stashes_count
+        git('stash')
+        stashes_count_after = stashes_count
+        stashes_count_after > stashes_count_before
+      end
+
+      def stashes_count
+        git('stash list --format=%h').count("\n")
+      end
+
+      def travel_to_original_state
+        git('stash pop')
+      end
+    end
+  end
+end

data/lib/rubycritic/source_control_systems/mercurial.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module RubyCritic
+  module SourceControlSystem
+    class Mercurial < Base
+      register_system
+
+      def self.supported?
+        `hg verify 2>&1` && $CHILD_STATUS.success?
+      end
+
+      def self.to_s
+        'Mercurial'
+      end
+
+      def revisions_count(path)
+        `hg log #{path.shellescape} --template '1'`.size
+      end
+
+      def date_of_last_commit(path)
+        `hg log #{path.shellescape} --template '{date|isodate}' --limit 1`.chomp
+      end
+
+      def revision?
+        false
+      end
+    end
+  end
+end