visionmedia-dm-forms 0.0.2 → 0.0.3

data/History.rdoc

@@ -1,4 +1,8 @@
 
+=== 0.0.3 / 2009-03-23
+
+* Refactored everything :)
+
 === 0.0.1 / 2009-01-13
 
 * Initial release

data/Manifest

@@ -1,27 +1,30 @@
-History.rdoc
-Manifest
-README.rdoc
-Rakefile
-Todo.rdoc
+dm-forms.gemspec
 examples/benchmarks.rb
-examples/datamapper.rb
-examples/elements.rb
-examples/haml.rb
-examples/login.haml
-lib/dm-forms.rb
+examples/login.rb
+History.rdoc
+lib/dm-forms/base.rb
 lib/dm-forms/core_ext.rb
-lib/dm-forms/elements.rb
-lib/dm-forms/model_elements.rb
+lib/dm-forms/helpers.rb
+lib/dm-forms/mixins/descriptions.rb
+lib/dm-forms/mixins/errors.rb
+lib/dm-forms/mixins/labels.rb
+lib/dm-forms/mixins/wrappers.rb
+lib/dm-forms/mixins.rb
 lib/dm-forms/tag.rb
 lib/dm-forms/version.rb
-spec/functional/core_ext_spec.rb
-spec/functional/elements_spec.rb
+lib/dm-forms.rb
+Manifest
+Rakefile
+README.rdoc
+spec/functional/helpers_spec.rb
+spec/functional/mixins/descriptions_spec.rb
+spec/functional/mixins/labels_spec.rb
+spec/functional/mixins/wrappers_spec.rb
 spec/functional/tag_spec.rb
 spec/integration/datamapper_spec.rb
-spec/integration/haml_spec.rb
 spec/spec_helper.rb
 tasks/benchmarks.rake
 tasks/docs.rake
 tasks/gemspec.rake
 tasks/spec.rake
-
+Todo.rdoc

data/README.rdoc

@@ -3,44 +3,15 @@
 
 DataMapper model form generation.
 
-== Features:
-
-* Integrates with DataMapper
-* Fast; over 1000 elements in 0.1 seconds (rake benchmark)
-* Error reporting
-* Handles restful HTTP verbs
-* Provides low-level form elements uncoupled from DataMapper
-
-== Examples:
-
-Pretend in a magical world we have a User model, and only the email is valid while we are updating.
-Based on the situation above, the form would render similar to the markup beneath the
-example.
-
-   errors_for @user
-   form_for @user, :action => '/user' do |f|
-     f.textfield :name, :label => 'Name'
-     f.textfield :email, :label => 'Email'
-     f.submit :op, :value => 'Update'
-   end
-
-   <ul class="messages error">
-     <li>Name has an invalid format</li>
-   </ul>
-   <form action="/user" method="post" id="form-user">
-     <input type="hidden" name="_method" value="put" />
-     <label for="name">Name:</label>
-     <input type="textfield" class="error form-textfield form-name" name="name" />
-     <label for="email">Email:</label>
-     <input type="textfield" class="form-textfield form-email" name="email" />
-     <input type="submit" class="form-submit form-op" value="Update" name="op" />
-   </form>
+== Features
+
+* Coming soon
 
 == License:
 
 (The MIT License)
 
-Copyright (c) 2008 TJ Holowaychuk
+Copyright (c) 2008-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

data/Rakefile

@@ -2,15 +2,17 @@
 require 'rubygems'
 require 'rake'
 require 'echoe'
-require './lib/dm-forms.rb'
+$:.unshift 'lib'
+require 'dm-forms'
 
-Echoe.new("dm-forms", DataMapper::Form::VERSION::STRING) do |p|
+Echoe.new "dm-forms", DataMapper::Form::VERSION do |p|
   p.author = "TJ Holowaychuk"
   p.email = "tj@vision-media.ca"
   p.summary = "DataMapper model form generation"
   p.url = "http://github.com/visionmedia/dm-forms"
