forme 2.6.0 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0078a295325f1880c32a870466a7e280a0cd324e2f8bf91ea81125bf557d225
-  data.tar.gz: 120e19dde7e39176a4693a4ab46f7f1c2f4d86265f3de4946af6a1d40f5fd524
+  metadata.gz: af9c688d8d8f4432cfe214dbc58332a11d57c50e9309b96ba30e7396865a19a7
+  data.tar.gz: 7c66b8036e5d34a78055e8ba046501f70dcab1b066bf0836548acc5219bcc5b9
 SHA512:
-  metadata.gz: f13bb7fdfaf90be6af18cc67403d4e36f963c6258eeb49bbc4579b356534172fa4d25380f032ef7a80954f532de3a63f67e3ad3a985c0225d4d21db0245fe387
-  data.tar.gz: 6ec1d4cbee834565239953a12b826b9b190c4f80901b6dc559954c7414889a1c0691e3a16b25dd5d2176a079ae3826a3b9e13bb6c23e323979046af98288208f
+  metadata.gz: aa5077f2c26acd92526dc3db78aa45c69c5c7ede218120b4eed39683bf8bf4a351b418bd8f8765fd9612e72d0e8879eab5617c9ac9d193103ff5b2c95afd17a6
+  data.tar.gz: b1999c8bc8ee43a1f3dc1a4601087f067750118cff71b0caf9ba0729e4b7555ffbd3f58ded0bda79f5a53c37a212e79951651e60e9f063c320f6dcda62f67237

data/CHANGELOG

@@ -1,3 +1,19 @@
+=== 2.7.0 (2025-09-16)
+
+* Omit closing / for void element tags (only used previously for xhtml compliance) (jeremyevans)
+
+* Allow emit: false option to work correctly for non-model template forms (jeremyevans)
+
+* Support :label_attr as an option-specific option for radioset/checkboxset options (jeremyevans)
+
+* Allow Tag#initialize to accept a block, and treat it the same as the children argument (jeremyevans)
+
+* Add Labeler::Explicit#id_for_input private method to allow subclasses to easily get the id (jeremyevans)
+
+* Support Sequel::Model#forme_required_abbr_title to control the content of the title attribute for abbr tags (jeremyevans)
+
+* Add Serializer#self_closing_tag? private method for easier overriding in subclasses (jeremyevans)
+
 === 2.6.0 (2024-06-18)
 
 * Add Roda forme_erubi_capture_block plugin to support erubi/capture_block <%= form do %> <% end %> tags (jeremyevans)

data/README.rdoc

@@ -25,11 +25,11 @@ showing usage without a related object:
 This results in the following HTML:
 
   <form action="/foo">
-    <input name="bar" type="text"/>
+    <input name="bar" type="text">
     <fieldset>
       <textarea name="baz"></textarea>
     </fieldset>
-    <input type="submit" value="Update"/>
+    <input type="submit" value="Update">
   </form>
 
 Forme also supports forms that are associated with objects, and
@@ -46,10 +46,10 @@ This results in the following HTML:
 
   <form action="/foo" method="post">
     <label>Name:
-      <input id="album_name" name="album[name]" type="text" value="Rising Force"/>
+      <input id="album_name" name="album[name]" type="text" value="Rising Force">
     </label>
     <label>Copies Sold:
-      <input id="album_copies_sold" inputmode="numeric" name="album[copies_sold]" pattern="-?[0-9]*" type="text" value="100000"/>
+      <input id="album_copies_sold" inputmode="numeric" name="album[copies_sold]" pattern="-?[0-9]*" type="text" value="100000">
     </label>
   </form>
 
@@ -95,7 +95,7 @@ While not typically done, you can instantiate Forme::Form objects directly and u
   f = Forme::Form.new
   f.open(:action=>'/foo', :method=>:post) # '<form action="/foo" method="post">'
   f.input(:textarea, :value=>'foo', :name=>'bar') # '<textarea name="bar">foo</textarea>'
-  f.input(:text, :value=>'foo', :name=>'bar') # '<input name="bar" type="text" value="foo"/>'
+  f.input(:text, :value=>'foo', :name=>'bar') # '<input name="bar" type="text" value="foo">'
   f.close # '</form>'
 
 With an object, <tt>Form#input</tt> calls +forme_input+ on the obj with the form, field, and options, which
