lite_page 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 472e81de60d3f72173b40e0189907b1aebdb0356
+  data.tar.gz: e710915875c2abc4eea118c9e9159f7146b4ff96
+SHA512:
+  metadata.gz: ac557b2b637f0a35f5cc40f93d6076a1bc8a2d396b397c5dcbab005d8322d3897457d32022a0d0437129bab147eef6ddcce41696259908ffbe3d893c5e29d884
+  data.tar.gz: f7347d54c3e324b1f0a014b2fe9e650ac33be8f219ecd938bce074ce07a6a7492d9da6aa9e94b87acf358b364ddd948e04eaa67e6890b31bbeb022150e23b874

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.ruby-gemset

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

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.1.0

data/.travis.yml

@@ -0,0 +1,17 @@
+language: ruby
+cache: bundler
+
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - 2.2.1
+
+script: 'bundle exec rake test'
+
+notifications:
+  email:
+    recipients:
+      - sclarkdev@gmail.com
+    on_failure: change
+    on_success: never

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in lite_page.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Scott Clark
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,58 @@
+# 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)
+
+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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'lite_page'
+
+And then execute:
+
+    $ bundle
+
+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.
+```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.
+```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 log_in(username, password)
+    self.username.set(username)
+    self.password.set(password)
+    self.log_in_button.click
+  end
+end
+```
+
+Visit and interact with your page objects.
+```ruby
+visit(LoginPage).login('afinch', 'pa55w0rd')
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/saclark/lite_page/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`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,17 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'coveralls/rake/task'
+require 'yard'
+
+Coveralls::RakeTask.new
+
+Rake::TestTask.new do |t|
+  t.pattern = "test/*_test.rb"
+end
+
+YARD::Rake::YardocTask.new do |t|
+  t.files = ['lib/**/*.rb']
+  t.options = ['--output-dir', 'doc/app/']
+end
+
+task :default => [:test]

data/lib/lite_page.rb

@@ -0,0 +1,44 @@
+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
+
+  # Initializes the page instance and sets the browser instance
+  #
+  # @param browser [Object] the browser instance
+  # @return [Object] the browser instance
+  def initialize(browser)
+    @browser = browser
+  end
+
+  module ClassMethods
+    # Defines an instance method `page_url` which returns the url passed to this
+    # method and takes optional query parameters that will be appended to the
+    # url if given.
+    #
+    # @param url [String] the page url
+    # @return [Symbol] the name of the defined method (ruby 2.1+)
+    def page_url(url)
+      define_method(:page_url) do |query_params = {}|
+        uri = URI(url)
+        existing_params = URI.decode_www_form(uri.query || '')
+        new_params = query_params.to_a
+
+        unless existing_params.empty? && new_params.empty?
+          combined_params = existing_params.push(*new_params)
+          uri.query = URI.encode_www_form(combined_params)
+        end
+
+        uri.to_s
+      end
+    end
+  end
+end

data/lib/lite_page/element_factory.rb

@@ -0,0 +1,18 @@
+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/lib/lite_page/page_initializers.rb

@@ -0,0 +1,33 @@
+module LitePage
+  module PageInitializers
+    # Initializes an instance of the given page class, drives the given browser
+    # instance to the page's url with any given query parameters appended,
+    # yields the page instance to a block if given, and returns the page instance.
+    #
+    # @param page_class [Class] the page class
+    # @param query_params [Hash, Array] the query parameters to append to the page url to viist
+    # @param browser [Object] the browser instance
+    # @yield [page] yields page instance to a block
+    def visit(page_class, query_params = {}, browser = @browser)
+      page = page_class.new(browser)
+
+      url = query_params.empty? ? page.page_url : page.page_url(query_params)
+      browser.goto(url)
+
+      yield page if block_given?
+      page
+    end
+
+    # Initializes and returns an instance of the given page class. Yields the
+    # page instance to a block if given.
+    #
+    # @param page_class [Class] the page class
+    # @param browser [Object] the browser instance
+    # @yield [page] yields page instance to a block
+    def on(page_class, browser = @browser)
+      page = page_class.new(browser)
+      yield page if block_given?
+      page
+    end
+  end
+end

data/lib/lite_page/version.rb

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

data/lite_page.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lite_page/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'lite_page'
+  spec.version       = LitePage::VERSION
+  spec.authors       = ['Scott Clark']
+  spec.email         = ['sclarkdev@gmail.com']
+  spec.summary       = %q{A Page Object Model DSL for watir-webdriver}
+  spec.description   = %q{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.}
+  spec.homepage      = 'http://github.com/saclark/lite_page'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'watir-webdriver'
+
+  spec.required_ruby_version = '>= 1.9.3'
+
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake', '~> 10.1'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'coveralls', '~> 0.7'
+  spec.add_development_dependency 'minitest-reporters'
+  spec.add_development_dependency 'yard'
+end

data/test/element_factory_test.rb

@@ -0,0 +1,35 @@
+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

data/test/lite_page_test.rb

@@ -0,0 +1,71 @@
+require_relative 'test_helper'
+
+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)
+        page.is_a?(LitePage::ClassMethods).must_equal(true)
+      end
+    end
+
+    describe '#initialize' do
+      it 'should assign its argument to @browser' do
+        page.new('browser').instance_variable_defined?(:@browser).must_equal(true)
+        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

data/test/page_initializers_test.rb

@@ -0,0 +1,81 @@
+require_relative 'test_helper'
+
+class PageInitializersTest < Minitest::Spec
+  describe LitePage::PageInitializers do
+    let(:browser) do
+      Class.new do
+        attr_reader :location
+        def goto(url)
+          @location = url
+        end
+      end
+    end
+
+    let(:page) do
+      Class.new do
+        include LitePage
+        page_url('http://www.example.com/page')
+      end
+    end
+
+    let(:world) do
+      Class.new do
+        include LitePage::PageInitializers
+        attr_accessor :browser
+        def initialize(browser); @browser = browser; end
+      end
+    end
+
+    before do
+      @world = world.new(browser.new)
+    end
+
+    describe '#visit' do
+      it 'should visit the page url' do
+        @world.browser.location.must_be_nil
+        @world.visit(page)
+        @world.browser.location.must_equal('http://www.example.com/page')
+      end
+
+      it 'should visit the page url with any given query parameters' do
+        @world.browser.location.must_be_nil
+        @world.visit(page, :foo => 'bar')
+        @world.browser.location.must_equal('http://www.example.com/page?foo=bar')
+      end
+
+      it 'should yeild an instance of the given page class to any given block' do
+        @world.visit(page) { |page_instance| page_instance.must_be_instance_of page }
+      end
+
+      it 'should visit the page before yielding to a given block' do
+        @world.browser.location.must_be_nil
+        @world.visit(page) { |_| @world.browser.location.must_equal('http://www.example.com/page') }
+        @world.browser.location.must_equal('http://www.example.com/page')
+      end
+
+      it 'should return an instance of the given page class' do
+        @world.visit(page).must_be_instance_of page
+      end
+
+      it 'should accept a browser instance defaulting to @browser' do
+        @world.visit(page, {}, browser.new)
+        @world.visit(page).instance_variable_get(:@browser).must_be_same_as(@world.browser)
+      end
+    end
+
+    describe '#on' do
+      it 'should return an instance of the given page class' do
+        @world.on(page).must_be_instance_of page
+      end
+
+      it 'should yeild an instance of the given page class to any given block' do
+        @world.on(page) { |page_instance| page_instance.must_be_instance_of page }
+      end
+
+      it 'should accept an optional browser instance defaulting to @browser' do
+        @world.on(page, browser.new)
+        @world.on(page).instance_variable_get(:@browser).must_be_same_as(@world.browser)
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,12 @@
+require 'simplecov'
+require 'coveralls'
+require 'minitest/autorun'
+require 'minitest/reporters'
+require 'minitest/spec'
+
+Minitest::Reporters.use!(Minitest::Reporters::SpecReporter.new)
+SimpleCov.formatter = SimpleCov::Formatter::HTMLFormatter
+SimpleCov.start { add_filter '/test/' }
+Coveralls.wear!
+
+require 'lite_page'

metadata

@@ -0,0 +1,167 @@
+--- !ruby/object:Gem::Specification
+name: lite_page
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Scott Clark
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: watir-webdriver
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 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.
+email:
+- sclarkdev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- 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/lite_page_test.rb
+- test/page_initializers_test.rb
+- test/test_helper.rb
+homepage: http://github.com/saclark/lite_page
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A Page Object Model DSL for watir-webdriver
+test_files:
+- test/element_factory_test.rb
+- test/lite_page_test.rb
+- test/page_initializers_test.rb
+- test/test_helper.rb
+has_rdoc: