formz 0.0.4

data/History.rdoc

@@ -0,0 +1,16 @@
+
+=== 0.0.4 / 2009-10-05
+
+* Added .field class to form wrappers
+
+=== 0.0.3 / 2009-10-05
+
+* Errors on models should display regardless of it being a new record
+
+=== 0.0.2 / 2009-10-05
+
+* Fixed errors module
+
+=== 0.0.1 / YYYY-MM-DD
+
+* Initial release

data/Manifest

@@ -0,0 +1,33 @@
+History.rdoc
+Manifest
+README.rdoc
+Rakefile
+benchmarks/small.rb
+examples/model.rb
+examples/small.rb
+formz.gemspec
+lib/formz.rb
+lib/formz/autoencoding.rb
+lib/formz/descriptions.rb
+lib/formz/errors.rb
+lib/formz/fauxmethod.rb
+lib/formz/helpers.rb
+lib/formz/import.rb
+lib/formz/labels.rb
+lib/formz/models.rb
+lib/formz/version.rb
+lib/formz/wrappers.rb
+spec/autoencoding_spec.rb
+spec/descriptions_spec.rb
+spec/errors_spec.rb
+spec/factories/user.rb
+spec/fauxmethod_spec.rb
+spec/helpers_spec.rb
+spec/labels_spec.rb
+spec/models_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+spec/wrappers_spec.rb
+tasks/docs.rake
+tasks/gemspec.rake
+tasks/spec.rake

data/README.rdoc

@@ -0,0 +1,54 @@
+
+= Formz
+
+Framework independant form helpers.
+
+== Features
+
+* Fast 
+* Framework independant
+* Highly extendable
+* Input labels
+* Input descriptions
+* Fakes out HTTP method to GET / POST
+* Sets enctype when using file inputs
+* ORM Model support
+* Error display
+
+== Cherry Pick
+
+Use only what you want:
+
+  include Formz::Labels
+  include Formz::Description
+  include Formz::Helpers
+  ...
+  
+Or simply:
+
+  require 'formz/import'
+
+== License
+
+(The MIT License)
+
+Copyright (c) 2009 TJ Holowaychuk <tj@vision-media.ca>
+
+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, an d/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/Rakefile

@@ -0,0 +1,18 @@
+
+$:.unshift 'lib'
+require 'formz'
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new "formz", Formz::VERSION do |p|
+  p.author = "TJ Holowaychuk"
+  p.email = "tj@vision-media.ca"
+  p.summary = "Framework independant tag helpers"
+  p.url = "http://github.com/visionmedia/formz"
+  p.runtime_dependencies << 'visionmedia-tagz >=1.1.1'
+  p.development_dependencies << 'rspec_hpricot_matchers >=1.0.0'
+  p.development_dependencies << 'thoughtbot-factory_girl'
+end
+
+Dir['tasks/**/*.rake'].sort.each { |f| load f }

data/benchmarks/small.rb

@@ -0,0 +1,48 @@
+
+$:.unshift File.dirname(__FILE__) + '/../lib'
+require 'rubygems'
+require 'rgauge'
+require 'formz/import'
+
+benchmark '', :times => 200 do
+  report 'tag' do 
+    tag :div, 'contents'
+  end
+  report 'tag with everything' do 
+    tag :textarea, 'contents', :label => 'Comments', :required => true, :description => 'Leave a comment.'
+  end
+  report 'input' do 
+    checkbox :delete
+  end
+  report 'input with everything' do 
+    checkbox :delete, :label => 'Delete', :required => true, :description => 'Delete the data.'
+  end
+  report 'select' do 
+    select :days, { :mon => 'Monday', :fri => 'Friday' }, :id => 'days'
+  end
+  report 'select with everything' do 
+    select :days, { :mon => 'Monday', :fri => 'Friday' }, :id => 'days', 
+      :label => 'Days', :required => true, :description => 'Select a day.'
+  end
+  report 'full form' do 
+    form :register, :action => '/register' do
+      fieldset :login, 'Login Information' do
+        text :username, :label => 'Username'
+        password :password, :label => 'Password'
+        password :password_confirm, :required => true, :description => 'Enter password between 6 - 30 characters.'
+      end
+      fieldset :account, 'Account Details' do
+        text :country, :label => 'Country'
+        text :city, :label => 'City'
+        fieldset :forum, 'Forum Related' do
+          file :image, :label => 'Avatar'
+          textarea :signature, :label => 'Signature'
+        end
+      end
+      buttons do
+        submit :op, 'Join'
+        submit :cancel, 'Cancel'
+      end
+    end
+  end
+end

