RubyGems - approvals - Versions diffs - 0.0.1 - Mend

approvals 0.0.1

Files changed (69) hide show

data/.gitignore +7 -0
data/.travis.yml +4 -0
data/Gemfile +4 -0
data/License.txt +22 -0
data/README.md +133 -0
data/Rakefile +1 -0
data/TODO +2 -0
data/approvals.gemspec +23 -0
data/bin/approvals +9 -0
data/lib/approvals.rb +24 -0
data/lib/approvals/approval.rb +97 -0
data/lib/approvals/configuration.rb +24 -0
data/lib/approvals/dsl.rb +7 -0
data/lib/approvals/error.rb +5 -0
data/lib/approvals/extensions/rspec.rb +11 -0
data/lib/approvals/extensions/rspec/dsl.rb +9 -0
data/lib/approvals/extensions/rspec/example.rb +17 -0
data/lib/approvals/extensions/rspec/example_group.rb +15 -0
data/lib/approvals/namers/default_namer.rb +20 -0
data/lib/approvals/namers/rspec_namer.rb +27 -0
data/lib/approvals/reporters.rb +3 -0
data/lib/approvals/reporters/first_working_reporter.rb +21 -0
data/lib/approvals/reporters/image_reporter.rb +16 -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/utilities.rb +4 -0
data/lib/approvals/utilities/cli.rb +28 -0
data/lib/approvals/utilities/dotfile.rb +38 -0
data/lib/approvals/utilities/executable.rb +14 -0
data/lib/approvals/utilities/scrubber.rb +43 -0
data/lib/approvals/utilities/system_command.rb +13 -0
data/lib/approvals/writer.rb +26 -0
data/lib/approvals/writers.rb +5 -0
data/lib/approvals/writers/array_writer.rb +15 -0
data/lib/approvals/writers/html_writer.rb +15 -0
data/lib/approvals/writers/json_writer.rb +17 -0
data/lib/approvals/writers/text_writer.rb +22 -0
data/lib/approvals/writers/xml_writer.rb +15 -0
data/spec/approvals_spec.rb +64 -0
data/spec/configuration_spec.rb +27 -0
data/spec/extensions/rspec_approvals_spec.rb +49 -0
data/spec/fixtures/approvals/approvals_verifies_a_complex_object.approved.txt +1 -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_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_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_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_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/two.png +0 -0
data/spec/namers/default_namer_spec.rb +35 -0
data/spec/namers/rspec_namer_spec.rb +31 -0
data/spec/namers_spec.rb +16 -0
data/spec/reporters/first_working_reporter_spec.rb +29 -0
data/spec/reporters/html_image_reporter_spec.rb +22 -0
data/spec/reporters/image_magick_reporter_spec.rb +16 -0
data/spec/utilities/dotfile_spec.rb +22 -0
data/spec/utilities/executable_spec.rb +15 -0
data/spec/utilities/scrubber_spec.rb +24 -0
data/spec/utilities/system_command_spec.rb +13 -0
metadata +147 -0

data/spec/configuration_spec.rb ADDED Viewed

@@ -0,0 +1,27 @@
+require 'approvals/configuration'
+describe Approvals::Configuration do
+  it "defaults to 'approvals/'" do
+    Approvals.configuration.approvals_path.should eq('approvals/')
+  end
+  describe "when set" do
+    before(:each) do
+      Approvals.configure do |c|
+        c.approvals_path = 'output/dir/'
+      end
+    end
+    after(:each) do
+      Approvals.configure do |c|
+        c.approvals_path = nil
+      end
+    end
+    it "overrides the output directory" do
+      Approvals.configuration.approvals_path.should eq('output/dir/')
+    end
+  end
+end

data/spec/extensions/rspec_approvals_spec.rb ADDED Viewed

