napybara 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c60bfd33a34b3c9225ede612cd2ceaecb644b235
-  data.tar.gz: ed872c87a98a39850a887a9f66e5fdcf5884e143
+  metadata.gz: 1d7b59ac7590d39a09e63cc572d21aa5c43f6c27
+  data.tar.gz: 9f3b75d890dbed6b3d19a0d4413950a212e3088f
 SHA512:
-  metadata.gz: 745db690753460d0e8b058f176463fac216f5a335b3abf4409e2229f3f6c3f8c75ea79b5b84f6d8ce204b2134cf7172f6dfc0caef95ad11207df7b1dfdbe245f
-  data.tar.gz: dcde1d036cedd78c9894b01110d6536db00e66a954cd82cd977ac8bcdd4961b535810e5ffb7b51b40c159bacffe8619412266289c486193c19468807d299248c
+  metadata.gz: a6e6557bf502740bff951cca82f8a2fbd1f177cd725e04e2dc506b89118974231ef0a58a1dd64d022b3b53c102756855c284a65b9841f9792b20c915d0b64c2a
+  data.tar.gz: fbb927c8fa87961f978213aa665a03622369cb427fa954985a358db171313394ebcaf02ee7cf08efa1e9b9c6a578ce28c040000ffdb7e87f87b8e5d900a674d1

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 0.4.0
+
+Require separate record selector for finding records.

data/README.md

@@ -30,8 +30,8 @@ messages_page.form.submit!
 expect(messages_page.message(Message.find(1))).to have_content('Hello world!')
 expect(messages_page.message(Message.find(2))).to have_content('Kamusta mundo!')
 
-expect(messages_page.message_items[0]).to have_content('Hello world!')
-expect(messages_page.message_items[1]).to have_content('Kamusta mundo!')
+expect(messages_page.messages[0]).to have_content('Hello world!')
+expect(messages_page.messages[1]).to have_content('Kamusta mundo!')
 ```
 
 With Napybara, now you can!
@@ -73,14 +73,13 @@ expect(messages_page.form.get['class']).to eq('new-message')
 
 ## Finding by object
 
-In Rails, dom elements usually have ids which end with object ids, the objects
-usually being active records. The method generated by `Napybara::Element#finder`
-can also accept an object when searching for the object's matching element:
+In order to find an element representing a particular ruby object, you need to
+add a separate selector which incorporates the ruby object's id:
 
 ```ruby
 let(:messages_page) do
   Napybara::Element.new(self) do |page|
-    page.finder :message, '#message-'
+    page.finder :message, '.message', '#message-{id}'
   end
 end
 
@@ -96,19 +95,11 @@ expect(messages_page.message(some_message).get['id'])
 ```
 
 In the above example, the `message` finder looks for an element matching the
-given selector (`#message-`) with `some_message`'s id (`1`). So it ends up
+given selector (`#message-{id}`) with `some_message`'s id (`1`). So it ends up
 looking for "#message-1".
 
-## Calling the finder with or without an object argument
+If the ruby object is identified by a method other than the object's id, you can replace `{id}` with the method e.g. `{name}`, `{to_s}`.
 
-As you may have observed, the finder added by `Napybara::Element#finder`
-can be called with or without an object argument. Usually, you only want to use
-just one of these two options; the selector you declare will determine what
-option you want to use. For example, `#message-` only makes sense with an object
-id at the end of the selector, so you want to call the `messages_page.message()`
-finder with an object. On the other hand, `form.new-message` does not make sense
-with an object id at the end of the selector, so you want to call the
-`messages_page.form()` finder without an object argument.
 
 ## Checking if an element exists
 
@@ -139,14 +130,14 @@ Finally, `Napybara::Element#finder` adds a pluralized version of the finder. For
 ```ruby
 let(:messages_page) do
   Napybara::Element.new(self) do |page|
-    page.finder :message_item, '.message'
+    page.finder :message, '.message'
   end
 end
 
 # ...
 
-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.messages[0].get.text).to eq("Hello world!")
+expect(messages_page.messages[1].get.text).to eq("Kamusta mundo!")
 ```
 
 Napybara uses ActiveSupport to get the plural version of the finder name.
