spec_cat 1.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 04e83ac3e75c89fc69549058557706a0bbb2a2bc
+  data.tar.gz: ec408995fdd89b1cf3a66a58cbf0e5f409f345d4
+SHA512:
+  metadata.gz: bc63fa25af06f5143a036a6320244d0747c05d0ca14ee23512bf947cf4b067c30dd0eb7de949491099e4f3f3a1c5f68267af3b1f202f6a3f4c195e2128178875
+  data.tar.gz: 060a2010c929c34020b246c211b7a2bded606bd8b4aa14d385f70480a745a6b4fdb6a503c3daf4c78a2513b1fb0f29bd74a2714f9670eb2f30e90fcfd0c66738

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+Copyright (c) 2012 SchrodingersBox.com
+MIT License
+
+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,92 @@
+[![Build Status](https://travis-ci.org/schrodingersbox/spec_cat.svg?branch=master)](https://travis-ci.org/schrodingersbox/spec_cat)
+[![Coverage Status](https://coveralls.io/repos/schrodingersbox/spec_cat/badge.png?branch=master)](https://coveralls.io/r/schrodingersbox/spec_cat?branch=master)
+[![Code Climate](https://codeclimate.com/github/schrodingersbox/spec_cat.png)](https://codeclimate.com/github/schrodingersbox/spec_cat)
+[![Dependency Status](https://gemnasium.com/schrodingersbox/spec_cat.png)](https://gemnasium.com/schrodingersbox/spec_cat)
+[![Gem Version](https://badge.fury.io/rb/spec_cat.png)](http://badge.fury.io/rb/spec_cat)
+
+# schrodingersbox/spec_cat
+
+This gem contains trivial matchers to make RSpecs a bit more effective and annoying.
+
+ * eql_file
+ * have_a_spec
+
+ NOTE: This gem does not depend on Rails.  All paths are relative to cwd, which
+ may be Rails.root or anywhere else.
+
+## Getting Started
+
+Add this to your gemfile...
+
+      gem 'spec_cat', :git => 'https://github.com/schrodingersbox/spec_cat.git'
+
+## Matchers
+
+### eql_file
+
+`eql_file` will compare method output to a ground truth file and fail if they
+are different.
+
+It also writes a .tmp file to replace the old ground truth if it's gone stale.
+
+e.g.  #foo produces a gnarly string too nasty to copy and paste into code.
+
+     foo.should eql_file( 'spec/data/foo.json' )
+
+... if it fails for a valid change, you can just....
+
+    cp spec/truth/foo.json.tmp spec/truth/foo.json
+
+... and all will be good again.
+
+This mechanism is a bit brittle, but great for big blobs of data.
+
+If you use this, you should add `*.tmp` to your .gitignore.
+
+### have_a_spec
+
+`have_a_spec` will ensure that any given path has a corresponding spec file to
+help ensure that you have good coverage.
+
+    'app/controllers/application_controller.rb'.should have_a_spec
+
+... is a good thing to write right after you integrate RSpec.
+
+Here's an example coverage spec...
+
+<https://github.com/schrodingersbox/spec_cat/blob/master/spec/coverage_spec.rb>
+
+### include_module
+
+`include_module` makes it easy to spec concern inclusion.
+
+    it( 'is Taggable' ) { should include_module( Taggable ) }
+
+## Rake Tasks
+
+### spec_cat:accept
+
+`rake spec_cat:accept` runs all specs and causes the eql_file matcher to overwrite
+the ground truth files, rather than output .tmp files.
+
+This is convenient when a code change impacts a large number of ground truth files,
+but is also risky, as it may allow an incorrect change to become ground truth.
+
+### spec_cat:coverage
+
+`rake spec_cat:coverage` runs all specs and then opens the coverage report if all the
+specs pass.
+
+## Reference
+
+ * [RSpec](https://github.com/rspec/rspec)
+ * [Testing Rake Tasks with RSpec](http://www.philsergi.com/2009/02/testing-rake-tasks-with-rspec.html)
+ * [Nathan Humbert's Blog: Rails 3: Loading rake tasks from a gem](http://blog.nathanhumbert.com/2010/02/rails-3-loading-rake-tasks-from-gem.html)
+ * [Publishing your gem](http://guides.rubygems.org/publishing/)
+
+## TODO
+
+ * Fix include_module - only get class if arg is not already a class
+ * Add more matchers
+
+

data/Rakefile

@@ -0,0 +1,3 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+load 'lib/tasks/spec_cat.rake'

data/lib/spec_cat/matchers/eql_file.rb

@@ -0,0 +1,28 @@
+# eql_file.rb
+#
+# Confirms that an in-memory string matches a ground truth file.
+# Exports the actual value as a .tmp file as a side effect.
+#
+# 'cp foo/bar.tmp foo/bar' to correct valid test failures.
+
+RSpec::Matchers.define :eql_file do |expected_path|
+
+  description do
+    "match the contents of #{expected}"
+  end
+
+  failure_message_for_should do |actual|
+    "expected that #{actual} would match the contents of #{expected}"
+  end
+
+  failure_message_for_should_not do |actual|
+    "expected that #{actual} would not match the contents of #{expected}"
+  end
+
+  match do |actual|
+    extension = SpecCat.accept? ?  '' : '.tmp'
+    SpecCat.write( expected_path + extension, actual )
+    actual == SpecCat.read( expected_path )
+  end
+
+end

data/lib/spec_cat/matchers/have_a_spec.rb

@@ -0,0 +1,33 @@
+# have_a_spec.rb
+#
+# Confirms that a given file path has a corresponding spec file.
+
+RSpec::Matchers.define :have_a_spec do
+
+  description do
+    'has a spec file'
+  end
+
+  match do |path|
+    File.exists?( spec_file_for( path ) )
+  end
+
+  failure_message_for_should do |path|
+    "expected #{path} to have spec at #{spec_file_for( path )}"
+  end
+
+  failure_message_for_should_not do |path|
+    "expected #{path} to not have spec at #{spec_file_for( path )}"
+  end
+
+  def spec_file_for( path )
+    basename = File.basename( path, '.rb' ) + '_spec.rb'
+
+    dirname = File.dirname( path )
+    dirname.gsub!( /^app/, 'spec' )
+    dirname.gsub!( /^lib/, 'spec/lib' )
+
+    return File.join( dirname, basename )
+  end
+
+end

data/lib/spec_cat/matchers/include_module.rb

@@ -0,0 +1,23 @@
+# include_module.rb
+#
+# Confirms that the subject includes the expected module
+
+RSpec::Matchers.define :include_module do |expected_module|
+
+  description do
+    "includes #{expected}"
+  end
+
+  failure_message_for_should do |subject|
+    "expected that #{subject.class} would include #{expected}"
+  end
+
+  failure_message_for_should_not do |subject|
+    "expected that #{subject.class} would not include #{expected}"
+  end
+
+  match do |subject|
+    subject.class.included_modules.include?( expected_module )
+  end
+
+end

data/lib/spec_cat/railtie.rb

@@ -0,0 +1,12 @@
+require 'spec_cat'
+require 'rails'
+
+module SpecCat
+  class Railtie < Rails::Railtie
+    railtie_name :'spec_cat'
+
+    rake_tasks do
+      load 'tasks/spec_cat.rake'
+    end
+  end
+end

data/lib/spec_cat/version.rb

@@ -0,0 +1,3 @@
+module SpecCat
+  VERSION = '1.0.2'
+end

data/lib/spec_cat.rb

@@ -0,0 +1,23 @@
+require 'rspec'
+
+require 'spec_cat/matchers/eql_file'
+require 'spec_cat/matchers/have_a_spec'
+require 'spec_cat/matchers/include_module'
+
+require 'spec_cat/railtie' if defined?(Rails)
+
+module SpecCat
+
+  def self.accept?
+    !ENV[ 'SPEC_CAT_ACCEPT' ].nil?
+  end
+
+  def self.write( path, content )
+    File.open( path,'wb' ) { |io| io.write content }
+  end
+
+  def self.read( path )
+    File.open( path, 'rb' ) { |io| io.read }
+  end
+
+end

data/lib/tasks/spec_cat.rake

@@ -0,0 +1,14 @@
+namespace :'spec_cat' do
+
+  desc 'Run rspec and accept all ground truth file changes'
+  task :accept do
+    ENV[ 'SPEC_CAT_ACCEPT' ] = '1'
+    Kernel.system 'rspec spec'
+  end
+
+  desc 'Run rspec with coverage and open the report'
+  task :coverage do
+    Kernel.system 'rspec spec && open coverage/index.html'
+  end
+
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: spec_cat
+version: !ruby/object:Gem::Version
+  version: 1.0.2
+platform: ruby
+authors:
+- Rich Humphrey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.14.0
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.2
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+description: Adds a few useful RSpec matchers
+email: rich@schrodingersbox.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/spec_cat.rb
+- lib/spec_cat/matchers/eql_file.rb
+- lib/spec_cat/matchers/have_a_spec.rb
+- lib/spec_cat/matchers/include_module.rb
+- lib/spec_cat/railtie.rb
+- lib/spec_cat/version.rb
+- lib/tasks/spec_cat.rake
+homepage: https://github.com/schrodingersbox/spec_cat
+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.2.0
+signing_key: 
+specification_version: 4
+summary: RSpec support library
+test_files: []