@@ -104,14 +104,14 @@ should return a <tt>Forme::Input</tt> or <tt>Forme::Tag</tt> instance.  Also, in
 the entire form based on the object.
 
   f = Forme::Form.new(obj)
-  f.input(:field) # '<input id="obj_field" name="obj[field]" type="text" value="foo"/>'
+  f.input(:field) # '<input id="obj_field" name="obj[field]" type="text" value="foo">'
 
 If the object doesn't respond to +forme_input+, it falls back to creating text fields
 with the name and id set to the field name and the value set by calling the given method
 on the object (or using #[] if the object is a hash).
 
   f = Forme::Form.new([:foo])
-  f.input(:first) # '<input id="first" name="first" type="text" value="foo"/>'
+  f.input(:first) # '<input id="first" name="first" type="text" value="foo">'
 
 = Forme::Form Creation
 
@@ -187,25 +187,25 @@ This adds an input to the form.  If the form has an associated object, and that
 object responds to +forme_input+, calls forme_input with the argument and options:
 
   f = Forme::Form.new(obj)
-  f.input(:field) # '<input id="obj_field" name="obj[field]" type="text" value="foo"/>'
+  f.input(:field) # '<input id="obj_field" name="obj[field]" type="text" value="foo">'
 
 If the form has an associated object, and that object does not respond to +forme_input+,
 calls the method on the object (or uses [] if the object is a hash), and uses the result
 as the value for a text input:
 
   f = Forme::Form.new([:foo])
-  f.input(:first) # '<input id="first" name="first" type="text" value="foo"/>'
+  f.input(:first) # '<input id="first" name="first" type="text" value="foo">'
 
 If the object does not respond to +forme_input+, you can change the type of the input
 via the +:type+ option:
 
   f = Forme::Form.new(obj)
-  f.input(:field, :type=>:email) # '<input id="obj_field" name="obj[field]" type="email" value="foo"/>'
+  f.input(:field, :type=>:email) # '<input id="obj_field" name="obj[field]" type="email" value="foo">'
 
 If the form does not have an associated object, the first argument is used as the input type:
 
   f = Forme::Form.new
-  f.input(:text) # '<input type="text" />'
+  f.input(:text) # '<input type="text" >'
   
 The second argument is an options hash.  See below for the supported input types and options.
 
@@ -226,7 +226,7 @@ Which results in a form similar to the following:
 
   <form>
     <span class="foo">
-      <input type="text"/>
+      <input type="text">
     </span>
   </form>
 
@@ -238,7 +238,7 @@ so it uses a +fieldset+ by default). You can give the inputs to add as an enumer
   f.inputs([:textarea, [:text, :value=>'a']])
   # <fieldset>
   #   <textarea></textarea>
-  #   <input type="text" value="a"/>
+  #   <input type="text" value="a">
   # </fieldset>
 
 You can also provide a block:
@@ -262,17 +262,17 @@ There is also one option specific to the inputs method:
 This adds a submit input to the form:
 
   f.button
-  # <input type="submit"/>
+  # <input type="submit">
 
 It can be called with a string to provide a value for the button:
 
   f.button('Search')
-  # <input type="submit" value="Search"/>
+  # <input type="submit" value="Search">
 
 It can be called with a hash to provide options for the submit input:
 
   f.button(value: 'Search', class: 'btn')
-  # <input class="btn" type="submit" value="Search"/>
+  # <input class="btn" type="submit" value="Search">
 
 == with_opts
 
@@ -280,12 +280,12 @@ This requires a block, and modifies the Forme::Form's options inside the block,
 restoring the options when the block returns:
 
   f.input(:text)
-  # <input type="text"/>
+  # <input type="text">
 
   f.with_opts(wrapper: :li) do
     f.input(:text)
   end
-  # <li><input type="text"/></li>
+  # <li><input type="text"></li>
 
 This supports most options you can provide to Forme::Form, but not all.
 
@@ -297,10 +297,10 @@ existing namespaces:
 
   Forme.form([:foo], {action: '/path'}, namespace: 'a') do |f|
     f.input(:first)
-    # <input id="a_first" name="a[first]" type="text" value="foo"/>
+    # <input id="a_first" name="a[first]" type="text" value="foo">
     f.with_obj(['foobar'], 'b') do |o|
       f.input(:first, :size=>o.first.size)
-      # <input id="a_b_first" name="a[b][first]" size="6" type="text" value="foobar"/>
+      # <input id="a_b_first" name="a[b][first]" size="6" type="text" value="foobar">
     end
   end
 
@@ -315,8 +315,8 @@ index of the object in the enumerable, and includes the index in the namespace:
     f.each_obj(objectlist, 'b') do |o, i|
       f.input(:first, :size=>10+i)
     end
-    # <input id="a_b_0_first" name="a[b][0][first]" size="10" type="text" value="foobar"/>
-    # <input id="a_b_1_first" name="a[b][1][first]" size="11" type="text" value="good"/>
+    # <input id="a_b_0_first" name="a[b][0][first]" size="10" type="text" value="foobar">
+    # <input id="a_b_1_first" name="a[b][1][first]" size="11" type="text" value="good">
   end
 
 = Sequel Support
@@ -375,16 +375,16 @@ to the current object.
 This will create a form similar to:
 
   <form action="/foo" method="post">
-    <label>Name: <input id="album_name" name="album[name]" type="text" value="Blue Hawaii"/></label>
+    <label>Name: <input id="album_name" name="album[name]" type="text" value="Blue Hawaii"></label>
     <label>Artist: <select id="album_artist_id" name="album[artist_id]">
       <option selected="selected" value="1">Elvis Presley</option>
       <option value="2">The Beatles</option>
       <option value="3">The Monkeys</option>
     </select></label>
     <span class="label">Tags:
-      <label><input checked="checked" id="album_tag_pks_1" name="album[tag_pks][]" type="checkbox" value="1"/> Rock and Roll</label>
-      <label><input id="album_tag_pks_2" name="album[tag_pks][]" type="checkbox" value="2"/> Blues</label>
-      <label><input id="album_tag_pks_3" name="album[tag_pks][]" type="checkbox" value="3"/> Country</label>
+      <label><input checked="checked" id="album_tag_pks_1" name="album[tag_pks][]" type="checkbox" value="1"> Rock and Roll</label>
+      <label><input id="album_tag_pks_2" name="album[tag_pks][]" type="checkbox" value="2"> Blues</label>
+      <label><input id="album_tag_pks_3" name="album[tag_pks][]" type="checkbox" value="3"> Country</label>
     </span>
   </form>
 
@@ -434,22 +434,22 @@ form similar to:
 
   <form action="/foo" method="post">
   
-    <label>Name: <input id="album_name" name="album[name]" type="text" value="Blue Hawaii"/></label>
+    <label>Name: <input id="album_name" name="album[name]" type="text" value="Blue Hawaii"></label>
   
-    <input id="album_artist_attributes_id" name="album[artist_attributes][id]" type="hidden" value="1"/>
+    <input id="album_artist_attributes_id" name="album[artist_attributes][id]" type="hidden" value="1">
     <fieldset class="inputs"><legend>Artist</legend>
-      <label>Name: <input id="album_artist_attributes_name" name="album[artist_attributes][name]" type="text" value="Elvis Presley"/></label>
+      <label>Name: <input id="album_artist_attributes_name" name="album[artist_attributes][name]" type="text" value="Elvis Presley"></label>
     </fieldset>
   
-    <input id="album_tracks_attributes_0_id" name="album[tracks_attributes][0][id]" type="hidden" value="1"/>
+    <input id="album_tracks_attributes_0_id" name="album[tracks_attributes][0][id]" type="hidden" value="1">
     <fieldset class="inputs"><legend>Track #1</legend>
-      <label>Number: <input id="album_tracks_attributes_0_number" inputmode="numeric" name="album[tracks_attributes][0][number]" pattern="-?[0-9]*" type="text" value="1"/></label>
-      <label>Name: <input id="album_tracks_attributes_0_name" name="album[tracks_attributes][0][name]" type="text" value="Blue Hawaii"/></label>
+      <label>Number: <input id="album_tracks_attributes_0_number" inputmode="numeric" name="album[tracks_attributes][0][number]" pattern="-?[0-9]*" type="text" value="1"></label>
+      <label>Name: <input id="album_tracks_attributes_0_name" name="album[tracks_attributes][0][name]" type="text" value="Blue Hawaii"></label>
     </fieldset>
-    <input id="album_tracks_attributes_1_id" name="album[tracks_attributes][1][id]" type="hidden" value="2"/>
+    <input id="album_tracks_attributes_1_id" name="album[tracks_attributes][1][id]" type="hidden" value="2">
     <fieldset class="inputs"><legend>Track #2</legend>
