rake_rack 1.0.1 → 1.1.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ZTE4MDg3YjA0ZjAzNWUxNzQyZDgwYmVmMWE5NmRmOWI5ODZhZjQwZA==
-  data.tar.gz: !binary |-
-    OWE2ZDIxMjUzNjQ0NjkxYTE0ODFiZDRlYTUzODY4NjgwNThiMmFkMQ==
+SHA1:
+  metadata.gz: 779c63528007bd1658fa4b62921c28c23dcb2b4b
+  data.tar.gz: 8ee6732d620c16c23a8a2ca5eae7e37aa09a18f0
 SHA512:
-  metadata.gz: !binary |-
-    NjA4MTYwYTQ5ZjFkNWY0MTQ1MDA4NjY4NjlmNjFkODZkNTBlZTljN2MyNjYy
-    ODI4ODJhZDZhNWE5NzIwYTMwMjA4MjJmZmJhMzJiNTk2NTAzMmYwMDhhM2Mz
-    ZTQ4YmQ2MmZmODczNGM2MTJkZWFmNzMxNmZhNjVhZmE5MTJhYzg=
-  data.tar.gz: !binary |-
-    MmE1NDNiY2I1ZTRhMGJjNWU2ZjVjYmZjMjk0ZWFmNTllNjM2Y2I3ZjZmZDdm
-    N2ZmN2Q1MjNlOGQ0MGZhYmMzZWVlMjk2ZTBmZGI2YWJmNTU3NzkzMmFhNmI3
-    NjIyYmJmMDk0OWM4OTg2YzgwYzhkYjk5ZjQ4OTM5NDBhOTc2YzM=
+  metadata.gz: db7319de2d9a9acd4d888086e02bc5bd24bd15cba8f28505464e9798e5d7a6d386608310ecf50f5271e53e53550db5dd07614b66288eb3174d347fd319802f77
+  data.tar.gz: 8283c38a7352d8fadf04cab850f65f4a1837c27eb9d6293865b8675804b44ed42cf0e8cb060a78419d6364ea11c792dd12a29502ab41a55cf4ffdd66cccc8b2f

data/.ruby-version

@@ -0,0 +1 @@
+2.1.2

data/Gemfile

@@ -1,7 +1,12 @@
 source 'https://rubygems.org'
 
-gem 'rspec'
-gem 'rake'
-gem 'simplecov'
-gem 'timecop'
-gem 'term-ansicolor', '~> 1.3'
+gemspec
+
+group :development, :test do
+  gem 'rake'
+  gem 'rspec'
+  gem 'bundler-audit'
+  gem 'simplecov'
+  gem 'timecop'
+  gem 'term-ansicolor', '~> 1.3'
+end

data/Gemfile.lock

@@ -1,6 +1,16 @@
+PATH
+  remote: .
+  specs:
+    rake_rack (1.1.0)
+      rake (~> 10)
+      term-ansicolor (~> 1.3)
+
 GEM
   remote: https://rubygems.org/
   specs:
+    bundler-audit (0.3.1)
+      bundler (~> 1.2)
+      thor (~> 0.18)
     diff-lcs (1.2.5)
     docile (1.1.5)
     multi_json (1.10.1)
@@ -24,6 +34,7 @@ GEM
     simplecov-html (0.8.0)
     term-ansicolor (1.3.0)
       tins (~> 1.0)
+    thor (0.19.1)
     timecop (0.7.1)
     tins (1.3.2)
 
@@ -31,7 +42,9 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  bundler-audit
   rake
+  rake_rack!
   rspec
   simplecov
   term-ansicolor (~> 1.3)

data/README.md

@@ -1,30 +1,43 @@
 RakeRack
 ========
