radiant-forms-extension 2.0.1 → 3.1.1

data/lib/forms/tags/core.rb

@@ -0,0 +1,201 @@
+class TagError < StandardError; end
+
+module Forms
+  module Tags
+    module Core
+      include Radiant::Taggable
+      
+      desc %{
+        Render a form and its contents
+        <pre><code><r:form name="object[key]" [method, url] /></code></pre>
+        
+        * *name* the name of the form
+        * *method* url submission method [ post, get, delete, put ]
+        * *url* address to submit the form to
+      }
+      tag 'form' do |tag|
+        if tag.attr['name'].present?
+          if tag.locals.form = Form.find_by_title(tag.attr['name'])
+            tag.attr['id'] ||= 'form_' + tag.locals.form.title
+            tag.attr['method'] ||= 'put'
+            tag.attr['action'] ||= tag.locals.form.action.blank? ? "/forms/#{tag.locals.form.id}" : tag.locals.form.action
+            
+            parse(Forms::Tags::Helpers.render(tag))
+          else
+            raise TagError, "Could not find '#{tag.attr['name']}' form"
+          end
+        else
+          tag.expand
+        end
+      end
+      
+      desc %{ 
+        Render a @<label />@ tag to be used inside a form
+        <pre><code><r:form:label for="object[key]" /></code></pre>
+        
+        **Required**
+        * *for* the name of the field you are relating the tag to
+        
+        _A label is a piece of text which activates its related input when clicked_
+      }
+      tag 'form:label' do |tag|
+        Forms::Tags::Helpers.require!(tag,'form:label','for')
+        
+        tag.attr['for'] = tag.attr['for'].gsub('[','_').gsub(']','') unless tag.attr['for'].nil?
+        
+        %(<label #{Forms::Tags::Helpers.attributes(tag)}>#{tag.expand}</label>)
+      end
+      
+      %w(text password reset checkbox radio hidden file button).each do |type|
+        desc %{
+          Render a @<#{type}>...</#{type}>@ tag to be used in a form
+          <pre><code><r:form:#{type} name="object[key]" /></code></pre>
+          
+          **Required**
+          * *name* the name of the data to be sent
+          
+          **Optional**
+          * *class* css class names
+          * *placeholder* default text, which is cleared when clicked
+          * *maxlength* the maximum amount of characters
+        }
+        tag "form:#{type}" do |tag|
+          Forms::Tags::Helpers.require!(tag,"form:#{type}",'name')
+          
+          value = tag.attr['value']
+          tag.attr['type'] = type
+          
+          %(<input type="#{type}" value="#{value}" #{Forms::Tags::Helpers.attributes(tag)} />)
+        end
+      end
+      
+      desc %{
+        Renders a @<select>...</select>@ tag to be used in a form
+        
+        <pre><code><r:form:select name="object[key]"><r:option value="text" /></r:form:select></code></pre>
+        
+        **Required**
+        * *name* the name of the data to be sent
+        
+        **Optional**
+        * *class* css class names
+        
+        _@<r:option />@ tags may be nested inside the tag to automatically generate options_
+      }
+      tag 'form:select' do |tag|
+        Forms::Tags::Helpers.require!(tag,'form:select','name')
+        
+        tag.locals.parent_tag_name = tag.attr['name']
+        tag.locals.parent_tag_type = 'select'
+        
+        %(<select #{Forms::Tags::Helpers.attributes(tag)}>#{tag.expand}</select>)
+      end
+      
+      desc %{
+        Renders a series of @<input type="radio"/>@ tags to be used in a form
+        
+        <pre><code><r:form:radios name="object[value]" value="text"><r:option value="text" /></r:form:radios></code></pre>
+        
+        **Required**
+        * *name* the name of the data to be sent
+        
+        **Optional**
+        * *class* css class names
+        
+        _@<r:option />@ tags may be nested inside the tag to automatically generate options_
+      }
+      tag 'form:radios' do |tag|
+        Forms::Tags::Helpers.require!(tag,'form:radios','name')
+        
+        tag.locals.parent_tag_name = tag.attr['name']
+        tag.locals.parent_tag_type = 'radios'
+        tag.expand
+      end
+      
+      desc %{
+        Renders an @<option/>@ tag if the parent is a
+        @<r:form:select>...</r:form:select>@ or @<r:form:radios>...</r:form:radios>@
+        
+        **Required**
+        * *value* the value you want to be sent if selected
+      }
+      tag 'form:option' do |tag|
+        value = tag.attr['value'] || tag.expand
+        
+        if tag.locals.parent_tag_type == 'select'
+          text = tag.expand.length == 0 ? value : tag.expand
+          
+          extra = { 'value' => value}
+          %(<option #{Forms::Tags::Helpers.attributes(tag, extra)}>#{text}</option>)
+        elsif tag.locals.parent_tag_type == 'radios'
+          name= tag.locals.parent_tag_type == 'radios' ? tag.locals.parent_tag_name : tag.attr['name']
+          id  = name.gsub('[','_').gsub(']','') + '_' + value
+          
+          extra = { 'id' => id, 'value' => value, 'name' => name, 'type' => 'radio' }
+          %(<input #{Forms::Tags::Helpers.attributes(tag, extra)} />)
+        end
+      end
+      
+      desc %{
+        Renders an @<input type="submit" />@ tag for a form.
+        
+        **Optional**
+        * *value* the text on the submit
+      }
+      tag 'form:submit' do |tag|
+        value = tag.attr['value'] || 'submit'
+        extra = { 'value' => value, 'type' => 'submit', 'class' => 'submit', 'name' => 'submit' }
+        %(<input #{Forms::Tags::Helpers.attributes(tag, extra)} />)
+      end
+      
+      desc %{
+        Query the data from a submitted form
+        
+        @<r:form:read name="object[value]" />@ access the object which was submitted
+        
+        _This can only be used in the content section of a form, use @<r:form:get />@ in pages_
+      }
+      tag 'form:read' do |tag|
+        Forms::Tags::Helpers.require!(tag,'form:read','name')
+        data = Forms::Tags::Responses.retrieve(tag.locals.page.data, tag.attr['name'])
+      end
+      
+      desc %{
+        Clears the response object
+        
+        @<r:response:clear />@
+      }
+      tag 'response:clear' do |tag|
+        Forms::Tags::Responses.clear(tag)
+        
+        nil
+      end
+      
+      desc %{ 
+        Allows access to the response of a submitted form
+        @<r:response>...<r:get /><r:clear />...</r:response>@
+        
+        _Will not expand if a form has not been submitted or has been cleared_
+      }
+      tag 'response' do |tag|
+        tag.locals.response = Forms::Tags::Responses.current(tag,request)
+        
+        tag.expand if tag.locals.response.present? and tag.locals.response.result.present?
+      end
+      
+      desc %{ 
+        Access the attributes of a submitted form.
+        
+        @<r:response:get name="object[value]" />@ an object which was submitted with the form
+        @<r:response:get name="result[mail][value]" />@ a response to the mail extension hooking the form
+        
+        _Refer to the readme on extensions to find out what they return_
+      }
+      tag 'response:get' do |tag|
+        Forms::Tags::Helpers.require!(tag,'response:get','name')
+        
+        result = Forms::Tags::Responses.retrieve(tag.locals.response.result, tag.attr['name']).to_s
+      end
+    end
+  end
+end

data/lib/forms/tags/helpers.rb

@@ -0,0 +1,54 @@
+module Forms
+  module Tags
+    module Helpers
+      
+      class << self
+        
+        def render(tag)
+          string =  %{<form enctype="multipart/form-data" method="post" #{attributes(tag)}>\n}
+            string << %{<input type="hidden" name="_method" value="#{tag.attr['method']}" />\n}
+            string << %{<input type="hidden" name="page_id" value="#{tag.locals.page.id}" />\n}
+            string << %{<r:form>}
+              string << tag.locals.form.body
+            string << %{</r:form>}
+          string << %{</form>}
+        end
+        
+        def attributes(tag, extras={})
+          id = tag.attr['name'] || extras['name']
+          id = id || tag.attr['for'] + '_label' if tag.attr['for']
+          id = id.gsub('[','_').gsub(']','') unless id.nil?
+
+          attrs = {
+            'id'            => id,  
+            'class'         => tag.attr['type'],
+            'name'          => nil,
+            'for'           => nil,
+            'action'        => nil,
+            'placeholder'   => nil,
+            'value'         => nil,
+            'maxlength'     => nil
+          }.merge(extras)
+          
+          result = attrs.collect do |k,v|
+            v = (tag.attr[k] || v)
+            next if v.blank?
+            %(#{k}="#{v}")
+          end.reject{|e| e.blank?}
+
+          result.join(' ')
+        end
+        
+        def require!(tag,name,key)
+          if tag.attr[key].present?
+            return true
+          else
+            raise "'<r:#{name} />' requires the '#{key}' attribute"
+          end
+        end
+        
+      end
+      
+    end
+  end
+end

data/lib/forms/tags/responses.rb

@@ -0,0 +1,58 @@
+module Forms
+  module Tags
+    module Responses
+      
+      class << self
+        
+        def current(tag, request)
+          response = nil
+          
+          if tag.locals.response.present?
+            response = tag.locals.response
+          elsif tag.locals.page.request.present?
+            session = tag.locals.page.request.session[:form_response]
+            begin
+              response = Response.find(session)
+            rescue
+              if session == Object
+                response  = Response.create
+                tag.locals.page.request.session[:form_response] = result.id
+              end
+            end
+          end
+          
+          response
+        end
+      
+        # Returns the value from a hash when in input key is sent 
+        # @source = hash
+        # @key 
+        def retrieve(source, key)
+          result = nil
+          
+          if source.present?
+            data = key.gsub("[","|").gsub("]","").split("|")
+            
+            if data.present?
+              result = source.fetch(data[0].to_sym)
+              data.delete_at(0)
+              
+              if data.length and result.present?
+                data.each do |i|
+                  result = result.fetch(i.to_sym) rescue nil
+                end
+              end
+            end
+          end
+          
+          result
+        end
+        
+        def clear(tag)
+          tag.locals.response.update_attribute('result', nil)
+        end
+      
+      end
+    end
+  end
+end

data/radiant-forms-extension.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{radiant-forms-extension}
-  s.version = "2.0.1"
+  s.version = "3.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["dirkkelly"]
-  s.date = %q{2010-08-02}
+  s.date = %q{2010-10-08}
   s.description = %q{Send data from a page to a form handler, extendable with addons}
   s.email = %q{dirk.kelly@squaretalent.com}
   s.extra_rdoc_files = [
@@ -23,6 +23,8 @@ Gem::Specification.new do |s|
      "app/controllers/admin/forms_controller.rb",
      "app/controllers/forms_controller.rb",
      "app/models/form.rb",
+     "app/models/form_mail.rb",
+     "app/models/form_mailer.rb",
      "app/models/form_page.rb",
      "app/models/response.rb",
      "app/views/admin/forms/_fields.html.haml",
@@ -40,19 +42,22 @@ Gem::Specification.new do |s|
      "db/migrate/002_create_user_observer.rb",
      "db/migrate/003_rename_output_to_content.rb",
      "db/migrate/004_create_responses.rb",
+     "db/migrate/20100929150423_change_to_updated_by_id.rb",
      "forms_extension.rb",
-     "lib/forms/addon_methods.rb",
-     "lib/forms/admin_ui.rb",
-     "lib/forms/application_controller_extensions.rb",
-     "lib/forms/page_extensions.rb",
-     "lib/forms/site_controller_extensions.rb",
-     "lib/forms/tags.rb",
+     "lib/forms/config.rb",
+     "lib/forms/controllers/application_controller.rb",
+     "lib/forms/controllers/site_controller.rb",
+     "lib/forms/interface/forms.rb",
+     "lib/forms/models/extension.rb",
+     "lib/forms/models/page.rb",
+     "lib/forms/tags/core.rb",
+     "lib/forms/tags/helpers.rb",
+     "lib/forms/tags/responses.rb",
      "lib/tasks/forms_extension_tasks.rake",
      "public/images/admin/extensions/form/form.png",
      "radiant-forms-extension.gemspec",
      "spec/controllers/forms_controller_spec.rb",
      "spec/datasets/forms.rb",
-     "spec/lib/forms/addon_methods_spec.rb",
      "spec/lib/forms/tags_spec.rb",
      "spec/models/form_spec.rb",
      "spec/models/response_spec.rb",
@@ -62,12 +67,11 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/squaretalent/radiant-forms-extension}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.5}
+  s.rubygems_version = %q{1.3.7}
   s.summary = %q{Forms Extension for Radiant CMS}
   s.test_files = [
     "spec/controllers/forms_controller_spec.rb",
      "spec/datasets/forms.rb",
-     "spec/lib/forms/addon_methods_spec.rb",
      "spec/lib/forms/tags_spec.rb",
      "spec/models/form_spec.rb",
      "spec/models/response_spec.rb",
@@ -78,7 +82,7 @@ Gem::Specification.new do |s|
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
     else
     end
   else

data/spec/controllers/forms_controller_spec.rb

@@ -9,8 +9,8 @@ describe FormsController do
       @page = pages(:home)
       @form = forms(:test)
       @params = {
-        'form_id' => @form.id,
-        'request' => 'test'
+        'id'    => @form.id,
+        'data'  => 'test'
       }
       mock(Page).find(anything) { @page }
       mock(Form).find(anything) { @form }
@@ -19,7 +19,7 @@ describe FormsController do
     context 'initialize' do
       
       before :each do
-        post :create, @params
+        put :update, @params
       end
         
       it 'should assign the page' do
@@ -31,7 +31,7 @@ describe FormsController do
       end
   
       it 'should put the params into the page data' do
-        assigns(:page).data['request'].should == @params['request']
+        assigns(:page).data[:request].should == @params['request']
       end
   
       it 'should find/create a response object' do
@@ -39,7 +39,7 @@ describe FormsController do
       end
   
       it 'should add the params to the response result' do
-        assigns(:response).result['request'].should == @params['request']
+        assigns(:response).result[:request].should == @params['request']
       end
       
     end
@@ -47,13 +47,13 @@ describe FormsController do
     context 'configuration' do
 
       before :each do
-        post :create, @params
+        put :update, @params
       end
       
       context 'configuration exists' do
         
         it 'should assign the configuration settings' do
-          assigns(:form)[:config][:test]['config'].should == 'test'
+          assigns(:form)[:extensions][:test][:config].should == 'test'
         end
         
       end
@@ -75,17 +75,17 @@ describe FormsController do
     context 'extensions' do
       
       before :each do
-        post :create, @params
+        put :update, @params
       end
           
       context 'extension configured' do
       
         it 'should call that test extension' do
-          assigns(:response).result['test_ext'].should == { 'response' => 'test' }
+          assigns(:response).result[:results][:test].should == { :response => 'test' }
         end
         
         it 'should not call the alt extension' do
-          assigns(:response).result['test_alt'].should be_nil
+          assigns(:response).result[:results][:alt].should be_nil
         end
       
       end
@@ -104,7 +104,7 @@ describe FormsController do
           
           before :each do
             @form.redirect_to = '/redirect/url'
-            post :create, @params
+            put :update, @params
           end
           
           it 'should redirect to the form redirect url' do
@@ -117,7 +117,7 @@ describe FormsController do
           
           before :each do
             @page.slug = '/page/url'
-            post :create, @params
+            put :update, @params
           end
           
           it 'should render page url' do
@@ -132,7 +132,7 @@ describe FormsController do
         
         before :each do
           stub(@response).save { false }
-          post :create, @params
+          put :update, @params
         end
         
         it 'should raise a form not submitted exception' do

data/spec/datasets/forms.rb

@@ -1,12 +1,12 @@
-class FormsTestController
-  include Forms::AddonMethods
+class FormTest
+include Forms::Models::Extension
   def create
     result = { :response => 'test' }
   end
 end
 
-class FormsAltController
-  include Forms::AddonMethods
+class FormAlt
+  include Forms::Models::Extension
   def create
     result = { :response => 'alt' }
   end

data/spec/lib/forms/tags_spec.rb

@@ -14,12 +14,11 @@ describe Forms::Tags do
       it 'should render the correct HTML' do
         tag = %{<r:form name="#{@form.title}" />}
 
-        expected = %{<form enctype="multipart/form-data" name="#{@form.title}" method="post" action="/forms/#{@form.id}" id="form_test_form">
+        expected = %{<form enctype="multipart/form-data" method="post" name="#{@form.title}" action="/forms/#{@form.id}" id="form_test_form">
+<input type="hidden" name="_method" value="put" />
 <input type="hidden" name="page_id" value="#{@page.id}" />
-<input type="hidden" name="form_id" value="#{@form.id}" />
 <input type="text" value="" name="request[test]" class="text" id="request_test" /></form>}
-
-        @page.should render(tag).as(expected)
+       @page.should render(tag).as(expected)
       end
     end
     
@@ -109,14 +108,4 @@ describe Forms::Tags do
     
   end
   
-  context 'form hooking' do
-    
-    
-  end
-  
-  context 'form response' do
-    
-  end
-  
-  
 end

data/spec/models/response_spec.rb

@@ -4,13 +4,13 @@ describe Response do
   
   before :each do
     @response = Response.new
-    @object   = { 'test' => 'test' }
+    @object   = { :test => 'test' }
   end
   
   context 'setting' do
     
     it 'should store an object' do
-      @response.result.should be_nil
+      @response.result.should == {}
       @response.result = @object
       @response.result.should_not be_nil
     end

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: radiant-forms-extension
 version: !ruby/object:Gem::Version 
-  version: 2.0.1
+  hash: 1
+  prerelease: false
+  segments: 
+  - 3
+  - 1
+  - 1
+  version: 3.1.1
 platform: ruby
 authors: 
 - dirkkelly
@@ -9,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-02 00:00:00 +08:00
+date: 2010-10-08 00:00:00 +08:00
 default_executable: 
 dependencies: []
 
@@ -29,6 +35,8 @@ files:
 - app/controllers/admin/forms_controller.rb
 - app/controllers/forms_controller.rb
 - app/models/form.rb
+- app/models/form_mail.rb
+- app/models/form_mailer.rb
 - app/models/form_page.rb
 - app/models/response.rb
 - app/views/admin/forms/_fields.html.haml
@@ -46,19 +54,22 @@ files:
 - db/migrate/002_create_user_observer.rb
 - db/migrate/003_rename_output_to_content.rb
 - db/migrate/004_create_responses.rb
+- db/migrate/20100929150423_change_to_updated_by_id.rb
 - forms_extension.rb
-- lib/forms/addon_methods.rb
-- lib/forms/admin_ui.rb
-- lib/forms/application_controller_extensions.rb
-- lib/forms/page_extensions.rb
-- lib/forms/site_controller_extensions.rb
-- lib/forms/tags.rb
+- lib/forms/config.rb
+- lib/forms/controllers/application_controller.rb
+- lib/forms/controllers/site_controller.rb
+- lib/forms/interface/forms.rb
+- lib/forms/models/extension.rb
+- lib/forms/models/page.rb
+- lib/forms/tags/core.rb
+- lib/forms/tags/helpers.rb
+- lib/forms/tags/responses.rb
 - lib/tasks/forms_extension_tasks.rake
 - public/images/admin/extensions/form/form.png
 - radiant-forms-extension.gemspec
 - spec/controllers/forms_controller_spec.rb
 - spec/datasets/forms.rb
-- spec/lib/forms/addon_methods_spec.rb
 - spec/lib/forms/tags_spec.rb
 - spec/models/form_spec.rb
 - spec/models/response_spec.rb
@@ -74,28 +85,33 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Forms Extension for Radiant CMS
 test_files: 
 - spec/controllers/forms_controller_spec.rb
 - spec/datasets/forms.rb
-- spec/lib/forms/addon_methods_spec.rb
 - spec/lib/forms/tags_spec.rb
 - spec/models/form_spec.rb
 - spec/models/response_spec.rb

data/lib/forms/addon_methods.rb

@@ -1,14 +0,0 @@
-module Forms
-  module AddonMethods
-    def self.included(base)
-      attr_accessor :form, :page, :data
-      base.class_eval do 
-        def initialize(form, page)
-          @form = form
-          @data = page.data
-          @page = page
-        end
-      end
-    end
-  end
-end