tapestry 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 736bda0dd5708d733bcf8462852fc6cfb85f83d7
-  data.tar.gz: 05c9cddcef3a79a481218722289f8b17a76cbb2f
+  metadata.gz: 2c86a3e97f5b536ef792a2f328ab1c89730dba52
+  data.tar.gz: 05868d9a03e465878d552706e4fb1edf9d7b0c54
 SHA512:
-  metadata.gz: 8b15fa2ecd4c7062d16bd774fdfabf228fe0baa5de65e402c2f1b55bdc7e312422014f8d739560a79c73eee8713f205f725f0578cd91fdd89240ac6ba2f81afa
-  data.tar.gz: 39c0bd51b96fb07e6ff01f5e6483203a65051910457cff7a93fbd25fbd99f036722344dc055a6682157badd394ff346d2bd3c498f6f49707e4704b5ee4b7ed5c
+  metadata.gz: cde8c77355467aa19b00036ec2c5d7005a030bafc7c8fda922c038904bdbd360695ee00f2add1e79cbda1647bedae1ed189c02f258644ab3deaf0317df63cebf
+  data.tar.gz: c0acd68c6e51f6eea985c4add3c6a4b071bd8865fa9e6be67431a253478f00c1709f7b9ff8d9e33650e3cdfbcef68cbf60e0010cf75be48280da4d4292db2dfb

data/.gitignore

@@ -7,6 +7,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+/.ruby-version
 
 # rspec failure tracking
 .rspec_status

data/.hound.yml

@@ -5,8 +5,8 @@ AllCops:
     - spec/**/*
 
 # Removing need for frozen string literal comment.
-#Style/FrozenStringLiteralComment:
-#  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false
 
 # Removing the preference for string single quotes.
 Style/StringLiterals:
@@ -60,3 +60,9 @@ Metrics/MethodLength:
 # Encourage fewer parameters.
 Metrics/ParameterLists:
   Max: 4
+
+# Allow methods with has_ for predicates.
+Style/PredicateName:
+  NameWhitelist:
+    - has_correct_url?
+    - has_correct_title?

data/.travis.yml

@@ -3,3 +3,7 @@ language: ruby
 rvm:
   - 2.3.1
 before_install: gem install bundler -v 1.14.3
+
+branches:
+  only:
+    - master

data/README.md

@@ -1,5 +1,11 @@
 # Tapestry
 
