RubyGems - radiant-forms-extension - Versions diffs - 2.0.0 - Mend

radiant-forms-extension 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (43) hide show

data/.gitignore +3 -0
data/README.md +117 -0
data/Rakefile +137 -0
data/VERSION +1 -0
data/app/controllers/admin/forms_controller.rb +10 -0
data/app/controllers/forms_controller.rb +35 -0
data/app/models/form.rb +5 -0
data/app/models/form_page.rb +7 -0
data/app/models/response.rb +11 -0
data/app/views/admin/forms/_fields.html.haml +56 -0
data/app/views/admin/forms/_filters.html.haml +7 -0
data/app/views/admin/forms/_form.html.haml +6 -0
data/app/views/admin/forms/_header.html.haml +3 -0
data/app/views/admin/forms/edit.html.haml +15 -0
data/app/views/admin/forms/index.html.haml +20 -0
data/app/views/admin/forms/new.html.haml +15 -0
data/app/views/admin/forms/remove.html.haml +20 -0
data/config/locales/en.yml +3 -0
data/config/routes.rb +9 -0
data/cucumber.yml +1 -0
data/db/migrate/001_create_forms.rb +16 -0
data/db/migrate/002_create_user_observer.rb +15 -0
data/db/migrate/003_rename_output_to_content.rb +9 -0
data/db/migrate/004_create_responses.rb +13 -0
data/forms_extension.rb +24 -0
data/lib/forms/admin_ui.rb +23 -0
data/lib/forms/application_controller_extensions.rb +20 -0
data/lib/forms/extension_methods.rb +14 -0
data/lib/forms/page_extensions.rb +6 -0
data/lib/forms/site_controller_extensions.rb +19 -0
data/lib/forms/tags.rb +277 -0
data/lib/tasks/forms_extension_tasks.rake +55 -0
data/public/images/admin/extensions/form/form.png +0 -0
data/radiant-forms-extension.gemspec +87 -0
data/spec/controllers/forms_controller_spec.rb +150 -0
data/spec/datasets/forms.rb +30 -0
data/spec/lib/forms/extension_methods_spec.rb +41 -0
data/spec/lib/forms/tags_spec.rb +122 -0
data/spec/models/form_spec.rb +40 -0
data/spec/models/response_spec.rb +31 -0
data/spec/spec.opts +7 -0
data/spec/spec_helper.rb +18 -0
metadata +102 -0

data/.gitignore ADDED Viewed

@@ -0,0 +1,3 @@
+.DS_Store
+*/.DS_Store
+pkg

data/README.md ADDED Viewed

