neorails-form_fu 0.1.1

data/LICENSE

@@ -0,0 +1,20 @@
+ViewFu - Copyright (c) 2008 NeoRails.com 
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions: 
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,86 @@
+FormFu
+======
+FormFu is a Rails plugin that enables you to easily build nice, tableless forms
+
+
+Maintainer Info
+======
+
+Tyler Crocker
+NeoRails.com
+
+Looking for *the one* awesome rails developer to add to your project? I may be available to help out. Contact me at neorails@gmail.com. 
+
+
+Installation
+======
+
+script/plugin install git://github.com/neorails/view_fu.git
+
+or
+
+# Add this to your environment.rb
+config.gem 'neorails-form_fu', :version => '>= 0.1',
+                               :lib => 'form_fu',
+                               :source => 'http://gems.github.com'
+
+
+Usage
+======
+
+  Create a Basic Form for a Model
+  <% build_form_for @widget do |f| %>
+    <%= f.text_field :name %>
+    <%= f.text_area :description %>
+    <%= f.submit %>
+  <% end %>
+  
+  --------
+  
+  Create Fields for a Model
+  <% build_fields_for @address do |a| %>
+    <%= a.text_field :street %>
+    <%= a.text_field :city %>
+    <%= a.select :state, State.to_select %>
+  <% end %>
+  
+  --------
+  
+  Set up a label
+  <%= f.text_field :name, :label => "Enter Your Name" %>  
+
+  --------
+  
+  Change the separator
+  <%= f.text_field :name, :separator => "" %>
+
+  --------
+  
+  Take a Block (adds it to the field div)
+  <% f.text_field :name do %>
+    <div class="hint">
+      please enter your name...
+    </div>
+  <% end %>
+
+  --------
+  
+  Add options to the field
+  <%= f.text_field :name, :field => {:class => "left"} %>
+
+  --------
+
+  Add an Error Messages Summary
+  <%= f.error_messages %>
+                                 
+  --------
+
+
+Try my other plugins
+======
+
+If you like FormFu, you'll *love* ViewFu. It will help you deal with Stylesheets, Javascripts, Page titles, and adds tons of useful view helper methods.
+https://github.com/neorails/view_fu
+
+
+Copyright (c) 2008 NeoRails.com, released under the MIT license

data/form_fu.gemspec

@@ -0,0 +1,30 @@
+Gem::Specification.new do |s|
+  s.name = 'form_fu'
+  s.version = '0.1.1'
+  s.date = '2008-07-06'
+  
+  s.summary = "Build Nice DRY Rails Forms"
+  s.description = "FormFu is a Rails plugin that enables you to easily build nice, tableless forms"
+   
+  s.authors = ['Tyler Crocker']
+  s.email = 'neorails@gmail.com'
+  s.homepage = 'http://github.com/neorails/form_fu'
+  
+  s.has_rdoc = true
+  s.rdoc_options = ["--main", "README"]
+  s.extra_rdoc_files = ["README"]
+
+  s.add_dependency 'rails', ['>= 2.1']
+
+  s.files = ["LICENSE",
+             "README",
+             "form_fu.gemspec",
+             "init.rb",
+             "lib/form_fu/form_builder.rb",
+             "lib/form_fu/helpers.rb",
+             "lib/form_fu.rb",
+             "rails/init.rb"]
+
+  s.test_files = ["test/form_fu_test.rb"]
+
+end

data/init.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + "/rails/init"

data/lib/form_fu/form_builder.rb

