forme 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 06d7e50cfae657572071affb86ef307636c65345
-  data.tar.gz: 5eef25b91f833f3a57caef3903d25886cb48f00d
+  metadata.gz: 037794e39f62d0052a5dd6a6832c41326d31b851
+  data.tar.gz: 1f3aa7418616002d1e2443ccea5313a874925851
 SHA512:
-  metadata.gz: a19e5579fc8f0bfe11c5136f2ecc69db057a23f76d08bc01aad4680c1ebeb9fbd27476a04d60265efe5de1d1e5ab0b16dd615f8bc0081c7b733ef9f188e31581
-  data.tar.gz: ba0fe6ba4e18fe182c0a93eb9b33f28e0d0f30729ec537f2a3b468d8b9db56a75d657aadb17b4c164a3128d901017d7460a7ce8ecd9bd8a923d5017bc1e4d051
+  metadata.gz: 55d5ebeb5602c3eaed73448d2973bfc12b97a3ffb5d39c4caee227c83cbca0142252c96d8c99c90a178071a9ca3302b99f62316180d2a2f36d2358ac8afeb7d9
+  data.tar.gz: 9bb5afa6c4192585b71bad482d7de6c138efc11b4e00310c9376f147884c1e6f2e399475504329502ca0281374f89ee20b3874e54649cb6dd3953dc197fdad94

data/CHANGELOG

@@ -1,3 +1,21 @@
+=== 0.9.0 (2013-12-13)
+
+* Support :input_defaults Form option for setting defaults for inputs by type (jeremyevans)
+
+* Make html_usa serializer convert date/datetime inputs to text for better compatibility (jeremyevans)
+
+* Format BigDecimal in standard notation instead of default scientific notation (jeremyevans)
+
+* Make trtd wrapper always have labels on left side (jeremyevans)
+
+* Make trtd wrapper always use 2 cells (jeremyevans)
+
+* Use regular (not-multiple) select box for *_to_many associations for :multiple=>false option (jeremyevans)
+
+* Associtions in the Sequel plugin now support a :dataset option to specify dataset to use for options (jeremyevans)
+
+* The :name_method option used for associations in the Sequel plugin now allows for arbitrary callables (jeremyevans)
+
 === 0.8.0 (2013-10-30)
 
 * form calls without block or :inputs or :button options are now handled correctly in the Sinatra integration (jeremyevans)

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2011-2012 Jeremy Evans
+Copyright (c) 2011-2013 Jeremy Evans
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to

data/README.rdoc

@@ -9,7 +9,11 @@ Forme is a HTML forms library for ruby with the following goals:
 
 = Demo Site
 
-A demo site is available at http://forme.heroku.com
+A demo site is available at http://forme-demo.jeremyevans.net
+
+= Documentation Site
+
+RDoc Documentation is available at http://forme.jeremyevans.net
 
 = Source Code
 

data/Rakefile

@@ -22,11 +22,17 @@ end
 
 ### RDoc
 
-RDOC_DEFAULT_OPTS = ["--quiet", "--line-numbers", "--inline-source", '--title', 'Forme']
+RDOC_DEFAULT_OPTS = ["--line-numbers", "--inline-source", '--title', 'Forme']
+
+begin
+  gem 'rdoc', '= 3.12.2'
+  gem 'hanna-nouveau'
+  RDOC_DEFAULT_OPTS.concat(['-f', 'hanna'])
+rescue Gem::LoadError
+end
 
 rdoc_task_class = begin
   require "rdoc/task"
-  RDOC_DEFAULT_OPTS.concat(['-f', 'hanna'])
   RDoc::Task
 rescue LoadError
   require "rake/rdoctask"

data/lib/forme.rb

@@ -1,4 +1,5 @@
 require 'date'
+require 'bigdecimal'
 require 'forme/version'
 
 # Forme is designed to make creating HTML forms easier.  Flexibility and
