br-approvals 0.0.22

data/spec/fixtures/approvals/verifies_xml.approved.xml

@@ -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/one.txt

@@ -0,0 +1 @@
+one

data/spec/fixtures/two.txt

@@ -0,0 +1 @@
+two

data/spec/namers/default_namer_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+require 'approvals/configuration'
+require 'approvals/namers/default_namer'
+
+describe Approvals::Namers::DefaultNamer do
+
+  subject { Approvals::Namers::DefaultNamer.new("a f!$^%&*(unky name") }
+
+  it "normalizes the name" do
+    expect(subject.name).to eq 'a_funky_name'
+  end
+
+  context "when configured" do
+    before :each do
+      Approvals.configure do |c|
+        c.approvals_path = 'path/to/files/'
+      end
+    end
+
+    after :each do
+      Approvals.configure do |c|
+        c.approvals_path = nil
+      end
+    end
+
+    it "uses the approvals output dir" do
+      expect(subject.output_dir).to eq 'path/to/files/'
+    end
+  end
+
+  it "must have a name" do
+    expect do
+      Approvals::Namers::DefaultNamer.new nil
+    end.to raise_error ArgumentError
+  end
+
+end

data/spec/namers/directory_namer_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+require 'approvals/rspec'
+
+describe Approvals::Namers::DirectoryNamer do
+
+  it "uses non-$%^&*funky example description" do |example|
+    expect(Approvals::Namers::DirectoryNamer.new(example).name).to eq 'approvals_namers_directorynamer/uses_non_funky_example_description'
+  end
+
+  it "has a decent default" do |example|
+    expect(Approvals::Namers::DirectoryNamer.new(example).output_dir).to eq 'spec/fixtures/approvals/'
+  end
+
+  context "when RSpec is configured" do
+    before :each do
+      RSpec.configure do |c|
+        c.approvals_path = 'spec/output/dir/'
+      end
+    end
+
+    after :each do
+      RSpec.configure do |c|
+        c.approvals_path = nil
+      end
+    end
+
+    it "uses the rspec config option" do |example|
+      expect(Approvals::Namers::DirectoryNamer.new(example).output_dir).to eq 'spec/output/dir/'
+    end
+  end
+end

data/spec/namers/rspec_namer_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+describe Approvals::Namers::RSpecNamer do
+
+  it "uses non-$%^&*funky example description" do |example|
+    expect(Approvals::Namers::RSpecNamer.new(example).name).to eq 'approvals_namers_rspecnamer_uses_non_funky_example_description'
+  end
+
+  it "has a decent default" do |example|
+    expect(Approvals::Namers::RSpecNamer.new(example).output_dir).to eq 'spec/fixtures/approvals/'
+  end
+
+  context "when RSpec is configured" do
+    before :each do
+      RSpec.configure do |c|
+        c.approvals_path = 'spec/output/dir/'
+      end
+    end
+
+    after :each do
+      RSpec.configure do |c|
+        c.approvals_path = nil
+      end
+    end
+
+    it "uses the rspec config option" do |example|
+      expect(Approvals::Namers::RSpecNamer.new(example).output_dir).to eq 'spec/output/dir/'
+    end
+  end
+end

data/spec/namers_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+require 'approvals/rspec'
+
+describe Approvals::Namers do
+
+  it "uses the RSpecNamer" do |example|
+    approval = Approvals::Approval.new("naming with rspec namer", :namer => Approvals::Namers::RSpecNamer.new(example))
+    expect(approval.name).to eq("approvals_namers_uses_the_rspecnamer")
+  end
+
+  it "uses the DefaultNamer" do
+    approval = Approvals::Approval.new("naming with default namer", :name => "a name")
+    expect(approval.name).to eq("a_name")
+  end
+
+end