@@ -0,0 +1,113 @@
+module FormFu
+
+  # A form builder that produces tableless, lined-up forms.
+  class FormBuilder < ActionView::Helpers::FormBuilder
+    # automatically wrap all the standard formbuilder helpers
+     (field_helpers - %w(label radio_button hidden_field text_area)).each do |selector|
+      src = <<-END_SRC
+        def #{selector}(field, options = {}, &block)
+          format_with_label(field, options.merge(:field_type => "#{selector}"), super(field, purge_custom_tags(options)), &block)
+        end
+      END_SRC
+      class_eval src, __FILE__, __LINE__
+    end
+
+    def text_area(field, options = {}, &block)
+      format_with_label(field, options.merge(:field_type => "text_area", :preserve => true), super(field, purge_custom_tags(options)), &block)
+    end
+
+    # wrap the date_select helper
+    def date_select(field, options={}, &block)
+      format_with_label(field, options.merge(:field_type => "date"), super(field, purge_custom_tags(options)), &block)
+    end
+
+    # create a radio group helper that works very similarly to the select helper
+    def radio_group(field, choices, options={}, &block)  
+
+      # handle special cases
+      if choices == :boolean
+        choices = [["True", "true"], ["False", "false"]]
+      elsif choices == :yes_no
+        choices = [["Yes", "yes"], ["No", "no"]]
+      elsif choices.class != Array
+        choices = []
+      end
+      
+      # build radio choices html 
+      choices_html = ""
+      choices.each do |key, value|
+        radio_html = radio_button(field, value)+key
+        
+        # wrap radio html in a label (for easier selection)
+        choices_html << content_tag(:label, radio_html, :class => "radio-option")
+      end
+      
+      # wrap the radio-group with a label
+      format_with_label(field, options.merge(:field_type => "radio-group"), choices_html, &block)
+    end
+
+    # wrap the select helper
+    def select(field, choices, options={}, &block)
+      html_options = options.delete(:html) || {}
+      format_with_label(field, options.merge(:field_type => "select"), super(field, choices, options, html_options), &block)
+    end
+
+    # create a submit helper
+    def submit(value = "Submit", options = {})
+      @template.submit_tag(value, options)
+    end
+
+    # create a image_submit helper
+    def image_submit(img_path, options = {})
+      @template.image_submit_tag(img_path, options)
+    end
+
+    # create an error messages helper
+    def error_messages(object_name = nil)
+      @template.error_messages_for object_name || @object_name
+    end
+
+    private
+
+    # format a helper by generating the haml to wrap it in a field_tag and include a label
+    def format_with_label(field, options, tag_output, &block)
+      # see if we have an error on the field
+      errors_on = object.send(:errors).send(:on, field)
+      has_error = true unless errors_on.blank?
+
+      # set field options
+      options[:field] ||= {}
+      options[:field].merge!(:has_error => has_error, :field_type => options[:field_type])
+
+      if options[:preserve]
+        tag_output = @template.preserve(tag_output)
+      end
+
+      output_html = @template.field_tag(options[:field], [
+          @template.label(@object_name, field, options[:label], :separator => options[:separator] || default_separator),
+          tag_output,
+          @template.validation_tag(@object, field),
+          block_given? ? @template.capture(&block) : nil
+      ].compact.join("\n"))
+
+      Rails.logger.debug "OUTPUTING LABEL FORMAT:\n\n#{output_html}\n\n"
+      
+      if block_given?
+        # concat to page if block was given
+        return concat(output_html, block.binding)
+      else
+        # otherwise return html directly
+       return output_html
+      end
+    end
+
+    def default_separator
+      ": "
+    end
+
+    # Removes tags such as :html, :label so they dont get rendered on the final html
+    def purge_custom_tags(options)
+      options.reject{ |key,value| [:label, :html, :field, :field_type, :separator].include?(key.to_sym) }
+    end
+  end
+end

data/lib/form_fu/helpers.rb

