page_record 0.0.1

data/lib/page_record/errors.rb

@@ -0,0 +1,88 @@
+module PageRecord
+
+
+	##
+	# This {::Exception} is raised when the specified record is not found 
+	# on the page. Check your selector, filter and HTML code for details.
+	#
+	# ```html
+	# <div data-team-id='10'>
+	# 	<div data-attribute-for='name'>Ajax</div>
+	# </div>
+	# ```
+	# When the following code is executed, the {RecordNotFound} exception is raised.
+	#
+	# ```ruby
+	# TeamPage.find(11)
+	#```
+	#
+	class RecordNotFound < Exception
+	end
+
+	##
+	# This {::Exception} is raised when the specfied attribute is not found
+	# on the page. Check your selector, filter and HTML code for details.
+	#
+	# ```html
+	# <div data-team-id='10'>
+	# 	<div data-attribute-for='name'>Ajax</div>
+	# </div>
+	# ```
+	# When the following code is executed, the {AttributeNotFound} exception is raised.
+	#
+	# ```ruby
+	# TeamPage.find(10).ranking
+	#```
+	#
+	class AttributeNotFound < Exception
+	end
+
+	##
+	# This {::Exception} is raised when you have not set the page variable
+	# of the class. Check {PageRecord::PageRecord.page} for details
+	#
+	class PageNotSet < Exception
+	end
+
+	##
+	# This {::Exception} is raised when the page contains multiple instances 
+	# of the specfied record type. Use a selector to narrow the search.
+	#
+	# ```html
+	# <div id='first-table' data-team-id='10'>
+	# 	<div data-attribute-for='name'>Ajax</div>
+	# </div>
+	# <div id='second-table' data-team-id='10'>
+	# 	<div data-attribute-for='name'>Ajax</div>
+	# </div>
+	# ```
+	# When the following code is executed, the {MultipleRecords} exception is raised.
+	#
+	# ```ruby
+	# TeamPage.find(10)
+	#```
+	#
+	# To fix this, use the `#first-table` in the selector
+	#
+	# ```ruby
+	# TeamPage.find(10, '#first-table')
+	#```
+	#
+	class MultipleRecords < Exception
+	end
+
+	# This {::Exception} is raised when you try to set a non input field.
+	#
+	# ```ruby
+	# <div data-team-id=1>
+	# 	<div data-attribute-for='name'>PSV</div>
+	# </div>
+	# ```
+	# When the following code is executed, the {NotInputField} exception is raised.
+	#
+	# ```ruby
+	# team_on_page.name = 'Ajax'  
+	# ```
+	class NotInputField < Exception
+	end
+end

data/lib/page_record/finders.rb

