rubycritic 3.0.0 → 3.1.0

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

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 require 'json'
-
 module RubyCritic
   module Turbulence
     def self.data(analysed_modules)
@@ -8,7 +7,8 @@ module RubyCritic
         {
           name: analysed_module.name,
           x: analysed_module.churn,
-          y: analysed_module.complexity
+          y: analysed_module.complexity,
+          rating: analysed_module.rating
         }
       end.to_json
     end

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

@@ -17,6 +17,10 @@ module RubyCritic
       relative_path("assets/#{file}")
     end
 
+    def image_path(file)
+      asset_path("images/#{file}")
+    end
+
     def file_path(file)
       relative_path(file)
     end

data/lib/rubycritic/source_control_systems/base.rb

@@ -34,3 +34,4 @@ 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/perforce.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+require 'date'
+
+module RubyCritic
+  module SourceControlSystem
+    PerforceStats = Struct.new(:filename, :revision, :last_commit, :opened?)
+
+    class Perforce < Base
+      register_system
+
+      def self.supported?
+        p4_client = ENV['P4CLIENT'] || ''
+        p4_installed? && !p4_client.empty? && in_client_directory?
+      end
+
+      def self.p4_installed?
+        p4_exe = Gem.win_platform? ? 'p4.exe' : 'p4'
+        ENV['PATH'].split(File::PATH_SEPARATOR).any? do |directory|
+          File.executable?(File.join(directory, p4_exe))
+        end
+      end
+
+      def self.in_client_directory?
+        p4_info = `p4 info`.each_line.select do |line|
+          line.start_with?('Client root', 'Current directory')
+        end
+
+        client_directory, current_directory = p4_info.map! { |info| info.split(': ').last.chomp }
+        child?(client_directory, current_directory)
+      end
+
+      def self.child?(root, target)
+        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
+
+      def self.to_s
+        'Perforce'
+      end
+
+      def revisions_count(path)
+        perforce_files[Perforce.key_file(path)].revision.to_i
+      end
+
+      def date_of_last_commit(path)
+        DateTime.strptime(perforce_files[Perforce.key_file(path)].last_commit, '%s').strftime('%Y-%m-%d %H:%M:%S %z')
+      end
+
+      def revision?
+        !perforce_files.values.count(&:opened?).zero?
+      end
+
+      def self.build_file_cache
+        # Chun is very slow if files stats are requested one by one
+        # this fill a hash with the result of all ruby file in the current directory (and sub-directories)
+        {}.tap do |file_cache|
+          line_aggregator = []
+          `p4 fstat -F "clientFile=*.rb" -T clientFile,headRev,headTime,action #{Dir.getwd}...`.each_line do |line|
+            Perforce.compute_line(file_cache, line_aggregator, line)
+          end
+          # handle remaining lines
+          Perforce.insert_file_cache(file_cache, line_aggregator) if line_aggregator.any?
+        end
+      end
+
+      def self.compute_line(file_cache, line_aggregator, line)
+        if line.chomp.empty?
+          Perforce.insert_file_cache(file_cache, line_aggregator)
+        else
+          line_aggregator << line
+        end
+      end
+
+      def self.insert_file_cache(file_cache, lines)
+        perforce_stat = Perforce.compute_cache_lines(lines)
+        file_cache[perforce_stat.filename] = perforce_stat
+        lines.clear
+      end
+
+      def self.compute_cache_lines(lines)
+        perforce_lines = Hash[*lines.map { |line| line.split[1..-1] }.flatten]
+        PerforceStats.new(
+          Perforce.normalized_file_path(perforce_lines['clientFile']),
+          perforce_lines['headRev'],
+          perforce_lines['headTime'],
+          perforce_lines.key?('action')
+        )
+      end
+
+      def self.key_file(source_file_path)
+        Perforce.normalized_file_path(File.join(Dir.getwd, source_file_path))
+      end
+
+      def self.normalized_file_path(file_path)
+        file_path.downcase.tr('\\', '/')
+      end
+
+      private
+
+      def perforce_files
+        @perforce_files ||= Perforce.build_file_cache
+      end
+    end
+  end
+end

data/lib/rubycritic/version.rb

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

data/rubycritic.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'flay', '~> 2.8'
   spec.add_runtime_dependency 'flog', '~> 4.4'
   spec.add_runtime_dependency 'reek', '~> 4.4'
-  spec.add_runtime_dependency 'parser', '2.3.1.2'
+  spec.add_runtime_dependency 'parser', '2.3.1.4'
   spec.add_runtime_dependency 'ruby_parser', '~> 3.8'
   spec.add_runtime_dependency 'rainbow'
   spec.add_runtime_dependency 'launchy', '2.4.3'

data/test/analysers_test_helper.rb

