code_quality 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80898f3a14a7a561070acc6cbc3a4e6d8285d451adcd921f51c8cd99535016dc
-  data.tar.gz: 20b1ed6739d35f1abc60143205518dfedb9c716b29f06134872c94aa5548afd3
+  metadata.gz: c97a301536ac1e5078182bd45230e6adfa3a2c472bdceee4982844e27d536441
+  data.tar.gz: 98a33f7a35c23d1a787f534e2847c3b664310b7751d1864ef109b9c88412b841
 SHA512:
-  metadata.gz: 91dab9cb07414281a9f6fad6a6906ab3e5b8d69a59ff045e88f284e4c0ecd0df30b1fa872258882ae065edcd13170dd4e24387d323547501d2dad44eb43005ca
-  data.tar.gz: aa5c50f26224d0a170b731f4a8a2f394d083247e49b4e088c69cbf38180c8f6137c7f1d5a61fdad37543c229cf1beeb14fcc97e1d527cf887f10bc7fe9b95add
+  metadata.gz: d394a0c35a8ee45ca255f071b279a8eb6effda067333e9c5df9b938b3f1c2c27c281516147f0a91efa4939dd53280c27caa5e34d01adf3758d0bc7cd3863c040
+  data.tar.gz: d6a4d1502a04558ba0d6be06bdf0d080723b10d18203edf21268798af22a621d398026b84103808f958b00ff1c53738e95233882f15b422b604ddea54229da01

data/.gitignore

@@ -9,3 +9,6 @@
 
 # rspec failure tracking
 .rspec_status
+
+config/.rubocop-https---rawgit-com-rails-rails-master--rubocop-yml
+Gemfile.lock

data/.travis.yml

@@ -4,12 +4,26 @@ rvm:
   - 2.4.3
 before_install: gem install bundler -v 1.16.0
 
-# automatically release Ruby gem to RubyGems after a successful build with `git push --tags`
+# config GitHub OAuth Token
+env:
+  global:
+    secure: HLfW6QDOiyxaM7wBRDzdF9ud0Ey1EVL/rdnvt8TvM7VUbtUt4wLlCbUcIIASbxrv0AV/MtpkS4n9O/WIk3rcdndoUzoPtYBNIKI9McJuunoSxzY2pwlF7scZz0aE64OJCCshCEeaNRR5p8yw7Lw4gptsdFmceIVXyPfGEG924arSwFcAhMUnWxaIBFamH9/j2KXrq0RkagX2b4+HUqH1at4cfc/otFUbvQxaGL5eaxI+ReZU3MwO3uxAvdoWoiWpAS3NDTxJKN9GMT6a67wzbxGPERj2G75sGubwVJfvRhdh+BgjAOJjgSMaUMYn2HA9phN5Mkb0z9yaZu2RuBzEscHv8Cq8pSVHb75IvjBdk2Ovsq3R25D/jFdTPnLnJxsrWYVLDDSyJvpyc1aOcws/Ry7MEX8v+Lt0gWJraleTcfn51ulZY/cWlD8utVqvTjfjGjKEZrmYXn5nu0xTJ3vYHMttqKavh6nQxcc7cDRLbVDE5GI9PUjENNP+ZxY0ldiSQiYm+S/1OuHZP9/z6DXMhIDUFZBNSIy3dkKW5bUFQNeb40mi0muS8elqoKQ/fkumU7YmKEVrdkP6wyL6LEa4HYqFAy/glktcb1r9PTSPpE/Z40rx0wemUaPSyY/2SYp1CMoSJpIHvt2IHzrlPaSuK9UTObmtH02CRqB9R8/cURU=
+
 deploy:
