napybara 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 53a5710df7b6badb61d443588bec50cd7d179618
-  data.tar.gz: 61e611ff8fa988a70190860db4e0b8800cb010ce
+  metadata.gz: c7b2cbbf480b100b3a1adc606cfa57b05868f860
+  data.tar.gz: 2a4ec7daa20873ffb807f49eba6302d4aa9171d1
 SHA512:
-  metadata.gz: 7e25b434912b12dc7175089a32433d62a24ec4b1d8a533e80e4a86c46c98d6e04b157528aa37a7462dbaf930f51cd7e2f6725297db3366fc9ef0901f47f37503
-  data.tar.gz: 81beacfbd669927f9798c7c4ecec8333f88bbb16fe285aee98d0836f6ba7c6d3f87b5fa62ee744a8e44719bd9c41c055ae0a1879e48f509c44e24d523af92a22
+  metadata.gz: b5661e2643515c2fa34eacef4702e1aa577f17f84ee4f02a9d0cf7d7929f544613ad183cc6c1ecf1ef6b78a584958376d634997d415819aa3b85a89794901e5f
+  data.tar.gz: 7eff003cfac47e53c8f476679e123630913f7eb289dc59bf71fbe48063bee022b049b0ddfa805ac35eeaaa05b2ec7d3f72b56735a512eddec629dce7842ca2f6

data/.travis.yml

@@ -3,5 +3,4 @@ rvm:
   - 1.9.3
   - 2.0.0
   - 2.1.0
-  - rbx
 cache: bundler

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## master
+
+Rename `#get` as #node. `#get` may become deprecated soon.
+
+Add `#selector`.
+
 ## 0.4.1
 
 Update README.

data/README.md

@@ -1,5 +1,7 @@
 # Napybara
 