@@ -146,6 +147,7 @@ module Forme
     # :error_handler :: Sets the +error_handler+ for the form
     # :formatter :: Sets the +formatter+ for the form
     # :hidden_tags :: Sets the hidden tags to automatically add to this form.
+    # :input_defaults :: Sets the default options for each input type
     # :inputs_wrapper :: Sets the +inputs_wrapper+ for the form
     # :labeler :: Sets the +labeler+ for the form
     # :wrapper :: Sets the +wrapper+ for the form
@@ -168,6 +170,10 @@ module Forme
     # respond to +call+ or be a registered symbol.
     attr_reader :wrapper
 
+    # Set the default options for inputs by type.  This should be a hash with
+    # input type string keys and values that are hashes of input options.
+    attr_reader :input_defaults
+
     # The +inputs_wrapper+ determines how calls to +inputs+ are wrapped.  Must
     # respond to +call+ or be a registered symbol.
     attr_reader :inputs_wrapper
@@ -242,6 +248,7 @@ module Forme
       end
       config = CONFIGURATIONS[@opts[:config]||Forme.default_config]
       TRANSFORMER_TYPES.each{|k| instance_variable_set(:"@#{k}", transformer(k, @opts.fetch(k, config[k])))}
+      @input_defaults = @opts[:input_defaults] || {}
       @hidden_tags = @opts[:hidden_tags]
       @nesting = []
     end
@@ -525,7 +532,8 @@ module Forme
 
     # Set the +form+, +type+, and +opts+.
     def initialize(form, type, opts={})
-      @form, @type, @opts = form, type, opts
+      @form, @type = form, type
+      @opts = (form.input_defaults[type.to_s] || {}).merge(opts)
     end
 
     # Replace the +opts+ by merging the given +hash+ into +opts+,
@@ -1051,7 +1059,17 @@ module Forme
   end
   Forme.register_transformer(:wrapper, :trtd) do |tag, input|
     a = Array(tag).flatten
-    input.tag(:tr, input.opts[:wrapper_attr], a.length == 1 ? input.tag(:td, {}, a) : [input.tag(:td, {}, [a.first]), input.tag(:td, {}, a[1..-1])])
+    labels, other = a.partition{|e| e.is_a?(Tag) && e.type.to_s == 'label'}
+    if labels.length == 1
+      ltd = labels
+      rtd = other
+    elsif a.length == 1
+      ltd = [a.first]
+      rtd = a[1..-1]
+    else
+      ltd = a
+    end
+    input.tag(:tr, input.opts[:wrapper_attr], [input.tag(:td, {}, ltd), input.tag(:td, {}, rtd)])
   end
 
   # Default inputs_wrapper used by the library, uses a fieldset.
@@ -1150,7 +1168,7 @@ module Forme
       case tag
       when Tag
         if SELF_CLOSING.include?(tag.type)
-          "<#{tag.type}#{attr_html(tag)}/>"
+          "<#{tag.type}#{attr_html(tag.attr)}/>"
         else
           "#{serialize_open(tag)}#{call(tag.children)}#{serialize_close(tag)}"
         end
@@ -1162,6 +1180,8 @@ module Forme
         format_time(tag)
       when Date
         format_date(tag)
+      when BigDecimal
+        tag.to_s('F')
       when Raw
         tag.to_s
       else
@@ -1171,7 +1191,7 @@ module Forme
 
     # Returns the opening part of the given tag.
     def serialize_open(tag)
-      "<#{tag.type}#{attr_html(tag)}>"
+      "<#{tag.type}#{attr_html(tag.attr)}>"
     end
 
     # Returns the closing part of the given tag.
@@ -1208,16 +1228,33 @@ module Forme
 
     # Transforms the +tag+'s attributes into an html string, sorting by the keys
     # and quoting and html escaping the values.
-    def attr_html(tag)
-      attr = tag.attr.to_a.reject{|k,v| v.nil?}
+    def attr_html(attr)
+      attr = attr.to_a.reject{|k,v| v.nil?}
       " #{attr.map{|k, v| "#{k}=\"#{attr_value(v)}\""}.sort.join(' ')}" unless attr.empty?
     end
   end
 
   # Overrides formatting of dates and times to use an American format without
   # timezones.
