visionmedia-dm-forms 0.0.2

data/lib/dm-forms/tag.rb

@@ -0,0 +1,156 @@
+
+module DataMapper
+  module Form
+    class Tag
+      
+      ##
+      # Boolean attributes.
+      
+      BOOLEAN_ATTRIBUTES = :disabled, :readonly, :multiple, :checked, :selected
+      
+      ##
+      # Elements which should not include auto-generated classes.
+      
+      IGNORE_CLASSES_ON_ELEMENTS = :form, :label, :fieldset, :hidden
+      
+      ##
+      # Name of element (input, fieldset, etc).
+      
+      attr_accessor :name
+      
+      ##
+      # Options passed to the constructor.
+      
+      attr_accessor :options
+      
+      ##
+      # Attributes pulled from #options.
+      
+      attr_accessor :attributes
+      
+      ##
+      # Markup placed before the element.
+      
+      attr_accessor :before
+      
+      ##
+      # Markup placed after the element.
+      
+      attr_accessor :after
+      
+      ##
+      # Tag's description.
+      
+      attr_accessor :description
+          
+      def initialize name, options = {}, &block
+        @name, @options, @attributes = name, options, (options[:attributes] ||= {})
+        @before, @after = attribute(:before, ''), attribute(:after, '')
+        @description = Elements.desc(attribute(:description)) || ''
+        @model = attribute :model
+        (@attributes[:value] ||= '') << Elements.capture_elements(@model, &block) if block_given?
+      end
+    
+      ##
+      # Render final markup of this element or 'tag'.
+    
+      def render
+        @attributes[:class] = classes unless classes.blank?
+        prepare_boolean_attributes
+        before << label
+        close = self_closing? ? " />" : ">#{inner_html}</#{@name}>"
+        open = "<#{@name} #{@attributes.to_html_attributes}"
+        tag = before << open << close << description << after << "\n"
+      end
+      alias :to_s :render
+      
+      ##
+      # Prepare boolean attribute values, so that the user may
+      # utilize :multiple => true, instead of :multiple => :multiple.
+      
+      def prepare_boolean_attributes
+        @attributes.each_pair do |key, value|
+          if BOOLEAN_ATTRIBUTES.include? key
+            if value
+              @attributes[key] = key
+            else
+              @attributes.delete key
+            end
+          end
+        end
+      end
+    
+      ##
+      # Wither or not a tag is self-closing (<br />).
+    
+      def self_closing?
+        @options[:self_closing]
+      end
+    
+      ##
+      # The inner HTML of this tag, only available for
+      # elements which are not self-closing.
+    
+      def inner_html
+        attribute :value, '' unless self_closing?
+      end
+          
+      ##
+      # Is the element required.
+    
+      def required?
+        attribute :required, false
+      end 
+      
+      ##
+      # Generates a label when needed.
+      
+      def label
+        @label ||= has_label? ? Elements.label(@attributes.delete(:label), :for => @attributes[:name], :required => required?) : ''
+      end
+      
+      ##
+      # Wither or not this tag has a label.
+      
+      def has_label?
+        !@attributes[:label].blank?
+      end
+
+      ##
+      # Returns user generated classes as well as those generated by
+      # dm-forms for styling consistancy.
+    
+      def classes
+        @classes ||= [@attributes[:class], generate_classes].join(' ').strip if should_add_classes?
+      end
+            
+      private
+      
+      ##
+      # Generates element class(es) such as form-submit.
+              
+      def generate_classes
+        classes = "form-#{@name == :input ? @attributes[:type] : @name}"
+        classes << " form-#{@attributes[:name]}" unless @attributes[:name].blank?
+        classes
+      end
+    
+      ##
+      # Wither or not classes should be added to this element.
+    
+      def should_add_classes?
+        !(IGNORE_CLASSES_ON_ELEMENTS.include? @name or IGNORE_CLASSES_ON_ELEMENTS.include? @attributes[:type])
+      end
+    
+      ##
+      # Return an +attribute+ or its +default+ value, removing
+      # it from @attributes so that final attributes rendered
+      # within the HTML are not cluttered with ad-hoc keys.
+    
+      def attribute attribute, default = nil
+        @attributes.delete(attribute) || default 
+      end
+    
+    end
+  end
+end