@@ -0,0 +1,117 @@
+# Radiant Forms Extension
+This extension allows a developer to create forms which can take on multiple tasks
+The idea was taken from the mailer extension, everything mail specific is used in [radiant-forms_mail-extension](http://github.com/squaretalent/radiant-forms_mail-extension)
+Using forms 'DRY's up the process of creating and reusing forms across a site (well I think so at least).
+## Installation
+    git clone git://github.com/squaretalent/radiant-forms-extension vendor/extensions/forms
+    rake radiant:extensions:forms:migrate
+    rake radiant:extensions:forms:update
+## Usage
+  A new tab will be present under design, a form has the following properties
+  * **title** reference for when you call the form tag (no spaces)
+    * **action** a specification action to submit the form to (posting to external sites etc)
+    * **redirect_to** location to send the redirection to, will go to posting page otherwise
+  * **body**  output which will be shown on a radiant page
+  * **content** presentation of data after form is submitted (useful when sending emails)
+  * **config** configuration for the addons which will use that form
+  Include the form in a page using a radius tag
+    <r:form name="form_title" />
+## Usage
+### Body
+    <ol>
+      <li>
+        <r:label for='contact[name]'>
+          <span class='title'>Your Name</span>
+          <r:text name='contact[name]' />
+        </r:label>
+      </li>
+      <li>
+        <r:label for='contact[email]'>
+          <span class='title'>Your Email</span>
+          <r:text name='contact[email]' />
+        </r:label>
+      </li>
+      <li>
+        <r:submit value='Send My Name' />
+      </li>
+    </ol>
+### Content
+    <h2>Contact from <r:get name='contact[name]' /></h2>
+    <p>You can get back to them on <r:get name='contact[email]' /></p>
+    <p>Cheers, <br /> <strong>Cool Mailer</strong></p>
+### Config
+  *assuming you have forms_mail installed as well*
+    mail:
+      field:
+        from: contact[email]
+      recipients: info@company.com
+### Response
+    <html>
+      <head>Some Terribly Designed Radiant Page</head>
+      <body>
+        <r:forms:response>
+          <h2>Thank you for contacting us <r:get name='contact[name]' /></h2>
+          <!-- We need to clear the response, sort of like flash data -->
+          <r:clear />
+        </r:forms:response>
+      </body>
+    </html>
+## Addons
+### The Market
+* [radiant-forms_mail-extension](http://github.com/squaretalent/radiant-forms_mail-extension) -
+A showcase of how to use addons, allows you to send emails directly from the page
+### Controller
+  Must be named **FormsBlahController** and contain an inherited FormsExtensionController of the same name
+    class FormsBlahController < FormsExtensionController
+      def create
+        # @form = Form which the data comes from
+        # @page = Page which submitted the form (data contains submitted information)
+        # return = {
+        #   :hash => 'these details will be returned to the result page namespaced under blah'
+        # }
+      end
+    end
+  Any form configured with a **blah** block will know to call this controllers create method
+    blah:
+      key: value
+      another: value
+### Functionality
+    I'm going to let you sort that out, you have the create action with input and output
+    from here you can decide how your form addon is going to behave.

data/Rakefile ADDED Viewed

@@ -0,0 +1,137 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "radiant-forms-extension"
+    gem.summary = %Q{Forms Extension for Radiant CMS}
+    gem.description = %Q{Send data from a page to a form handler, extendable with addons}
+    gem.email = "dirk.kelly@squaretalent.com"
+    gem.homepage = "http://github.com/squaretalent/radiant-forms-extension"
+    gem.authors = ["dirkkelly"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. This is only required if you plan to package forms as a gem."
+end
+# In rails 1.2, plugins aren't available in the path until they're loaded.
+# Check to see if the rspec plugin is installed first and require
+# it if it is.  If not, use the gem version.
+# Determine where the RSpec plugin is by loading the boot
+unless defined? RADIANT_ROOT
+  ENV["RAILS_ENV"] = "test"
+  case
+  when ENV["RADIANT_ENV_FILE"]
+    require File.dirname(ENV["RADIANT_ENV_FILE"]) + "/boot"
+  when File.dirname(__FILE__) =~ %r{vendor/radiant/vendor/extensions}
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../../../")}/config/boot"
+  else
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../")}/config/boot"
+  end
+end
+require 'rake'
+require 'rake/rdoctask'
+require 'rake/testtask'
+rspec_base = File.expand_path(RADIANT_ROOT + '/vendor/plugins/rspec/lib')
+$LOAD_PATH.unshift(rspec_base) if File.exist?(rspec_base)
+require 'spec/rake/spectask'
+require 'cucumber'
+require 'cucumber/rake/task'
+# Cleanup the RADIANT_ROOT constant so specs will load the environment
+Object.send(:remove_const, :RADIANT_ROOT)
+extension_root = File.expand_path(File.dirname(__FILE__))
+task :default => :spec
+task :stats => "spec:statsetup"
+desc "Run all specs in spec directory"
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_opts = ['--options', "\"#{extension_root}/spec/spec.opts\""]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+task :features => 'spec:integration'
+namespace :spec do
+  desc "Run all specs in spec directory with RCov"
+  Spec::Rake::SpecTask.new(:rcov) do |t|
+    t.spec_opts = ['--options', "\"#{extension_root}/spec/spec.opts\""]
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.rcov = true
+    t.rcov_opts = ['--exclude', 'spec', '--rails']
+  end
+  desc "Print Specdoc for all specs"
+  Spec::Rake::SpecTask.new(:doc) do |t|
+    t.spec_opts = ["--format", "specdoc", "--dry-run"]
+    t.spec_files = FileList['spec/**/*_spec.rb']
+  end
+  [:models, :controllers, :views, :helpers].each do |sub|
+    desc "Run the specs under spec/#{sub}"
+    Spec::Rake::SpecTask.new(sub) do |t|
+      t.spec_opts = ['--options', "\"#{extension_root}/spec/spec.opts\""]
+      t.spec_files = FileList["spec/#{sub}/**/*_spec.rb"]
+    end
+  end
+  desc "Run the Cucumber features"
+  Cucumber::Rake::Task.new(:integration) do |t|
+    t.fork = true
+    t.cucumber_opts = ['--format', (ENV['CUCUMBER_FORMAT'] || 'pretty')]
+    # t.feature_pattern = "#{extension_root}/features/**/*.feature"
+    t.profile = "default"
+  end
+  # Setup specs for stats
+  task :statsetup do
+    require 'code_statistics'
+    ::STATS_DIRECTORIES << %w(Model\ specs spec/models)
+    ::STATS_DIRECTORIES << %w(View\ specs spec/views)
+    ::STATS_DIRECTORIES << %w(Controller\ specs spec/controllers)
+    ::STATS_DIRECTORIES << %w(Helper\ specs spec/views)
+    ::CodeStatistics::TEST_TYPES << "Model specs"
+    ::CodeStatistics::TEST_TYPES << "View specs"
+    ::CodeStatistics::TEST_TYPES << "Controller specs"
+    ::CodeStatistics::TEST_TYPES << "Helper specs"
+    ::STATS_DIRECTORIES.delete_if {|a| a[0] =~ /test/}
+  end
+  namespace :db do
+    namespace :fixtures do
+      desc "Load fixtures (from spec/fixtures) into the current environment's database.  Load specific fixtures using FIXTURES=x,y"
+      task :load => :environment do
+        require 'active_record/fixtures'
+        ActiveRecord::Base.establish_connection(RAILS_ENV.to_sym)
+        (ENV['FIXTURES'] ? ENV['FIXTURES'].split(/,/) : Dir.glob(File.join(RAILS_ROOT, 'spec', 'fixtures', '*.{yml,csv}'))).each do |fixture_file|
+          Fixtures.create_fixtures('spec/fixtures', File.basename(fixture_file, '.*'))
+        end
+      end
+    end
+  end
+end
+desc 'Generate documentation for the forms extension.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'FormsExtension'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+# For extensions that are in transition
+desc 'Test the forms extension.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+# Load any custom rakefiles for extension
+Dir[File.dirname(__FILE__) + '/tasks/*.rake'].sort.each { |f| require f }

data/VERSION ADDED Viewed

	@@ -0,0 +1 @@
1	+ 2.0.0

data/app/controllers/admin/forms_controller.rb ADDED Viewed

@@ -0,0 +1,10 @@
+class Admin::FormsController < Admin::ResourceController
+  skip_before_filter :verify_authenticity_token, :only => :create
+  only_allow_access_to :index, :show, :new, :create, :edit, :update, :remove, :destroy,
+    :when => [ :designer, :admin ],
+    :denied_url => { :controller => 'admin/pages', :action => 'index' },
+    :denied_message => 'You must have designer privileges to perform this action.'
+end

data/app/controllers/forms_controller.rb ADDED Viewed

@@ -0,0 +1,35 @@
+class FormsController < ApplicationController
+  no_login_required
+  skip_before_filter :verify_authenticity_token
+  # POST /forms/1
+  #----------------------------------------------------------------------------
+  def create
+    @page = Page.find(params[:page_id])
+    @form = Form.find(params[:form_id])
+    @page.data = params
+    response = current_response
+    response.result = params
+    begin
+      @form[:config] = YAML::load("--- !map:HashWithIndifferentAccess\n"+@form[:config]).symbolize_keys
+    rescue
+      raise "Form '#{@form.title}' has not been configured"
+    end
+    @form[:config].each do |ext, config|
+      ext_controller  = ("Forms#{ext.to_s.capitalize}Controller".constantize).new(@form, @page)
+      response.result = response.result.merge({ "#{ext}_ext" => ext_controller.create })
+    end
+    if response.save
+      redirect_to (@form.redirect_to.nil? ? @page.url : @form.redirect_to)
+    else
+      raise "Form '#{@form.name}' could not be submitted. Sorry"
+    end
+  end
+end

data/app/models/form.rb ADDED Viewed

@@ -0,0 +1,5 @@
+class Form < ActiveRecord::Base
+  validates_presence_of :title
+end

data/app/models/form_page.rb ADDED Viewed

@@ -0,0 +1,7 @@
+class FormPage < Page
+  def cache?
+    false
+  end
+end

data/app/models/response.rb ADDED Viewed

@@ -0,0 +1,11 @@
+class Response < ActiveRecord::Base
+  def result
+    ActiveSupport::JSON.decode(self.result_json) unless self.result_json.nil?
+  end
+  def result=(result)
+    self.result_json = ActiveSupport::JSON.encode(result)
+  end
+end

data/app/views/admin/forms/_fields.html.haml ADDED Viewed

@@ -0,0 +1,56 @@
+- form_for [:admin, @form], :html => {:onsubmit_status => onsubmit_status(@form)}, :html => { :enctype => 'multipart/form-data' } do |form_form|
+  .form_top
+    - render_region :form_top do |form_top|
+      -# empty
+  .form_area
+    - render_region :form do |form|
+      - form.edit_title do
+        %p.title
+          = form_form.label :title, 'Title'
+          = form_form.text_field :title, :class => 'textbox activate', :maxlength => 255
+        .drawer
+          .drawer_contents#attributes
+            %table.fieldset
+              %tr
+                %th.label= form_form.label :action, 'Action'
+                %td.field= form_form.text_field :action, :class => 'textbox', :maxlength => 100, :size => 100
+              %tr
+                %th.label= form_form.label :redirect_to, 'Redirect To'
+                %td.field= form_form.text_field :redirect_to, :class => 'textbox', :maxlength => 100, :size => 100
+          .drawer_handle
+            %a.toggle{:href=>'#attributes', :rel=>"toggle[attributes]", :class=>"#{(meta_errors? ? 'less' : 'more')}"}= meta_label
+      - form.edit_content do
+        #tab_control
+          #tabs.tabs
+          #parts.pages
+            #form_body.page{'data-caption'=>'body'}
+              = render '/admin/forms/filters'
+              = form_form.text_area :body, :class => 'textarea large', :style => 'width: 100%'
+            #form_content.page{'data-caption'=>'content'}
+              = render '/admin/forms/filters'
+              = form_form.text_area :content, :class => 'textarea large', :style => 'width: 100%'
+            #form_config.page{'data-caption'=>'config'}
+              %p
+                %span.reference_links
+                  Available
+              = form_form.text_area :config, :class => 'textarea large', :style => 'width: 100%'
+  .form_bottom
+    - render_region :form_bottom do |form_bottom|
+      - form_bottom.edit_buttons do
+        %p.buttons{:style=>"clear: left"}
+          = save_model_button(@form)
+          = save_model_and_continue_editing_button(@form)
+          or
+          = link_to t('cancel'), admin_forms_url
+      - form_bottom.edit_timestamp do
+        %p.updated_line
+          = updated_stamp @form
+- content_for :page_css do
+  :sass
+    th.label
+      :width 75px !important

data/app/views/admin/forms/_filters.html.haml ADDED Viewed

@@ -0,0 +1,7 @@
+%p
+  %span.reference_links
+    = t('reference')
+    %span#filter_reference_link_body
+      = link_to t('filter'), '/admin/reference/filters?filter_name=Textile', :class => 'popup'
+    %span#tag_reference_link_body
+      = link_to t('available_tags'), '/admin/reference/tags', :class => 'popup'

data/app/views/admin/forms/_form.html.haml ADDED Viewed

@@ -0,0 +1,6 @@
+%tr.node.level_1
+  %td.snippet
+    = image('extensions/form/form', :alt => '')
+    %span= link_to form.title, edit_admin_form_path(form)
+  %td.remove
+    = link_to t('remove'), remove_admin_form_path(form)

data/app/views/admin/forms/_header.html.haml ADDED Viewed

@@ -0,0 +1,3 @@
+-# include_stylesheet 'admin/former'
+-# include_javascript 'admin/former'

data/app/views/admin/forms/edit.html.haml ADDED Viewed

@@ -0,0 +1,15 @@
+- body_classes << "reversed"
+- render_region :main do |main|
+  - main.edit_header do
+    %h1= "Edit Form"
+  - main.edit_form do
+    = render :partial => 'fields'
+    = hidden_field_tag 'page_part_index_field'
+- content_for :page_css do
+  :sass
+    .tab
+      .close
+        :display none

data/app/views/admin/forms/index.html.haml ADDED Viewed

@@ -0,0 +1,20 @@
+- @page_title = 'Forms - ' + default_page_title
+.outset
+  = render 'header'
+  #forms_table
+    %table.index
+      %thead
+        %tr
+          %th.form Form
+          %th.modify Modify
+      %tbody#forms_table_body
+        - if @forms.size != 0
+          = render :partial => 'form', :collection => @forms
+        -else
+          %tr
+            %td.empty{:colspan => 2} No Forms
+#actions
+  %ul
+    %li= link_to "New Form", new_admin_form_path

data/app/views/admin/forms/new.html.haml ADDED Viewed

@@ -0,0 +1,15 @@
+- body_classes << "reversed"
+- render_region :main do |main|
+  - main.edit_header do
+    %h1= "New Form"
+  - main.edit_form do
+    = render :partial => 'fields'
+    = hidden_field_tag 'page_part_index_field'
+- content_for :page_css do
+  :sass
+    .tab
+      .close
+        :display none

data/app/views/admin/forms/remove.html.haml ADDED Viewed

@@ -0,0 +1,20 @@
+%h1 Remove Form
+%p
+  Are you sure you want to
+  %strong.warning permanently remove
+  the following form?
+%table.index#form{ :cellpadding => "0", :cellspacing => "0", :border => "0" }
+  %tbody
+    %tr.node.level-1{ :onmouseover => "Element.addClassName(this, 'highlight');", :onmouseout => "Element.removeClassName(this, 'highlight');" }
+      %td.asset
+        = image('form.png', :alt => '')
+        = @form.title
+- form_for [:admin, @form], :html => { :method => 'delete', :onsubmit_status => "Removing Form&#8230;" } do
+  %p.buttons
+    %input.button{ :type => "submit", :value => "Delete Form" }
+    or
+    = link_to 'Cancel', admin_forms_path

data/config/locales/en.yml ADDED Viewed

@@ -0,0 +1,3 @@
+---
+en:
+  forms: Forms

data/config/routes.rb ADDED Viewed

@@ -0,0 +1,9 @@
+ActionController::Routing::Routes.draw do |map|
+  map.namespace :admin, :member => { :remove => :get } do |admin|
+    admin.resources :forms
+  end
+  map.resources :forms, :only => [ :create ]
+end

data/cucumber.yml ADDED Viewed

	@@ -0,0 +1 @@
1	+ default: --format progress features --tags ~@proposed,~@in_progress

data/db/migrate/001_create_forms.rb ADDED Viewed

@@ -0,0 +1,16 @@
+class CreateForms < ActiveRecord::Migration
+  def self.up
+    create_table :forms do |t|
+      t.string    :title
+      t.string    :action
+      t.string    :redirect_to
+      t.text      :body
+      t.text      :output
+      t.text      :config
+    end
+  end
+  def self.down
+    drop_table :forms
+  end
+end

data/db/migrate/002_create_user_observer.rb ADDED Viewed

@@ -0,0 +1,15 @@
+class CreateUserObserver < ActiveRecord::Migration
+  def self.up
+    add_column :forms, :created_by, :integer
+    add_column :forms, :updated_by, :integer
+    add_column :forms, :created_at, :datetime
+    add_column :forms, :updated_at, :datetime
+  end
+  def self.down
+    remove_column :forms, :created_by
+    remove_column :forms, :updated_by
+    remove_column :forms, :created_at
+    remove_column :forms, :updated_at
+  end
+end

data/db/migrate/003_rename_output_to_content.rb ADDED Viewed

@@ -0,0 +1,9 @@
+class RenameOutputToContent < ActiveRecord::Migration
+  def self.up
+    rename_column :forms, :output, :content
+  end
+  def self.down
+    rename_column :forms, :content, :output
+  end
+end

data/db/migrate/004_create_responses.rb ADDED Viewed

@@ -0,0 +1,13 @@
+class CreateResponses < ActiveRecord::Migration
+  def self.up
+    create_table :responses do |t|
+      t.text        :result_json
+      t.timestamps
+    end
+  end
+  def self.down
+    drop_table :responses
+  end
+end

data/forms_extension.rb ADDED Viewed

@@ -0,0 +1,24 @@
+class FormsExtension < Radiant::Extension
+  version     '2.0'
+  description 'Radiant Form extension. Site wide, useful form management'
+  url         'http://github.com/squaretalent/radiant-forms-extension'
+  extension_config do |config|
+    if RAILS_ENV == :test
+      config.gem 'rr',        :version => '0.10.11'
+    end
+  end
+  def activate
+    Radiant::AdminUI.send(:include, Forms::AdminUI) unless defined? admin.form
+    admin.form = Radiant::AdminUI.load_default_form_regions
+    Page.class_eval { include Forms::Tags, Forms::PageExtensions }
+    ApplicationController.send(:include, Forms::ApplicationControllerExtensions)
+    SiteController.send(:include, Forms::SiteControllerExtensions)
+    tab 'Design' do
+      add_item 'Forms', '/admin/forms', :after => 'Snippets'
+    end
+  end
+end

data/lib/forms/admin_ui.rb ADDED Viewed

@@ -0,0 +1,23 @@
+module Forms
+  module AdminUI
+   def self.included(base)
+     base.class_eval do
+        attr_accessor :form
+        alias_method :forms, :form
+        protected
+          def load_default_form_regions
+            returning OpenStruct.new do |form|
+              form.edit = Radiant::AdminUI::RegionSet.new do |edit|
+                edit.main.concat %w{edit_header edit_form}
+                edit.form.concat %w{edit_title edit_content}
+                edit.form_bottom.concat %w{edit_buttons edit_timestamp}
+              end
+              form.new = form.edit
+            end
+          end
+      end
+    end
+  end
+end

data/lib/forms/application_controller_extensions.rb ADDED Viewed

@@ -0,0 +1,20 @@
+module Forms
+  module ApplicationControllerExtensions
+    def self.included(base)
+      base.class_eval {
+        helper_method :current_response
+        def current_response
+          if request.session[:form_response]
+            @response = Response.find(request.session[:form_response])
+          else
+            @response = Response.create
+            request.session = @response.id
+          end
+          @response
+        end
+      }
+    end
+  end
+end

data/lib/forms/extension_methods.rb ADDED Viewed

@@ -0,0 +1,14 @@
+module Forms
+  module ExtensionMethods
+    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

data/lib/forms/page_extensions.rb ADDED Viewed

@@ -0,0 +1,6 @@
+module Forms
+  module PageExtensions
+    attr_accessor :last_form
+    attr_accessor :data
+  end
+end