page_record 0.4.0 → 0.5.0

data/.rubocop.yml

@@ -0,0 +1,13 @@
+Encoding:
+  Enabled: false
+
+# Limit lines to 80 characters.
+LineLength:
+  Enabled: false
+
+Documentation:
+  Enabled: false 
+
+MethodLength:
+  CountComments: false  # count full line comments?
+  Max: 15

data/CHANGES.md

@@ -15,3 +15,8 @@
 ##V0.4.0
 * Added support for Formtasic
 * Added spec's for rails helpers
+
+##V0.5.0
+* Added a rails project containing some cucumber features to demonstrate how it works. The example also shows how to use the rails and Formtastic helpers.
+* Added support for form validations. Both in formtastic and in reading the errors
+* added a `inspect` for both the class and for the instances. This is __very__ helpfull when dubugging.

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    page_record (0.4.0)
+    page_record (0.5.0)
+      activemodel
       activesupport
       capybara (~> 2.1.0)
 
@@ -38,6 +39,7 @@ GEM
       rack (>= 1.0.0)
       rack-test (>= 0.5.4)
       xpath (~> 2.0)
+    coderay (1.0.9)
     colorize (0.5.8)
     coveralls (0.6.7)
       colorize
@@ -47,13 +49,34 @@ GEM
       thor
     diff-lcs (1.2.4)
     erubis (2.7.0)
+    ffi (1.9.0)
+    formatador (0.2.4)
+    guard (1.8.1)
+      formatador (>= 0.2.4)
+      listen (>= 1.0.0)
+      lumberjack (>= 1.0.2)
+      pry (>= 0.9.10)
+      thor (>= 0.14.6)
+    guard-rspec (3.0.2)
+      guard (>= 1.8)
+      rspec (~> 2.13)
     i18n (0.6.4)
+    listen (1.2.2)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+      rb-kqueue (>= 0.2)
+    lumberjack (1.0.4)
+    method_source (0.8.1)
     mime-types (1.23)
-    mini_portile (0.5.0)
+    mini_portile (0.5.1)
     minitest (4.7.5)
     multi_json (1.7.7)
     nokogiri (1.6.0)
       mini_portile (~> 0.5.0)
+    pry (0.9.12.2)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
     rack (1.5.2)
     rack-protection (1.5.0)
       rack
@@ -65,23 +88,29 @@ GEM
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)
     rake (10.1.0)
+    rb-fsevent (0.9.3)
+    rb-inotify (0.9.0)
+      ffi (>= 0.5.0)
+    rb-kqueue (0.2.0)
+      ffi (>= 0.5.0)
     rest-client (1.6.7)
       mime-types (>= 1.16)
-    rspec (2.13.0)
-      rspec-core (~> 2.13.0)
-      rspec-expectations (~> 2.13.0)
-      rspec-mocks (~> 2.13.0)
-    rspec-core (2.13.1)
-    rspec-expectations (2.13.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.4)
+    rspec-expectations (2.14.0)
       diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.13.1)
-    rspec-rails (2.13.2)
+    rspec-mocks (2.14.1)
+    rspec-rails (2.14.0)
       actionpack (>= 3.0)
       activesupport (>= 3.0)
       railties (>= 3.0)
-      rspec-core (~> 2.13.0)
-      rspec-expectations (~> 2.13.0)
-      rspec-mocks (~> 2.13.0)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    ruby_gntp (0.3.4)
     simplecov (0.7.1)
       multi_json (~> 1.0)
       simplecov-html (~> 0.7.1)
@@ -90,8 +119,9 @@ GEM
       rack (~> 1.4)
       rack-protection (~> 1.4)
       tilt (~> 1.3, >= 1.3.4)
+    slop (3.4.6)
     thor (0.18.1)
-    thread_safe (0.1.0)
+    thread_safe (0.1.2)
       atomic
     tilt (1.4.1)
     tzinfo (0.3.37)
@@ -106,8 +136,10 @@ DEPENDENCIES
   activerecord
   bundler (~> 1.3)
   coveralls
+  guard-rspec
   page_record!
   rake
   rspec
   rspec-rails
+  ruby_gntp
   sinatra

data/Guardfile

@@ -0,0 +1,24 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml)$})                 { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+
+  # Capybara features specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml)$})          { |m| "spec/features/#{m[1]}_spec.rb" }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end
+

data/README.md

@@ -7,7 +7,33 @@ You've probably been there. You're building your killer Web Application. You, be
 ## PageRecord can help.
 There are a lot of ways you can do this. PageRecord is one of these ways. PageRecord is an ActiveRecord like abstraction for information on the HTML page. You can use `TeamRecord.find(1)` and `TeamRecord.find_by_name('Barcelona')` like functions to find a record on an HTML page. When you've found the record you need, you can use easy accessors to access the attributes. `TeamRecord.find(1).name` returns the name of the team.
 
-TODO explain how it helps in testing
+###Adding a record using a form
+
+With the PageRecord api you can fill all form fields press the save button.
+
+```ruby
+When(/^I add a team$/) do
+  visit new_team_path
+  team = TeamPage.find
+  team.name = "Ajax"
+  team.competition = @competition
+  team.save
+end
+```
+
+###Checking if an error is displayed.
+
+With the PageRecord api you can check for errors. No need to checkout what css you need to select the right DOM element. PageRecord takes care of that.
+
+```ruby
+Then(/^I should see error "can't be blank" on field "competition"$/) do
+  team = TeamPage.find
+  expect(team.errors['competition']).to eq ['can't be blank']
+end
+```
+
+###How to get the right HTML?
+PageRecord contains form builders that make it extremely easy to build the right forms. When  you use Formtastic. You don't have to do anything. PageRecord add's the right attributes to the right DOM elements. When you use barebone Rails, you van use the `record_form_for` form builder. See the example for more information.
 
 ##Documentation
 Look at [the yard documentation](http://rubydoc.info/github/appdrones/page_record/PageRecord) for details. Check [Changes](https://github.com/appdrones/page_record/blob/master/CHANGES.md) for (breaking) changes per version.

data/bin/autospec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'autospec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'autospec')

data/bin/guard

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'guard' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('guard', 'guard')

data/bin/rake

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake', 'rake')

data/bin/rspec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

data/lib/page_record/attribute_accessors.rb

@@ -1,60 +1,63 @@
 module PageRecord
-	class Base
-		##
-		# Searches the record for the specified attribute and returns the {http://rubydoc.info/github/jnicklas/capybara/master/Capybara/Result Capybara Result}.
-		# This method is called when you access an attribute with a `?` of a record
-		# 
-		# @return [Capybara::Result] the text content of the specified attribute
-		#
-		# @raise [AttributeNotFound] when the attribute is not found in the record
-		#
-		def read_attribute?(attribute)
-			begin
-				@record.find("[data-attribute-for='#{attribute}']")
-			rescue Capybara::ElementNotFound
-				raise AttributeNotFound, "#{@type} record with id #{@id} doesn't contain attribute #{attribute}"
-			end
-		end
+  class Base
+    ##
+    # Searches the record for the specified attribute and returns
+    # the {http://rubydoc.info/github/jnicklas/capybara/master/Capybara/Result Capybara Result}.
+    # This method is called when you access an attribute with a `?` of a record
+    #
+    # @return [Capybara::Result] the text content of the specified attribute
+    #
+    # @raise [AttributeNotFound] when the attribute is not found in the record
+    #
+    def read_attribute?(attribute)
+      @record.find("[data-attribute-for='#{attribute}']")
+      rescue Capybara::ElementNotFound
+        raise AttributeNotFound, "#{@type} record with id #{@id} doesn't contain attribute #{attribute}"
+    end
 
-		##
-		# Searches the record for the specified attribute and returns the text content.
-		# This method is called when you access an attribute of a record
-		# 
-		# @return [String] the text content of the specified attribute
-		#
-		# @raise [AttributeNotFound] when the attribute is not found in the record
-		#
-		def read_attribute( attribute)
-			element = self.send("#{attribute}?")
-			tag = element.tag_name
-			textelement?(tag) ? element.value : element.text
-		end
+    ##
+    # Searches the record for the specified attribute and returns
+    # the text content. This method is called when you access an
+    # attribute of a record
+    #
+    # @return [String] the text content of the specified attribute
+    #
+    # @raise [AttributeNotFound] when the attribute is not found in the record
+    #
+    def read_attribute(attribute)
+      element = send("#{attribute}?")
+      tag = element.tag_name
+      input_field?(tag) ? element.value : element.text
+    end
 
-		##
-		# Searches the record for the specified attribute and sets the value of the attribute
-		# This method is called when you set an attribute of a record
-		# 
-		# @return [Capybara::Result] the text content of the specified attribute
-		#
-		# @raise [AttributeNotFound] when the attribute is not found in the record
-		# @raise [NotInputField] when the attribute is not a `TEXTAREA` or `INPUT` tag
-		#
-		def write_attribute( attribute, value)
-			element = self.send("#{attribute}?")
-			tag = element.tag_name
-			raise NotInputField unless textelement?(tag)
-			element.set(value)
-			element
-		end
+    ##
+    # Searches the record for the specified attribute and sets the value of the attribute
+    # This method is called when you set an attribute of a record
+    #
+    # @return [Capybara::Result] the text content of the specified attribute
+    #
+    # @raise [AttributeNotFound] when the attribute is not found in the record
+    # @raise [NotInputField] when the attribute is not a `TEXTAREA` or `INPUT` tag
+    #
+    def write_attribute(attribute, value)
+      element = send("#{attribute}?")
+      tag = element.tag_name
+      case tag
+      when 'textarea', 'input' then element.set(value)
+      when 'select'then element.select(value)
+      else raise NotInputField
+      end
+      element
+    end
 
+    private
 
-private
-		# @private
-		def textelement?(tag)
-			case tag
-			when 'textarea', 'input' then true
-			else false
-			end
-		end
-	end
+    # @private
+    def input_field?(tag)
+      case tag
+      when 'textarea', 'input', 'select' then true
+      else false
+      end
+    end
+  end
 end

data/lib/page_record/base.rb

@@ -1,29 +1,34 @@
 module PageRecord
 
-	class Base
+  class Base
+    include PageRecord::Inspector
 
-		attr_reader :id
-		alias :id? :id
+    attr_reader :id
+    alias_method :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
+    def initialize(id = nil, selector = nil, filter = nil)
+      @page = self.class.page
+      @type = self.class.instance_variable_get('@type')
+      @id = id.to_s
+      find_record(selector, filter)
+    end
+
+    private
+
+    def find_record(selector, filter)
+      selector ||= @selector
+      filter ||= @filter
+      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/class_actions.rb

@@ -1,55 +1,52 @@
 module PageRecord
-	class Base
-		##
-		#
-		# This is the implementation of the page 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 result.
-		#
-		# @param action [Symbol] this is the name of the action
-		# 
-		# @return [Capybara::Element]
-		#
-		# @raise [PageRecord::MultipleRecords] when there are more actions with 
-		#   this name on the page
-		#
-		def self.method_missing(action)
-			raw_action = /(.*)\?/.match(action)
-			begin
-				if raw_action
-					action_for?(raw_action[1])
-				else
-					action_for(action)
-				end
-			rescue Capybara::Ambiguous
-				raise MultipleRecords, "Found multiple #{action} tags for #{@type} on page"				
-			rescue Capybara::ElementNotFound
-				super
-			end
-		end
+  class Base
+    ##
+    #
+    # This is the implementation of the page 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 result.
+    #
+    # @param action [Symbol] this is the name of the action
+    #
+    # @return [Capybara::Element]
+    #
+    # @raise [PageRecord::MultipleRecords] when there are more actions with
+    #   this name on the page
+    #
+    def self.method_missing(action)
+      raw_action = /(.*)\?/.match(action)
+      begin
+        if raw_action
+          action_for?(raw_action[1])
+        else
+          action_for(action)
+        end
+      rescue Capybara::Ambiguous
+        raise MultipleRecords, "Found multiple #{action} tags for #{@type} on page"
+      rescue Capybara::ElementNotFound
+        super
+      end
+    end
 
-private
+    private
 
-		# @private
-		def self.action_for(action)
-			element = action_for?(action)
-			element.click
-			element
-		end
+      # @private
+      def self.action_for(action)
+        element = action_for?(action)
+        element.click
+        element
+      end
 
-
-		# @private
-		def self.action_for?(action)
-			page.find("[data-action-for='#{action}']")
-		end
-	end
+      # @private
+      def self.action_for?(action)
+        page.find("[data-action-for='#{action}']")
+      end
+  end
 end
-
-