data/lib/dm-forms/version.rb

@@ -0,0 +1,9 @@
+
+module DataMapper
+  module Form
+    module VERSION #:nodoc:
+      MAJOR, MINOR, TINY = [0, 0, 2]
+      STRING = [MAJOR, MINOR, TINY].join '.'
+    end
+  end
+end

data/lib/dm-forms.rb

@@ -0,0 +1,32 @@
+#--
+# Copyright (c) 2008 TJ Holowaychuk
+#
+# 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 File.dirname(__FILE__)
+
+require 'rubygems'
+require 'extlib'
+require 'dm-forms/version'
+require 'dm-forms/core_ext'
+require 'dm-forms/tag'
+require 'dm-forms/elements'
+require 'dm-forms/model_elements'

data/spec/functional/core_ext_spec.rb

@@ -0,0 +1,56 @@
+
+
+describe "core ext" do
+  
+  #--
+  # Humanize
+  #++
+  
+  describe "String#humanize" do
+
+    it "should humanize strings" do
+      'im_a_Lame_String.Yeah.with.7.words'.humanize.should == 'im a Lame String Yeah with 7 words'
+    end
+
+    it "should humanize symbols" do
+      :some_Cool_symbol.humanize.should == 'some Cool symbol'
+      :login.humanize.should == 'login'
+    end
+
+    it "should not mess with already human readable strings" do
+      'i am already VERY readable'.humanize.should == 'i am already VERY readable'
+    end
+
+  end
+  
+  #--
+  # Indent
+  #++
+  
+  describe "String#indent" do
+    
+    it "should indent 2 spaces by default" do
+      'meow'.indent.should == '  meow'
+    end
+    
+    it "should indent variable tab lengths" do
+      'meow'.indent(2).should == '    meow'
+    end
+    
+    it "should indent multi-line strings" do
+      string = <<-EOF.deindent
+      foo
+      bar
+      EOF
+      string.indent.should == <<-EOF.deindent
+        foo
+        bar
+      EOF
+      string.indent(2).should == <<-EOF.deindent
+          foo
+          bar
+      EOF
+    end
+    
+  end
+end

data/spec/functional/elements_spec.rb