data/spec/reporters/first_working_reporter_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+require 'approvals/reporters/first_working_reporter'
+
+describe Approvals::Reporters::FirstWorkingReporter do
+
+
+  let(:no) { double(:working_in_this_environment? => false) }
+  let(:yes) { double(:working_in_this_environment? => true) }
+  let(:yes_too) { double(:working_in_this_environment? => true) }
+
+  it "when at least one reporter works it is working" do
+    reporter = Approvals::Reporters::FirstWorkingReporter.new(no, yes)
+    expect(reporter).to be_working_in_this_environment
+  end
+
+  it "when no reporters work it's not working" do
+    reporter = Approvals::Reporters::FirstWorkingReporter.new(no, no)
+    expect(reporter).not_to be_working_in_this_environment
+  end
+
+  it "calls the first working reporter" do
+    working = Approvals::Reporters::FirstWorkingReporter.new(no, yes, yes_too)
+
+    expect(no).not_to receive(:report)
+    expect(yes).to receive(:report)
+    expect(yes_too).not_to receive(:report)
+
+    working.report("r", "a")
+  end
+end

data/spec/reporters/html_image_reporter_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+require 'approvals/reporters'
+require 'approvals/scrubber'
+
+describe Approvals::Reporters::HtmlImageReporter do
+
+  subject { Approvals::Reporters::HtmlImageReporter.instance }
+
+  it "creates the template" do
+    scrubber = Approvals::Scrubber.new(subject.html("spec/fixtures/one.png", "spec/fixtures/two.png"))
+    expect(scrubber.to_s).to eq('<html><head><title>Approval</title></head><body><center><table style="text-align: center;" border="1"><tr><td><img src="file://{{current_dir}}/spec/fixtures/one.png"></td><td><img src="file://{{current_dir}}/spec/fixtures/two.png"></td></tr><tr><td>received</td><td>approved</td></tr></table></center></body></html>')
+  end
+
+  # verify "creates the appropriate command", :format => :html do
+  #   reporter = Reporters::HtmlImageReporter.instance
+  #   scrubber = Scrubber.new(reporter.html("spec/fixtures/one.png", "spec/fixtures/two.png"))
+  #   scrubber.to_executable do |html|
+  #     reporter.display(html)
+  #   end
+  # end
+
+end

data/spec/reporters/image_magick_reporter_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+require 'approvals/reporters'
+
+describe Approvals::Reporters::ImageMagickReporter do
+  subject { Approvals::Reporters::ImageMagickReporter.instance }
+
+  it "creates the appropriate command" do
+    result = subject.create_command_line("spec/fixtures/one.png", "spec/fixtures/two.png")
+    expected = "compare spec/fixtures/one.png spec/fixtures/two.png -compose Src x:"
+    if result != expected
+      system(result)
+      system(expected)
+    end
+    expect(result).to eq(expected)
+  end
+end

