handy_form 0.0.1

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/*
+*.gem
+.bundle

data/Gemfile

@@ -0,0 +1,4 @@
+source :gemcutter
+
+# Specify your gem's dependencies in handy_form.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/TODO

@@ -0,0 +1,4 @@
+TODO
+
+* Add readme and docs
+* Add tests!

data/css/forms.css

@@ -0,0 +1,40 @@
+/*
+ * Handy Forms
+ ***************/
+
+.handy_form .text_field_row input,
+.handy_form .password_field_row input,
+.handy_form .select_row select,
+.handy_form .text_area_row textarea,
+.handy_form .check_box_row input,
+.handy_form .radio_button_row input {
+  font-size: 14px;
+  padding: 3px;
+  width: 150px;
+}
+
+.handy_form label {
+  font-size: 12px;
+  margin-right: 5px;
+}
+
+.handy_form .hint {
+  font-size: 11px;
+  color: #aaa;
+}
+
+.handy_form.stacked label,
+.row.stacked label {
+  display: block;
+  clear: both;
+  padding-left: 0;
+  padding-bottom: 0;
+}
+
+.handy_form .row {
+  margin-bottom: 18px;
+}
+
+.handy_form .error-message {
+  color: red;
+}

data/handy_form.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path("../lib/handy_form/version", __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = "handy_form"
+  s.version     = HandyForm::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Peter Bui"]
+  s.email       = ["peter@paydrotalks.com"]
+  s.homepage    = "http://rubygems.org/gems/handy_form"
+  s.summary     = "A handy Rails 3 Form Builder"
+  s.description = "Builds forms with a standard template that has labels, hints, and validations"
+
+  s.required_rubygems_version = ">= 1.3.6"
+  s.rubyforge_project         = "handy_form"
+
+  s.add_development_dependency "bundler", ">= 1.0.0"
+  s.add_runtime_dependency "rails", ">= 3.0"
+
+  s.files        = `git ls-files`.split("\n")
+  s.executables  = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
+  s.require_path = 'lib'
+end

data/lib/handy_form/builder.rb

@@ -0,0 +1,138 @@
+module HandyForm
+  class Builder < ::ActionView::Helpers::FormBuilder
+    (field_helpers -
+      ["form_for", "fields_for",
+       "apply_form_for_options!", "label",
+       "hidden_field"]
+    ).each do |selector|
+      define_method(selector) do |method, *args|
+        options = args.extract_options!
+
+        # Remove the handy-related options from the above options
+        # This will keep the handy_options from being displayed when the
+        # field is composed below.
+        handy_options = extract_handy_options!(options)
+
+        # Build the field as if it weren't modified, allowing HandyForm to use
+        # whatever Rails decides is the representation of the current field.
+        # This allows Rails to be upgraded without HandyForm breaking.
+        field = super(method, *(args << options))
+
+        # Build the label for the field as well. Again, we let Rails handle
+        # this.
+        field_label = build_label(method, handy_options.delete(:label))
+
+        # If checkbox or radio, place input first
+        if field_first?(selector) && !handy_options.has_key?(:input_first)
+          handy_options[:input_first] = true
+        end
+
+        # Add the selector (input type) to the wrapper so that
+        # CSS rules can target the whole row.
+        add_selector_to_wrapper_class!(selector, handy_options)
+
+        # Add any error messages to handy options.
+        if object.errors[method.to_s].any?
+          add_errors!(method, handy_options)
+        end
+
+        # Now combine everything!
+        @template.handy_field_wrapper(field, field_label, handy_options)
+      end
+    end
+
+    # Allows this all handy_form_for objects to behave like the normal form
+    # builder in partials.
+    #
+    # e.g., this will use the "_form.html.erb" partial in the current view
+    # directory.
+    #   <%= handy_form_for(@user) do |f| %>
+    #     <%= render :partial => f %>
+    #   <% end %>
+    #
+    def self.model_name
+      @model_name ||= Struct.new(:partial_path).new("form")
+    end
+
+    def extract_handy_options!(options)
+      options.extract!(:error, :hint, :label, :wrapper, :input_first)
+    end
+
+    # Build's a label for the given ActiveModel method
+    #
+    # When options = false, then no label is built
+    # When options is a string, then the value for the label is the string
+    # When options is a hash, hash[:text] will become the value for the label
+    # and all other options are passed into Rails' label builder.
+    # Otherwise, the label is built off of the method.
+    def build_label(method, options)
+      return "" if options == false
+
+      text = nil
+      label_options = {}
+
+      text = method.to_s.humanize
+      case options
+      when String
+        text = options
+      when Hash
+        if !options[:text].blank?
+          text = options.delete(:text)
+        end
+        label_options = options
+      end
+
+      label(method, text, label_options)
+    end
+    alias_method :label_for, :build_label
+
+    def errors_for(method, options = {})
+      return "" unless object.errors[method.to_s].any?
+      add_errors!(method, options)
+      @template.error_tag(options[:error])
+    end
+
+    def hint(method, options = {})
+      @template.hint_tag(options)
+    end
+
+    protected
+
+      def field_first?(selector)
+        ["check_box", "radio_button"].include?(selector.to_s)
+      end
+
+      def add_selector_to_wrapper_class!(selector, options = {})
+        options[:wrapper] ||= {}
+
+        # This allows for CSS targeting for selector types
+        options[:wrapper][:class] = "#{selector}_row " +
+                                    "#{options[:wrapper][:class]}"
+
+        options[:wrapper][:class].strip!
+      end
+
+      def add_errors!(method, options)
+        return if object.errors[method.to_s].empty?
+
+        options[:wrapper] ||= {}
+        options[:wrapper][:class] = "error #{options[:wrapper][:class]}".strip
+
+        case options[:error]
+        when nil
+          options[:error] = {}
+          options[:error][:text] = object.errors[method.to_s]
+        when Hash
+          options[:error][:text] = object.errors[method.to_s]
+        when String
+          options[:error] = {:text => [options[:error]]}
+        when Array
+          options[:error] = {:text => options[:error]}
+        else
+          raise "Unknown error type #{options[:error].inspect} " +
+                "for :error option"
+        end
+        options[:error] ||= {}
+      end
+  end
+end

data/lib/handy_form/helpers.rb

@@ -0,0 +1,81 @@
+module HandyForm
+  module Helpers
+    def handy_form_for(record_or_name_or_array, *args, &proc)
+      raise ArgumentError, "Missing block" unless block_given?
+      options = args.extract_options!
+      merge_builder_options! options
+      form_for(record_or_name_or_array, *(args << options), &proc)
+    end
+
+    def merge_builder_options!(options)
+      options.merge!(:builder => HandyForm::Builder)
+      options[:html] ||= {}
+      options[:html][:class] = "handy_form #{options[:html][:class]}".strip
+    end
+
+    def handy_field_wrapper(field, field_label, options = {})
+      options[:wrapper] ||= {}
+      merge_option_strings!(options[:wrapper], :class, "row")
+
+      hint = hint_tag(options.delete(:hint))
+      error = error_tag(options.delete(:error))
+
+      unless options.delete(:input_first)
+        content_tag(:div, (
+          field_label.html_safe + field.html_safe +
+          hint.html_safe + error.html_safe
+        ), options[:wrapper]).html_safe
+      else
+        content_tag(:div, (field.html_safe + field_label.html_safe + hint.html_safe + error.html_safe), options[:wrapper]).html_safe
+      end
+    end
+
+    def hint_tag(options)
+      return "" if options.nil?
+      case options
+      when String
+        text = options
+        options = {:class => "hint"}
+      when Hash
+        text = options.delete(:text)
+        merge_option_strings!(options, :class, "error-message")
+      end
+
+      content_tag(:div, text, options)
+    end
+
+    def error_tag(options)
+      return "" if options.nil?
+      case options
+      when String
+        text = options
+        options = {:class => "error-message"}
+      when Hash
+        text = build_error_string(options.delete(:text))
+        merge_option_strings!(options, :class, "error-message")
+      end
+
+      content_tag(:div, text, options)
+    end
+
+    protected
+
+      def build_error_string(messages)
+        if messages.size == 1
+          messages.first
+        else
+          content_tag :ul do
+            items = ""
+            messages.each do |message|
+              items << content_tag(:li, message)
+            end
+            items
+          end
+        end
+      end
+
+      def merge_option_strings!(hash, key, str)
+        hash[key] = "#{str} #{hash[key]}".strip
+      end
+  end
+end

data/lib/handy_form/railtie.rb

@@ -0,0 +1,16 @@
+require 'handy_form'
+require 'rails'
+
+module HandyForm
+  class Railtie < Rails::Railtie
+    initializer "handy_form.initializer" do |app|
+      ::ActionView::Base.class_eval do
+        include HandyForm::Helpers
+      end
+    end
+
+    rake_tasks do
+      load "handy_form/tasks.rake"
+    end
+  end
+end

data/lib/handy_form/tasks.rake

@@ -0,0 +1,12 @@
+namespace :handy_form do
+  desc "Copy handy_form css files into your rails application"
+  task :css_install do
+    gemdir = File.join(File.dirname(__FILE__), "..", "..",)
+    print "\nCopying 'forms.css' to rails' public/stylesheets dir ... "
+    FileUtils.cp(
+      File.join(gemdir, "css", "forms.css"),
+      Rails.root.join("public", "stylesheets")
+    )
+    puts "Done."
+  end
+end

data/lib/handy_form/version.rb

@@ -0,0 +1,3 @@
+module HandyForm
+  VERSION = "0.0.1"
+end

data/lib/handy_form.rb

@@ -0,0 +1,4 @@
+require "handy_form/builder"
+require "handy_form/helpers"
+require "handy_form/railtie"
+

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification 
+name: handy_form
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Peter Bui
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-13 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+  type: :runtime
+  version_requirements: *id002
+description: Builds forms with a standard template that has labels, hints, and validations
+email: 
+- peter@paydrotalks.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Rakefile
+- TODO
+- css/forms.css
+- handy_form.gemspec
+- lib/handy_form.rb
+- lib/handy_form/builder.rb
+- lib/handy_form/helpers.rb
+- lib/handy_form/railtie.rb
+- lib/handy_form/tasks.rake
+- lib/handy_form/version.rb
+has_rdoc: true
+homepage: http://rubygems.org/gems/handy_form
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 3
+      - 6
+      version: 1.3.6
+requirements: []
+
+rubyforge_project: handy_form
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A handy Rails 3 Form Builder
+test_files: []
+