felt 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4d4be91443885d47f5e5aea19104465367551d4e0ef2dc35b110519e84274da
-  data.tar.gz: 2ba284067b6227021c04bb7f40593acb8a57ec2b762e72fad3f5c077a16a2a29
+  metadata.gz: e4cee8afd69693c7c4ab5b113587fa54c63994ceb7e31b662d5c42d2205db328
+  data.tar.gz: 8dbefac39a252bc8ff50c24c3175309de8157d0184b82b4ef880f8263486c2a2
 SHA512:
-  metadata.gz: 5a3059fe1adc3287eebdd6812a91b80ce82b5f63fbfc9550cf36cd50bca630b0ca8724d1b4004b5e88f6ccef8c3e5d7098af682309c424c6f3d2f4e537c2bfbe
-  data.tar.gz: 8627ba5a61f4fd64d27c4982d95d0d4860dd6e2d9e74a940110f64fcba804e1c0cd0af426bb7d9daf34a1c8dfaf891f4b0d6ec140a143b544ecfcd6fea2509a2
+  metadata.gz: b7ebb4ad07dc4df0d0b1091af1066cb15e83fbf26dc3ced14a7331c59c1ad5198b679f912b6bf48dfb42782a8b23fb41fbe50e2065f3a9833c573734832b2491
+  data.tar.gz: c1956e71f6bbdda2716cf712fc1e80661b6a66cfb7e1586532febb767e9bc17db25a7724240c8a47ceaf6f52cdbae737d4b262c7212d61cb0b2552687ec7990f

data/lib/felt/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Felt
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/felt.rb

@@ -7,6 +7,9 @@ require_relative "input_group/checkbox_field"
 require_relative "input_group/email_field"
 require_relative "input_group/password_field"
 require_relative "input_group/text_field"
+require_relative "input_group/wrapper"
+require_relative "help"
+require_relative "hint"
 require_relative "label"
 
 module Felt

data/lib/help/help.html.erb

@@ -0,0 +1 @@
+<div class="<%= classes %>"><%= text %></div>

data/lib/help.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require "view_component"
+
+module Felt
+  # Renders a help element for a form input.
+  class Help < ViewComponent::Base
+    attr_reader :attribute, :form, :options
+
+    # Returns the classes to use for the help element
+    def classes
+      @classes ||
+        Felt.configuration.classes.dig(:help, :default, :default)
+    end
+
+    # - classes: Classes to add to the help element.
+    #
+    # - text: The help text to show. If not provided, the text will be looked up
+    #   in the `forms.<object_name>.<attribute>` translation. See #help for more
+    #   details. To disable the help, pass an empty string.
+    #
+    # All remaining keyword arguments are passed to the help element. See
+    # ActionView::Helpers::FormBuilder#help for details.
+    def initialize(attribute:, form:, classes: nil, text: nil, **options)
+      @attribute = attribute
+      @classes = classes
+      @form = form
+      @text = text
+      @options = options
+    end
+
+    def render?
+      text.present?
+    end
+
+    # Returns the text to render in the help. If no text is configured, returns
+    # nil.
+    #
+    # Help texts are looked up in the following order:
+    #
+    # 1. The text argument passed to the component.
+    # 2. The `help` key in the `forms.<object_name>.<attribute>` translation.
+    # 3. The translation value found under
+    #    `helpers.help.<modelname>.<attribute>` (like with
+    #    ActionView::Helpers::FormBuilder#help).
+    def text
+      @text ||= translate("help")
+    end
+
+    # Returns true if the input group has a help text configured
+    def text?
+      text.present?
+    end
+
+    private
+
+    def translate(key)
+      I18n.translate(key, default: nil, scope: translation_scope)
+    end
+
+    def translation_scope
+      [:forms, form.object_name, attribute].join(".")
+    end
+  end
+end

data/lib/hint/hint.html.erb

@@ -0,0 +1 @@
+<div class="<%= classes %>"><%= text %></div>

data/lib/hint.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require "view_component"
+
+module Felt
+  # Renders a hint element for a form input.
+  class Hint < ViewComponent::Base
+    attr_reader :attribute, :form, :options
+
+    # Returns the classes to use for the hint element
+    def classes
+      @classes ||
+        Felt.configuration.classes.dig(:hint, :default, :default)
+    end
+
+    # - classes: Classes to add to the hint element.
+    #
+    # - text: The hint text to show. If not provided, the text will be
+    #   looked up in the `forms.<object_name>.<attribute>` translation. See
+    #   #hint for more details. To disable the hint, pass an empty string.
+    #
+    # All remaining keyword arguments are passed to the hint element. See
+    # ActionView::Helpers::FormBuilder#hint for details.
+    def initialize(attribute:, form:, classes: nil, text: nil, **options)
+      @attribute = attribute
+      @classes = classes
+      @form = form
+      @text = text
+      @options = options
+    end
+
+    def render?
+      text.present?
+    end
+
+    # Returns the text to render in the hint. If no text is configured, returns
+    # nil.
+    #
+    # Hint texts are looked up in the following order:
+    #
+    # 1. The text argument passed to the component.
+    # 2. The `hint` key in the `forms.<object_name>.<attribute>` translation.
+    # 3. The translation value found under
+    #    `helpers.hint.<modelname>.<attribute>` (like with
+    #    ActionView::Helpers::FormBuilder#hint).
+    def text
+      @text ||= translate("hint")
+    end
+
+    # Returns true if the input group has a hint text configured
+    def text?
+      text.present?
+    end
+
+    private
+
+    def translate(key)
+      I18n.translate(key, default: nil, scope: translation_scope)
+    end
+
+    def translation_scope
+      [:forms, form.object_name, attribute].join(".")
+    end
+  end
+end

