RubyGems - br-approvals - Versions diffs - 0.0.22 - Mend

br-approvals 0.0.22

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (110) hide show

checksums.yaml +7 -0
data/.gitignore +9 -0
data/.travis.yml +15 -0
data/CHANGELOG.md +71 -0
data/Gemfile +6 -0
data/License.txt +22 -0
data/README.md +263 -0
data/Rakefile +6 -0
data/approvals.gemspec +29 -0
data/bin/approvals +8 -0
data/ext/mkrf_conf.rb +22 -0
data/lib/approvals.rb +33 -0
data/lib/approvals/approval.rb +144 -0
data/lib/approvals/cli.rb +36 -0
data/lib/approvals/configuration.rb +29 -0
data/lib/approvals/dotfile.rb +33 -0
data/lib/approvals/dsl.rb +7 -0
data/lib/approvals/error.rb +21 -0
data/lib/approvals/executable.rb +18 -0
data/lib/approvals/extensions/rspec.rb +13 -0
data/lib/approvals/extensions/rspec/dsl.rb +44 -0
data/lib/approvals/filter.rb +45 -0
data/lib/approvals/namers/default_namer.rb +20 -0
data/lib/approvals/namers/directory_namer.rb +30 -0
data/lib/approvals/namers/rspec_namer.rb +32 -0
data/lib/approvals/reporters.rb +14 -0
data/lib/approvals/reporters/diff_reporter/diffmerge_reporter.rb +18 -0
data/lib/approvals/reporters/diff_reporter/opendiff_reporter.rb +18 -0
data/lib/approvals/reporters/diff_reporter/tortoisediff_reporter.rb +18 -0
data/lib/approvals/reporters/diff_reporter/vimdiff_reporter.rb +18 -0
data/lib/approvals/reporters/filelauncher_reporter.rb +18 -0
data/lib/approvals/reporters/first_working_reporter.rb +21 -0
data/lib/approvals/reporters/image_reporter.rb +13 -0
data/lib/approvals/reporters/image_reporter/html_image_reporter.rb +35 -0
data/lib/approvals/reporters/image_reporter/image_magick_reporter.rb +20 -0
data/lib/approvals/reporters/launcher.rb +49 -0
data/lib/approvals/reporters/reporter.rb +30 -0
data/lib/approvals/rspec.rb +4 -0
data/lib/approvals/scrubber.rb +43 -0
data/lib/approvals/system_command.rb +13 -0
data/lib/approvals/version.rb +3 -0
data/lib/approvals/writer.rb +39 -0
data/lib/approvals/writers/array_writer.rb +17 -0
data/lib/approvals/writers/binary_writer.rb +49 -0
data/lib/approvals/writers/hash_writer.rb +20 -0
data/lib/approvals/writers/html_writer.rb +15 -0
data/lib/approvals/writers/json_writer.rb +31 -0
data/lib/approvals/writers/text_writer.rb +21 -0
data/lib/approvals/writers/xml_writer.rb +15 -0
data/spec/approvals_spec.rb +172 -0
data/spec/configuration_spec.rb +28 -0
data/spec/dotfile_spec.rb +22 -0
data/spec/executable_spec.rb +17 -0
data/spec/extensions/rspec_approvals_spec.rb +105 -0
data/spec/filter_spec.rb +123 -0
data/spec/fixtures/approvals/approvals_custom_writer_verifies_a_complex_object.approved.txt +1 -0
data/spec/fixtures/approvals/approvals_passes_approved_files_through_erb.approved.txt +1 -0
data/spec/fixtures/approvals/approvals_passes_the_received_files_through_erb.approved.txt +1 -0
data/spec/fixtures/approvals/approvals_supports_excluded_keys_option_also_supports_an_array_of_hashes.approved.json +10 -0
data/spec/fixtures/approvals/approvals_supports_excluded_keys_option_supports_the_array_writer.approved.txt +1 -0
data/spec/fixtures/approvals/approvals_supports_excluded_keys_option_supports_the_hash_writer.approved.txt +1 -0
data/spec/fixtures/approvals/approvals_supports_excluded_keys_option_verifies_json_with_excluded_keys.approved.json +8 -0
data/spec/fixtures/approvals/approvals_verifies_a_complex_object.approved.txt +1 -0
data/spec/fixtures/approvals/approvals_verifies_a_hash.approved.txt +6 -0
data/spec/fixtures/approvals/approvals_verifies_a_malformed_html_fragment.approved.html +11 -0
data/spec/fixtures/approvals/approvals_verifies_a_string.approved.txt +1 -0
data/spec/fixtures/approvals/approvals_verifies_an_array.approved.txt +4 -0
data/spec/fixtures/approvals/approvals_verifies_an_array_as_json_when_format_is_set_to_json.approved.json +10 -0
data/spec/fixtures/approvals/approvals_verifies_an_executable.approved.txt +1 -0
data/spec/fixtures/approvals/approvals_verifies_html.approved.html +11 -0
data/spec/fixtures/approvals/approvals_verifies_json.approved.json +7 -0
data/spec/fixtures/approvals/approvals_verifies_json_and_is_newline_agnostic.approved.json +7 -0
data/spec/fixtures/approvals/approvals_verifies_xml.approved.xml +9 -0
data/spec/fixtures/approvals/verifications_a_string.approved.txt +1 -0
data/spec/fixtures/approvals/verifies_a_complex_object.approved.txt +1 -0
data/spec/fixtures/approvals/verifies_a_failure.approved.txt +1 -0
data/spec/fixtures/approvals/verifies_a_failure_diff.approved.txt +1 -0
data/spec/fixtures/approvals/verifies_a_string.approved.txt +1 -0
data/spec/fixtures/approvals/verifies_an_array.approved.txt +4 -0
data/spec/fixtures/approvals/verifies_an_executable.approved.txt +1 -0
data/spec/fixtures/approvals/verifies_directory/a_complex_object.approved.txt +1 -0
data/spec/fixtures/approvals/verifies_directory/a_failure.approved.txt +0 -0
data/spec/fixtures/approvals/verifies_directory/a_failure_diff.approved.txt +0 -0
data/spec/fixtures/approvals/verifies_directory/a_string.approved.txt +1 -0
data/spec/fixtures/approvals/verifies_directory/an_array.approved.txt +4 -0
data/spec/fixtures/approvals/verifies_directory/an_executable.approved.txt +1 -0
data/spec/fixtures/approvals/verifies_directory/html.approved.html +11 -0
data/spec/fixtures/approvals/verifies_directory/json.approved.json +7 -0
data/spec/fixtures/approvals/verifies_directory/xml.approved.xml +9 -0
data/spec/fixtures/approvals/verifies_html.approved.html +11 -0
data/spec/fixtures/approvals/verifies_json.approved.json +7 -0
data/spec/fixtures/approvals/verifies_xml.approved.xml +9 -0
data/spec/fixtures/one.png +0 -0
data/spec/fixtures/one.txt +1 -0
data/spec/fixtures/two.png +0 -0
data/spec/fixtures/two.txt +1 -0
data/spec/namers/default_namer_spec.rb +37 -0
data/spec/namers/directory_namer_spec.rb +31 -0
data/spec/namers/rspec_namer_spec.rb +30 -0
data/spec/namers_spec.rb +16 -0
data/spec/reporters/first_working_reporter_spec.rb +30 -0
data/spec/reporters/html_image_reporter_spec.rb +22 -0
data/spec/reporters/image_magick_reporter_spec.rb +16 -0
data/spec/reporters/launcher_spec.rb +24 -0
data/spec/reporters/opendiff_reporter_spec.rb +15 -0
data/spec/reporters/reporter_spec.rb +21 -0
data/spec/scrubber_spec.rb +26 -0
data/spec/spec_helper.rb +7 -0
data/spec/system_command_spec.rb +13 -0
metadata +196 -0