-  provider: rubygems
-  api_key:
-    secure: mzjlQXKByIn4jdGzUayX65Xqnl9zSkvJJZZnoqZuVnRjz93veVm9mwfUGGcSNQj9dvQTedrxMLyOKINJMIH+SlveHUeU04a7QxbM6i7o+sWRFEq98p7DauSpJJTB4fDINSwjcHU8t43PjhBItA6n4PLUrCuIzXqxvY4VLHgGLGkXV17ngdHBRRFFDuMS0npsTLLfaqaFtyYx/mer/z9pSGR9g4ETsfVFSBNafPfDAoXfK3WRLbqS8EkB7SXCSliOUuzLBEOSLy8xMOAS682dEsPZzUvUGBMrXLYhxVBECfzAMzk2VxRX0MujJxzQyGiKZUShLkDVSulkah+aHhcMqcQ0VewcELihNj86tPEtT7Uiwd6aSe0J9WrgeVE2jkaPcIZyN3eAfZ4QhQrdrHeCnjmhcMsKopzc4FLOq9B7j1WCbmeGx3scXsZkjcugwnAUm07imlUQzHO85tVxZuDbPvBQ/J/vBhuUIl1E7ptUx0eUXrVWTGDsM7RIgt87O96QXthGgVg9NYmTmvMAjts8W0zfhAQIc/13QZUYvXQ6qX95Xu4RkmeTX7T63hpqKlwSCbYbQTBF3T5X9xyKkeF0BLHZ1jMIyoOoKZFsZL+ESrpCEeq8ZDaod6Az2rIa3KgszKxV/w5vyIInhg+lzX9RF5JL8X9q9hVEvIIx5BGQWXI=
-  gem: code_quality
-  on:
-    tags: true
-    repo: rainchen/code_quality
+  # automatically release Ruby gem to RubyGems after a successful build with `git push --tags`
+  - provider: rubygems
+    api_key:
+      secure: mzjlQXKByIn4jdGzUayX65Xqnl9zSkvJJZZnoqZuVnRjz93veVm9mwfUGGcSNQj9dvQTedrxMLyOKINJMIH+SlveHUeU04a7QxbM6i7o+sWRFEq98p7DauSpJJTB4fDINSwjcHU8t43PjhBItA6n4PLUrCuIzXqxvY4VLHgGLGkXV17ngdHBRRFFDuMS0npsTLLfaqaFtyYx/mer/z9pSGR9g4ETsfVFSBNafPfDAoXfK3WRLbqS8EkB7SXCSliOUuzLBEOSLy8xMOAS682dEsPZzUvUGBMrXLYhxVBECfzAMzk2VxRX0MujJxzQyGiKZUShLkDVSulkah+aHhcMqcQ0VewcELihNj86tPEtT7Uiwd6aSe0J9WrgeVE2jkaPcIZyN3eAfZ4QhQrdrHeCnjmhcMsKopzc4FLOq9B7j1WCbmeGx3scXsZkjcugwnAUm07imlUQzHO85tVxZuDbPvBQ/J/vBhuUIl1E7ptUx0eUXrVWTGDsM7RIgt87O96QXthGgVg9NYmTmvMAjts8W0zfhAQIc/13QZUYvXQ6qX95Xu4RkmeTX7T63hpqKlwSCbYbQTBF3T5X9xyKkeF0BLHZ1jMIyoOoKZFsZL+ESrpCEeq8ZDaod6Az2rIa3KgszKxV/w5vyIInhg+lzX9RF5JL8X9q9hVEvIIx5BGQWXI=
+    gem: code_quality
+    on:
+      tags: true
+      repo: rainchen/code_quality
+
+  # publish generated files to GitHub pages
+  - provider: script
+    skip_cleanup: true
+    script: bin/travis-update-gh-pages.sh
+    on:
+      branch: master
+      tags: true
+    condition: $TRAVIS_PULL_REQUEST = "false"

data/README.md