@@ -0,0 +1,209 @@
+
+include DataMapper::Form::Elements
+
+describe DataMapper::Form::Elements do
+  
+  #--
+  # Element aspecs
+  #++
+
+  describe "element aspecs" do
+            
+    it "should allow descriptions" do
+      s = textarea :comments, :description => 'Please enter your comments.'
+      s.should == <<-HTML.deindent(8)
+        <textarea class="form-textarea form-comments" name="comments"></textarea>
+        <p class="description">Please enter your comments.</p>
+      HTML
+    end
+
+    it "should allow prefixing of arbitrary markup" do
+      s = textarea :comments, :before => "<h1>Comments</h1>\n"
+      s.should == <<-HTML.deindent(8)
+        <h1>Comments</h1>
+        <textarea class="form-textarea form-comments" name="comments"></textarea>
+      HTML
+    end
+
+    it "should allow arbitrary markup after" do
+      s = textarea :comments, :after => "\n<p>Custom markup</p>"
+      s.should == <<-HTML.deindent(8)
+        <textarea class="form-textarea form-comments" name="comments"></textarea>
+        <p>Custom markup</p>
+      HTML
+    end
+    
+  end
+    
+  #--
+  # Elements
+  #++
+  
+  describe "elements" do
+    
+    it "should create labels" do
+      s = label 'Email', :for => :email
+      s.should == %(<label for="email">Email:</label>\n)
+    end
+
+    it "should create required labels" do
+      s = label 'Email', :for => :email, :required => true
+      s.should == %(<label for="email">Email:<em>*</em></label>\n)
+    end
+    
+    it "should create textfields" do
+      s = textfield :phone, :value => 'Enter phone number'
+      s.should == %(<input type="textfield" class="form-textfield form-phone" value="Enter phone number" name="phone" />\n)
+    end
+
+    it "should create submit buttons" do
+      s = submit :op, :value => 'Submit'
+      s.should == %(<input type="submit" class="form-submit form-op" value="Submit" name="op" />\n)
+    end
+
+    it "should create buttons" do
+      s = button :op, :value => 'Edit'
+      s.should == %(<input type="button" class="form-button form-op" value="Edit" name="op" />\n)    
+    end
+    
+    it "should create image buttons" do
+      s = button :op, :value => 'Edit', :src => 'path/to/image.png'
+      s.should == %(<input type="image" class="form-image form-op" value="Edit" name="op" src="path/to/image.png" />\n)    
+    end
+    
+    it "should create a checkbox" do
+      s = checkbox :agree_to_terms, :value => 'Agree to terms', :checked => true
+      s.should == %(<input type="checkbox" class="form-checkbox form-agree_to_terms" value="Agree to terms" name="agree_to_terms" checked="checked" />\n)    
+    end
+    
+    it "should create a file field" do
+      s = file :image
+      s.should == %(<input type="file" class="form-file form-image" name="image" />\n)    
+    end
+    
+    it "should create hidden fields" do
+      s = hidden :_method, :value => 'put'
+      s.should == %(<input type="hidden" value="put" name="_method" />\n)    
+    end
+    
+    it "should create a radio button" do
+      s = radio :sex, :value => 'Male'
+      s.should == %(<input type="radio" class="form-radio form-sex" value="Male" name="sex" />\n)
+    end
+    
+    it "should create textareas" do
+      s = textarea :comments, :value => 'Enter your comments here', :label => 'Comments'
+      s.should == <<-HTML.deindent(8)
+        <label for="comments">Comments:</label>
+        <textarea class="form-textarea form-comments" name="comments">Enter your comments here</textarea>
+      HTML
+    end
+    
+    it "should create fieldsets" do
+      s = fieldset :details, :legend => 'Details', :value => 'WAHOO!'
+      s.should == <<-HTML.deindent(8)
+        <fieldset class="fieldset-details">
+        <legend>Details</legend>WAHOO!</fieldset>
+      HTML
+    end
+
+    it "should create fieldsets with element capturing block" do
+      s = fieldset :details, :id => 'details' do |f|
+        f.button :one
+        f.button :two
+      end
+      s.should == <<-HTML.deindent(8)
+        <fieldset class="fieldset-details" id="details">
+        <legend>Details</legend><input type="button" class="form-button form-one" name="one" />
+        <input type="button" class="form-button form-two" name="two" />
+        </fieldset>
+      HTML
+    end
+
+    it "should create fieldsets without legends, auto-generating them from the fieldset name" do
+      s = fieldset :some_legend, :value => 'WAHOO!'
+      s.should == <<-HTML.deindent(8)
+        <fieldset class="fieldset-some_legend">
+        <legend>Some legend</legend>WAHOO!</fieldset>
+      HTML
+    end
+    
+    it "should create select fields" do
+      s = select :color, :options => { :red => 'Red', :green => 'Green', :blue => 'Blue' }
+      s.should == <<-HTML.deindent(8)
+        <select class="form-select form-color" name="color">
+        <option value="blue">Blue</option>
+        <option value="red">Red</option>
+        <option value="green">Green</option>
+        </select>
+      HTML
+    end
+    
+    it "should create select fields with block" do
+      s = select :color do |s|
+        s.option :red, 'Red'
+        s.option :green, 'Green'
+        s.option :blue, 'Blue'
+      end
+      s.should == <<-HTML.deindent(8)
+        <select class="form-select form-color" name="color">
+        <option value="red">Red</option>
+        <option value="green">Green</option>
+        <option value="blue">Blue</option>
+        </select>
+      HTML
+    end
+    
+  end
+  
+  #--
+  # Form specifics
+  #++
+  
+  describe "forms" do
+    
+    it "should default method to post" do
+      s = form :register
+      s.should == %(<form method="post" id="form-register"></form>\n)
+    end
+
+    it "should allow custom methods" do
+      s = form :register, :method => :get
+      s.should == %(<form method="get" id="form-register"></form>\n)
+    end
+
+    it "should allow arbitrary inner html" do
+      s = form :register, :method => :get, :value => 'COOKIE!'
+      s.should == %(<form method="get" id="form-register">COOKIE!</form>\n)
+    end
+    
+    it "should store arbitrary methods in _method" do
+      s = form :login, :method => :put do |f|
+        f.submit :op, :value => 'Submit'
+      end
+      s.should == <<-HTML.deindent(8)
+        <form method="post" id="form-login"><input type="hidden" value="put" name="_method" />
+        <input type="submit" class="form-submit form-op" value="Submit" name="op" />
+        </form>
+      HTML
+    end
+    
+    it "should create with a block for inner html" do
+      s = form :login do |f|
+        f.textfield :name, :label => 'Username'
+        f.textfield :pass, :label => 'Password'
+        f.submit :op, :value => 'Login'
+      end
+      s.should == <<-HTML.deindent(8)
+        <form method="post" id="form-login"><label for="name">Username:</label>
+        <input type="textfield" class="form-textfield form-name" name="name" />
+        <label for="pass">Password:</label>
+        <input type="textfield" class="form-textfield form-pass" name="pass" />
+        <input type="submit" class="form-submit form-op" value="Login" name="op" />
+        </form>
+      HTML
+    end
+    
+  end
+                  
+end