@@ -2,3 +2,10 @@
 require 'test_helper'
 
 class AnalysedModuleDouble < OpenStruct; end
+
+require_relative '../lib/rubycritic/core/analysed_modules_collection'
+class AnalysedModulesCollectionDouble < RubyCritic::AnalysedModulesCollection
+  def initialize(module_doubles)
+    @modules = module_doubles
+  end
+end

data/test/lib/rubycritic/analysis_summary_test.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+require 'test_helper'
+require 'rubycritic/analysis_summary'
+
+module RubyCritic
+  describe AnalysisSummary do
+    before do
+      analysed_modules = AnalysedModulesCollectionDouble.new(
+        [
+          AnalysedModuleDouble.new(rating: 'A', churn: 2, smells: [:a, :b, :c]),
+          AnalysedModuleDouble.new(rating: 'A', churn: 3, smells: [:b]),
+          AnalysedModuleDouble.new(rating: 'A', churn: 4, smells: [:x, :y]),
+          AnalysedModuleDouble.new(rating: 'B', churn: 5, smells: [:a, :z])
+        ]
+      )
+      @summary = RubyCritic::AnalysisSummary.generate(analysed_modules)
+    end
+
+    describe '.root' do
+      it 'computes correct summary' do
+        @summary['A'].to_a.must_equal({ files: 3, churns: 9, smells: 6 }.to_a)
+        @summary['B'].to_a.must_equal({ files: 1, churns: 5, smells: 2 }.to_a)
+        @summary['C'].to_a.must_equal({ files: 0, churns: 0, smells: 0 }.to_a)
+        @summary['D'].to_a.must_equal({ files: 0, churns: 0, smells: 0 }.to_a)
+        @summary['F'].to_a.must_equal({ files: 0, churns: 0, smells: 0 }.to_a)
+      end
+    end
+  end
+end

data/test/lib/rubycritic/generators/console_report_test.rb

@@ -28,15 +28,15 @@ describe RubyCritic::Generator::ConsoleReport do
       assert output_contains?('Rating', @mock_analysed_module.rating)
     end
 
-    it "includes the module's rating in the report" do
+    it "includes the module's churn metric in the report" do
       assert output_contains?('Churn', @mock_analysed_module.churn)
     end
 
-    it "includes the module's rating in the report" do
+    it "includes the module's complexity in the report" do
       assert output_contains?('Complexity', @mock_analysed_module.complexity)
     end
 
-    it "includes the module's rating in the report" do
+    it "includes the module's duplication metric in the report" do
       assert output_contains?('Duplication', @mock_analysed_module.duplication)
     end
 

data/test/lib/rubycritic/source_control_systems/perforce_test.rb

