merb_form_fields 0.0.2

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Jacques Crocker
+
+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,102 @@
+merb_form_fields
+================
+
+A plugin for the Merb framework that provides a Form Builder that wraps each of your fields. 
+
+It provides validation on the wrapper (adds a class), and will insert the error message automatically.
+
+= form_with_fields_for(@user) do
+  = text_field :first_name
+
+is equivalent to:
+<form ...>
+  <div class="field text_field">
+    <input type="text" name="user_first_name" ... />
+  </div>
+</form>
+
+If there an error on first name it will render:
+<form ...>
+  <div class="field text_field error">
+    <input type="text" name="user_first_name" ... />
+    <em class='error'>First Name is required.</em>
+  </div>
+</form>
+
+Customize Fields with the :field option (takes a hash)
+= text_field :first_name, :field => {:class => "my_field_class", :id => "field_id"}
+
+Customize the error message with the :error option (overrides the default model error)
+= text_field :first_name, :error => "Bzzzzt... wrong!"
+
+
+All render options are easily configurable via Merb::Plugins.config[:merb_form_fields]
+
+Field Tag
+---------
+  Merb::Plugins.config[:merb_form_fields][:field_tag]
+  defaults to :div
+  
+  this defines which tag is used for the field wrapper. 
+  e.g. <div class="field ...">...</div>
+  if you set it to :li, it would render as <li class="field ...">...</li>
+
+
+Field Class
+------------
+  Merb::Plugins.config[:merb_form_fields][:field_tag]
+  defaults to "field"
+  
+  this defines the class used by default for the field wrapper. 
+  e.g. <div class="field ...">...</div>
+  if you set it to "wrapper", it would render as <div class="wrapper ...">...</div>
+
+
+Field Error Class
+-----------------
+  Merb::Plugins.config[:merb_form_fields][:field_error_class]
+  defaults to "error"
+  
+  this defines the class used on the field wrapper when the field is invalid.
+  e.g. <div class="field error ...">...</div>
+  if you set it to "invalid", it would render as <div class="field invalid ...">...</div>
+
+
+Error Message Tag
+------------------
+  Merb::Plugins.config[:merb_form_fields][:error_message_tag]
+  defaults to :em
+
+  this is the tag that is displayed inside the field. 
+  e.g. <em class='error'>First Name is required.</em>
+  If you set it to :span, it would display as <span class='error'>...</span>
+
+
+Error Message Class
+-------------------
+  Merb::Plugins.config[:merb_form_fields][:error_message_class]
+  defaults to "error"
+  
+  this is the class that is used for the error messages displayed inside a field. 
+  e.g. <em class='error'>First Name is required.</em>
+  If you set it to "invalid", it would display as <em class='invalid'>...</em>
+  
+
+Add Field Type Class Option
+----------------------------
+  Merb::Plugins.config[:merb_form_fields][:add_field_type_class?]
+  defaults to true
+
+  if this option is enabled, it will add the field_type as a class to the field wrapper
+  e.g. <div class="field text_field ...">....</div>
+  if you set it to false, it would render without the field_type <div class="field ...">....</div>
+
+
+Skipped Field Types
+------------------
+  Merb::Plugins.config[:merb_form_fields][:skipped_field_types]
+  defaults to [:hidden_field, :check_box, :radio_button]
+  
+  Field types defined in this list will not be wrapped with a field wrapper
+  You can force the field wrapper to show by passing :field => {:force => true} on your field
+  You can prevent the field wrapper from showing by passing :field => {:skip => true} on your field

data/Rakefile