data/lib/input_group/base.rb

@@ -11,7 +11,12 @@ module Felt
 
       # Returns the classes to use for the root element of the input.
       def classes
-        classes_from_configuration(:input_group, self.class.config_key)
+        @classes ||
+          classes_from_configuration(:input_group, config_key)
+      end
+
+      def config_key
+        raise "Must be implemented in a subclass"
       end
 
       # Returns the error messages to output in the input group. Returns [] if no
@@ -32,7 +37,7 @@ module Felt
 
       # Returns the classes to use for the help text.
       def error_classes
-        classes_from_configuration(:error, self.class.config_key, state_key) ||
+        classes_from_configuration(:error, config_key, state_key) ||
           classes_from_configuration(:error, :default, state_key)
       end
 
@@ -55,7 +60,7 @@ module Felt
 
       # Returns the classes to use for the help text.
       def help_classes
-        classes_from_configuration(:help, self.class.config_key, state_key) ||
+        classes_from_configuration(:help, config_key, state_key) ||
           classes_from_configuration(:help, :default, state_key)
       end
 
@@ -77,10 +82,12 @@ module Felt
 
       # Returns the classes to use for the hint text.
       def hint_classes
-        classes_from_configuration(:hint, self.class.config_key, state_key) ||
+        classes_from_configuration(:hint, config_key, state_key) ||
           classes_from_configuration(:hint, :default, state_key)
       end
 
+      # - classes: CSS classes to add to the wrapping input group element.
+      #
       # - hint: The hint for the input group. If not provided, the hint will be
       #   looked up in the `forms.<object_name>.<attribute>` translation. See
       #   #hint for more details. To disable the hint, pass an empty string.
@@ -100,8 +107,9 @@ module Felt
       # All remaining keyword arguments are passed to the wrapping div element
       # of the input group. See ActionView::Helpers::TagHelper#content_tag for
       # details.
-      def initialize(attribute:, form:, help: nil, hint: nil, input_options: {}, label: nil, placeholder: nil, **options)
+      def initialize(attribute:, form:, classes: nil, help: nil, hint: nil, input_options: {}, label: nil, placeholder: nil, **options)
         @attribute = attribute
+        @classes = classes
         @form = form
         @help = help
         @hint = hint
@@ -113,13 +121,13 @@ module Felt
 
       # Returns the classes to use for the input field.
       def input_classes
-        classes_from_configuration(:input, self.class.config_key, state_key) ||
+        classes_from_configuration(:input, config_key, state_key) ||
           classes_from_configuration(:input, :default, state_key)
       end
 
       # Returns the classes to use for the label field.
       def label_classes
-        classes_from_configuration(:label, self.class.config_key, state_key) ||
+        classes_from_configuration(:label, config_key, state_key) ||
           classes_from_configuration(:label, :default, state_key)
       end
 

data/lib/input_group/checkbox_field/checkbox_field.html.erb

@@ -1,5 +1,5 @@
 <%= content_tag(:div, :class => classes, **options) do %>
-  <% if hint? %><div class="<%= hint_classes %>"><%= hint %></div><% end %>
+  <%= render(Felt::Hint.new(:form => form, :attribute => attribute, :classes => hint_classes, :text => hint)) %>
   <div class="flex">
     <div class="flex items-center h-5">
       <%= form.check_box(attribute, :class => input_classes, :placeholder => placeholder, **input_options) %>

data/lib/input_group/checkbox_field.rb

@@ -9,10 +9,8 @@ module Felt
     #
     # The hint text is optional and is rendered before the checkbox.
     class CheckboxField < InputGroup::Base
-      class << self
-        def config_key
-          :checkbox_field
-        end
+      def config_key
+        :checkbox_field
       end
     end
   end

data/lib/input_group/email_field/email_field.html.erb

@@ -1,9 +1,3 @@
-<%= content_tag(:div, :class => classes, **options) do %>
-  <%= render(Felt::Label.new(:form => form, :attribute => attribute, :classes => label_classes, :text => label)) %>
-  <% if hint? %><div class="<%= hint_classes %>"><%= hint %></div><% end %>
+<%= render(Felt::InputGroup::Wrapper.new(attribute: attribute, classes: classes, config_key: config_key, form: form, help: help, hint: hint, input_options: input_options, label: label, placeholder: placeholder, **options)) do %>
   <%= form.email_field(attribute, :class => input_classes, :placeholder => placeholder, **input_options) %>