data/spec/extensions/rspec_approvals_spec.rb ADDED

@@ -0,0 +1,105 @@
+require 'approvals/rspec'
+shared_context 'verify examples' do
+  specify "a string" do
+    verify do
+      "We have, I fear, confused power with greatness."
+    end
+  end
+  specify "an array" do
+    verify do
+      array = [
+        "abc",
+        123,
+        :zomg_fooooood,
+        %w(cheese burger ribs steak bacon)
+      ]
+    end
+  end
+  specify "a complex object" do
+    verify do
+      hello = Object.new
+      def hello.to_s
+        "Hello, World!"
+      end
+      def hello.inspect
+        "#<The World Says: Hello!>"
+      end
+      hello
+    end
+  end
+  specify "html" do
+    verify :format => :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>
+      HTML
+    end
+  end
+  specify "xml" do
+    verify :format => :xml do
+      xml = "<xml char=\"kiddo\"><node><content name='beatrice' /></node><node aliases='5'><content /></node></xml>"
+    end
+  end
+  specify "json" do
+    verify :format => :json do
+      json = '{"pet":{"species":"turtle","color":"green","name":"Anthony"}}'
+    end
+  end
+  specify "an executable" do
+    verify do
+      executable('SELECT 1') do |command|
+        puts "your slip is showing (#{command})"
+      end
+    end
+  end
+  specify "a failure" do
+    expect { verify { 'no.' } }.to raise_error(Approvals::ApprovalError)
+  end
+  specify "a failure diff" do
+    ::RSpec.configuration.diff_on_approval_failure = true
+    expect(::RSpec::Expectations).to receive(:fail_with)
+    verify { 'no.' }
+    ::RSpec.configuration.diff_on_approval_failure = false
+  end
+  specify "a failure diff", :diff_on_approval_failure => true do
+    expect(::RSpec::Expectations).to receive(:fail_with)
+    verify { 'no.' }
+  end
+end
+RSpec.configure do |c|
+  c.after :each do
+    c.approvals_namer_class = nil
+  end
+end
+describe "Verifies" do
+  before :each do
+    RSpec.configure do |c|
+      c.approvals_namer_class = Approvals::Namers::RSpecNamer
+    end
+  end
+  include_context 'verify examples'
+end
+describe "Verifies (directory)" do
+  before :each do
+    RSpec.configure do |c|
+      c.approvals_namer_class = Approvals::Namers::DirectoryNamer
+    end
+  end
+  include_context 'verify examples'
+end