data/examples/model.rb

@@ -0,0 +1,44 @@
+
+$:.unshift File.dirname(__FILE__) + '/../lib'
+require 'rubygems'
+require 'dm-core'
+require 'factory_girl'
+require 'formz/import'
+require 'tagz/import'
+
+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
+
+puts "\nAnonymous"
+markup = form_for :user do
+  hidden :uid
+  text :name, :label => 'Username', :required => true
+  text :email, :default => 'example@site.com'
+  textarea :signature
+  select :role, :admin => 'Admin', :manager => 'Manager'
+end
+puts markup
+
+puts "\nPopulated Model"
+markup = form_for Factory.build(:user), :method => :put do
+  hidden :uid
+  text :name, :label => 'Username', :required => true
+  text :email, :default => 'example@site.com'
+  textarea :signature
+  select :role, :admin => 'Admin', :manager => 'Manager'
+end
+puts markup

data/examples/small.rb

@@ -0,0 +1,19 @@
+
+$:.unshift File.dirname(__FILE__) + '/../lib'
+require 'rubygems'
+require 'formz'
+require 'tagz/import'
+include Formz::Helpers
+
+markup = form :login do
+  fieldset :details, 'Details' do
+    text :username
+    password :password
+  end
+  fieldset :details, 'Details' do
+    text :username
+    password :password
+  end
+end
+puts markup
+

data/formz.gemspec