-      <label>Number: <input id="album_tracks_attributes_1_number" inputmode="numeric" name="album[tracks_attributes][1][number]" pattern="-?[0-9]*" type="text" value="2"/></label>
-      <label>Name: <input id="album_tracks_attributes_1_name" name="album[tracks_attributes][1][name]" type="text" value="Almost Always True"/></label>
+      <label>Number: <input id="album_tracks_attributes_1_number" inputmode="numeric" name="album[tracks_attributes][1][number]" pattern="-?[0-9]*" type="text" value="2"></label>
+      <label>Name: <input id="album_tracks_attributes_1_name" name="album[tracks_attributes][1][name]" type="text" value="Almost Always True"></label>
     </fieldset>
   
   </form>

data/lib/forme/bs3.rb

@@ -380,7 +380,7 @@ module Forme
             tag.attr[:class] = "form-control #{klass.gsub(/\s*form-control\s*/,'')}".strip
           end
           
-          return "<#{tag.type}#{attr_html(tag.attr)}/>"
+          return "<#{tag.type}#{attr_html(tag.attr)}>"
           
         when :textarea, :select
           klass = tag.attr[:class] ? "form-control #{tag.attr[:class].to_s}" : ''

data/lib/forme/tag.rb

@@ -18,9 +18,9 @@ module Forme
     attr_reader :children
 
     # Set the +form+, +type+, +attr+, and +children+.
-    def initialize(form, type, attr={}, children=nil)
+    def initialize(form, type, attr={}, children=nil, &block)
       @form, @type, @attr = form, type, (attr||{})
-      @children = parse_children(children)
+      @children = parse_children(children||block)
     end
 
     # Create a new +Tag+ instance with the given arguments and block

data/lib/forme/template.rb

@@ -58,14 +58,14 @@ module Forme
       # using the standard ERB hidden tags.
       def form(obj=nil, attr={}, opts={}, &block)
         if obj.is_a?(Hash)
-          attribs = obj
-          options = attr = attr.dup
+          opts = attr.dup
+          attr = obj
+          obj = opts.delete(:obj)
         else
-          attribs = attr
-          options = opts = opts.dup
+          opts = opts.dup
         end
 
-        _forme_form_options(obj, attribs, options)
+        _forme_form_options(obj, attr, opts)
         _forme_form(obj, attr, opts, &block)
       end
 

data/lib/forme/transformers/formatter.rb

@@ -237,9 +237,9 @@ module Forme
       last_input = nil
       ret = process_select_optgroups(:_format_set_optgroup) do |label, value, sel, attrs|
         value = label if value.nil?
-        label_attr = {:class=>:option}
-        label_attr.merge!(tag_label_attr) if tag_label_attr
-        r_opts = attrs.merge(tag_attrs).merge(:label=>label||value, :label_attr=>label_attr, :wrapper=>tag_wrapper, :labeler=>tag_labeler, :error=>nil, :error_attr=>nil)
+        label_attr = attrs[:label_attr] || {:class=>:option}
+        label_attr = label_attr.merge(tag_label_attr) if tag_label_attr
+        r_opts = attrs.merge(tag_attrs).merge!(:label=>label||value, :label_attr=>label_attr, :wrapper=>tag_wrapper, :labeler=>tag_labeler, :error=>nil, :error_attr=>nil, :parent=>self)
         if r_opts[:value].nil?
           r_opts[:value] = value unless value.nil?
         end
@@ -579,7 +579,7 @@ module Forme
       when String
         text = text.gsub(/\A[\r\n]+|[\r\n]+\z/, '').split(/(?:\r?\n)(?:\r?\n)+/).map do |t|
           t = Forme.h(t)
-          t.gsub!(/\r?\n/, "<br />")
+          t.gsub!(/\r?\n/, "<br>")
           tag(:p, {}, Forme.raw(t))
         end
       end

data/lib/forme/transformers/labeler.rb

@@ -50,16 +50,7 @@ module Forme
     # :label_for option is used, the label created will not be
     # associated with an input.
     def call(tag, input)
-      unless id = input.opts[:id]
-        if key = input.opts[:key]
-          namespaces = input.form_opts[:namespace]
-          id = "#{namespaces.join('_')}#{'_' unless namespaces.empty?}#{key}"
-          if key_id = input.opts[:key_id]
-            id += "_#{key_id.to_s}"
-          end
-        end
-      end
-
+      id = id_for_input(input)
       label_attr = input.opts[:label_attr]
       label_attr = label_attr ? label_attr.dup : {}
       label_attr[:for] ||= input.opts.fetch(:label_for, id)
