shoelace-rails 0.5.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4e0b7daab9653d58867634fed2dffbf3455c06cd47f084271650507b68128cdb
-  data.tar.gz: d92ddd6a16d38a0dad1eecfc193534365fb1da246c0ad9a54d09e39d28f7f073
+  metadata.gz: 220b7683429f052cb711bac68076e05f812a19c7857864e66bc3863ca5740b78
+  data.tar.gz: 3947f8255bdb9a41d7faee272b77e356a78a233719b8e2b1d15e4bc814668fe1
 SHA512:
-  metadata.gz: bb8b38ff8c3d03f12ebc72eb85cfe24fe108ba0838054e8878a439fc63083c1fc53be4d507b090da7d67daba440ae09a5cc855e4dcb008382930b0d11d15275c
-  data.tar.gz: 62faa8f43c33c0c2f5d7690368b4b4694de05d8e7c3f68467f1716757d6f08b26bdd4da8ce252087c68e5b79500ef5016866cacb459f28468148e73e4b0ea3da
+  metadata.gz: '039b7be7a76bd89494cc7a95fab19d702c2ec87fc49f35dd6d19a88c7cc2ef0ebc1867d499a0e71b59044421d0199efed9b42417b1d8f38d3513157d5eebaf94'
+  data.tar.gz: fc32460b9adadafdf3bc35be7bf8c360a2e9dd5d2645edad50f9f7efeb420275ce2be57df4f3653b88efaf3254686a158b06b512d2201079cae661fade8c0419

data/CHANGELOG.md

@@ -1,13 +1,27 @@
-## v0.5.0
+## v0.6.1
 
