page_navigation 0.1

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/.rspec

@@ -0,0 +1,2 @@
+--color
+--format doc

data/.rvmrc

@@ -0,0 +1,2 @@
+rvm --create use 1.9.3-p194@page-object  
+

data/ChangeLog

@@ -0,0 +1,2 @@
+=== Version 0.1 / 2013-1-25
+* This is the initial release of this gem

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jeffrey S. Morgan
+
+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,29 @@
+# PageNavigation
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'page_navigation'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install page_navigation
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+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,14 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.ruby_opts = "-I lib:spec"
+  spec.pattern = 'spec/**/*_spec.rb'
+end
+task :spec
+
+task :lib do
+  $LOAD_PATH.unshift(File.expand_path("lib", File.dirname(__FILE__)))
+end
+
+task :default => :spec

data/lib/page_navigation.rb

@@ -0,0 +1,103 @@
+require "page_navigation/version"
+require "page_navigation/routes"
+
+#
+# Implements basic navigation capabilities for a collection of classes
+# that implement a PageObject like pattern.
+#
+# In order to use these two methods you must define routes.  A route
+# is cimply an array of Class/Method calls and can contain parameters
+# that can be passed to the methods.  Here is an example:
+#
+# @example Example routes defined in env.rb
+#   MyNavigator.routes = {
+#     :default => [[PageOne,:method1], [PageTwoA,:method2], [PageThree,:method3]],
+#     :another_route => [[PageOne,:method1, "arg1"], [PageTwoB,:method2b], [PageThree,:method3]]
+#   }
+#
+# Notice the first entry of :anouther_route is passing an argument
+# to the method.
+#
+# The user must also maintain an instance variable named @current_page
+# which points to the current object in the array.
+# 
+module PageNavigation
+
+  def self.included(cls)
+    cls.extend PageNavigation::Routes
+  end
+
+
+  #
+  # Navigate to a specific page following a predefined path.
+  #
+  # This method requires a lot of setup.  See the documentation for
+  # this module.  Once the setup is complete you can navigate to a
+  # page traversing through all other pages along the way.  It will
+  # call the method you specified in the routes for each
+  # page as it navigates.  Using the example setup defined in the
+  # documentation above you can call the method two ways:
+  #
+  # @example
+  #   page.navigate_to(PageThree)  # will use the default path
+  #   page.navigate_to(PageThree, :using => :another_route)
+  #
+  # @param [PageObject]  a class that implements the PageObject pattern.
+  # @param [Hash] a hash that contains an element with the key
+  # :using.  This will be used to lookup the route.  It has a
+  # default value of :default.
+  # @param [block]  an optional block to be called
+  # @return [PageObject] the page you are navigating to
+  #
+  def navigate_to(page_cls, how = {:using => :default}, &block)
+    path = path_for how
+    to_index = find_index_for(path, page_cls)-1
+    navigate_through_pages(path[0..to_index])
+    on(page_cls, &block)
+  end
+
+  #
+  # Same as navigate_to except it will start at the @current_page
+  # instead the beginning of the path.
+  #
+  # @param [PageObject]  a class that implements the PageObject pattern.
+  # @param [Hash] a hash that contains an element with the key
+  # :using.  This will be used to lookup the route.  It has a
+  # default value of :default.
+  # @param [block]  an optional block to be called
+  # @return [PageObject] the page you are navigating to
+  #
+  def continue_navigation_to(page_cls, how = {:using => :default}, &block)
+    path = path_for how
+    from_index = find_index_for(path, @current_page.class)+1
+    to_index = find_index_for(path, page_cls)-1
+    navigate_through_pages(path[from_index..to_index])
+    on(page_cls, &block)
+  end
+
+  
+  private
+
+  def path_for(how)
+    path = self.class.routes[how[:using]]
+    fail("PageFactory route :#{how[:using].to_s} not found") unless path
+    path
+  end
+  
+  def navigate_through_pages(pages)
+    pages.each do |cls, method, *args|
+      page = on(cls)
+      fail("Navigation method not specified on #{cls}.") unless page.respond_to? method
+      page.send method unless args
+      page.send method, *args if args
+    end
+  end
+
+  def find_index_for(path, item)
+    path.find_index { |each| each[0] == item}
+  end
+
+  def self.included(cls)
+    cls.extend PageNavigation::Routes
+  end
+end

data/lib/page_navigation/routes.rb

@@ -0,0 +1,10 @@
+module PageNavigation
+  module Routes
+    attr_accessor :routes
+    
+    def routes=(routes)
+      raise("You must provide a :default route") unless routes[:default]
+      @routes = routes
+    end
+  end
+end

data/lib/page_navigation/version.rb

@@ -0,0 +1,3 @@
+module PageNavigation
+  VERSION = "0.1"
+end

data/page_navigation.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'page_navigation/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "page_navigation"
+  gem.version       = PageNavigation::VERSION
+  gem.platform      = Gem::Platform::RUBY
+  gem.authors       = ["Jeffrey S. Morgan"]
+  gem.email         = ["jeff.morgan@leandog.com"]
+  gem.homepage      = "http://github.com/cheezy/page_naigation"
+  gem.description   = %q{Provides basic navigation through a collection of items that use the PageObject pattern.}
+  gem.summary       = %q{Provides basic navigation through a collection of items that use the PageObject pattern.}
+
+  gem.rubyforge_project = "page_naigation"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_development_dependency 'rspec', '>= 2.12.0'
+
+end

data/spec/lib/page_navigation_spec.rb

@@ -0,0 +1,89 @@
+require 'spec_helper'
+
+class FactoryTestPage
+end
+
+class AnotherPage
+end
+
+class YetAnotherPage
+end
+
+class TestNavigator
+  include PageNavigation
+  attr_accessor :current_page
+
+  def on(cls)
+    cls.new
+  end
+
+  def class_from_string(str)
+    str.split('::').inject(Object) do |mod, class_name|
+      mod.const_get(class_name)
+    end
+  end
+end
+
+describe PageNavigation do
+  before(:each) do
+    @navigator = TestNavigator.new
+  end
+
+  it "should raise an error when you do not provide a default route" do
+    expect { TestNavigator.routes = {:another => []} }.to raise_error
+  end
+
+  it "should store the routes" do
+    routes = ['a', 'b', 'c']
+    TestNavigator.routes = {:default => routes}
+    TestNavigator.routes[:default].should == routes
+  end
+
+  it "should navigate to a page calling the default methods" do
+    pages = [[FactoryTestPage, :a_method], [AnotherPage, :b_method]]
+    TestNavigator.routes = {:default => pages}
+    fake_page = double('a_page')
+    FactoryTestPage.should_receive(:new).and_return(fake_page)
+    fake_page.should_receive(:a_method)
+    @navigator.navigate_to(AnotherPage).class.should == AnotherPage
+  end
+
+  it "should pass parameters to methods when navigating" do
+    pages = [[FactoryTestPage, :a_method, 'blah'], [AnotherPage, :b_method]]
+    TestNavigator.routes = {:default => pages}
+    fake_page = double('a_page')
+    FactoryTestPage.should_receive(:new).and_return(fake_page)
+    fake_page.should_receive(:a_method).with('blah')
+    @navigator.navigate_to(AnotherPage).class.should == AnotherPage
+  end
+
+  it "should fail when it does not find a proper route" do
+    TestNavigator.routes = {:default => ['a'], :another => ['b']}
+    expect { @navigator.navigate_to(AnotherPage, :using => :no_route) }.to raise_error
+  end
+
+  it "should fail when no default method specified" do
+    TestNavigator.routes = {
+      :default => [[FactoryTestPage, :a_method], [AnotherPage, :b_method]]
+    }
+    fake_page = double('a_page')
+    FactoryTestPage.should_receive(:new).and_return(fake_page)
+    fake_page.should_receive(:respond_to?).with(:a_method).and_return(false)
+    expect { @navigator.navigate_to(AnotherPage) }.to raise_error
+  end
+
+  it "should know how to continue routng from a location" do
+    TestNavigator.routes = {
+      :default => [[FactoryTestPage, :a_method],
+                   [AnotherPage, :b_method],
+                   [YetAnotherPage, :c_method]]
+    }
+    fake_page = double('a_page')
+    AnotherPage.should_receive(:new).and_return(fake_page)
+    fake_page.should_receive(:respond_to?).with(:b_method).and_return(true)
+    fake_page.should_receive(:b_method)
+    @navigator.current_page = FactoryTestPage.new
+    FactoryTestPage.should_not_receive(:new)
+    @navigator.continue_navigation_to(YetAnotherPage).class.should == YetAnotherPage
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+# encoding: utf-8
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rspec'
+require 'page_navigation'

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: page_navigation
+version: !ruby/object:Gem::Version
+  version: '0.1'
+  prerelease: 
+platform: ruby
+authors:
+- Jeffrey S. Morgan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.12.0
+description: Provides basic navigation through a collection of items that use the
+  PageObject pattern.
+email:
+- jeff.morgan@leandog.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- ChangeLog
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/page_navigation.rb
+- lib/page_navigation/routes.rb
+- lib/page_navigation/version.rb
+- page_navigation.gemspec
+- spec/lib/page_navigation_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/cheezy/page_naigation
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2015481616432211171
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2015481616432211171
+requirements: []
+rubyforge_project: page_naigation
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Provides basic navigation through a collection of items that use the PageObject
+  pattern.
+test_files:
+- spec/lib/page_navigation_spec.rb
+- spec/spec_helper.rb