forme 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 315de851244fa7fd0ccb18fb0d57aa53204fff22
-  data.tar.gz: c880954089f9c59174abdf75eed937a2fddde4a0
+  metadata.gz: a74dc2b36401ea1374b6e0790ee2292b793beac2
+  data.tar.gz: 33e3d4e182a2af0513ac37e3200c0eda9826d08b
 SHA512:
-  metadata.gz: d598b9cb754eb1973685c6b830451a78b3fbf18e0477373a8021966d0f5b210756fdab2f1209ed5b83cf481f530f8e02995776a829555266233bc008842a163f
-  data.tar.gz: a321b164bc8a347573c12cdd1b4bd1e786c45e82c06de27d3219256b8523acdab4e80153dbd4bf7bc82cf6929714987d1002eb5ff27ab043d717ef0c37908814
+  metadata.gz: 7c9e809e2c1cd4ea343de693f4611c5f42e5f320723545ec7f76d2e1112d3d695159ed791c2ff0f7810ed2e1bdfe01eb1d850fcd37493c13ebe3e98aa413b0a5
+  data.tar.gz: b1dfd6ce07b3e35e0873e86f6956662779ecd46f545e0c030a5e557da6cf19df7a8f9dda20ef9feb2a4f418e7d231d33fff6e4f4bcf35e858816c2e9f53fcbd1

data/CHANGELOG

@@ -1,3 +1,15 @@
+=== 1.2.0 (2014-11-06)
+
+* Support pg_array_to_many associations in the Sequel plugin, treating them similarly to other *_to_many associations (jeremyevans)
+
+* When using :grid option to subform in the Sequel plugin, :inputs_opts can be used to pass options to the InputsWrapper (jeremyevans)
+
+* Support :error_attr option for inputs, for setting attributes to use for error message span (jeremyevans)
+
+* Make explicit labeler use label-before and label-after classes specifying the label position (jeremyevans)
+
+* Support :size option for select inputs (jeremyevans)
+
 === 1.1.0 (2014-09-07)
 
 * Make form without a block in the ERB integration still use hidden tags if method is post (jeremyevans)

data/README.rdoc

@@ -424,11 +424,14 @@ This will create a form similar to:
 For one_to_many and many_to_many associations, you will probably want to use the
 +association_pks+ plugin that ships with Sequel.
 
+This supports the pg_array_to_many association type that comes with Sequel's
++pg_array_association+ plugin.
+
 association input options:
 
 :as :: For many_to_one associations, set to :radio to use a series of radio buttons instead
-       a select input.  For one_to_many and many_to_many associations, set to :checkbox to
-       use a series of checkboxes instead of a multiple select input.
+       a select input.  For one_to_many, many_to_many, and pg_array_to_many associations, set
+       to :checkbox to use a series of checkboxes instead of a multiple select input.
 :dataset :: If a Dataset, uses the dataset to retrieve the options.  If a Proc or Method,
             calls the proc or method with the default dataset, and should return a modified
             dataset to use.
@@ -502,6 +505,8 @@ subform options:
            be created via the :inputs option.  If you are not providing
            an :inputs option or are using a block with additional inputs,
            you should specify this option.
+:inputs_opts :: When using the :grid option, this allows you to specify options
+                to pass to the table InputsWrapper.
 
 = ERB Support
 
@@ -611,6 +616,7 @@ Creates a select tag, containing option tags specified by the :options option.
 :selected :: The value that should be selected.  Any options that are equal to
              this value (or included in this value if a multiple select box),
              are set to selected.
+:size :: Uses the size attribute on the tag
 :text_method :: If set, each entry in the array has this option called on
                 it to get the text of the object.
 :value :: Same as :selected, but has lower priority.
@@ -737,6 +743,10 @@ Forme ships with a bunch of built-in transformers that you can use:
 
 :default :: modifies tag to add an error class and adds a span with the error message
 
+This supports the following options:
+
+:error_attr :: A hash of attributes to use for the span with the error message
+
 === +labeler+
 
 :default :: uses implicit labels, where the tag is a child of the label tag

data/lib/forme.rb

@@ -792,9 +792,10 @@ module Forme
     # Takes a select input and turns it into a select tag with (possibly) option
     # children tags.
     def format_select
-      if os = process_select_options(@opts[:options])
-        @attr[:multiple] = :multiple if @opts[:multiple]
+      @attr[:multiple] = :multiple if @opts[:multiple]
+      copy_options_to_attributes([:size])
 
