approvals 0.0.22 → 0.0.24

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6f444a0aa1c3b1b8adeade0729913ffd0bc77af0
-  data.tar.gz: fcb304998044a0f34fdcf339d3bac514e6175529
+  metadata.gz: 18211b4ae23de30297af8004404da5497abc99b9
+  data.tar.gz: 8f4ed09ce1ad7a43719049363969dc3dcd3a5158
 SHA512:
-  metadata.gz: 0425fc7fab8349a9d762e8f134feebeba3d49c632f2bc3e4dc09df1b35041526acf86a6eda2f98b44b6443c968c2e32778741d984e73632124195f98c666f1ee
-  data.tar.gz: 503eef74aa5ed03cf9591ca43dc771bfc5fde4c5fb2d57bd1823ea7dfab4cbcbd95bebeba4cd1cb448b8fea32bf8bc4909b206fa1934b7eab2c8906170729dfd
+  metadata.gz: 0d093bc47d069b7a70562e71cbcc5588b38cf37a5a8320f1e7df33b2834d27da8644633ccfafd9ac6e09f796257bd2ab8d1e6895c122d4d0183d44d95e394d08
+  data.tar.gz: 64faeb4c33be84e307bc9e27e05476fbf0cb979c702a1480d1885c54d4bd984f832074fe6f2cda179f67b648a8a85475f1e0adfe25a40450c8d5eaeb64d2da54

data/.gitignore