data/spec/functional/tag_spec.rb

@@ -0,0 +1,49 @@
+
+describe DataMapper::Form::Tag do
+  
+  Tag = DataMapper::Form::Tag
+
+  it "should generate classes" do
+    tag = Tag.new :input, :attributes => { :name => 'email', :type => :textfield }
+    tag.send(:classes).should == 'form-textfield form-email'    
+  end
+
+  it "should generate classes when no name is present" do
+    tag = Tag.new :input, :attributes => { :type => :textfield }
+    tag.send(:classes).should == 'form-textfield'    
+  end
+  
+  it "should auto-assign boolean attributes" do
+    tag = Tag.new :input, :attributes => { :name => 'email', :type => :textfield, :disabled => true }
+    tag.render.should == %(<input disabled="disabled" type="textfield" class="form-textfield form-email" name="email"></input>\n)
+  end
+    
+  it "should generate and merge classes" do
+    tag = Tag.new :input, :attributes => { :class => 'foo bar', :name => 'email', :type => :textfield }
+    tag.send(:classes).should == 'foo bar form-textfield form-email'
+  end
+  
+  it "should grab inner html for non self-closing tags" do
+    tag = Tag.new :textarea, :self_closing => false, :attributes => { :value => 'BOOYAH' }
+    tag.inner_html.should == 'BOOYAH'
+  end
+  
+  it "should allow descriptions and remove from attributes" do
+    tag = Tag.new :input, :attributes => { :description => 'testing one two three' }
+    tag.description.should == %(\n<p class="description">testing one two three</p>)  
+    tag.attributes.has_key?(:description).should be_false  
+  end
+  
+  it "should allow capturing of elements via block" do
+    tag = Tag.new :fieldset, :attributes => { :id => 'something' } do |f|
+      f.button :one
+      f.button :two
+    end
+    tag.render.should == <<-HTML.deindent
+      <fieldset id="something"><input type="button" class="form-button form-one" name="one" />
+      <input type="button" class="form-button form-two" name="two" />
+      </fieldset>
+    HTML
+  end
+    
+end

data/spec/integration/datamapper_spec.rb