@@ -0,0 +1,135 @@
+module PageRecord
+	##
+	# PageRecord is  a specific sort of {http://assertselenium.com/automation-design-practices/page-object-pattern/ PageObject pattern}. Where a "normal" 
+	# {http://assertselenium.com/automation-design-practices/page-object-pattern/ PageObject} tries to make the page accessible with business like functions. 
+	# We have taken a different approach. We've noticed that a lot of WebPage are 
+	# mainly luxury CRUD pages. This means that almost every page shows one or more 
+	# records of a certain type and has the ability to create, read update and delete
+	# one or more records. Sounds familiar? Yes,  it is the same as an ActiveRecord 
+	# pattern. So we tried to make accessing a page as close as possible to accessing
+	# an ActiveRecord.
+	#
+	# To make this work, however, we need to add extra information to the HTML page. 
+	# With HTML5, , you can do this easily. HTML-5 supports the data- attributes on any
+	# tag. We use these tags to identify the records on the page.
+	#
+	#
+	class PageRecord
+		##
+		#
+		# Searches the page and returns an {::Array} of {PageRecord::PageRecord} of instances of
+		# that match the selector and the filter. See {file:README.md#markup markup} for more
+		# details about formatting the page.
+		# 
+		# example:
+		#
+		# ```ruby
+		# TeamPage.all
+		# ```
+		# 
+		# returns all records on the page
+		#
+		# @param	selector 	[String] selector to use for searching the table on the page
+		# @param	filter		[String] filter to use on the records on the page
+		#
+		# @return	[Array Pagerecord]	The Array containing instances of [PageRecord::PageRecord] 
+		#  								with records that fit the selector and the filter
+		#
+		# @raise	[MultipleRecords]	if the page contains more then on set of records
+		# @raise 	[RecordNotFound]	if the page does not contain any of the specified records
+		#
+		def self.all(selector = nil, filter = nil)
+			selector ||= self.instance_variable_get('@selector')
+			filter ||= self.instance_variable_get('@filter')
+			records = []
+			context = context_for_selector(selector)				
+			context.all("[data-#{@type}-id]#{filter}").each do | record|
+				id = record["data-#{@type}-id"]
+				records << self.new(id, selector)
+			end
+			records
+		end
+
+		##
+		#
+		# Searches the page and returns an instance of {PageRecord::PageRecord} of instances of
+		# that matches the given id, selector and the filter. See {file:README.md#markup markup} for more
+		# details about formatting the page.
+		# 
+		# example:
+		#
+		# ```ruby
+		# TeamPage.find(1)
+		# ```
+		# 
+		# returns the record with id 
+		# 
+		# When you don't specify an id, `find` returns the only record on the page.
+		# If you have more than one record on the page, `find` raises {MultipleRecords}.
+		#
+		# example:
+		#
+		# ```ruby
+		# TeamPage.find()
+		# ```
+		#
+		# @param	selector 	[String] selector to use for searching the table on the page
+		# @param	filter		[String] filter to use on the records on the page
+		#
+		# @return	[Pagerecord]	An instance of [PageRecord::PageRecord]
+		#
+		# @raise	[MultipleRecords] if the page contains more then on set of records
+		# @raise 	[RecordNotFound] if the page does not contain any of the specified records
+		#
+		def self.find(id=nil, selector = nil, filter= nil)
+			selector ||= self.instance_variable_get('@selector')
+			filter ||= self.instance_variable_get('@filter')
+			self.new(id, selector, filter)
+		end
+
+		##
+		#
+		# Searches the page and returns an instance of {PageRecord::PageRecord} of instances of
+		# that matches the given attribute. See {file:README.md#markup markup} for more
+		# details about formatting the page.
+		#
+		# Although you can call this yourself, {PageRecord::PageRecord} uses this method for defining a
+		# finder for all attributes when you define your page class, {PageRecord::PageRecord}
+		# See {PageRecord::PageRecord.attributes} for more details.
+		# 
+		# example:
+		#
+		# ```ruby
+		# TeamPage.find_by_name('Ajax')
+		# ```
+		# 
+		# returns the record where the name is set to Ajax 
+		# 
+		# @param	attribute 	[String] The attribute name
+		# @param	value 		[String] The value to search for
+		# @param	selector 	[String] selector to use for searching the table on the page
+		# @param	filter		[String] filter to use on the records on the page
+		#
+		# @return	[Pagerecord]	An instance of [PageRecord::PageRecord].
+		#
+		# @raise	[MultipleRecords] if the page contains more then on set of records
+		# @raise 	[RecordNotFound] if the page does not contain any of the specified records
+		#
+		def self.find_by_attribute(attribute, value, selector, filter)
+			begin
+				selector ||= self.instance_variable_get('@selector')
+				filter ||= self.instance_variable_get('@filter')
+				
+				context = self.context_for_selector(selector)
+				record = context.find("[data-#{@type}-id]#{filter} > [data-attribute-for='#{attribute}']", :text => value)
+				parent = record.find(:xpath, "..")
+				id = parent["data-#{@type}-id"]
+				self.new(id, selector)
+				rescue Capybara::Ambiguous
+					raise MultipleRecords, "Found multiple #{@type} record with #{attribute} #{value} on page"				
+				rescue Capybara::ElementNotFound
+					raise RecordNotFound, "#{@type} record with #{attribute} #{value} not found on page"
+			end
+		end
+	end
+end