@@ -76,6 +67,23 @@ module Forme
 
       t
     end
+
+    private
+
+    # Determine the appropriate id for the input, to use in the for attribute
+    def id_for_input(input)
+      unless id = input.opts[:id]
+        if key = input.opts[:key]
+          namespaces = input.form_opts[:namespace]
+          id = "#{namespaces.join('_')}#{'_' unless namespaces.empty?}#{key}"
+          if key_id = input.opts[:key_id]
+            id += "_#{key_id.to_s}"
+          end
+        end
+      end
+
+      id
+    end
   end
 
   class Labeler::Span

data/lib/forme/transformers/serializer.rb

@@ -19,8 +19,8 @@ module Forme
     def call(tag)
       case tag
       when Tag
-        if SELF_CLOSING.include?(tag.type)
-          "<#{tag.type}#{attr_html(tag.attr)}/>"
+        if self_closing_tag?(tag.type)
+          "<#{tag.type}#{attr_html(tag.attr)}>"
         else
           "#{serialize_open(tag)}#{call(tag.children)}#{serialize_close(tag)}"
         end
@@ -79,6 +79,12 @@ module Forme
       attr = attr.to_a.reject{|k,v| v.nil?}
       " #{attr.map{|k, v| "#{k}=\"#{attr_value(v)}\""}.sort.join(' ')}" unless attr.empty?
     end
+
+    # Return whether the tag is self closing. this can be overridden in subclasses
+    # to make additional types self closing.
+    def self_closing_tag?(type)
+      SELF_CLOSING.include?(type)
+    end
   end
 
   # Overrides formatting of dates and times to use an American format without
@@ -94,7 +100,7 @@ module Forme
           attr.delete(:type)
           attr.delete('type')
           attr['type'] = 'text'
-          "<#{tag.type}#{attr_html(attr)}/>"
+          "<#{tag.type}#{attr_html(attr)}>"
         else
           super
         end

data/lib/forme/version.rb

@@ -6,7 +6,7 @@ module Forme
   MAJOR = 2
 
   # The minor version of Forme, updated for new feature releases of Forme.
-  MINOR = 6
+  MINOR = 7
 
   # The patch version of Forme, updated only for bug fixes from the last
   # feature release.

data/lib/sequel/plugins/forme.rb

@@ -223,7 +223,7 @@ module Sequel # :nodoc:
         # is required.
         def handle_label(f)
           opts[:label] = humanize(field) unless opts.has_key?(:label)
-          opts[:label] = [opts[:label], form._tag(:abbr, {:title=>'required'}, '*')] if opts[:label] && opts[:required] && obj.forme_use_required_abbr?
+          opts[:label] = [opts[:label], form._tag(:abbr, {:title=>obj.forme_required_abbr_title}, '*')] if opts[:label] && opts[:required] && obj.forme_use_required_abbr?
         end
 
         # Update the attributes and options for any recognized validations
@@ -508,6 +508,11 @@ module Sequel # :nodoc:
           'post'
         end
 
+        # The content of the title attribute of the abbr tag included in labels that are required.
+        def forme_required_abbr_title
+          'required'
+        end
+
         # Whether to set an abbr tag in labels for required inputs.
         def forme_use_required_abbr?
           true

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: forme
 version: !ruby/object:Gem::Version
-  version: 2.6.0
+  version: 2.7.0
 platform: ruby
 authors:
 - Jeremy Evans
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-18 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bigdecimal
@@ -176,9 +175,9 @@ email: code@jeremyevans.net
 executables: []
 extensions: []
 extra_rdoc_files:
-- README.rdoc
 - CHANGELOG
 - MIT-LICENSE
+- README.rdoc
 files:
 - CHANGELOG
 - MIT-LICENSE
@@ -218,7 +217,6 @@ metadata:
   documentation_uri: http://forme.jeremyevans.net
   mailing_list_uri: https://github.com/jeremyevans/forme/discussions
   source_code_uri: https://github.com/jeremyevans/forme
-post_install_message:
 rdoc_options:
 - "--quiet"
 - "--line-numbers"
@@ -240,8 +238,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.9
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: HTML forms library
 test_files: []