approval_tests 0.0.7

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rubygems'
+require 'spec/rake/spectask'
+
+Spec::Rake::SpecTask.new('specs') do |t|
+  t.spec_opts = ["--format", "specdoc", "--colour"]
+  t.spec_files = Dir['spec/**/*_spec.rb'].sort
+end
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "approval_tests"
+    gemspec.summary = "Approval testing library"
+    gemspec.email = "approvaltests@dangilkerson.com"
+    gemspec.homepage = "http://github.com/approvaltests/approval_tests"
+    gemspec.description = "Approval testing library for ruby"
+    gemspec.authors = ["Dan Gilkerson, Llewellyn Falco"]
+    gemspec.rubyforge_project = 'approvaltests'
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.7

data/approval_tests.gemspec

@@ -0,0 +1,68 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{approval_tests}
+  s.version = "0.0.7"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Dan Gilkerson, Llewellyn Falco"]
+  s.date = %q{2009-07-03}
+  s.description = %q{Approval testing library for ruby}
+  s.email = %q{approvaltests@dangilkerson.com}
+  s.extra_rdoc_files = [
+    "README"
+  ]
+  s.files = [
+    "README",
+     "Rakefile",
+     "VERSION",
+     "approval_tests.gemspec",
+     "lib/approval_tests.rb",
+     "lib/approval_tests/approvals.rb",
+     "lib/approval_tests/approvers/file_approver.rb",
+     "lib/approval_tests/extensions/rspec.rb",
+     "lib/approval_tests/namers/rspec_namer.rb",
+     "lib/approval_tests/reporters/diff_reporter.rb",
+     "lib/approval_tests/reporters/quiet_reporter.rb",
+     "lib/approval_tests/reporters/text_mate_reporter.rb",
+     "lib/approval_tests/writers/html_writer.rb",
+     "lib/approval_tests/writers/text_writer.rb",
+     "lib/approval_tests/writers/xml_writer.rb",
+     "spec/a.txt",
+     "spec/approvals_lists_should_show_empty_lists.approved.txt",
+     "spec/approvals_lists_should_write_arrays.approved.txt",
+     "spec/approvals_lists_should_write_maps.approved.txt",
+     "spec/approvals_multiple_describes_should_approve_multiple_describes.approved.txt",
+     "spec/approvals_should_approve_shared_behaviors.approved.txt",
+     "spec/approvals_should_successfully_approve_text.approved.txt",
+     "spec/approvals_spec.rb",
+     "spec/approvals_using_approval_blocks.approved.txt",
+     "spec/approvals_using_approval_blocks_the_last_statement.approved.txt",
+     "spec/approvals_xml_should_be_pretty.approved.txt",
+     "spec/b.txt",
+     "spec/cleanup_reporter.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/approvaltests/approval_tests}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{approvaltests}
+  s.rubygems_version = %q{1.3.4}
+  s.summary = %q{Approval testing library}
+  s.test_files = [
+    "spec/approvals_spec.rb",
+     "spec/cleanup_reporter.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/lib/approval_tests.rb

@@ -0,0 +1,10 @@
+__DIR__ = File.dirname(__FILE__)
+
+$LOAD_PATH.unshift __DIR__ unless
+  $LOAD_PATH.include?(__DIR__) ||
+  $LOAD_PATH.include?(File.expand_path(__DIR__))
+
+require "approval_tests/approvals"
+require "approval_tests/extensions/rspec"
+
+include ApprovalTests::Namers

data/lib/approval_tests/approvals.rb

@@ -0,0 +1,101 @@
+require 'fileutils'
+__DIR__ = File.dirname(__FILE__)
+require "#{__DIR__}/namers/rspec_namer"
+require "#{__DIR__}/approvers/file_approver"
+require "#{__DIR__}/writers/text_writer"
+require "#{__DIR__}/writers/html_writer"
+require "#{__DIR__}/writers/xml_writer"
+require "#{__DIR__}/reporters/quiet_reporter"
+require "#{__DIR__}/reporters/text_mate_reporter"
+require "#{__DIR__}/reporters/diff_reporter"
+#require "#{__DIR__}/reporters/html_reporter"
+
+include ApprovalTests::Approvers
+include ApprovalTests::Writers
+include ApprovalTests::Reporters
+
+module ApprovalTests
+  class ApprovalError < Exception
+    attr_accessor :received_filename
+    attr_accessor :approved_filename
+  end
+  class Approvals
+    class << self
+      def approve_list(label, list)
+        
+        i = -1;
+        format = list.map do |m| 
+          i = i+1
+          "#{label}[#{i}] = #{m} \r"
+        end
+        format = "#{label}.count = 0" if list.empty?
+        approve(format.to_s)
+      end
+      def approve_map(map)
+        out = "";
+        map.each do |key,value| 
+          out += "[#{key}] = #{value} \r"
+        end
+        approve(out)
+      end
+      def approve(data)
+        approve_with_writer(TextWriter.new(data))
+      end
+      
+      def approve_html(data)
+        approve_with_writer(HtmlWriter.new(data))
+      end
+      
+      def approve_xml(data)
+        approve_with_writer(TextWriter.new(XmlWriter.pretty_xml(data)))
+      end
+      
+      def approve_with_writer(writer)
+          approver = FileApprover.new(writer, @namer)
+          if approver.approve()
+            approver.clean_up_after_success()
+          else
+            @reporter = get_default_reporter()
+            approver.report_failure(@reporter)
+
+            if @reporter.approved_when_reported()
+              approver.clean_up_after_sucess()
+            else
+              approver.fail()
+            end
+          end
+      end
+      
+      def namer=(namer)
+        @namer = namer
+      end
+      
+      def namer
+        @namer
+      end
+    
+      def get_default_reporter()
+        @reporters ||= []
+        return @reporters.first() unless @reporters.empty?
+        if defined? Spec::Mate
+          TextMateReporter.instance
+        else
+          QuietReporter.instance
+        end
+      end
+
+      def reporter(reporter)
+        @reporters ||= []
+        @reporters.push(reporter);
+      end
+
+      def unregister_reporter(reporter)
+        @reporters.remove(reporter);
+      end
+
+      def unregister_last_reporter()
+        @reporters.pop() if @reporters
+      end
+    end
+  end
+end

data/lib/approval_tests/approvers/file_approver.rb

@@ -0,0 +1,47 @@
+
+
+module ApprovalTests
+  module Approvers
+    class FileApprover
+      def initialize(writer, namer)
+  			@writer = writer
+  			@namer = namer
+  		end
+  		
+      def approve()
+  			basename = "#{@namer.source_file_path}/#{@namer.approval_name}"
+  			@approved = @writer.get_approval_filename(basename)
+  			@received = @writer.get_received_filename(basename)
+  			@received = @writer.write_received_file(@received)
+
+  			unless File.exists?(@approved)
+  			  @failure = ApprovalError.new("Failed Approval: Approval File \"#{@approved}\" Not Found.")
+  			  @failure.received_filename = @received
+  			  @failure.approved_filename = @approved
+  				return false
+  			end
+
+  			unless FileUtils.cmp(@received, @approved)
+  			  @failure = ApprovalError.new("Failed Approval: Received file #{@received} does not match approved file #{@approved}.")
+  			  @failure.received_filename = @received
+  			  @failure.approved_filename = @approved
+  				return false
+  			end
+
+  			return true
+  		end
+  		
+      def fail()
+        raise @failure
+      end
+      		
+      def report_failure(reporter)
+        reporter.report(@approved, @received);
+      end
+      		
+      def clean_up_after_success()
+        File.delete(@received)
+      end
+    end
+  end
+end

data/lib/approval_tests/extensions/rspec.rb

@@ -0,0 +1,50 @@
+require "#{File.dirname(__FILE__)}/../approvals"
+
+module ApprovalTests
+  module Extensions
+    module RSpec
+      def approve(thing=nil, options={}, backtrace=nil, &implementation)
+        if block_given?
+          approve_description = "#{thing}" 
+        else
+          approve_description = nil
+          result = thing
+        end
+
+        example(approve_description, options) do
+          if block_given?    
+            result = yield implementation
+          end
+          Approvals.approve(result)
+        end
+      end
+      
+      def approve_html(thing=nil, options={}, backtrace=nil, &implementation)
+        if block_given?
+          approve_description = "#{thing}" 
+        else
+          approve_description = nil
+          result = thing
+        end
+
+        example(approve_description, options) do
+          if block_given?    
+            result = yield implementation
+          end
+          Approvals.approve(result, :html)
+        end
+      end
+    end
+  end
+end
+
+Spec::Runner.configure do |config|  
+  config.before(:each) do
+    Approvals.namer = RSpecNamer.new()
+    extra_description = ""
+    extra_description = "_#{self.description}" if !self.description.empty?
+    Approvals.namer.approval_name = "#{self.class.description}#{extra_description}".gsub("/", "__FORWARD_SLASH__");
+    Approvals.namer.source_file_path = File.dirname(self.class.location)
+  end
+  config.extend(ApprovalTests::Extensions::RSpec)
+end

data/lib/approval_tests/namers/rspec_namer.rb

@@ -0,0 +1,22 @@
+module ApprovalTests
+  module Namers
+    class RSpecNamer
+      
+      def approval_name
+        @approval_name
+      end
+      
+      def approval_name=(name)
+        @approval_name = name.downcase.gsub(/ |\./, "_")
+      end
+      
+      def source_file_path
+        @source_file_path ||= File.dirname(File.expand_path(@approval_name))
+      end
+      
+      def source_file_path=(path)
+        @source_file_path = path
+      end
+    end
+  end
+end

data/lib/approval_tests/reporters/diff_reporter.rb

@@ -0,0 +1,18 @@
+require 'singleton'
+
+module ApprovalTests
+  module Reporters
+    class DiffReporter
+      include Singleton
+
+  		def report(approved, received)
+  		   TextWriter.write_file(approved,"")  unless File.exists?(approved)
+        exec "/Applications/DiffMerge.app/Contents/MacOS/DiffMerge --nosplash \"#{received}\" \"#{approved}\""
+      end
+      
+      def approved_when_reported()
+        false 
+      end
+    end
+  end
+end

data/lib/approval_tests/reporters/quiet_reporter.rb

@@ -0,0 +1,21 @@
+require 'singleton'
+
+module ApprovalTests
+  module Reporters
+    class QuietReporter
+      include Singleton
+
+  		def report(approved, received)
+        if RUBY_PLATFORM =~ /mswin32/
+  		    puts "move /Y \"#{received}\" \"#{approved}\""
+  			else
+  			  puts "mv \"#{received}\" \"#{approved}\""
+			  end
+      end
+      
+      def approved_when_reported()
+        false 
+      end
+    end
+  end
+end

data/lib/approval_tests/reporters/text_mate_reporter.rb

@@ -0,0 +1,24 @@
+require 'singleton'
+
+module ApprovalTests
+  module Reporters
+    class TextMateReporter
+      include Singleton
+
+  		def report(approved, received)
+        puts "<script language='JavaScript'>
+              function move(received, approved) {
+                return TextMate.system('mv ' + received + ' ' + approved, null).outputString;
+              }
+              </script>"    
+        puts "<a href='#' onclick='move(\"#{File.expand_path(received)}\",\"#{File.expand_path(approved)}\")'>Approve</a>"
+        puts "<a href='txmt://open?url=file://#{File.expand_path(received)}'>View</a>"
+        puts "<p></p><iframe src='tm-file://#{File.expand_path(received)}' width='100%' frameborder='0' style='border:solid 1px red'></iframe>"
+      end
+      
+      def approved_when_reported()
+        false 
+      end
+    end
+  end
+end

data/lib/approval_tests/writers/html_writer.rb

@@ -0,0 +1,24 @@
+module ApprovalTests
+  module Writers
+    class HtmlWriter
+      def initialize(data)
+        @data = data
+      end
+      
+      def get_approval_filename(basename)
+        basename + ".approved.html"
+      end
+      
+      def get_received_filename(basename)
+        basename + ".received.html"
+      end
+      
+      def write_received_file(received)
+        f = File.new("#{received}", "w+")
+        f.write(@data)
+        f.close()
+        f.path
+      end
+    end
+  end
+end

data/lib/approval_tests/writers/text_writer.rb

@@ -0,0 +1,27 @@
+module ApprovalTests
+  module Writers
+    class TextWriter
+      def initialize(data)
+        @data = data
+      end
+      
+      def get_approval_filename(basename)
+        basename + ".approved.txt"
+      end
+      
+      def get_received_filename(basename)
+        basename + ".received.txt"
+      end
+      
+      def write_received_file(received)
+        TextWriter.write_file(received, @data)
+      end
+      def self.write_file(name, data)
+        f = File.new("#{name}", "w+")
+        f.write(data)
+        f.close()
+        f.path
+      end
+    end
+  end
+end

data/lib/approval_tests/writers/xml_writer.rb

@@ -0,0 +1,81 @@
+require 'rexml/document'
+include REXML
+
+module ApprovalTests
+  module Writers
+    class XmlWriter
+      def initialize(data)
+        @data = data
+      end
+      
+      def get_approval_filename(basename)
+        basename + ".approved.xml"
+      end
+      
+      def get_received_filename(basename)
+        basename + ".received.xml"
+      end
+      
+      def write_received_file(received)
+        f = File.new("#{received}", "w+")
+        f.write(@data)
+        f.close()
+        f.path
+      end
+      class << self
+        def pretty_print(parent_node, itab)
+          buffer = ''
+
+          parent_node.elements.each do |node|
+
+            buffer += ' ' * itab + "<#{node.name}#{get_att_list(node)}"
+
+            if node.to_a.length > 0
+              buffer += ">"
+              if node.text.nil?
+                buffer += "\n"
+                buffer += pretty_print(node,itab+2) 
+                buffer += ' ' * itab + "</#{node.name}>\n"
+              else
+                node_text = node.text.strip
+                if node_text != ''
+                  buffer += node_text 
+                  buffer += "</#{node.name}>\n"        
+                else
+                  buffer += "\n" + pretty_print(node,itab+2) 
+                  buffer += ' ' * itab + "</#{node.name}>\n"        
+                end
+              end
+            else
+              buffer += "/>\n"
+            end
+
+          end
+          buffer
+        end
+
+        def get_att_list(node)
+          att_list = ''
+          node.attributes.each { |attribute, val| att_list += " #{attribute}='#{val}'" }
+          att_list
+        end
+
+        def pretty_xml(xml_string)
+          doc = Document.new(xml_string)
+
+          buffer = ''
+          xml_declaration = doc.to_s.match('<\?.*\?>').to_s
+          buffer += "#{xml_declaration}\n" if not xml_declaration.nil?
+          xml_doctype = doc.to_s.match('<\!.*\">').to_s
+          buffer += "#{xml_doctype}\n" if not xml_doctype.nil?
+          buffer += "<#{doc.root.name}#{get_att_list(doc.root)}"
+          if doc.root.to_a.length > 0
+            buffer +=">\n#{pretty_print(doc.root,2)}</#{doc.root.name}>"
+          else
+            buffer += "/>\n"
+          end
+        end
+      end
+    end
+  end
+end

data/spec/a.txt

@@ -0,0 +1,7 @@
+1
+2
+3
+easy as
+a
+b
+c

data/spec/approvals_lists_should_show_empty_lists.approved.txt

@@ -0,0 +1 @@
+tv.count = 0

data/spec/approvals_lists_should_write_arrays.approved.txt

@@ -0,0 +1 @@
+name[0] = tom 

data/spec/approvals_lists_should_write_maps.approved.txt

@@ -0,0 +1 @@
+[name] = harry 

data/spec/approvals_multiple_describes_should_approve_multiple_describes.approved.txt

@@ -0,0 +1 @@
+multiple describes

data/spec/approvals_should_approve_shared_behaviors.approved.txt

@@ -0,0 +1 @@
+shared behavior test

data/spec/approvals_should_successfully_approve_text.approved.txt

@@ -0,0 +1 @@
+should be approved

data/spec/approvals_spec.rb

@@ -0,0 +1,75 @@
+require File.join(File.dirname(__FILE__), "spec_helper")
+
+shared_examples_for "Shared Behaviors" do
+  it "should approve shared behaviors" do
+    Approvals.approve("shared behavior test")
+  end
+end
+
+describe "Approvals" do 
+  after(:each) do
+    Approvals.unregister_last_reporter()
+  end
+  
+  it_should_behave_like "Shared Behaviors"
+  
+  it "should successfully approve text" do
+    Approvals.approve("should be approved")
+  end
+  
+  it "should raise mismatch error if received does not match approved" do
+    Approvals.reporter(CleanupReporter.new);
+    lambda { Approvals.approve("should fail with mismatch") }.should raise_error(ApprovalError)
+  end
+  
+  it "should raise missing approval error if has not been approved yet" do
+    Approvals.reporter(CleanupReporter.new);
+    lambda { Approvals.approve("should fail with a missing ") }.should raise_error(ApprovalError)
+  end  
+  
+  describe "Multiple describes" do
+    it "should approve multiple describes" do
+      Approvals.approve("multiple describes")
+    end
+  end
+  
+  describe "lists" do
+    it "should write arrays" do
+      Approvals.approve_list("name",["tom","dick","harry"])
+    end
+    it "should show empty lists" do
+      Approvals.approve_list("tv", [])
+    end
+    it "should write maps" do
+      Approvals.approve_map(:name=> "harry", :age => 25, :sex => "male")
+    end
+  end
+  
+  describe "xml" do
+    it "should be pretty" do
+      Approvals.approve_xml('<?xml version="1.0" encoding="ISO-8859-1"?><data><a><b>Bee</b><c>Sea</c></a></data>')
+    end
+  end
+  
+  describe "DiffReporter" do
+    it "should launch" do
+      base = "approval_tests/spec/"
+   #   DiffReporter.instance.report("approval_tests/spec/a.txt", "approval_tests/spec/b.txt")    
+   end 
+     it "should create and launch" do
+        base = "approval_tests/spec/"
+        File.delete("#{base}c.txt") if File.exists?("#{base}c.txt")
+   #     DiffReporter.instance.report("#{base}c.txt", "#{base}a.txt")    
+      end
+  end
+    
+end
+
+
+
+describe "Approvals", "using approval blocks" do
+  approve "the last statement" do
+    "approve this"
+  end
+  
+end

data/spec/approvals_using_approval_blocks.approved.txt

@@ -0,0 +1 @@
+approve this

data/spec/approvals_using_approval_blocks_the_last_statement.approved.txt

@@ -0,0 +1 @@
+approve this

data/spec/approvals_xml_should_be_pretty.approved.txt

@@ -0,0 +1,8 @@
+<?xml version='1.0' encoding='ISO-8859-1'?>
+
+<data>
+  <a>
+    <b>Bee</b>
+    <c>Sea</c>
+  </a>
+</data>

data/spec/b.txt

@@ -0,0 +1,7 @@
+1
+3
+3
+easy as
+b
+b
+b

data/spec/cleanup_reporter.rb

@@ -0,0 +1,9 @@
+class CleanupReporter
+  def report(approved, received)
+		File.delete(received)
+	end
+	
+	def approved_when_reported()
+		false
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'spec'
+
+__DIR__ = File.join(File.dirname(__FILE__))
+$LOAD_PATH.unshift __DIR__ unless
+  $LOAD_PATH.include?(__DIR__) ||
+  $LOAD_PATH.include?(File.expand_path(__DIR__))
+
+require 'cleanup_reporter'
+
+__DIR__ = File.join(__DIR__,  "..", "lib")
+ 
+$LOAD_PATH.unshift __DIR__ unless
+  $LOAD_PATH.include?(__DIR__) ||
+  $LOAD_PATH.include?(File.expand_path(__DIR__))
+
+require 'approval_tests'
+include ApprovalTests

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: approval_tests
+version: !ruby/object:Gem::Version 
+  version: 0.0.7
+platform: ruby
+authors: 
+- Dan Gilkerson, Llewellyn Falco
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-03 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: Approval testing library for ruby
+email: approvaltests@dangilkerson.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- README
+- Rakefile
+- VERSION
+- approval_tests.gemspec
+- lib/approval_tests.rb
+- lib/approval_tests/approvals.rb
+- lib/approval_tests/approvers/file_approver.rb
+- lib/approval_tests/extensions/rspec.rb
+- lib/approval_tests/namers/rspec_namer.rb
+- lib/approval_tests/reporters/diff_reporter.rb
+- lib/approval_tests/reporters/quiet_reporter.rb
+- lib/approval_tests/reporters/text_mate_reporter.rb
+- lib/approval_tests/writers/html_writer.rb
+- lib/approval_tests/writers/text_writer.rb
+- lib/approval_tests/writers/xml_writer.rb
+- spec/a.txt
+- spec/approvals_lists_should_show_empty_lists.approved.txt
+- spec/approvals_lists_should_write_arrays.approved.txt
+- spec/approvals_lists_should_write_maps.approved.txt
+- spec/approvals_multiple_describes_should_approve_multiple_describes.approved.txt
+- spec/approvals_should_approve_shared_behaviors.approved.txt
+- spec/approvals_should_successfully_approve_text.approved.txt
+- spec/approvals_spec.rb
+- spec/approvals_using_approval_blocks.approved.txt
+- spec/approvals_using_approval_blocks_the_last_statement.approved.txt
+- spec/approvals_xml_should_be_pretty.approved.txt
+- spec/b.txt
+- spec/cleanup_reporter.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/approvaltests/approval_tests
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: approvaltests
+rubygems_version: 1.3.4
+signing_key: 
+specification_version: 3
+summary: Approval testing library
+test_files: 
+- spec/approvals_spec.rb
+- spec/cleanup_reporter.rb
+- spec/spec_helper.rb