RubyGems - rspec-approvals - Versions diffs - 0.0.3 → 0.0.4 - Mend

rspec-approvals 0.0.3 → 0.0.4

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 (11) hide show

data/README.md +12 -0
data/lib/rspec/approvals/approval.rb +33 -2
data/lib/rspec/approvals/dsl.rb +2 -2
data/lib/rspec/approvals/version.rb +1 -1
data/lib/rspec/approvals.rb +1 -0
data/rspec-approvals.gemspec +1 -0
data/spec/approval_spec.rb +27 -0
data/spec/approvals/rspec_approvals_formats_html_nicely.approved.txt +48 -0
data/spec/approvals/rspec_approvals_formats_xml_nicely.approved.txt +10 -0
data/spec/approvals_spec.rb +10 -0
metadata +18 -3

data/README.md CHANGED Viewed

@@ -53,6 +53,18 @@ empty.
 The contents of the two files are compared, and the approval will fail at this point.
+### Formatting
+You can pass options to format output before it gets written to the file.
+At the moment, only xml and html are supported.
+Simply add a `:format => :xml` or `:format => :html` option to the example:
+    approve "some html", :format => :html do
+      "<html><head></head><body><h1>ZOMG</h1></body></html>"
+    end
 ### Approving a spec
 If the contents of the received file is to your liking, you can approve

data/lib/rspec/approvals/approval.rb CHANGED Viewed

@@ -9,6 +9,7 @@ module RSpec
       def inspect
         ""
       end
+      def strip; end
     end
     class Approval
@@ -23,8 +24,9 @@ module RSpec
       attr_reader :location
-      def initialize(example, received = '')
+      def initialize(example, received = '', options = {})
         @path = Approval.base_path(example.full_description)