+[![Build Status](https://travis-ci.org/jeffnyman/tapestry.svg)](https://travis-ci.org/jeffnyman/tapestry)
+[![Gem Version](https://badge.fury.io/rb/tapestry.svg)](http://badge.fury.io/rb/tapestry)
+[![License](http://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/jeffnyman/tapestry/blob/master/LICENSE.md)
+
+[![Dependency Status](https://gemnasium.com/jeffnyman/tapestry.png)](https://gemnasium.com/jeffnyman/tapestry)
+
 > _Nature uses only the longest threads to weave her patterns, so that each
 > small piece of her fabric reveals the organization of the entire tapestry._
 >
@@ -57,6 +63,9 @@ You can also install Tapestry just as you would any other gem:
 Probably the best way to get a feel for the current state of the code is to look at the examples:
 
 * [Simple script](https://github.com/jeffnyman/tapestry/blob/master/examples/tapestry-simple.rb)
+* [Factory script](https://github.com/jeffnyman/tapestry/blob/master/examples/tapestry-factory.rb)
+* [Data Set script](https://github.com/jeffnyman/tapestry/blob/master/examples/tapestry-data-set.rb)
+* [Events script](https://github.com/jeffnyman/tapestry/blob/master/examples/tapestry-events.rb)
 
 You'll see references to "Veilus" and a "localhost" in the script. I'm using my own [Veilus application](https://veilus.herokuapp.com/). As far as the localhost, you can use the [Veilus repo](https://github.com/jeffnyman/veilus) to get a local copy to play around with.
 

data/Rakefile

@@ -13,6 +13,16 @@ namespace :script do
   task :simple do
     system("ruby ./examples/tapestry-simple.rb")
   end
+
+  desc "Run the Tapestry factory script"
+  task :factory do
+    system("ruby ./examples/tapestry-factory.rb")
+  end
+
+  desc "Run the Tapestry data setter script"
+  task :data_set do
+    system("ruby ./examples/tapestry-data-set.rb")
+  end
 end
 
 namespace :spec do

data/examples/tapestry-data-set.rb

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+$: << "./lib"
+
+require "rspec"
+include RSpec::Matchers
+
+require "tapestry"
+include Tapestry::Factory
+
+class WarpTravel
+  include Tapestry
+
+  url_is    "http://localhost:9292/warp"
+
+  text_field :warp_factor, id: 'warpInput'
+  text_field :velocity,    id: 'velocityInput'
+  text_field :distance,    id: 'distInput'
+end
+
+Tapestry.start_browser
+
+on_view(WarpTravel).using_data("warp factor": 1, velocity: 1, distance: 4.3)
+
+Tapestry.quit_browser

data/examples/tapestry-events.rb

@@ -0,0 +1,42 @@
+#!/usr/bin/env ruby
+$: << "./lib"
+
+require "rspec"
+include RSpec::Matchers
+
+require "tapestry"
+
+class Dynamic
+  include Tapestry
+
+  url_is "http://localhost:9292/practice/dynamic_events"
+
+  button :long,  id: 'long'
+  button :quick, id: 'quick'
+  button :stale, id: 'stale'
+  button :fade,  id: 'fade'
+
+  div :dom_events,    id: 'container1'
+  div :stale_event,   id: 'container2'
+  div :effect_events, id: 'container3'
+end
+
+Tapestry.start_browser
+
+page = Dynamic.new
+
+page.visit
+
+expect(page.dom_events.dom_updated?).to be_truthy
+expect(page.dom_events.wait_until(&:dom_updated?).spans.count).to eq(0)
+
+page.long.click
+
+expect(page.dom_events.dom_updated?).to be_falsey
+expect(page.dom_events.wait_until(&:dom_updated?).spans.count).to eq(5)
+
+page.quick.click
+
+expect(page.dom_events.wait_until(&:dom_updated?).spans.count).to eq(25)
+
+Tapestry.quit_browser

data/examples/tapestry-factory.rb

@@ -0,0 +1,56 @@
+#!/usr/bin/env ruby
+$: << "./lib"
+
+require "rspec"
+include RSpec::Matchers
+
+require "tapestry"
+include Tapestry::Factory
+
+puts Tapestry::VERSION
+
+class Home
+  include Tapestry
+
+  url_is "http://localhost:9292"
+
+  p          :login_form, id: "open", visible: true
+  text_field :username,   id: "username"
+  text_field :password
+  button     :login,      id: "login-button"
+  div        :message,    class: 'notice'
+
+  #element :login_form, id: "open", visible: true
+  #element :username,   id: "username"
+  #element :password
+  #element :login,      id: "login-button"
+end
+
+class Navigation
+  include Tapestry
+
+  p     :page_list,     id: 'navlist'
+  link  :planets,       id: 'planets'
+
+  image :planet_logo,   id: 'planet-logo'
+end
+
+Tapestry.set_browser :chrome
+
+on_view(Home)
+
+on(Home) do
+  @context.login_form.click
+  @context.username.set "admin"
+  @context.password(id: 'password').set "admin"
+  @context.login.click
+  expect(@context.message.text).to eq('You are now logged in as admin.')
+end
+
+on(Navigation) do
+  @context.page_list.wait_until(&:dom_updated?).click
+  @context.planets.click
+  expect(@context.planet_logo.exists?).to be true
+end
+
+Tapestry.quit_browser

data/examples/tapestry-simple.rb

@@ -7,28 +7,86 @@ include RSpec::Matchers
 require "tapestry"
 
 puts Tapestry::VERSION
-
-browser = Watir::Browser.new
+puts Tapestry.version
+puts Tapestry.dependencies
+puts Tapestry.elements?
+puts Tapestry.recognizes?("div")
 
 class Home
   include Tapestry
 
+  url_is "http://localhost:9292/"
+  url_matches /:\d{4}/
+  title_is "Veilus"
+
+  # Elements can be defined with HTML-style names as found in Watir.
   p          :login_form, id: "open", visible: true
   text_field :username,   id: "username"
   text_field :password
   button     :login,      id: "login-button"
+  div        :message,    class: 'notice'
 
+  # Elements can be defined with a generic name.
   #element :login_form, id: "open", visible: true
   #element :username,   id: "username"
   #element :password
   #element :login,      id: "login-button"
 end
 
-browser.goto("http://localhost:9292")
-page = Home.new(browser)
+class Navigation
+  include Tapestry
+
+  p     :page_list,     id: 'navlist'
+  link  :planets,       id: 'planets'
+
+  image :planet_logo,   id: 'planet-logo'
+
+  def begin_with
+    move_to(0, 0)
+    resize_to(screen_width, screen_height)
+  end
+end
+
+Tapestry.start_browser
+
+page = Home.new
+
+expect(Tapestry.browser).to be_an_instance_of(Watir::Browser)
+expect(Tapestry.browser.driver).to be_an_instance_of(Selenium::WebDriver::Driver)
+
+expect(page).to be_a_kind_of(Tapestry)
+expect(page).to be_an_instance_of(Home)
+
+# You can specify a URL to visit or you can rely on the provided
+# url_is attribute on the page definition.
+#page.visit("http://localhost:9292")
+page.visit
+
+expect(page.url).to eq(page.url_attribute)
+expect(page.url).to match(page.url_match_attribute)
+expect(page.title).to eq(page.title_attribute)
+
+expect(page.secure?).to be_falsey
+expect(page).not_to be_secure
+
+expect(page.has_correct_url?).to be_truthy
+expect(page).to have_correct_url
+
+expect(page.displayed?).to be_truthy
+expect(page).to be_displayed
+
+expect(page.has_correct_title?).to be_truthy
+expect(page).to have_correct_title
+
 page.login_form.click
 page.username.set "admin"
 page.password(id: 'password').set "admin"
 page.login.click
+expect(page.message.text).to eq('You are now logged in as admin.')
+
+page = Navigation.new
+page.page_list.wait_until(&:dom_updated?).click
+page.planets.click
+expect(page.planet_logo.exists?).to be true
 
-browser.quit()
+Tapestry.quit_browser

data/lib/tapestry.rb

@@ -1,15 +1,53 @@
 require "tapestry/version"
 require "tapestry/element"
+require "tapestry/factory"
+require "tapestry/interface"
+require "tapestry/attribute"
+require "tapestry/ready"
+
+require "tapestry/extensions/dom_observer"
+require "tapestry/extensions/data_setter"
+require "tapestry/extensions/watir_elements"
 
 require "watir"
 
 module Tapestry
   def self.included(caller)
     caller.extend Tapestry::Element
+    caller.extend Tapestry::Interface::Page::Attribute
+    caller.__send__ :include, Tapestry::Ready
     caller.__send__ :include, Tapestry::Locator
+    caller.__send__ :include, Tapestry::Interface::Page
+    caller.__send__ :include, Tapestry::DataSetter
+  end
+
+  def initialize(browser = nil, &block)
+    @browser = Tapestry.browser unless Tapestry.browser.nil?
+    @browser = browser if Tapestry.browser.nil?
+    begin_with if respond_to?(:begin_with)
+    instance_eval(&block) if block
   end
 
-  def initialize(browser)
-    @browser = browser
+  # This accessor is needed so that internal API calls, like `markup` or
+  # `text`, have access to the browser instance. This is an instance-level
+  # access to the browser.
+  attr_accessor :browser
+
+  class << self
+    # This accessor is needed so that Tapestry itself can provide a browser
+    # reference to indicate connection to WebDriver. This is a class-level
+    # access to the browser.
+    attr_accessor :browser
+
+    def set_browser(app = :chrome, *args)
+      @browser = Watir::Browser.new(app, *args)
+      Tapestry.browser = @browser
+    end
+
+    alias start_browser set_browser
+
+    def quit_browser
+      @browser.quit
+    end
   end
 end

data/lib/tapestry/attribute.rb

@@ -0,0 +1,40 @@
+require "tapestry/situation"
+
+module Tapestry
+  module Interface
+    module Page
+      module Attribute
+        include Situation
+
+        def url_is(url = nil)
+          url_is_empty if url.nil? && url_attribute.nil?
+          url_is_empty if url.nil? || url.empty?
+          @url = url
+        end
+
+        def url_matches(pattern = nil)
+          url_match_is_empty if pattern.nil?
+          url_match_is_empty if pattern.is_a?(String) && pattern.empty?
+          @url_match = pattern
+        end
+
+        def title_is(title = nil)
+          title_is_empty if title.nil? || title.empty?
+          @title = title
+        end
+
+        def url_attribute
+          @url
+        end
+
+        def url_match_attribute
+          @url_match
+        end
+
+        def title_attribute
+          @title
+        end
+      end
+    end
+  end
+end

data/lib/tapestry/element.rb

@@ -5,6 +5,14 @@ module Tapestry
 
   NATIVE_QUALIFIERS = %i(visible).freeze
 
+  def elements?
+    @elements
+  end
+
+  def recognizes?(method)
+    @elements.include? method.to_sym
+  end
+
   def elements
     @elements = Watir::Container.instance_methods unless @elements
   end
@@ -16,11 +24,9 @@ module Tapestry
     # element definition.
     Tapestry.elements.each do |element|
       define_method(element) do |*signature, &block|
-        puts "(1) signature: #{signature}"
         identifier, signature = parse_signature(signature)
-        puts "(2) identifier: #{identifier}"
-        puts "(3) signature: #{signature}"
-        define_element_accessor(identifier, signature, element, &block)
+        context = context_from_signature(signature, &block)
+        define_element_accessor(identifier, signature, element, &context)
       end
     end
 
@@ -41,6 +47,26 @@ module Tapestry
       [signature.shift, signature.shift]
     end
 
+    # Returns the block or proc that serves as a context for an element
+    # definition. Consider the following element definitions:
+    #
+    #    ul   :facts, id: 'fact-list'
+    #    span :fact, -> { facts.span(class: 'site-item')}
+    #
+    # Here the second element definition provides a proc that contains a
+    # context for another element definition. That leads to the following
+    # construction being sent to the browser:
+    #
+    #    @browser.ul(id: 'fact-list').span(class: 'site-item')
+    def context_from_signature(*signature, &block)
+      if block_given?
+        block
+      else
+        context = signature.shift
+        context.is_a?(Proc) && signature.empty? ? context : nil
+      end
+    end
+
     # This method provides the means to get the aspects of an accessor
     # signature. The "aspects" refer to the locator information and any
     # qualifier information that was provided along with the locator.
@@ -51,11 +77,9 @@ module Tapestry
     # Note that "qualifiers" here refers to Watir boolean methods.
     def accessor_aspects(element, *signature)
       identifier = signature.shift
-      puts "(4) identifier: #{identifier}"
       locator_args = {}
       qualifier_args = {}
       gather_aspects(identifier, element, locator_args, qualifier_args)
-      puts "(5) QUAL/LOC: #{[locator_args, qualifier_args]}"
       [locator_args, qualifier_args]
     end
 
@@ -147,15 +171,11 @@ module Tapestry
     # like this: ["Drag and Drop"].
     def define_element_accessor(identifier, *signature, element, &block)
       locators, qualifiers = accessor_aspects(element, signature)
-      puts "(6) locators: #{locators}"
-      puts "(7) qualifiers: #{qualifiers}"
       define_method(identifier.to_s) do |*values|
         if block_given?
           instance_exec(*values, &block)
         else
-          puts "(8) values: #{values}"
           locators = values[0] if locators.empty?
-          puts "(9) locators: #{locators} | empty? #{locators.empty?}"
           access_element(element, locators, qualifiers)
         end
       end