@@ -4,6 +4,7 @@ Run code quality and security audit report with one rake task as `rake code_qual
 
 [![Gem Version](https://badge.fury.io/rb/code_quality.svg)](https://badge.fury.io/rb/code_quality)
 [![Build Status](https://travis-ci.org/rainchen/code_quality.svg)](https://travis-ci.org/rainchen/code_quality)
+[![HitCount](http://hits.dwyl.io/rainchen/code_quality.svg)](http://hits.dwyl.io/rainchen/code_quality)
 
 ## Principle
 
@@ -47,6 +48,8 @@ Generated by code_quality (v0.1.3) @ 2018-01-12 16:32:20 +0800
 
 [Code Quality Report Example](doc/code_quality_report_example.md)
 
+[Code Quality Report Details Example](https://rainchen.github.io/code_quality/)
+
 ### Two major audit tasks
 
 There are 2 types of audit tasks: `security_audit` and `quality_audit`, each sub task can be run separately.

data/app/views/code_quality/index.html.erb

@@ -0,0 +1,20 @@
+<html>
+<head>
+  <title>Code Quality Report</title>
+</head>
+<body>
+
+<h1>Code Quality Report</h1>
+
+<ul>
+<% @audit_tasks.each do |task_name, report| %>
+  <li>[<%= report[:failure].empty? ? "✓" : "✗" %>] <a href="<%= report[:report_path] %>"><%= task_name %></a> <%= report[:failure] %></li>
+<% end %>
+</ul>
+
+<footer>
+  Generated by code_quality (v<%= CodeQuality::VERSION %>) @ <%= Time.now %>
+</footer>
+
+</body>
+</html>

data/bin/travis-update-gh-pages.sh

@@ -0,0 +1,35 @@
+#!/bin/sh
+# This script is used to run on Travis CI to publish generated files to GitHub pages
+if [ ${TRAVIS} = "true" ]; then
+  echo "Starting to update gh-pages"
+
+  #copy data we're interested in to other place
+  mkdir $HOME/tmp
+  cp -R tmp/code_quality $HOME/tmp/code_quality
+
+  #go to home
+  cd $HOME
+
+  #using token clone gh-pages branch
+  git clone --quiet --branch=gh-pages https://${GH_TOKEN}@github.com/${TRAVIS_REPO_SLUG}.git gh-pages > /dev/null
+
+  #go into diractory and copy data we're interested in to that directory
+  cd gh-pages
+  cp -Rf $HOME/tmp/code_quality/* .
+
+  #setup git user
+  git config user.email "travis@travis-ci.org"
+  git config user.name "Travis CI"
+
+  #add, commit and push files
+  travis_build_url="https://travis-ci.org/${TRAVIS_REPO_SLUG}/builds/${TRAVIS_BUILD_ID}"
+  git add -f .
+  git commit -m "Travis CI build $travis_build_url pushed to gh-pages"
+  git push -fq origin gh-pages > /dev/null
+
+  #display GitHub Project Pages url
+  owner_name=`echo $TRAVIS_REPO_SLUG|cut -d / -f 1`
+  repo_name=`echo $TRAVIS_REPO_SLUG|cut -d / -f 2`
+  gh_pages_url="https://$owner_name.github.io/$repo_name"
+  echo "Push to $gh_pages_url"
+fi

data/lib/code_quality/version.rb

@@ -1,3 +1,3 @@
 module CodeQuality
-  VERSION = "0.1.6"
+  VERSION = "0.1.7"
 end

data/lib/tasks/code_quality.rake

@@ -1,7 +1,8 @@
 desc "Generate security audit and code quality report"
+# e.g.: rake code_quality lowest_score=90 max_offenses=100 metrics=stats,rails_best_practices,roodi rails_best_practices_max_offenses=10 roodi_max_offenses=10
 task :code_quality => :"code_quality:default" do; end
 namespace :code_quality do
-  task :default => [:summary, :security_audit, :quality_audit] do; end
+  task :default => [:summary, :security_audit, :quality_audit, :generate_index] do; end
 
   # desc "show summary"
   task :summary do
@@ -9,6 +10,23 @@ namespace :code_quality do
     puts "Generated by code_quality (v#{CodeQuality::VERSION}) @ #{Time.now}", "\n"
   end
 
+  # desc "generate a report index page"
+  task :generate_index => :helpers do
+    require "erb"
+    prepare_dir "tmp/code_quality"
+    gem_app_dir = File.expand_path("../../../app", __FILE__)
+    erb_file = "#{gem_app_dir}/views/code_quality/index.html.erb"
+    index_path = "tmp/code_quality/index.html"
+
+    # render view
+    erb = ERB.new(File.read(erb_file))
+    output = erb.result(binding)
+
+    File.open(index_path, 'w') {|f| f.write output }
+    # puts "Generate report index to #{index_path}"
+    show_in_browser File.realpath(index_path)
+  end
+
   desc "security audit using bundler-audit, brakeman"
   task :security_audit => [:"security_audit:default"] do; end
   namespace :security_audit do
@@ -26,22 +44,24 @@ namespace :code_quality do
     end
 
     desc "bundler audit"
-    task :bundler_audit => :prepare do
-      run_audit "bundler audit - checks for vulnerable versions of gems in Gemfile.lock" do
+    task :bundler_audit => :prepare do |task|
+      run_audit task, "bundler audit - checks for vulnerable versions of gems in Gemfile.lock" do
         # Update the ruby-advisory-db and check Gemfile.lock
         report = `bundle audit check --update`
-        File.open("#{report_dir}/bundler-audit-report.txt", 'w') {|f| f.write report }
+        @report_path = "#{report_dir}/bundler-audit-report.txt"
+        File.open(@report_path, 'w') {|f| f.write report }
         puts report
         audit_faild "Must fix vulnerabilities ASAP" unless report =~ /No vulnerabilities found/
       end
     end
 
     desc "brakeman"
-    task :brakeman => :prepare do
+    task :brakeman => :prepare do |task|
       require 'json'
-      run_audit "Brakeman audit - checks Ruby on Rails applications for security vulnerabilities" do
-        `brakeman -o #{report_dir}/brakeman-report.txt -o #{report_dir}/brakeman-report.json`
-        puts `cat #{report_dir}/brakeman-report.txt`
+      run_audit task, "Brakeman audit - checks Ruby on Rails applications for security vulnerabilities" do
+        @report_path = "#{report_dir}/brakeman-report.txt"
+        `brakeman -o #{@report_path} -o #{report_dir}/brakeman-report.json`
+        puts `cat #{@report_path}`
         report = JSON.parse(File.read("#{report_dir}/brakeman-report.json"))
         audit_faild "There are #{report["errors"].size} errors, must fix them ASAP." if report["errors"].any?
       end