data/spec/reporters/launcher_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+require 'approvals/reporters/launcher'
+
+describe Approvals::Reporters::Launcher do
+  it "has a vimdiff launcher" do
+    expect(described_class.vimdiff.call('one', 'two')).to eq("vimdiff one two")
+  end
+
+  it "has an opendiff launcher" do
+    expect(described_class.opendiff.call('one', 'two')).to eq("opendiff one two")
+  end
+
+  it "has a diffmerge launcher" do
+    expect(described_class.diffmerge.call('one', 'two')).to match(/DiffMerge.*\"one\"\ \"two\"/)
+  end
+
+  it "has a tortoisediff launcher" do
+    expect(described_class.tortoisediff.call('one', 'two')).to match(/TortoiseMerge.exe.*one.*two/)
+  end
+
+  it "has a filelauncher launcher" do
+    expect(described_class.filelauncher.call('one', 'two')).to eq("open one")
+  end
+end

data/spec/reporters/opendiff_reporter_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe Approvals::Reporters::OpendiffReporter do
+
+  it "has a nice launcher" do
+    skip "Breaks off execution of the tests. Horrible."
+    one = 'spec/fixtures/one.txt'
+    two = 'spec/fixtures/two.txt'
+    executable = Approvals::Executable.new(Approvals::Reporters::OpendiffReporter.instance.launcher.call(one, two)) do |command|
+      Approvals::Reporters::OpendiffReporter.report(one, two)
+    end
+
+    Approvals.verify(executable, :name => 'opendiff launcher')
+  end
+end

data/spec/reporters/reporter_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+require 'approvals/reporters'
+
+describe Approvals::Reporters::Reporter do
+
+  it "is not approved by default" do
+    expect(Approvals::Reporters::Reporter.new).not_to be_approved_when_reported
+  end
+
+  it "takes a launcher" do
+    move = lambda {|received, approved|
+      "echo \"mv #{received} #{approved}\""
+    }
+
+    expect(Approvals::Reporters::Reporter.new(&move).launcher.call('received.txt', 'approved.txt')).to eq("echo \"mv received.txt approved.txt\"")
+  end
+
+  it "defaults to the default OpenDiff launcher" do
+    expect(Approvals::Reporters::Reporter.new.launcher).to eq(Approvals::Reporters::Launcher.opendiff)
+  end
+end

data/spec/scrubber_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+require 'approvals/scrubber'
+
+describe Approvals::Scrubber do
+
+  describe "defaults" do
+    let(:path) { File.expand_path('.') }
+    subject { Approvals::Scrubber.new("I am currently at #{path}") }
+
+    it "has a sensible to_s" do
+      expect(subject.to_s).to eq("I am currently at {{current_dir}}")
+    end
+
+    it "unscrubs" do
+      expect(subject.unscrub).to eq("I am currently at #{path}")
+    end
+
+    it "unscrubs any old string" do
+      expect(subject.unscrub("Hoy, where's {{current_dir}}?")).to eq("Hoy, where's #{path}?")
+    end
+  end
+
+  it "overrides default hash" do
+    expect(Approvals::Scrubber.new("oh, my GAWD", {"deity" => "GAWD"}).to_s).to eq('oh, my {{deity}}')
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'approvals'
+
+# Configure RSpec
+RSpec.configure do |config|
+  # Use color
+  config.color = true
+end

data/spec/system_command_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+require 'approvals/system_command'
+
+describe Approvals::SystemCommand, "#exists?" do
+
+  it "does" do
+    expect(Approvals::SystemCommand.exists?("ls")).to be_truthy
+  end
+
+  it "does not" do
+    expect(Approvals::SystemCommand.exists?("absolutelydoesnotexistonyoursystem")).to be_falsey
+  end
+end

metadata

@@ -0,0 +1,196 @@
+--- !ruby/object:Gem::Specification
+name: br-approvals
+version: !ruby/object:Gem::Version
+  version: 0.0.22
+platform: ruby
+authors:
+- Katrina Owen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.18'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description: Approval Tests for Ruby
+email:
+- katrina.owen@gmail.com
+executables:
+- approvals
+extensions:
+- ext/mkrf_conf.rb
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- License.txt
+- README.md
+- Rakefile
+- approvals.gemspec
+- bin/approvals
+- ext/mkrf_conf.rb
+- lib/approvals.rb
+- lib/approvals/approval.rb
+- lib/approvals/cli.rb
+- lib/approvals/configuration.rb
+- lib/approvals/dotfile.rb
+- lib/approvals/dsl.rb
+- lib/approvals/error.rb
+- lib/approvals/executable.rb
+- lib/approvals/extensions/rspec.rb
+- lib/approvals/extensions/rspec/dsl.rb
+- lib/approvals/filter.rb
+- lib/approvals/namers/default_namer.rb
+- lib/approvals/namers/directory_namer.rb
+- lib/approvals/namers/rspec_namer.rb
+- lib/approvals/reporters.rb
+- lib/approvals/reporters/diff_reporter/diffmerge_reporter.rb
+- lib/approvals/reporters/diff_reporter/opendiff_reporter.rb
+- lib/approvals/reporters/diff_reporter/tortoisediff_reporter.rb
+- lib/approvals/reporters/diff_reporter/vimdiff_reporter.rb
+- lib/approvals/reporters/filelauncher_reporter.rb
+- lib/approvals/reporters/first_working_reporter.rb
+- lib/approvals/reporters/image_reporter.rb
+- lib/approvals/reporters/image_reporter/html_image_reporter.rb
+- lib/approvals/reporters/image_reporter/image_magick_reporter.rb
+- lib/approvals/reporters/launcher.rb
+- lib/approvals/reporters/reporter.rb
+- lib/approvals/rspec.rb
+- lib/approvals/scrubber.rb
+- lib/approvals/system_command.rb
+- lib/approvals/version.rb
+- lib/approvals/writer.rb
+- lib/approvals/writers/array_writer.rb
+- lib/approvals/writers/binary_writer.rb
+- lib/approvals/writers/hash_writer.rb
+- lib/approvals/writers/html_writer.rb
+- lib/approvals/writers/json_writer.rb
+- lib/approvals/writers/text_writer.rb
+- lib/approvals/writers/xml_writer.rb
+- spec/approvals_spec.rb
+- spec/configuration_spec.rb
+- spec/dotfile_spec.rb
+- 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_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
+- spec/fixtures/approvals/approvals_supports_excluded_keys_option_supports_the_array_writer.approved.txt
+- spec/fixtures/approvals/approvals_supports_excluded_keys_option_supports_the_hash_writer.approved.txt
+- spec/fixtures/approvals/approvals_supports_excluded_keys_option_verifies_json_with_excluded_keys.approved.json
+- spec/fixtures/approvals/approvals_verifies_a_complex_object.approved.txt
+- spec/fixtures/approvals/approvals_verifies_a_hash.approved.txt
+- spec/fixtures/approvals/approvals_verifies_a_malformed_html_fragment.approved.html
+- spec/fixtures/approvals/approvals_verifies_a_string.approved.txt
+- spec/fixtures/approvals/approvals_verifies_an_array.approved.txt
+- spec/fixtures/approvals/approvals_verifies_an_array_as_json_when_format_is_set_to_json.approved.json
+- spec/fixtures/approvals/approvals_verifies_an_executable.approved.txt
+- 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_xml.approved.xml
+- spec/fixtures/approvals/verifications_a_string.approved.txt
+- spec/fixtures/approvals/verifies_a_complex_object.approved.txt
+- spec/fixtures/approvals/verifies_a_failure.approved.txt
+- spec/fixtures/approvals/verifies_a_failure_diff.approved.txt
+- spec/fixtures/approvals/verifies_a_string.approved.txt
+- spec/fixtures/approvals/verifies_an_array.approved.txt
+- spec/fixtures/approvals/verifies_an_executable.approved.txt
+- spec/fixtures/approvals/verifies_directory/a_complex_object.approved.txt
+- spec/fixtures/approvals/verifies_directory/a_failure.approved.txt
+- spec/fixtures/approvals/verifies_directory/a_failure_diff.approved.txt
+- spec/fixtures/approvals/verifies_directory/a_string.approved.txt
+- spec/fixtures/approvals/verifies_directory/an_array.approved.txt
+- spec/fixtures/approvals/verifies_directory/an_executable.approved.txt
+- spec/fixtures/approvals/verifies_directory/html.approved.html
+- spec/fixtures/approvals/verifies_directory/json.approved.json
+- spec/fixtures/approvals/verifies_directory/xml.approved.xml
+- spec/fixtures/approvals/verifies_html.approved.html
+- spec/fixtures/approvals/verifies_json.approved.json
+- spec/fixtures/approvals/verifies_xml.approved.xml
+- spec/fixtures/one.png
+- spec/fixtures/one.txt
+- spec/fixtures/two.png
+- spec/fixtures/two.txt
+- spec/namers/default_namer_spec.rb
+- spec/namers/directory_namer_spec.rb
+- spec/namers/rspec_namer_spec.rb
+- spec/namers_spec.rb
+- spec/reporters/first_working_reporter_spec.rb
+- spec/reporters/html_image_reporter_spec.rb
+- spec/reporters/image_magick_reporter_spec.rb
+- spec/reporters/launcher_spec.rb
+- spec/reporters/opendiff_reporter_spec.rb
+- spec/reporters/reporter_spec.rb
+- spec/scrubber_spec.rb
+- spec/spec_helper.rb
+- spec/system_command_spec.rb
+homepage: ''
+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: approvals
+rubygems_version: 2.5.2
+signing_key: 
+specification_version: 4
+summary: Approval Tests for Ruby
+test_files: []