domino 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 554cc2cc550cceacec189b1fcab208a2f530c3b4
-  data.tar.gz: 65dd95a5af9bfa19e04e38e3821cb016e01c8594
+  metadata.gz: 668a5c9b60cd2400258480a45f70444913a6c776
+  data.tar.gz: 411bee6d727404291237bd9fa7e286371f413cc4
 SHA512:
-  metadata.gz: 98a53738194cc39ab9734ceeb69209735f84bb7bec6c06f672b6243556bc4d18fa272b7d5a682ac3fc6264b086eb4b2f09dbc9fd0473b46c09575f0096e0f8e0
-  data.tar.gz: a65293c01ae787bc2df87372ad30b88d7f4b50a20156993e6d501493715e8ffd588e7f366ecec01d646eabdf76ea64466008a4cf8e8c610174e173c76ee7cd6a
+  metadata.gz: 4de9f8704851ef5e0f2891f44218db61022a65ec6a1bf11278fb966286a38df418f14b554992614436df2b310674ad454db7eac2aac43fb0ef8f038d69ca6256
+  data.tar.gz: 8812d350512383ba7b3503b3e9d2644e14f81215217caad816120a4ddb3ee106afc4884185f1cf255a6e82189e52a23f0ff29726c1a26bbf06767d597164f215

data/README.md

@@ -7,42 +7,57 @@ View abstraction for integration testing
 To create a basic Domino class, inherit from Domino and
 define a selector and attributes:
 
-    module Dom
-      class Post < Domino
-        selector '#posts .post'
-        attribute :title # selector defaults to .title
-        attribute :author_name # selector defaults to .author-name
-        attribute :body, '.post-body' # example of selector override
-
-        # pass a block if you want to modify the value
-        attribute :comments do |text|
-          text.to_i
-        end
-
-        attribute :posted_at do |text|
-          Date.parse(text)
-        end
-      end
+```ruby
+module Dom
+  class Post < Domino
+    selector '#posts .post'
+    attribute :title # selector defaults to .title
+    attribute :author_name # selector defaults to .author-name
+    attribute :body, '.post-body' # example of selector override
+
+    # pass a block if you want to modify the value
+    attribute :comments do |text|
+      text.to_i
     end
 
+    attribute :posted_at do |text|
+      Date.parse(text)
+    end
+  end
+end
+```
+
 Now in your integration test you can use some of Domino's methods:
 
-    assert_equal 4, Dom::Post.count
-    refute_nil Dom::Post.find_by_title('First Post')
+```ruby
+assert_equal 4, Dom::Post.count
+refute_nil Dom::Post.find_by_title('First Post')
+
+# Multiple attributes, returns first match if any
+refute_nil Dom::Post.find_by(title: 'First Post', author: 'Jane Doe')
+
+# Multiple attributes with exception if no match is found
+refute_nil Dom::Post.find_by!(title: 'First Post', author: 'Jane Doe')
+
+# Multiple attributes, returns all matches if any
+assert_equal ["12/06/2014", "12/01/2014"], Dom::Post.where(author: 'Jane Doe').map(&:posted_on)
+```
 
 What makes it really powerful is defining scoped actions:
 
-    module Dom
-      class Post < Domino
-        def delete
-          within(id) { click_button 'Delete' }
-        end
-      end
+```ruby
+module Dom
+  class Post < Domino
+    def delete
+      within(id) { click_button 'Delete' }
     end
+  end
+end
 
-    refute_nil Dom::Post.find_by_title('First Post')
-    Dom::Post.find_by_title('First Post').delete
-    assert_nil Dom::Post.find_by_title('First Post')
+refute_nil Dom::Post.find_by_title('First Post')
+Dom::Post.find_by_title('First Post').delete
+assert_nil Dom::Post.find_by_title('First Post')
+```
 
 ## Integration with capybara
 
@@ -50,15 +65,17 @@ Domino uses capybara internally to search html for nodes and
 attributes. If you need to do something special, you can have direct
 access to the capybara node.
 
-    module Dom
-      class Account < Domino
-        selector "#accounts li"
-        # Returns this node text
-        def text
-            node.text
-        end
-      end
+```ruby
+module Dom
+  class Account < Domino
+    selector "#accounts li"
+    # Returns this node text
+    def text
+        node.text
     end
+  end
+end
+```
 
 For more information about using Capybara nodes, check [Capybara Documentation](https://github.com/jnicklas/capybara/blob/master/README.rdoc).
 
@@ -69,12 +86,16 @@ necessary to wait for elements to appear. Note that the following code
 simply collects all `Account` dominos currently on the page and
 returns the first:
 
-    Dom::Account.first # returns nil if account is displayed asynchronously
+```ruby
+Dom::Account.first # returns nil if account is displayed asynchronously
+```
 
 When you are waiting for a unique domino to appear, you can instead
 use the `find!` method:
 
-    Dom::Account.find! # waits for matching element to appear
+```ruby
+Dom::Account.find! # waits for matching element to appear
+```
 
 If no matching element appears, Capybara will raise an error telling
 you about the expected selector.  Depending on the
@@ -91,7 +112,9 @@ Use them in your steps.
 
 Include "domino" in your Gemfile if using bundler, or simply
 
-    require 'domino'
+```ruby
+require 'domino'
+```
 
 If you're not using Bundler.
 

data/domino.gemspec

@@ -1,7 +1,7 @@
 # -*- encoding: utf-8 -*-
 Gem::Specification.new do |gem|
   gem.name = "domino"
-  gem.version = "0.6.0"
+  gem.version = "0.7.0"
   gem.platform = Gem::Platform::RUBY
   gem.authors = ["Nick Gauthier"]
   gem.email = ["ngauthier@gmail.com"]

data/lib/domino.rb

@@ -1,4 +1,5 @@
 require 'capybara/dsl'
+require 'set'
 # To create a basic Domino class, inherit from Domino and
 # define a selector and attributes:
 #
@@ -65,12 +66,29 @@ class Domino
     # support asynchronous behavior, this method waits for a matching
     # node to appear.
     def find!
-      if @selector.nil?
-        raise Domino::Error.new("You must define a selector")
-      end
+      require_selector!
       new(Capybara.current_session.find(@selector))
     end
 
+    # Returns Domino for capybara node matching all attributes.
+    def find_by(attributes)
+      where(attributes).first
+    end
+
+    # Returns Domino for capybara node matching all attributes.
+    #
+    # Raises an error if no matching node is found.
+    def find_by!(attributes)
+      find_by(attributes) or raise Capybara::ElementNotFound
+    end
+
+    # Returns collection of Dominos for capybara node matching all attributes.
+    def where(attributes)
+      select do |node|
+        attributes.to_set.subset?(node.attributes.to_set)
+      end
+    end
+
     # Define the selector for this Domino
     #
     #   module Dom
@@ -130,9 +148,7 @@ class Domino
 
     # Return capybara nodes for this object
     def nodes
-      if @selector.nil?
-        raise Domino::Error.new("You must define a selector")
-      end
+      require_selector!
       Capybara.current_session.all(@selector)
     end
 
@@ -140,6 +156,10 @@ class Domino
     def find_by_attribute(selector, value)
       detect{|node| value === node.attribute(selector) }
     end
+
+    def require_selector!(&block)
+      raise Domino::Error.new("You must define a selector") if @selector.nil?
+    end
   end
 
   # Get the text of the first dom element matching a selector

data/test/domino_test.rb

@@ -159,4 +159,56 @@ class DominoTest < MiniTest::Unit::TestCase
       Dom::NoSelector.find!
     end
   end
+
+  def test_find_by
+    assert_equal 'Alice', Dom::Person.find_by(biography: 'Alice is fun').name
+  end
+
+  def test_find_by_with_multiple_attributes
+    assert_equal 'Alice', Dom::Person.find_by(biography: 'Alice is fun', age: 23, favorite_color: 'Blue').name
+  end
+
+  def test_find_by_without_selector
+    assert_raises Domino::Error do
+      Dom::NoSelector.find_by(foo: "bar")
+    end
+  end
+
+  def test_find_by_bang
+    assert_equal 'Alice', Dom::Person.find_by!(biography: 'Alice is fun').name
+  end
+
+  def test_find_by_bang_with_multiple_attributes
+    assert_equal 'Alice', Dom::Person.find_by!(biography: 'Alice is fun', age: 23, favorite_color: 'Blue').name
+  end
+
+  def test_find_by_bang_without_selector
+    assert_raises Domino::Error do
+      Dom::NoSelector.find_by(foo: "bar")
+    end
+  end
+
+  def test_find_by_bang_without_match
+    assert_raises Capybara::ElementNotFound do
+      Dom::Person.find_by!(foo: "bar")
+    end
+  end
+
+  def test_where_with_single_attribute
+    assert_equal %w(Bob Charlie), Dom::Person.where(favorite_color: "Red").map(&:name)
+  end
+
+  def test_where_with_multiple_attributes
+    assert_equal %w(Alice), Dom::Person.where(age: 23, favorite_color: 'Blue').map(&:name)
+  end
+
+  def test_where_without_match
+    assert_equal [], Dom::Person.where(favorite_color: "Yellow")
+  end
+
+  def test_where_without_selector
+    assert_raises Domino::Error do
+      Dom::NoSelector.where(foo: "bar")
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: domino
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Nick Gauthier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-11 00:00:00.000000000 Z
+date: 2014-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -104,7 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.1
+rubygems_version: 2.4.2
 signing_key: 
 specification_version: 4
 summary: View abstraction for integration testing