@@ -81,12 +101,12 @@ namespace :code_quality do
 
     desc "rubycritic"
     # e.g.: rake code_quality:quality_audit:rubycritic lowest_score=94.5
-    task :rubycritic => :prepare do
+    task :rubycritic => :prepare do |task|
       options = options_from_env(:lowest_score)
-      run_audit "Rubycritic - static analysis gems such as Reek, Flay and Flog to provide a quality report of your Ruby code." do
+      run_audit task, "Rubycritic - static analysis gems such as Reek, Flay and Flog to provide a quality report of your Ruby code." do
         report = `rubycritic -p #{report_dir}/rubycritic app lib --no-browser`
         puts report
-        report_path = "#{report_dir}/rubycritic/overview.html"
+        @report_path = report_path = "#{report_dir}/rubycritic/overview.html"
         show_in_browser File.realpath(report_path)
 
         # if config lowest_score then audit it with report score
@@ -106,8 +126,8 @@ namespace :code_quality do
     #   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
+    task :rubocop => :prepare do |task|
+      run_audit task, "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 = {
@@ -125,7 +145,7 @@ namespace :code_quality do
           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"
+        @report_path = 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}`
@@ -153,7 +173,7 @@ namespace :code_quality do
     #   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
+    task :metric_fu => :prepare do |task|
       metrics_offenses_patterns = {
         "flay" => /Total Score (\d+)/,
         "cane" => /Total Violations (\d+)/,
@@ -163,7 +183,7 @@ namespace :code_quality do
       }
       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
+      run_audit task, "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 = ""
@@ -183,6 +203,7 @@ namespace :code_quality do
         puts report
         puts "Report generated to #{report_path}"
         show_in_browser File.realpath(report_path)
+        @report_path = "#{report_path}/index.html"
 
         # audit report result
         report_result_path = "tmp/metric_fu/report.yml"
@@ -225,10 +246,25 @@ namespace :code_quality do
 
   # desc "helper methods"
   task :helpers do
-    def run_audit(title, &block)
+    def run_audit(task, title, &block)
+      task_name = task.name.split(":").last
+      @audit_tasks ||= {}
+      @audit_tasks[task_name] ||= {
+        report_path: "",
+        failure: "",
+      }
+
       puts "## #{title}"
       puts "", "```"
-      realtime(&block)
+      begin
+        realtime(&block)
+      rescue SystemExit => exc
+        # audit faild
+        @audit_tasks[task_name][:failure] = exc.message.gsub(/(\e\[\d+m)/, "")
+      ensure
+        # get @report_path set in each audit task
+        @audit_tasks[task_name][:report_path] = @report_path.sub("tmp/code_quality/", "")
+      end
       puts "```", ""
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: code_quality
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - RainChen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-17 00:00:00.000000000 Z
+date: 2018-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler-audit
@@ -151,8 +151,10 @@ files:
 - README.md
 - Rakefile
 - app/readme
+- app/views/code_quality/index.html.erb
 - bin/console
 - bin/setup
+- bin/travis-update-gh-pages.sh
 - code_quality.gemspec
 - config/rubocop-github.yml
 - config/rubocop-rails.yml