@@ -0,0 +1,49 @@
+require 'approvals'
+describe "Verifies" do
+  verify "a string" do
+    "We have, I fear, confused power with greatness."
+  end
+  verify "an array" do
+    array = [
+      "abc",
+      123,
+      :zomg_fooooood,
+      %w(cheese burger ribs steak bacon)
+    ]
+  end
+  verify "a complex object" do
+    hello = Object.new
+    def hello.to_s
+      "Hello, World!"
+    end
+    def hello.inspect
+      "#<The World Says: Hello!>"
+    end
+    hello
+  end
+  verify "html", :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
+  verify "xml", :format => :xml do
+    xml = "<xml char=\"kiddo\"><node><content name='beatrice' /></node><node aliases='5'><content /></node></xml>"
+  end
+  verify "json", :format => :json do
+    json = '{"pet":{"species":"turtle","color":"green","name":"Anthony"}}'
+  end
+  verify "an executable" do
+    executable('SELECT 1') do |command|
+      puts "your slip is showing (#{command})"
+    end
+  end
+end

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

	@@ -0,0 +1 @@
1	+ #<The World Says: Hello!>

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

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

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

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

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

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

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

@@ -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 Viewed

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

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

@@ -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 Viewed

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

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

	@@ -0,0 +1 @@
1	+ #<The World Says: Hello!>

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

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

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

@@ -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 Viewed

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

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

@@ -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 Viewed

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

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

@@ -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.png ADDED Viewed

Binary file

data/spec/fixtures/two.png ADDED Viewed

Binary file

data/spec/namers/default_namer_spec.rb ADDED Viewed

@@ -0,0 +1,35 @@
+require 'approvals/configuration'
+require 'approvals/namers/default_namer'
+describe Approvals::Namers::DefaultNamer do
+  include Approvals::Namers
+  subject { DefaultNamer.new("a f!$^%&*(unky name") }
+  it "normalizes the name" do
+    subject.name.should 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
+      subject.output_dir.should eq('path/to/files/')
+    end
+  end
+  it "must have a name" do
+    ->{ DefaultNamer.new(nil) }.should raise_error(ArgumentError)
+  end
+end

data/spec/namers/rspec_namer_spec.rb ADDED Viewed

@@ -0,0 +1,31 @@
+require 'approvals'
+describe Approvals::Namers::RSpecNamer do
+  include Approvals::Namers
+  it "uses non-$%^&*funky example description" do
+    RSpecNamer.new(self.example).name.should eq("approvals_namers_rspecnamer_uses_non_funky_example_description")
+  end
+  it "has a decent default" do
+    RSpecNamer.new(self.example).output_dir.should 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
+      RSpecNamer.new(self.example).output_dir.should eq('spec/output/dir/')
+    end
+  end
+end

data/spec/namers_spec.rb ADDED Viewed

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

data/spec/reporters/first_working_reporter_spec.rb ADDED Viewed

@@ -0,0 +1,29 @@
+require 'approvals/reporters/first_working_reporter'
+describe Approvals::Reporters::FirstWorkingReporter do
+  include Approvals::Reporters
+  let(:no) { stub(:working_in_this_environment? => false) }
+  let(:yes) { stub(:working_in_this_environment? => true) }
+  let(:yes_too) { stub(:working_in_this_environment? => true) }
+  context "when at least one reporter works" do
+    subject { FirstWorkingReporter.new(no, yes) }
+    its(:working_in_this_environment?) { should be_true }
+  end
+  context "when no reporters work" do
+    subject { FirstWorkingReporter.new(no, no) }
+    its(:working_in_this_environment?) { should be_false }
+  end
+  it "calls the first working reporter" do
+    working = FirstWorkingReporter.new(no, yes, yes_too)
+    no.should_not_receive(:report)
+    yes.should_receive(:report)
+    yes_too.should_not_receive(:report)
+    working.report("r", "a")
+  end
+end

data/spec/reporters/html_image_reporter_spec.rb ADDED Viewed

@@ -0,0 +1,22 @@
+require 'approvals/reporters'
+require 'approvals/utilities/scrubber'
+describe Approvals::Reporters::HtmlImageReporter do
+  include Approvals
+  subject { Reporters::HtmlImageReporter.instance }
+  it "creates the template" do
+    scrubber = Scrubber.new(subject.html("spec/fixtures/one.png", "spec/fixtures/two.png"))
+    scrubber.to_s.should 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 ADDED Viewed

