vident 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba2054320ceb13a2646f5f88f4dcef219ad4a5482118f1245472b07d8848f313
-  data.tar.gz: 7e0af03ee04bc52c6b7f35cd0da6490116428581bae587249380df7c71c8d863
+  metadata.gz: e4d88cce5b38bd6e4c19016a7bad835cd25b8e4453284fc5795d039e7b48d145
+  data.tar.gz: f63eca71787e977e9204336b16f8cd32e3fa5c73ee88977ff3befdd8a5f8a33a
 SHA512:
-  metadata.gz: 8cd4c1933065215f12d8640a4274164ddb869f9b013891f6ef569293b84dbcafea761c8442ebee81c0656c3c2d0e560f7d7ee4a36b5390cba2bc2148d5bc62b0
-  data.tar.gz: bd3549f2eaf0157bea9b8489c2fc9ea83f71d11afa998b6a013ef65ea86ff4f41cbb39caafb94b4ea5049c00b36e3be3a3b67c3cb9ec24020f842cda85476523
+  metadata.gz: 3845320ed4eef3e3b3919ef970e93e9ed2c09332ccf14db2224b1d98402b43471e6a543690249fb42a64b52a50f35314f05844f460c702af60c5cc8cf0bc083a
+  data.tar.gz: d167a0e66951777bbde64f657d97e68804ca15bc6890604e0d4015d27a4ee4b17a252574f5e0dcd5cc9f9864929f20bc24ad5689f98e1c853b7cb4da36c293a7

data/CHANGELOG.md

@@ -0,0 +1,48 @@
+
+# Change Log
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+## [Unreleased]
+
+### Added
+
+### Changed
+
+### Fixed
+
+## [0.6.0] - 2023-02-20
+
+### Added
+
+- Experimental support for `better_html` in the root components (the stimulus attributes are generated with `html_attributes`)
+
+
+
+## [0.5.1] - 2023-02-17
+
+### Added
+
+- N/A
+
+### Changed
+
+- N/A
+
+### Fixed
+
+- Typed attributes was not always using custom coercion methods if they were defined 
+
+### Removed
+
+- N/A
+
+### Deprecated
+
+- N/A
+
+### Security
+
+- N/A

data/Gemfile

@@ -18,6 +18,7 @@ gem "stimulus-rails"
 gem "dry-struct"
 
 gem "phlex-rails"
+gem "better_html"
 
 # FIXME: versions greater than 2.74 cause issues: https://github.com/ViewComponent/view_component/pull/1571
 gem "view_component", "2.74.1"

data/lib/vident/attributes/typed.rb

@@ -61,9 +61,11 @@ if Gem.loaded_specs.has_key? "dry-struct"
           attr_reader :schema, :attribute_ivar_names
 
           def attribute(name, signature = :any, **options, &converter)
-            type_info = map_primitive_to_dry_type(signature, options, converter)
+            strict = !options[:convert]
+            signatures = extract_member_type_and_subclass(signature, options)
+            type_info = map_primitive_to_dry_type(signatures, strict, converter)
             type_info = set_constraints(type_info, options)
-            type_info = set_metadata(type_info, signature, options)
+            type_info = set_metadata(type_info, signatures, options)
             define_on_schema(name, type_info, options)
           end
 
@@ -87,8 +89,8 @@ if Gem.loaded_specs.has_key? "dry-struct"
             type_info
           end
 
-          def set_metadata(type_info, specified_type, options)
-            metadata = {typed_attribute_type: specified_type, typed_attribute_options: options}
+          def set_metadata(type_info, signatures, options)
+            metadata = {typed_attribute_type: signatures, typed_attribute_options: options}
             type_info.meta(**metadata)
           end
 
@@ -100,7 +102,7 @@ if Gem.loaded_specs.has_key? "dry-struct"
             @attribute_ivar_names ||= {}
             @attribute_ivar_names[attribute_name] = :"@#{attribute_name}"
             define_attribute_delegate(attribute_name) if delegates?(options)
-            @schema ||= const_set("TypedSchema", Class.new(Vident::Attributes::TypedNilingStruct))
+            @schema ||= const_set(:TypedSchema, Class.new(Vident::Attributes::TypedNilingStruct))
             @schema.attribute attribute_name, type_info
           end
 
@@ -130,9 +132,7 @@ if Gem.loaded_specs.has_key? "dry-struct"
             allow_blank.nil? ? true : allow_blank
           end
 
-          def map_primitive_to_dry_type(signature, options, converter)
-            strict = !options[:convert]
-            signatures = extract_member_type_and_subclass(signature, options)
+          def map_primitive_to_dry_type(signatures, strict, converter)
             types = signatures.map do |type, subtype|
               dry_type = dry_type_from_primary_type(type, strict, converter)
               if subtype && dry_type.respond_to?(:of)