-_<sup>released at 2023-03-21 04:03:27 UTC</sup>_
+#### 🐞Bug Fixes
+
+- Fixes a bug where form builders fail to render wtih a string `:as` option
+
+## [v0.6.0](https://github.com/yuki24/shoelace-rails/tree/v0.6.0)
+
+_<sup>released at 2024-03-13 02:54:02 UTC</sup>_
+
+#### ⭐️ Features
+
+- Add the ability to use translations with form helpers ([<tt>626f271</tt>](https://github.com/yuki24/shoelace-rails/commit/626f271ca710dd48040907ff6a99e3bba6c5d57c))
+
+## [v0.5.0](https://github.com/yuki24/shoelace-rails/tree/v0.5.0)
+
+_<sup>released at 2024-03-09 08:54:30 UTC</sup>_
 
 #### ⭐️ Features
 
-- Add support for Ruby 3.3 (`399f25567f964d0ea2e250eba6db28a2bcd038a3`)
-- Add support for Rails 7.1 (#4)
-- Add `#grouped_collection_select` (`2b91023d51e1d0a218f2102232241afa82aaf872`)
-- Make the `<sl-radio>` form helpers compatible with Shoelace [2.0.0-beta.80](https://shoelace.style/resources/changelog#id_2_0_0-beta_80) and above (`ef9a8345f2c5c921847aef15e19cf64a471d6473`)
+- Add support for Ruby 3.3 ([<tt>399f255</tt>](https://github.com/yuki24/shoelace-rails/commit/399f25567f964d0ea2e250eba6db28a2bcd038a3))
+- Add support for Rails 7.1 ([#4](https://github.com/yuki24/shoelace-rails/pull/4))
+- Add `#grouped_collection_select` ([<tt>2b91023</tt>](https://github.com/yuki24/shoelace-rails/commit/2b91023d51e1d0a218f2102232241afa82aaf872))
+- Make the `<sl-radio>` form helpers compatible with Shoelace [2.0.0-beta.80](https://shoelace.style/resources/changelog#id_2_0_0-beta_80) and above ([<tt>ef9a834</tt>](https://github.com/yuki24/shoelace-rails/commit/ef9a8345f2c5c921847aef15e19cf64a471d6473))
 
 ## [v0.4.1](https://github.com/yuki24/shoelace-rails/tree/v0.4.1)
 

data/app/helpers/shoelace/form_helper.rb

@@ -57,8 +57,9 @@ module Shoelace
         options = @options.stringify_keys
         options["value"] = options.fetch("value") { value_before_type_cast }
         add_default_name_and_id(options)
+        label = options.delete('label').presence || @method_name.humanize
 
-        @template_object.content_tag('sl-switch', @method_name.to_s.humanize, options, &block)
+        @template_object.content_tag('sl-switch', label, options, &block)
       end
     end
 
@@ -123,6 +124,7 @@ module Shoelace
         options = @options.stringify_keys
         options["value"]   = @checked_value
         options["checked"] = true if input_checked?(options)
+        label = options.delete("label") || @method_name.humanize
 
         if options["multiple"]
           add_default_name_and_id_for_value(@checked_value, options)
@@ -136,7 +138,7 @@ module Shoelace
         sl_checkbox_tag = if block_given?
                             @template_object.content_tag('sl-checkbox', '', options, &block)
                           else
-                            @template_object.content_tag('sl-checkbox', @method_name.to_s.humanize, options)
+                            @template_object.content_tag('sl-checkbox', label || @method_name.to_s.humanize, options)
                           end
 
         if include_hidden
@@ -181,8 +183,9 @@ module Shoelace
         html_options = @html_options.stringify_keys
         html_options["value"] = value
         add_default_name_and_id(html_options)
+        html_options["label"] = @options[:label].presence || @method_name.humanize
 
-        @template_object.content_tag('sl-radio-group', html_options.with_defaults(label: @method_name.humanize)) { super(&block) }
+        @template_object.content_tag('sl-radio-group', html_options) { super(&block) }
       end
 
       def hidden_field
@@ -206,52 +209,56 @@ module Shoelace
         url: :url
       }.each do |field_type, field_class|
         # def email_field(method, **options, &block)
-        #   ShoelaceInputField.new(:email, object_name, method, @template, options.with_defaults(label: method.to_s.humanize)).render(&block)
+        #   ShoelaceInputField.new(:email, object_name, method, @template, options.with_defaults(label: label_text(method))).render(&block)
         # end
         eval <<-RUBY, nil, __FILE__, __LINE__ + 1
           def #{field_type}_field(method, **options, &block)
-            ShoelaceInputField.new(:#{field_class}, object_name, method, @template, options.with_defaults(object: @object, label: method.to_s.humanize)).render(&block)
+            ShoelaceInputField.new(:#{field_class}, object_name, method, @template, options.with_defaults(object: @object, label: label_text(method))).render(&block)
           end
         RUBY
       end
 
       def color_field(method, **options)
-        ShoelaceColorPicker.new(object_name, method, @template, options.with_defaults(object: @object)).render
+        ShoelaceColorPicker.new(object_name, method, @template, options.with_defaults(object: @object, label: label_text(method))).render
       end
       alias color_picker color_field
 
       def range_field(method, **options)
-        ShoelaceRange.new(object_name, method, @template, options.with_defaults(object: @object, label: method.to_s.humanize)).render
+        ShoelaceRange.new(object_name, method, @template, options.with_defaults(object: @object, label: label_text(method))).render
       end
       alias range range_field
 
       def switch_field(method, **options, &block)
-        ShoelaceSwitch.new(object_name, method, @template, options.with_defaults(object: @object)).render(&block)
+        if block_given?
+          ShoelaceSwitch.new(object_name, method, @template, options.with_defaults(object: @object)).render(&block)
+        else
+          ShoelaceSwitch.new(object_name, method, @template, options.with_defaults(object: @object, label: label_text(method))).render(&block)
+        end
       end
       alias switch switch_field
 
       def text_area(method, **options, &block)
-        ShoelaceTextArea.new(object_name, method, @template, options.with_defaults(object: @object, label: method.to_s.humanize, resize: 'auto')).render(&block)
+        ShoelaceTextArea.new(object_name, method, @template, options.with_defaults(object: @object, label: label_text(method), resize: 'auto')).render(&block)
       end
 
       def check_box(method, options = {}, checked_value = "1", unchecked_value = "0", &block)
-        ShoelaceCheckBox.new(object_name, method, @template, checked_value, unchecked_value, options.merge(object: @object)).render(&block)
+        ShoelaceCheckBox.new(object_name, method, @template, checked_value, unchecked_value, options.with_defaults(label: label_text(method)).merge(object: @object)).render(&block)
       end
 
       def select(method, choices = nil, options = {}, html_options = {}, &block)
-        ShoelaceSelect.new(object_name, method, @template, choices, options.with_defaults(object: @object), html_options.with_defaults(label: method.to_s.humanize), &block).render
+        ShoelaceSelect.new(object_name, method, @template, choices, options.with_defaults(object: @object), html_options.with_defaults(label: label_text(method)), &block).render
       end
 
       def collection_select(method, collection, value_method, text_method, options = {}, html_options = {}, &block)
-        ShoelaceCollectionSelect.new(object_name, method, @template, collection, value_method, text_method, options.with_defaults(object: @object), html_options.with_defaults(label: method.to_s.humanize), &block).render
+        ShoelaceCollectionSelect.new(object_name, method, @template, collection, value_method, text_method, options.with_defaults(object: @object), html_options.with_defaults(label: label_text(method)), &block).render
       end
 
       def grouped_collection_select(method, collection, group_method, group_label_method, option_key_method, option_value_method, options = {}, html_options = {})
-        ShoelaceGroupedCollectionSelect.new(object_name, method, @template, collection, group_method, group_label_method, option_key_method, option_value_method, options.with_defaults(object: @object), html_options.with_defaults(label: method.to_s.humanize)).render
+        ShoelaceGroupedCollectionSelect.new(object_name, method, @template, collection, group_method, group_label_method, option_key_method, option_value_method, options.with_defaults(object: @object), html_options.with_defaults(label: label_text(method))).render
       end
 
       def collection_radio_buttons(method, collection, value_method, text_method, options = {}, html_options = {}, &block)
-        ShoelaceCollectionRadioButtons.new(object_name, method, @template, collection, value_method, text_method, options.with_defaults(object: @object), html_options).render(&block)
+        ShoelaceCollectionRadioButtons.new(object_name, method, @template, collection, value_method, text_method, options.with_defaults(object: @object, label: label_text(method)), html_options).render(&block)
       end
 
       def submit(value = nil, options = {})
@@ -259,6 +266,12 @@ module Shoelace
 
         @template.sl_submit_tag(value || submit_default_value, **options)
       end
+
+      private
+
+      def label_text(method, tag_value = nil)
+        ::ActionView::Helpers::Tags::Label::LabelBuilder.new(@template, object_name.to_s, method, object, tag_value).translation
+      end
     end
 
     DEFAULT_FORM_PARAMETERS = { builder: ShoelaceFormBuilder }

data/lib/shoelace/rails/version.rb

@@ -2,6 +2,6 @@
 
 module Shoelace
   module Rails
-    VERSION = "0.5.0"
+    VERSION = "0.6.1"
   end
 end

data/test/helpers/form_helper_test.rb

@@ -149,7 +149,7 @@ class FormHelperTest < ActionView::TestCase
   test "#color_field" do
     sl_form_for(User.new, url: "/") do |form|
       assert_dom_equal <<~HTML, form.color_field(:name)
-        <sl-color-picker name="user[name]" id="user_name"></sl-color-picker>
+        <sl-color-picker name="user[name]" id="user_name" label="Name"></sl-color-picker>
       HTML
     end
   end

data/test/helpers/translation_test.rb

@@ -0,0 +1,168 @@
+# frozen_string_literal: true
+require 'test_helper'
+
+require_relative '../../app/helpers/shoelace/form_helper'
+
+class TranslationTest < ActionView::TestCase
+  include ActionView::Helpers::TranslationHelper
+  include Shoelace::FormHelper
+
+  AUTOCOMPLETE_ATTRIBUTE = ActionView::VERSION::STRING >= '6.1.0' ? 'autocomplete="off"' : ''
+
+  setup do
+    I18n.backend.store_translations :en,
+                                    helpers: {
+                                      label: {
+                                        user: { name: "Full Name" }
+                                      }
+                                    }
+
+    view_paths = ActionController::Base.view_paths
+    view_paths.each(&:clear_cache)
+    @view = ::ActionView::Base.with_empty_template_cache.with_view_paths(view_paths, {})
+  end
+
+  teardown do
+    I18n.backend.reload!
+  end
+
+  test "Form helpers should respect label translations" do
+    sl_form_for(User.new, url: "/") do |form|
+      assert_dom_equal <<~HTML, form.text_field(:name)
+        <sl-input label="Full Name" type="text" name="user[name]" id="user_name"></sl-input>
+      HTML
+    end
+  end
+
+  test "Form helpers should cast symbol object names to String" do
+    sl_form_for(User.new, as: :user, url: "/") do |form|
+      assert_dom_equal <<~HTML, form.text_field(:name)
+        <sl-input label="Full Name" type="text" name="user[name]" id="user_name"></sl-input>
+      HTML
+    end
+  end
+
+  test "#color_field should respect label translations" do
+    sl_form_for(User.new, url: "/") do |form|
+      assert_dom_equal <<~HTML, form.color_field(:name)
+        <sl-color-picker name="user[name]" id="user_name" label="Full Name"></sl-color-picker>
+      HTML
+    end
+  end
+
+  test "#range_field should respect label translations" do
+    sl_form_for(User.new, url: "/") do |form|
+      assert_dom_equal <<~HTML, form.range_field(:name)
+        <sl-range label="Full Name" name="user[name]" id="user_name"></sl-range>
+      HTML
+    end
+  end
+
+  test "#switch_field should respect label translations" do
+    sl_form_for(User.new, url: "/") do |form|
+      assert_dom_equal <<~HTML, form.switch_field(:name)
+        <sl-switch name="user[name]" id="user_name">Full Name</sl-switch>
+      HTML
+    end
+  end
+
+  test "#text_area should respect label translations" do
+    sl_form_for(User.new, url: "/") do |form|
+      assert_dom_equal <<~HTML, form.text_area(:name)
+        <sl-textarea label="Full Name" resize="auto" name="user[name]" id="user_name"></sl-textarea>
+      HTML
+    end
+  end
+
+  test "#check_box should respect label translations" do
+    sl_form_for(User.new, url: "/") do |form|
+      assert_dom_equal <<~HTML, form.check_box(:name)
+        <input name="user[name]" type="hidden" value="0" #{AUTOCOMPLETE_ATTRIBUTE} />
+        <sl-checkbox value="1" name="user[name]" id="user_name">Full Name</sl-checkbox>
+      HTML
+    end
+  end
+
+  test "#selec should respect label translationst" do
+    users = {
+      "Yuki Nishijima" => 1,
+      "Matz" => 2,
+      "Koichi Sasada" => 3
+    }
+
+    sl_form_for(User.new, url: "/") do |form|
+      assert_dom_equal <<~HTML, form.select(:name, users)
+        <sl-select label="Full Name" name="user[name]" id="user_name">
+          <sl-option value="1">Yuki Nishijima</sl-option>
+          <sl-option value="2">Matz</sl-option>
+          <sl-option value="3">Koichi Sasada</sl-option>
+        </sl-select>
+      HTML
+    end
+  end
+
+  test "#collection_select should respect label translations" do
+    users = {
+      1 => "Yuki Nishijima",
+      2 => "Matz",
+      3 => "Koichi Sasada",
+    }
+
+    sl_form_for(User.new, url: "/") do |form|
+      assert_dom_equal <<~HTML, form.collection_select(:name, users, :first, :last)
+        <sl-select label="Full Name" name="user[name]" id="user_name">
+          <sl-option value="1">Yuki Nishijima</sl-option>
+          <sl-option value="2">Matz</sl-option>
+          <sl-option value="3">Koichi Sasada</sl-option>
+        </sl-select>
+      HTML
+    end
+  end
+
+  test "#grouped_collection_select should respect label translations" do
+    users = [
+      OpenStruct.new(
+        group_name: "Main maintainers",
+        members: [
+          OpenStruct.new(id: 1, name: "Matz"),
+          OpenStruct.new(id: 2, name: "Koichi Sasada"),
+        ]
+      ),
+      OpenStruct.new(
+        group_name: "Default gem maintainers",
+        members: [OpenStruct.new(id: 3, name: "Yuki Nishijima")]
+      ),
+    ]
+
+    sl_form_for(User.new(name: "2"), url: "/") do |form|
+      assert_dom_equal <<~HTML, form.grouped_collection_select(:name, users, :members, :group_name, :id, :name)
+        <sl-select label="Full Name" name="user[name]" id="user_name" value="2">
+          <small>Main maintainers</small>
+          <sl-option value="1">Matz</sl-option>
+          <sl-option value="2" checked="checked">Koichi Sasada</sl-option>
+          <sl-divider></sl-divider>
+          <small>Default gem maintainers</small>
+          <sl-option value="3">Yuki Nishijima</sl-option>
+        </sl-select>
+      HTML
+    end
+  end
+
+  test "#collection_radio_buttons should respect label translations" do
+    users = {
+      1 => "Yuki Nishijima",
+      2 => "Matz",
+      3 => "Koichi Sasada",
+    }
+
+    sl_form_for(User.new, url: "/") do |form|
+      assert_dom_equal <<~HTML, form.collection_radio_buttons(:name, users, :first, :last)
+        <sl-radio-group label="Full Name" name="user[name]" id="user_name">
+          <sl-radio value="1" id="user_name_1">Yuki Nishijima</sl-radio>
+          <sl-radio value="2" id="user_name_2">Matz</sl-radio>
+          <sl-radio value="3" id="user_name_3">Koichi Sasada</sl-radio>
+        </sl-radio-group>
+      HTML
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: shoelace-rails
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Yuki Nishijima
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-03-09 00:00:00.000000000 Z
+date: 2024-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionview
@@ -118,6 +118,7 @@ files:
 - shoelace-rails.gemspec
 - test/helpers/form_helper_test.rb
 - test/helpers/tag_helper_test.rb
+- test/helpers/translation_test.rb
 - test/test_helper.rb
 homepage: https://github.com/yuki24/shoelace-rails
 licenses: