lite_page 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 472e81de60d3f72173b40e0189907b1aebdb0356
-  data.tar.gz: e710915875c2abc4eea118c9e9159f7146b4ff96
+  metadata.gz: 71735671e9e4181369dcfe4804f85b2a37b670ee
+  data.tar.gz: 8ddbf2000d882bc268da5e5804f628c80c15ca57
 SHA512:
-  metadata.gz: ac557b2b637f0a35f5cc40f93d6076a1bc8a2d396b397c5dcbab005d8322d3897457d32022a0d0437129bab147eef6ddcce41696259908ffbe3d893c5e29d884
-  data.tar.gz: f7347d54c3e324b1f0a014b2fe9e650ac33be8f219ecd938bce074ce07a6a7492d9da6aa9e94b87acf358b364ddd948e04eaa67e6890b31bbeb022150e23b874
+  metadata.gz: 896939d371bbb321f48c816e3ea5408df25849c3cdb47498d2396535bbeb2ea49ce982ccb1096de0d5c65265ebacaa73f89722d189e011f9ee934c512e899ef6
+  data.tar.gz: 04e2b601eb106a745717681c15a1d5db66b72b22f323c561de9111bf2bf58024493443aa652e2860ece8bb7329fa29ccf85160cd5fd66a634a341c34c9a6cf2b

data/.gitignore

@@ -4,6 +4,7 @@
 .config
 .yardoc
 Gemfile.lock
+vendor/
 InstalledFiles
 _yardoc
 coverage

data/.ruby-version

@@ -1 +1 @@
-ruby-2.1.0
+2.1.0

data/README.md

@@ -1,6 +1,6 @@
 # LitePage
 
-[![Build Status](https://travis-ci.org/saclark/lite_page.svg?branch=master)](https://travis-ci.org/saclark/lite_page) [![Coverage Status](https://coveralls.io/repos/saclark/lite_page/badge.svg)](https://coveralls.io/r/saclark/lite_page)
+[![Gem Version](https://badge.fury.io/rb/lite_page.svg)](http://badge.fury.io/rb/lite_page) [![Build Status](https://travis-ci.org/saclark/lite_page.svg?branch=master)](https://travis-ci.org/saclark/lite_page) [![Coverage Status](https://coveralls.io/repos/saclark/lite_page/badge.svg)](https://coveralls.io/r/saclark/lite_page)
 
 A gem providing a quick, clean, and concise means of implementing the Page Object Model pattern and defining a semantic DSL for automated acceptance tests using watir-webdriver.
 
@@ -18,35 +18,40 @@ Or install it yourself as:
 
     $ gem install lite_page
 
-## Usage
-If you are using cucumber, include the page initialization helper methods in the cucumber World instance.
+## Documentation
+You can find comprehensive [documentation in the wiki](https://github.com/saclark/lite_page/wiki)
+
+### Example Usage
+
+If using cucumber, include `LitePage::PageInitializers` in the `World` instance
 ```ruby
 World(LitePage::PageInitializers)
 ```
 
-Include `LightPage` in your page objects, define a `page_url` (if you want to be able to use the `PageInitializers`), and define elements on the page.
-
-Page elements are defined by calling a method corresponding to the appropriate element type and passing it the name by which you wish to access the element and the selectors used to locate it.
+Define a page object:
 ```ruby
 class LoginPage
   include LitePage
+  
   page_url('http://www.example.com/login')
 
-  text_field(:username, :label => 'Username')
-  text_field(:password, :label => 'Password')
-  button(:log_in_button, :text => 'Log In')
+  def_elements(:@browser, {
+    :username_field => [:text_field, :id => 'username'],
+    :password_field => [:text_field, :id => 'password'],
+    :log_in_button => [:button, :value => 'Log In']
+  })
 
   def log_in(username, password)
-    self.username.set(username)
-    self.password.set(password)
+    self.username_field.set(username)
+    self.password_field.set(password)
     self.log_in_button.click
   end
 end
 ```
 
-Visit and interact with your page objects.
+Interact with the page:
 ```ruby
-visit(LoginPage).login('afinch', 'pa55w0rd')
+visit(LoginPage).log_in('afinch', 'mockingbird60')
 ```
 
 ## Contributing

data/lib/lite_page.rb

@@ -1,13 +1,10 @@
 require 'uri'
-require 'watir-webdriver'
 require 'lite_page/version'
 require 'lite_page/page_initializers'
-require 'lite_page/element_factory'
 
 module LitePage
   # Extends the including class with the ElementFactory and ClassMethods modules.
   def self.included(base)
-    base.extend(ElementFactory)
     base.extend(ClassMethods)
   end
 
@@ -40,5 +37,23 @@ module LitePage
         uri.to_s
       end
     end
+
+    # Provides convenient method for concisely defining element getters
+    #
+    # @param root_elem_var_name [Symbol] the name of the instance variable
+    #   containing the element on which methods should be caleld
+    #   (typically the browser instance).
+    # @param element_definitions [Hash] the hash used to define element getters
+    #   on the class instance where each key represents the name of the method
+    #   to be defined and whose value is an array containing first, the
+    #   element tag name and second, the selectors with which to locate it.
+    def def_elements(root_elem_var_name, element_definitions = {})
+      element_definitions.each do |name, definition|
+        define_method(name) do |other_selectors = {}|
+          definition[1].merge!(other_selectors)
+          instance_variable_get(root_elem_var_name.to_sym).send(*definition)
+        end
+      end
+    end
   end
 end

data/lib/lite_page/version.rb

@@ -1,3 +1,3 @@
 module LitePage
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 end

data/test/class_methods_test.rb

@@ -0,0 +1,94 @@
+require_relative 'test_helper'
+
+class ClassMethodsTest < Minitest::Spec
+  describe LitePage::ClassMethods do
+    let(:page) { Class.new { extend LitePage::ClassMethods } }
+
+    describe '::page_url' do
+      it 'should define a page url instance method' do
+        page.page_url('http://www.example.com')
+        page.new.must_respond_to(:page_url)
+      end
+    end
+
+    describe '#page_url' do
+      it 'should return the url when no arguments passed' do
+        page.page_url('http://www.example.com')
+        page.new.page_url.must_equal('http://www.example.com')
+
+        page.page_url('http://www.example.com?')
+        page.new.page_url.must_equal('http://www.example.com?')
+
+        page.page_url('http://www.example.com?foo=bar')
+        page.new.page_url.must_equal('http://www.example.com?foo=bar')
+      end
+
+      it 'should accept query string parameters as an array or hash' do
+        page.page_url('http://www.example.com')
+        page.new.page_url(:foo => 'bar').must_equal('http://www.example.com?foo=bar')
+
+        page.page_url('http://www.example.com')
+        page.new.page_url([[:foo, 'bar']]).must_equal('http://www.example.com?foo=bar')
+      end
+
+      it 'should create query string if none existed before' do
+        page.page_url('http://www.example.com')
+        page.new.page_url(:foo => 'bar').must_equal('http://www.example.com?foo=bar')
+
+        page.page_url('http://www.example.com')
+        page.new.page_url(:foo => 'bar', :baz => 'qux').must_equal('http://www.example.com?foo=bar&baz=qux')
+      end
+
+      it 'should append query string parameters if some existed before' do
+        page.page_url('http://www.example.com?')
+        page.new.page_url(:foo => 'bar').must_equal('http://www.example.com?foo=bar')
+
+        page.page_url('http://www.example.com?foo=bar')
+        page.new.page_url(:baz => 'qux').must_equal('http://www.example.com?foo=bar&baz=qux')
+
+        page.page_url('http://www.example.com?foo=bar')
+        page.new.page_url(:foo => :bar).must_equal('http://www.example.com?foo=bar&foo=bar')
+
+        page.page_url('http://www.example.com?foo=bar')
+        page.new.page_url(:baz => 'qux', :fizz => 'buzz').must_equal('http://www.example.com?foo=bar&baz=qux&fizz=buzz')
+      end
+    end
+
+    describe '#def_elements' do
+      before do
+        class Browser
+          def echo_args(*args)
+            args
+          end
+
+          alias_method :button, :echo_args
+          alias_method :div, :echo_args
+        end
+
+        class Page
+          extend LitePage::ClassMethods
+
+          def initialize
+            @my_browser = Browser.new
+          end
+        end
+      end
+
+      it 'should define getters for all of the given definitions' do
+        Page.def_elements(:@my_browser, {
+          :foo => [:button, :id => 'foo-element'],
+          :bar => [:div, :class => 'bar-element']
+        })
+
+        Page.new.foo.must_equal([:id => 'foo-element'])
+        Page.new.bar.must_equal([:class => 'bar-element'])
+      end
+
+      it 'should define getters that accept additional selectors' do
+        Page.def_elements(:@my_browser, :foo => [:button, :id => 'foo-element'])
+        result = Page.new.foo(:text => /blah/)
+        result.must_equal([:id => 'foo-element', :text => /blah/])
+      end
+    end
+  end
+end

data/test/lite_page_test.rb

@@ -4,9 +4,9 @@ class LitePageTest < Minitest::Spec
   describe LitePage do
     let(:page) { Class.new { include LitePage } }
 
+
     describe '::included' do
-      it 'should extend the class with ElementFactory and ClassMethods' do
-        page.is_a?(LitePage::ElementFactory).must_equal(true)
+      it 'should extend the class with ClassMethods' do
         page.is_a?(LitePage::ClassMethods).must_equal(true)
       end
     end
@@ -17,55 +17,5 @@ class LitePageTest < Minitest::Spec
         proc { page.new }.must_raise ArgumentError
       end
     end
-
-    describe '::ClassMethods#page_url' do
-      it 'should define a page url instance method' do
-        page.page_url('http://www.example.com')
-        page.new(nil).must_respond_to(:page_url)
-      end
-    end
-
-    describe '#page_url' do
-      it 'should return the url when no arguments passed' do
-        page.page_url('http://www.example.com')
-        page.new(nil).page_url.must_equal('http://www.example.com')
-
-        page.page_url('http://www.example.com?')
-        page.new(nil).page_url.must_equal('http://www.example.com?')
-
-        page.page_url('http://www.example.com?foo=bar')
-        page.new(nil).page_url.must_equal('http://www.example.com?foo=bar')
-      end
-
-      it 'should accept query string parameters as an array or hash' do
-        page.page_url('http://www.example.com')
-        page.new(nil).page_url(:foo => 'bar').must_equal('http://www.example.com?foo=bar')
-
-        page.page_url('http://www.example.com')
-        page.new(nil).page_url([[:foo, 'bar']]).must_equal('http://www.example.com?foo=bar')
-      end
-
-      it 'should create query string if none existed before' do
-        page.page_url('http://www.example.com')
-        page.new(nil).page_url(:foo => 'bar').must_equal('http://www.example.com?foo=bar')
-
-        page.page_url('http://www.example.com')
-        page.new(nil).page_url(:foo => 'bar', :baz => 'qux').must_equal('http://www.example.com?foo=bar&baz=qux')
-      end
-
-      it 'should append query string parameters if some existed before' do
-        page.page_url('http://www.example.com?')
-        page.new(nil).page_url(:foo => 'bar').must_equal('http://www.example.com?foo=bar')
-
-        page.page_url('http://www.example.com?foo=bar')
-        page.new(nil).page_url(:baz => 'qux').must_equal('http://www.example.com?foo=bar&baz=qux')
-
-        page.page_url('http://www.example.com?foo=bar')
-        page.new(nil).page_url(:foo => :bar).must_equal('http://www.example.com?foo=bar&foo=bar')
-
-        page.page_url('http://www.example.com?foo=bar')
-        page.new(nil).page_url(:baz => 'qux', :fizz => 'buzz').must_equal('http://www.example.com?foo=bar&baz=qux&fizz=buzz')
-      end
-    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lite_page
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Scott Clark
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-09 00:00:00.000000000 Z
+date: 2015-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: watir-webdriver
@@ -119,7 +119,6 @@ extra_rdoc_files: []
 files:
 - ".coveralls.yml"
 - ".gitignore"
-- ".ruby-gemset"
 - ".ruby-version"
 - ".travis.yml"
 - Gemfile
@@ -127,11 +126,10 @@ files:
 - README.md
 - Rakefile
 - lib/lite_page.rb
-- lib/lite_page/element_factory.rb
 - lib/lite_page/page_initializers.rb
 - lib/lite_page/version.rb
 - lite_page.gemspec
-- test/element_factory_test.rb
+- test/class_methods_test.rb
 - test/lite_page_test.rb
 - test/page_initializers_test.rb
 - test/test_helper.rb
@@ -155,12 +153,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: A Page Object Model DSL for watir-webdriver
 test_files:
-- test/element_factory_test.rb
+- test/class_methods_test.rb
 - test/lite_page_test.rb
 - test/page_initializers_test.rb
 - test/test_helper.rb

data/.ruby-gemset

@@ -1 +0,0 @@
-LitePage

data/lib/lite_page/element_factory.rb

@@ -1,18 +0,0 @@
-module LitePage
-  # Defines a set of class methods on the including class corresponding to
-  # each of the instance methods available on the `Watir::Container` class.
-  # Each class method takes a symbol or string that will be used to
-  # dynamically define an instance method on the including class that takes
-  # any number of arguments so long as they are valid arguments for the
-  # corresponding `Watir::Container` instance method. When the instance method
-  # is called, it will call the corresponding `Watir::Container` instance method
-  # on the class instance's browser instance along with the parameters given
-  # to the class method.
-  module ElementFactory
-    Watir::Container.instance_methods.each do |tag_name|
-      define_method(tag_name) do |method_name, *args, &block|
-        define_method(method_name) { @browser.send(tag_name, *args, &block) }
-      end
-    end
-  end
-end

data/test/element_factory_test.rb

@@ -1,35 +0,0 @@
-require_relative 'test_helper'
-
-class ElementFactoryTest < Minitest::Spec
-  describe LitePage::ElementFactory do
-    let(:page) do
-      Class.new do
-        extend LitePage::ElementFactory
-        def initialize(browser)
-          @browser = browser
-        end
-      end
-    end
-
-    let(:browser) do
-      Class.new do
-        def button(selectors)
-          "button found using #{selectors.to_s}"
-        end
-      end
-    end
-
-    it 'should define class methods for each Watir::Container instance method' do
-      Watir::Container.instance_methods.each do |method_name|
-        page.must_respond_to method_name
-      end
-    end
-
-    describe 'page elements defined' do
-      it 'should create methods that call the appropriate method on the browser' do
-        page.button(:my_button, :id => 'my-button')
-        page.new(browser.new).my_button.must_equal('button found using {:id=>"my-button"}')
-      end
-    end
-  end
-end