@@ -0,0 +1,90 @@
+module FormFu
+  module Helpers
+    # Create a form_for block using FormFuBuilder
+    def formfu_for(record_or_name_or_array, *args, &proc)  
+      options = args.extract_options!
+      args << options.merge(:builder => FormFu::FormBuilder)
+      form_for(record_or_name_or_array, *args, &proc)
+    end
+    
+    # also work with the more semantic name (build_form_for)
+    alias :build_form_for :formfu_for
+    
+    # Create a fields_for block using FormFuBuilder
+    def formfu_fields_for(object_or_object_name, *args, &block)
+      raise ArgumentError, "Missing block" unless block_given?
+      options = args.extract_options!
+
+      if object_or_object_name.class == Symbol
+        # if object_or_object_name is a symbol, use the object from args
+        object_name = object_or_object_name
+        object  = args.first
+      else
+        # otherwise retrieve the object_name from ActiveRecord helper
+        object = object_or_object_name
+        object_name = ActionController::RecordIdentifier.singular_class_name(object)
+      end
+
+      yield FormFu::FormBuilder.new(object_name, object, self, options, block)
+    end 
+    
+    # also work with the more semantic name (build_fields_for)
+    alias :build_fields_for :formfu_fields_for
+    
+    # wrap content with a fieldset tag with a legend
+    def fieldset_tag(legend_name, options = {}, &block)
+      if block_given?
+        concat(content_tag(:fieldset, options) do
+          (legend_name ? content_tag(:legend, legend_name) : "")+
+          capture(&block)
+        end, block.binding)
+      else
+        return content_tag(:fieldset, options) do
+          content_tag :legend, legend_name
+        end
+      end
+    end
+
+    #generate a field div with label
+    def field_tag(options_or_label = {}, content = nil, &block)
+      label, options =  "", {}
+      if options_or_label.class == String
+        label = options_or_label
+        options[:class] = "field"
+      else
+        options = options_or_label
+        # grab the error indicator out of the options
+        has_error = options.delete(:has_error) || false
+
+        # grab the field_type out of the options
+        field_type = options.delete(:field_type) || nil
+
+        # append field as css class for div options
+        options[:class] = "field #{field_type} #{options[:class]} #{'withErrors' if has_error}"
+      end
+      
+      if block_given?
+        concat(content_tag(:div, options) do
+          (label.blank? ? "" : content_tag(:label, label.strip)) +
+          capture(&block)
+        end, block.binding)
+      else
+        content_tag(:div, options) do
+          (label.blank? ? "" : content_tag(:label, label.strip))+content.to_s
+        end
+      end
+    end
+    
+    # show validation error is applicable
+    def validation_tag(model, attribute, options = {})
+      return if model.blank? or model.errors.blank?    
+      unless model.errors[attribute].blank?
+        # generate error markup
+        content_tag :span, :class => "error-message" do
+          [model.errors[attribute]].flatten.join(options[:separator] || ", ").to_s
+        end
+      end
+    end
+    
+  end
+end

data/lib/form_fu.rb

@@ -0,0 +1,21 @@
+require "form_fu/form_builder"
+require "form_fu/helpers"
+ActionView::Base.send :include, FormFu::Helpers
+
+# Override the error proc to use a span instead of a div
+module ActionView
+  class Base #:nodoc:
+    @@field_error_proc = Proc.new{ |html_tag, instance| "#{html_tag}" }
+    cattr_accessor :field_error_proc
+  end 
+end
+
+# Add a to_select method to our ActiveRecord models
+module ActiveRecord
+  class Base
+    #find all items matching _condition_, and return an array of [value,key], useful for using with select
+    def self.to_select(method='to_s', conditions=nil)
+      find(:all, :conditions => conditions).collect{|record| [record.send(method), record.id]}
+    end
+  end
+end

data/rails/init.rb

@@ -0,0 +1 @@
+require 'form_fu'

data/test/form_fu_test.rb

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'test/unit'
+require 'form_fu'
+
+class FormFuTest < Test::Unit::TestCase
+
+  include ActionView::Helpers::TagHelper
+  include FormFu::Helpers
+  
+  def test_truth
+    assert true
+  end
+
+end

metadata

@@ -0,0 +1,69 @@
+--- !ruby/object:Gem::Specification 
+name: neorails-form_fu
+version: !ruby/object:Gem::Version 
+  version: 0.1.1
+platform: ruby
+authors: 
+- Tyler Crocker
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-07-06 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "2.1"
+    version: 
+description: FormFu is a Rails plugin that enables you to easily build nice, tableless forms
+email: neorails@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- LICENSE
+- README
+- form_fu.gemspec
+- init.rb
+- lib/form_fu/form_builder.rb
+- lib/form_fu/helpers.rb
+- lib/form_fu.rb
+- rails/init.rb
+has_rdoc: true
+homepage: http://github.com/neorails/form_fu
+post_install_message: 
+rdoc_options: 
+- --main
+- README
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Build Nice DRY Rails Forms
+test_files: 
+- test/form_fu_test.rb