code_quality 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2aad6bae79b3c4e3ed57dcbd8441768630056e0e
-  data.tar.gz: f54a234cff30d6713b1d6614380796975b560ce9
+  metadata.gz: '0468a907d1a5093eb7a55189993c91b7db4dc35c'
+  data.tar.gz: d976a2903996a791e5fc83596194f93813ed819f
 SHA512:
-  metadata.gz: c04a6210d08688e077c8c3a40462381040bd91c82f869aa7776b24001e44026e3a5adcd625f00328876df8e1a3b5e8854d30e90f98330a5fa5398c1146fa0c81
-  data.tar.gz: b1d39e7d4ac9350b48bcfedee9e982d9f56334646b9fd4cc7877c3dbe936a9f4d5502bd9693bc6f8d33ec93a03b13fe5659e55e4d39e5c67b9af68b815a74201
+  metadata.gz: e0987639e46edab9cb64d36c1231fa8b0c34f0db415442a1db5b6da4b899d7c71402bef53e102bf19361345756dc954da9c2015ec31b989313a5157935862d23
+  data.tar.gz: 62f47cffc1f28847bb182edf16b150470373337d2e13a2b35c41387d3259dca766426ee16ebc8a4fa117effcd965f071a2c1a4e4468ce5fc17fcc1e0a18f837c

data/code_quality.gemspec

@@ -23,7 +23,10 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "bundler-audit"
   spec.add_dependency "brakeman"
-  spec.add_dependency "rubycritic"
+  spec.add_dependency "rubycritic", "~> 3.3.0"
+  spec.add_dependency "rubocop", "~> 0.52.0"
+  spec.add_dependency "rubocop-github", "~> 0.8.1"
+  spec.add_dependency "code_metric_fu", "~> 4.14.3"
 
   spec.add_development_dependency "bundler", "~> 1.16"
   spec.add_development_dependency "rake", "~> 10.0"

data/config/rubocop-github.yml

@@ -0,0 +1,5 @@
+# https://github.com/github/rubocop-github
+inherit_gem:
+  rubocop-github:
+    - config/default.yml
+    - config/rails.yml

data/config/rubocop-rails.yml

@@ -0,0 +1,3 @@
+# https://github.com/rails/rails/blob/master/.rubocop.yml
+inherit_from:
+  - https://rawgit.com/rails/rails/master/.rubocop.yml

data/lib/code_quality/version.rb

@@ -1,3 +1,3 @@
 module CodeQuality
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/lib/tasks/code_quality.rake

@@ -58,7 +58,7 @@ namespace :code_quality do
   task :quality_audit => [:"quality_audit:default"] do; end
   namespace :quality_audit do
     # default tasks
-    task :default => [:rubycritic] do; end
+    task :default => [:rubycritic, :rubocop, :metric_fu] do; end
 
     # desc "prepare dir"
     task :prepare => :helpers do
@@ -88,6 +88,110 @@ namespace :code_quality do
         end
       end
     end
+
+    desc "rubocop - audit coding style"
+    # e.g.: rake code_quality:quality_audit:rubocop max_offenses=100
+    # options:
+    #   config_formula: use which formula for config, supports "github, "rails" or path_to_your_local_config.yml, default is "github"
+    #   cli_options: pass extract options, e.g.: cli_options="--show-cops"
+    #   max_offenses: if config max_offenses then audit it with detected offenses number in report, e.g.: max_offenses=100
+    task :rubocop => :prepare do
+      run_audit "rubocop - RuboCop is a Ruby static code analyzer. Out of the box it will enforce many of the guidelines outlined in the community Ruby Style Guide." do
+        options = options_from_env(:config_formula, :cli_options, :max_offenses)
+
+        config_formulas = {
+          'github' => 'https://github.com/github/rubocop-github',
+          'rails' => 'https://github.com/rails/rails/blob/master/.rubocop.yml'
+        }
+
+        # prepare cli options
+        config_formula = options.fetch(:config_formula, 'github')
+        if config_formula && File.exists?(config_formula)
+          config_file = config_formula
+          puts "Using config file: #{config_file}"
+        else
+          gem_config_dir = File.expand_path("../../../config", __FILE__)
+          config_file    = "#{gem_config_dir}/rubocop-#{config_formula}.yml"
+          puts "Using config formula: [#{config_formula}](#{config_formulas[config_formula]})"
+        end
+        report_path = "#{report_dir}/rubocop-report.html"
+
+        # generate report
+        report = `rubocop -c #{config_file} -S -R -P #{options[:cli_options]} --format offenses --format html -o #{report_path}`
+        puts report
+        puts "Report generated to #{report_path}"
+        show_in_browser File.realpath(report_path)
+
+        # if config max_offenses then audit it with detected offenses number in report
+        if options[:max_offenses]
+          if report.last(20) =~ /(\d+) *Total/
+            detected_offenses = $1.to_i
+            max_offenses = options[:max_offenses].to_i
+            audit_faild "Detected offenses #{colorize(detected_offenses, :yellow)} is more then #{colorize(max_offenses, :yellow)}, must improve your code quality or set a lower #{colorize("max_offenses", :black, :white)}" if detected_offenses > max_offenses
+          end
+        end
+      end
+    end
+
+    desc "metric_fu - many kinds of metrics"
+    # e.g.: rake code_quality:quality_audit:metric_fu metrics=stats,rails_best_practices,roodi rails_best_practices_max_offenses=9 roodi_max_offenses=10
+    # options:
+    #   metrics: default to run all metrics, can be config as: cane,churn,flay,flog,hotspots,rails_best_practices,rcov,reek,roodi,saikuro,stats
+    #   flay_max_offenses: offenses number for audit
+    #   cane_max_offenses: offenses number for audit
+    #   rails_best_practices_max_offenses: offenses number for audit
+    #   reek_max_offenses: offenses number for audit
+    #   roodi_max_offenses: offenses number for audit
+    task :metric_fu => :prepare do
+      metrics_offenses_patterns = {
+        "flay" => /Total Score (\d+)/,
+        "cane" => /Total Violations (\d+)/,
+        "rails_best_practices" => /Found (\d+) errors/,
+        "reek" => /Found (\d+) code smells/,
+        "roodi" => /Found (\d+) errors/,
+      }
+      metrics_have_offenses = metrics_offenses_patterns.keys.map { |metric| "#{metric}_max_offenses".to_sym }
+      options = options_from_env(:metrics, *metrics_have_offenses)
+      run_audit "metric_fu - Code metrics from Flog, Flay, Saikuro, Churn, Reek, Roodi, Code Statistics, and Rails Best Practices. (and optionally RCov)" do
+        report_path = "#{report_dir}/metric_fu"
+        available_metrics = %w{cane churn flay flog hotspots rails_best_practices rcov reek roodi saikuro stats}
+        metric_fu_opts = ""
+        selected_metrics = available_metrics
+        if options[:metrics]
+          selected_metrics = options[:metrics].split(",")
+          disable_metrics = available_metrics - selected_metrics
+          selected_metrics_opt = selected_metrics.map { |m| "--#{m}" }.join(" ")
+          disable_metrics_opt = disable_metrics.map { |m| "--no-#{m}" }.join(" ")
+          metric_fu_opts = "#{selected_metrics_opt} #{disable_metrics_opt}"
+          puts "for metrics: #{selected_metrics.join(",")}"
+        end
+        # geneate report
+        report = `bundle exec metric_fu --no-open #{metric_fu_opts}`
+        FileUtils.remove_dir(report_path) if Dir.exists? report_path
+        FileUtils.mv("tmp/metric_fu/output", report_path, force: true)
+        puts report
+        puts "Report generated to #{report_path}"
+        show_in_browser File.realpath(report_path)
+
+        # audit report result
+        report_result_path = "tmp/metric_fu/report.yml"
+        if File.exists? report_result_path
+          report_result = YAML.load_file(report_result_path)
+          # if config #{metric}_max_offenses then audit it with report result
+          audit_failures = []
+          metrics_offenses_patterns.each do |metric, pattern|
+            option_key = "#{metric}_max_offenses".to_sym
+            if options[option_key]
+              detected_offenses = report_result[metric.to_sym][:total].to_s.match(pattern)[1].to_i rescue 0
+              max_offenses = options[option_key].to_i
+              puts "Metric #{colorize(metric, :green)} detected offenses #{colorize(detected_offenses, :yellow)} is more then #{colorize(max_offenses, :yellow)}, must improve your code quality or set a lower #{colorize(option_key, :black, :white)}" if detected_offenses > max_offenses
+              audit_failures << {metric: metric, detected_offenses: detected_offenses, max_offenses: max_offenses}
+            end
+          end
+          audit_faild "#{audit_failures.size} of #{selected_metrics.size} metrics audit failed" if audit_failures.any?
+        end
+      end
+    end
   end
 
   # desc "helper methods"
@@ -147,6 +251,19 @@ namespace :code_quality do
       ansi = cov.call(ansi, bg, bgcode) if bg.to_s != "default"
       ansi
     end
+
+    def show_in_browser(dir)
+      require "launchy"
+      uri = URI.escape("file://#{dir}/")
+      if File.directory?(dir)
+        uri = URI.join(uri, "index.html")
+      end
+      Launchy.open(uri) if open_in_browser?
+    end
+
+    def open_in_browser?
+      ENV["CI"].nil?
+    end
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: code_quality
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - RainChen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-22 00:00:00.000000000 Z
+date: 2017-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler-audit
@@ -42,16 +42,58 @@ dependencies:
   name: rubycritic
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.3.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.52.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.52.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-github
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: code_metric_fu
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.14.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.14.3
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -111,6 +153,8 @@ files:
 - bin/console
 - bin/setup
 - code_quality.gemspec
+- config/rubocop-github.yml
+- config/rubocop-rails.yml
 - lib/code_quality.rb
 - lib/code_quality/railtie.rb
 - lib/code_quality/version.rb
@@ -140,3 +184,4 @@ signing_key:
 specification_version: 4
 summary: run code quality and security audit report with one rake task
 test_files: []
+has_rdoc: