page_record 0.4.0 → 0.5.0

data/lib/page_record/helpers.rb

@@ -2,118 +2,177 @@ module PageRecord
 
   module Helpers
 
-		##
-		#
-		# returns a hash containing the record-type and the id. The id is based on the type. For example when
-		# you specify `:team` as the type, it will search for the `@type` instance variable.
-		# 
-		# example:
-		#
-		# ```ruby
-		# <%= form_for(@team, html:form_record_for(:team)) do |f| %>
-		# <% end %>
-		# ```
-		# this returns the follwing HTML:
-		#
-		# ```html
-		# <form accept-charset="UTF-8" action="/teams/2" class="edit_team" data-team-id="2" id="edit_team_2" method="post"><div style="margin:0;padding:0;display:inline"><input name="utf8" type="hidden" value="✓"><input name="_method" type="hidden" value="patch"><input name="authenticity_token" type="hidden" value="QXIbPXH65Ek+8i0j2R8akdHX2WXLo2MuDFuUVL8CQpY="></div>
-		# </form>
-		# ```
-		#
-		# @param type Symbol identifying the type of record and the variable to use
-		# @param var the variable to use. This is optional
-		#
-		# @return	Hash  
-		#
-		#
-    def form_record_for(type, var=nil)
+    ##
+    #
+    # returns a hash containing the record-type and the id. The id is based on the type. For example when
+    # you specify `:team` as the type, it will search for the `@type` instance variable.
+    #
+    # example:
+    #
+    # ```ruby
+    # <%= form_for(@team, html:form_record_for(:team)) do |f| %>
+    # <% end %>
+    # ```
+    # this returns the follwing HTML:
+    #
+    # ```html
+    # <form accept-charset="UTF-8" action="/teams/2" class="edit_team" data-team-id="2" id="edit_team_2" method="post"><div style="margin:0;padding:0;display:inline"><input name="utf8" type="hidden" value=""><input name="_method" type="hidden" value="patch"><input name="authenticity_token" type="hidden" value="QXIbPXH65Ek+8i0j2R8akdHX2WXLo2MuDFuUVL8CQpY="></div>
+    # </form>
+    # ```
+    #
+    # @param type Symbol identifying the type of record and the variable to use
+    # @param var the variable to use. This is optional
+    #
+    # @return	Hash
+    #
+    #
+    def form_record_for(type, var = nil)
       if var
         id = var.id
       else
         id = instance_eval("@#{type}.id")
       end
       id ||= 'new'
-      Hash["data-#{type}-id",id]
+      Hash["data-#{type}-id", id]
     end
 
-		##
-		#
-		# Returns a hash containing the attribute name. This can be used as html options in rails helpers
-		# 
-		# example in a form builder block:
-		#
-		# ```ruby
-		#<%= f.text_field :name, attribute_for(:name) %>
-		# ```
-		#
-		# this returns the follwing HTML:
-		#
-		# ```html
-		# <input data-attribute-for="name" id="team_name" name="team[name]" type="text">
-		# ```
-		#
-		# @param name Symbol or String identifying the name 
-		#
-		# @return	Hash  
-		#
-		#
+    ##
+    #
+    # returns a string containing the record-type and the id. The id is based on the type. For example when
+    # you specify `:team` as the type, it will search for the `type` instance variable.
+    #
+    # example:
+    #
+    # ```ruby
+    # <tr <%= record_for(:team)%>>
+    # ```
+    # this returns the follwing HTML:
+    #
+    # ```html
+    # <tr data-team-id="2">
+    # ```
+    #
+    # @param type Symbol identifying the type of record and the variable to use
+    # @param var the variable to use. This is optional
+    #
+    # @return   Hash
+    #
+    #
+    def record_for(record, type = nil)
+      unless type
+        type = record.class.to_s.downcase
+      end
+      "data-#{type}-id=#{record.id}"
+    end
+
+    ##
+    #
+    # Returns a hash containing the attribute name. This can be used as html options in rails helpers
+    #
+    # example in a form builder block:
+    #
+    # ```ruby
+    # <%= f.text_field :name, attribute_for(:name) %>
+    # ```
+    #
+    # this returns the follwing HTML:
+    #
+    # ```html
+    # <input data-attribute-for="name" id="team_name" name="team[name]" type="text">
+    # ```
+    #
+    # @param name Symbol or String identifying the name
+    #
+    # @return	Hash
+    #
+    #
     def attribute_for(name)
-      Hash["data-attribute-for",name]
+      Hash['data-attribute-for', name]
     end
 
-		##
-		#
-		# Returns a hash containing the action name. This can be used as html options in rails helpers
-		# 
-		# example in a form builder block:
-		#
-		# ```ruby
-		# <%= f.submit "Submit", action_for(:save)%>
-		# ```
-		#
-		# this returns the follwing HTML:
-		#
-		# ```html
-		# <input data-action-for="submit" name="commit" type="submit" value="Submit">
-		# ```
-		#
-		# @param name Symbol or String identifying the action name 
-		#
-		# @return	Hash  
-		#
-		#
+    ##
+    #
+    # Returns a hash containing the action name. This can be used as html options in rails helpers
+    #
+    # example in a form builder block:
+    #
+    # ```ruby
+    # <%= f.submit "Submit", action_for(:save)%>
+    # ```
+    #
+    # this returns the follwing HTML:
+    #
+    # ```html
+    # <input data-action-for="submit" name="commit" type="submit" value="Submit">
+    # ```
+    #
+    # @param name Symbol or String identifying the action name
+    #
+    # @return	Hash
+    #
+    #
     def action_for(name)
-      Hash["data-action-for",name]
+      name = name.to_s
+      name = 'save' if name == 'submit'
+      Hash['data-action-for', name]
     end
 
-		##
-		#
-		# Writes a tag containing the specified PageRecord attribute
-		# 
-		# example:
-		#
-		# ```ruby
-		#    <% @teams.each do |team| %>
-		#      <tr>
-		#        <%= attribute_tag_for(:td, :name) { team.name} %>
-		#        <%= attribute_tag_for(:td, :competition) { team.competition} %>
-		#        <%= attribute_tag_for(:td, :point) { team.point} %>
-		#        <%= attribute_tag_for(:td, :ranking) { team.ranking} %>
-		#        <td><%= link_to 'Show', team, action_for(:show) %></td>
-		#        <td><%= link_to 'Edit', edit_team_path(team), action_for(:edit) %></td>
-		#        <td><%= link_to 'Destroy', team, {method: :delete, data: { confirm: 'Are you sure?' }}.merge(action_for(:destroy)) %></td>
-		#      </tr>
-		# ```
-		#
-		# the first `attribute_tag_for` lines returns the follwing HTML:
-		#
-		# ```html
-		#<td data-attribute-for="name">aa</td>
-		# ```
-		#
-		#
+
+    ##
+    #
+    # Returns a hash containing the error name. This can be used as html options in rails helpers
+    #
+    # example: 
+    # 
+    # TODO: Make an example
+    #
+    #
+    # this returns the follwing HTML:
+    #
+    # ```html
+    # <div data-error-for="name">can't be blank</div>
+    # ```
+    #
+    # @param name Symbol or String identifying the name
+    #
+    # @return   Hash
+    #
+    #
+    def error_for(name)
+      Hash['data-error-for', name]
+    end
+
+
+
+    ##
+    #
+    # Writes a tag containing the specified PageRecord attribute
+    #
+    # example:
+    #
+    # ```ruby
+    #    <% @teams.each do |team| %>
+    #      <tr>
+    #        <%= attribute_tag_for(:td, :name) { team.name} %>
+    #        <%= attribute_tag_for(:td, :competition) { team.competition} %>
+    #        <%= attribute_tag_for(:td, :point) { team.point} %>
+    #        <%= attribute_tag_for(:td, :ranking) { team.ranking} %>
+    #        <td><%= link_to 'Show', team, action_for(:show) %></td>
+    #        <td><%= link_to 'Edit', edit_team_path(team), action_for(:edit) %></td>
+    #        <td><%= link_to 'Destroy', team, {method: :delete, data: { confirm: 'Are you sure?' }}.merge(action_for(:destroy)) %></td>
+    #      </tr>
+    # ```
+    #
+    # the first `attribute_tag_for` lines returns the follwing HTML:
+    #
+    # ```html
+    # <td data-attribute-for="name">aa</td>
+    # ```
+    #
+    #
+    # rubocop:disable ParameterLists
     def attribute_tag_for(name, attribute, content_or_options_with_block = nil, options = nil, escape = true, &block)
-      options||= options ? options << {'data-attribute-for' => attribute} :{'data-attribute-for' => attribute}
+      options ||= options ? options << { 'data-attribute-for' => attribute } : { 'data-attribute-for' => attribute }
       if block_given?
         options = content_or_options_with_block if content_or_options_with_block.is_a?(Hash)
         content_tag_string(name, capture(&block), options, escape)
@@ -121,57 +180,59 @@ module PageRecord
         content_tag_string(name, content_or_options_with_block, options, escape)
       end
     end
+    # rubocop:enable ParameterLists
 
     alias_method :atf, :attribute_tag_for
 
-
-		##
-		#
-		# build a form that automagicaly identifies a form as a PageRecord recognisable form
-		# The form is identified by the id of the given record or `new` if the record is new.
-		#
-		# All the elements in the form are labeled according to there field name. And thus easy
-		# recognisable by PageRecord
-		# 
-		# example:
-		#
-		# ```ruby
-		# <%= record_form_for(@team) do |f| %>
-		#  <div class="field" >
-		#    <%= f.label :name %><br>
-		#    <%= f.text_field :name %>
-		#  </div>
-		#  <div class="field"%>
-		#    <%= f.label :competition %><br>
-		#    <%= f.text_field :competition%>
-		#  </div>
-		#  <div class="actions">
- 		#   <%= f.submit "Submit"%>
-		#  </div>
-		# <% end %>
-		# ```
-		# @see 
-		#
-		# @return	formBuilder object 
-		#
-		#
+    ##
+    #
+    # build a form that automagicaly identifies a form as a PageRecord recognisable form
+    # The form is identified by the id of the given record or `new` if the record is new.
+    #
+    # All the elements in the form are labeled according to there field name. And thus easy
+    # recognisable by PageRecord
+    #
+    # example:
+    #
+    # ```ruby
+    # <%= record_form_for(@team) do |f| %>
+    #  <div class="field" >
+    #    <%= f.label :name %><br>
+    #    <%= f.text_field :name %>
+    #  </div>
+    #  <div class="field"%>
+    #    <%= f.label :competition %><br>
+    #    <%= f.text_field :competition%>
+    #  </div>
+    #  <div class="actions">
+    #   <%= f.submit "Submit"%>
+    #  </div>
+    # <% end %>
+    # ```
+    # @see
+    #
+    # @return	formBuilder object
+    #
+    #
     def record_form_for(record, options = {}, &block)
       case record
       when String, Symbol
         object_name = record
       else
         object      = record.is_a?(Array) ? record.last : record
-        raise ArgumentError, "First argument in form cannot contain nil or be empty" unless object
+        raise ArgumentError, 'First argument in form cannot contain nil or be empty' unless object
         object_name = options[:as] || model_name_from_record_or_class(object).param_key
       end
-      options = options.merge(html:form_record_for(object_name), builder:PageRecord::FormBuilder)
+      options = options.merge(html: form_record_for(object_name), builder: PageRecord::FormBuilder)
       form_for(record, options, &block)
     end
   end
 
 end
 
+# rubocop:disable HandleExceptions
 begin
-	ActionView::Base.send :include, PageRecord::Helpers
+  ActionView::Base.send :include, PageRecord::Helpers
 rescue NameError
 end
+# rubocop:enable HandleExceptions

data/lib/page_record/inspector.rb

@@ -0,0 +1,36 @@
+module PageRecord
+
+  module Inspector
+
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    def inspect
+    	attributes = Hash.new
+    	self.class.attributes.each do | attribute|
+    		begin
+	    		attributes[attribute] = self.send(attribute)
+    		rescue AttributeNotFound
+    			attributes[attribute] = '--not found on page--'
+    		end
+    	end
+    	attributes
+    end
+
+
+    module ClassMethods
+      def inspect
+      	{
+      		type: 				self.type,
+      		host_class: 	self.host_class,
+      		selector: 		self.selector,
+      		filter: 			self.filter,
+      		attributes: 	self.attributes,
+      	}
+      end
+    end
+
+  end
+end

data/lib/page_record/instance_actions.rb

@@ -1,52 +1,50 @@
 module PageRecord
-	class Base
+  class Base
 
-		##
-		# 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
+    ##
+    # 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
+      # @private
+      def action_for(action)
+        element = action_for?(action)
+        element.click
+        element
+      end
 
-		# @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
+      # @private
+      def action_for?(action)
+        @record.find("[data-action-for='#{action}']")
+      end
+  end
 end
-

data/lib/page_record/rspec.rb

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

data/lib/page_record/validation.rb

@@ -0,0 +1,46 @@
+require 'active_model'
+
+module PageRecord
+  class Base
+    ##
+    # Searches the record for any errors and returns them
+    #
+    # @return [ActiveModel::Errors] the error object for the current record
+    #
+    # @raise [AttributeNotFound] when the attribute is not found in the record
+    #
+    def errors
+      found_errors = @record.all("[data-error-for]")
+      error_list = ActiveModel::Errors.new(self)
+      found_errors.each do | error |
+        attribute = error['data-error-for']
+        message = error.text
+        error_list.add(attribute, message)
+      end
+      error_list
+    end
+
+    ##
+    # Returns true of there are no errors on the current record
+    #
+    # @return bool
+    #
+    # @raise [AttributeNotFound] when the attribute is not found in the record
+    #
+    def valid?
+      errors.empty?
+    end
+
+    ##
+    # Returns true of there are errors on the current record
+    #
+    # @return bool
+    #
+    # @raise [AttributeNotFound] when the attribute is not found in the record
+    #
+    def invalid?
+      !valid?
+    end
+
+  end
+end

data/lib/page_record/version.rb

@@ -1,3 +1,3 @@
 module PageRecord
-  VERSION = "0.4.0"
+  VERSION = '0.5.0'
 end

data/lib/page_record.rb

@@ -1,19 +1,17 @@
 require 'active_support/core_ext'
-require "page_record/version"
-require "page_record/base"
-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"
+require 'page_record/version'
+require 'page_record/inspector'
+require 'page_record/base'
+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'
+require 'page_record/validation'
 if defined?(ActionView::Base)
-	require "page_record/helpers"
-	require "page_record/form_builder"
+  require 'page_record/helpers'
+  require 'page_record/form_builder'
 end
-if defined?(Formtastic::Helpers::FormHelper)
-	require "page_record/formtastic"
-end
-
-
+require 'page_record/formtastic' if defined?(Formtastic::Helpers::FormHelper)
 

data/page_record.gemspec

@@ -25,8 +25,11 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "sinatra"
   spec.add_development_dependency "actionpack"
   spec.add_development_dependency "activerecord"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "ruby_gntp"
   # spec.add_development_dependency "debugger"
 
   spec.add_dependency "capybara" , '~>2.1.0'
   spec.add_dependency "activesupport"
-end
+  spec.add_dependency "activemodel"
+end

data/spec/.rubocop.yml

@@ -0,0 +1,4 @@
+inherit_from: ../.rubocop.yml
+
+StringLiterals:
+  Enabled: false