wheelhouse-forms 1.0

data/app/models/forms/fields/text_field.rb

@@ -0,0 +1,21 @@
+module Forms::Fields
+  class TextField < Field
+    property :label, String, :required => true
+    property :input_type, String, :default => "text"
+    property :required, Boolean, :default => false
+    
+    self.renderer = Forms::TextFieldRenderer
+    
+    INPUT_TYPES = [
+      ["Text",        "text"],
+      ["Email",       "email"],
+      ["Telephone",   "tel"],
+      ["URL",         "url"],
+      ["Date",        "date"],
+      ["Date & Time", "datetime"],
+      ["Number",      "number"],
+      ["Search",      "search"],
+      ["Color",       "color"]
+    ]
+  end
+end

data/app/models/forms/form.rb

@@ -0,0 +1,65 @@
+class Forms::Form < Wheelhouse::Resource
+  include Wheelhouse::Resource::Node
+  include Wheelhouse::Resource::Renderable
+  include Wheelhouse::Resource::Addressable
+  include Wheelhouse::Resource::Versioned
+  include Wheelhouse::Resource::Content
+  
+  property :title, String, :required => true, :translate => true
+  property :fields, FieldCollection, :default => [Forms::Fields::FieldSet.new]
+  property :recipients, MongoModel::Collection[String]
+  property :subject, String, :default => "Form Submission"
+  
+  validates_associated :fields
+  
+  has_many :submissions, :class => "Forms::Submission"
+  
+  activities :all
+  
+  icon "wheelhouse-forms/form.png"
+  
+  attr_accessor :view_context, :current_submission
+  
+  def to_s
+    render(view_context)
+  end
+  
+  def render(template)
+    Forms::FormRenderer.new(self, current_submission, template).render
+  end
+  
+  def submit(params)
+    submission = submissions.build(:params => params)
+    
+    if submission.save
+      deliver(submission)
+      @success = true
+    else
+      self.current_submission = submission
+      @success = false
+    end
+  end
+  
+  def deliver(submission)
+    Forms::Mailer.submission(self, submission).deliver unless recipients.empty?
+  rescue
+    # Mail delivery failed
+  end
+  
+  def success?
+    @success
+  end
+  
+  def first_content_field
+    @first_content_field ||= fields.flatten.find { |f| f.respond_to?(:label) }
+  end
+  
+  def recipients=(recipients)
+    recipients = recipients.split(/,/) if recipients.is_a?(String)
+    write_attribute(:recipients, recipients.map(&:strip))
+  end
+  
+  def handler
+    Forms::FormHandler
+  end
+end

data/app/models/forms/submission.rb

@@ -0,0 +1,53 @@
+class Forms::Submission < Wheelhouse::BasicResource
+  class Parameters < Hash
+    def to_mongo
+      result = []
+      each do |key, value|
+        result << [key, value]
+      end
+      result
+    end
+    
+    def self.cast(params)
+      case params
+      when Hash
+        self[params]
+      when Array
+        params.each_with_object({}) { |v, hash| hash[v[0]] = v[1] }
+      end
+    end
+    
+    def self.from_mongo(params)
+      cast(params)
+    end
+  end
+  
+  include Wheelhouse::Resource::AdminPath
+  
+  property :params, Parameters
+  timestamps!
+  
+  belongs_to :form, :class => "Forms::Form"
+  
+  default_scope order(:created_at.desc)
+  
+  validate do
+    form.fields.flatten.each do |field|
+      if field.required? && value_for(field).blank?
+        errors.add(field.label, "This field is required")
+      end
+    end
+  end
+  
+  def value_for(field)
+    params[field.label]
+  end
+  
+  def admin_path
+    form_submission_path(form_id, id)
+  end
+  
+  def admin_url
+    form_submission_url(form, id, :host => form.site.domain)
+  end
+end

data/app/renderers/forms/checkbox_renderer.rb

@@ -0,0 +1,7 @@
+class Forms::CheckboxRenderer < Forms::FieldRenderer
+  def render
+    super do
+      label_tag { check_box_tag(name, "Yes", value, html_options) + " " + field.label }
+    end
+  end
+end

data/app/renderers/forms/checkboxes_renderer.rb

@@ -0,0 +1,18 @@
+class Forms::CheckboxesRenderer < Forms::FieldRenderer
+  include Forms::LabelledFieldRenderer
+  
+  def render
+    super { content_tag(:ul, safe_join(list_items, "\n")) }
+  end
+
+protected
+  def list_items
+    field.options.map { |o| content_tag(:li, checkbox(o)) }
+  end
+
+  def checkbox(option)
+    content_tag(:label, :class => "option #{option.parameterize}") do
+      check_box_tag("#{name}[]", option, (value || []).include?(option), :id => nil) + " " + option
+    end
+  end
+end

data/app/renderers/forms/content_field_renderer.rb

@@ -0,0 +1,5 @@
+class Forms::ContentFieldRenderer < Forms::FieldRenderer
+  def render
+    field.content.to_s
+  end
+end

data/app/renderers/forms/custom_field_renderer.rb

@@ -0,0 +1,5 @@
+class Forms::CustomFieldRenderer < Forms::FieldRenderer
+  def render
+    super { template.render :partial => field.partial, :locals => { :field => field } }
+  end
+end

data/app/renderers/forms/field_collection_renderer.rb

@@ -0,0 +1,13 @@
+class Forms::FieldCollectionRenderer
+  include ActionView::Helpers::OutputSafetyHelper
+  
+  attr_reader :collection, :submission, :template
+  
+  def initialize(collection, submission, template)
+    @collection, @submission, @template = collection, submission, template
+  end
+  
+  def render
+    safe_join(collection.map { |field| field.render(submission, template) }, "\n")
+  end
+end

data/app/renderers/forms/field_renderer.rb

@@ -0,0 +1,57 @@
+class Forms::FieldRenderer
+  include ActionView::Helpers::FormTagHelper
+  include ActionView::Helpers::OutputSafetyHelper
+  
+  attr_accessor :output_buffer
+  attr_reader :field, :submission, :template
+  
+  def initialize(field, submission, template)
+    @field, @submission, @template = field, submission, template
+  end
+  
+  def render
+    content_tag(:div, :class => classes.join(" ")) do
+      concat yield if block_given?
+      concat content_tag(:p, error, :class => "error") if has_errors?
+    end
+  end
+
+protected
+  def name
+    "submission[#{reference}]"
+  end
+  
+  def reference
+    field.label
+  end
+  
+  def field_class
+    field.class.partial.dasherize
+  end
+  
+  def classes
+    classes = ["field", field_class]
+    classes << reference.parameterize
+    classes << "required" if field.required?
+    classes << "error" if has_errors?
+    classes.uniq
+  end
+  
+  def value
+    submission.value_for(field) if submission
+  end
+  
+  def has_errors?
+    submission && submission.errors[field.label].any?
+  end
+  
+  def error
+    submission.errors[field.label].first
+  end
+  
+  def html_options
+    options = {}
+    options[:required] = "required" if field.required?
+    options
+  end
+end

data/app/renderers/forms/field_set_renderer.rb

@@ -0,0 +1,10 @@
+class Forms::FieldSetRenderer < Forms::FieldRenderer
+  def render
+    content_tag(:fieldset, :class => field.legend? ? field.legend.parameterize : '') do
+      ActiveSupport::SafeBuffer.new.tap do |result|
+        result << content_tag(:legend, field.legend) if field.legend?
+        result << field.fields.render(submission, template)
+      end
+    end
+  end
+end

data/app/renderers/forms/form_renderer.rb

@@ -0,0 +1,30 @@
+class Forms::FormRenderer
+  include ActionView::Helpers::FormTagHelper
+
+  attr_accessor :output_buffer
+  attr_reader :form, :submission, :template
+  
+  def initialize(form, submission, template)
+    @form, @submission, @template = form, submission, template
+  end
+  
+  def render
+    form_tag(form.path) do
+      concat form.fields.render(submission, template)
+      concat default_submit_button unless has_submit_button?
+    end
+  end
+  
+  def protect_against_forgery?
+    false
+  end
+  
+private
+  def has_submit_button?
+    form.fields.flatten.any? { |f| f.is_a?(Forms::Fields::SubmitButton) }
+  end
+  
+  def default_submit_button
+    content_tag(:div, submit_tag("Submit"), :class => "submit")
+  end
+end

data/app/renderers/forms/labelled_field_renderer.rb

@@ -0,0 +1,10 @@
+module Forms::LabelledFieldRenderer
+  def render
+    super do
+      result = ActiveSupport::SafeBuffer.new
+      result << label_tag(name, field.label.html_safe) if field.label?
+      result << yield if block_given?
+      result
+    end
+  end
+end

data/app/renderers/forms/radio_buttons_renderer.rb

@@ -0,0 +1,18 @@
+class Forms::RadioButtonsRenderer < Forms::FieldRenderer
+  include Forms::LabelledFieldRenderer
+  
+  def render
+    super { content_tag(:ul, safe_join(list_items, "\n")) }
+  end
+
+protected
+  def list_items
+    field.options.map { |o| content_tag(:li, radio_button(o)) }
+  end
+
+  def radio_button(option)
+    content_tag(:label, :class => "option #{option.parameterize}") do
+      radio_button_tag(name, option, value == option, :id => nil) + " " + option
+    end
+  end
+end

data/app/renderers/forms/select_field_renderer.rb

