code_quality 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eace4c0b5c37da862ea1badeb54ef4f0163236d4f3b73134cbe7dfea9830de86
-  data.tar.gz: 2927bcc4f3ddff5ff6c142bfdb5835f2fafba593148c547d6e8ca6142d111df4
+  metadata.gz: 1fc47dc8cf14d7cd8a5106fff0b642bc487093bfeacabfbfab5637df50cf4ab7
+  data.tar.gz: cf6c2cc1d8c0412eb56e793cfb9d4dc73be29eafff29c2700289e1fa10d52304
 SHA512:
-  metadata.gz: ce5e2c0afa00141987f63bbfaedfbffd7595fe1b888f9dfa90816e1de0a3b8ffd83097ddec857656ce79452417174a37b06e723e0e0891f82dccc3beba52a927
-  data.tar.gz: 8d318b6278cf2111400c19c0dc296c572fe6a2a3855bc22850b40bc352d2ff060330e7b8086d1562f9122c201ca1a4057d484eaff321bee1b413100f2c19d622
+  metadata.gz: ef8ce46be84722fa2053dd4979723985aa21a8d7cb5f68c3cffbb409e54d82210adbc87da53a3390ab149f32b2bf1e182392a8963a6763f8060fea5b7b33e82f
+  data.tar.gz: a5b5032fd98227186ae874c9279fd36d2cd79e2bf163177089b65f43f321909b41fe9c28016d744318583ba44ce9a84c8e229853cf991aa60ad5d9c49b21539f

data/.travis.yml

@@ -1,3 +1,26 @@
+################
+# CI Workflow:
+# feature development, trigger by `git push`:
+#   test -> code_audit(code_security_audit and code_quality_audit)
+#
+# feature deploy, trigger by `git push --tags`
+#   test -> deploy
+#
+# Stages:
+# - test: run `rake test`
+# - code_audit: run `code_quality security_audit` and `code_quality quality_audit`
+# - deploy: auto build and upload a gem package to rubygems.org after `git push --tags`
+#
+# Principle:
+# - fail fast
+# - done is better than perfect
+################
+
+stages:
+  - test
+  - code_audit
+  - deploy
+
 sudo: false
 language: ruby
 rvm:
@@ -9,6 +32,16 @@ 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=
 
+jobs:
+  include:
+    - stage: code_audit
+      if: branch != master
+      install: gem install code_quality --no-ri --no-rdoc
+      script:
+        - bundle install # to generate Gemfile.lock
+        - code_quality security_audit
+        - code_quality quality_audit fail_fast=false generate_index=true lowest_score=90 rubocop_max_offenses=120
+
 deploy:
   # automatically release Ruby gem to RubyGems after a successful build with `git push --tags`
   - provider: rubygems

data/lib/code_quality/cli.rb

@@ -39,14 +39,20 @@ module CodeQuality
 
         OptionParser.new do |opts|
           opts.separator "Run code_quality for a ruby/rails project, e.g.:"
-          opts.separator "    code_quality lowest_score=90 max_offenses=100 metrics=stats,rails_best_practices,roodi rails_best_practices_max_offenses=10 roodi_max_offenses=10"
+          opts.separator "    code_quality lowest_score=90 rubocop_max_offenses=100 metrics=stats,rails_best_practices,roodi rails_best_practices_max_offenses=10 roodi_max_offenses=10"
           opts.separator ""
           opts.separator "Show available tasks:"
           opts.separator "    code_quality -T"
           opts.separator ""
-          opts.separator "Invoke a audit task:"
+          opts.separator "Invoke an audit task:"
           opts.separator "    code_quality AUDIT_TASK"
           opts.separator ""
+          opts.separator "Invoke all security audit tasks:"
+          opts.separator "    code_quality security_audit"
+          opts.separator ""
+          opts.separator "Invoke all quality audit tasks:"
+          opts.separator "    code_quality quality_audit"
+          opts.separator ""
           opts.separator "Advanced options:"
 
           opts.on_tail("-h", "--help", "-H", "Display this help message.") do

data/lib/code_quality/version.rb

@@ -1,3 +1,3 @@
 module CodeQuality
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

data/lib/tasks/code_quality.rake

@@ -47,11 +47,14 @@ namespace :code_quality do
     end
 
     desc "brakeman"
+    # options:
+    #   brakeman_options: pass extract CLI options, e.g.: brakeman_options="--skip-files lib/templates/"
     task :brakeman => :prepare do |task|
+      options = options_from_env(:brakeman_options)
       require 'json'
       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`
+        `brakeman -o #{@report_path} -o #{report_dir}/brakeman-report.json #{options[:brakeman_options]} .`
         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?
@@ -84,7 +87,7 @@ namespace :code_quality do
     # default tasks
     task :default => [:run_all, :resources] do; end
 
-    desc "run all audit tasks"
+    # desc "run all audit tasks"
     task :run_all => :helpers do
       options = options_from_env(:fail_fast, :generate_index)
       fail_fast = options.fetch(:fail_fast, "false")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: code_quality
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - RainChen
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-02-28 00:00:00.000000000 Z
+date: 2018-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler-audit