page_record 0.2.1 → 0.3.0

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "example"]
+	path = example
+	url = https://github.com/appdrones/page_record_example.git

data/Gemfile.lock

@@ -1,16 +1,20 @@
 PATH
   remote: .
   specs:
-    page_record (0.2.1)
+    page_record (0.3.0)
       activesupport
       capybara (~> 2.1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (3.2.13)
-      i18n (= 0.6.1)
-      multi_json (~> 1.0)
+    activesupport (4.0.0)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    atomic (1.1.10)
     capybara (2.1.0)
       mime-types (>= 1.16)
       nokogiri (>= 1.3.3)
@@ -25,9 +29,10 @@ GEM
       simplecov (>= 0.7)
       thor
     diff-lcs (1.2.4)
-    i18n (0.6.1)
+    i18n (0.6.4)
     mime-types (1.23)
     mini_portile (0.5.0)
+    minitest (4.7.5)
     multi_json (1.7.7)
     nokogiri (1.6.0)
       mini_portile (~> 0.5.0)
@@ -56,7 +61,10 @@ GEM
       rack-protection (~> 1.4)
       tilt (~> 1.3, >= 1.3.4)
     thor (0.18.1)
+    thread_safe (0.1.0)
+      atomic
     tilt (1.4.1)
+    tzinfo (0.3.37)
     xpath (2.0.0)
       nokogiri (~> 1.3)
 

data/README.md

@@ -1,4 +1,4 @@
-[![Code Climate](https://codeclimate.com/github/appdrones/page_record.png)](https://codeclimate.com/github/appdrones/page_record) [![Build Status](https://travis-ci.org/appdrones/page_record.png)](https://travis-ci.org/appdrones/page_record) [![Dependency Status](https://gemnasium.com/appdrones/page_record.png)](https://gemnasium.com/appdrones/page_record) [![Coverage Status](https://coveralls.io/repos/appdrones/page_record/badge.png)](https://coveralls.io/r/appdrones/page_record)
+[![Gem Version](https://badge.fury.io/rb/page_record.png)](http://badge.fury.io/rb/page_record)[![Code Climate](https://codeclimate.com/github/appdrones/page_record.png)](https://codeclimate.com/github/appdrones/page_record) [![Build Status](https://travis-ci.org/appdrones/page_record.png)](https://travis-ci.org/appdrones/page_record) [![Dependency Status](https://gemnasium.com/appdrones/page_record.png)](https://gemnasium.com/appdrones/page_record) [![Coverage Status](https://coveralls.io/repos/appdrones/page_record/badge.png)](https://coveralls.io/r/appdrones/page_record)
 
 # PageRecord
 

data/lib/page_record.rb

@@ -7,3 +7,10 @@ require "page_record/attribute_accessors"
 require "page_record/class_actions"
 require "page_record/class_methods"
 require "page_record/errors"
+begin
+	require "page_record/helpers"
+	require "page_record/form_builder"
+rescue
+	# probably not in rails. Leave it like this
+	# TODO make this beter
+end

data/lib/page_record/form_builder.rb

@@ -0,0 +1,23 @@
+module PageRecord
+
+  class FormBuilder < ActionView::Helpers::FormBuilder
+    include PageRecord::Helpers
+
+    helpers = field_helpers + %w(time_zone_select date_select) - %w(hidden_field fields_for label)
+    helpers.each do |helper|
+      define_method helper do |field, *args|
+        options = args.detect{ |a| a.is_a?(Hash) } || {}
+        super field, options.merge(attribute_for(field))
+      end
+    end
+
+    actions = ['submit','button']
+    actions.each do |helper|
+      define_method helper do |field, *args|
+        options = args.detect{ |a| a.is_a?(Hash) } || {}
+        super field, options.merge(action_for(field.downcase))
+      end
+    end
+
+  end
+end

data/lib/page_record/helpers.rb

@@ -0,0 +1,175 @@
+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)
+      if var
+        id = var.id
+      else
+        id = instance_eval("@#{type}.id")
+      end
+      id ||= 'new'
+      @type = type
+      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  
+		#
+		#
+    def 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  
+		#
+		#
+    def action_for(name)
+      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>
+		# ```
+		#
+		#
+    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}
+      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)
+      else
+        content_tag_string(name, content_or_options_with_block, options, escape)
+      end
+    end
+
+    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 
+		#
+		#
+    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
+        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)
+      form_for(record, options, &block)
+    end
+  end
+
+end
+
+ActionView::Base.send :include, PageRecord::Helpers

data/lib/page_record/version.rb

@@ -1,3 +1,3 @@
 module PageRecord
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: page_record
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-25 00:00:00.000000000 Z
+date: 2013-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -116,6 +116,7 @@ extra_rdoc_files: []
 files:
 - .coveralls.yml
 - .gitignore
+- .gitmodules
 - .rspec
 - .travis.yml
 - .yardopts
@@ -133,6 +134,8 @@ files:
 - lib/page_record/cucumber.rb
 - lib/page_record/errors.rb
 - lib/page_record/finders.rb
+- lib/page_record/form_builder.rb
+- lib/page_record/helpers.rb
 - lib/page_record/instance_actions.rb
 - lib/page_record/rspec.rb
 - lib/page_record/version.rb
@@ -162,12 +165,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 3410867289688860735
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 3410867289688860735
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24