@@ -0,0 +1,9 @@
+class Forms::SelectFieldRenderer < Forms::FieldRenderer
+  include Forms::LabelledFieldRenderer
+  
+  include ActionView::Helpers::FormOptionsHelper
+  
+  def render
+    super { select_tag(name, options_for_select(field.options, value), html_options) }
+  end
+end

data/app/renderers/forms/submit_button_renderer.rb

@@ -0,0 +1,5 @@
+class Forms::SubmitButtonRenderer < Forms::FieldRenderer
+  def render
+    content_tag(:div, submit_tag(field.label), :class => "field submit")
+  end
+end

data/app/renderers/forms/text_area_renderer.rb

@@ -0,0 +1,7 @@
+class Forms::TextAreaRenderer < Forms::FieldRenderer
+  include Forms::LabelledFieldRenderer
+  
+  def render
+    super { text_area_tag(name, value, html_options) }
+  end
+end

data/app/renderers/forms/text_field_renderer.rb

@@ -0,0 +1,7 @@
+class Forms::TextFieldRenderer < Forms::FieldRenderer
+  include Forms::LabelledFieldRenderer
+  
+  def render
+    super { text_field_tag(name, value, html_options.merge(:type => field.input_type)) }
+  end
+end

data/app/templates/form.html.haml

@@ -0,0 +1,9 @@
+- template.name = "Default Form"
+- template.resource = Forms::Form
+
+= @form.content
+
+- if @form.success?
+  = @form.content("Success Message", :rows => 15)
+- else
+  = @form

data/app/templates/form.xhr.haml

@@ -0,0 +1,4 @@
+- if @form.success?
+  = @form.content("Success Message")
+- else
+  = @form

data/app/templates/form/submission.html.haml

@@ -0,0 +1,15 @@
+!!!
+
+%html
+  %head
+  
+  %body
+    %p= link_to "View this submission online", @submission.admin_url
+    
+    %p
+      %strong Submitted at:
+      = @submission.created_at.to_s(:long)
+    
+    - @form.fields.each do |field|
+      = render_field(field)
+      

data/app/views/forms/forms/_checkbox.haml

@@ -0,0 +1,3 @@
+= form_field(checkbox, :index => index, :prefix => prefix, :class => "checkbox") do |f|
+  = f.text_field :label, :title => "Checkbox Label", :placeholder => "Checkbox Label", :id => nil
+  = f.required_field_checkbox

data/app/views/forms/forms/_checkboxes.haml

@@ -0,0 +1,10 @@
+= form_field(checkboxes, :index => index, :prefix => prefix, :class => "checkboxes") do |f|
+  = f.text_field :label, :title => "Checkboxes Label", :placeholder => "Checkboxes Label", :id => nil
+  = f.required_field_checkbox
+  
+  %ul.options
+    %li
+      %label Options:
+    
+    - checkboxes.options(true).each do |option|
+      %li= text_field_tag "#{prefix}[options][]", option, :id => nil

data/app/views/forms/forms/_content_field.haml

@@ -0,0 +1,3 @@
+= form_field(content_field, :index => index, :prefix => prefix, :class => "content-field", :icon => "content") do |f|
+  = f.text_area :content, :class => "editor", :rows => 5
+  

data/app/views/forms/forms/_countries_dropdown.haml

@@ -0,0 +1,4 @@
+= form_field(countries_dropdown, :index => index, :prefix => prefix, :class => "countries-dropdown", :icon => "countries") do |f|
+  = f.text_field :label, :title => "Countries Dropdown Label", :placeholder => "Countries Dropdown Label", :id => nil
+  = f.required_field_checkbox
+  

data/app/views/forms/forms/_custom_field.haml

@@ -0,0 +1,4 @@
+= form_field(custom_field, :index => index, :prefix => prefix, :class => "custom-field", :icon => "custom") do |f|
+  = f.text_field :label, :title => "Custom Field Label", :placeholder => "Custom Field Label", :id => nil
+  = f.text_field :partial, :title => "Partial", :placeholder => "Partial", :id => nil
+  

data/app/views/forms/forms/_field_set.haml

@@ -0,0 +1,16 @@
+.field-set{ "data-index" => index }
+  = hidden_field_tag "#{prefix}[type]", field_set.type.demodulize, :id => nil
+  
+  .drag
+
+  .drag-area
+    = label_tag "fieldset_#{index}_legend", "Fieldset Legend:"
+    = text_field_tag "#{prefix}[legend]", field_set.legend, :id => "fieldset_#{index}_legend"
+  
+    %span.note (leave blank for none)
+
+  .fields{ "data-prefix" => "form[fields][#{index}][fields]" }
+    = render_fields(field_set.fields, "form[fields][#{index}][fields]")
+  
+  = link_to "Delete", '#', :class => 'delete'
+