formz 0.0.4

data/lib/formz/helpers.rb

@@ -0,0 +1,159 @@
+
+module Formz
+  
+  ##
+  # = Formz::Helpers
+  #
+  # The Formz:Helpers module provides unbound form related
+  # helper methods such as #checkbox, #password and others.
+  
+  module Helpers
+    
+    ##
+    # Return a form.
+    
+    def form name, attrs = {}, &block
+      Tagz.tag :form, { :id => "form-#{name}" }.merge(attrs), &block
+    end
+    
+    ##
+    # Return a legend with _contents_.
+
+    def legend contents, attrs = {}, &block
+      Tagz.tag :legend, contents, attrs, &block
+    end
+    
+    ##
+    # Return a fieldset with optional _legend_.
+    
+    def fieldset name, legend = nil, attrs = {}, &block
+      attrs, legend = legend, nil if legend.is_a? Hash
+      Tagz.tag :fieldset, legend ? legend(legend) : nil, { :id => "fieldset-#{name}" }.merge(attrs), &block
+    end
+    
+    ##
+    # Return a textarea.
+    
+    def textarea name, contents = nil, attrs = {}, &block
+      attrs, contents = contents, nil if contents.is_a? Hash
+      Tagz.tag :textarea, contents, { :name => name }.merge(attrs), &block
+    end
+    
+    ##
+    # Wrap form elements in div _name_.
+    
+    def group name, &block
+      Tagz.tag :div, { :class => "group-#{name}" }, &block
+    end
+    
+    ##
+    # Wrap form buttons defined within _block_ in a div.
+    
+    def buttons attrs = {}, &block
+      Tagz.tag :div, { :class => 'form-buttons' }.merge(attrs), &block
+    end
+    
+    %w( checkbox radio text submit reset hidden button password file ).each do |name|
+      class_eval <<-END
+        def #{name} name, value = nil, attrs = {}
+          attrs, value = value, nil if value.is_a? Hash
+          attrs[:value] ||= value
+          Tagz.tag :input, { :type => :#{name}, :name => name }.merge(attrs)
+        end
+      END
+    end
+    
+    %w( checkbox radio ).each do |name|
+      class_eval <<-END
+        def #{name}_group name, values, options = {}
+          values.map do |key, value|
+            #{name} name, key, :label => value, :checked => option_selected?(key, options)
+          end.join
+        end
+      END
+    end
+    
+    ##
+    # Return select element _name_ with _options_ hash.
+    
+    def select name, options, attrs = {}
+      options = select_options options, attrs
+      attrs.delete :selected
+      Tagz.tag :select, options, { :name => name }.merge(attrs)
+    end
+    
+    ##
+    # Return select option _contents_ with _value_.
+
+    def select_option value, contents, attrs = {}
+      Tagz.tag :option, contents, { :value => value }.merge(attrs)
+    end
+    
+    ##
+    # Return select option elements from _values_ with
+    # _options_ passed. 
+    #
+    # === Options
+    #
+    #   :selected    string, symbol, or array of options selected
+    #
+
+    def select_options values, options = {}
+      normalize_select_prompt values, options
+      values.map do |key, value|
+        if value.is_a? Hash
+          Tagz.tag :optgroup, select_options(value, options), :label => key
+        elsif option_selected? key, options[:selected]
+          select_option key, value, :selected => true
+        else
+          select_option key, value
+        end
+      end.join
+    end
+    
+    ##
+    # Check if option _key_ is _selected_.
+    
+    def option_selected? key, selected
+      if Array === selected
+        selected.any? do |value|
+          key.to_s == value.to_s
+        end
+      else
+        key.to_s == selected.to_s
+      end
+    end
+    
+    ##
+    # Normalize select prompt. 
+    #
+    # * When _options_ contains a :prompt string it is assigned as the prompt
+    # * When :prompt is true the default of '- Select -' will become the prompt
+    # * The prompt is selected unless a specific option is explicitly selected.
+    #
+
+    def normalize_select_prompt values, options = {}
+      return unless :prompt.in? options
+      prompt = options.delete :prompt
+      options[:selected] = '' unless :selected.in? options
+      values[''] = String === prompt ? prompt : '- Select -'
+    end
+    
+    #--
+    # Delegates
+    #++
+
+    module Delegates
+      %w( select_options select_option select checkbox radio text submit reset hidden 
+          button password file checkbox_group radio_group buttons textarea fieldset
+          legend form group ).each do |meth|
+        class_eval <<-EOF
+          def #{meth} *args, &block
+            @contents << Formz::Helpers.#{meth}(*args, &block)
+          end
+        EOF
+      end
+    end
+     
+  end
+end

data/lib/formz/import.rb

@@ -0,0 +1,12 @@
+
+require 'formz'
+require 'tagz/import'
+
+include Formz::Labels
+include Formz::Descriptions
+include Formz::Errors
+include Formz::Wrappers
+include Formz::Helpers
+include Formz::AutoEncoding
+include Formz::FauxMethod
+include Formz::Models

data/lib/formz/labels.rb

@@ -0,0 +1,55 @@
+
+module Formz
+  
+  ##
+  # = Formz::Labels
+  #
+  # The Formz:Labels module allows a :label attribute
+  # to be passed, which then adds a label tag to the
+  # markup output. Tags are nested nested within its
+  # label, in cases such as for checkboxes or radio
+  # buttons.
+  #
+  # When using labels, a :required attribute may also 
+  # be passed, which will alter the markup to indicate
+  # the input field is required.
+  #
+  # === Examples
+  #
+  #   tag :input, :type => :file, :name => :upload, :label => 'Upload', :required => true
+  #
+  #   <div class="form-upload form-file">
+  #     <label for="upload">Upload<em>*</em>:</label>
+  #     <input type="file" name="upload" />
+  #   </div>
+  #
+  
+  module Labels
+    NESTED_LABEL_INPUT_TYPES = :checkbox, :radio
+    
+    def create_tag name, contents, attrs, &block
+      if name != :optgroup && string = attrs.delete(:label)
+        label_attrs = { :for => attrs[:name], :required => attrs.delete(:required) }
+        if attrs[:type].in? NESTED_LABEL_INPUT_TYPES
+          label string, super, label_attrs
+        else
+          label(string, label_attrs) << super
+        end
+      else
+        super
+      end
+    end
+
+    ##
+    # Return a label with _string_. When _contents_
+    # is present the label will act as a wrapper for
+    # checkboxes, radios etc.
+    
+    def label string, contents = nil, attrs = {}
+      attrs, contents = contents, nil if contents.is_a? Hash
+      Tagz.tag :label, contents.to_s + string + (contents ? '' :
+            attrs.delete(:required) ? '<em>*</em>:' :
+              ':'), attrs
+    end
+  end
+end

data/lib/formz/models.rb

@@ -0,0 +1,94 @@
+
+module Formz
+  
+  ##
+  # = Formz::Models
+  #
+  
+  module Models
+    
+    ##
+    # Form context model stack.
+    
+    def form_context
+      $__form_context ||= []
+    end
+    
+    ##
+    # Push _model_ as the current context while executing
+    # _block_; returning _block_'s results.
+    
+    def with_form_context model, &block
+      form_context.push model
+      result = yield
+      form_context.pop
+      result
+    end
+    
+    ##
+    # Return a form in context to _model_. _model_ may be
+    # an object, class, or symbol.
+    
+    def form_for model, attrs = {}, &block
+      model = Object.const_get model.to_s.capitalize if model.is_a? Symbol
+      model = model.new if model.is_a? Class
+      with_form_context model do
+        form model_name(model), attrs, &block  
+      end
+    end
+    
+    def select name, options, attrs = {}
+      if model = form_context.last
+        if model_has_property? model, name
+          if value = model.send(name)
+            attrs[:selected] ||= value
+          end
+        end
+      end
+      super
+    end
+    
+    def create_tag name, contents, attrs, &block
+      unless name == :form || form_context.blank?
+        model, tag_name = form_context.last, attrs[:name]
+        if attrs[:value].nil?
+          if attrs[:name] && model_has_property?(model, attrs[:name])
+            # Errors
+            if errors = model.errors.on(attrs[:name])
+              attrs[:error] = errors.first
+            end
+            # Values
+            attrs[:name] = '%s[%s]' % [model_name(model), tag_name]
+            value = model.send tag_name
+            case name
+            when :textarea ; contents = value
+            else             attrs[:value] = value
+            end
+          end
+        end
+        if default = attrs.delete(:default)
+          attrs[:value] = default if attrs[:value].nil?
+        end
+      end
+      super
+    end
+    
+    ##
+    # Check if _model_ has _property_name_.
+    
+    def model_has_property? model, property_name
+      model.send(:properties).any? do |property|
+        property.name == property_name.to_sym
+      end
+    end
+    
+    ##
+    # Return lowercase name of _model_. Forum::Post
+    # will become :post, etc.
+    
+    def model_name model
+      model.class.to_s.split('::').last.downcase.to_sym
+    end
+        
+  end
+end

data/lib/formz/version.rb

@@ -0,0 +1,4 @@
+
+module Formz
+  VERSION = '0.0.4'
+end

data/lib/formz/wrappers.rb

@@ -0,0 +1,34 @@
+
+module Formz
+  
+  ##
+  # = Formz::Wrappers
+  #
+  # The Formz:Wrappers module wraps input, textarea
+  # and select tags with wrapping div elements to aid
+  # in styling.
+  #
+  # === Examples
+  #
+  #   tag :input, :type => :file, :name => :upload
+  #
+  #   <div class="field-upload field-file">
+  #     <input type="file" name="upload" />
+  #   </div>
+  #
+  
+  module Wrappers
+    WRAP_TAGS = :input, :textarea, :select
+
+    def create_tag name, contents, attrs, &block
+      if name.in? WRAP_TAGS
+        classes = "field-#{attrs[:name].to_s.gsub('[', '-').gsub(']', '')}"
+        classes.add_class "field-#{attrs[:type]}" if :type.in? attrs
+        classes.add_class 'field'
+        Tagz.tag :div, super, :class => classes
+      else 
+        super
+      end
+    end    
+  end
+end

data/spec/autoencoding_spec.rb

@@ -0,0 +1,14 @@
+
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe Formz do
+  describe "autoencoding" do
+    it "should set the forms enctype properly when a file field is present" do
+      markup = form :image_upload do
+        file :image
+        submit :op, 'Upload'
+      end
+      markup.should have_tag('form[@enctype="form/multi-part"]')
+    end
+  end
+end

data/spec/descriptions_spec.rb

@@ -0,0 +1,11 @@
+
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe Formz do
+  describe "descriptions" do
+    it "should add descriptions to a field" do
+      text(:name, :description => 'Enter your firstname.').
+      should have_tag('span.description', 'Enter your firstname.')
+    end
+  end
+end

data/spec/errors_spec.rb

@@ -0,0 +1,21 @@
+
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe Formz do
+  describe "errors" do
+    before :each do
+      @markup = form :login do
+        text :username, :label => 'Username'
+        password :password, :label => 'Password', :error => 'Invalid Password'
+      end
+    end
+    
+    it "should add error classes" do
+      @markup.should have_tag('input[@type=password].error')
+    end
+    
+    it "should add error messages after failing fields" do
+      @markup.should have_tag('span.error-message', 'Invalid Password')
+    end
+  end
+end

data/spec/factories/user.rb

@@ -0,0 +1,25 @@
+
+class User
+  include DataMapper::Resource
+  property :uid,   Serial    
+  property :name,  String,   :length => 5..20
+  property :email, String,   :format => :email_address
+  property :role,  String
+  property :signature, Text, :default => 'Enter your forum signature'
+end
+
+Factory.define :user do |user|
+  user.uid 1
+  user.name 'tjholowaychuk'
+  user.email 'tj@vision-media.ca'
+  user.role 'admin'
+  user.signature 'Foo bar'
+end
+
+Factory.define :invalid_user, :class => :user do |user|
+  user.uid 2
+  user.name 'tjholowaychuk'
+  user.email 'foobar'
+  user.role 'admin'
+  user.signature 'Foo bar'
+end

data/spec/fauxmethod_spec.rb

@@ -0,0 +1,24 @@
+
+require File.dirname(__FILE__) + '/spec_helper'
+
+describe Formz do
+  describe "faux method" do
+    it "should add a hidden _method field when verb is not POST or GET" do
+      form(:save, :method => :put).should have_tag('form[@method=post]') do |form|
+        form.should have_tag('input[@type=hidden]') do |hidden|
+          hidden['name'].should == '_method'
+          hidden['value'].should == 'put'
+        end
+      end
+    end
+    
+    it "should not duplicate fields" do
+      form(:save, :method => :put).should have_tag('input[@name=_method]', :times => 1)
+    end
+        
+    it "should not add a hidden field when GET or POST" do
+      form(:search, :method => :post).should_not have_tag('input[@type=hidden]')
+      form(:search, :method => :get).should_not have_tag('input[@type=hidden]')
+    end
+  end
+end