@@ -5,3 +5,5 @@ pkg/*
 *.received.txt
 .approvals
 tmp/
+
+ext/Rakefile

data/.travis.yml

@@ -5,6 +5,11 @@ rvm:
   - 2.0.0
   - 2.1.0
   - ruby-head
-  - rbx-2
+  - rbx
+matrix:
+  allow_failures:
+    - rvm: rbx
+before_install:
+  - gem update bundler
 script: bundle exec rspec spec
 cache: bundler

data/README.md

@@ -23,8 +23,8 @@ which Llewellyn Falco is interviewed about approvals.
 ## Configuration
 
 ```ruby
-Approvals.configure do |c|
-  c.approvals_path = 'output/goes/here/'
+Approvals.configure do |config|
+  config.approvals_path = 'output/goes/here/'
 end
 ```
 
@@ -42,18 +42,43 @@ Approvals.verify(your_subject, :format => :json)
 
 This will raise an `ApprovalError` in the case of a failure.
 
-The default writer uses the `:to_s` method on the subject will be used to generate the output for
-the `received` file. For custom complex objects you will need to override
-`:to_s` to get helpful output, rather than the default:
-
-    #<Object:0x0000010105ea40> # or whatever the object id is
-
 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
@@ -115,17 +140,17 @@ spec/fixtures/approvals/
 You can override this:
 
 ```ruby
-RSpec.configure do |c|
-  c.approvals_path = 'some/other/path'
+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
+it 'works' do
   verify do
-    "this is the the thing you want to verify"
+    'this is the the thing you want to verify'
   end
 end
 ```
@@ -135,21 +160,21 @@ end
 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")
+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.
+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>"
+page = '<html><head></head><body><h1>ZOMG</h1></body></html>'
 Approvals.verify page, :format => :html
 
-data = "{\"beverage\":\"coffee\"}"
+data = '{\'beverage\':\'coffee\'}'
 Approvals.verify data, :format => :json
 ```
 
@@ -157,19 +182,27 @@ In RSpec, it looks like this:
 
 ```ruby
 verify :format => :html do
-  "<html><head></head><body><h1>ZOMG</h1></body></html>"
+  '<html><head></head><body><h1>ZOMG</h1></body></html>'
 end
 
 verify :format => :json do
-  "{\"beverage\":\"coffee\"}"
+  '{\'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 |c|
-  c.excluded_json_keys = {
+Approvals.configure do |config|
+  config.excluded_json_keys = {
     :id =>/(\A|_)id$/,
     :date => /_at$/
   }

data/approvals.gemspec

@@ -9,9 +9,9 @@ Gem::Specification.new do |s|
   s.licenses    = ['MIT']
   s.authors     = ["Katrina Owen"]
   s.email       = ["katrina.owen@gmail.com"]
-  s.homepage    = ""
+  s.homepage    = "https://github.com/kytrinyx/approvals"
   s.summary     = %q{Approval Tests for Ruby}
-  s.description = %q{Approval Tests for Ruby}
+  s.description = %q{A library to make it easier to do golden-master style testing in Ruby}
 
   s.rubyforge_project = "approvals"
 
@@ -19,9 +19,11 @@ Gem::Specification.new do |s|
   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_development_dependency 'json', '~> 1.8'
   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/ext/mkrf_conf.rb

@@ -0,0 +1,22 @@
+require 'rubygems/dependency_installer'
+
+# This is how we can depend on a different version of the same gem for
+# different Ruby versions.
+# See https://en.wikibooks.org/wiki/Ruby_Programming/RubyGems
+
+installer = Gem::DependencyInstaller.new
+
+begin
+  if RUBY_VERSION >= '2.0'
+    installer.install 'json', '~> 2.0'
+  else
+    installer.install 'json', '~> 1.8'
+  end
+rescue
+  exit(1)
+end
+
+# Write fake Rakefile for rake since Makefile isn't used
+File.open(File.join(File.dirname(__FILE__), 'Rakefile'), 'w') do |f|
+  f.write("task :default\n")
+end

data/lib/approvals.rb

@@ -13,6 +13,7 @@ require 'approvals/executable'
 require 'approvals/reporters'
 require 'approvals/filter'
 require 'approvals/writer'
+require 'approvals/verifier'
 require 'approvals/namers/default_namer'
 
 module Approvals

data/lib/approvals/approval.rb

@@ -19,9 +19,9 @@ module Approvals
     # Add a Proc that tests if subject is a kind of format
     IDENTITIES = {
       hash: Proc.new(){|subject|subject.respond_to? :each_pair},
-      array: Proc.new(){|subject|subject.respond_to? :each_with_index},      
+      array: Proc.new(){|subject|subject.respond_to? :each_with_index},
     }
-    
+
     def identify_format
       IDENTITIES.each_pair do |format, id_test|
         return format if id_test.call(subject)
@@ -34,6 +34,10 @@ module Approvals
       @writer ||= Writer.for(@format)
     end
 
+    def verifier
+      @verifier ||= Verifier.for(@format)
+    end
+
     def verify
       unless File.exist?(namer.output_dir)
         FileUtils.mkdir_p(namer.output_dir)
@@ -63,6 +67,10 @@ module Approvals
     BINARY_FORMATS = [:binary]
 
     def received_matches?
+      return verifier
+        .new(received_path, approved_path)
+        .verify if verifier
+
       if BINARY_FORMATS.include?(@format) # Read without ERB
         IO.read(received_path).chomp == IO.read(approved_path).chomp
       else

data/lib/approvals/filter.rb

@@ -16,18 +16,18 @@ module Approvals
     end
 
     def censored value, key=nil
-      case value
-      when Array
-        value.map { |item| censored(item) }
-      when Hash
-        Hash[value.map { |inner_key, inner_value| [inner_key, censored(inner_value, inner_key)] }]
+      if value.nil?
+        nil
+      elsif key && placeholder_for(key)
+        "<#{placeholder_for(key)}>"
       else
-        if value.nil?
-          nil
-        elsif key && placeholder_for(key)
-          "<#{placeholder_for(key)}>"
-        else
-          value
+        case value
+          when Array
+            value.map { |item| censored(item) }
+          when Hash
+            Hash[value.map { |inner_key, inner_value| [inner_key, censored(inner_value, inner_key)] }]
+          else
+            value
         end
       end
     end

data/lib/approvals/verifier.rb

@@ -0,0 +1,15 @@
+require 'approvals/verifiers/json_verifier'
+
+module Approvals
+  module Verifier
+    REGISTRY = {
+      json: Verifiers::JsonVerifier,
+    }
+
+    class << self
+      def for(format)
+        REGISTRY[format]
+      end
+    end
+  end
+end

data/lib/approvals/verifiers/json_verifier.rb

@@ -0,0 +1,26 @@
+module Approvals
+  module Verifiers
+    class JsonVerifier
+      def initialize(received_path, approved_path)
+        self.received_path = received_path
+        self.approved_path = approved_path
+      end
+
+      def verify
+        approved == received
+      end
+
+      private
+
+      attr_accessor :approved_path, :received_path
+
+      def approved
+        JSON.parse(File.read(approved_path))
+      end
+
+      def received
+        JSON.parse(File.read(received_path))
+      end
+    end
+  end
+end

data/lib/approvals/version.rb

@@ -1,3 +1,3 @@
 module Approvals
-  VERSION = '0.0.22'
+  VERSION = '0.0.24'
 end

data/lib/approvals/writer.rb

@@ -16,15 +16,21 @@ module Approvals
       html: Writers::HtmlWriter.new,
       hash: Writers::HashWriter.new,
       array: Writers::ArrayWriter.new,
+      txt: Writers::TextWriter.new,
     }
 
 
     class << self
       def for(format)
-        if REGISTRY.include?(format)
-          REGISTRY[format]
-        else
-          TextWriter.new
+        begin
+          REGISTRY[format] || Object.const_get(format).new
+        rescue NameError => e
+          error = ApprovalError.new(
+            "Approval Error: #{ e }. Please define a custom writer as outlined"\
+            " in README section 'Customizing formatted output': "\
+            "https://github.com/kytrinyx/approvals#customizing-formatted-output"
+          )
+          raise error
         end
       end
     end

data/spec/approvals_spec.rb

@@ -51,6 +51,32 @@ describe Approvals do
     Approvals.verify hello, :namer => namer
   end
 
+  context "custom writer" do
+    let(:hello) { Object.new }
+
+    class MyCustomWriter < Approvals::Writers::TextWriter
+      def format(data)
+        filter(data)
+      end
+
+      def filter(data)
+        data.to_s.chars.reject {|c| c =~ /[a-zA-Z0-9]/}
+      end
+    end
+
+    it "verifies a complex object" do
+      Approvals.verify hello, :namer => namer, :format => "MyCustomWriter"
+    end
+
+    it "raises an error with an uninitialized custom writer class" do
+      expect{
+        Approvals.verify hello, :namer => namer, :format => "UninitializedWriter"
+      }.to raise_error.with_message(
+        /Please define a custom writer as outlined in README section 'Customizing formatted output':/
+      )
+    end
+ end
+
   it "verifies html" do
     html = <<-HTML
     <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd"><html><head><title>Approval</title></head><body><h1>An Approval</h1><p>It has a paragraph</p></body></html>
@@ -79,6 +105,11 @@ describe Approvals do
     Approvals.verify json, :format => :json, :namer => namer
   end
 
+  it "ignores whitespace differences in json" do
+    hash = { foo: {} }
+
+    Approvals.verify hash, :format => :json, :namer => namer
+  end
 
   it "verifies json and is newline agnostic" do
     json = '{"pet":{"species":"turtle","color":"green","name":"Anthony"}}'

data/spec/filter_spec.rb

@@ -74,6 +74,40 @@ describe Approvals::Filter do
     })
   end
 
+  it "filters array keys" do
+    filter = Approvals::Filter.new({foolist: /^foolist$/})
+    input = {
+      foo: 'bar124',
+      foolist: [{foo: 'bar 145', bar: 'foo'}, 'foobar'],
+      nonfoo: 'bar',
+    }
+
+    output = filter.apply(input)
+
+    expect(output).to eq({
+      foo: 'bar124',
+      foolist: '<foolist>',
+      nonfoo: 'bar',
+    })
+  end
+
+  it "filters hash keys" do
+    filter = Approvals::Filter.new({foohash: /^foohash$/})
+    input = {
+      foo: 'bar124',
+      foohash: {foo: 'bar 145', barlist: ['foo', 'bar']},
+      nonfoo: 'bar',
+    }
+
+    output = filter.apply(input)
+
+    expect(output).to eq({
+      foo: 'bar124',
+      foohash: '<foohash>',
+      nonfoo: 'bar',
+    })
+  end
+
   it "takes the last applicable filter" do
     filter = Approvals::Filter.new({foo: /^foo/, bar: /bar$/})
     input = {

data/spec/fixtures/approvals/approvals_custom_writer_verifies_a_complex_object.approved.txt

@@ -0,0 +1 @@
+["#", "<", ":", ">"]

data/spec/fixtures/approvals/approvals_ignores_whitespace_differences_in_json.approved.json

@@ -0,0 +1,6 @@
+{
+  "foo": {
+
+
+  }
+}

data/spec/fixtures/approvals/approvals_verifies_json_with_a_time_object.approved.json

@@ -0,0 +1,3 @@
+{
+  "foo": "2017-01-01 00:00:00 +0100"
+}

data/spec/fixtures/json_approval_with_different_whitespace/approved.json

@@ -0,0 +1,7 @@
+{
+  "foo": {
+  
+  
+  
+  }
+}

data/spec/fixtures/json_approval_with_different_whitespace/received.json

@@ -0,0 +1,3 @@
+{
+  "foo": {}
+}

data/spec/fixtures/json_approval_with_different_whitespace/received_different_content.json

@@ -0,0 +1,3 @@
+{
+  "bar": 1
+}

data/spec/verifiers/json_verifier_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+
+describe Approvals::Verifiers::JsonVerifier do
+  subject(:instance) do
+    described_class.new(received_path, approved_path)
+  end
+
+  context "with same json content but different formatting" do
+    let(:received_path) do
+      "./spec/fixtures/json_approval_with_different_whitespace/received.json"
+    end
+    let(:approved_path) do
+      "./spec/fixtures/json_approval_with_different_whitespace/approved.json"
+    end
+
+    it "passes verification" do
+      expect(instance.verify).to be_truthy
+    end
+  end
+
+  context "with different json content" do
+    let(:received_path) do
+      "./spec/fixtures/json_approval_with_different_whitespace/received_different_content.json"
+    end
+    let(:approved_path) do
+      "./spec/fixtures/json_approval_with_different_whitespace/approved.json"
+    end
+
+    it "does not passe verification" do
+      expect(instance.verify).to be_falsy
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: approvals
 version: !ruby/object:Gem::Version
-  version: 0.0.22
+  version: 0.0.24
 platform: ruby
 authors:
 - Katrina Owen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-22 00:00:00.000000000 Z
+date: 2018-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -24,20 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.1'
-- !ruby/object:Gem::Dependency
-  name: json
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.8'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
@@ -66,12 +52,13 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
-description: Approval Tests for Ruby
+description: A library to make it easier to do golden-master style testing in Ruby
 email:
 - katrina.owen@gmail.com
 executables:
 - approvals
-extensions: []
+extensions:
+- ext/mkrf_conf.rb
 extra_rdoc_files: []
 files:
 - ".gitignore"
@@ -83,6 +70,7 @@ files:
 - Rakefile
 - approvals.gemspec
 - bin/approvals
+- ext/mkrf_conf.rb
 - lib/approvals.rb
 - lib/approvals/approval.rb
 - lib/approvals/cli.rb
@@ -112,6 +100,8 @@ files:
 - lib/approvals/rspec.rb
 - lib/approvals/scrubber.rb
 - lib/approvals/system_command.rb
+- lib/approvals/verifier.rb
+- lib/approvals/verifiers/json_verifier.rb
 - lib/approvals/version.rb
 - lib/approvals/writer.rb
 - lib/approvals/writers/array_writer.rb
@@ -127,6 +117,8 @@ files:
 - spec/executable_spec.rb
 - spec/extensions/rspec_approvals_spec.rb
 - spec/filter_spec.rb
+- spec/fixtures/approvals/approvals_custom_writer_verifies_a_complex_object.approved.txt
+- spec/fixtures/approvals/approvals_ignores_whitespace_differences_in_json.approved.json
 - spec/fixtures/approvals/approvals_passes_approved_files_through_erb.approved.txt
 - spec/fixtures/approvals/approvals_passes_the_received_files_through_erb.approved.txt
 - spec/fixtures/approvals/approvals_supports_excluded_keys_option_also_supports_an_array_of_hashes.approved.json
@@ -143,6 +135,7 @@ files:
 - spec/fixtures/approvals/approvals_verifies_html.approved.html
 - spec/fixtures/approvals/approvals_verifies_json.approved.json
 - spec/fixtures/approvals/approvals_verifies_json_and_is_newline_agnostic.approved.json
+- spec/fixtures/approvals/approvals_verifies_json_with_a_time_object.approved.json
 - spec/fixtures/approvals/approvals_verifies_xml.approved.xml
 - spec/fixtures/approvals/verifications_a_string.approved.txt
 - spec/fixtures/approvals/verifies_a_complex_object.approved.txt
@@ -163,6 +156,9 @@ files:
 - spec/fixtures/approvals/verifies_html.approved.html
 - spec/fixtures/approvals/verifies_json.approved.json
 - spec/fixtures/approvals/verifies_xml.approved.xml
+- spec/fixtures/json_approval_with_different_whitespace/approved.json
+- spec/fixtures/json_approval_with_different_whitespace/received.json
+- spec/fixtures/json_approval_with_different_whitespace/received_different_content.json
 - spec/fixtures/one.png
 - spec/fixtures/one.txt
 - spec/fixtures/two.png
@@ -180,7 +176,8 @@ files:
 - spec/scrubber_spec.rb
 - spec/spec_helper.rb
 - spec/system_command_spec.rb
-homepage: ''
+- spec/verifiers/json_verifier_spec.rb
+homepage: https://github.com/kytrinyx/approvals
 licenses:
 - MIT
 metadata: {}
@@ -200,9 +197,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: approvals
-rubygems_version: 2.2.2
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Approval Tests for Ruby
 test_files: []
-has_rdoc: