domino 0.7.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8e011d8bc68c0c8ae737dca7043ba829256b5cb6
-  data.tar.gz: 71e4c55f827b3a608e3ecd754b665ee37dc02cbb
+  metadata.gz: f53dbf7a0e24f6b9fe707570a47a60a4a6dcdfaa
+  data.tar.gz: 783a69aedf7543b0e78c0e64c431ce4165252709
 SHA512:
-  metadata.gz: f4f2e5bd103f116d0f0bc2eedd120536abe9bd9e7aee8b3fb3eaaa592a404b376d6977db952bd4152884d286acd5deff2f8cd62becdbd388f5a60d385741a4a3
-  data.tar.gz: 711b95a1769bb2c17782cb539b76706dbdf1e041444ac3d574c93e6b2e9f83b52de509dfe91e4f91cf2278ce12a0aea02d04c1317bdd634ae76fbd6012d77103
+  metadata.gz: 764cc8f1e20079d75ae4c66ec4266884431498a6ddc853926c3d74df5a836b8d11f45085c847880d716d19ef5ee5ef0cda315b19678b4fa633514d82a8847973
+  data.tar.gz: 61f0c02649ac0a6f6f19937345ee995751f9eca029baecc6c5febc2a66a4a4b095edeccf1279dd4e075de7461cfcd82b01fe5c4c8f18f8d28a7bbaa2891ad407

data/.travis.yml

@@ -3,5 +3,7 @@ rvm:
   - 1.9.3
   - 2.0.0
   - 2.1.2
+  - 2.4.3
+  - 2.5.0
   - jruby
   - ruby

data/README.md

@@ -15,7 +15,7 @@ module Dom
     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
+    # pass a block if you want to convert the value
     attribute :comments do |text|
       text.to_i
     end
@@ -23,6 +23,21 @@ module Dom
     attribute :posted_at do |text|
       Date.parse(text)
     end
