elabs_matchers 0.0.3 → 0.0.4

data/.gitignore

@@ -1,4 +1,5 @@
 pkg/*
 *.gem
 .bundle
-.yardoc
+.yardoc
+bundler_stubs

data/Gemfile.lock

@@ -1,18 +1,19 @@
 PATH
   remote: .
   specs:
-    elabs_matchers (0.0.2)
+    elabs_matchers (0.0.3)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    activemodel (3.2.1)
-      activesupport (= 3.2.1)
+    activemodel (3.2.8)
+      activesupport (= 3.2.8)
       builder (~> 3.0.0)
-    activesupport (3.2.1)
+    activesupport (3.2.8)
       i18n (~> 0.6)
       multi_json (~> 1.0)
-    builder (3.0.0)
+    addressable (2.3.2)
+    builder (3.0.3)
     capybara (1.1.2)
       mime-types (>= 1.16)
       nokogiri (>= 1.3.3)
@@ -20,36 +21,45 @@ GEM
       rack-test (>= 0.5.4)
       selenium-webdriver (~> 2.0)
       xpath (~> 0.1.4)
-    childprocess (0.3.0)
-      ffi (~> 1.0.6)
+    childprocess (0.3.5)
+      ffi (~> 1.0, >= 1.0.6)
+    coderay (1.0.6)
     diff-lcs (1.1.3)
-    ffi (1.0.11)
-    i18n (0.6.0)
-    mime-types (1.17.2)
-    multi_json (1.0.4)
-    nokogiri (1.5.0)
+    ffi (1.1.5)
+    i18n (0.6.1)
+    libwebsocket (0.1.5)
+      addressable
+    method_source (0.7.1)
+    mime-types (1.19)
+    multi_json (1.3.6)
+    nokogiri (1.5.5)
+    pry (0.9.9.6)
+      coderay (~> 1.0.5)
+      method_source (~> 0.7.1)
+      slop (>= 2.4.4, < 3)
     rack (1.4.1)
     rack-test (0.6.1)
       rack (>= 1.0)
     rake (0.9.2.2)
-    redcarpet (2.1.0)
-    rspec (2.8.0)
-      rspec-core (~> 2.8.0)
-      rspec-expectations (~> 2.8.0)
-      rspec-mocks (~> 2.8.0)
-    rspec-core (2.8.0)
-    rspec-expectations (2.8.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.8.0)
-    rubyzip (0.9.5)
-    selenium-webdriver (2.18.0)
+    redcarpet (2.1.1)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.3)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.2)
+    rubyzip (0.9.9)
+    selenium-webdriver (2.25.0)
       childprocess (>= 0.2.5)
-      ffi (~> 1.0.9)
-      multi_json (~> 1.0.4)
+      libwebsocket (~> 0.1.3)
+      multi_json (~> 1.0)
       rubyzip
+    slop (2.4.4)
     xpath (0.1.4)
       nokogiri (~> 1.3)
-    yard (0.7.5)
+    yard (0.8.2.1)
 
 PLATFORMS
   ruby
@@ -59,6 +69,7 @@ DEPENDENCIES
   activesupport
   capybara
   elabs_matchers!
+  pry
   rake
   redcarpet
   rspec

data/README.md

@@ -6,76 +6,86 @@ Elabs matchers aims to extend existing rspec matchers from e.g Rspec, Rspec-rail
 of less generic once. This could be things like asserting a table appearing in a certain way or check that
 an active record instance has been successfully persisted after an update.
 
+It is important to know that this gem aims to extend rspec / capybara with more matchers. If functionality in either of theses
+makes any of elabs matchers' matchers obsolete they will be deprecated and removed from elabs matchers.
+
 Below follows a list of matchers that the gem bundles. To get documentation about each matcher the source code is
 your bast friend at this point.
 
+The gem's api should be consider subject to change on any level until version 1.0
+
+## Setup
+
+add elabs_matchers to your Gemfile:
+
+```ruby
+gem "elabs_matchers"
+```
+
 ### Model matchers:
-* hash.contain_hash({ "baz" => "bar" })
-* array.only_include("bar", "foo")
-* record.should persist(:title, "Blog post")
-* record.should allow("Blog post").as(:title)
+```ruby
+record.should allow("Blog post").as(:title)
+hash.contain_hash({ "baz" => "bar" })
+array.only_include("bar", "foo")
+record.should persist(:title, "Blog post")
+```
 
 ### Model helpers:
-* reload(post)
-* save\_and_reload(post)
+```ruby
+reload(post)
+save_and_reload(post)
+```
 
 ### Acceptance matchers:
-* page.should have_options(["Yes", "No"])
-* page.should have\_table_row('Posts', "Title" => "First", :year => "2012")
-* page.should have\_attribute("Status", "Pending")
-* page.should have\_image("Logo")
-* page.should have\_header("Elabs")
-* page.should have\_flash_notice("Success")
-* page.should have\_flash_alert("Error")
-* page.should have\_form\_errors_on("Name", "Can't be blank")
-* page.should have\_fields("Author" => "Adam", "Year" => "2011")
+```ruby
+page.should have_flash_notice("Success")
+page.should have_flash_alert("Error")
+page.should have_form_errors_on("Name", "Can't be blank")
+page.should have_header("Elabs")
+page.should have_image("Logo")
+page.should have_fields("Author" => "Adam", "Year" => "2011")
+page.should have_table_row("Posts", "Title" => "First", :year => "2012")
+page.should have_attribute("Status", "Pending")
+```
 
 ### Acceptance helpers:
-* select\_year\_and_month("2010", "March", :from => "Birth date")
-* sign\_in_as(user)
-* sign_out
+```ruby
+select_year_and_month("2010", "March", :from => "Birth date")
+```
 
 ### Common helpers:
-* select\_year\_and_month("2010", "March", :from => "Birth date")
-* normalize_keys({ "First name" => "Adam" })
-* fixture_file("file.txt")
+```ruby
+normalize_keys({ "First name" => "Adam" })
+fixture_file("file.txt")
+```
 
-## Setup
+## Configuration
 
-add elabs_matchers to your Gemfile:
+Matchers can be configured in e.g your spec_helper.rb-file:
 
 ```ruby
-gem 'elabs_matchers', :git => 'git://github.com/elabs/elabs_matchers.git'
+ElabsMatchers.configure do |config|
+  config.header_selector = "//h1"
+  config.header_selector_type = :xpath
+  config.image_selector = lambda { |src| "img[src='#{src}']" }
+end
 ```
 
-if you're using Spork gem you need to tell bundler not to require the files for you:
+See [elabs_matchers.rb](https://github.com/elabs/elabs_matchers/blob/master/lib/elabs_matchers.rb)
 
-```ruby
-gem 'elabs_matchers', :git => 'git://github.com/elabs/elabs_matchers.git', :require => false
-```
 
-then you'll require them inside your spork prefork block:
+## More
+The gem includes YARD documentation which can be read with any browser.
+The gem's test suite should also serve as detailed documentation for each matcher and helper.
 
-```ruby
-Spork.prefork do
-  ...
-  require 'elabs_matchers'
-  ...
-end
-```
 
 ## Development
 
-```bash
-bundle exec rake
-```
+See [devlopment.txt](https://github.com/elabs/elabs_matchers/blob/master/development.rb)
 
-should run all the gem's specs.
+## Contributors
 
-## TODOS
- * Make yard document rspec matchers
- * Use matcher with RSpec::Matchers:DSL
- * Add contributors
+So far the code base is a joined effort by everyone at Elabs.
 
 ## License:
 
@@ -85,7 +95,7 @@ should run all the gem's specs.
 
  Permission is hereby granted, free of charge, to any person obtaining
  a copy of this software and associated documentation files (the
- 'Software'), to deal in the Software without restriction, including
+ "Software"), to deal in the Software without restriction, including
  without limitation the rights to use, copy, modify, merge, publish,
  distribute, sublicense, and/or sell copies of the Software, and to
  permit persons to whom the Software is furnished to do so, subject to
@@ -94,10 +104,10 @@ should run all the gem's specs.
  The above copyright notice and this permission notice shall be
  included in all copies or substantial portions of the Software.
 
- THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
  IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
  CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
  TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
- SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/development.txt

@@ -0,0 +1,26 @@
+## Setting up:
+#
+1. Fork the gem
+2. Clone you fork to your local machine
+3. Run:
+   gem install bundler
+   bundle install
+   rspec
+
+## Pull requests:
+#
+Pull requests are appreciated. Before submitting please consider the following:
+
+* Public methods are documented.
+* `rake yard` runs without warnings.
+* Matchers are using the "class syntax", that is, not the DSL.
+* Use double quotes ("), not single quotes (') whenever possible.
+  Exceptions are when writing copy, "It's a fine day" and "Expected '#{actual}' to be '#{expected}'." is also fine.
+* When writing matches? methods, consider writing does_not_match? as well.
+  This is important when writing Capybara matchers since failing to do so will cause problems with
+  specs that are rune with asynchronous communication going on (AJAX).
+* Try to follow the pattern of a selector and a selector_type method in each matcher
+* If possible, allow the user to override the selector and selector type using the configure syntax.
+* Test your methods using the same pattern as existing specs.
+
+Thank you for helping out!

data/doc/ElabsMatchers/Helpers/Fixtures.html

@@ -6,7 +6,7 @@
 <title>
   Module: ElabsMatchers::Helpers::Fixtures
   
-    &mdash; Documentation by YARD 0.7.5
+    &mdash; Documentation by YARD 0.8.2.1
   
 </title>
 
@@ -15,10 +15,12 @@
   <link rel="stylesheet" href="../../css/common.css" type="text/css" media="screen" charset="utf-8" />
 
 <script type="text/javascript" charset="utf-8">
-  relpath = '../..';
-  if (relpath != '') relpath += '/';
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '../../';
+  framesUrl = "../../frames.html#!" + escape(window.location.href);
 </script>
 
+
   <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
 
   <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
@@ -26,36 +28,41 @@
 
   </head>
   <body>
-    <script type="text/javascript" charset="utf-8">
-      if (window.top.frames.main) document.body.className = 'frames';
-    </script>
-    
     <div id="header">
       <div id="menu">
   
-    <a href="../../_index.html">Index (F)</a> &raquo; 
+    <a href="../../_index.html">Index (F)</a> &raquo;
     <span class='title'><span class='object_link'><a href="../../ElabsMatchers.html" title="ElabsMatchers (module)">ElabsMatchers</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Helpers.html" title="ElabsMatchers::Helpers (module)">Helpers</a></span></span>
      &raquo; 
     <span class="title">Fixtures</span>
   
-  
+
   <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
 </div>
 
       <div id="search">
   
-    <a id="class_list_link" href="#">Class List</a>
+    <a class="full_list_link" id="class_list_link"
+        href="../../class_list.html">
+      Class List
+    </a>
   
-    <a id="method_list_link" href="#">Method List</a>
+    <a class="full_list_link" id="method_list_link"
+        href="../../method_list.html">
+      Method List
+    </a>
   
-    <a id="file_list_link" href="#">File List</a>
+    <a class="full_list_link" id="file_list_link"
+        href="../../file_list.html">
+      File List
+    </a>
   
 </div>
       <div class="clear"></div>
     </div>
-    
+
     <iframe id="search_frame"></iframe>
-    
+
     <div id="content"><h1>Module: ElabsMatchers::Helpers::Fixtures
   
   
@@ -106,6 +113,7 @@
   
   
   
+  
 
   
     <span class="summary_desc"><div class='inline'>
@@ -122,16 +130,18 @@
 
   <div id="instance_method_details" class="method_details_list">
     <h2>Instance Method Details</h2>
-    
+
     
       <div class="method_details first">
-  <p class="signature first" id="fixture_file-instance_method">
+  <h3 class="signature first" id="fixture_file-instance_method">
   
     - (<tt>Object</tt>) <strong>fixture_file</strong>(path) 
   
 
   
-</p><div class="docstring">
+
+  
+</h3><div class="docstring">
   <div class="discussion">
     
 <p>Opens a file from the fixtures directory.</p>
@@ -142,12 +152,12 @@
   </div>
 </div>
 <div class="tags">
-  <h3>Parameters:</h3>
+  <p class="tag_title">Parameters:</p>
 <ul class="param">
   
     <li>
       
-        <span class='name'>file</span>
+        <span class='name'>path</span>
       
       
         <span class='type'>(<tt>String</tt>)</span>
@@ -156,7 +166,7 @@
       
         &mdash;
         <div class='inline'>
-<p>name      A file name, relative to the fixtures folder.</p>
+<p>A file name, relative to the fixtures folder.</p>
 </div>
       
     </li>
@@ -190,11 +200,11 @@
   </div>
 
 </div>
-    
+
     <div id="footer">
-  Generated on Fri Feb 17 16:29:16 2012 by 
+  Generated on Wed Sep 19 15:04:26 2012 by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
-  0.7.5 (ruby-1.9.3).
+  0.8.2.1 (ruby-1.9.3).
 </div>
 
   </body>

data/doc/ElabsMatchers/Helpers/NormalizeKeys.html

@@ -0,0 +1,222 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>
+  Module: ElabsMatchers::Helpers::NormalizeKeys
+  
+    &mdash; Documentation by YARD 0.8.2.1
+  
+</title>
+
+  <link rel="stylesheet" href="../../css/style.css" type="text/css" media="screen" charset="utf-8" />
+
+  <link rel="stylesheet" href="../../css/common.css" type="text/css" media="screen" charset="utf-8" />
+
+<script type="text/javascript" charset="utf-8">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '../../';
+  framesUrl = "../../frames.html#!" + escape(window.location.href);
+</script>
+
+
+  <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
+
+
+  </head>
+  <body>
+    <div id="header">
+      <div id="menu">
+  
+    <a href="../../_index.html">Index (N)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../../ElabsMatchers.html" title="ElabsMatchers (module)">ElabsMatchers</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Helpers.html" title="ElabsMatchers::Helpers (module)">Helpers</a></span></span>
+     &raquo; 
+    <span class="title">NormalizeKeys</span>
+  
+
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+
+      <div id="search">
+  
+    <a class="full_list_link" id="class_list_link"
+        href="../../class_list.html">
+      Class List
+    </a>
+  
+    <a class="full_list_link" id="method_list_link"
+        href="../../method_list.html">
+      Method List
+    </a>
+  
+    <a class="full_list_link" id="file_list_link"
+        href="../../file_list.html">
+      File List
+    </a>
+  
+</div>
+      <div class="clear"></div>
+    </div>
+
+    <iframe id="search_frame"></iframe>
+
+    <div id="content"><h1>Module: ElabsMatchers::Helpers::NormalizeKeys
+  
+  
+  
+</h1>
+
+<dl class="box">
+  
+  
+    
+  
+    
+  
+  
+  
+    <dt class="r1 last">Defined in:</dt>
+    <dd class="r1 last">lib/elabs_matchers/helpers/normalize_keys.rb</dd>
+  
+</dl>
+<div class="clear"></div>
+
+
+
+
+
+
+
+
+  
+    <h2>
+      Instance Method Summary
+      <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
+    </h2>
+
+    <ul class="summary">
+      
+        <li class="public ">
+  <span class="summary_signature">
+    
+      <a href="#normalize_keys-instance_method" title="#normalize_keys (instance method)">- (Object) <strong>normalize_keys</strong>(hash) </a>
+    
+
+    
+  </span>
+  
+  
+  
+  
+  
+  
+  
+
+  
+    <span class="summary_desc"><div class='inline'>
+<p>Normalizes a hash so that it can be described in a more human friendly
+manner.</p>
+</div></span>
+  
+</li>
+
+      
+    </ul>
+  
+
+
+
+  <div id="instance_method_details" class="method_details_list">
+    <h2>Instance Method Details</h2>
+
+    
+      <div class="method_details first">
+  <h3 class="signature first" id="normalize_keys-instance_method">
+  
+    - (<tt>Object</tt>) <strong>normalize_keys</strong>(hash) 
+  
+
+  
+
+  
+</h3><div class="docstring">
+  <div class="discussion">
+    
+<p>Normalizes a hash so that it can be described in a more human friendly
+manner.</p>
+
+<p>Examples:</p>
+
+<p># Or in a Cucumber table: Given the following people:</p>
+
+<pre class="code ruby"><code>| First name | Last name |
+| Douglas    | Adams     |</code></pre>
+
+
+  </div>
+</div>
+<div class="tags">
+  <p class="tag_title">Parameters:</p>
+<ul class="param">
+  
+    <li>
+      
+        <span class='name'>hash</span>
+      
+      
+        <span class='type'>(<tt>Hash</tt>)</span>
+      
+      
+      
+        &mdash;
+        <div class='inline'>
+<p>A hash of human-friendly key and value pairs.</p>
+</div>
+      
+    </li>
+  
+</ul>
+
+
+</div><table class="source_code">
+  <tr>
+    <td>
+      <pre class="lines">
+
+
+20
+21
+22
+23
+24
+25</pre>
+    </td>
+    <td>
+      <pre class="code"><span class="info file"># File 'lib/elabs_matchers/helpers/normalize_keys.rb', line 20</span>
+
+<span class='kw'>def</span> <span class='id identifier rubyid_normalize_keys'>normalize_keys</span><span class='lparen'>(</span><span class='id identifier rubyid_hash'>hash</span><span class='rparen'>)</span>
+  <span class='id identifier rubyid_hash'>hash</span><span class='period'>.</span><span class='id identifier rubyid_inject'>inject</span><span class='lparen'>(</span><span class='const'>HashWithIndifferentAccess</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='rparen'>)</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_new_hash'>new_hash</span><span class='comma'>,</span> <span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='comma'>,</span> <span class='id identifier rubyid_value'>value</span><span class='rparen'>)</span><span class='op'>|</span>
+    <span class='id identifier rubyid_new_hash'>new_hash</span><span class='lbracket'>[</span><span class='id identifier rubyid_key'>key</span><span class='period'>.</span><span class='id identifier rubyid_parameterize'>parameterize</span><span class='lparen'>(</span><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>_</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_value'>value</span>
+    <span class='id identifier rubyid_new_hash'>new_hash</span>
+  <span class='kw'>end</span>
+<span class='kw'>end</span></pre>
+    </td>
+  </tr>
+</table>
+</div>
+    
+  </div>
+
+</div>
+
+    <div id="footer">
+  Generated on Wed Sep 19 15:04:26 2012 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.2.1 (ruby-1.9.3).
+</div>
+
+  </body>
+</html>