napybara 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 136cf0b7cb6fe430469f8f62716b881f13cbd930
-  data.tar.gz: 2eced35383167624d76137d9c55b7ac5ad8cc1b0
+  metadata.gz: 1acb0ab3b95532810db2654efd6a23ff89d23a58
+  data.tar.gz: 8d24168fbf6adc727fdd89afe2ecf8d1c6c1d714
 SHA512:
-  metadata.gz: 815eda0334f497bb7b085654777577a20f86e49448989c769dd9718436c31c980028b70ab960ac8f4a8078bf972f5e223d51aa2d992692562f82f515eb4a82c0
-  data.tar.gz: b0ad69b36d4e99febc8590ea2309940ae5cf4b35c4c7b45208b94d0fea8ec36896b3859a972bc0848d8a68118b06c9088a99aac2df3e53e9b6d4e22acf80a2ac
+  metadata.gz: d3f4c003ac74d14684fcff69c18e06d571ae68d43f00df59738581af6b4711127eaf8657d7adb07e2c3ea9f46a25738b224a5949ec0165738011f43ac300d571
+  data.tar.gz: 0a46fea43e3df63a71780a4691894d4cb61efbe380e02f2185442d590cf9af67c4c4b14a0f47529b17671b5d07679986f57cc1b8d82221fd470482d3f16fbd4c

data/README.md

@@ -23,7 +23,7 @@ Wouldn't it be nice if your test helpers followed the structure of the page?
 
 ```ruby
 messages_page.visit!
-messages_page.form.message.text_field.set 'Hello World!'
+messages_page.form.message.text_field.get.set 'Hello World!'
 messages_page.form.submit!
 expect(messages_page.messages[0]).to have_content('Hello world!')
 expect(messages_page.messages[1]).to have_content('Kamusta mundo!')
@@ -34,49 +34,49 @@ With Napybara, now they can! All you need is to define the structure of the page
 ```ruby
 # spec/features/messages_spec.rb
 
-:new_messsage_page) do
-  Napybara::DSL.build(self) do
-    all :messages, '.messages-list .message'
+let(:new_message_page) do
+  Napybara::Element.new(self) do |page|
+    page.finder :message, '.messages-list .message'
 
-    find :form, 'form.new-message' do
-      find :message, '.message' do
-        find :text_field, 'input#message'
+    page.finder :form, 'form.new-message' do |form|
+      form.finder :message, '.message' do |row|
+        row.finder :text_field, 'input#message'
       end
 
-      find :submit_button, 'input[type=submit]'
+      form.finder :submit_button, 'input[type=submit]'
     end
   end
 end
 ```
 
-In the integration test above, the `self` in `Napybara::DSL.build(self)` points to the current test session. In Rails integration tests which include `Capybara::DSL`, `self` would already have access to `Capybara::DSL`'s methods.
+In the integration test above, the `self` in `Napybara::Element.new(self)` points to the current test session. In Rails integration tests which include `Capybara::DSL`, `self` would already have access to `Capybara::DSL`'s methods.
 
- What about the custom `messages_page.visit!` and `form.submit!` methods? With Napybara, you can extend each element in the structure with the dsl's `extend_element` method. So if you want to add a `visit!` method to the `messages_page` element, you can write
+ What about the custom `messages_page.visit!` and `form.submit!` methods? With Napybara, you can extend each element in the structure. So if you want to add a `visit!` method to the `messages_page` element, you can write
 
 ```ruby
-Napybara::DSL.build(self) do
-  extend_element do
-    def visit!
-      visit '/messages/index'
-    end
+Napybara::Element.new(self) do |page|
+  def page.visit!
+    get.visit '/messages/index'
   end
 
   # ...
 end
 ```
 
-You can also reuse helpers by calling the `extend_element` with a module. For example, with `form.submit!`:
+`get` here points to the Capybara element that the Napybara element is wrapping.
+
+You can also reuse helpers by extend the Napybara element with a module. For example, with `form.submit!`:
 
 ```ruby
 module FormExtensions
   def submit!
-    submit_button.click
+    submit_button.get.click
   end
 end
 