-  p.runtime_dependencies = ['dm-core']
-  p.development_dependencies = ['rspec_hpricot_matchers']
+  p.runtime_dependencies << 'dm-core'
+  p.runtime_dependencies << 'visionmedia-rext'
+  p.development_dependencies << 'rspec_hpricot_matchers'
 end
 
 Dir['tasks/**/*.rake'].sort.each { |lib| load lib }

data/Todo.rdoc

@@ -1,24 +1,22 @@
 
 == Major:
 
-* match messages markup to jquery ui if reasonable
-* <optgroup label
-* assign :required based on model?
-* clean up examples
-* use have_tag matcher
-* add enctype automatically
-* Fix select option ordering ... poor unordered hashes :(
-* Add nesting to select options, and select groups
-* escape xml in attrs
-* Support both instance_eval and block
-* wrap all in div class="form-TYPE" and adjust spec...
-* XHTML ... validate 
-* perform some indenting (or all but make it optional)
-* increase performance
-* preview rdoc / finish documenting ...
+* major refactor with processing of elements since some allow contents param, and some do not etc
+* get rid of origin.buffer..what is merbs technique?
+* select optgroups
+* use stack (array) method for contexts ... cleaner than manual toggling
+* allow explicit context names, not just auto-generated from class names
+* view merb form helper specs to see what was missed
+* abstract ORM ? rename from dm-forms ... have ORM mixins
+* only one context so dont use all those methods? just capture with optional builder base?
+* self closing tags auto self-close to maximize mixin DRYness
+* Make sure othe frameworks can plug in their functionality
+* documentation per method generated
+* better naming conventions / refactor / release
 
 == Minor:
 
+* have these optional as mixins?
 * Aggregate / faux elements ...
   * date_field :bday, :format => 'YYYY-MM-DD', :value => '1987-05-25'
 

data/dm-forms.gemspec

@@ -2,15 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{dm-forms}
-  s.version = "0.0.2"
+  s.version = "0.0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["TJ Holowaychuk"]
-  s.date = %q{2009-01-15}
+  s.date = %q{2009-03-23}
   s.description = %q{DataMapper model form generation}
   s.email = %q{tj@vision-media.ca}
-  s.extra_rdoc_files = ["README.rdoc", "lib/dm-forms.rb", "lib/dm-forms/core_ext.rb", "lib/dm-forms/elements.rb", "lib/dm-forms/model_elements.rb", "lib/dm-forms/tag.rb", "lib/dm-forms/version.rb", "tasks/benchmarks.rake", "tasks/docs.rake", "tasks/gemspec.rake", "tasks/spec.rake"]
-  s.files = ["History.rdoc", "Manifest", "README.rdoc", "Rakefile", "Todo.rdoc", "examples/benchmarks.rb", "examples/datamapper.rb", "examples/elements.rb", "examples/haml.rb", "examples/login.haml", "lib/dm-forms.rb", "lib/dm-forms/core_ext.rb", "lib/dm-forms/elements.rb", "lib/dm-forms/model_elements.rb", "lib/dm-forms/tag.rb", "lib/dm-forms/version.rb", "spec/functional/core_ext_spec.rb", "spec/functional/elements_spec.rb", "spec/functional/tag_spec.rb", "spec/integration/datamapper_spec.rb", "spec/integration/haml_spec.rb", "spec/spec_helper.rb", "tasks/benchmarks.rake", "tasks/docs.rake", "tasks/gemspec.rake", "tasks/spec.rake", "dm-forms.gemspec"]
+  s.extra_rdoc_files = ["lib/dm-forms/base.rb", "lib/dm-forms/core_ext.rb", "lib/dm-forms/helpers.rb", "lib/dm-forms/mixins/descriptions.rb", "lib/dm-forms/mixins/errors.rb", "lib/dm-forms/mixins/labels.rb", "lib/dm-forms/mixins/wrappers.rb", "lib/dm-forms/mixins.rb", "lib/dm-forms/tag.rb", "lib/dm-forms/version.rb", "lib/dm-forms.rb", "README.rdoc", "tasks/benchmarks.rake", "tasks/docs.rake", "tasks/gemspec.rake", "tasks/spec.rake"]
+  s.files = ["dm-forms.gemspec", "examples/benchmarks.rb", "examples/login.rb", "History.rdoc", "lib/dm-forms/base.rb", "lib/dm-forms/core_ext.rb", "lib/dm-forms/helpers.rb", "lib/dm-forms/mixins/descriptions.rb", "lib/dm-forms/mixins/errors.rb", "lib/dm-forms/mixins/labels.rb", "lib/dm-forms/mixins/wrappers.rb", "lib/dm-forms/mixins.rb", "lib/dm-forms/tag.rb", "lib/dm-forms/version.rb", "lib/dm-forms.rb", "Manifest", "Rakefile", "README.rdoc", "spec/functional/helpers_spec.rb", "spec/functional/mixins/descriptions_spec.rb", "spec/functional/mixins/labels_spec.rb", "spec/functional/mixins/wrappers_spec.rb", "spec/functional/tag_spec.rb", "spec/integration/datamapper_spec.rb", "spec/spec_helper.rb", "tasks/benchmarks.rake", "tasks/docs.rake", "tasks/gemspec.rake", "tasks/spec.rake", "Todo.rdoc"]
   s.has_rdoc = true
   s.homepage = %q{http://github.com/visionmedia/dm-forms}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Dm-forms", "--main", "README.rdoc"]
@@ -25,13 +25,16 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<dm-core>, [">= 0"])
+      s.add_runtime_dependency(%q<visionmedia-rext>, [">= 0"])
       s.add_development_dependency(%q<rspec_hpricot_matchers>, [">= 0"])
     else
       s.add_dependency(%q<dm-core>, [">= 0"])
+      s.add_dependency(%q<visionmedia-rext>, [">= 0"])
       s.add_dependency(%q<rspec_hpricot_matchers>, [">= 0"])
     end
   else
     s.add_dependency(%q<dm-core>, [">= 0"])
+    s.add_dependency(%q<visionmedia-rext>, [">= 0"])
     s.add_dependency(%q<rspec_hpricot_matchers>, [">= 0"])
   end
 end

data/examples/benchmarks.rb

@@ -1,118 +1,34 @@
 
-$:.unshift File.expand_path(File.dirname(__FILE__) + '/../lib')
-require 'dm-forms'
-require 'benchmark'
-require 'dm-core'
-require 'dm-validations'
-DataMapper.setup :default, 'sqlite3::memory:'
-include DataMapper::Form::ModelElements
+require File.dirname(__FILE__) + '/../lib/dm-forms'
 
-#--
-# Models
-#++
+require 'rubygems'
+require 'rgauge'
 
-class User
-  include DataMapper::Resource
-  property :id,    Serial
-  property :name,  String, :format => /^[\w]+$/
-  property :email, String, :format => :email_address
-end
-
-DataMapper.auto_migrate!
-
-$user = User.new :name => 'tj', :email => 'invalid email@lame.com'
-
-#--
-# Benchmarks
-#++
-
-puts
-puts 'Single element'
-Benchmark.bm(25) do |x|
-  x.report("10 elements") {
-    10.times do
-      textarea :comments, :value => 'Enter your comments here', :label => 'Comments:', :required => true
-    end
-  }
-  x.report("100 elements") {
-    100.times do
-      textarea :comments, :value => 'Enter your comments here', :label => 'Comments:', :required => true
-    end
-  }
-  x.report("1000 elements") {
-    1000.times do
-      textarea :comments, :value => 'Enter your comments here', :label => 'Comments:', :required => true
-    end
-  }
-end
+include DataMapper::Form::Helpers
 
-puts
-puts 'Capture elements within a fieldset'
-Benchmark.bm(25) do |x|
-  x.report("10 elements") {
-    5.times do
-      fieldset :comments do |f|
-        f.textarea :comments, :value => 'Enter your comments here', :label => 'Comments:', :required => true
-      end
-    end
-  }
-  x.report("100 elements") {
-    50.times do
-      fieldset :comments do |f|
-        f.textarea :comments, :value => 'Enter your comments here', :label => 'Comments:', :required => true
-      end
-    end
-  }
-  x.report("1000 elements") {
-    500.times do
-      fieldset :comments do |f|
-        f.textarea :comments, :value => 'Enter your comments here', :label => 'Comments:', :required => true
-      end
-    end
-  }
+def params
+  Hash.new { |h, k| k }
 end
+public :params
 
-# Not real-world examples ... just for benchmarking purposes
-puts
-puts 'Entire forms'
-Benchmark.bm(25) do |x|
-  x.report("Login") {
-    form :login do |f|
-      f.textfield :name, :label => 'Username', :required => true
-      f.textfield :email, :label => 'Email', :required => true
-      f.textfield :pass, :label => 'Password', :required => true
-      f.submit :op, :value => 'Login'
+benchmark 'Entire forms', :times => 400 do
+  report 'Login' do 
+    form :action => '/login' do
+      textfield :name, :id => 'username'
+      textfield :pass, :id => 'password'
+      submit :value => 'Login'
     end
-  }
+  end
   
-  x.report("Register") {
-    form :register do |f|
-      f.fieldset :general do |f|
-        f.textfield :name, :label => 'Username', :required => true
-        f.textfield :email, :label => 'Email', :required => true
-        f.textfield :pass, :label => 'Password', :required => true
-        f.password :pass_confirm
-      end
-      f.fieldset :details do |f|
-        f.textfield :city, :label => 'City'
-        f.textfield :zip, :label => 'Postal Code'
-      end
-      f.fieldset :forums do |f|
-        f.textarea :signature, :label => 'Signature', :description => 'Enter a signature which will appear below your forum posts.'
-      end
-      f.submit :op, :value => 'Register'
-    end
-  }
-end
-
-puts
-puts 'Entires form with #form_for'
-Benchmark.bm(25) do |x|
-  x.report("User") {
-    form_for $user do |f|
-      f.textfield :name, :label => 'Username', :required => true
-      f.textfield :email, :label => 'Email', :required => true
-      f.submit :op, :value => 'Login'
-    end
-  }
-end
+  DataMapper::Form::Base.send :include, DataMapper::Form::Labels
+  DataMapper::Form::Base.send :include, DataMapper::Form::Descriptions
+  DataMapper::Form::Base.send :include, DataMapper::Form::Wrappers
+  
+  report 'Login with mixins' do 
+    form :action => '/login' do
+      textfield :name, :id => 'username', :label => 'Username'
+      textfield :pass, :id => 'password', :label => 'Password', :description => 'Enter a valid password.'
+      submit :value => 'Login'
+    end    
+  end
+end

data/examples/login.rb

@@ -0,0 +1,20 @@
+
+require File.dirname(__FILE__) + '/../lib/dm-forms'
+
+include DataMapper::Form::Helpers
+DataMapper::Form::Base.send :include, DataMapper::Form::Labels
+DataMapper::Form::Base.send :include, DataMapper::Form::Descriptions
+DataMapper::Form::Base.send :include, DataMapper::Form::Wrappers
+
+def params
+  Hash.new { |h, k| k }
+end
+public :params
+
+markup = form :action => '/login' do
+  textfield :name, :label => 'Username', :description => 'Enter your username.'
+  textfield :pass, :label => 'Password', :description => 'Enter your password.'
+  submit 'Login'
+end
+
+puts markup

data/lib/dm-forms.rb

@@ -1,5 +1,5 @@
 #--
-# Copyright (c) 2008 TJ Holowaychuk
+# Copyright (c) 2008-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
@@ -21,12 +21,11 @@
 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 #++
 
-$:.unshift File.dirname(__FILE__)
-
-require 'rubygems'
 require 'extlib'
+require 'rext/all'
 require 'dm-forms/version'
 require 'dm-forms/core_ext'
 require 'dm-forms/tag'
-require 'dm-forms/elements'
-require 'dm-forms/model_elements'
+require 'dm-forms/helpers'
+require 'dm-forms/mixins'
+require 'dm-forms/base'

data/lib/dm-forms/base.rb

@@ -0,0 +1,115 @@
+
+module DataMapper
+  module Form
+    class Base
+      
+      include Tag
+
+      REGULAR_ELEMENTS = :textarea, :select
+      SELF_CLOSING_ELEMENTS = :textfield, :submit, :file, :button, :hidden, :password, :radio, :checkbox
+      DEFAULT_VALUE_ELEMENTS = :textarea, :select, :textfield, :radio, :checkbox
+      
+      attr_reader :model, :origin, :name
+      
+      def initialize model = nil, origin = nil
+        @model, @origin = model, origin
+        @name = model.class.name.downcase.split('::').last
+      end
+      
+      def form attrs = {}, &block
+        origin.clear_buffer
+        captured = origin.capture &block
+        faux_method = process_form_attrs attrs 
+        tag :form, faux_method + captured, attrs 
+      end
+      
+      def fieldset attrs = {}, &block
+        legend_tag = (legend = attrs.delete(:legend)) ? tag(:legend, legend) : ''
+        origin.buffer << tag(:fieldset, legend_tag + origin.capture(&block), attrs)
+      end
+      
+      def select_options options, selected = nil, prompt = nil
+        options[''] = prompt unless prompt.nil?
+        selected ||= prompt || nil
+        options.map do |value, contents|
+          tag :option, contents, :value => value, :selected => (value == selected or contents == selected)
+        end.join("\n")
+      end
+      
+      def unbound_textarea *args
+        contents, attrs = split_args *args
+        process_unbound_element :textarea, attrs
+        origin.buffer << tag(:textarea, element_value(attrs) || contents, attrs)
+      end
+      
+      def unbound_select attrs = {}
+        options = select_options *attrs.extract!(:options, :selected, :prompt)
+        process_unbound_element :select, attrs
+        origin.buffer << tag(:select, options, attrs)
+      end
+      
+      SELF_CLOSING_ELEMENTS.each do |type|
+        define_method :"unbound_#{type}" do |attrs|
+          process_unbound_element type, attrs
+          origin.buffer << self_closing_tag(:input, attrs)
+        end
+      end
+      
+      (SELF_CLOSING_ELEMENTS | REGULAR_ELEMENTS).each do |type|
+        define_method :"bound_#{type}" do |*args|
+          method, attrs = args.shift, args.shift || {}
+          process_bound_element type, method, attrs
+          send :"unbound_#{type}", attrs
+        end
+      end
+      
+      private
+      
+      def split_args *args
+        return nil, args.shift if args.first.is_a? Hash
+        return *args
+      end
+      
+      def process_bound_element type, method, attrs
+        attrs[:name] = element_name method
+      end
+      
+      def process_unbound_element type, attrs
+        attrs ||= {}
+        attrs[:type] = type if type.in? SELF_CLOSING_ELEMENTS
+        attrs[:value] = element_value attrs if type.in?(DEFAULT_VALUE_ELEMENTS - REGULAR_ELEMENTS)
+        case type
+        when :file
+          @multipart = true
+        when :submit 
+          attrs[:name]  ||= 'submit'
+          attrs[:value] ||= 'Submit'
+        end
+        raise ArgumentError, 'form elements must have a name', caller unless attrs.include? :name
+      end
+      
+      def process_form_attrs attrs = {}
+        attrs[:method] ||= :post
+        method = attrs[:method] 
+        attrs[:method] = :post if attrs[:method] != :get
+        attrs[:enctype] = 'multipart/form-data' if @multipart || attrs.delete(:multipart)
+        method.in?(:post, :get) ? '' : faux_method(method)
+      end
+
+      def faux_method method
+        unbound_hidden :name => '_method', :value => method
+      end
+      
+      def element_name method 
+        model ? "#{name}[#{method}]" : method
+      end
+      
+      def element_value attrs = {}
+        # TODO: escape HTML
+        # TODO: dont use this name hack... better positioning to assign element_name to prevent this
+        model ? model.send(attrs[:name].gsub(/\w+\[|\]/, '')) : origin.params[attrs[:name]]
+      end
+      
+    end
+  end
+end