data/lib/page_record/instance_actions.rb

@@ -0,0 +1,52 @@
+module PageRecord
+	class PageRecord
+
+		##
+		# This is the implementation of the record action routine. It has two variants.
+		# it has a `?` variant and a `normal` variant.
+		#
+		# normal variant:
+		# It checks the page for a data-action-for='action' tag somewhere on the page.
+		# If it finds it, it clicks it.
+		#
+		# `?` variant:
+		# It checks the page for a data-action-for='action' tag somewhere on the page.
+		# If it finds it, returns the Capybara element.
+		#
+		# @param action [Symbol] this is the name of the action
+		# 
+		# @return [Capybara::Result]
+		#
+		# @raise [PageRecord::MultipleRecords] when there are more actions with 
+		#   this name on the page
+		#
+		def method_missing(action)
+			raw_action = /(.*)\?/.match(action)
+			begin
+				if raw_action
+					action_for?(raw_action[1])
+				else
+					action_for(action)
+				end
+			rescue Capybara::ElementNotFound
+				super
+			end
+		end
+
+
+	private
+
+		# @private
+		def action_for(action)
+			element = action_for?(action)
+			element.click
+			element
+		end
+
+		# @private
+		def action_for?(action)
+			@record.find("[data-action-for='#{action}']")
+		end
+	end
+end
+

data/lib/page_record/page_record.rb

@@ -0,0 +1,29 @@
+
+module PageRecord
+
+	class PageRecord
+
+		attr_reader :id
+		alias :id? :id
+
+		def initialize(id=nil, selector=nil, filter=nil)
+			selector ||= self.instance_variable_get('@selector')
+			filter ||= self.instance_variable_get('@filter')
+			@page = self.class.page
+			# raise PageNotSet, "page variable not set" unless @page
+			@type = self.class.instance_variable_get('@type')
+			@id = id.to_s
+			id_text = @id.blank? ? "" : "='#{@id}'"
+			begin
+				context = self.class.context_for_selector(selector)
+				@record = context.find("[data-#{@type}-id#{id_text}]#{filter}")
+				@id = @record["data-#{@type}-id"] if @id.blank?
+			rescue Capybara::Ambiguous
+				raise MultipleRecords, "Found multiple #{@type} record with id #{@id} on page"				
+			rescue Capybara::ElementNotFound
+				raise RecordNotFound, "#{@type} record with id #{@id} not found on page"
+			end
+		end
+
+  end
+end

data/lib/page_record/rspec.rb

@@ -0,0 +1,7 @@
+require 'page_record'
+
+RSpec.configure do |config|
+	config.before(:each) do
+    PageRecord::PageRecord.page = session
+  end
+end

data/lib/page_record/version.rb

@@ -0,0 +1,3 @@
+module PageRecord
+  VERSION = "0.0.1"
+end

data/lib/page_record.rb

@@ -0,0 +1,9 @@
+require 'active_support/core_ext'
+require "page_record/version"
+require "page_record/page_record"
+require "page_record/finders"
+require "page_record/instance_actions"
+require "page_record/attribute_accessors"
+require "page_record/class_actions"
+require "page_record/class_methods"
+require "page_record/errors"

data/page_record.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'page_record/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "page_record"
+  spec.version       = PageRecord::VERSION
+  spec.authors       = ["Bert Hajee"]
+  spec.email         = ["hajee@moretIA.com"]
+  spec.description   = %q{ActiveRecord like reading from specialy formatted HTML-page}
+  spec.summary       = %q{Using some specialy formatted 'data-...' tags you can read records from HTML pages like an ActiveRecord page}
+  spec.homepage      = "https://github.com/appdrones/page_record"
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "sinatra"
+  # spec.add_development_dependency "debugger"
+
+  spec.add_dependency "capybara" , '~>2.1.0'
+  spec.add_dependency "activesupport"
+end