centric_page_navigation 0.12

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d9b36013fd2d7881392710a107d44d95daf1f17213e95137642a36d3fa3c2d8b
+  data.tar.gz: '0583f831e345754c7a2c428ad746394663cc60e1360f4a9054b69d132010e1cb'
+SHA512:
+  metadata.gz: 46866b11e2f4af5dbb5d4267506d1e134ae7d25435a69d40708964ebf0610ff08ea7ae1daa2a21a1e1c865b37128e2d60ac6ea447561dd4ce5112da576f51c30
+  data.tar.gz: 1dba1830cd19a53eb2ed6c17a681efe0a6d0dd0091a7b5310e2d36279342abc3e689e8b6c25d1e0f9a827e24c1e0a939f16e60ba4ddd7f063f7d2c6430fa01bf

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.idea
+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/.ruby-gemset

@@ -0,0 +1 @@
+page-object

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.7.0

data/ChangeLog

@@ -0,0 +1,30 @@
+=== Version 0.10 / 2016-10-18
+* Improved error message when navigation methods are undefined
+* Added optional 'visit' argument to navigate_to and navigate_all to visit first page (Thanks sciros)
+
+=== Version 0.9 / 2013-05-03
+* Added :from entry to navigate_to method call
+
+=== Version 0.8 / 2013-04-26
+* Added navigate_all method to navigate an entire route including the last page
+
+=== Version 0.7 / 2013-2-27
+* Added route_data hash to map a route to a specific DataMagic file
+
+=== Version 0.6 / 2013-2-19
+* Fixed continue_navigation_to to always start with @current_page
+
+=== Version 0.5 / 2013-2-1
+* Fixed with continue_navigation_to not picking the page after @current_page
+
+=== Version 0.4 / 2013-1-28
+* Fixed typo in homepage entry for gemspec
+
+=== Version 0.3 / 2013-1-26
+* Fixed issue when navigating from a page to the same page
+
+=== Version 0.2 / 2013-1-25
+* Fixed minor issue when module is included in module that is included in Class
+
+=== Version 0.1 / 2013-1-25
+* This is the initial release of this gem

data/Gemfile

@@ -0,0 +1,10 @@
+source 'https://rubygems.org'
+
+gem 'centric_data_magic'
+gem 'growl'
+gem 'guard-rspec'
+gem 'rake'
+gem 'rb-fsevent', :require => false if RUBY_PLATFORM =~ /darwin/i
+
+# Specify your gem's dependencies in page_navigation.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,9 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :cli => '--color --format doc' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end
+

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 'centric_page_navigation'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install centric_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/centric_page_navigation.gemspec

@@ -0,0 +1,25 @@
+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          = 'centric_page_navigation'
+  gem.version       = PageNavigation::VERSION
+  gem.platform      = Gem::Platform::RUBY
+  gem.authors       = ['Jeffrey S. Morgan','Dmitry Sharkov', 'Joseph Ours']
+  gem.email         = ['jeff.morgan@leandog.com', 'joseph.ours@centricconsulting.com']
+  gem.homepage      = 'http://github.com/centricconsulting/page_navigation'
+  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 = 'centric_page_navigation'
+
+  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_dependency 'centric_data_magic', '>= 1.2'
+  
+  gem.add_development_dependency 'rspec', '>= 3.4.0'
+end

data/lib/page_navigation/routes.rb

@@ -0,0 +1,21 @@
+module PageNavigation
+  module Routes
+    
+    def routes
+      @routes
+    end
+    
+    def routes=(routes)
+      raise('You must provide a :default route') unless routes[:default]
+      @routes = routes
+    end
+
+    def route_data
+      @route_data 
+    end
+
+    def route_data=(data)
+      @route_data = data
+    end
+  end
+end

data/lib/page_navigation/version.rb

@@ -0,0 +1,3 @@
+module PageNavigation
+  VERSION = '0.12'.freeze
+end

data/lib/page_navigation.rb

@@ -0,0 +1,142 @@
+require 'page_navigation/version'
+require 'page_navigation/routes'
+require 'data_magic'
+
+#
+# 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 simply 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 :another_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
+    @cls = cls
+  end
+
+  def self.cls
+    @cls
+  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] page_cls a class that implements the PageObject pattern.
+  # @param [Hash] how a hash that contains two elements. One with the key
+  # :using.  This will be used to lookup the route.  It has a
+  # default value of :default. The other is with the key :visit. This specifies
+  # whether to explicitly visit the first page. It has a default value of false.
+  # @param [block] block an optional block to be called
+  # @return [PageObject] the page you are navigating to
+  #
+  def navigate_to(page_cls, how = {:using => :default, :visit => false}, &block)
+    how[:using] = :default unless how[:using]
+    how[:visit] = false unless how[:visit]
+    path = path_for how
+    to_index = find_index_for(path, page_cls)-1
+    if to_index == -1
+      return on(page_cls, &block)
+    else
+      start = how[:from] ? path.find_index { |entry| entry[0] == how[:from] } : 0
+      navigate_through_pages(path[start..to_index], how[:visit])
+    end
+    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] page_cls a class that implements the PageObject pattern.
+  # @param [Hash] how 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] 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)
+    to_index = find_index_for(path, page_cls)-1
+    if from_index == to_index
+      navigate_through_pages([path[from_index]], false)
+    else
+      navigate_through_pages(path[from_index..to_index], false)
+    end
+    on(page_cls, &block)
+  end
+
+  #
+  # Navigate through a complete route.
+  #
+  # This method will navigate an entire route executing all of the
+  # methods.  Since it completes the route it does not return any
+  # pages and it does not accept a block.
+  #
+  # @example
+  #   page.navigate_all  # will use the default path
+  #   page.navigate_all(:using => :another_route)
+  #
+  # @param [Hash] how a hash that contains two elements. One with the key
+  # :using.  This will be used to lookup the route.  It has a
+  # default value of :default. The other is with the key :visit. This specifies
+  # whether to explicitly visit the first page. It has a default value of false.
+  #
+  def navigate_all(how = {:using => :default, :visit => false})
+    path = path_for how
+    navigate_through_pages(path[0..-1], how[:visit])
+  end
+  
+  private
+
+  def path_for(how)
+    path = PageNavigation.cls.routes[how[:using]]
+    fail("PageFactory route :#{how[:using].to_s} not found") unless path
+    if PageNavigation.cls.route_data
+      file_to_load = PageNavigation.cls.route_data[how[:using]]
+      DataMagic.load "#{file_to_load.to_s}.yml" if file_to_load
+    end
+    path
+  end
+  
+  def navigate_through_pages(pages, visit)
+    pages.each do |cls, method, *args|
+      page = visit ? visit(cls) : on(cls)
+      visit = false # visit once, for just the first page
+      fail("Navigation method '#{method}' not defined 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
+
+end

data/spec/lib/page_navigation_spec.rb

@@ -0,0 +1,214 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+class FirstPage
+end
+
+class MiddlePage
+end
+
+class LastPage
+end
+
+class TestNavigator
+  include PageNavigation
+  attr_accessor :current_page
+
+  # placeholder for PageFactory's on_page (alias 'on')
+  def on(cls)
+    cls.new
+  end
+
+  # placeholder for PageFactory's visit_page (alias 'visit')
+  def visit(cls)
+    page_instance = cls.new
+    page_instance.visit
+    page_instance
+  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
+    allow(DataMagic).to receive(:load)
+  end
+
+  it 'should raise an error when you do not provide a default route' do
+    expect { TestNavigator.routes = { another: [] } }.to raise_error 'You must provide a :default route'
+  end
+
+  it 'should store the routes' do
+    routes = %w[a b c]
+    TestNavigator.routes = { default: routes }
+    expect(TestNavigator.routes[:default]).to be routes
+  end
+
+  it 'should store route data' do
+    TestNavigator.route_data = { default: :blah }
+    expect(TestNavigator.route_data).to eq({ default: :blah })
+  end
+
+  it 'should navigate to a page calling the default methods' do
+    pages = [[FirstPage, :a_method], [MiddlePage, :b_method]]
+    TestNavigator.routes = { default: pages }
+    fake_page = double('middle_page')
+    expect(FirstPage).to receive(:new).and_return(fake_page)
+    expect(fake_page).to receive(:a_method)
+    expect(@navigator.navigate_to(MiddlePage).class).to be MiddlePage
+  end
+
+  it 'should load the DataMagic file when specified' do
+    pages = [[FirstPage, :a_method], [MiddlePage, :b_method]]
+    TestNavigator.routes = { default: pages }
+    TestNavigator.route_data = { default: :dm_file }
+    fake_page = double('middle_page')
+    expect(FirstPage).to receive(:new).and_return(fake_page)
+    expect(fake_page).to receive(:a_method)
+    expect(DataMagic).to receive(:load).with('dm_file.yml')
+    expect(@navigator.navigate_to(MiddlePage).class).to be MiddlePage
+  end
+
+  it 'should pass parameters to methods when navigating' do
+    pages = [[FirstPage, :a_method, 'blah'], [MiddlePage, :b_method]]
+    TestNavigator.routes = { default: pages }
+    fake_page = double('middle_page')
+    expect(FirstPage).to receive(:new).and_return(fake_page)
+    expect(fake_page).to receive(:a_method).with('blah')
+    expect(@navigator.navigate_to(MiddlePage).class).to be MiddlePage
+  end
+
+  it 'should fail when it does not find a proper route' do
+    TestNavigator.routes = { default: ['a'], another: ['b'] }
+    expect { @navigator.navigate_to(MiddlePage, using: :no_route) }.to raise_error
+  end
+
+  it 'should fail when no default method specified' do
+    TestNavigator.routes = {
+      default: [[FirstPage, :a_method], [MiddlePage, :b_method]]
+    }
+    fake_page = double('middle_page')
+    expect(FirstPage).to receive(:new).and_return(fake_page)
+    expect(fake_page).to receive(:respond_to?).with(:a_method).and_return(false)
+    expect { @navigator.navigate_to(MiddlePage) }.to raise_error
+  end
+
+  it 'should know how to continue routing from a location' do
+    first_page, middle_page, last_page = mock_common_method_calls
+
+    @navigator.current_page = FirstPage.new
+
+    expect(first_page).to receive(:a_method)
+    expect(middle_page).to receive(:b_method)
+
+    expect(@navigator.continue_navigation_to(LastPage).class).to be LastPage
+  end
+
+  it 'should know how to continue routing from a location that is one page from the end' do
+    first_page, middle_page, last_page = mock_common_method_calls
+
+    @navigator.current_page = MiddlePage.new
+
+    expect(first_page).not_to receive(:a_method)
+    expect(middle_page).to receive(:b_method)
+
+    expect(@navigator.continue_navigation_to(LastPage).class).to be LastPage
+  end
+
+  it 'should know how to navigate an entire route including the last page' do
+    first_page, middle_page, last_page = mock_common_method_calls
+
+    expect(first_page).to receive(:a_method)
+    expect(middle_page).to receive(:b_method)
+    expect(last_page).to receive(:c_method)
+
+    @navigator.navigate_all
+  end
+
+  it 'should be able to start in the middle of a route and proceed' do
+    first_page, middle_page, last_page = mock_common_method_calls
+
+    expect(first_page).not_to receive(:a_method)
+    expect(middle_page).to receive(:b_method)
+
+    @navigator.navigate_to(LastPage, from: MiddlePage)
+  end
+
+  it 'should visit page at start of route given visit param set to true' do
+    first_page, middle_page, last_page = mock_common_method_calls
+
+    expect(first_page).to receive(:visit)
+    expect(first_page).to receive(:a_method)
+    expect(middle_page).to receive(:b_method)
+    expect(middle_page).not_to receive(:visit)
+
+    @navigator.navigate_to(LastPage, visit: true)
+  end
+
+  it 'should not visit page at start of route given visit param set to false (explicit)' do
+    first_page, middle_page, last_page = mock_common_method_calls
+
+    expect(first_page).not_to receive(:visit)
+    expect(first_page).to receive(:a_method)
+    expect(middle_page).to receive(:b_method)
+
+    @navigator.navigate_to(LastPage, visit: false)
+  end
+
+  it 'should not visit page at start of route given visit param set to false (default)' do
+    first_page, middle_page, last_page = mock_common_method_calls
+
+    expect(first_page).not_to receive(:visit)
+    expect(first_page).to receive(:a_method)
+    expect(middle_page).to receive(:b_method)
+
+    @navigator.navigate_to(LastPage)
+  end
+
+  it 'should handle specification of both using and visit params' do
+    first_page, middle_page, last_page = mock_common_method_calls
+
+    expect(first_page).to receive(:respond_to?).with(:x_method).at_least(:once).and_return(true)
+    expect(first_page).to receive(:visit)
+    expect(first_page).to receive(:x_method)
+    expect(middle_page).to receive(:respond_to?).with(:y_method).at_least(:once).and_return(true)
+    expect(middle_page).to receive(:y_method)
+    expect(middle_page).not_to receive(:visit)
+
+    @navigator.navigate_to(LastPage, visit: true, using: :alt)
+  end
+end
+
+def mock_common_method_calls
+  TestNavigator.routes = {
+    default: [[FirstPage, :a_method],
+              [MiddlePage, :b_method],
+              [LastPage, :c_method]],
+    alt: [[FirstPage, :x_method],
+          [MiddlePage, :y_method],
+          [LastPage, :z_method]]
+  }
+
+  first_page = FirstPage.new
+  allow(FirstPage).to receive(:new).and_return(first_page)
+  allow(first_page).to receive(:respond_to?).with(:visit).and_return(true)
+  allow(first_page).to receive(:respond_to?).with(:a_method).and_return(true)
+
+  middle_page = MiddlePage.new
+  allow(MiddlePage).to receive(:new).and_return(middle_page)
+  allow(middle_page).to receive(:respond_to?).with(:visit).and_return(true)
+  allow(middle_page).to receive(:respond_to?).with(:b_method).and_return(true)
+
+  last_page = LastPage.new
+  allow(LastPage).to receive(:new).and_return(last_page)
+  allow(last_page).to receive(:respond_to?).with(:visit).and_return(true)
+  allow(last_page).to receive(:respond_to?).with(:c_method).and_return(true)
+
+  [first_page, middle_page, last_page]
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+# 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,93 @@
+--- !ruby/object:Gem::Specification
+name: centric_page_navigation
+version: !ruby/object:Gem::Version
+  version: '0.12'
+platform: ruby
+authors:
+- Jeffrey S. Morgan
+- Dmitry Sharkov
+- Joseph Ours
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-05-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: centric_data_magic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+description: Provides basic navigation through a collection of items that use the
+  PageObject pattern.
+email:
+- jeff.morgan@leandog.com
+- joseph.ours@centricconsulting.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ChangeLog
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- centric_page_navigation.gemspec
+- lib/page_navigation.rb
+- lib/page_navigation/routes.rb
+- lib/page_navigation/version.rb
+- spec/lib/page_navigation_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/centricconsulting/page_navigation
+licenses: []
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+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