@@ -0,0 +1,39 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{formz}
+  s.version = "0.0.4"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["TJ Holowaychuk"]
+  s.date = %q{2009-10-05}
+  s.description = %q{Framework independant tag helpers}
+  s.email = %q{tj@vision-media.ca}
+  s.extra_rdoc_files = ["README.rdoc", "lib/formz.rb", "lib/formz/autoencoding.rb", "lib/formz/descriptions.rb", "lib/formz/errors.rb", "lib/formz/fauxmethod.rb", "lib/formz/helpers.rb", "lib/formz/import.rb", "lib/formz/labels.rb", "lib/formz/models.rb", "lib/formz/version.rb", "lib/formz/wrappers.rb", "tasks/docs.rake", "tasks/gemspec.rake", "tasks/spec.rake"]
+  s.files = ["History.rdoc", "Manifest", "README.rdoc", "Rakefile", "benchmarks/small.rb", "examples/model.rb", "examples/small.rb", "formz.gemspec", "lib/formz.rb", "lib/formz/autoencoding.rb", "lib/formz/descriptions.rb", "lib/formz/errors.rb", "lib/formz/fauxmethod.rb", "lib/formz/helpers.rb", "lib/formz/import.rb", "lib/formz/labels.rb", "lib/formz/models.rb", "lib/formz/version.rb", "lib/formz/wrappers.rb", "spec/autoencoding_spec.rb", "spec/descriptions_spec.rb", "spec/errors_spec.rb", "spec/factories/user.rb", "spec/fauxmethod_spec.rb", "spec/helpers_spec.rb", "spec/labels_spec.rb", "spec/models_spec.rb", "spec/spec.opts", "spec/spec_helper.rb", "spec/wrappers_spec.rb", "tasks/docs.rake", "tasks/gemspec.rake", "tasks/spec.rake"]
+  s.homepage = %q{http://github.com/visionmedia/formz}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Formz", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{formz}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Framework independant tag helpers}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<visionmedia-tagz>, [">= 1.1.1"])
+      s.add_development_dependency(%q<rspec_hpricot_matchers>, [">= 1.0.0"])
+      s.add_development_dependency(%q<thoughtbot-factory_girl>, [">= 0"])
+    else
+      s.add_dependency(%q<visionmedia-tagz>, [">= 1.1.1"])
+      s.add_dependency(%q<rspec_hpricot_matchers>, [">= 1.0.0"])
+      s.add_dependency(%q<thoughtbot-factory_girl>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<visionmedia-tagz>, [">= 1.1.1"])
+    s.add_dependency(%q<rspec_hpricot_matchers>, [">= 1.0.0"])
+    s.add_dependency(%q<thoughtbot-factory_girl>, [">= 0"])
+  end
+end

data/lib/formz.rb

@@ -0,0 +1,39 @@
+#--
+# Copyright (c) 2009 TJ Holowaychuk <tj@vision-media.ca>
+#
+# 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.
+#++
+
+$:.unshift '/Users/tjholowaychuk/scripts/gems/tagz/lib' 
+require 'tagz'
+require 'formz/version'
+
+module Formz
+  autoload :Labels, 'formz/labels'
+  autoload :Errors, 'formz/errors'
+  autoload :Models, 'formz/models'
+  autoload :Helpers, 'formz/helpers'
+  autoload :Wrappers, 'formz/wrappers'
+  autoload :FauxMethod, 'formz/fauxmethod'
+  autoload :Descriptions, 'formz/descriptions'
+  autoload :AutoEncoding, 'formz/autoencoding'
+end
+
+Tagz::Tag.send :include, Formz::Helpers::Delegates

data/lib/formz/autoencoding.rb

@@ -0,0 +1,16 @@
+
+module Formz
+  
+  ##
+  # = Formz::AutoEncoding
+  #
+  # Automatically sets form enctype to 'multipart/form-data' 
+  # when a file field is present.
+  
+  module AutoEncoding
+    def create_tag name, contents, attrs, &block
+      @__form_encoding = 'multipart/form-data' if name == :file
+      super
+    end
+  end
+end

data/lib/formz/descriptions.rb

@@ -0,0 +1,30 @@
+
+module Formz
+  
+  ##
+  # = Formz::Descriptions
+  #
+  # The Formz:Descriptions module allows a :description attribute
+  # to be passed, which then appends a tag containing the field
+  # description.
+  #
+  # === Examples
+  #
+  #   tag :input, :type => :file, :name => :upload, :description => 'Upload a file.'
+  #
+  #   <div class="form-upload form-file">
+  #     <input type="file" name="upload" />
+  #     <span class="description">Upload a file.</span>
+  #   </div>
+  #
+  
+  module Descriptions
+    def create_tag name, contents, attrs, &block
+      if description = attrs.delete(:description)
+        super << Tagz.tag(:span, description, :class => 'description')
+      else
+        super
+      end
+    end
+  end
+end

data/lib/formz/errors.rb

@@ -0,0 +1,40 @@
+
+module Formz
+  
+  ##
+  # = Formz::Errors
+  #
+  # Adds classes and error messages when :error is
+  # present for any field.
+  #
+  # === Examples
+  #
+  #   password :password, :label => 'Password', :error => 'Invalid Password'
+  #
+  #   <div class="field-password">
+  #     <label for="password">Password:</label>
+  #     <input name="password" class="error" type="password" value="" />
+  #     <span class="error-message">Invalid Password</span>
+  #   </div>
+  #
+  
+  module Errors
+    
+    ##
+    # Array of form specific errors.
+    
+    def form_errors
+      @__form_errors ||= []
+    end
+    
+    def create_tag name, contents, attrs, &block
+      if error = attrs.delete(:error)
+        form_errors << error
+        (attrs[:class] ||= '').add_class 'error'
+        super << Tagz.tag(:span, error, :class => 'error-message')
+      else
+        super
+      end
+    end
+  end
+end

data/lib/formz/fauxmethod.rb

@@ -0,0 +1,32 @@
+
+module Formz
+  
+  ##
+  # = Formz::FauxMethod
+  #
+  # Fake out methods using the hidden field '_method'
+  # when the HTTP method is not GET or POST. Defaults the 
+  # method to POST.
+  
+  module FauxMethod
+    
+    def create_tag name, contents, attrs, &block
+      if name == :form
+        attrs[:method] ||= :post
+        unless valid_http_method? attrs[:method]
+          method = Tagz.tag :input, :type => :hidden, :name => :_method, :value => attrs[:method]
+          attrs[:method] = :post
+          contents << method
+        end
+      end
+      super
+    end
+    
+    ##
+    # Check if _method_ is a valid form HTTP verb. (get, post).
+    
+    def valid_http_method? method
+      method.to_s.in? 'post', 'get'
+    end
+  end
+end