-  <% if help? %><div class="<%= help_classes %>"><%= help %></div><% end %>
-  <% errors.each do |error| %>
-    <p class="<%= error_classes %>"><%= error %></p>
-  <% end %>
 <% end %>

data/lib/input_group/email_field.rb

@@ -5,10 +5,8 @@ require "input_group/base"
 module Felt
   module InputGroup
     class EmailField < InputGroup::Base
-      class << self
-        def config_key
-          :email_field
-        end
+      def config_key
+        :email_field
       end
     end
   end

data/lib/input_group/password_field/password_field.html.erb

@@ -1,6 +1,6 @@
 <%= content_tag(:div, :class => classes, **options) do %>
   <%= render(Felt::Label.new(:form => form, :attribute => attribute, :classes => label_classes, :text => label)) %>
-  <% if hint? %><div class="<%= hint_classes %>"><%= hint %></div><% end %>
+  <%= render(Felt::Hint.new(:form => form, :attribute => attribute, :classes => hint_classes, :text => hint)) %>
   <%= form.password_field(attribute, :class => input_classes, :placeholder => placeholder, **input_options) %>
   <% if help? %><div class="<%= help_classes %>"><%= help %></div><% end %>
   <% errors.each do |error| %>

data/lib/input_group/password_field.rb

@@ -8,10 +8,8 @@ module Felt
     # field is blank by default; pass in a value via options if this is not
     # desired.
     class PasswordField < InputGroup::Base
-      class << self
-        def config_key
-          :password_field
-        end
+      def config_key
+        :password_field
       end
     end
   end

data/lib/input_group/text_field/text_field.html.erb

@@ -1,9 +1,3 @@
-<%= content_tag(:div, :class => classes, **options) do %>
-  <%= render(Felt::Label.new(:form => form, :attribute => attribute, :classes => label_classes, :text => label)) %>
-  <% if hint? %><div class="<%= hint_classes %>"><%= hint %></div><% end %>
+<%= render(Felt::InputGroup::Wrapper.new(attribute: attribute, classes: classes, config_key: config_key, form: form, help: help, hint: hint, input_options: input_options, label: label, placeholder: placeholder, **options)) do %>
   <%= form.text_field(attribute, :class => input_classes, :placeholder => placeholder, **input_options) %>
-  <% if help? %><div class="<%= help_classes %>"><%= help %></div><% end %>
-  <% errors.each do |error| %>
-    <p class="<%= error_classes %>"><%= error %></p>
-  <% end %>
 <% end %>

data/lib/input_group/text_field.rb

@@ -5,10 +5,8 @@ require "input_group/base"
 module Felt
   module InputGroup
     class TextField < InputGroup::Base
-      class << self
-        def config_key
-          :text_field
-        end
+      def config_key
+        :text_field
       end
     end
   end

data/lib/input_group/wrapper/wrapper.html.erb

@@ -0,0 +1,9 @@
+<%= content_tag(:div, :class => classes, **options) do %>
+  <%= render(Felt::Label.new(:form => form, :attribute => attribute, :classes => label_classes, :text => label)) %>
+  <%= render(Felt::Hint.new(:form => form, :attribute => attribute, :classes => hint_classes, :text => hint)) %>
+  <%= content %>
+  <%= render(Felt::Help.new(:form => form, :attribute => attribute, :classes => help_classes, :text => help)) %>
+  <% errors.each do |error| %>
+    <p class="<%= error_classes %>"><%= error %></p>
+  <% end %>
+<% end %>

data/lib/input_group/wrapper.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "input_group/base"
+
+module Felt
+  module InputGroup
+    # Encapsulates the common functionality of all input groups.
+    #
+    # Renders a wrapping div containing a label, a hint, an input field, a help
+    # element, and a list of errors.
+    #
+    # Pass the input field as a block to the constructor.
+    class Wrapper < Base
+      attr_reader :config_key
+
+      def initialize(config_key: nil, **args)
+        @config_key = config_key
+        super(**args)
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: felt
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Jakob Skjerning
@@ -51,6 +51,10 @@ files:
 - lib/felt.rb
 - lib/felt/configuration.rb
 - lib/felt/version.rb
+- lib/help.rb
+- lib/help/help.html.erb
+- lib/hint.rb
+- lib/hint/hint.html.erb
 - lib/input_group/base.rb
 - lib/input_group/checkbox_field.rb
 - lib/input_group/checkbox_field/checkbox_field.html.erb
@@ -60,6 +64,8 @@ files:
 - lib/input_group/password_field/password_field.html.erb
 - lib/input_group/text_field.rb
 - lib/input_group/text_field/text_field.html.erb
+- lib/input_group/wrapper.rb
+- lib/input_group/wrapper/wrapper.html.erb
 - lib/label.rb
 - lib/label/label.html.erb
 homepage: https://github.com/substancelab/felt