capybara-ng 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2fe60760b896ba2c87ac3f698db240f5a249c302
-  data.tar.gz: e293bf655ff886c0b5ef48fc569f5f11f30309f5
+  metadata.gz: 52f9e96dfa5ce32dfc53c66148d301d82e20dbc1
+  data.tar.gz: 0827939aa362e10eedea420ecee2baa077aa98c2
 SHA512:
-  metadata.gz: 2584ef8d0dceeb3b578eeb23c6e0620d6ccb449a8af4cd68bf4fa4d01d4148b132e1876f29ce86ba3c10578a680e28217307d822cb205c50bfdb79fd9b5a084d
-  data.tar.gz: c441a769921abad480c6ac4c619417fb8426db4be0b42fc10da2aa3060bf95682ae98e1571d1f94449c02b36adb14384fdf78bec6e69dcb6e29efc3cea2db59b
+  metadata.gz: 48174a887a6f82642bd390f24383e2c8f360104a89904fc42c6398b47189f0dbf5bd0773c62b35ba0e5a1f5868eb8079f62d69fd231505cdb63fc5f2b4fbb517
+  data.tar.gz: 1fc2e8382d0d81355b214cbcdf69b7bd8b285b253d486beff3dbc65df881073ac1b7000faf1a5164d2439deb4304b5c0b937aea84c72040ef05fba193dd468bc

data/README.md

@@ -1,7 +1,18 @@
 # Angular
 
-Basic bindings for AngularJS to be used with Capybara. Logic is based into Protractor.
+Basic bindings for AngularJS to be used with Capybara. Implementation is based into
+logic copied from Protractor.
 
+NOTE: At this point of development, I would classify DSL API "unstable". This means that
+DSL language may change in incompatible ways.
+
+## Related Projects
+
+- https://github.com/jnicklas/capybara
+- https://github.com/angular/protractor
+- https://code.google.com/p/selenium/wiki/RubyBindings
+- https://github.com/teampoltergeist/poltergeist
+- https://github.com/colszowka/phantomjs-gem
 
 ## Installation
 
@@ -20,12 +31,22 @@ Or install it yourself as:
 
 ## Usage
 
+### Setup
+
+spec/spec_helper.rb
+````ruby
+RSpec.configure do |config|
+  config.include Angular::DSL
+  ...
+end
+```
+
+### Experimenting features
+
 ````ruby
 require 'spec_helper'
 
 describe 'capybara', type: :feature  do
-  include Angular::DSL
-
   it 'test' do
     visit 'http://localhost:4000/sampler'
 
@@ -76,6 +97,70 @@ describe 'capybara', type: :feature  do
 end
 ```
 