@@ -158,6 +158,19 @@ if Gem.loaded_specs.has_key? "dry-struct"
           end
 
           def dry_type_from_primary_type(type, strict, converter)
+            # If a converter is provided, we should use it to coerce the value
+            if converter && !strict && !type.is_a?(Symbol)
+              return Types.Constructor(type) do |value|
+                next value if value.is_a?(type)
+
+                converter.call(value).tap do |new_value|
+                  unless new_value.is_a?(type)
+                    raise ArgumentError, "Type conversion proc did not convert #{value} to #{type}"
+                  end
+                end
+              end
+            end
+
             if type == :any
               Types::Nominal::Any
             elsif type == Integer
@@ -191,15 +204,11 @@ if Gem.loaded_specs.has_key? "dry-struct"
               # values using the default constructor, `new`.
               Types.Instance(type)
             else
-              # dry calls this when initialising the Type. Check if type of input is correct or coerce
+              # dry calls this when initialising the Type. Check if type of input is correct or create new instance
               Types.Constructor(type) do |value|
                 next value if value.is_a?(type)
 
-                if converter
-                  converter.call(value)
-                else
-                  type.new(**value)
-                end
+                type.new(**value)
               end
             end
           end

data/lib/vident/root_component/base.rb

@@ -68,23 +68,21 @@ module Vident
 
       # Helpers for generating the Stimulus data-* attributes directly
 
-      # Return the HTML `data-controller` attribute
-      def with_controllers
-        "data-controller='#{controller_list}'".html_safe
+      # Return the HTML `data-controller` attribute for the given controllers
+      def with_controllers(*controllers_to_set)
+        "data-controller=\"#{controller_list(controllers_to_set)}\"".html_safe
       end
 
-      # Return the HTML `data-target` attribute
+      # Return the HTML `data-target` attribute for the given targets
       def as_targets(*targets)
-        build_target_data_attributes(parse_targets(targets))
-          .map { |dt, n| "data-#{dt}=\"#{n}\"" }
-          .join(" ")
-          .html_safe
+        attrs = build_target_data_attributes(parse_targets(targets))
+        attrs.map { |dt, n| "data-#{dt}=\"#{n}\"" }.join(" ").html_safe
       end
       alias_method :as_target, :as_targets
 
-      # Return the HTML `data-action` attribute to add these actions
-      def with_actions(*actions)
-        "data-action='#{parse_actions(actions).join(" ")}'".html_safe
+      # Return the HTML `data-action` attribute for the given actions
+      def with_actions(*actions_to_set)
+        "data-action='#{parse_actions(actions_to_set).join(" ")}'".html_safe
       end
       alias_method :with_action, :with_actions
 
@@ -101,14 +99,14 @@ module Vident
       end
 
       # A complete list of Stimulus controllers for this component
-      def controller_list
-        @controllers&.map { |c| stimulize_path(c) }&.join(" ")
+      def controller_list(controllers_to_set)
+        controllers_to_set&.map { |c| stimulize_path(c) }&.join(" ")
       end
 
       # Complete list of actions ready to be use in the data-action attribute
-      def action_list
-        return nil unless @actions&.size&.positive?
-        parse_actions(@actions).join(" ")
+      def action_list(actions_to_parse)
+        return nil unless actions_to_parse&.size&.positive?
+        parse_actions(actions_to_parse).join(" ")
       end
 
       # Complete list of targets ready to be use in the data attributes
@@ -124,7 +122,7 @@ module Vident
 
       # stimulus "data-*" attributes map for this component
       def tag_data_attributes
-        {controller: controller_list, action: action_list}
+        {controller: controller_list(@controllers), action: action_list(@actions)}
           .merge!(target_list)
           .merge!(named_classes_list)
           .merge!(data_map_attributes)

data/lib/vident/root_component/using_better_html.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+if Gem.loaded_specs.has_key? "better_html"
+  require "better_html"
+  require "cgi/util"
+
+  module Vident
+    module RootComponent
+      module UsingBetterHTML
+        # Return the HTML `data-controller` attribute for the given controllers
+        def with_controllers(*controllers_to_set)
+          helpers.html_attributes("data-controller" => controller_list(controllers_to_set)&.html_safe)
+        end
+
+        # Return the HTML `data-target` attribute for the given targets
+        def as_targets(*targets)
+          attrs = build_target_data_attributes(parse_targets(targets))
+          helpers.html_attributes(attrs.transform_keys! { |k| "data-#{k}" })
+        end
+
+        # Return the HTML `data-action` attribute for the given actions
+        def with_actions(*actions_to_set)
+          actions_str = action_list(actions_to_set)
+          actions_str.present? ? helpers.html_attributes("data-action" => actions_str) : nil
+        end
+
+        private
+
+        # Complete list of actions ready to be use in the data-action attribute
+        def action_list(actions_to_parse)
+          return nil unless actions_to_parse&.size&.positive?
+          # `html_attributes` will escape '->' thus breaking the stimulus action, so we need to do our own escaping
+          actions_str_raw = parse_actions(actions_to_parse).join(" ")
+          CGI.escapeHTML(actions_str_raw).gsub("->", "->").html_safe
+        end
+      end
+    end
+  end
+end

