code_quality 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 37c28c316373313c706968fba46f52a023f20584
+  data.tar.gz: d6143f5b24da0776c272fa06b5a626976932b739
+SHA512:
+  metadata.gz: daed8fdb4a6ad0ce29c93c298f55735b7ec9a26a44c96e13c9f292371093739789dab4b4670c9edeffd599e25825f120c67fc3c2ca71b50da9f0c1c776cfde5c
+  data.tar.gz: ac3117746cec3a4bcf35be15c927aa369550609008e60bf4665dfbe6457cb04f68889bdad12da915b2137c8d8dcbac2b01442723db2b4c44b2a663837d8f9af5

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.3
+before_install: gem install bundler -v 1.16.0

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in code_quality.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 RainChen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,39 @@
+# CodeQuality
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/code_quality`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'code_quality'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install code_quality
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/code_quality.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "code_quality"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/code_quality.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "code_quality/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "code_quality"
+  spec.version       = CodeQuality::VERSION
+  spec.authors       = ["RainChen"]
+  spec.email         = ["hirainchen@gmail.com"]
+
+  spec.summary       = %q{run code quality and security audit report with one rake task}
+  spec.description   = %q{run code quality and security audit report with one rake task}
+  spec.homepage      = "https://github.com/rainchen/code_quality"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "bundler-audit"
+  spec.add_dependency "brakeman"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/code_quality.rb

@@ -0,0 +1,5 @@
+require "code_quality/version"
+require "code_quality/railtie"# if defined?(Rails)
+
+module CodeQuality
+end

data/lib/code_quality/railtie.rb

@@ -0,0 +1,5 @@
+class CodeQuality::Railtie < Rails::Railtie
+  rake_tasks do
+    load 'tasks/code_quality.rake'
+  end
+end

data/lib/code_quality/version.rb

@@ -0,0 +1,3 @@
+module CodeQuality
+  VERSION = "0.1.0"
+end

data/lib/tasks/code_quality.rake

@@ -0,0 +1,105 @@
+namespace :code_quality do
+
+  desc "security audit using bundler-audit, brakeman"
+  task :security_audit => [:"security_audit:default"] do; end
+  namespace :security_audit do
+    # default tasks
+    task :default => [:bundler_audit, :brakeman, :resources] do; end
+
+    # desc "prepare dir"
+    task :prepare => :helpers do
+      @report_dir = "tmp/code_quality/security_audit"
+      prepare_dir @report_dir
+
+      def report_dir
+        @report_dir
+      end
+    end
+
+    desc "bundler audit"
+    task :bundler_audit => :prepare do
+      run_audit "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 }
+        puts report
+        audit_faild "Must fix vulnerabilities ASAP" unless report =~ /No vulnerabilities found/
+      end
+    end
+
+    desc "brakeman"
+    task :brakeman => :prepare do
+      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`
+        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
+    end
+
+    # desc "resources url"
+    task :resources do
+      refs = %w{
+        https://github.com/presidentbeef/brakeman
+        https://github.com/rubysec/bundler-audit
+        http://guides.rubyonrails.org/security.html
+        https://github.com/hardhatdigital/rails-security-audit
+        https://hakiri.io/blog/ruby-security-tools-and-resources
+        https://www.netsparker.com/blog/web-security/ruby-on-rails-security-basics/
+        https://www.owasp.org/index.php/Ruby_on_Rails_Cheatsheet
+      }
+      puts "## Security Resources"
+      puts refs.map { |url| "  - #{url}" }
+    end
+  end
+
+  # TODO: code quality audit
+  desc "code quality audit"
+  task :quality_audit => [:"quality_audit:default"] do; end
+  namespace :quality_audit do
+    # default tasks
+    task :default do
+      puts "PENDING"
+    end
+  end
+
+  # desc "helper methods"
+  task :helpers do
+    def run_audit(title, &block)
+      puts "## #{title}"
+      puts "", "```"
+      realtime(&block)
+      puts "```", ""
+    end
+
+    def realtime(&block)
+      realtime = Benchmark.realtime do
+        block.call
+      end.round
+      process_time = humanize_secs(realtime)
+      puts "[ #{process_time} ]"
+    end
+
+    # p humanize_secs 60
+    # => 1m
+    # p humanize_secs 1234
+    #=>"20m 34s"
+    def humanize_secs(secs)
+      [[60, :s], [60, :m], [24, :h], [1000, :d]].map{ |count, name|
+        if secs > 0
+          secs, n = secs.divmod(count)
+          "#{n.to_i}#{name}"
+        end
+      }.compact.reverse.join(' ').chomp(' 0s')
+    end
+
+    def prepare_dir(dir)
+      FileUtils.mkdir_p dir
+    end
+
+    def audit_faild(msg)
+      abort "[AUDIT FAILED] #{msg}"
+    end
+  end
+
+end

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: code_quality
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- RainChen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-12-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler-audit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: brakeman
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: run code quality and security audit report with one rake task
+email:
+- hirainchen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- code_quality.gemspec
+- lib/code_quality.rb
+- lib/code_quality/railtie.rb
+- lib/code_quality/version.rb
+- lib/tasks/code_quality.rake
+homepage: https://github.com/rainchen/code_quality
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: run code quality and security audit report with one rake task
+test_files: []