@@ -0,0 +1,51 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+
+require 'merb-core'
+require 'merb-core/tasks/merb'
+
+GEM_NAME = "merb_form_fields"
+GEM_VERSION = "0.0.2"
+AUTHOR = "Jacques Crocker"
+EMAIL = "merbjedi@gmail.com"
+HOMEPAGE = "http://github.com/merbjedi/merb_form_fields"
+SUMMARY = "Merb plugin that provides a Form Builder that will wrap your bound fields with a field div, integrated with the model validation"
+
+spec = Gem::Specification.new do |s|
+  s.rubyforge_project = 'merb'
+  s.name = GEM_NAME
+  s.version = GEM_VERSION
+  s.platform = Gem::Platform::RUBY
+  s.has_rdoc = true
+  s.extra_rdoc_files = ["README", "LICENSE"]
+  s.summary = SUMMARY
+  s.description = s.summary
+  s.author = AUTHOR
+  s.email = EMAIL
+  s.homepage = HOMEPAGE
+  s.add_dependency('merb-helpers', '>= 1.0.8')
+  s.require_path = 'lib'
+  s.files = %w(LICENSE README Rakefile) + Dir.glob("{lib,spec}/**/*")
+  
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+desc "install the plugin as a gem"
+task :install do
+  Merb::RakeHelper.install(GEM_NAME, :version => GEM_VERSION)
+end
+
+desc "Uninstall the gem"
+task :uninstall do
+  Merb::RakeHelper.uninstall(GEM_NAME, :version => GEM_VERSION)
+end
+
+desc "Create a gemspec file"
+task :gemspec do
+  File.open("#{GEM_NAME}.gemspec", "w") do |file|
+    file.puts spec.to_ruby
+  end
+end

data/lib/merb_form_fields/form_field_builder.rb

