br-approvals 0.0.22

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b63647cada9073bef605592e7b020c68a865690f
+  data.tar.gz: fa78ac98c6771a7de12e81d3d100a67c09709552
+SHA512:
+  metadata.gz: fe40cb6326244d6370509a6274f8f12aa9c59bb44b810e505486356113184d8934e7b59cb54f7afae26db120fee8bd714e54c2b6d24274ad095736559cc63cc5
+  data.tar.gz: ee4349658a39c61b03eb309cf1617f93c5a13c9ad7fb3df5fd18c906e4c39568d8b3080551580b270831eb3a54049f6e581f0d100f45318bbc33ed6ea3c32797

data/.gitignore

@@ -0,0 +1,9 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+*.received.txt
+.approvals
+tmp/
+
+ext/Rakefile

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - ruby-head
+  - rbx
+matrix:
+  allow_failures:
+    - rvm: rbx
+before_install:
+  - gem update bundler
+script: bundle exec rspec spec
+cache: bundler

data/CHANGELOG.md

@@ -0,0 +1,71 @@
+# Changelog
+
+### Next Release
+
+* Your contribution here
+
+### v0.0.22 (2015-10-22)
+
+* Fix bug in non-binary comparisons.
+
+### v0.0.21 (2015-10-12)
+
+* [#64](https://github.com/kytrinyx/approvals/pull/64) Silence deprecation warnings - [@tmock12](https://github.com/tmock12)
+* Fixed typos and replaced a deprecated standard library method call.
+
+### v0.0.20 (2015-04-21)
+
+* [#63](https://github.com/kytrinyx/approvals/issues/62) Make CLI --ask compatible with new or old .approval file. - [@kytrinyx](https://github.com/kytrinyx)
+
+### v0.0.19 (2015-04-20)
+
+* [#62](https://github.com/kytrinyx/approvals/issues/62) Fix bug in CLI with --ask option that deletes approval file instead of overwriting it. - [@kytrinyx](https://github.com/kytrinyx)
+
+### v0.0.18 (2015-04-18)
+
+- Greatly improve output on failure (Show the diff even if approved file is missing, don't complain if there's no .approvals file, print diff command before showing each diff for better context, and reverse the order of the arguments to the diff so that the additions/removals make sense). - [@randycoulman](https://github.com/randycoulman)
+- General improvements (fix typos, replace PNG badges with SVG ones) - [@jamonholmgren](https://github.com/jamonholmgren), [@olivierlacan](https://github.com/olivierlacan)
+
+### v0.0.17 (2014-10-10)
+
+- [#55](https://github.com/kytrinyx/approvals/pull/55) Upgrade to RSpec 3.1 - [@Willianvdv](https://github.com/Willianvdv)
+
+### v0.0.16 (2014-05-19)
+
+- General improvements (refactoring, simplify travis build, fix whitespace issues) - [@zph](https://github.com/zph), [@markijbema](https://github.com/markijbema)
+- Ignore trailing whitespace when making assertions. - [@kytrinyx](https://github.com/kytrinyx)
+
+### v0.0.15 (2014-04-05)
+
+- [#46](https://github.com/kytrinyx/approvals/pull/46) Improve handling of malformed HTML. - [@hotgazpacho](https://github.com/hotgazpacho)
+
+### v0.0.14 (2014-04-05)
+
+- [#48](https://github.com/kytrinyx/approvals/pull/48) Fix CLI namespace clash. - [@zph](https://github.com/zph)
+
+### v0.0.13 (2014-03-10)
+
+- Allow verifying hashes and arrays as json. - [@markijbema](https://github.com/markijbema)
+- Add support for RSpec 3.0. - [@markijbema](https://github.com/markijbema)
+- General improvements (documentation, README, refactoring). - [@markijbema](https://github.com/markijbema), [@kytrinyx](https://github.com/kytrinyx)
+
+### v0.0.12 (2014-02-16)
+
+- [#34](https://github.com/kytrinyx/approvals/pull/34) Make default formatter configurable. - [@markijbema](https://github.com/markijbema)
+- Update dependencies, and lock them to major releases.
+- Add a license to the gemspec.
+- Add a default rake task.
+
+### v0.0.11 (2014-02-16)
+
+- [#33](https://github.com/kytrinyx/approvals/pull/33) Append a trailing newline to all approval files. - [@markijbema](https://github.com/markijbema)
+
+### v0.0.10 (2014-01-30)
+
+- [#9](https://github.com/kytrinyx/approvals/pull/9) Add option to let RSpec handle diffing when approval fails. - [@jeremyruppel](https://github.com/jeremyruppel)
+- [#19](https://github.com/kytrinyx/approvals/pull/19) Switch rspec fail_with args so diff is correct. - [@bmarini](https://github.com/bmarini)
+- Fix build, clean up specs, add badges, add CHANGELOG, fix warnings. - [@markijbema](https://github.com/markijbema)
+
+### v0.0.9 (2013-10-08)
+
+Before this version, no changelog was maintained

data/Gemfile

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in rspec-approvals.gemspec
+gemspec
+
+gem 'rubysl', '~> 2.0', :platform => :rbx

data/License.txt

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2011 Katrina Owen
+
+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,263 @@
+# Approvals
+
+[![Build Status](https://secure.travis-ci.org/kytrinyx/approvals.svg?branch=master)](http://travis-ci.org/kytrinyx/approvals)
+[![Gem Version](https://badge.fury.io/rb/approvals.svg)](http://badge.fury.io/rb/approvals)
+[![Code Climate](https://codeclimate.com/github/kytrinyx/approvals.svg)](https://codeclimate.com/github/kytrinyx/approvals)
+[![Gemnasium](https://gemnasium.com/kytrinyx/approvals.svg)](https://gemnasium.com/kytrinyx/approvals)
+
+
+Approvals are based on the idea of the *_golden master_*.
+
+You take a snapshot of an object, and then compare all future
+versions of the object to the snapshot.
+
+Big hat tip to Llewellyn Falco who developed the approvals concept, as
+well as the original approvals libraries (.NET, Java, Ruby, PHP,
+probably others).
+
+See [ApprovalTests](http://www.approvaltests.com) for videos and additional documentation about the general concept.
+
+Also, check out  Herding Code's [podcast #117](http://t.co/GLn88R5) in
+which Llewellyn Falco is interviewed about approvals.
+
+## Configuration
+
+```ruby
+Approvals.configure do |config|
+  config.approvals_path = 'output/goes/here/'
+end
+```
+
+The default location for the output files is
+
+```plain
+approvals/
+```
+
+## Usage
+
+```ruby
+Approvals.verify(your_subject, :format => :json)
+```
+
+This will raise an `ApprovalError` in the case of a failure.
+
+The first time the approval is run, a file will be created with the contents of the subject of your approval:
+
+    the_name_of_the_approval.received.txt # or .json, .html, .xml as appropriate
+
+Since you have not yet approved anything, the `*.approved` file does not exist, and the comparison will fail.
+
+### Customizing formatted output
+
+The default writer uses the `:to_s` method on the subject to generate the output for the received file.
+For custom complex objects you will need to provide a custom writer to get helpful output, rather than the default:
+
+    #<Object:0x0000010105ea40> # or whatever the object id is
+
+Create a custom writer class somewhere accessible to your test:
+
+```
+class MyCustomWriter < Approvals::Writers::TextWriter
+  def format(data)
+    # Custom data formatting here
+  end
+
+  def filter(data)
+    # Custom data filtering here
+  end
+end
+```
+
+In your test, use a string to reference your custom class:
+
+```
+it "verifies a complex object" do
+  Approvals.verify hello, :format => "MyCustomWriter"
+end
+```
+
+Define and use different custom writers as needed!
+
+## CLI
+
+The gem comes with a command-line tool that makes it easier to manage the
+`*.received.*` and `*.approved.*` files.
+
+The basic usage is:
+
+```bash
+approvals verify
+```
+
+This goes through each approval failure in turn showing you the diff.
+
+The option `--diff` or `-d` configures which difftool to use (for example
+`opendiff`, `vimdiff`, etc). The default value is `diff`.
+
+The option `--ask` or `-a`, which after showing you a diff will offer to
+approve the received file (move it from `*.received.*` to `*.approved.*`.).
+The default is `true`. If you set this to `false`, then nothing happens beyond
+showing you the diff, and you will need to rename files manually.
+
+### Workflow Using VimDiff
+
+I have the following mapped to `<leader>v` in my .vimrc file:
+
+```viml
+map <leader>v :!approvals verify -d vimdiff -a<cr>
+```
+
+I tend to run my tests from within vim with an on-the-fly mapping:
+
+```viml
+:map Q :wa <Bar> :!ruby path/to/test_file.rb<cr>
+```
+
+When I get one or more approval failures, I hit `<leader>v`. This gives me the
+vimdiff.
+
+When I've inspected the result, I hit `:qa` which closes both sides of the
+diff.
+
+Then I'm asked if I want to approve the received file `[yN]`. If there are
+multiple diffs, this handles each failure in turn.
+
+### RSpec
+
+For the moment the only direct integration is with RSpec.
+
+```ruby
+require 'approvals/rspec'
+```
+
+The default directory for output files when using RSpec is
+
+```ruby
+spec/fixtures/approvals/
+```
+
+You can override this:
+
+```ruby
+RSpec.configure do |config|
+  config.approvals_path = 'some/other/path'
+end
+```
+
+The basic format of the approval is modeled after RSpec's `it`:
+
+```ruby
+it 'works' do
+  verify do
+    'this is the the thing you want to verify'
+  end
+end
+```
+
+### Naming
+
+When using RSpec, the namer is set for you, using the example's `full_description`.
+
+```ruby
+Approvals.verify(thing, :name => 'the name of your test')
+```
+
+### Formatting
+
+You can pass a format for your output before it gets written to the file.
+At the moment, only text, xml, html, and json are supported, while text is the default.
+
+Simply add a `:format => :text`, `:format => :xml`, `:format => :html`, or `:format => :json` option to the example:
+
+```ruby
+page = '<html><head></head><body><h1>ZOMG</h1></body></html>'
+Approvals.verify page, :format => :html
+
+data = '{\'beverage\':\'coffee\'}'
+Approvals.verify data, :format => :json
+```
+
+In RSpec, it looks like this:
+
+```ruby
+verify :format => :html do
+  '<html><head></head><body><h1>ZOMG</h1></body></html>'
+end
+
+verify :format => :json do
+  '{\'beverage\':\'coffee\'}'
+end
+```
+
+If you like you could also change the default format globally with:
+
+```ruby
+RSpec.configure do |config|
+  config.approvals_default_format = :json # or :xml, :html
+end
+```
+
+### Exclude dynamically changed values from json
+
+```ruby
+Approvals.configure do |config|
+  config.excluded_json_keys = {
+    :id =>/(\A|_)id$/,
+    :date => /_at$/
+  }
+end
+```
+
+It will replace values with placeholders:
+
+    {id: 5, created_at: "2013-08-29 13:48:08 -0700"}
+
+=>
+
+    {id: "<id>", created_at: "<date>"}
+
+### Approving a spec
+
+If the contents of the received file is to your liking, you can approve
+the file by renaming it.
+
+For an example who's full description is `My Spec`:
+
+    mv my_spec.received.txt my_spec.approved.txt
+
+When you rerun the approval, it should now pass.
+
+### Expensive computations
+
+The Executable class allows you to perform expensive operations only when the command to execute it changes.
+
+For example, if you have a SQL query that is very slow, you can create an executable with the actual SQL to be performed.
+
+The first time the spec runs, it will fail, allowing you to inspect the results.
+If this output looks right, approve the query. The next time the spec is run, it will compare only the actual SQL.
+
+If someone changes the query, then the comparison will fail. Both the previously approved command and the received command will be executed so that you can inspect the difference between the results of the two.
+
+```ruby
+executable = Approvals::Executable.new(subject.slow_sql) do |output|
+  # do something on failure
+end
+
+Approvals.verify(executable, :options => :here)
+```
+
+### RSpec executable
+
+There is a convenience wrapper for RSpec that looks like so:
+
+```ruby
+verify do
+  executable(subject.slow_sql) do |command|
+     result = ActiveRecord::Base.connection.execute(command)
+     # do something to display the result
+  end
+end
+```
+
+Copyright (c) 2011 Katrina Owen, released under the MIT license

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new :spec
+
+task default: :spec

data/approvals.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+
+require 'approvals/version'
+
+Gem::Specification.new do |s|
+  s.name        = "br-approvals"
+  s.version     = Approvals::VERSION
+  s.licenses    = ['MIT']
+  s.authors     = ["Katrina Owen"]
+  s.email       = ["katrina.owen@gmail.com"]
+  s.homepage    = ""
+  s.summary     = %q{Approval Tests for Ruby}
+  s.description = %q{Approval Tests for Ruby}
+
+  s.rubyforge_project = "approvals"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {spec}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  s.extensions    << 'ext/mkrf_conf.rb'
+
+  s.add_development_dependency 'rspec', '~> 3.1'
+  s.add_dependency 'thor', '~> 0.18'
+  s.add_dependency 'nokogiri', '~> 1.6'
+  # We also depend on the json gem, but the version we need is
+  # Ruby-version-specific. See `ext/mkrf_conf.rb`.
+end

data/bin/approvals

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'thor'
+require 'approvals/cli'
+
+Approvals::CLI.start
+