data/lib/vident/root_component/using_phlex_html.rb

@@ -7,6 +7,9 @@ if Gem.loaded_specs.has_key? "phlex"
     module RootComponent
       class UsingPhlexHTML < Phlex::HTML
         include Base
+        if Gem.loaded_specs.has_key? "better_html"
+          include UsingBetterHTML
+        end
 
         VALID_TAGS = Set[*(Phlex::HTML::VOID_ELEMENTS.keys + Phlex::HTML::STANDARD_ELEMENTS.keys)].freeze
 

data/lib/vident/root_component/using_view_component.rb

@@ -7,6 +7,9 @@ if Gem.loaded_specs.has_key? "view_component"
     module RootComponent
       class UsingViewComponent < ::ViewComponent::Base
         include Base
+        if Gem.loaded_specs.has_key? "better_html"
+          include UsingBetterHTML
+        end
 
         SELF_CLOSING_TAGS = Set[:area, :base, :br, :col, :embed, :hr, :img, :input, :link, :meta, :param, :source, :track, :wbr].freeze
 
@@ -19,25 +22,28 @@ if Gem.loaded_specs.has_key? "view_component"
         end
 
         def call
-          # Capture inner block content
-          # It's important that we capture the block content before generating the tag options.
-          # This is because the content could contain calls to `s.data_map`.
-          # These calls add key-value pairs to the internal data_map, which can then be translated into
-          # the correct `data-*` attrs by the tag options.
-          generated = content
-
           # Generate outer tag options and render
-          tag_type = @element_tag.presence || :div
-          options = @html_options&.dup || {}
-          data_attrs = tag_data_attributes
-          options[:data] = options[:data].present? ? data_attrs.merge(options[:data]) : data_attrs
-          options = options.merge(id: @id) if @id
+          tag_type = content_tag_type
+          options = content_tag_options
           if SELF_CLOSING_TAGS.include?(tag_type)
             view_context.tag(tag_type, options)
           else
-            view_context.content_tag(tag_type, generated, options)
+            view_context.content_tag(tag_type, content, options)
           end
         end
+
+        private
+
+        def content_tag_options
+          options = @html_options&.dup || {}
+          data_attrs = tag_data_attributes
+          options[:data] = options[:data].present? ? data_attrs.merge(options[:data]) : data_attrs
+          options.merge(id: @id) if @id
+        end
+
+        def content_tag_type
+          @element_tag.presence || :div
+        end
       end
     end
   end

data/lib/vident/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Vident
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

data/lib/vident.rb

@@ -26,6 +26,7 @@ end
 
 require_relative "vident/stable_id"
 require_relative "vident/root_component/base"
+require_relative "vident/root_component/using_better_html"
 require_relative "vident/root_component/using_phlex_html"
 require_relative "vident/root_component/using_view_component"
 require_relative "vident/base"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vident
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Stephen Ierodiaconou
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-02-04 00:00:00.000000000 Z
+date: 2023-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -31,8 +31,9 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '8'
 description: Vident makes using Stimulus with your `ViewComponent` or `Phlex` view
-  components as easy as writing Ruby. It also provides a base class for your components
-  to inherit from.
+  components as easy as writing Ruby. Vident is the base of your design system implementation,
+  which provides helpers for working with Stimulus. For component libraries with ViewComponent
+  or Phlex.
 email:
 - stevegeek@gmail.com
 executables: []
@@ -40,6 +41,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".standard.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -57,6 +59,7 @@ files:
 - lib/vident/component.rb
 - lib/vident/railtie.rb
 - lib/vident/root_component/base.rb
+- lib/vident/root_component/using_better_html.rb
 - lib/vident/root_component/using_phlex_html.rb
 - lib/vident/root_component/using_view_component.rb
 - lib/vident/stable_id.rb
@@ -90,6 +93,6 @@ requirements: []
 rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
-summary: Vident is a view component base class for your design system implementation,
-  which provides helpers for working with Stimulus. For ViewComponent and Phlex.
+summary: Vident is the base of your design system implementation, which provides helpers
+  for working with Stimulus. For component libraries with ViewComponent or Phlex.
 test_files: []