@@ -0,0 +1,153 @@
+module MerbFormFields 
+  class FormFieldBuilder < Merb::Helpers::Form::Builder::ResourcefulForm
+
+    # --------------------------------------------------------
+    # override the following methods to customize FieldBuilder
+    # --------------------------------------------------------
+
+    # This tag wraps inner error messages
+    def error_message_tag
+      Merb::Plugins.config[:merb_form_fields][:error_message_tag] || :em
+    end
+
+    # This tag wraps the field
+    def field_tag
+      Merb::Plugins.config[:merb_form_fields][:field_tag] || :div
+    end
+
+    # This is the default field class
+    def field_class
+      Merb::Plugins.config[:merb_form_fields][:field_class] || "field"
+    end
+
+    # whether or not to add the field_type class
+    def add_field_type_class?
+      if Merb::Plugins.config[:merb_form_fields][:add_field_type_class?].nil?
+        true
+      else
+        Merb::Plugins.config[:merb_form_fields][:add_field_type_class?]
+      end
+    end
+
+    # These field types are skipped (not wrapped in a field div)
+    def skipped_field_types
+      Merb::Plugins.config[:merb_form_fields][:skipped_field_types] || [:hidden_field, :check_box, :radio_button]
+    end
+
+    # ---------------------------------------------
+    # wrapper method implementation
+    # ---------------------------------------------
+    def field_wrapper(field_type, attrs = {})
+      field_options = attrs.delete(:field) || {}
+      error_override = attrs.delete(:error)
+
+      # build inner field html (using the passed in block) 
+      inner_html = yield if block_given?
+
+      # skip certain field types 
+      # :fields => {:force => true} will force the field to show
+      # :fields => {:skip => true} will prevent the field from showing
+      if (field_options[:force] != true and skipped_field_types.include?(field_type)) or field_options[:skip] == true
+        return inner_html
+      end
+
+      # build class string
+      css_class = field_options[:class] || "#{field_class} #{field_type if add_field_type_class?}"
+      if error_class = field_error_class(@obj, attrs[:method])
+        css_class << " #{error_class}"
+      end
+
+      # build field
+      tag field_tag,
+          "#{inner_html}#{field_error_message(@obj, attrs[:method], error_override)}",
+          field_options.merge(:class => css_class)
+    end
+
+    # returns the class added to the field element if there was an error
+    def field_error_class(obj, method)
+      if obj && method && !obj.errors.on(method.to_sym).blank?
+        Merb::Plugins.config[:merb_form_fields][:field_error_class] || "error"
+      else
+        ""
+      end
+    end
+
+    # displays the inner error message element
+    def field_error_message(obj, method, error_override = nil)
+      if obj && method
+        error = obj.errors.on(method.to_sym)
+        unless error.blank?
+          return "\n<#{error_message_tag} class='#{Merb::Plugins.config[:merb_form_fields][:error_message_class] || "error"}'>#{error_override || error}</#{error_message_tag}>"
+        end
+      end
+    end
+
+    # we'll make our own errors, thank you very much
+    def error_messages_for(obj, error_class, build_li, header, before)
+      obj ||= @obj
+      return "" unless obj.respond_to?(:errors)
+
+      sequel = !obj.errors.respond_to?(:each)
+      errors = sequel ? obj.errors.full_messages : obj.errors
+
+      return "" if errors.empty?
+
+      header_message = header % [errors.size, errors.size == 1 ? "" : "s"]
+      markup = %Q{<div class='#{error_class}'>#{header_message}<ul>}
+      errors.each {|err| markup << (build_li % (sequel ? err : err.join(" ")))}
+      markup << %Q{</ul></div>}
+    end
+
+    # ------------------------------------------------------------------------
+    # methods below are hacks to support merb field wrapping
+    # there needs to be a hook added to merb-core that allows this more easily
+    # ------------------------------------------------------------------------
+    %w(text password hidden file).each do |kind|
+      self.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+        def bound_#{kind}_field(method, attrs = {})
+          name = control_name(method)
+          field_wrapper(:#{kind}_field, attrs.merge(:method => method)) do
+            super
+          end
+        end
+      RUBY
+    end
+
+    def bound_check_box(method, attrs = {})
+      name = control_name(method)
+      field_wrapper(:check_box, attrs.merge(:method => method)) do
+        super
+      end
+    end
+
+    def bound_radio_button(method, attrs = {})
+      name = control_name(method)
+      field_wrapper(:radio_button, attrs.merge(:method => method)) do
+        super
+      end
+    end
+
+    def bound_radio_group(method, arr)
+      val = control_value(method)
+
+      field_wrapper(:radio_group, attrs.merge(:method => method, :arr => arr)) do
+        super
+      end
+    end
+
+    def bound_select(method, attrs = {})
+      name = control_name(method)
+      field_wrapper(:select, attrs.merge(:method => method)) do
+        super
+      end
+    end
+
+    def bound_text_area(method, attrs = {})
+      name = "#{@name}[#{method}]"
+      field_wrapper(:text_area, attrs.merge(:method => method)) do
+        super
+      end
+    end
+    
+  end
+end

data/lib/merb_form_fields/view_helpers.rb

@@ -0,0 +1,9 @@
+module MerbFormFields 
+  module ViewHelpers
+    def form_with_fields_for(name, attrs = {}, &blk)
+      with_form_context(name, MerbFormFields::FormFieldBuilder) do
+        current_form_context.form(attrs, &blk)
+      end
+    end
+  end
+end

data/lib/merb_form_fields.rb

@@ -0,0 +1,23 @@
+# make sure we're running inside Merb
+if defined?(Merb::Plugins)
+  # Merb gives you a Merb::Plugins.config hash...feel free to put your stuff in your piece of it
+  Merb::Plugins.config[:merb_form_fields] = {
+    :field_tag => :div,
+    :field_class => "field",
+    :field_error_class => "error",
+    :add_field_type_class? => true,
+    
+    :error_message_tag => :em,
+    :error_message_class => "error",
+
+    :skipped_field_types => [:hidden_field, :check_box, :radio_button]
+  }
+  
+  Merb::BootLoader.before_app_loads do
+    Merb::Controller.send(:include, MerbFormFields::ViewHelpers)
+  end  
+end
+
+# load classes
+require 'merb_form_fields/form_field_builder'
+require 'merb_form_fields/view_helpers'

data/spec/merb_form_fields_spec.rb

@@ -0,0 +1,7 @@
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe "merb_form_fields" do
+  it "should do nothing" do
+    true.should == true
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+$:.push File.join(File.dirname(__FILE__), '..', 'lib')

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: merb_form_fields
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Jacques Crocker
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-02-22 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: merb-helpers
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.8
+    version: 
+description: Merb plugin that provides a Form Builder that will wrap your bound fields with a field div, integrated with the model validation
+email: merbjedi@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+- LICENSE
+files: 
+- LICENSE
+- README
+- Rakefile
+- lib/merb_form_fields
+- lib/merb_form_fields/form_field_builder.rb
+- lib/merb_form_fields/view_helpers.rb
+- lib/merb_form_fields.rb
+- spec/merb_form_fields_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/merbjedi/merb_form_fields
+post_install_message: 
+rdoc_options: []
+
+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: merb
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: Merb plugin that provides a Form Builder that will wrap your bound fields with a field div, integrated with the model validation
+test_files: []
+