+[![Build Status](https://api.travis-ci.org/gsmendoza/napybara.svg)](https://travis-ci.org/gsmendoza/napybara)
+
 So you're writing an integration test for the following page:
 
 ```html
@@ -19,12 +21,13 @@ So you're writing an integration test for the following page:
 </html>
 ```
 
-Wouldn't it be nice if your test helpers followed the page's structure?
+Wouldn't it be nice if you can write test helpers that followed the page's
+structure?
 
 ```ruby
 messages_page.visit!
 
-messages_page.form.message_row.text_field.get.set 'Hello World!'
+messages_page.form.message_row.text_field.node.set 'Hello World!'
 messages_page.form.submit!
 
 expect(messages_page.message(Message.find(1))).to have_content('Hello world!')
@@ -36,7 +39,7 @@ expect(messages_page.messages[1]).to have_content('Kamusta mundo!')
 
 With Napybara, now you can!
 
-## Napybara::Element.new and #get
+## Napybara::Element.new and #node
 
 First off, let's wrap the Capybara session in a Napybara element:
 
@@ -49,10 +52,10 @@ end
 In Rails integration tests which use Capybara, `self` is usually the Capybara session.
 
 You can get the Capybara element wrapped by the Napybara element with
-`Napybara::Element#get`:
+`Napybara::Element#node`:
 
 ```ruby
-expect(messages_page.get).to eq(self)
+expect(messages_page.node).to eq(self)
 ```
 
 ## Finding by selector
@@ -68,7 +71,7 @@ end
 
 # ...
 
-expect(messages_page.form.get['class']).to eq('new-message')
+expect(messages_page.form.node['class']).to eq('new-message')
 ```
 
 ## Finding by object
@@ -89,7 +92,7 @@ end
 
 # ...
 
-expect(messages_page.message(some_message).get['id'])
+expect(messages_page.message(some_message).node['id'])
   .to eq("message-#{some_message.id}")
 
 ```
@@ -106,7 +109,7 @@ If the ruby object is identified by a method other than the object's id, you can
 `Napybara::Element#finder` also adds `has_` and `has_no_` methods to the element.
 With the Napybara elements above, you can call:
 
-```
+```ruby
 expect(messages_page.has_form?).to be_true
 expect(messages_page).to have_form
 
@@ -136,8 +139,8 @@ end
 
 # ...
 
-expect(messages_page.messages[0].get.text).to eq("Hello world!")
-expect(messages_page.messages[1].get.text).to eq("Kamusta mundo!")
+expect(messages_page.messages[0].node.text).to eq("Hello world!")
+expect(messages_page.messages[1].node.text).to eq("Kamusta mundo!")
 ```
 
 Napybara uses ActiveSupport to get the plural version of the finder name.
@@ -150,7 +153,7 @@ You can add new methods to a Napybara element with plain Ruby:
 let(:messages_page) do
   Napybara::Element.new(self) do |page|
     def page.visit!
-      get.visit get.messages_path
+      node.visit node.messages_path
     end
   end
 end
@@ -167,7 +170,7 @@ Adding the same methods to multiple Napybara elements? You can share the methods
 ```ruby
 module PageExtensions
   def visit!
-    get.visit get.messages_path
+    node.visit node.messages_path
     @visited = true
   end
 
@@ -192,10 +195,10 @@ expect(messages_page).to be_visited
 
 And what if you want to share a module with finders? Again, with plain Ruby:
 
-```
+```ruby
 module IsAForm
   def submit!
-    submit_button.get.click
+    submit_button.node.click
   end
 
   def self.add_to(form)
@@ -222,7 +225,7 @@ helpers at the start of this README:
 
 module PageExtensions
   def visit!
-    get.visit get.messages_path
+    node.visit node.messages_path
     @visited = true
   end
 
@@ -233,7 +236,7 @@ end
 
 module IsAForm
   def submit!
-    submit_button.get.click
+    submit_button.node.click
   end
 
   def self.add_to(form)
@@ -243,7 +246,7 @@ module IsAForm
 end
 
 let(:messages_page) do
-  Napybara::Element.new(capybara_page) do |page|
+  Napybara::Element.new(self) do |page|
     page.extend PageExtensions
 
     page.finder :form, 'form.new-message' do |form|
@@ -259,6 +262,27 @@ let(:messages_page) do
 end
 ```
 
+## And a few more things: getting the selector of a finder
+
+`Napybara::Element#selector` returns a selector that can be used to find the element:
+
+```ruby
+expect(messages_page.form.message_row.text_field.selector)
+  .to eq('form.new-message .message-row input[type=text]')
+
+expect(messages_page.message(Message.find(2)).selector)
+  .to eq('#message-2')
+
+expect(messages_page.messages.selector)
+  .to eq('.message-list .message')
+
+expect(messages_page.messages[1].selector)
+  .to eq('.message-list .message')
+
+```
+
+Take note that with `messages_page.messages[1]`, it's currently not possible to get the ith match of a selector. We'll have to wait until [`nth-match`](http://www.w3.org/TR/selectors4/#nth-match-pseudo) becomes mainstream.
+
 ## Installation
 
 ```

data/lib/napybara.rb

@@ -4,4 +4,6 @@ module Napybara
 end
 
 require "napybara/element"
+require "napybara/element_array"
+require "napybara/selector"
 require "napybara/version"

data/lib/napybara/element.rb

@@ -2,18 +2,24 @@ require 'napybara'
 
 module Napybara
   class Element
-    attr_reader :capybara_element
-    alias_method :get, :capybara_element
+    attr_reader :node, :parent, :selector_string
+
+    alias_method :get, :node
+
+    def initialize(node, parent = nil, selector_string = nil, &block)
+      @node = node
+      @parent = parent
+      @selector_string = selector_string
 
-    def initialize(capybara_element, &block)
-      @capybara_element = capybara_element
       block.call(self) if block_given?
     end
 
     def finder(child_element_name, child_element_selector, record_selector = nil, &block)
       self.define_singleton_method(child_element_name) do |record = nil|
         selector = Selector.new(child_element_selector, record_selector, record)
-        self.class.new(self.get.find(selector.to_s), &block)
+        selector_string = selector.to_s
+
+        self.class.new(self.get.find(selector_string), self, selector_string, &block)
       end
 
       self.define_singleton_method("has_#{child_element_name}?") do |record = nil|
@@ -27,29 +33,19 @@ module Napybara
       end
 
       self.define_singleton_method(child_element_name.to_s.pluralize) do
-        self.get.all(child_element_selector).map do |child_element|
-          self.class.new(child_element, &block)
-        end
-      end
-    end
+        elements = self.get.all(child_element_selector)
+          .map.with_index do |child_element, i|
 
-    class Selector < Struct.new(:child_element_selector, :record_selector, :record)
-      METHOD_NAME_REGEX = /\{(\w+)\}/
-      def method_name
-        record_selector.match(METHOD_NAME_REGEX)[1]
-      end
+          self.class.new(child_element, self, child_element_selector, &block)
+        end
 
-      def record_id
-        record && record.public_send(method_name)
+        ElementArray.new(elements, self, child_element_selector)
       end
+    end
 
-      def to_s
-        if record
-          record_selector.gsub(METHOD_NAME_REGEX, record_id.to_s)
-        else
-          child_element_selector
-        end
-      end
+    def selector
+      parent_selector = parent.try(:selector)
+      parent_selector ? "#{parent_selector} #{selector_string}" : selector_string
     end
   end
 end

data/lib/napybara/element_array.rb

@@ -0,0 +1,14 @@
+module Napybara
+  class ElementArray < Array
+    def initialize(elements, parent, selector_string = '')
+      @parent = parent
+      @selector_string = selector_string
+      super(elements)
+    end
+
+    def selector
+      parent_selector = @parent.try(:selector)
+      parent_selector ? "#{@parent.selector} #{@selector_string}" : @selector_string
+    end
+  end
+end

data/lib/napybara/selector.rb

@@ -0,0 +1,20 @@
+module Napybara
+  class Selector < Struct.new(:child_element_selector, :record_selector, :record)
+    METHOD_NAME_REGEX = /\{(\w+)\}/
+    def method_name
+      record_selector.match(METHOD_NAME_REGEX)[1]
+    end
+
+    def record_id
+      record && record.public_send(method_name)
+    end
+
+    def to_s
+      if record
+        record_selector.gsub(METHOD_NAME_REGEX, record_id.to_s)
+      else
+        child_element_selector
+      end
+    end
+  end
+end

data/lib/napybara/version.rb

@@ -1,3 +1,3 @@
 module Napybara
-  VERSION = "0.4.1"
+  VERSION = "0.5.0"
 end

data/spec/integration/readme_spec.rb

@@ -11,7 +11,7 @@ describe 'Readme example:' do
             <li class="message" id="message-2">Kamusta mundo!</li>
           </ul>
           <form class='new-message'>
-            <div class="message-row" />
+            <div class="message-row">
               <label for='message'>Message</label>
               <input id='message' type='text' name='message'>
             </div>
@@ -30,8 +30,8 @@ describe 'Readme example:' do
       @messages_page = Napybara::Element.new(capybara_page)
     end
 
-    And "I call #get on the Napybara page" do
-      @get_result = @messages_page.get
+    And "I call #node on the Napybara page" do
+      @get_result = @messages_page.node
     end
 
     Then "I should get the capybara page" do
@@ -52,7 +52,7 @@ describe 'Readme example:' do
 
     Then "the finder should be able to find the element matching the selector" do
 
-      expect(@messages_page.form.get['class']).to eq('new-message')
+      expect(@messages_page.form.node['class']).to eq('new-message')
     end
   end
 
@@ -70,7 +70,7 @@ describe 'Readme example:' do
     Then "the finder should be able to find the element matching a given object" do
       id = 1
       message = OpenStruct.new(id: id)
-      expect(@messages_page.message(message).get['id']).to eq("message-#{id}")
+      expect(@messages_page.message(message).node['id']).to eq("message-#{id}")
     end
   end
 
@@ -114,8 +114,8 @@ describe 'Readme example:' do
     Then "I should be able to find all the elements matching the selector with
       a plural version of the finder name" do
 
-      expect(@messages_page.message_items[0].get.text).to eq("Hello world!")
-      expect(@messages_page.message_items[1].get.text).to eq("Kamusta mundo!")
+      expect(@messages_page.message_items[0].node.text).to eq("Hello world!")
+      expect(@messages_page.message_items[1].node.text).to eq("Kamusta mundo!")
     end
   end
 
@@ -169,4 +169,37 @@ describe 'Readme example:' do
       expect(@messages_page).to be_visited
     end
   end
+
+  Steps "Getting the selector of a finder" do
+    Given "I have a a capybara page" do
+      capybara_page
+    end
+
+    When "I wrap the page in a Napybara element" do
+      @messages_page = Napybara::Element.new(capybara_page) do |page|
+        page.finder :form, 'form.new-message' do |form|
+
+          form.finder :message_row, '.message-row' do |row|
+            row.finder :text_field, 'input[type=text]'
+          end
+        end
+
+        page.finder :message, '.messages-list .message', '#message-{id}'
+      end
+    end
+
+    Then "I can get the selectors of the Napybara finder results" do
+      expect(@messages_page.form.message_row.text_field.selector)
+        .to eq('form.new-message .message-row input[type=text]')
+
+      expect(@messages_page.message(OpenStruct.new(id: 2)).selector)
+        .to eq('#message-2')
+
+      expect(@messages_page.messages.selector)
+        .to eq('.messages-list .message')
+
+      expect(@messages_page.messages[1].selector)
+        .to eq('.messages-list .message')
+    end
+  end
 end

data/spec/napybara/element_spec.rb

@@ -104,4 +104,80 @@ describe Napybara::Element do
       expect(page.has_no_form?(object)).to be_false
     end
   end
+
+  describe "#selector" do
+    it "can return the selector for a single element" do
+      napybara_page = described_class.new(capybara_page) do |page|
+        page.finder :form, '.some-form'
+      end
+
+      expect(napybara_page.form.selector).to eq('.some-form')
+    end
+
+    it "can return the selector for an element nested one layer" do
+      napybara_page = described_class.new(capybara_page) do |page|
+        page.finder :form, '.some-form' do |form|
+          form.finder :some_button, '.some-button'
+        end
+      end
+
+      expect(napybara_page.form.some_button.selector).to eq('.some-form .some-button')
+    end
+
+    it "can return the selector for an element nested more than one layer" do
+      napybara_page = described_class.new(capybara_page) do |page|
+        page.finder :form, '.some-form' do |form|
+          form.finder :some_button, '.some-button' do |button|
+            button.finder :img, 'img'
+          end
+        end
+      end
+
+      expect(napybara_page.form.some_button.img.selector)
+        .to eq('.some-form .some-button img')
+    end
+
+    it "can return the selector for an element array" do
+      napybara_page = described_class.new(capybara_page) do |page|
+        page.finder :button, 'button'
+      end
+
+      expect(napybara_page.buttons.selector).to eq('button')
+    end
+
+    context "where the items of the element array are not adjacent" do
+      let(:capybara_page) do
+        Capybara.string <<-HTML
+          <form class='some-form', id='form-1'>
+            <button class='recognized-button some-button' />
+            <button class='ignored-button' />
+            <button class='recognized-button another-button' />
+          </form>
+        HTML
+      end
+
+      it "can return the selector of the ith item of an element array" do
+        napybara_page = described_class.new(capybara_page) do |page|
+          page.finder :button, '.recognized-button'
+        end
+
+        first_button = napybara_page.buttons[1]
+
+        expect(first_button.selector).to eq('.recognized-button')
+
+        expect(napybara_page.node.all(first_button.selector)[1]['class'])
+          .to eq('recognized-button another-button')
+      end
+    end
+
+    it "can return the selector of an child of an element array item" do
+      napybara_page = described_class.new(capybara_page) do |page|
+        page.finder :button, 'button' do |button|
+          button.finder :image, 'img'
+        end
+      end
+
+      expect(napybara_page.buttons[0].image.selector).to eq('button img')
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: napybara
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - George Mendoza
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-18 00:00:00.000000000 Z
+date: 2014-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -198,6 +198,8 @@ files:
 - Rakefile
 - lib/napybara.rb
 - lib/napybara/element.rb
+- lib/napybara/element_array.rb
+- lib/napybara/selector.rb
 - lib/napybara/version.rb
 - napybara.gemspec
 - spec/dummy_app/config.ru