@@ -0,0 +1,16 @@
+require 'approvals/reporters'
+describe Approvals::Reporters::ImageMagickReporter do
+  include Approvals::Reporters
+  subject { 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
+    result.should eq(expected)
+  end
+end

data/spec/utilities/dotfile_spec.rb ADDED Viewed

@@ -0,0 +1,22 @@
+require 'approvals/utilities/dotfile'
+describe Approvals::Dotfile do
+  include Approvals
+  let(:dotfile) { '/tmp/.approvals' }
+  before(:each) do
+    Dotfile.stub(:path => dotfile)
+    Dotfile.reset
+  end
+  it "appends the text" do
+    Dotfile.append('text')
+    File.readlines(dotfile).map(&:chomp).should eq(['text'])
+  end
+  it "appends the text exactly once" do
+    Dotfile.append('text')
+    Dotfile.append('text')
+    File.readlines(dotfile).map(&:chomp).should eq(['text'])
+  end
+end

data/spec/utilities/executable_spec.rb ADDED Viewed

@@ -0,0 +1,15 @@
+require 'approvals/utilities/executable'
+describe Approvals::Executable do
+  include Approvals
+  subject { Executable.new('SELECT 1') }
+  its(:inspect) { should eq('SELECT 1') }
+  it "takes a block" do
+    executable = Executable.new('SELECT 1') do |command|
+      "execute query: #{command}"
+    end
+    executable.on_failure.call('SELECT 1').should eq('execute query: SELECT 1')
+  end
+end

data/spec/utilities/scrubber_spec.rb ADDED Viewed

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

data/spec/utilities/system_command_spec.rb ADDED Viewed

@@ -0,0 +1,13 @@
+require 'approvals/utilities/system_command'
+describe Approvals::SystemCommand, "#exists?" do
+  include Approvals
+  it "does" do
+    SystemCommand.exists?("ls").should be_true
+  end
+  it "does not" do
+    SystemCommand.exists?("absolutelydoesnotexistonyoursystem").should be_false
+  end
+end

metadata ADDED Viewed

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: approvals
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease:
+platform: ruby
+authors:
+- Katrina Owen
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2012-02-19 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70351267248460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70351267248460
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: &70351267246520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70351267246520
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &70351267200860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70351267200860
+description: Approval Tests for Ruby
+email:
+- katrina.owen@gmail.com
+executables:
+- approvals
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- License.txt
+- README.md
+- Rakefile
+- TODO
+- approvals.gemspec
+- bin/approvals
+- lib/approvals.rb
+- lib/approvals/approval.rb
+- lib/approvals/configuration.rb
+- lib/approvals/dsl.rb
+- lib/approvals/error.rb
+- lib/approvals/extensions/rspec.rb
+- lib/approvals/extensions/rspec/dsl.rb
+- lib/approvals/extensions/rspec/example.rb
+- lib/approvals/extensions/rspec/example_group.rb
+- lib/approvals/namers/default_namer.rb
+- lib/approvals/namers/rspec_namer.rb
+- lib/approvals/reporters.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/utilities.rb
+- lib/approvals/utilities/cli.rb
+- lib/approvals/utilities/dotfile.rb
+- lib/approvals/utilities/executable.rb
+- lib/approvals/utilities/scrubber.rb
+- lib/approvals/utilities/system_command.rb
+- lib/approvals/writer.rb
+- lib/approvals/writers.rb
+- lib/approvals/writers/array_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/extensions/rspec_approvals_spec.rb
+- spec/fixtures/approvals/approvals_verifies_a_complex_object.approved.txt
+- spec/fixtures/approvals/approvals_verifies_a_string.approved.txt
+- spec/fixtures/approvals/approvals_verifies_an_array.approved.txt
+- 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_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_string.approved.txt
+- spec/fixtures/approvals/verifies_an_array.approved.txt
+- spec/fixtures/approvals/verifies_an_executable.approved.txt
+- 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/two.png
+- spec/namers/default_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/utilities/dotfile_spec.rb
+- spec/utilities/executable_spec.rb
+- spec/utilities/scrubber_spec.rb
+- spec/utilities/system_command_spec.rb
+homepage: ''
+licenses: []
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: approvals
+rubygems_version: 1.8.10
+signing_key:
+specification_version: 3
+summary: Approval Tests for Ruby
+test_files: []