@@ -0,0 +1,162 @@
+# frozen_string_literal: true
+require 'test_helper'
+require 'rubycritic/source_control_systems/base'
+
+describe RubyCritic::SourceControlSystem::Perforce do
+  before do
+    @system = RubyCritic::SourceControlSystem::Perforce.new
+  end
+
+  describe RubyCritic::SourceControlSystem::Perforce do
+    describe '::supported?' do
+      let(:path) do
+        ['/some/path', File::PATH_SEPARATOR, '/perforce/path/p4', File::PATH_SEPARATOR + '/other/useless_path'].join
+      end
+      let(:p4_client) { 'UNIT_TEST_CLIENT' }
+
+      context 'directory is under p4 client' do
+        it 'detects if Perforce is the source control used' do
+          ENV['PATH'] = path
+          ENV['P4CLIENT'] = p4_client
+          Gem.stubs(:win_platform?).returns(false)
+          File.stubs(:executable?).with('/some/path/p4').returns(false)
+          File.stubs(:executable?).with('/perforce/path/p4/p4').returns(true)
+          RubyCritic::SourceControlSystem::Perforce.stubs(:in_client_directory?).returns(true)
+
+          RubyCritic::SourceControlSystem::Perforce.supported?.must_equal true
+        end
+      end
+
+      context 'directory is not under p4 client' do
+        it 'returns false if no p4 executables are found' do
+          ENV['PATH'] = path
+          ENV['P4CLIENT'] = nil
+          Gem.stubs(:win_platform?).returns(false)
+          File.stubs(:executable?).with('/some/path/p4').returns(false)
+          File.stubs(:executable?).with('/perforce/path/p4/p4').returns(false)
+          File.stubs(:executable?).with('/other/useless_path/p4').returns(false)
+
+          RubyCritic::SourceControlSystem::Perforce.supported?.must_equal false
+        end
+
+        it 'returns false if no p4 client is set in environment variables' do
+          ENV['PATH'] = path
+          ENV['P4CLIENT'] = nil
+          Gem.stubs(:win_platform?).returns(false)
+          File.stubs(:executable?).with('/some/path/p4').returns(false)
+          File.stubs(:executable?).with('/perforce/path/p4/p4').returns(true)
+
+          RubyCritic::SourceControlSystem::Perforce.supported?.must_equal false
+        end
+
+        it 'returns false if the current directory is not under p4 client' do
+          ENV['PATH'] = path
+          ENV['P4CLIENT'] = p4_client
+          Gem.stubs(:win_platform?).returns(false)
+          File.stubs(:executable?).with('/some/path/p4').returns(false)
+          File.stubs(:executable?).with('/perforce/path/p4/p4').returns(true)
+          RubyCritic::SourceControlSystem::Perforce.stubs(:in_client_directory?).returns(false)
+
+          RubyCritic::SourceControlSystem::Perforce.supported?.must_equal false
+        end
+      end
+    end
+
+    describe '::in_client_directory?' do
+      context 'current directory is in p4 client' do
+        let(:p4_info) do
+          <<-END
+User name: unit_test_user
+Client name: UNIT_TEST_CLIENT
+Client host: MACHINE_NAME
+Client root: /path/to/client/root
+Current directory: /path/to/client/root/ruby_project/unit_test
+Peer address: 127.0.0.1::3000
+Client address: 127.0.0.1
+Server address: the.server.address.com
+          END
+        end
+
+        it 'calls p4 info and parse the result' do
+          RubyCritic::SourceControlSystem::Perforce.stubs(:`).with('p4 info').returns(p4_info)
+          RubyCritic::SourceControlSystem::Perforce.in_client_directory?.must_equal true
+        end
+      end
+
+      context 'current directory is not in p4 client' do
+        let(:p4_info) do
+          <<-END
+User name: unit_test_user
+Client name: UNIT_TEST_CLIENT
+Client host: MACHINE_NAME
+Client root: /path/to/client/root
+Current directory: /somewhere/else/ruby_project/unit_test
+Peer address: 127.0.0.1::3000
+Client address: 127.0.0.1
+Server address: the.server.address.com
+          END
+        end
+
+        it 'calls p4 info and parse the result' do
+          RubyCritic::SourceControlSystem::Perforce.stubs(:`).with('p4 info').returns(p4_info)
+          RubyCritic::SourceControlSystem::Perforce.in_client_directory?.must_equal false
+        end
+      end
+    end
+
+    describe 'retrieve informations' do
+      let(:p4_stats) do
+        <<-END
+... clientFile /path/to/client/a_ruby_file.rb
+... headTime 1473075551
+... headRev 16
+
+... clientFile /path/to/client/second_ruby_file.rb
+... headTime 1464601668
+... action opened
+... headRev 12
+        END
+      end
+
+      describe 'build_file_cache' do
+        it 'builds the perforce file cache' do
+          RubyCritic::SourceControlSystem::Perforce.stubs(:`).returns(p4_stats)
+          file_cache = @system.send(:perforce_files)
+          file_cache.size.must_equal 2
+
+          first_file = file_cache['/path/to/client/a_ruby_file.rb']
+          first_file.filename.must_equal '/path/to/client/a_ruby_file.rb'
+          first_file.revision.must_equal '16'
+          first_file.last_commit.must_equal '1473075551'
+          first_file.opened?.must_equal false
+
+          second_file = file_cache['/path/to/client/second_ruby_file.rb']
+          second_file.filename.must_equal '/path/to/client/second_ruby_file.rb'
+          second_file.revision.must_equal '12'
+          second_file.last_commit.must_equal '1464601668'
+          second_file.opened?.must_equal true
+        end
+      end
+
+      it 'retrieves the number revisions of the ruby files' do
+        Dir.stubs(:getwd).returns('/path/to/client')
+        RubyCritic::SourceControlSystem::Perforce.stubs(:`).once.returns(p4_stats)
+        @system.revisions_count('a_ruby_file.rb').must_equal 16
+        @system.revisions_count('second_ruby_file.rb').must_equal 12
+      end
+
+      it 'retrieves the date of the last commit of the ruby files' do
+        Dir.stubs(:getwd).returns('/path/to/client')
+        RubyCritic::SourceControlSystem::Perforce.stubs(:`).once.returns(p4_stats)
+        @system.date_of_last_commit('a_ruby_file.rb').must_equal '2016-09-05 11:39:11 +0000'
+        @system.date_of_last_commit('second_ruby_file.rb').must_equal '2016-05-30 09:47:48 +0000'
+      end
+
+      it 'retrieves the information if the ruby file is opened (in the changelist and ready to commit)' do
+        Dir.stubs(:getwd).returns('/path/to/client')
+        RubyCritic::SourceControlSystem::Perforce.stubs(:`).once.returns(p4_stats)
+        @system.revision?.must_equal true
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubycritic
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - Guilherme Simoes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-01 00:00:00.000000000 Z
+date: 2016-11-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.3.1.2
+        version: 2.3.1.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.3.1.2
+        version: 2.3.1.4
 - !ruby/object:Gem::Dependency
   name: ruby_parser
   requirement: !ruby/object:Gem::Requirement