@@ -221,8 +212,7 @@ let(:messages_page) do
       form.finder :submit_button, 'input[type=submit]'
     end
 
-    page.finder :message, '.message-list #message-'
-    page.finder :message_item, '.message-list .message'
+    page.finder :message, '.message-list .message', '#message-{id}'
   end
 end
 ```

data/lib/napybara/element.rb

@@ -10,19 +10,19 @@ module Napybara
       block.call(self) if block_given?
     end
 
-    def finder(child_element_name, child_element_selector, method_name = :id, &block)
+    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, method_name, record)
+        selector = Selector.new(child_element_selector, record_selector, record)
         self.class.new(self.get.find(selector.to_s), &block)
       end
 
       self.define_singleton_method("has_#{child_element_name}?") do |record = nil|
-        selector = Selector.new(child_element_selector, method_name, record)
+        selector = Selector.new(child_element_selector, record_selector, record)
         self.get.has_css?(selector.to_s)
       end
 
       self.define_singleton_method("has_no_#{child_element_name}?") do |record = nil|
-        selector = Selector.new(child_element_selector, method_name, record)
+        selector = Selector.new(child_element_selector, record_selector, record)
         self.get.has_no_css?(selector.to_s)
       end
 
@@ -33,13 +33,22 @@ module Napybara
       end
     end
 
-    class Selector < Struct.new(:child_element_selector, :method_name, :record)
+    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
-        "#{child_element_selector}#{record_id}"
+        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.3.1"
+  VERSION = "0.4.0"
 end

data/spec/integration/readme_spec.rb

@@ -63,7 +63,7 @@ describe 'Readme example:' do
 
     When "I add an object finder to the Napybara page wrapping the capybara page" do
       @messages_page = Napybara::Element.new(capybara_page) do |page|
-        page.finder :message, '#message-'
+        page.finder :message, '.message', '#message-{id}'
       end
     end
 
@@ -82,7 +82,7 @@ describe 'Readme example:' do
     When "I add finders to the Napybara page wrapping the capybara page" do
       @messages_page = Napybara::Element.new(capybara_page) do |page|
         page.finder :form, 'form.new-message'
-        page.finder :message, '#message-'
+        page.finder :message, '.message', '#message-{id}'
       end
     end
 

data/spec/napybara/element_spec.rb

@@ -50,7 +50,7 @@ describe Napybara::Element do
 
     it 'allows the element to find a sub-element with an id' do
       page = described_class.new(capybara_page)
-      page.finder(:form, '#form-')
+      page.finder(:form, '.some-form', '#form-{id}')
 
       object = OpenStruct.new(id: 1)
 
@@ -59,7 +59,7 @@ describe Napybara::Element do
 
     it 'allows the element to find a sub-element with a record method' do
       page = described_class.new(capybara_page)
-      page.finder(:form, '#form-', :name)
+      page.finder(:form, '.some-form', '#form-{name}')
 
       object = OpenStruct.new(name: 1)
 
@@ -88,7 +88,7 @@ describe Napybara::Element do
 
     it 'adds a method to check if the element has a sub-element matching a record' do
       page = described_class.new(capybara_page)
-      page.finder(:form, '#form-')
+      page.finder(:form, '.some-form', '#form-{id}')
 
       object = OpenStruct.new(id: 1)
 
@@ -97,7 +97,7 @@ describe Napybara::Element do
 
     it 'adds a method to check if the element has no sub-element matching a record' do
       page = described_class.new(capybara_page)
-      page.finder(:form, '#form-')
+      page.finder(:form, '.some-form', '#form-{id}')
 
       object = OpenStruct.new(id: 1)
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: napybara
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - George Mendoza
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-06 00:00:00.000000000 Z
+date: 2014-05-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -190,6 +190,7 @@ files:
 - .rspec
 - .rubocop.yml
 - .travis.yml
+- CHANGELOG.md
 - Gemfile
 - Guardfile
 - LICENSE.txt