+      if os = process_select_options(@opts[:options])
         os = os.map do |label, value, sel, attrs|
           if value || sel
             attrs = attrs.dup
@@ -1104,7 +1105,10 @@ module Forme
 
     # Return tag with error message span tag after it.
     def call(tag, input)
-      [tag, input.tag(:span, {:class=>'error_message'}, input.opts[:error])]
+      attr = input.opts[:error_attr]
+      attr = attr ? attr.dup : {}
+      Forme.attr_classes(attr, 'error_message')
+      [tag, input.tag(:span, attr, input.opts[:error])]
     end
   end
 
@@ -1166,19 +1170,22 @@ module Forme
           end
         end
       end
-      if [:radio, :checkbox].include?(input.type)
-        t = [tag, input.tag(:label, {:for=>input.opts.fetch(:label_for, id)}.merge(input.opts[:label_attr]||{}), [input.opts[:label]])]
-        pos = :before
-      else
-        t = [input.tag(:label, {:for=>input.opts.fetch(:label_for, id)}.merge(input.opts[:label_attr]||{}), [input.opts[:label]]), tag]
-        pos = :after
-      end
 
-      if input.opts[:label_position] == pos
-        t.reverse
+      label_attr = input.opts[:label_attr]
+      label_attr = label_attr ? label_attr.dup : {}
+      label_attr[:for] ||= input.opts.fetch(:label_for, id)
+      lpos = input.opts[:label_position] || ([:radio, :checkbox].include?(input.type) ? :after : :before)
+
+      Forme.attr_classes(label_attr, "label-#{lpos}")
+      label = input.tag(:label, label_attr, [input.opts[:label]])
+
+      t = if lpos == :before
+        [label, tag]
       else
-        t
+        [tag, label]
       end
+
+      t
     end
   end
 

data/lib/forme/version.rb

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

data/lib/sequel/plugins/forme.rb

@@ -87,7 +87,8 @@ module Sequel # :nodoc:
           if grid
             labels = opts.fetch(:labels){opts[:inputs].map{|l, *| humanize(l)} if opts[:inputs]}
             legend = opts.fetch(:legend){humanize(association)}
-            inputs({:inputs_wrapper=>:table, :nested_inputs_wrapper=>:tr, :wrapper=>:td, :labeler=>nil, :labels=>labels, :legend=>legend}, &contents)
+            inputs_opts = opts[:inputs_opts] || {}
+            inputs(inputs_opts.merge(:inputs_wrapper=>:table, :nested_inputs_wrapper=>:tr, :wrapper=>:td, :labeler=>nil, :labels=>labels, :legend=>legend), &contents)
           else
             contents.call
           end
@@ -285,14 +286,21 @@ module Sequel # :nodoc:
           key = ref[:key]
           klass = ref.associated_class
           pk = klass.primary_key
-          field = "#{klass.send(:singularize, ref[:name])}_pks"
+          label = klass.send(:singularize, ref[:name])
+
+          field = if ref[:type] == :pg_array_to_many
+            ref[:key]
+          else
+            "#{label}_pks"
+          end
+
           unless opts.has_key?(:key)
             opts[:array] = true unless opts.has_key?(:array)
             opts[:key] = field
           end
           opts[:value] = obj.send(ref[:name]).map{|x| x.send(pk)} unless opts.has_key?(:value)
           opts[:options] = association_select_options(ref) unless opts.has_key?(:options)
-          handle_label(field)
+          handle_label(label)
           if opts.delete(:as) == :checkbox
             _input(:checkboxset, opts)
           else
@@ -301,6 +309,7 @@ module Sequel # :nodoc:
           end
         end
         alias association_many_to_many association_one_to_many
+        alias association_pg_array_to_many association_one_to_many
 
         # Return an array of two element arrays representing the
         # select options that should be created.

data/spec/forme_spec.rb

@@ -239,6 +239,10 @@ describe "Forme plain forms" do
     @f.input(:select).to_s.should == '<select></select>'
   end
 
+  specify "should respect multiple and size options in select tag" do
+    @f.input(:select, :multiple=>true, :size=>10).to_s.should == '<select multiple="multiple" size="10"></select>'
+  end
+
   specify "should create date tag" do
     @f.input(:date).to_s.should == '<input type="date"/>'
   end
