page-object-pal 0.1.0

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,3 @@
+--require spec_helper
+--color
+--format progress

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Johnson Denen
+
+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,60 @@
+# PageObjectPal
+
+PageObjectPal keeps an eye on your [page-object](https://github.com/cheezy/page-object) classes, alerting you to outdated element information. Unit test your page classes with PageObjectPal, and don't wait for your acceptance tests to fail!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'page-object-pal'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install page-object-pal
+
+## Usage
+
+PageObjectPal is a self-extending module and needs only one method call. `PageObjectPal#examine` takes three arguments: a class, a filepath, and a URL. It returns ```true``` if your page objects pass, and raises a `PageObjectInvalid` error if they fail.
+
+Call `PageObjectPal#examine` from your specs:
+```ruby
+require 'page-object-pal'
+describe Page do
+  it "should reference valid elements in its methods" do
+    PageObjectPal.examine(Page, '/path/to/Page', 'http://www.page.com').should be_true
+  end
+end
+```
+
+Or wrap `PageObjectPal#examine` in a class method to be called in your specs:
+```ruby
+require 'page-object'
+require 'page-object-pal'
+class Page
+  include 'PageObject'
+  def self.examine
+    PageObjectPal.examine(self, __FILE__, 'http://www.page.com')
+  end
+end
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Write tests for your feature
+4. Code until your tests pass (`rake`)
+5. Commit your changes (`git commit -am 'Add some feature'`)
+6. Push to the branch (`git push origin my-new-feature`)
+7. Create new Pull Request
+
+## Testing
+
+I'm partial to the rspec-given syntax and use it in [my unit tests](/spec). Please do the same. If you're unfamiliar with [rspec-given](https://github.com/jimweirich/rspec-given), you should check it out!
+
+## Issues/Comments/Questions?
+Write something up in the [Issues Tracker](https://github.com/jdenen/page-object-pal/issues). Or contact me via twitter, [@jpdenen](http://twitter.com/jpdenen)!

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+
+task :default => :test
+
+desc "Execute specs"
+task :test do 
+  sh "bundle exec rspec"
+end

data/lib/page-object-pal.rb

@@ -0,0 +1,70 @@
+require "page-object-pal/version"
+require "page-object-pal/elements"
+require "page-object-pal/diff"
+require "nokogiri"
+require "open-uri"
+# 
+# Module that will compare element identifying information used to define 
+# instance methods in PageObject classes to the HTML source code of a URL.
+# Use to keep page objects from becoming stale/unit testing your classes.
+#
+# Can be used independent of class to unit test page object.
+# @example Independent test
+#   describe Page do
+#     it "calls upon valid elements in its instance methods" do
+#       PageObjectPal.examine(Page, 'path/to/page/file', 'http://www.page.com').should be_true
+#     end
+#   end
+#
+# Can wrapped in a page object class method for validation.
+# @example Class method
+#   class Page
+#     include PageObject
+#
+#     def self.elements_still_valid
+#       PageObjectPal.examine(self, __FILE__, 'http://www.page.com')
+#     end
+#   end
+#
+module PageObjectPal
+  include PageObjectPal::Elements
+  include PageObjectPal::Diff
+  extend self
+
+  # 
+  # Compare elements constructed by the PageObject::DSL to the elements in the 
+  # URL's source code.
+  #
+  # @param [Class] Page object class to be tested
+  # @param [String] Path to the file housing the class being tested
+  # @param [String] Page URL
+  #
+  # @return [Boolean] True if no error is raised
+  #
+  def examine(klass, path, url)
+    diff_page(Nokogiri::HTML(open(url)), parse_class(klass, path))
+    success!
+  end
+
+  private
+  def success!
+    true
+  end
+
+  #
+  # Parse elements from the page object class methods. 
+  # 
+  def parse_class(klass, path)
+    methods = find_class_methods(klass)
+    elements = parse_methods(methods, path)
+  end
+
+  # 
+  # Grab instance methods defined in the page object class and not its super classes.
+  #
+  def find_class_methods(klass)
+    methods = []
+    klass.instance_methods(false).each { |m| methods << m }
+  end
+
+end

data/lib/page-object-pal/diff.rb

@@ -0,0 +1,51 @@
+require 'page-object-pal/exceptions'
+require 'page-object-pal/elements'
+
+module PageObjectPal
+  module Diff
+    include PageObjectPal::Elements
+
+    # 
+    # Find page object defined methods that do not match code
+    # in the source HTML.
+    #
+    def diff_page(source, elements)
+      elements.each do |e_hash|
+        e_hash.each do |elem, identifier|
+          scrub_source(elem, identifier, source)
+        end
+      end
+    end
+
+    # 
+    # Look for code in the source HTML matching the identifying
+    # code defined in the page object class.
+    #
+    def scrub_source(tag, identifier, source)
+      identifier.each do |prop, prop_val|
+        match = case prop
+        when :class
+          source.css("#{tag.to_s}.#{prop_val}")
+        when :id
+          source.css("#{tag.to_s}##{prop_val}")
+        when :index
+          source.css("#{tag.to_s}")[prop_val.to_i]
+        when :text
+          source.search("[text()*='#{prop_val}']")
+        when :xpath
+          source.xpath(prop_val)
+        else
+          raise SupportError, "PageObjectPal doesn't support elements identified by '#{prop}'... yet. Consider ", 
+            "forking the project at http://github.com/jdenen/page-object-pal."
+        end
+
+        raise PageObjectOutdated, "Could not identify '#{html_to_dsl(tag)}' where :#{prop} == '#{prop_val}'" if failure? match
+      end
+    end
+
+    def failure?(match)
+      match.to_a.empty?
+    end
+
+  end
+end

data/lib/page-object-pal/elements.rb

@@ -0,0 +1,89 @@
+module PageObjectPal
+  module Elements
+
+    # 
+    # Find lines in the page object class file that define the non-super
+    # instance methods. 
+    #
+    def parse_methods(methods, path)
+      elements = []
+      methods.each do |meth|
+        File.open(path).read.each_line do |line|
+          next unless line.include? meth.to_s
+          next unless line.lstrip.start_with? "div", "element", "image", "link", "list_item", "ordered_list", "paragraph", "radio_button", "span", "text_area", "text_field", "unordered_list"
+          elements << parse_element(line.lstrip)
+        end
+      end
+      elements
+    end
+
+    # 
+    # Convert method defining string to hash containing anchor_tag,
+    # identifying_property, and property_value.
+    #
+    def parse_element(string)
+      string.gsub!(/(,\s+)/, ",")
+      tag = dsl_to_html(string[/^(\w+)/])
+
+      case tag
+      when :element then element_tag(string)
+      else standard_tag(tag, string)
+      end
+    end
+
+    # 
+    # Convert method defining string for PageObject::Accessors#element method.
+    #
+    def element_tag(string)
+      tag = string[/,:(\w+)/].gsub(",:","")
+      sym = string[/:class|:id|:index|:text|:xpath/].gsub(":","").to_sym
+      (sym == :index) ? val = string[/\d+/] : val = string[/"(.+)"/].gsub("\"","")
+      { tag => { sym => val } }
+    end
+
+    # 
+    # Convert method defining string for standard PageObject::Accessors methods.
+    #
+    def standard_tag(tag, string)
+      sym = string[/:class|:id|:index|:text|:xpath/].gsub(":","").to_sym
+      (sym == :index) ? val = string[/\d+/] : val = string[/"(.+)"/].gsub("\"","")
+      { tag => { sym => val } }
+    end
+
+    # 
+    # Convert non-HTML anchor_tags from the PageObject::DSL to HTML.
+    #
+    def dsl_to_html(anchor)
+      case anchor
+      when "image" then :img
+      when "link" then :a
+      when "list_item" then :li
+      when "ordered_list" then :ol
+      when "paragraph" then :p
+      when "radio_button" then :radio
+      when "text_area" then :input
+      when "text_field" then :input
+      when "unordered_list" then :ul
+      else anchor.to_sym
+      end
+    end
+
+    # 
+    # Convert HTML to PageObject::DSL where the two are not identical.
+    #
+    def html_to_dsl(anchor)
+      case anchor
+      when :img then "image"
+      when :a then "link"
+      when :li then "list_item"
+      when :ol then "ordered_list"
+      when :p then "paragraph"
+      when :radio then "radio_button"
+      when :input then "text_field/text_area"
+      when :ul then "unordered_list"
+      else anchor.to_s
+      end
+    end
+
+  end
+end

data/lib/page-object-pal/exceptions.rb

@@ -0,0 +1,6 @@
+module PageObjectPal
+  class PageObjectOutdated < StandardError; end
+  class AnchorError < StandardError; end
+  class SupportError < StandardError; end
+  class CannotFindClass < StandardError; end
+end

data/lib/page-object-pal/version.rb

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

data/page-object-pal.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'page-object-pal/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "page-object-pal"
+  spec.version       = PageObjectPal::VERSION
+  spec.authors       = ["Johnson Denen"]
+  spec.email         = ["jdenen@manta.com"]
+  spec.description   = %q{Did the test suite find a bug? Or are the page objects outdated by new code? PageObjectPal will keep an eye on your page objects and let you know when they need some TLC.}
+  spec.summary       = %q{Page object maintenance made easier}
+  spec.homepage      = "http://github.com/jdenen/page-object-pal"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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 "nokogiri", "~> 1.6.0"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", ">= 2.12.0"
+  spec.add_development_dependency "rspec-given", "~> 3.1.1"
+  spec.add_development_dependency "page-object", "~> 0.9.2"
+end

data/spec/Page.rb

@@ -0,0 +1,16 @@
+require 'page-object'
+
+class Page 
+  include PageObject
+  link(:by_class, :class => "coolLight")
+  link(:by_id, :id => "signup-nav-header")
+  link(:by_index, :index => 0)
+  link(:by_text, :text => "Advertise With Us")
+  link(:by_xpath, :xpath => "(//a)[1]")
+  element(:by_element, :a, :xpath => "(//a)[1]")
+
+  def self.healthy?
+    PageObjectPal.examine(self, __FILE__, "http://www.manta.com")
+  end
+
+end

data/spec/dsl_conversion_spec.rb

@@ -0,0 +1,16 @@
+require 'rspec'
+
+describe PageObjectPal do
+  context "Converting to-and-from PageObject DSL" do
+    context "Converting most tags" do
+      ['div','image','link','list_item','ordered_list','paragraph','radio_button','unordered_list'].each do |anchor_tag|
+        Then { PageObjectPal.html_to_dsl(PageObjectPal.dsl_to_html(anchor_tag)).should == anchor_tag }
+      end
+    end
+    
+    context "Converting text_area and text_field" do
+      Then { PageObjectPal.html_to_dsl(PageObjectPal.dsl_to_html("text_area")).should == "text_field/text_area" }
+      And { PageObjectPal.html_to_dsl(PageObjectPal.dsl_to_html("text_field")).should == "text_field/text_area" }
+    end
+  end
+end

data/spec/elements_spec.rb

@@ -0,0 +1,10 @@
+require 'rspec'
+
+describe PageObjectPal do
+  describe "#parse_element" do
+    context "passed uncommented line" do
+      Then { PageObjectPal.parse_element('link(:stuff, :xpath => "//a")').should be_a_kind_of(Hash) }
+    end
+  end
+
+end

data/spec/exceptions_spec.rb

@@ -0,0 +1,23 @@
+require 'rspec'
+
+describe PageObjectPal, :private => true do
+  Given(:source) { Nokogiri::HTML(open("http://www.manta.com")) }
+
+  context "using unsupported identifying property" do
+    Then { expect { PageObjectPal.scrub_source('a', {:numero => 'uno'}, source) }.to raise_error(PageObjectPal::SupportError) }
+  end
+
+  context "using invalid identification" do
+    context "HTML selectors" do
+      Then { expect { PageObjectPal.scrub_source('a', {:class => 'invalid-class'}, source) }.to raise_error(PageObjectPal::PageObjectOutdated) }
+      Then { expect { PageObjectPal.scrub_source('a', {:id => 'invalid-id'}, source) }.to raise_error(PageObjectPal::PageObjectOutdated) }
+      Then { expect { PageObjectPal.scrub_source('a', {:index => 9000}, source) }.to raise_error(PageObjectPal::PageObjectOutdated) }
+      Then { expect { PageObjectPal.scrub_source('a', {:text => 'xxcvxddvndxm'}, source) }.to raise_error(PageObjectPal::PageObjectOutdated) }
+    end
+
+    context "Xpath selector" do
+      Then { expect { PageObjectPal.scrub_source('a', {:xpath => "//a[@id='invalid-id']"}, source) }.to raise_error(PageObjectPal::PageObjectOutdated) }
+    end
+  end
+
+end

data/spec/identifiers_spec.rb

@@ -0,0 +1,16 @@
+require 'rspec'
+
+describe PageObjectPal do
+  Given(:page) { require_relative 'Page'; Page }
+  Given(:path) { File.join(File.dirname(__FILE__), "Page.rb") }
+  Given(:src) { "http://www.manta.com" }
+
+  context "Evaluate from outside PageObject" do
+    Then { PageObjectPal.examine(page, path, src).should be_true }
+  end
+
+  context "Evaluate from PageObject method" do
+    Then { page.healthy?.should be_true }
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'rspec-given'
+require 'page-object-pal'
+
+RSpec.configure do |config|
+  config.before :each, :private => true do
+    PageObjectPal.class_eval do
+      public *private_instance_methods
+    end
+  end
+end

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: page-object-pal
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Johnson Denen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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
+- !ruby/object:Gem::Dependency
+  name: rspec-given
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.1.1
+- !ruby/object:Gem::Dependency
+  name: page-object
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+description: Did the test suite find a bug? Or are the page objects outdated by new
+  code? PageObjectPal will keep an eye on your page objects and let you know when
+  they need some TLC.
+email:
+- jdenen@manta.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/page-object-pal.rb
+- lib/page-object-pal/diff.rb
+- lib/page-object-pal/elements.rb
+- lib/page-object-pal/exceptions.rb
+- lib/page-object-pal/version.rb
+- page-object-pal.gemspec
+- spec/Page.rb
+- spec/dsl_conversion_spec.rb
+- spec/elements_spec.rb
+- spec/exceptions_spec.rb
+- spec/identifiers_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/jdenen/page-object-pal
+licenses:
+- MIT
+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: -577390764071290171
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -577390764071290171
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Page object maintenance made easier
+test_files:
+- spec/Page.rb
+- spec/dsl_conversion_spec.rb
+- spec/elements_spec.rb
+- spec/exceptions_spec.rb
+- spec/identifiers_spec.rb
+- spec/spec_helper.rb