-  module Serializer::AmericanTime
-    Forme.register_transformer(:serializer, :html_usa, Serializer.new.extend(self))
+  class Serializer::AmericanTime < Serializer
+    Forme.register_transformer(:serializer, :html_usa, new)
+
+    def call(tag)
+      case tag
+      when Tag
+        if tag.type.to_s == 'input' && %w'date datetime'.include?((tag.attr[:type] || tag.attr['type']).to_s)
+          attr = tag.attr.dup
+          attr.delete(:type)
+          attr.delete('type')
+          attr['type'] = 'text'
+          "<#{tag.type}#{attr_html(attr)}/>"
+        else
+          super
+        end
+      else
+        super
+      end
+    end
 
     private
 

data/lib/forme/version.rb

@@ -1,6 +1,6 @@
 module Forme
   # Version constant, use <tt>Forme.version</tt> instead.
-  VERSION = '0.8.0'.freeze
+  VERSION = '0.9.0'.freeze
 
   # Returns the version as a frozen string (e.g. '0.1.0')
   def self.version

data/lib/sequel/plugins/forme.rb

@@ -145,7 +145,7 @@ module Sequel # :nodoc:
         # If the field is a column, use the column's type to determine
         # an appropriate field type. If the field is an association,
         # use either a regular or multiple select input (or multiple radios or
-        # checkboxes if the related :type option is used).  If it's not a
+        # checkboxes if the related :as option is used).  If it's not a
         # column or association, but the object responds to +field+,
         # create a text input.  Otherwise, raise an +Error+.
         def input
@@ -290,8 +290,8 @@ module Sequel # :nodoc:
 
         # Create a select input made up of options for all entries the object
         # could be associated to, with the one currently associated to being selected.
-        # If the :type=>:radio option is used, use multiple radio buttons instead of
-        # a select box.  For :type=>:radio, you can also provide a :tag_wrapper option
+        # If the :as=>:radio option is used, use multiple radio buttons instead of
+        # a select box.  For :as=>:radio, you can also provide a :tag_wrapper option
         # used to wrap the individual radio buttons.
         def association_many_to_one(ref)
           key = ref[:key]
@@ -319,8 +319,8 @@ module Sequel # :nodoc:
 
         # Create a multiple select input made up of options for all entries the object
         # could be associated to, with all of the ones currently associated to being selected.
-        # If the :type=>:checkbox option is used, use multiple checkboxes instead of
-        # a multiple select box.  For :type=>:checkbox, you can also provide a :tag_wrapper option
+        # If the :as=>:checkbox option is used, use multiple checkboxes instead of
+        # a multiple select box.  For :as=>:checkbox, you can also provide a :tag_wrapper option
         # used to wrap the individual checkboxes.
         def association_one_to_many(ref)
           key = ref[:key]
@@ -340,7 +340,7 @@ module Sequel # :nodoc:
             wrapper ? wrapper.call(cbs, _input(:checkbox, opts)) : cbs
           else
             opts[:id] = form.namespaced_id(field) unless opts.has_key?(:id)
-            opts[:multiple] = true
+            opts[:multiple] = true unless opts.has_key?(:multiple)
             _input(:select, opts)
           end
         end
@@ -349,8 +349,25 @@ module Sequel # :nodoc:
         # Return an array of two element arrays representing the
         # select options that should be created.
         def association_select_options(ref)
-          name_method = forme_name_method(ref)
-          obj.send(:_apply_association_options, ref, ref.associated_class.dataset).unlimited.all.map{|a| [a.send(name_method), a.pk]}
+          case ds = opts[:dataset]
+          when nil
+            ds = association_select_options_dataset(ref)
+          when Proc, Method
+            ds = ds.call(association_select_options_dataset(ref))
+          end
+          rows = ds.all
+
+          case name_method = forme_name_method(ref)
+          when Symbol, String
+            rows.map{|a| [a.send(name_method), a.pk]}
+          else
+            rows.map{|a| [name_method.call(a), a.pk]}
+          end
+        end
+
+        # The dataset to use to retrieve the association select options
+        def association_select_options_dataset(ref)
+          obj.send(:_apply_association_options, ref, ref.associated_dataset).unlimited
         end
 
         # Delegate to the +form+.
@@ -359,7 +376,8 @@ module Sequel # :nodoc:
         end
 
         # If the column allows +NULL+ values, use a three-valued select
-        # input.  If not, use a simple checkbox.
+        # input.  If not, use a simple checkbox.  You can also use :as=>:select,
+        # as :as=>:radio, or :as=>:checkbox to specify a particular style.
         def input_boolean(sch)
           unless opts.has_key?(:as)
             opts[:as] = sch[:allow_null] ? :select : :checkbox

data/spec/forme_spec.rb

@@ -1,5 +1,4 @@
 require File.join(File.dirname(File.expand_path(__FILE__)), 'spec_helper.rb')
-require 'date'
 
 describe "Forme plain forms" do
   def sel(opts, s)
@@ -306,6 +305,10 @@ describe "Forme plain forms" do
     @f.tag(:div, :foo=>Time.utc(2011, 6, 5, 4, 3, 2)).to_s.should =~ /<div foo="2011-06-05 04:03:02(GMT|UTC)"><\/div>/
   end
 
+  specify "should format bigdecimals in standard notation" do
+    @f.tag(:div, :foo=>BigDecimal.new('10000.010')).to_s.should == '<div foo="10000.01"></div>'
+  end
+
   specify "inputs should accept a :wrapper option to use a custom wrapper" do
     @f.input(:text, :wrapper=>:li).to_s.should == '<li><input type="text"/></li>'
   end
@@ -367,6 +370,12 @@ describe "Forme plain forms" do
     @f.inputs(:inputs_wrapper=>:ol){@f.input(:textarea)}.to_s.should == '<ol><textarea></textarea></ol>'
   end
 
+  specify "should support setting defaults for inputs at the form level" do
+    f = Forme::Form.new(:input_defaults=>{'text'=>{:size=>20}, 'textarea'=>{:cols=>80, :rows=>6}})
+    f.input(:text, :name=>"foo").to_s.should == '<input name="foo" size="20" type="text"/>'
+    f.input(:textarea, :name=>"foo").to_s.should == '<textarea cols="80" name="foo" rows="6"></textarea>'
+  end
+
   specify "invalid custom transformers should raise an Error" do
     proc{Forme::Form.new(:wrapper=>Object.new)}.should raise_error(Forme::Error)
     proc{@f.input(:textarea, :wrapper=>Object.new).to_s}.should raise_error(Forme::Error)
@@ -475,7 +484,7 @@ describe "Forme built-in custom" do
   end
 
   specify "wrapper: trtd wraps tag in an tr/td" do
-    Forme::Form.new(:wrapper=>:trtd).input(:textarea, :id=>'foo').to_s.should == '<tr><td><textarea id="foo"></textarea></td></tr>'
+    Forme::Form.new(:wrapper=>:trtd).input(:textarea, :id=>'foo').to_s.should == '<tr><td><textarea id="foo"></textarea></td><td></td></tr>'
   end
 
   specify "wrapper: trtd supports multiple tags in separate tds" do
@@ -486,6 +495,10 @@ describe "Forme built-in custom" do
     Forme::Form.new(:wrapper=>:trtd, :labeler=>:explicit).input(:textarea, :id=>'foo', :label=>'Foo', :error=>'Bar').to_s.should == '<tr><td><label for="foo">Foo</label></td><td><textarea class="error" id="foo"></textarea><span class="error_message">Bar</span></td></tr>'
   end
 