+        @options = options
         example.options[:approval] = true
         example.options[:approval_diff_paths] = {
@@ -46,7 +48,11 @@ module RSpec
       def write(suffix, contents)
         File.open("#{@path}.#{suffix}.txt", 'w') do |f|
-          if contents.respond_to?(:each_pair)
+          if xml?
+            parser = XML::Parser.string contents.strip
+            doc = parser.parse
+            f.write doc.to_s
+          elsif contents.respond_to?(:each_pair)
             contents.each_pair do |k,v|
               f.write "#{k.inspect} => #{v.inspect}\n"
             end
@@ -61,6 +67,11 @@ module RSpec
       end
       def failure_message
+        return failure_message_exposing_received if show_received?
+        return default_failure_message
+      end
+      def default_failure_message
         <<-FAILURE_MESSAGE
         Approval Failure:
@@ -80,6 +91,10 @@ module RSpec
         FAILURE_MESSAGE
       end
+      def failure_message_exposing_received
+        default_failure_message << "        received:\n        " << received << "\n\n\n"
+      end
       def location=(backtrace)
         @location = [backtrace.first.gsub(Dir.pwd, '.')]
       end
@@ -91,6 +106,22 @@ module RSpec
           raise RSpec::Approvals::ReceivedDiffersError, failure_message, location
         end
       end
+      def approved
+        File.read(approved_path)
+      end
+      def received
+        File.read(received_path)
+      end
+      def xml?
+        [:xml, :html].include? @options[:format]
+      end
+      def show_received?
+        @options[:show_received]
+      end
     end
   end
 end

data/lib/rspec/approvals/dsl.rb CHANGED Viewed

@@ -4,10 +4,10 @@ module RSpec
   module Approvals
     module DSL
-      def approve(description)
+      def approve(description, options = {})
         specify(description) do
-          approval = Approval.new(example, yield)
+          approval = Approval.new(example, yield, options)
           # We may be able to set file_path and
           # line_number on example in the approval

data/lib/rspec/approvals/version.rb CHANGED Viewed

@@ -1,5 +1,5 @@
 module RSpec
   module Approvals
-    VERSION = "0.0.3"
+    VERSION = "0.0.4"
   end
 end

data/lib/rspec/approvals.rb CHANGED Viewed

@@ -1,4 +1,5 @@
+require 'xml'
 require "rspec/approvals/version"
 require "rspec/approvals/approval"
 require "rspec/approvals/dsl"

data/rspec-approvals.gemspec CHANGED Viewed

@@ -19,4 +19,5 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
   s.add_dependency 'rspec', '~> 2.6'
+  s.add_dependency 'libxml-ruby'
 end

data/spec/approval_spec.rb CHANGED Viewed

@@ -149,6 +149,33 @@ The::Class       \t \r\n \fname
         mv #{approval.received_path} #{approval.approved_path}
+      FAILURE_MESSAGE
+      approval.failure_message.should eq(message)
+    end
+    it "fails with exposed 'received'" do
+      approval = Approvals::Approval.new(example, 'aoeu', :show_received => true)
+      message = <<-FAILURE_MESSAGE
+        Approval Failure:
+        The received contents did not match the approved contents.
+        Inspect the differences in the following files:
+        #{approval.received_path}
+        #{approval.approved_path}
+        If you like what you see in the *.received.txt file, you can approve it
+        by renaming it with the .approved.txt suffix.
+        mv #{approval.received_path} #{approval.approved_path}
+        received:
+        #{approval.received}
       FAILURE_MESSAGE
       approval.failure_message.should eq(message)

data/spec/approvals/rspec_approvals_formats_html_nicely.approved.txt ADDED Viewed

@@ -0,0 +1,48 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en">
+  <head>
+    <meta content="text/html; charset=utf-8" http-equiv="Content-Type" />
+    <title>blog</title>
+    <script type="text/javascript" src="/blog/static/jquery-1.1.3.pack.js"></script>
+    <script type="text/javascript" src="/blog/static/blog.js"></script>
+    <link type="text/css" rel="stylesheet" href="/blog/styles.css" media="screen" />
+  </head>
+  <body>
+    <h1 class="header">
+      <a href="/blog/">blog</a>
+    </h1>
+    <div class="content">
+      <h1 class="post_head">
+        <a href="/blog/view/2">Hej</a>
+        <a class="edit_link" href="/blog/edit/2">edit</a>
+      </h1>
+      <p>ASDJlksdjfsld
+    </p>
+      <h2 class="comment_head">
+        <a href="javascript:getComments(2)">See comments (2)</a>
+      </h2>
+      <div id="comments">
+        <h3>tyysen</h3>
+        <p>miljoooner</p>
+        <h3>hej</h3>
+        <p>bulan</p>
+      </div>
+      <h2 class="add_comment_head">
+        <a href="#comment_form">Add comment</a>
+      </h2>
+      <form method="post" name="comment_form" id="comment_form" action="/blog/comment">
+        <label for="post_username">Name</label>
+        <br />
+        <input type="text" name="post_username" />
+        <br />
+        <label for="post_body">Comment</label>
+        <br />
+        <textarea name="post_body"></textarea>
+        <br />
+        <input type="hidden" name="post_id" value="2" />
+        <input type="submit" value="Add comment" />
+      </form>
+    </div>
+  </body>
+</html>

data/spec/approvals/rspec_approvals_formats_xml_nicely.approved.txt ADDED Viewed

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<xml testsdf="dsfsdf">
+  <test/>
+  <node>
+    <content attr="fgsd"/>
+  </node>
+  <node id="2">
+    <content/>
+  </node>
+</xml>

data/spec/approvals_spec.rb CHANGED Viewed

@@ -63,4 +63,14 @@ describe Approvals do
     hello # => output matches hello.inspect
   end
+  approve "formats html nicely", :format => :html, :show_received => true do
+    <<-XML
+    <?xml version="1.0" encoding="UTF-8"?><!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "DTD/xhtml1-strict.dtd"><html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><meta content="text/html; charset=utf-8" http-equiv="Content-Type"/><title>blog</title><script type="text/javascript" src="/blog/static/jquery-1.1.3.pack.js"></script><script type="text/javascript" src="/blog/static/blog.js"></script><link type="text/css" rel="stylesheet" href="/blog/styles.css" media="screen"/></head><body><h1 class="header"><a href="/blog/">blog</a></h1><div class="content"><h1 class="post_head"><a href="/blog/view/2">Hej</a><a class="edit_link" href="/blog/edit/2">edit</a></h1><p>ASDJlksdjfsld
+    </p><h2 class="comment_head"><a href="javascript:getComments(2)">See comments (2)</a></h2><div id="comments"><h3>tyysen</h3><p>miljoooner</p><h3>hej</h3><p>bulan</p></div><h2 class="add_comment_head"><a href="#comment_form">Add comment</a></h2><form method="post" name="comment_form" id="comment_form" action="/blog/comment"><label for="post_username">Name</label><br/><input type="text" name="post_username"/><br/><label for="post_body">Comment</label><br/><textarea name="post_body"></textarea><br/><input type="hidden" name="post_id" value="2"/><input type="submit" value="Add comment"/></form></div></body></html>
+    XML
+  end
+  approve "formats xml nicely", :format => :xml, :show_received => true do
+    "<xml testsdf=\"dsfsdf\"><test/><node><content attr='fgsd' /></node><node id='2'><content /></node></xml>"
+  end
 end

metadata CHANGED Viewed

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments:
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors:
 - Katrina Owen
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
-date: 2011-07-27 00:00:00 +02:00
+date: 2011-07-29 00:00:00 +02:00
 default_executable:
 dependencies:
 - !ruby/object:Gem::Dependency
@@ -31,6 +31,19 @@ dependencies:
         version: "2.6"
   type: :runtime
   version_requirements: *id001
+- !ruby/object:Gem::Dependency
+  name: libxml-ruby
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        segments:
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
 description: An RSpec extension that adds support for approvals. Based on the idea of the Golden Master.
 email:
 - katrina.owen@gmail.com
@@ -58,6 +71,8 @@ files:
 - spec/approvals/rspec_approvals_a_hash.approved.txt
 - spec/approvals/rspec_approvals_a_string.approved.txt
 - spec/approvals/rspec_approvals_an_array.approved.txt
+- spec/approvals/rspec_approvals_formats_html_nicely.approved.txt
+- spec/approvals/rspec_approvals_formats_xml_nicely.approved.txt
 - spec/approvals_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true