@@ -252,7 +256,7 @@ describe "Forme plain forms" do
   end
 
   specify "should have explicit labeler and trtd wrapper work with multiple select boxes for dates" do
-    @f.input(:date, :name=>"foo", :id=>"bar", :as=>:select, :value=>Date.new(2011, 6, 5), :wrapper=>:trtd, :labeler=>:explicit, :label=>'Baz').to_s.should == %{<tr><td><label for="bar_year">Baz</label></td><td><select id="bar_year" name="foo[year]">#{sel(1900..2050, 2011)}</select>-<select id="bar_month" name="foo[month]">#{sel(1..12, 6)}</select>-<select id="bar_day" name="foo[day]">#{sel(1..31, 5)}</select></td></tr>}
+    @f.input(:date, :name=>"foo", :id=>"bar", :as=>:select, :value=>Date.new(2011, 6, 5), :wrapper=>:trtd, :labeler=>:explicit, :label=>'Baz').to_s.should == %{<tr><td><label class="label-before" for="bar_year">Baz</label></td><td><select id="bar_year" name="foo[year]">#{sel(1900..2050, 2011)}</select>-<select id="bar_month" name="foo[month]">#{sel(1..12, 6)}</select>-<select id="bar_day" name="foo[day]">#{sel(1..31, 5)}</select></td></tr>}
   end
 
   specify "should use multiple select boxes for datetimes if the :as=>:select option is given" do
@@ -439,6 +443,10 @@ describe "Forme plain forms" do
     @f.input(:text, :error=>'Bad Stuff!', :class=>'bar', :value=>'foo').to_s.should == '<input class="bar error" type="text" value="foo"/><span class="error_message">Bad Stuff!</span>'
   end
 
+  specify "should respect :error_attr option for setting the attributes for the error message span" do
+    @f.input(:text, :error=>'Bad Stuff!', :value=>'foo', :error_attr=>{:class=>'foo'}).to_s.should == '<input class="error" type="text" value="foo"/><span class="foo error_message">Bad Stuff!</span>'
+  end
+
   specify "#open should return an opening tag" do
     @f.open(:action=>'foo', :method=>'post').to_s.should == '<form action="foo" method="post">'
   end
@@ -559,19 +567,19 @@ describe "Forme plain forms" do
   end
 
   specify "inputs should accept a :labeler option to use a custom labeler" do
-    @f.input(:textarea, :labeler=>:explicit, :label=>'bar', :id=>:foo).to_s.should == '<label for="foo">bar</label><textarea id="foo"></textarea>'
+    @f.input(:textarea, :labeler=>:explicit, :label=>'bar', :id=>:foo).to_s.should == '<label class="label-before" for="foo">bar</label><textarea id="foo"></textarea>'
   end
 
   specify "inputs handle explicit labels with :label_position=>:after" do
-    @f.input(:textarea, :labeler=>:explicit, :label=>'bar', :id=>:foo, :label_position=>:after).to_s.should == '<textarea id="foo"></textarea><label for="foo">bar</label>'
+    @f.input(:textarea, :labeler=>:explicit, :label=>'bar', :id=>:foo, :label_position=>:after).to_s.should == '<textarea id="foo"></textarea><label class="label-after" for="foo">bar</label>'
   end
 
   specify "should handle explicit labels with checkboxes" do
-    @f.input(:checkbox, :labeler=>:explicit, :label=>'Foo', :value=>'foo', :name=>'a', :id=>'bar').to_s.should == '<input id="bar_hidden" name="a" type="hidden" value="0"/><input id="bar" name="a" type="checkbox" value="foo"/><label for="bar">Foo</label>'
+    @f.input(:checkbox, :labeler=>:explicit, :label=>'Foo', :value=>'foo', :name=>'a', :id=>'bar').to_s.should == '<input id="bar_hidden" name="a" type="hidden" value="0"/><input id="bar" name="a" type="checkbox" value="foo"/><label class="label-after" for="bar">Foo</label>'
   end
 
   specify "should handle explicit labels with checkboxes with :label_position=>:before" do
-    @f.input(:checkbox, :labeler=>:explicit, :label=>'Foo', :value=>'foo', :name=>'a', :id=>'bar', :label_position=>:before).to_s.should == '<label for="bar">Foo</label><input id="bar_hidden" name="a" type="hidden" value="0"/><input id="bar" name="a" type="checkbox" value="foo"/>'
+    @f.input(:checkbox, :labeler=>:explicit, :label=>'Foo', :value=>'foo', :name=>'a', :id=>'bar', :label_position=>:before).to_s.should == '<label class="label-before" for="bar">Foo</label><input id="bar_hidden" name="a" type="hidden" value="0"/><input id="bar" name="a" type="checkbox" value="foo"/>'
   end
 
   specify "inputs handle implicit labels or checkboxes without hidden fields with :label_position=>:before" do
@@ -706,15 +714,15 @@ describe "Forme built-in custom" do
   end
 
   specify "labeler: explicit uses an explicit label with for attribute" do
-    Forme::Form.new(:labeler=>:explicit).input(:textarea, :id=>'foo', :label=>'bar').to_s.should == '<label for="foo">bar</label><textarea id="foo"></textarea>'
+    Forme::Form.new(:labeler=>:explicit).input(:textarea, :id=>'foo', :label=>'bar').to_s.should == '<label class="label-before" for="foo">bar</label><textarea id="foo"></textarea>'
   end
 
   specify "labeler: explicit handles the key option correctly" do
-    Forme::Form.new(:labeler=>:explicit, :namespace=>:baz).input(:textarea, :key=>'foo', :label=>'bar').to_s.should == '<label for="baz_foo">bar</label><textarea id="baz_foo" name="baz[foo]"></textarea>'
+    Forme::Form.new(:labeler=>:explicit, :namespace=>:baz).input(:textarea, :key=>'foo', :label=>'bar').to_s.should == '<label class="label-before" for="baz_foo">bar</label><textarea id="baz_foo" name="baz[foo]"></textarea>'
   end
 
   specify "labeler: explicit should handle tags with errors" do
-    Forme::Form.new(:labeler=>:explicit).input(:text, :error=>'Bad Stuff!', :value=>'f', :id=>'foo', :label=>'bar').to_s.should == '<label for="foo">bar</label><input class="error" id="foo" type="text" value="f"/><span class="error_message">Bad Stuff!</span>'
+    Forme::Form.new(:labeler=>:explicit).input(:text, :error=>'Bad Stuff!', :value=>'f', :id=>'foo', :label=>'bar').to_s.should == '<label class="label-before" for="foo">bar</label><input class="error" id="foo" type="text" value="f"/><span class="error_message">Bad Stuff!</span>'
   end
 
   specify "wrapper: li wraps tag in an li" do
@@ -748,15 +756,15 @@ describe "Forme built-in custom" do
   end
 
   specify "wrapper: trtd supports multiple tags in separate tds" do
-    Forme::Form.new(:wrapper=>:trtd, :labeler=>:explicit).input(:textarea, :id=>'foo', :label=>'Foo').to_s.should == '<tr><td><label for="foo">Foo</label></td><td><textarea id="foo"></textarea></td></tr>'
+    Forme::Form.new(:wrapper=>:trtd, :labeler=>:explicit).input(:textarea, :id=>'foo', :label=>'Foo').to_s.should == '<tr><td><label class="label-before" for="foo">Foo</label></td><td><textarea id="foo"></textarea></td></tr>'
   end
 
   specify "wrapper: trtd should use at most 2 td tags" 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>'
+    Forme::Form.new(:wrapper=>:trtd, :labeler=>:explicit).input(:textarea, :id=>'foo', :label=>'Foo', :error=>'Bar').to_s.should == '<tr><td><label class="label-before" 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>'
+    Forme::Form.new(:wrapper=>:trtd, :labeler=>:explicit).input(:checkbox, :id=>'foo', :name=>'foo', :label=>'Foo').to_s.should == '<tr><td><label class="label-after" 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 "wrapper: tr should use a td wrapper and tr inputs_wrapper" do
@@ -884,17 +892,17 @@ describe "Forme configurations" do
   end
 
   specify "config: :formastic uses fieldset_ol inputs_wrapper and li wrapper, and explicit labeler" do
-    Forme::Form.new(:config=>:formtastic).inputs([[:textarea, {:id=>:foo, :label=>'Foo'}]]).to_s.should == '<fieldset class="inputs"><ol><li><label for="foo">Foo</label><textarea id="foo"></textarea></li></ol></fieldset>'
+    Forme::Form.new(:config=>:formtastic).inputs([[:textarea, {:id=>:foo, :label=>'Foo'}]]).to_s.should == '<fieldset class="inputs"><ol><li><label class="label-before" for="foo">Foo</label><textarea id="foo"></textarea></li></ol></fieldset>'
   end
 
   specify "should be able to set a default configuration with Forme.default_config=" do
     Forme.default_config = :formtastic
-    Forme::Form.new.inputs([[:textarea, {:id=>:foo, :label=>'Foo'}]]).to_s.should == '<fieldset class="inputs"><ol><li><label for="foo">Foo</label><textarea id="foo"></textarea></li></ol></fieldset>'
+    Forme::Form.new.inputs([[:textarea, {:id=>:foo, :label=>'Foo'}]]).to_s.should == '<fieldset class="inputs"><ol><li><label class="label-before" for="foo">Foo</label><textarea id="foo"></textarea></li></ol></fieldset>'
   end
 
   specify "should have #register_config register a configuration for later use" do
     Forme.register_config(:foo, :wrapper=>:li, :labeler=>:explicit)
-    Forme::Form.new(:config=>:foo).input(:textarea, :id=>:foo, :label=>'Foo').to_s.should == '<li><label for="foo">Foo</label><textarea id="foo"></textarea></li>'
+    Forme::Form.new(:config=>:foo).input(:textarea, :id=>:foo, :label=>'Foo').to_s.should == '<li><label class="label-before" for="foo">Foo</label><textarea id="foo"></textarea></li>'
   end
 
   specify "should have #register_config support a :base option to base it on an existing config" do

data/spec/sequel_helper.rb

@@ -55,6 +55,13 @@ class Album < Sequel::Model
   one_to_many :tracks
   many_to_many :tags
 
+  plugin :pg_array_associations
+  pg_array_to_many :atags, :class=>:Tag
+
+  def atag_ids
+    @atag_ids ||= [1,2]
+  end
+
   def artist_name
     artist.name if artist
   end

data/spec/sequel_plugin_spec.rb

@@ -234,6 +234,12 @@ 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 multiple select box for pg_array_to_many associations" do
+    @b.input(:atags).to_s.should == '<label>Atags: <select id="album_atag_ids" multiple="multiple" name="album[atag_ids][]"><option selected="selected" value="1">s</option><option selected="selected" value="2">t</option><option value="3">u</option></select></label>'
+    @c.obj.atag_ids.delete(1)
+    @c.input(:atags).to_s.should == '<label>Atags: <select id="album_atag_ids" multiple="multiple" name="album[atag_ids][]"><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>'
@@ -389,6 +395,10 @@ describe "Forme Sequel::Model forms" do
     Forme.form(@ab){|f| f.subform(:artist, :inputs=>[:name], :grid=>true)}.to_s.should == '<form class="forme album" method="post"><table><caption>Artist</caption><tr><th>Name</th></tr><input id="album_artist_attributes_id" name="album[artist_attributes][id]" type="hidden" value="1"/><tr><td class="string"><input id="album_artist_attributes_name" name="album[artist_attributes][name]" type="text" value="a"/></td></tr></table></form>'
   end
   
+  specify "should have #subform :grid option respect :inputs_opts option to pass options to inputs" do
+    Forme.form(@ab){|f| f.subform(:artist, :inputs=>[:name], :grid=>true, :inputs_opts=>{:attr=>{:class=>'foo'}})}.to_s.should == '<form class="forme album" method="post"><table class="foo"><caption>Artist</caption><tr><th>Name</th></tr><input id="album_artist_attributes_id" name="album[artist_attributes][id]" type="hidden" value="1"/><tr><td class="string"><input id="album_artist_attributes_name" name="album[artist_attributes][name]" type="text" value="a"/></td></tr></table></form>'
+  end
+  
   specify "should have #subform :grid option handle :legend and :labels options" do
     Forme.form(@ab){|f| f.subform(:artist, :inputs=>[:name], :grid=>true, :legend=>'Foo', :labels=>%w'Bar')}.to_s.should == '<form class="forme album" method="post"><table><caption>Foo</caption><tr><th>Bar</th></tr><input id="album_artist_attributes_id" name="album[artist_attributes][id]" type="hidden" value="1"/><tr><td class="string"><input id="album_artist_attributes_name" name="album[artist_attributes][name]" type="text" value="a"/></td></tr></table></form>'
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: forme
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Jeremy Evans
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-08 00:00:00.000000000 Z
+date: 2014-11-06 00:00:00.000000000 Z
 dependencies: []
 description: |
   Forme is a forms library with the following goals: