labelled_form 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38262f7dcfe077ea7678b0f28e01a3baacb4bf0e1fed446f3c87ab3b07803b6e
-  data.tar.gz: e03071200fdf6bf0858f08cc7d7f0bc45d273dc9070245dc356973327252bcc0
+  metadata.gz: e8726fb2089a7a687b5975773e7992cedc323e955b87db3d1e236fb1791cba33
+  data.tar.gz: 0e9b1cd1b765656dc8bc00f7895fca70c1c4fa5154cc81d7b8d74c163d643812
 SHA512:
-  metadata.gz: 4566ed311aad19b51a3ced101f045c56ada1c66c5753b961841418e81385e81058318fe216bf08fd64731e7530b7588ff6ac1bd760991cd40697f22eb3d13f64
-  data.tar.gz: 2b28af8ff3b88b78d960f55dafab2ae882e3973ff45b82db99d4355635587627eaad96e88071564da1dd76a23af5ed58cc00d05ea3a04be70da29663d5f00f27
+  metadata.gz: 3c3c559e1401e7c0f242f5ac0da78a026478a6da08734a9153ae36c4d4dcdcd516e30b891cc8e928c02d5157f48438c6efd025b4275a7ad91958a0866673dc1c
+  data.tar.gz: 343fa9c7add0f5100e8d1d32e26e00b657ef500814c8238ca528af6382fb526a44f0037f274c5cbd19a37a80137ebec14c395f97eb3c88ecbfc8298cff210569

data/README.md

@@ -7,29 +7,43 @@ Adds `label:` option to Rails form helpers.
 Works like you'd expect, or at least, works like I'd expect! Examples:
 
 ```ruby
-form_with :user do |form|
+= form_with :user do |form|
 
   # Prepends label to field and infers label text
-  form.text_field :email, label: true
+  = form.text_field :email, label: true
   # <label for="user_email">Email</label>
   # <input type="text" name="user[email]" id="user_email">
 
   # Supports specifying different label text
-  form.text_field :name, label: "Full name"
+  = form.text_field :name, label: "Full name"
   # <label for="user_name">Full name</label>
   # <input type="text" name="user[name]" id="user_name">
 
   # Appends label to field for radio buttons and checkboxes
-  form.radio_button :gender, "Male", label: true
+  = form.radio_button :gender, "Male", label: true
   # <input type="radio" name="user[gender]" value="Male" id="user_gender_male">
   # <label for="user_gender_male">Male</label>
 
+  # Specify label class
+  = form.text_field :email, label_class: "hidden"
+  # <label for="user_email" class="hidden">Email</label>
+  # <input type="text" name="user[email]" id="user_email">
+
+  # Append colon to label
+  = form.text_field :email, label_with_colon: true
+  # <label for="user_email">Email:</label>
+  # <input type="text" name="user[email]" id="user_email">
+
+  # Wrap whole thing in a <dfn>
+  = form.text_field :email, wrap_in_dfn: true
+  # <dfn>
+  #   <dt><label for="user_email">Email</label></dt>
+  #   <dd><input type="text" name="user[email]" id="user_email"></dd>
+  # </dfn>
+
 end
 ```
 
-## Todo
-Figure out how to support options for the label tag, like `class:` and, uh, idk, other stuff. Maybe just pass options hash directly to `label:`? Maybe just start with additional `label_class:` option? Is there any other potential option for e.g. `form.label` we would care about? Probably should just cross this bridge when we get to it.
-
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/botandrose/labelled_form.
@@ -37,3 +51,4 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/botand
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+

data/lib/labelled_form/version.rb

@@ -1,3 +1,3 @@
 module LabelledForm
-  VERSION = "0.2.3"
+  VERSION = "0.3.0"
 end

data/lib/labelled_form.rb

@@ -9,72 +9,143 @@ module LabelledForm
   end if defined?(Rails)
 
   class Builder < ActionView::Helpers::FormBuilder
-    def text_area method, options = {}
-      if label_text = options.delete(:label)
-        label_text = method.to_s.humanize if label_text === true
-        label(method, label_text) + " ".html_safe + super
+    def with_label method, options
+      wrap_in_dfn = options.delete(:wrap_in_dfn)
+      label_class = options.delete(:label_class)
+      label_with_colon = options.delete(:label_with_colon)
+      label_text = options.delete(:label) || label_class.present? || label_with_colon
+
+      label_text = method.to_s.humanize if label_text === true
+      label_text&.sub!(/_id$/,"")
+      label_text << ":" if label_with_colon && !label_text.ends_with?(":")
+
+      field_html = yield
+
+      if label_text
+        if wrap_in_dfn
+          @template.tag.dfn do
+            @template.tag.dt(label(method, label_text, class: label_class)) +
+              @template.tag.dd(field_html)
+          end
+        else
+          label(method, label_text, class: label_class) + " ".html_safe + field_html
+        end
       else
+        field_html
+      end
+    end
+
+    def text_area method, options = {}
+      with_label(method, options) do
         super
       end
     end
 
     def date_field method, options = {}
-      if label_text = options.delete(:label)
-        label_text = method.to_s.humanize if label_text === true
-        label(method, label_text) + " ".html_safe + super
-      else
+      with_label(method, options) do
+        super
+      end
+    end
+
+    def phone_field method, options = {}
+      with_label(method, options) do
         super
       end
     end
 
     def email_field method, options = {}
-      if label_text = options.delete(:label)
-        label_text = method.to_s.humanize if label_text === true
-        label(method, label_text) + " ".html_safe + super
-      else
+      with_label(method, options) do
+        super
+      end
+    end
+
+    def url_field method, options = {}
+      with_label(method, options) do
         super
       end
     end
 
     def text_field method, options = {}
-      if label_text = options.delete(:label)
-        label_text = method.to_s.humanize if label_text === true
-        label(method, label_text) + " ".html_safe + super
-      else
+      with_label(method, options) do
         super
       end
     end
 
     def file_field method, options = {}
-      if label_text = options.delete(:label)
-        label_text = method.to_s.humanize if label_text === true
-        label(method, label_text) + " ".html_safe + super
-      else
+      with_label(method, options) do
+        super
+      end
+    end
+
+    def select(method, choices = nil, options = {}, html_options = {}, &block)
+      label_options = (options.keys & %i[wrap_in_dfn label_class label_with_colon label]).any? ? options : html_options
+      with_label(method, label_options) do
+        super
+      end
+    end
+
+    def collection_select(method, collection, value_method, text_method, options = {}, html_options = {})
+      label_options = (options.keys & %i[wrap_in_dfn label_class label_with_colon label]).any? ? options : html_options
+      with_label(method, label_options) do
+        super
+      end
+    end
+
+    def number_field method, options = {}
+      with_label(method, options) do
         super
       end
     end
 
     def radio_button(method, tag_value, options = {})
+      options = options.dup
       label_text = options.delete(:label)
+      label_class = options.delete(:label_class)
       super.tap do |out|
         if label_text
           label_text = tag_value if label_text === true
           out << " ".html_safe
-          out << label(method, label_text, value: tag_value)
+          out << label(method, label_text, value: tag_value, class: label_class)
         end
       end
     end
 
     def check_box(method, options = {}, checked_value = "1", unchecked_value = "0")
+      options = options.dup
       label_text = options.delete(:label)
+      label_class = options.delete(:label_class)
       super.tap do |out|
         if label_text
           label_text = checked_value == "1" ? nil : checked_value if label_text === true
           out << " ".html_safe
           label_options = options[:multiple] ? { value: checked_value } : {}
-          out << label(method, label_text, label_options)
+          out << label(method, label_text, label_options.merge(class: label_class))
         end
       end
     end
+
+    def multiple_check_box method, value, options={}
+      options = options.dup
+      label_text = options.delete(:label)
+      label_class = options.delete(:label_class)
+      out = "".html_safe
+
+      if !multiple_check_box_fields.include?(method)
+        multiple_check_box_fields << method
+        out << hidden_field(method, value: "", multiple: true)
+      end
+
+      out << check_box(method, { multiple: true }.reverse_merge(options), value, nil)
+
+      if label_text
+        label_text = value == "1" ? nil : value if label_text === true
+        out << " ".html_safe
+        out << label(method, label_text, value: value, class: label_class)
+      end
+    end
+
+    private def multiple_check_box_fields
+      @multiple_check_box_fields ||= Set.new
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: labelled_form
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Micah Geisel
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-20 00:00:00.000000000 Z
+date: 2023-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -104,7 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Adds label option to Rails form helpers