+  specify "wrapper: trtd should handle inputs with label after" do
+    Forme::Form.new(:wrapper=>:trtd, :labeler=>:explicit).input(:checkbox, :id=>'foo', :name=>'foo', :label=>'Foo').to_s.should == '<tr><td><label for="foo">Foo</label></td><td><input id="foo_hidden" name="foo" type="hidden" value="0"/><input id="foo" name="foo" type="checkbox"/></td></tr>'
+  end
+
   specify "inputs_wrapper: ol wraps tags in an ol" do
     Forme::Form.new(:inputs_wrapper=>:ol, :wrapper=>:li).inputs([:textarea]).to_s.should == '<ol><li><textarea></textarea></li></ol>'
   end
@@ -503,7 +516,7 @@ describe "Forme built-in custom" do
   end
 
   specify "inputs_wrapper: table wraps tags in an table" do
-    Forme::Form.new(:inputs_wrapper=>:table, :wrapper=>:trtd).inputs([:textarea]).to_s.should == '<table><tr><td><textarea></textarea></td></tr></table>'
+    Forme::Form.new(:inputs_wrapper=>:table, :wrapper=>:trtd).inputs([:textarea]).to_s.should == '<table><tr><td><textarea></textarea></td><td></td></tr></table>'
   end
 
   specify "serializer: html_usa formats dates and datetimes in American format without timezones" do
@@ -512,6 +525,11 @@ describe "Forme built-in custom" do
     Forme::Form.new(:serializer=>:html_usa).tag(:div, :foo=>Time.utc(2011, 6, 5, 4, 3, 2)).to_s.should == '<div foo="06/05/2011 04:03:02AM"></div>'
   end
 
+  specify "serializer: html_usa should convert date and datetime inputs into text inputs" do
+    Forme::Form.new(:serializer=>:html_usa).input(:date, :value=>Date.new(2011, 6, 5)).to_s.should == '<input type="text" value="06/05/2011"/>'
+    Forme::Form.new(:serializer=>:html_usa).input(:datetime, :value=>DateTime.new(2011, 6, 5, 16, 3, 2)).to_s.should == '<input type="text" value="06/05/2011 04:03:02PM"/>'
+  end
+
   specify "serializer: text uses plain text output instead of html" do
     Forme::Form.new(:serializer=>:text).input(:textarea, :label=>"Foo", :value=>"Bar").to_s.should == "Foo: Bar\n\n"
     Forme::Form.new(:serializer=>:text).input(:text, :label=>"Foo", :value=>"Bar").to_s.should == "Foo: Bar\n\n"

data/spec/sequel_plugin_spec.rb

@@ -171,6 +171,21 @@ describe "Forme Sequel::Model forms" do
     @c.input(:artist, :name_method=>:idname).to_s.should == '<label>Artist: <select id="album_artist_id" name="album[artist_id]"><option value=""></option><option value="1">1a</option><option selected="selected" value="2">2d</option></select></label>'
   end
   
+  specify "should support :name_method option being a callable object" do
+    @b.input(:artist, :name_method=>lambda{|obj| obj.idname * 2}).to_s.should == '<label>Artist: <select id="album_artist_id" name="album[artist_id]"><option value=""></option><option selected="selected" value="1">1a1a</option><option value="2">2d2d</option></select></label>'
+    @c.input(:artist, :name_method=>lambda{|obj| obj.idname * 2}).to_s.should == '<label>Artist: <select id="album_artist_id" name="album[artist_id]"><option value=""></option><option value="1">1a1a</option><option selected="selected" value="2">2d2d</option></select></label>'
+  end
+  
+  specify "should support :dataset option providing dataset to search" do
+    @b.input(:artist, :dataset=>Artist.reverse_order(:name)).to_s.should == '<label>Artist: <select id="album_artist_id" name="album[artist_id]"><option value=""></option><option value="2">d</option><option selected="selected" value="1">a</option></select></label>'
+    @c.input(:artist, :dataset=>Artist.reverse_order(:name)).to_s.should == '<label>Artist: <select id="album_artist_id" name="album[artist_id]"><option value=""></option><option selected="selected" value="2">d</option><option value="1">a</option></select></label>'
+  end
+  
+  specify "should support :dataset option being a callback proc returning modified dataset to search" do
+    @b.input(:artist, :dataset=>proc{|ds| ds.reverse_order(:name)}).to_s.should == '<label>Artist: <select id="album_artist_id" name="album[artist_id]"><option value=""></option><option value="2">d</option><option selected="selected" value="1">a</option></select></label>'
+    @c.input(:artist, :dataset=>proc{|ds| ds.reverse_order(:name)}).to_s.should == '<label>Artist: <select id="album_artist_id" name="album[artist_id]"><option value=""></option><option selected="selected" value="2">d</option><option value="1">a</option></select></label>'
+  end
+  
   specify "should try a list of methods to get a suitable one for select box naming" do
     al = Class.new(Album){def self.name() 'Album' end}
     ar = Class.new(Artist)
@@ -209,6 +224,11 @@ describe "Forme Sequel::Model forms" do
     @c.input(:tags).to_s.should == '<label>Tags: <select id="album_tag_pks" multiple="multiple" name="album[tag_pks][]"><option value="1">s</option><option selected="selected" value="2">t</option><option value="3">u</option></select></label>'
   end
 
+  specify "should use a regular select box for *_to_many associations if multiple if false" do
+    @b.input(:tracks, :multiple=>false).to_s.should == '<label>Tracks: <select id="album_track_pks" name="album[track_pks][]"><option value="1">m</option><option value="2">n</option><option value="3">o</option></select></label>'
+    @c.input(:tags, :multiple=>false).to_s.should == '<label>Tags: <select id="album_tag_pks" name="album[tag_pks][]"><option value="1">s</option><option value="2">t</option><option value="3">u</option></select></label>'
+  end
+
   specify "should use multiple checkboxes for one_to_many associations if :as=>:checkbox" do
     @b.input(:tracks, :as=>:checkbox).to_s.should == '<span class="label">Tracks</span><label class="option"><input checked="checked" id="album_track_pks_1" name="album[track_pks][]" type="checkbox" value="1"/> m</label><label class="option"><input checked="checked" id="album_track_pks_2" name="album[track_pks][]" type="checkbox" value="2"/> n</label><label class="option"><input id="album_track_pks_3" name="album[track_pks][]" type="checkbox" value="3"/> o</label>'
     @c.input(:tracks, :as=>:checkbox).to_s.should == '<span class="label">Tracks</span><label class="option"><input id="album_track_pks_1" name="album[track_pks][]" type="checkbox" value="1"/> m</label><label class="option"><input id="album_track_pks_2" name="album[track_pks][]" type="checkbox" value="2"/> n</label><label class="option"><input checked="checked" id="album_track_pks_3" name="album[track_pks][]" type="checkbox" value="3"/> o</label>'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: forme
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Jeremy Evans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-30 00:00:00.000000000 Z
+date: 2013-12-13 00:00:00.000000000 Z
 dependencies: []
 description: |
   Forme is a forms library with the following goals:
@@ -30,15 +30,15 @@ files:
 - README.rdoc
 - Rakefile
 - spec/forme_spec.rb
-- spec/spec_helper.rb
+- spec/rails_integration_spec.rb
+- spec/sequel_helper.rb
 - spec/sequel_plugin_spec.rb
 - spec/sinatra_integration_spec.rb
-- spec/sequel_helper.rb
-- spec/rails_integration_spec.rb
+- spec/spec_helper.rb
 - lib/forme.rb
-- lib/forme/version.rb
-- lib/forme/sinatra.rb
 - lib/forme/rails.rb
+- lib/forme/sinatra.rb
+- lib/forme/version.rb
 - lib/sequel/plugins/forme.rb
 homepage: http://gihub.com/jeremyevans/forme
 licenses: []