-Napybara::DSL.build(self) do
-  find :form, 'form.new-message' do
-    extend_element FormExtensions
+Napybara::Element.new(self) do |page|
+  page.finder :form, 'form.new-message' do |form|
+    form.extend FormExtensions
     # ...
   end
 end
@@ -86,7 +86,7 @@ end
 
 Add this line to your application's Gemfile:
 
-    gem 'napybara'
+    gem 'Napybara'
 
 And then execute:
 
@@ -94,11 +94,11 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install napybara
+    $ gem install Napybara
 
 ## Contributing
 
-1. Fork it ( http://github.com/<my-github-username>/napybara/fork )
+1. Fork it ( http://github.com/<my-github-username>/Napybara/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/napybara.rb

@@ -1,6 +1,7 @@
+require 'active_support/core_ext/string'
+
 module Napybara
 end
 
-require "napybara/dsl"
+require "napybara/element"
 require "napybara/version"
-

data/lib/napybara/element.rb

@@ -0,0 +1,46 @@
+require 'napybara'
+
+module Napybara
+  class Element
+    attr_reader :capybara_element
+    alias_method :get, :capybara_element
+
+    def initialize(capybara_element, &block)
+      @capybara_element = capybara_element
+      block.call(self) if block_given?
+    end
+
+    def finder(child_element_name, child_element_selector, method_name = :id, &block)
+      self.define_singleton_method(child_element_name) do |record = nil|
+        selector = Selector.new(child_element_selector, method_name, record)
+        self.class.new(self.get.find(selector.to_s), &block)
+      end
+
+      self.define_singleton_method("has_#{child_element_name}?") do |record|
+        selector = Selector.new(child_element_selector, method_name, record)
+        self.get.has_css?(selector.to_s)
+      end
+
+      self.define_singleton_method("has_no_#{child_element_name}?") do |record|
+        selector = Selector.new(child_element_selector, method_name, record)
+        self.get.has_no_css?(selector.to_s)
+      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
+
+    class Selector < Struct.new(:child_element_selector, :method_name, :record)
+      def record_id
+        record && record.public_send(method_name)
+      end
+
+      def to_s
+        "#{child_element_selector}#{record_id}"
+      end
+    end
+  end
+end

data/lib/napybara/version.rb

@@ -1,3 +1,3 @@
 module Napybara
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/napybara.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "activesupport"
   spec.add_dependency "capybara"
 
   spec.add_development_dependency "bundler", "~> 1.5"

data/spec/integration/napybara_spec.rb

@@ -2,7 +2,7 @@ require 'capybara/poltergeist'
 require 'spec_helper'
 require 'dummy_app/dummy_app'
 
-describe Napybara do
+describe 'Napybara::Element#get' do
   describe '#has_content?' do
     describe 'waits for Ajax events to complete before processing' do
       let(:session) do
@@ -10,16 +10,14 @@ describe Napybara do
       end
 
       let(:test_page) do
-        Napybara::DSL.build(session) do
-          extend_element do
-            def visit!
-              visit '/test.html'
-            end
+        Napybara::Element.new(session) do |page|
+          def page.visit!
+            get.visit '/test.html'
           end
 
-          find :form, 'form' do
-            find :notice_updater, 'button.update'
-            find :notice, '.notice'
+          page.finder :form, 'form' do |form|
+            form.finder :notice_updater, 'button.update'
+            form.finder :notice, '.notice'
           end
         end
       end
@@ -29,17 +27,17 @@ describe Napybara do
           another element B is clicked' do
           test_page.visit!
 
-          expect(test_page.form.notice).to have_content('Old content.')
-          expect(test_page.form.notice).to have_no_content('New content.')
+          expect(test_page.form.notice.get).to have_content('Old content.')
+          expect(test_page.form.notice.get).to have_no_content('New content.')
         end
 
         When 'I click on element B' do
-          test_page.form.notice_updater.click
+          test_page.form.notice_updater.get.click
         end
 
         Then 'checking if element A has the new content should be true' do
-          expect(test_page.form.notice).to have_content('New content.')
-          expect(test_page.form.notice).to have_no_content('Old content.')
+          expect(test_page.form.notice.get).to have_content('New content.')
+          expect(test_page.form.notice.get).to have_no_content('Old content.')
         end
       end
     end

data/spec/napybara/element_spec.rb

@@ -0,0 +1,107 @@
+require 'spec_helper'
+
+describe Napybara::Element do
+  let(:capybara_page) do
+    Capybara.string <<-HTML
+      <form class='some-form', id='form-1'>
+        <button class='some-button'>
+          <img />
+        </button>
+
+        <button class='another-button'>
+          <img />
+        </button>
+      </form>
+    HTML
+  end
+
+  describe '#new' do
+    it 'returns the element' do
+      element = described_class.new(capybara_page)
+      expect(element).to be_a(Napybara::Element)
+      expect(element.get).to eq(capybara_page)
+    end
+
+    it 'adds child elements from the block to the return element' do
+      element = described_class.new(capybara_page) do |page|
+        page.finder :form, '.some-form'
+      end
+
+      expect(element.form.get['class']).to eq('some-form')
+    end
+  end
+
+  describe '#finder' do
+    it 'adds a method to the element for finding the given selector' do
+      page = described_class.new(capybara_page)
+      page.finder(:form, '.some-form')
+
+      expect(page.form.get['class']).to eq('some-form')
+    end
+
+    it 'adds child elements from the block to the finder element' do
+      page = described_class.new(capybara_page)
+      page.finder(:form, '.some-form') do |form|
+        form.finder(:button, '.some-button')
+      end
+
+      expect(page.form.button.get['class']).to eq('some-button')
+    end
+
+    it 'allows the element to find a sub-element with an id' do
+      page = described_class.new(capybara_page)
+      page.finder(:form, '#form-')
+
+      object = OpenStruct.new(id: 1)
+
+      expect(page.form(object).get['class']).to eq('some-form')
+    end
+
+    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)
+
+      object = OpenStruct.new(name: 1)
+
+      expect(page.form(object).get['class']).to eq('some-form')
+    end
+
+    it 'adds a method to get all the elements matching the selector' do
+      page = described_class.new(capybara_page)
+      page.finder(:button, 'button')
+
+      expect(page.buttons).to have(2).elements
+      expect(page.buttons).to be_all do |element|
+        element.get.tag_name == 'button'
+      end
+    end
+
+    it 'adds child elements from the block to each element returned' do
+      page = described_class.new(capybara_page)
+      page.finder(:button, 'button') do |button|
+        button.finder :img, 'img'
+      end
+
+      expect(page.buttons).to have(2).elements
+      expect(page.buttons[0].img.get.tag_name).to eq('img')
+    end
+
+    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-')
+
+      object = OpenStruct.new(id: 1)
+
+      expect(page.has_form?(object)).to be_true
+    end
+
+    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-')
+
+      object = OpenStruct.new(id: 1)
+
+      expect(page.has_no_form?(object)).to be_false
+    end
+  end
+end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: napybara
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - George Mendoza
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-17 00:00:00.000000000 Z
+date: 2014-04-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement
@@ -182,7 +196,7 @@ files:
 - README.md
 - Rakefile
 - lib/napybara.rb
-- lib/napybara/dsl.rb
+- lib/napybara/element.rb
 - lib/napybara/version.rb
 - napybara.gemspec
 - spec/dummy_app/config.ru
@@ -191,7 +205,7 @@ files:
 - spec/dummy_app/public/new_content.html
 - spec/dummy_app/public/test.html
 - spec/integration/napybara_spec.rb
-- spec/napybara/dsl_spec.rb
+- spec/napybara/element_spec.rb
 - spec/spec_helper.rb
 homepage: ''
 licenses:
@@ -224,5 +238,5 @@ test_files:
 - spec/dummy_app/public/new_content.html
 - spec/dummy_app/public/test.html
 - spec/integration/napybara_spec.rb
-- spec/napybara/dsl_spec.rb
+- spec/napybara/element_spec.rb
 - spec/spec_helper.rb

data/lib/napybara/dsl.rb

@@ -1,30 +0,0 @@
-module Napybara
-  class DSL < Struct.new(:element)
-    def self.build(capybara_node, &block)
-      @element = capybara_node
-      capybara_node.tap do |element|
-        dsl_instance = new(element)
-        dsl_instance.instance_eval(&block) if block_given?
-      end
-    end
-
-    def all(child_element_name, child_element_selector, &block)
-      element.define_singleton_method(child_element_name) do
-        self.all(child_element_selector).each do |child_element|
-          Napybara::DSL.build(child_element, &block)
-        end
-      end
-    end
-
-    def extend_element(a_module = Module.new, &block)
-      block_module = Module.new(&block)
-      element.extend(block_module, a_module)
-    end
-
-    def find(child_element_name, child_element_selector, &block)
-      element.define_singleton_method(child_element_name) do
-        Napybara::DSL.build(self.find(child_element_selector), &block)
-      end
-    end
-  end
-end

data/spec/napybara/dsl_spec.rb

@@ -1,121 +0,0 @@
-require 'spec_helper'
-
-describe Napybara::DSL do
-  let(:capybara_page) do
-    Capybara.string <<-HTML
-      <form class='some-form'>
-        <button class='some-button'>
-          <img />
-        </button>
-
-        <button class='another-button'>
-          <img />
-        </button>
-      </form>
-    HTML
-  end
-
-  describe '.build' do
-    it 'returns the capybara_page as is' do
-      element = described_class.build(capybara_page)
-      expect(element).to eq(capybara_page)
-    end
-
-    it 'adds child elements from the block to the return element' do
-      element = described_class.build(capybara_page) do
-        find :form, '.some-form'
-      end
-
-      expect(element.form['class']).to eq('some-form')
-    end
-  end
-
-  describe '#find' do
-    it 'adds a method to the element for finding the given selector' do
-      dsl = described_class.new(capybara_page)
-      dsl.find(:form, '.some-form')
-
-      expect(dsl.element.form['class']).to eq('some-form')
-    end
-
-    it 'adds child elements from the block to the finder element' do
-      dsl = described_class.new(capybara_page)
-      dsl.find(:form, '.some-form') do
-        find(:button, '.some-button')
-      end
-
-      expect(dsl.element.form.button['class']).to eq('some-button')
-    end
-  end
-
-  describe '#all' do
-    it 'adds a method to get all the elements matching the selector' do
-      dsl = described_class.new(capybara_page)
-      dsl.all(:buttons, 'button')
-
-      expect(dsl.element.buttons).to have(2).elements
-      expect(dsl.element.buttons).to be_all do |element|
-        element.tag_name == 'button'
-      end
-    end
-
-    it 'adds child elements from the block to each element returned' do
-      dsl = described_class.new(capybara_page)
-      dsl.all(:buttons, 'button') do
-        find :img, 'img'
-      end
-
-      expect(dsl.element.buttons).to have(2).elements
-      expect(dsl.element.buttons[0].img.tag_name).to eq('img')
-    end
-  end
-
-  describe '#extend_element' do
-    it 'can accept a module' do
-      some_module = Module.new do
-        def responds_to_this_method?
-          true
-        end
-      end
-
-      dsl = described_class.new(capybara_page)
-      dsl.extend_element(some_module)
-
-      expect(dsl.element.responds_to_this_method?).to be_true
-    end
-
-    it 'can accept a block' do
-      dsl = described_class.new(capybara_page)
-      dsl.extend_element do
-        def responds_to_this_method?
-          true
-        end
-      end
-
-      expect(dsl.element.responds_to_this_method?).to be_true
-    end
-
-    it 'prefers the passed module with the block' do
-      some_module = Module.new do
-        def responds_to_module_method?
-          true
-        end
-
-        def responds_to_block_method?
-          false
-        end
-      end
-
-      dsl = described_class.new(capybara_page)
-
-      dsl.extend_element(some_module) do
-        def responds_to_block_method?
-          true
-        end
-      end
-
-      expect(dsl.element.responds_to_module_method?).to be_true
-      expect(dsl.element.responds_to_block_method?).to be_true
-    end
-  end
-end