+### Example test
+Example taken from https://github.com/kikonen/sampler/blob/master/dummy/spec/request/task_spec.rb
+
+#### Test file
+````ruby
+require 'spec_helper'
+
+describe 'capybara', type: :feature  do
+  include Angular::DSL
+
+  it 'create task' do
+    visit 'http://localhost:4000/sampler'
+
+    init_task_count = 2
+
+    # login
+    ng_repeater_row('view in views', 0).click
+    ng_model('user.username').set('admin')
+    ng_model('user.password').set('password')
+    click_button 'Login'
+
+    # check initial state
+    ng_repeater_row('view in views', 2).click
+    expect(ng_repeater_rows('task in $data').length).to eq init_task_count
+
+    # create new task
+    click_link 'New Task'
+    ng_model('task.name').set('Some')
+    ng_model('task.message').set('Thing')
+    ng_model('task.done').set('true')
+    click_button 'Save'
+
+    # check task is created
+    rows = ng_repeater_columns('task in $data', 'task.name')
+    expect(rows.length).to eq init_task_count + 1
+
+    # delete created task
+    cell = rows.select { |row| row.visible_text == 'Some' }.first
+    cell.click
+    accept_alert do
+      click_button 'Delete'
+    end
+    expect(ng_repeater_rows('task in $data').length).to eq init_task_count
+  end
+end
+```
+
+#### Running Example Test
+````bash
+# download and install chrome-driver
+# http://chromedriver.storage.googleapis.com/index.html
+
+git clone git@github.com:kikonen/sampler.git
+cd sampler
+cd dummy
+bundle
+rails s -p 4000&
+bundle exec rspec spec/request/test_spec.rb
+bundle exec rspec spec/request/task_spec.rb
+fg
+CTRL^C
+```
+
+
 ## Contributing
 
 1. Fork it ( https://github.com/[my-github-username]/capybara/fork )

data/lib/angular.rb

@@ -9,3 +9,5 @@ require 'angular/client_script'
 require 'angular/dsl'
 require 'angular/setup'
 require 'angular/waiter'
+
+require 'angular/capybara_setup'

data/lib/angular/capybara_setup.rb

@@ -0,0 +1,4 @@
+# bind logic to capybara
+class Capybara::Session
+  include Angular::DSL
+end

data/lib/angular/dsl.rb

@@ -15,129 +15,267 @@ module DSL
   #
   # @return current location absolute url
   #
-  def ng_location_abs(using = 'body')
-    ng.make_call :getLocationAbsUrl, [using], false
+  def ng_location_abs(opt = {})
+    selector = opt.delete(:rootSelector) || 'body'
+    ng.make_call :getLocationAbsUrl, [selector], opt
   end
 
   # @return current location absolute url
   #
-  def ng_location(using = 'body')
-    ng.make_call :getLocation, [using], false
+  def ng_location(opt = {})
+    selector = opt.delete(:rootSelector) || 'body'
+    ng.make_call :getLocation, [selector], opt
   end
 
   #
   # @return current location
   #
-  def ng_set_location(url, using = 'body')
-    ng.make_call :setLocation, [using, url], false
+  def ng_set_location(url, opt = {})
+    selector = opt.delete(:rootSelector) || 'body'
+    ng.make_call :setLocation, [selector, url], opt
   end
 
   #
+  # @param opt
+  # - :rootSelector
+  # - :wait
   # @return eval result
   #
-  def ng_eval(selector, expr)
-    ng.make_call :evaluate, [selector, expr], false
+  def ng_eval(expr, opt = {})
+    selector = opt.delete(:rootSelector) || 'body'
+    ng.make_call :evaluate, [selector, expr], opt
+  end
+
+  #
+  # Does binding exist
+  #
+  # @param opt
+  # - :exact
+  # - :using
+  # - :rootSelector
+  # - :wait
+  # @return true | false
+  #
+  def has_ng_binding?(binding, opt = {})
+    ng_bindings(model, opt)
+    true
+  rescue NotFound
+    false
   end
 
   #
   # Node for nth binding match
+  #
+  # @param opt
+  # - :row
+  # - :exact
+  # - :using
+  # - :rootSelector
+  # - :wait
   # @return nth node
   #
-  def ng_binding(binding, exact = false, row = 0, using = nil , rootSelector = 'body')
-    ng_bindings(binding, exact, using , rootSelector)[row]
+  def ng_binding(binding, opt = {})
+    row = ng.row(opt)
+    ng_bindings(binding, opt)[row]
   end
 
   #
   # All nodes matching binding
   #
+  # @param opt
+  # - :exact
+  # - :using
+  # - :rootSelector
+  # - :wait
   # @return [node, ...]
   #
-  def ng_bindings(binding, exact = false, using = nil , rootSelector = 'body')
-    ng.make_call :findBindings, [binding, exact, using, rootSelector], true
+  def ng_bindings(binding, opt = {})
+    ng.get_nodes :findBindings, [binding, opt[:exact]], opt
+  end
+
+  #
+  # Does model exist
+  #
+  # @param opt
+  # - :using
+  # - :rootSelector
+  # - :wait
+  # @return true | false
+  #
+  def has_ng_model?(model, opt = {})
+    ng_models(model, opt)
+    true
+  rescue NotFound
+    false
   end
 
   #
   # Node for nth model match
   #
+  # @param opt
+  # - :row
+  # - :using
+  # - :rootSelector
+  # - :wait
   # @return nth node
   #
-  def ng_model(model, row = 0, using = nil , rootSelector = 'body')
-    ng_models(model, using, rootSelector)[row]
+  def ng_model(model, opt = {})
+    row = ng.row(opt)
+    ng_models(model, opt)[row]
   end
 
   #
   # All nodes matching model
   #
+  # @param opt
+  # - :using
+  # - :rootSelector
+  # - :wait
   # @return [node, ...]
   #
-  def ng_models(model, using = nil , rootSelector = 'body')
-    ng.make_call :findByModel, [model, using, rootSelector], true
+  def ng_models(model, opt = {})
+    ng.get_nodes :findByModel, [model], opt
+  end
+
+  #
+  # Does option exist
+  #
+  # @param opt
+  # - :using
+  # - :rootSelector
+  # - :wait
+  # @return true | false
+  #
+  def has_ng_option?(options, opt = {})
+    ng_options(options, opt)
+    true
+  rescue NotFound
+    false
   end
 
   #
   # Node for nth option
   #
+  # @param opt
+  # - :row
+  # - :using
+  # - :rootSelector
+  # - :wait
   # @return nth node
   #
-  def ng_option(options, row = 0, using = nil , rootSelector = 'body')
-    ng_options(options, using, rootSelector)[row]
+  def ng_option(options, opt = {})
+    row = ng.row(opt)
+    ng_options(options, opt)[row]
   end
 
   #
   # All option values matching option
+  #
+  # @param opt
+  # - :using
+  # - :rootSelector
+  # - :wait
   # @return [node, ...]
   #
-  def ng_options(options, using = nil , rootSelector = 'body')
-    ng.make_call :findByOptions, [options, using, rootSelector], true
+  def ng_options(options, opt = {})
+    ng.get_nodes :findByOptions, [options], opt
+  end
+
+  #
+  # Does row exist
+  #
+  # @param opt
+  # - :using
+  # - :rootSelector
+  # - :wait
+  # @return true | false
+  #
+  def has_ng_repeater_row?(repeater, opt = {})
+    ng.get_nodes(:findRepeaterRows, [repeater, 0], opt)
+    true
+  rescue NotFound
+    false
   end
 
   #
   # Node for nth repeater row
+  #
+  # @param opt
+  # - :row
+  # - :using
+  # - :rootSelector
+  # - :wait
   # @return nth node
   #
-  def ng_repeater_row(repeater, row = 0, using = nil , rootSelector = 'body')
-    ng.make_call(:findRepeaterRows, [repeater, row, using, rootSelector], true).first
+  def ng_repeater_row(repeater, opt = {})
+    row = ng.row(opt)
+    data = ng.get_nodes(:findRepeaterRows, [repeater, row], opt)
+    data.first
   end
 
   #
   # All nodes matching repeater
   #
+  # @param opt
+  # - :using
+  # - :rootSelector
+  # - :wait
   # @return [node, ...]
   #
-  def ng_repeater_rows(repeater, using = nil , rootSelector = 'body')
-    ng.make_call :findAllRepeaterRows, [repeater, using, rootSelector], true
+  def ng_repeater_rows(repeater, opt = {})
+    ng.get_nodes :findAllRepeaterRows, [repeater], opt
   end
 
   #
   # Node for column binding value in row
   #
+  # @param opt
+  # - :row
+  # - :using
+  # - :rootSelector
+  # - :wait
   # @return nth node
   #
-  def ng_repeater_column(repeater, binding, row = 0, using = nil , rootSelector = 'body')
-    ng_repeater_columns(repeater, binding, using, rootSelector)[row]
+  def ng_repeater_column(repeater, binding, opt = {})
+    row = ng.row(opt)
+    ng_repeater_columns(repeater, binding, opt)[row]
   end
 
   #
   # Node for column binding value in all rows
   #
+  # @param opt
+  # - :using
+  # - :rootSelector
+  # - :wait
   # @return [node, ...]
   #
-  def ng_repeater_columns(repeater, binding, using = nil , rootSelector = 'body')
-    ng.make_call :findRepeaterColumn, [repeater, binding, using, rootSelector], true
+  def ng_repeater_columns(repeater, binding, opt = {})
+    ng.get_nodes :findRepeaterColumn, [repeater, binding], opt
   end
 
   #
+  # @param opt
+  # - :row
+  # - :using
+  # - :rootSelector
+  # - :wait
   # @return nth node
   #
-  def ng_repeater_element(repeater, index, binding, row = 0, using = nil, rootSelector = 'body')
-    ng_repeater_elements(repeater, index, binding, using, rootSelector)[row]
+  def ng_repeater_element(repeater, index, binding, opt = {})
+    row = ng.row(opt)
+    ng_repeater_elements(repeater, index, binding, opt)[row]
   end
 
   #
+  # @param opt
+  # - :using
+  # - :rootSelector
+  # - :wait
   # @return [node, ...]
   #
-  def ng_repeater_elements(repeater, index, binding, using = nil, rootSelector = 'body')
-    ng.make_call :findRepeaterElement, [repeater, index, binding, using, rootSelector], true
+  def ng_repeater_elements(repeater, index, binding, opt = {})
+    ng.get_nodes :findRepeaterElement, [repeater, index, binding], opt
   end
 end
 end

data/lib/angular/setup.rb

@@ -11,9 +11,40 @@ module Angular
       Waiter.new(self).wait_until_ready
     end
 
-    def make_call(method, params, nodes)
-      ng_wait
+    def row(opt)
+      opt.has_key?(:row) ? opt[:row] : 0
+    end
+
+    #
+    # @param opt
+    # - :using
+    # - :rootSelector
+    # - :wait
+    #
+    def get_nodes(method, params, opt = {})
+      opt = {
+        nodes: true,
+        using: nil,
+        rootSelector: 'body',
+      }.merge(opt)
+      make_call(method, params, opt)
+    end
+
+    #
+    # @param opt
+    # - :nodes
+    # - :wait
+    #
+    def make_call(method, params, opt = {})
+      opt = {
+        nodes: false,
+        wait: true,
+      }.merge(opt)
+
+      ng_wait if opt[:wait]
 
+      params << opt[:using] if opt.has_key?(:using)
+      params << opt[:rootSelector] if opt.has_key?(:rootSelector)
       js_params = params.map do |p|
         if p.nil?
           'null'
@@ -26,12 +57,12 @@ module Angular
       end
 
       js = "#{method}(#{js_params.join(', ')});"
-      logger.info js
+      logger.debug js
 
       js_result = page.evaluate_script(js);
-      logger.info js_result
+#      logger.debug js_result
 
-      if nodes
+      if opt[:nodes]
         make_result method, params, js_result
       else
         js_result

data/lib/angular/version.rb

@@ -1,3 +1,3 @@
 module Angular
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capybara-ng
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - kari
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-01 00:00:00.000000000 Z
+date: 2014-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -68,6 +68,7 @@ files:
 - Rakefile
 - capybara-ng.gemspec
 - lib/angular.rb
+- lib/angular/capybara_setup.rb
 - lib/angular/client_script.rb
 - lib/angular/driver.rb
 - lib/angular/dsl.rb