data/spec/filter_spec.rb ADDED

@@ -0,0 +1,123 @@
+require 'spec_helper'
+describe Approvals::Filter do
+  it "When no filters were supplied, it leaves the h_or_a alone" do
+    filter = Approvals::Filter.new({})
+    input = {some: 'hash'}
+    output = filter.apply(input)
+    expect(input).to equal output
+  end
+  it "replaces fields which match a filter" do
+    filter = Approvals::Filter.new({foo: /^_?foo$/})
+    input = {
+      foo: 'bar13',
+      _foo: 'bar27',
+      nonfoo: 'bar',
+    }
+    output = filter.apply(input)
+    expect(output).to eq({
+      foo: '<foo>',
+      _foo: '<foo>',
+      nonfoo: 'bar',
+    })
+  end
+  it "a filter matches, but the value is nil, it does not get replaced" do
+    filter = Approvals::Filter.new({foo: /^foo$/})
+    input = {
+      foo: nil,
+      nonfoo: 'bar',
+    }
+    output = filter.apply(input)
+    expect(output).to eq({
+      foo: nil,
+      nonfoo: 'bar',
+    })
+  end
+  it "a filter matches, and the value is falsey, but not nil, it gets replaced" do
+    filter = Approvals::Filter.new({foo: /^foo$/})
+    input = {
+      foo: false,
+      nonfoo: 'bar',
+    }
+    output = filter.apply(input)
+    expect(output).to eq({
+      foo: "<foo>",
+      nonfoo: 'bar',
+    })
+  end
+  it "filters recursively in hashes and array" do
+    filter = Approvals::Filter.new({foo: /^foo$/})
+    input = {
+      foo: 'bar124',
+      foolist: [{foo: 'bar 145', bar: 'foo'}, 'foobar'],
+      nonfoo: 'bar',
+    }
+    output = filter.apply(input)
+    expect(output).to eq({
+      foo: '<foo>',
+      foolist: [{foo: '<foo>', bar: 'foo'}, 'foobar'],
+      nonfoo: 'bar',
+    })
+  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 = {
+      foobar: 'baz',
+    }
+    output = filter.apply(input)
+    expect(output).to eq({
+      foobar: '<bar>',
+    })
+  end
+end

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

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