+
+    # Combination selector is a boolean that combines with the root node. Boolean.
+    # You can find a post that also has the .active class.
+    attribute :active, "&.active"
+
+
+    # Combination selector for a data attribute. Finds the value of the data attribute
+    # on the root node. You can convert it with a callback like any other attribute.
+    attribute :rating, "&[data-rating]", &:to_i
+
+    # Combination selector for a data attribute with no value set. Must convert to
+    # boolean in the callback.
+    attribute :blah, "&[data-blah]" do |a|
+      !a.nil?
+    end
   end
 end
 ```
@@ -71,7 +86,7 @@ module Dom
     selector "#accounts li"
     # Returns this node text
     def text
-        node.text
+      node.text
     end
   end
 end

data/domino.gemspec

@@ -1,7 +1,7 @@
 # -*- encoding: utf-8 -*-
 Gem::Specification.new do |gem|
   gem.name = "domino"
-  gem.version = "0.7.1"
+  gem.version = "0.8.0"
   gem.platform = Gem::Platform::RUBY
   gem.authors = ["Nick Gauthier"]
   gem.email = ["ngauthier@gmail.com"]
@@ -23,4 +23,3 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency('rake')
   gem.add_development_dependency('simplecov')
 end
-

data/lib/domino.rb

@@ -9,6 +9,12 @@ require 'set'
 #         attribute :title # selector defaults to .title
 #         attribute :body, '.post-body' # example of selector override
 #
+#         # can define attributes on the selected node
+#         attribute :uuid, "&[data-uuid]"
+#
+#         # can define states based on classes of the selected node
+#         attribute :active, "&.active"
+#
 #         # accepts blocks as callbacks these are run only if attribute exists
 #         attribute :comments do |text|
 #           text.to_i
@@ -39,7 +45,7 @@ class Domino
   extend  Capybara::DSL
 
   # Namespaced Domino::Error
-  class Error < StandardError ; end
+  class Error < StandardError; end
 
   # Direct access to the capybara node, in case you need
   # anything special
@@ -57,7 +63,7 @@ class Domino
 
     # Get an array of all the Dominos
     def all
-      map{|node| node}
+      map { |domino| domino }
     end
 
     # Returns Domino for capybara node matching selector.
@@ -79,14 +85,14 @@ class Domino
     #
     # Raises an error if no matching node is found.
     def find_by!(attributes)
-      find_by(attributes) or raise Capybara::ElementNotFound
+      find_by(attributes) || raise(Capybara::ElementNotFound)
     end
 
     # Returns collection of Dominos for capybara node matching all attributes.
     def where(attributes)
-      select do |node|
+      select do |domino|
         attributes.all? do |key, value|
-          node.send(key) == value if node.respond_to?(key)
+          domino.send(key) == value if domino.respond_to?(key)
         end
       end
     end
@@ -103,11 +109,11 @@ class Domino
     end
 
     def attributes
-      @attributes ||= []
+      attribute_definitions.keys
     end
 
-    def callbacks
-      @callbacks ||= {}
+    def attribute_definitions
+      @attribute_definitions ||= {}
     end
 
     # Define an attribute for this Domino
@@ -126,22 +132,16 @@ class Domino
     #   Dom::Post.find_by_title("First Post")
     #   Dom::Post.find_by_title(/^First/)
     def attribute(attribute, selector = nil, &callback)
-      attributes << attribute
-      callbacks[attribute] = callback
+      selector ||= %(.#{attribute.to_s.tr('_', '-')})
 
-      selector ||= %{.#{attribute.to_s.gsub("_", "-")}}
+      attribute_definitions[attribute] = Attribute.new(attribute, selector, &callback)
 
       class_eval %{
         def #{attribute}
-          value = attribute(%{#{selector}})
-          if value && self.class.callbacks[:#{attribute}].is_a?(Proc)
-            self.class.callbacks[:#{attribute}].call(value)
-          else
-            value
-          end
+          self.class.attribute_definitions[:#{attribute}].value(node)
         end
         def self.find_by_#{attribute}(value)
-          find_by_attribute(%{#{selector}}, value)
+          find_by_attribute(:#{attribute}, value)
         end
       }
     end
@@ -155,39 +155,94 @@ class Domino
     end
 
     # Internal method for finding nodes by a selector
-    def find_by_attribute(selector, value)
-      detect{|node| value === node.attribute(selector) }
+    def find_by_attribute(attribute, value)
+      detect do |domino|
+        attribute_definitions[attribute].match_value?(domino.node, value)
+      end
     end
 
-    def require_selector!(&block)
-      raise Domino::Error.new("You must define a selector") if @selector.nil?
+    def require_selector!
+      raise Domino::Error, 'You must define a selector' if @selector.nil?
     end
   end
 
-  # Get the text of the first dom element matching a selector
+  # Get the text of the first dom element matching a selector:
   #
   #   Dom::Post.all.first.attribute('.title')
-  def attribute(selector)
-    @node.find(selector).text
-  rescue Capybara::ElementNotFound
-    nil
+  #
+  # Or get the value of the attribute of this dom element:
+  #
+  #   Dom::Post.all.first.attribute('&[href]')
+  def attribute(selector, &callback)
+    Attribute.new(nil, selector, &callback).value(node)
   end
 
   # Dom id for this object.
   def id
-    @node['id'].nil? ? nil : %{##{@node['id']}}
+    node['id'].nil? ? nil : %(##{node['id']})
   end
 
   def attributes
-    self.class.attributes.inject({}) do |memo, attribute|
+    self.class.attributes.each_with_object({}) do |attribute, memo|
       memo[attribute] = send(attribute)
-      memo
     end
   end
 
   private
+
   # Store the capybara node internally
   def initialize(node)
     @node = node
   end
+
+  class Attribute
+    attr_reader :name, :selector, :callback
+
+    def initialize(name, selector = nil, &callback)
+      @callback = callback
+      @name = name
+      @selector = selector || %(.#{name.to_s.tr('_', '-')})
+    end
+
+    def value(node)
+      val = value_before_typecast(node)
+
+      if val && callback.is_a?(Proc)
+        callback.call(val)
+      else
+        val
+      end
+    end
+
+    # Get the text of the first dom element matching a selector
+    #
+    #   Dom::Post.all.first.attribute('.title')
+    def value_before_typecast(node)
+      if combinator?
+        node[node_attribute_key] || node.matches_css?(combinator)
+      else
+        node.find(selector).text
+      end
+    rescue Capybara::ElementNotFound
+      nil
+    end
+
+    def match_value?(node, value)
+      value === value(node)
+    end
+
+    private
+
+    def combinator?
+      selector[0] == "&".freeze
+    end
+
+    def combinator
+      @combinator ||= selector.sub(/&/, "") if combinator?
+    end
+
+    def node_attribute_key
+      @node_attribute_key ||= combinator.match(/(?<=\[).+?(?=\])/) { |m| m[0] }
+    end
+  end
 end

data/test/domino_test.rb

@@ -8,33 +8,33 @@ require 'minitest/autorun'
 require 'minitest/mock'
 
 class TestApplication
-  def call(env)
-    [200, {"Content-Type" => "text/plain"}, [%{
+  def call(_env)
+    [200, { 'Content-Type' => 'text/plain' }, [%(
         <html>
           <body>
             <h1>Here are people and animals</h1>
             <div id='people'>
-              <div class='person'>
+              <div class='person active' data-rank="1" data-uuid="e94bb2d3-71d2-4efb-abd4-ebc0cb58d19f">
                 <h2 class='name'>Alice</h2>
                 <p class='last-name'>Cooper</p>
                 <p class='bio'>Alice is fun</p>
                 <p class='fav-color'>Blue</p>
                 <p class='age'>23</p>
               </div>
-              <div class='person'>
+              <div class='person' data-rank="3" data-uuid="05bf319e-8d6a-43c2-be37-2dad8ddbe5af">
                 <h2 class='name'>Bob</h2>
                 <p class='last-name'>Marley</p>
                 <p class='bio'>Bob is smart</p>
                 <p class='fav-color'>Red</p>
                 <p class='age'>52</p>
               </div>
-              <div class='person'>
+              <div class='person' data-rank="2" data-uuid="4abcdeff-1d36-44a9-a05e-8fc57564d2c4">
                 <h2 class='name'>Charlie</h2>
                 <p class='last-name'>Murphy</p>
                 <p class='bio'>Charlie is wild</p>
                 <p class='fav-color'>Red</p>
               </div>
-              <div class='person'>
+              <div class='person' data-rank="7" data-blocked data-uuid="2afccde0-5d13-41c7-ab01-7f37fb2fe3ee">
                 <h2 class='name'>Donna</h2>
                 <p class='last-name'>Summer</p>
                 <p class='bio'>Donna is quiet</p>
@@ -46,25 +46,27 @@ class TestApplication
             </div>
           </body>
         </html>
-    }]]
+    )]]
   end
 end
 
 Capybara.app = TestApplication.new
 
-
 class DominoTest < MiniTest::Unit::TestCase
   include Capybara::DSL
   module Dom
     class Person < Domino
       selector '#people .person'
+
       attribute :name
       attribute :last_name
       attribute :biography, '.bio'
       attribute :favorite_color, '.fav-color'
-      attribute :age do |text|
-        text.to_i
-      end
+      attribute :age, &:to_i
+      attribute :rank, '&[data-rank]', &:to_i
+      attribute :active, '&.active'
+      attribute :uuid, '&[data-uuid]'
+      attribute(:blocked, '&[data-blocked]') { |a| !a.nil? }
     end
 
     class Animal < Domino
@@ -95,14 +97,14 @@ class DominoTest < MiniTest::Unit::TestCase
 
     assert_equal 4, Dom::Person.all.size
 
-    red_people = Dom::Person.select{|p| p.favorite_color == 'Red'}
+    red_people = Dom::Person.select { |p| p.favorite_color == 'Red' }
     assert_equal 2, red_people.count
 
     assert_equal(
-      %w(Donna Alice Bob Charlie),
-      Dom::Person.sort{|a,b|
+      %w[Donna Alice Bob Charlie],
+      Dom::Person.sort do |a, b|
         a.favorite_color.to_s <=> b.favorite_color.to_s
-      }.map(&:name)
+      end.map(&:name)
     )
   end
 
@@ -132,16 +134,20 @@ class DominoTest < MiniTest::Unit::TestCase
     assert_equal 'Charlie', Dom::Person.find_by_biography(/wild/).name
   end
 
+  def test_find_by_data_combinator_attribute_regex
+    assert_equal 'Charlie', Dom::Person.find_by_uuid(/abcdef/).name
+  end
+
   def test_node_properties
     assert_equal 'ACME', Dom::Receipt.first.node['data-store']
   end
 
   def test_attributes
-    assert_equal({name: 'Alice', last_name: 'Cooper', biography: 'Alice is fun', favorite_color: 'Blue', age: 23}, Dom::Person.first.attributes)
+    assert_equal({ name: 'Alice', last_name: 'Cooper', biography: 'Alice is fun', favorite_color: 'Blue', age: 23, rank: 1, active: true, uuid: 'e94bb2d3-71d2-4efb-abd4-ebc0cb58d19f', blocked: false }, Dom::Person.first.attributes)
   end
 
   def test_callback
-    assert_equal 23, Dom::Person.find_by_name("Alice").age
+    assert_equal 23, Dom::Person.find_by_name('Alice').age
   end
 
   def test_find_bang
@@ -165,50 +171,74 @@ class DominoTest < MiniTest::Unit::TestCase
   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
+    assert_equal 'Alice', Dom::Person.find_by(biography: 'Alice is fun', age: 23, favorite_color: 'Blue', rank: 1).name
+  end
+
+  def test_find_by_without_match
+    assert_nil Dom::Person.find_by(foo: 'bar')
   end
 
   def test_find_by_without_selector
     assert_raises Domino::Error do
-      Dom::NoSelector.find_by(foo: "bar")
+      Dom::NoSelector.find_by(foo: 'bar')
     end
   end
 
+  def test_find_by_class_combinator_attribute
+    assert_equal 'Alice', Dom::Person.find_by(active: true).name
+  end
+
+  def test_find_by_data_key_combinator_attribute
+    assert_equal 'Donna', Dom::Person.find_by(blocked: true).name
+  end
+
+  def test_find_by_data_combinator_attribute
+    assert_equal 'Charlie', Dom::Person.find_by(rank: 2).name
+  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
+    assert_equal 'Alice', Dom::Person.find_by!(biography: 'Alice is fun', age: 23, favorite_color: 'Blue', rank: 1).name
   end
 
   def test_find_by_bang_without_selector
     assert_raises Domino::Error do
-      Dom::NoSelector.find_by(foo: "bar")
+      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")
+      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)
+    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)
+    assert_equal %w[Alice], Dom::Person.where(age: 23, favorite_color: 'Blue').map(&:name)
+  end
+
+  def test_where_with_class_combinator_attribute
+    assert_equal %w[Bob Charlie Donna], Dom::Person.where(active: false).map(&:name)
+  end
+
+  def test_where_with_data_key_combinator_attribute
+    assert_equal %w[Donna], Dom::Person.where(blocked: true).map(&:name)
   end
 
   def test_where_without_match
-    assert_equal [], Dom::Person.where(favorite_color: "Yellow")
+    assert_equal [], Dom::Person.where(favorite_color: 'Yellow')
   end
 
   def test_where_without_selector
     assert_raises Domino::Error do
-      Dom::NoSelector.where(foo: "bar")
+      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.7.1
+  version: 0.8.0
 platform: ruby
 authors:
 - Nick Gauthier
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-04 00:00:00.000000000 Z
+date: 2018-02-27 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.8
+rubygems_version: 2.6.14
 signing_key: 
 specification_version: 4
 summary: View abstraction for integration testing