@@ -0,0 +1,70 @@
+
+require 'dm-core'
+require 'dm-validations'
+
+include DataMapper::Form::ModelElements
+
+DataMapper.setup :default, 'sqlite3::memory:'
+
+class User
+  include DataMapper::Resource
+  property :id,    Serial
+  property :name,  String, :format => /^[\w]+$/
+  property :email, String, :format => :email_address
+end
+
+DataMapper.auto_migrate!
+
+describe DataMapper::Form::ModelElements do
+  
+  before :each do
+    @user = User.new :name => 'invalid username', :email => 'is_valid@email.com'
+  end
+  
+  it "should create a list of errors when a model is invalid" do
+    errors_for(@user).should == <<-HTML.deindent
+      <ul class="messages error">
+      <li>Name has an invalid format</li>
+      </ul>
+    HTML
+    @user.email = 'invalid email@ something.com'
+    errors_for(@user).should == <<-HTML.deindent
+      <ul class="messages error">
+      <li>Name has an invalid format</li>
+      <li>Email has an invalid format</li>
+      </ul>
+    HTML
+  end
+  
+  it "should create model specific forms with errors on elements" do
+    results = form_for @user do |f|
+      f.textfield :name
+      f.textfield :email
+      f.submit :op, :value => 'Save'
+    end
+    results.should == <<-HTML.deindent
+      <form method="post" id="form-user"><input type="textfield" class="error form-textfield form-name" name="name" />
+      <input type="textfield" class="form-textfield form-email" name="email" />
+      <input type="submit" class="form-submit form-op" value="Save" name="op" />
+      </form>
+    HTML
+  end
+  
+  it "should use _method put for updating records" do
+    @user.name = 'tj'
+    @user.save
+    results = form_for @user, :action => '/register' do |f|
+      f.textfield :name
+      f.textfield :email
+      f.submit :op, :value => 'Save'
+    end
+    results.should == <<-HTML.deindent
+      <form method="post" action="/register" id="form-user"><input type="hidden" value="put" name="_method" />
+      <input type="textfield" class="form-textfield form-name" name="name" />
+      <input type="textfield" class="form-textfield form-email" name="email" />
+      <input type="submit" class="form-submit form-op" value="Save" name="op" />
+      </form>
+    HTML
+  end
+  
+end

data/spec/integration/haml_spec.rb

@@ -0,0 +1,29 @@
+
+require 'rubygems'
+require 'haml'
+
+include DataMapper::Form::Elements
+
+describe "Haml + dm-forms" do
+      
+  it "should create pretty forms :D" do
+    engine = Haml::Engine.new <<-HAML.deindent
+      .comments
+        %h1 Comments
+        = textfield :name
+        = textfield :email
+        = textarea :comments
+        = submit :op, :value => 'Submit'
+    HAML
+    engine.render.should == <<-HTML.deindent
+      <div class='comments'>
+        <h1>Comments</h1>
+        <input type="textfield" class="form-textfield form-name" name="name" />
+        <input type="textfield" class="form-textfield form-email" name="email" />
+        <textarea class="form-textarea form-comments" name="comments"></textarea>
+        <input type="submit" class="form-submit form-op" value="Submit" name="op" />
+      </div>
+    HTML
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+
+require 'dm-forms'
+require 'rspec_hpricot_matchers'
+include RspecHpricotMatchers
+  
+class String
+  def deindent spaces = 6
+    gsub /^ {0,#{spaces}}/, ''
+  end
+end

data/tasks/benchmarks.rake

@@ -0,0 +1,5 @@
+
+desc 'Run benchmark suite'
+task :benchmark do
+  sh 'ruby examples/benchmarks.rb'
+end

data/tasks/docs.rake

@@ -0,0 +1,13 @@
+
+namespace :docs do
+  
+  desc 'Remove rdoc products'
+  task :remove => [:clobber_docs]
+  
+  desc 'Build docs, and open in browser for viewing (specify BROWSER)'
+  task :open do
+    browser = ENV["BROWSER"] || "safari"
+    sh "open -a #{browser} doc/index.html"
+  end
+  
+end

data/tasks/gemspec.rake

@@ -0,0 +1,3 @@
+
+desc 'Build gemspec file'
+task :gemspec => [:build_gemspec]

data/tasks/spec.rake

@@ -0,0 +1,25 @@
+
+require 'spec/rake/spectask'
+  
+desc "Run all specifications"
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.libs << "lib"
+  t.spec_opts = ["--color", "--require", "spec/spec_helper.rb"]
+end
+  
+namespace :spec do
+
+  desc "Run all specifications verbosely"
+  Spec::Rake::SpecTask.new(:verbose) do |t|
+    t.libs << "lib"
+    t.spec_opts = ["--color", "--format", "specdoc", "--require", "spec/spec_helper.rb"]
+  end
+  
+  desc "Run specific specification verbosely (specify SPEC)"
+  Spec::Rake::SpecTask.new(:select) do |t|
+    t.libs << "lib"
+    t.spec_files = [ENV["SPEC"]]
+    t.spec_opts = ["--color", "--format", "specdoc", "--require", "spec/spec_helper.rb"]
+  end
+  
+end