+
+Commonly used Rake tasks
+------------------------
+...collected together and given a new coat of paint (and nothing to do with [Rack](http://rack.github.io/))
+
+
 [![Build Status](https://travis-ci.org/RichardVickerstaff/rake_rack.svg?branch=master)](https://travis-ci.org/RichardVickerstaff/rake_rack)
 [![Gem Version](https://badge.fury.io/rb/rake_rack.svg)](http://badge.fury.io/rb/rake_rack)
-Common rake tasks I use a lot
------------------------------------------
 
-RakeRack is a collection of rake tasks myself and other commanly use on our projects.
-They have been extracted into a gem to allow them to easily be reused.
+RakeRack is a collection of widely applicable Rake tasks used on many projects.
+They have been extracted into a gem to allow them to easily be reused and maintained.
+
+RakeRack tasks are used on the project itself, so you can always take a peek at our [Rakefile](https://github.com/RichardVickerstaff/rake_rack/blob/master/Rakefile) or the [tasks themselves](https://github.com/RichardVickerstaff/rake_rack/tree/master/tasks) to work out what is going on
 
 Installation
 ------------
-* Install the gem or add `gem "rake_rack"` to your Gemfile.
+Install the gem or add `gem "rake_rack"` to your Gemfile.
 
 Usage
 -----
-RakeRack is made up of many rake tasks, add `require "rake_rack"` to the top of your default.rake file to gain access to them.
-You can then call them like you would any other rake task.
+    1. Add `require "rake_rack"` to your Rakefile
+    2. Call the tasks that you want, in with your usual Rake tasks.
 
-All tasks are namespaced with `:rake_rack` to prevent clashing with other tasks
+Tasks are namespaced under `:rake_rack` to prevent clashes.
+For example, this means the `:ok` task is called by invoking `:rake_rack:ok`
+
+Tasks
+-----
+### :bundler_audit
+Check the current Gemfile.lock for gem versions with known security issues, courtesy of [Bundler Audit](https://github.com/rubysec/bundler-audit#readme)
 
 ### :check_external_dependencies
 Check that each command in the `@external_dependencies` array is present on the system path (and fails the task if it isn't)
 For example:
-```ruby
-@external_dependencies = ['ruby', 'postgres', 'foo']
-```
+  ```ruby
+  @external_dependencies = ['ruby', 'postgres', 'foo']
+  ```
+You can also use the underlying checker object by creating an instance of `RakeRack::DependencyChecker` with your array of dependencies and calling `#check` or `#missing` on it.
 
 ### :code_quality
 #### :all
@@ -50,12 +63,13 @@ Look at SimpleCov results for spec coverage in `log/coverage/spec` and fail the
 Look at SimpleCov results for Cucumber coverage in `log/coverage/features` and fail the build if not 100%
 
 ### :ok
-Run this task last to print `***** ALL TESTS PASSED *****` showing you rake has passed.
+Useful at the end of any Rake tasks which test your application, it prints `***** ALL TESTS PASSED *****`.
 
 ### :ok_rainbow
-Run this task last to print a more magical version of the 'ALL TESTS PASSED' message
+Run this task last to print a more magical version of `:ok`
 
-
-ToDo
-----
-1. Add a cucumber rake task
+Contributing
+------------
+  1. Make a fork
+  2. Make and push your changes to your fork
+  3. Create a Pull Reques

data/Rakefile

@@ -1,7 +1,7 @@
 require 'rake/clean'
 require './lib/rake_rack'
 
-@external_dependencies = %w[ruby rake tput]
+@external_dependencies = %w[ruby rake]
 
 task :default => [
   :clean,
@@ -9,5 +9,6 @@ task :default => [
   :"rake_rack:code_quality:all",
   :"rake_rack:rspec",
   :"rake_rack:coverage:check_specs",
+  :"rake_rack:bundler_audit",
   :"rake_rack:ok",
 ]

data/history.rdoc

@@ -1,3 +1,5 @@
+== 1.1.0 (16 October 2014)
+
 == 1.0.1 (05 September 2014)
 
 == 1.0.0 (05 September 2014)

data/lib/dependency_checker.rb

@@ -0,0 +1,26 @@
+require 'term/ansicolor'
+
+class RakeRack
+  class DependencyChecker
+    include Term::ANSIColor
+
+    def initialize dependencies
+      @dependencies = Array(dependencies)
+    end
+
+    def check silent = false
+      @results = @dependencies.each_with_object({}) do |dep, results|
+        results[dep] = system "which #{dep} >/dev/null"
+        unless silent
+          results[dep] ? print(".".green) : print("F".red)
+        end
+      end
+    end
+
+    def missing
+      @results ||= check(true)
+      @results.select{|_, present| present == false}.keys
+    end
+
+  end
+end

data/lib/rake_rack.rb

@@ -1,7 +1,9 @@
 $:.unshift File.dirname(__FILE__)
 
 require 'rake'
-require 'version'
+
+lib = File.expand_path("../lib", File.dirname(__FILE__))
+Dir.glob("#{lib}/*.rb").each{|l| require l}
 
 dir = File.expand_path("../tasks", File.dirname(__FILE__))
 Dir.glob("#{dir}/*.rake").each { |r| import r}

data/rake_rack.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "rake_rack"
-  spec.version       = '1.0.1'
+  spec.version       = '1.1.0'
   spec.authors       = ["Richard Vickerstaff"]
   spec.email         = ["m3akq@btinternet.com"]
   spec.description   = "A set of rake tasks I commonly use - Formerly known as pool_net"
@@ -15,6 +15,5 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib","tasks"]
 
   spec.add_runtime_dependency "rake", "~> 10"
-  spec.add_runtime_dependency "rspec", "~> 3.0"
   spec.add_runtime_dependency "term-ansicolor", "~> 1.3"
 end

data/spec/dependency_checker_spec.rb

@@ -0,0 +1,41 @@
+require 'spec_helper'
+require 'term/ansicolor'
+include Term::ANSIColor
+
+describe RakeRack::DependencyChecker do
+
+  # Note that this test will fail if you, somehow, have this insane string define on your path
+  let(:missing) {'jajfjfjosojfnbje3nknq'}
+  let(:present) {'rspec'}
+  let(:list){ [present, missing] }
+
+  subject{RakeRack::DependencyChecker.new list}
+
+  describe '#check' do
+    before { $stdout = StringIO.new }
+
+    it 'returns a hash of dependencies => presence' do
+      result = subject.check
+      expect(result).to eq({present => true, missing => false})
+    end
+
+    it 'prints a dot for dependencies which are present' do
+      expect{subject.check}.to output(/\./).to_stdout
+    end
+
+    it 'prints a F for missing dependencies' do
+      expect{subject.check}.to output(/F/).to_stdout
+    end
+
+    it 'can be run without printing anything out' do
+      expect{subject.check(true)}.to_not output.to_stdout
+    end
+  end
+
+  describe '#missing_from' do
+    it 'returns only missing dependencies' do
+      expect(subject.missing).to eq [missing]
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -2,7 +2,6 @@ require 'simplecov'
 require 'timecop'
 require 'tempfile'
 
-
 SimpleCov.start do
   add_filter '/vendor/'
   coverage_dir 'log/coverage/spec'

data/tasks/bundler_audit.rake

@@ -0,0 +1,8 @@
+require 'bundler/audit/cli'
+
+namespace :rake_rack do
+  desc 'Check Gemfile.lock for security issues'
+  task :bundler_audit do
+    Bundler::Audit::CLI.start
+  end
+end

data/tasks/check_external_deps.rake

@@ -1,23 +1,16 @@
+require 'term/ansicolor'
+
 namespace :rake_rack do
   task :check_external_dependencies do
+    include Term::ANSIColor
+    checker = RakeRack::DependencyChecker.new(@external_dependencies)
+
     puts 'Checking external dependencies...'
-    green = `tput setaf 2`
-    red = `tput setaf 1`
-    reset = `tput sgr0`
+    checker.check
+    puts
 
-    results = Array(@external_dependencies).each_with_object({}) do |exe, status|
-        system "which #{exe} > /dev/null"
-        status[exe] = if($? == 0)
-          print "#{green}.#{reset}"
-          true
-        else
-          print "#{red}F#{reset}"
-          false
-        end
-      end
+    missing = checker.missing
+    fail("The following dependencies are missing: \n#{missing.join(%Q[\n])}") unless missing.empty?
     puts
-    missing = results.select{|k,v| v == false}
-    fail "The following dependencies are missing: \n#{missing.keys.join(%Q[\n])}" unless missing.empty?
-    2.times{puts}
   end
 end

data/tasks/ok.rake

@@ -1,7 +1,9 @@
+require 'term/ansicolor'
+
 namespace :rake_rack do
-  require 'term/ansicolor'
   include Term::ANSIColor
 
+  desc 'Print the "ALL TESTS PASSED" message'
   task :ok do
     puts
     print [
@@ -20,6 +22,7 @@ namespace :rake_rack do
     puts
   end
 
+  desc 'Print the "ALL TESTS PASSED" message WITH A SWEET RAINBOW!!!'
   task :ok_rainbow do
     puts
     print "  ",           "   ",            "    ",            "                  ".on_red,     "    ",            "   ",            "  ",           "\n"

metadata

@@ -1,55 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: rake_rack
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Richard Vickerstaff
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-05 00:00:00.000000000 Z
+date: 2014-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: term-ansicolor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 description: A set of rake tasks I commonly use - Formerly known as pool_net
@@ -59,20 +45,23 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rvmrc
-- .travis.yml
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - README.md
 - Rakefile
 - history.rdoc
+- lib/dependency_checker.rb
 - lib/rake_rack.rb
 - lib/version.rb
 - rake_rack.gemspec
 - spec/.keep
+- spec/dependency_checker_spec.rb
 - spec/spec_helper.rb
 - spec/version_spec.rb
+- tasks/bundler_audit.rake
 - tasks/check_external_deps.rake
 - tasks/code_quality.rake
 - tasks/coverage.rake
@@ -90,17 +79,17 @@ require_paths:
 - tasks
 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.4.1
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: A set of rake tasks I commonly use

data/.rvmrc

@@ -1 +0,0 @@
-rvm use --create --install ruby-2.1.2@rake_rack