data/spec/fixtures/approvals/approvals_passes_approved_files_through_erb.approved.txt ADDED

	@@ -0,0 +1 @@
1	+ We have, I fear, confused power with <%= $what %>.

data/spec/fixtures/approvals/approvals_passes_the_received_files_through_erb.approved.txt ADDED

	@@ -0,0 +1 @@
1	+ <%

data/spec/fixtures/approvals/approvals_supports_excluded_keys_option_also_supports_an_array_of_hashes.approved.json ADDED

@@ -0,0 +1,10 @@
+[
+  {
+    "object": {
+      "id": "<id>",
+      "created_at": "<date>",
+      "name": "test",
+      "deleted_at": null
+    }
+  }
+]

data/spec/fixtures/approvals/approvals_supports_excluded_keys_option_supports_the_array_writer.approved.txt ADDED

	@@ -0,0 +1 @@
1	+ [0] {:object=>{:id=>"<id>", :created_at=>"<date>", :name=>"test", :deleted_at=>nil}}

data/spec/fixtures/approvals/approvals_supports_excluded_keys_option_supports_the_hash_writer.approved.txt ADDED

	@@ -0,0 +1 @@
1	+ [0] [:object, {:id=>"<id>", :created_at=>"<date>", :name=>"test", :deleted_at=>nil}]

data/spec/fixtures/approvals/approvals_supports_excluded_keys_option_verifies_json_with_excluded_keys.approved.json ADDED

@@ -0,0 +1,8 @@
+{
+  "object": {
+    "id": "<id>",
+    "created_at": "<date>",
+    "name": "test",
+    "deleted_at": null
+  }
+}

data/spec/fixtures/approvals/approvals_verifies_a_complex_object.approved.txt ADDED

	@@ -0,0 +1 @@
1	+ Hello, World!

data/spec/fixtures/approvals/approvals_verifies_a_hash.approved.txt ADDED

@@ -0,0 +1,6 @@
+{
+	:meal => "breakfast"
+	:proteins => "90%"
+	:price => 38
+	:delicious => true
+}

data/spec/fixtures/approvals/approvals_verifies_a_malformed_html_fragment.approved.html ADDED

@@ -0,0 +1,11 @@
+<!DOCTYPE html>
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+    <title>Hoi</title>
+    <script async="" defer="defer" src="http://foo.com/bar.js"></script>
+  </head>
+  <body>
+    <h1>yo</h1>
+  </body>
+</html>

data/spec/fixtures/approvals/approvals_verifies_a_string.approved.txt ADDED

	@@ -0,0 +1 @@
1	+ We have, I fear, confused power with greatness.

data/spec/fixtures/approvals/approvals_verifies_an_array.approved.txt ADDED

@@ -0,0 +1,4 @@
+[0] "abc"
+[1] 123
+[2] :zomg_fooooood
+[3] ["cheese", "burger", "ribs", "steak", "bacon"]

data/spec/fixtures/approvals/approvals_verifies_an_array_as_json_when_format_is_set_to_json.approved.json ADDED

@@ -0,0 +1,10 @@
+[
+  {
+    "name": "Alice",
+    "age": 28
+  },
+  {
+    "name": "Bob",
+    "age": 22
+  }
+]

data/spec/fixtures/approvals/approvals_verifies_an_executable.approved.txt ADDED

	@@ -0,0 +1 @@
1	+ SELECT 1

data/spec/fixtures/approvals/approvals_verifies_html.approved.html ADDED

@@ -0,0 +1,11 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+    <title>Approval</title>
+  </head>
+  <body>
+    <h1>An Approval</h1>
+    <p>It has a paragraph</p>
+  </body>
+</html>

data/spec/fixtures/approvals/approvals_verifies_json.approved.json ADDED

@@ -0,0 +1,7 @@
+{
+  "pet": {
+    "species": "turtle",
+    "color": "green",
+    "name": "Anthony"
+  }
+}