@@ -253,6 +253,7 @@ files:
 - Gemfile
 - LICENSE.txt
 - README.md
+- ROADMAP.md
 - Rakefile
 - bin/rubycritic
 - docs/building-own-code-climate.md
@@ -279,6 +280,7 @@ files:
 - lib/rubycritic/analysers/smells/flog.rb
 - lib/rubycritic/analysers/smells/reek.rb
 - lib/rubycritic/analysers_runner.rb
+- lib/rubycritic/analysis_summary.rb
 - lib/rubycritic/browser.rb
 - lib/rubycritic/cli/application.rb
 - lib/rubycritic/cli/options.rb
@@ -297,15 +299,33 @@ files:
 - lib/rubycritic/core/rating.rb
 - lib/rubycritic/core/smell.rb
 - lib/rubycritic/generators/console_report.rb
+- lib/rubycritic/generators/html/assets/fonts/FontAwesome.otf
+- lib/rubycritic/generators/html/assets/fonts/Roboto-Medium.ttf
+- lib/rubycritic/generators/html/assets/fonts/Roboto-Regular.ttf
+- lib/rubycritic/generators/html/assets/fonts/fontawesome-webfont.eot
+- lib/rubycritic/generators/html/assets/fonts/fontawesome-webfont.svg
+- lib/rubycritic/generators/html/assets/fonts/fontawesome-webfont.ttf
+- lib/rubycritic/generators/html/assets/fonts/fontawesome-webfont.woff
+- lib/rubycritic/generators/html/assets/fonts/fontawesome-webfont.woff2
+- lib/rubycritic/generators/html/assets/fonts/glyphicons-halflings-regular.eot
+- lib/rubycritic/generators/html/assets/fonts/glyphicons-halflings-regular.svg
+- lib/rubycritic/generators/html/assets/fonts/glyphicons-halflings-regular.ttf
+- lib/rubycritic/generators/html/assets/fonts/glyphicons-halflings-regular.woff
+- lib/rubycritic/generators/html/assets/fonts/glyphicons-halflings-regular.woff2
+- lib/rubycritic/generators/html/assets/images/logo.png
 - lib/rubycritic/generators/html/assets/javascripts/application.js
+- lib/rubycritic/generators/html/assets/javascripts/bootstrap.min.js
 - lib/rubycritic/generators/html/assets/javascripts/highcharts.src-4.0.1.js
-- lib/rubycritic/generators/html/assets/javascripts/jquery-2.1.0.js
-- lib/rubycritic/generators/html/assets/javascripts/jquery.floatThead-v1.2.7.js
-- lib/rubycritic/generators/html/assets/javascripts/jquery.scrollTo-1.4.11.js
+- lib/rubycritic/generators/html/assets/javascripts/jquery.min.js
+- lib/rubycritic/generators/html/assets/javascripts/jquery.scrollTo.min.js
 - lib/rubycritic/generators/html/assets/javascripts/jquery.tablesorter.js
-- lib/rubycritic/generators/html/assets/javascripts/jquery.timeago-v1.4.1.js
-- lib/rubycritic/generators/html/assets/javascripts/prettify-4-Mar-2013.js
+- lib/rubycritic/generators/html/assets/javascripts/jquery.tablesorter.min.js
+- lib/rubycritic/generators/html/assets/javascripts/jquery.timeago.js
+- lib/rubycritic/generators/html/assets/javascripts/prettify.js
 - lib/rubycritic/generators/html/assets/stylesheets/application.css
+- lib/rubycritic/generators/html/assets/stylesheets/bootstrap.min.css
+- lib/rubycritic/generators/html/assets/stylesheets/font-awesome.min.css
+- lib/rubycritic/generators/html/assets/stylesheets/prettify.css
 - lib/rubycritic/generators/html/assets/stylesheets/prettify.custom_theme.css
 - lib/rubycritic/generators/html/base.rb
 - lib/rubycritic/generators/html/code_file.rb
@@ -336,6 +356,7 @@ files:
 - lib/rubycritic/source_control_systems/double.rb
 - lib/rubycritic/source_control_systems/git.rb
 - lib/rubycritic/source_control_systems/mercurial.rb
+- lib/rubycritic/source_control_systems/perforce.rb
 - lib/rubycritic/source_locator.rb
 - lib/rubycritic/version.rb
 - rubycritic.gemspec
@@ -347,6 +368,7 @@ files:
 - 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
@@ -367,6 +389,7 @@ files:
 - 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
@@ -419,6 +442,7 @@ test_files:
 - 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
@@ -439,6 +463,7 @@ test_files:
 - 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