data/spec/fixtures/approvals/approvals_verifies_json_and_is_newline_agnostic.approved.json ADDED

@@ -0,0 +1,7 @@
+{
+  "pet": {
+    "species": "turtle",
+    "color": "green",
+    "name": "Anthony"
+  }
+}

data/spec/fixtures/approvals/approvals_verifies_xml.approved.xml ADDED

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<xml char="kiddo">
+  <node>
+    <content name="beatrice"/>
+  </node>
+  <node aliases="5">
+    <content/>
+  </node>
+</xml>

data/spec/fixtures/approvals/verifications_a_string.approved.txt ADDED

	@@ -0,0 +1 @@
1	+ "We have, I fear, confused power with greatness."

data/spec/fixtures/approvals/verifies_a_complex_object.approved.txt ADDED

	@@ -0,0 +1 @@
1	+ Hello, World!

data/spec/fixtures/approvals/verifies_a_failure.approved.txt ADDED

	@@ -0,0 +1 @@
1	+ yes.

data/spec/fixtures/approvals/verifies_a_failure_diff.approved.txt ADDED

	@@ -0,0 +1 @@
1	+ yes.

data/spec/fixtures/approvals/verifies_a_string.approved.txt ADDED

	@@ -0,0 +1 @@
1	+ We have, I fear, confused power with greatness.

data/spec/fixtures/approvals/verifies_an_array.approved.txt ADDED

@@ -0,0 +1,4 @@
+[0] "abc"
+[1] 123
+[2] :zomg_fooooood
+[3] ["cheese", "burger", "ribs", "steak", "bacon"]

data/spec/fixtures/approvals/verifies_an_executable.approved.txt ADDED

	@@ -0,0 +1 @@
1	+ SELECT 1

data/spec/fixtures/approvals/verifies_directory/a_complex_object.approved.txt ADDED

	@@ -0,0 +1 @@
1	+ Hello, World!

data/spec/fixtures/approvals/verifies_directory/a_failure.approved.txt ADDED

File without changes

data/spec/fixtures/approvals/verifies_directory/a_failure_diff.approved.txt ADDED

File without changes

data/spec/fixtures/approvals/verifies_directory/a_string.approved.txt ADDED

	@@ -0,0 +1 @@
1	+ We have, I fear, confused power with greatness.

data/spec/fixtures/approvals/verifies_directory/an_array.approved.txt ADDED

@@ -0,0 +1,4 @@
+[0] "abc"
+[1] 123
+[2] :zomg_fooooood
+[3] ["cheese", "burger", "ribs", "steak", "bacon"]

data/spec/fixtures/approvals/verifies_directory/an_executable.approved.txt ADDED

	@@ -0,0 +1 @@
1	+ SELECT 1

data/spec/fixtures/approvals/verifies_directory/html.approved.html ADDED

@@ -0,0 +1,11 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+    <title>Approval</title>
+  </head>
+  <body>
+    <h1>An Approval</h1>
+    <p>It has a paragraph</p>
+  </body>
+</html>

data/spec/fixtures/approvals/verifies_directory/json.approved.json ADDED

@@ -0,0 +1,7 @@
+{
+  "pet": {
+    "species": "turtle",
+    "color": "green",
+    "name": "Anthony"
+  }
+}

data/spec/fixtures/approvals/verifies_directory/xml.approved.xml ADDED

@@ -0,0 +1,9 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<xml char="kiddo">
+  <node>
+    <content name="beatrice"/>
+  </node>
+  <node aliases="5">
+    <content/>
+  </node>
+</xml>

data/spec/fixtures/approvals/verifies_html.approved.html ADDED

@@ -0,0 +1,11 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+    <title>Approval</title>
+  </head>
+  <body>
+    <h1>An Approval</h1>
+    <p>It has a paragraph</p>
+  </body>
+</html>

data/spec/fixtures/approvals/verifies_json.approved.json ADDED

@@ -0,0 +1,7 @@
+{
+  "pet": {
+    "species": "turtle",
+    "color": "green",
+    "name": "Anthony"
+  }
+}