vident 0.12.0 → 0.13.0

data/lib/vident/base.rb

@@ -92,8 +92,7 @@ module Vident
 
     # HTML and attribute definition and creation
 
-    # FIXME: if we call them before `root` we will setup the root element before we intended
-    # The separation between component and root element is a bit messy. Might need rethinking.
+    # Generate action/target/etc Stimulus attribute string that can be used externally to this component
     delegate :action, :target, :named_classes, to: :root
 
     # This can be overridden to return an array of extra class names
@@ -133,14 +132,49 @@ module Vident
 
     private
 
-    def parent_element_attributes(options)
-      options
-        .except(:id, :element_tag, :html_options, :controller, :controllers, :actions, :targets, :named_classes, :data_maps)
-        .merge(stimulus_options_for_component(options))
+    def root_element_attributes
+      {}
+    end
+
+    def merge_element_attributes!(element_attributes, attributes)
+      attributes.each_with_object(element_attributes) do |(k, v), h|
+        if h[k].is_a?(Hash)
+          h[k].merge!(v)
+        elsif h[k].is_a?(Array)
+          h[k] << v
+        else
+          h[k] = v
+        end
+      end
+    end
+
+    def root_component_attributes(**attributes)
+      @root_component_attributes ||= {}
+      merge_element_attributes!(@root_component_attributes, attributes)
+    end
+
+    def stimulus_options_for_root_component
+      attributes = root_element_attributes
+      merge_element_attributes!(attributes, @root_component_attributes) if @root_component_attributes.present?
+      stimulus_options_for_component(attributes)
     end
 
     # Prepare the stimulus attributes for a StimulusComponent
     def stimulus_options_for_component(options)
+      # Add pending actions
+      all_actions = attribute(:actions) + Array.wrap(options[:actions])
+      all_actions += @pending_actions if @pending_actions&.any?
+
+      # Add pending targets
+      all_targets = attribute(:targets) + Array.wrap(options[:targets])
+      all_targets += @pending_targets if @pending_targets&.any?
+
+      # Merge pending named classes
+      named_classes_option = merge_stimulus_option(options, :named_classes)
+      if @pending_named_classes&.any?
+        named_classes_option = named_classes_option.merge(@pending_named_classes)
+      end
+
       {
         id: respond_to?(:id) ? id : (attribute(:id) || options[:id]),
         element_tag: attribute(:element_tag) || options[:element_tag] || :div,
@@ -148,12 +182,12 @@ module Vident
         controllers: (
           self.class.stimulus_controller? ? [default_controller_path] : []
         ) + Array.wrap(options[:controllers]) + attribute(:controllers),
-        actions: attribute(:actions) + Array.wrap(options[:actions]),
-        targets: attribute(:targets) + Array.wrap(options[:targets]),
+        actions: all_actions,
+        targets: all_targets,
         outlets: attribute(:outlets) + Array.wrap(options[:outlets]),
         outlet_host: attribute(:outlet_host),
-        named_classes: merge_stimulus_option(options, :named_classes),
-        data_maps: prepare_stimulus_option(options, :data_maps)
+        named_classes: named_classes_option,
+        values: prepare_stimulus_option(options, :values)
       }
     end
 

data/lib/vident/component.rb

@@ -18,7 +18,7 @@ module Vident
       attribute :targets, default: [], delegates: false
       attribute :outlets, default: [], delegates: false
       attribute :outlet_host, delegates: false
-      attribute :data_maps, default: [], delegates: false
+      attribute :values, default: [], delegates: false
       attribute :named_classes, delegates: false
     end
 

data/lib/vident/root_component.rb

@@ -9,7 +9,7 @@ module Vident
       outlets: nil,
       outlet_host: nil,
       named_classes: nil, # https://stimulus.hotwired.dev/reference/css-classes
-      data_maps: nil,
+      values: nil,
       element_tag: nil,
       id: nil,
       html_options: nil
@@ -22,8 +22,7 @@ module Vident
       @targets = targets
       @outlets = outlets
       @named_classes = named_classes
-      @data_map_kvs = {}
-      @data_maps = data_maps
+      @values = values
 
       outlet_host.connect_outlet(self) if outlet_host.respond_to?(:connect_outlet)
     end
@@ -150,13 +149,18 @@ module Vident
       build_named_classes_data_attributes(@named_classes)
     end
 
+    def values_list
+      return {} unless @values&.size&.positive?
+      build_values_attributes
+    end
+
     # stimulus "data-*" attributes map for this component
     def tag_data_attributes
       {controller: controller_list(@controllers), action: action_list(@actions)}
         .merge!(target_list)
         .merge!(outlet_list)
         .merge!(named_classes_list)
-        .merge!(data_map_attributes)
+        .merge!(values_list)
         .compact_blank!
     end
 
@@ -229,7 +233,11 @@ module Vident
 
     def parse_target(raw_target)
       return raw_target if raw_target.is_a?(String)
-      return raw_target if raw_target.is_a?(Hash)
+      if raw_target.is_a?(Hash)
+        raw_target[:name] = js_name(raw_target[:name]) if raw_target[:name].is_a?(Symbol)
+        return raw_target
+      end
+      return target(*raw_target) if raw_target.is_a?(Array)
       target(raw_target)
     end
 
@@ -241,23 +249,28 @@ module Vident
       actions.map! { |a| a.is_a?(String) ? a : action(*a) }
     end
 
-    def parse_attributes(attrs, controller = nil)
-      attrs.transform_keys { |k| :"#{controller || implied_controller_name}-#{k}" }
+    def parse_value_attributes(attrs, controller: nil)
+      attrs.transform_keys do |value_name|
+        :"#{controller || implied_controller_name}-#{value_name.to_s.dasherize}-value"
+      end
     end
 
-    def data_map_attributes
-      return {} unless @data_maps
-      @data_maps.each_with_object({}) do |m, obj|
+    def build_values_attributes
+      @values.each_with_object({}) do |m, obj|
         if m.is_a?(Hash)
-          obj.merge!(parse_attributes(m))
+          obj.merge!(parse_value_attributes(m))
         elsif m.is_a?(Array)
           controller_path = m.first
           data = m.last
-          obj.merge!(parse_attributes(data, stimulize_path(controller_path)))
+          obj.merge!(parse_value_attributes(data, controller: stimulize_path(controller_path)))
         end
       end
     end
 
+    def build_values_data_attributes(values)
+      values.map { |name, value| [:"#{name}-value", value] }.to_h
+    end
+
     def parse_named_classes_hash(named_classes)
       named_classes.map do |name, classes|
         logical_name = name.to_s.dasherize

data/lib/vident/version.rb

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
 module Vident
-  VERSION = "0.12.0"
+  VERSION = "0.13.0"
+
+  # Shared version for all vident gems
+  def self.version
+    VERSION
+  end
 end

data/lib/vident.rb

@@ -1,8 +1,14 @@
 # frozen_string_literal: true
 
+require "active_support"
+require "active_support/concern"
 require "vident/version"
-require "vident/engine"
+require "vident/base"
+require "vident/stable_id"
+require "vident/attributes/not_typed"
+require "vident/root_component"
+require "vident/component"
 
-module Vident
-  # Your code goes here...
-end
+require "vident/engine" if defined?(Rails)
+
+module Vident; end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: vident
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Stephen Ierodiaconou
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-25 00:00:00.000000000 Z
+date: 2025-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -16,40 +15,40 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '7.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '7.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '9'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '7.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '9'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '7.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8.0'
+        version: '9'
 description: Vident makes using Stimulus with your `ViewComponent` or `Phlex` view
   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
@@ -60,14 +59,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".ruby-version"
-- ".standard.yml"
 - CHANGELOG.md
-- CODE_OF_CONDUCT.md
 - LICENSE.txt
 - README.md
-- Rakefile
-- lib/tasks/vident_tasks.rake
 - lib/vident.rb
 - lib/vident/attributes/not_typed.rb
 - lib/vident/base.rb
@@ -77,8 +71,6 @@ files:
 - lib/vident/root_component.rb
 - lib/vident/stable_id.rb
 - lib/vident/version.rb
-- sig/vident.rbs
-- vident.gemspec
 homepage: https://github.com/stevegeek/vident
 licenses:
 - MIT
@@ -86,7 +78,6 @@ metadata:
   homepage_uri: https://github.com/stevegeek/vident
   source_code_uri: https://github.com/stevegeek/vident
   changelog_uri: https://github.com/stevegeek/vident/blob/main/CHANGELOG.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -94,15 +85,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: 3.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Vident is the base of your design system implementation, which provides helpers
   for working with Stimulus. For component libraries with ViewComponent or Phlex.

data/.ruby-version

@@ -1 +0,0 @@
-3.3.0

data/.standard.yml

@@ -1,3 +0,0 @@
-# For available configuration options, see:
-#   https://github.com/testdouble/standard
-ruby_version: 3.3

data/CODE_OF_CONDUCT.md

@@ -1,84 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
-
-We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
-
-## Our Standards
-
-Examples of behavior that contributes to a positive environment for our community include:
-
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the overall community
-
-Examples of unacceptable behavior include:
-
-* The use of sexualized language or imagery, and sexual attention or
-  advances of any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email
-  address, without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Enforcement Responsibilities
-
-Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
-
-Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
-
-## Scope
-
-This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at stevegeek@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
-
-All community leaders are obligated to respect the privacy and security of the reporter of any incident.
-
-## Enforcement Guidelines
-
-Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
-
-### 1. Correction
-
-**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
-
-**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
-
-### 2. Warning
-
-**Community Impact**: A violation through a single incident or series of actions.
-
-**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
-
-### 3. Temporary Ban
-
-**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
-
-**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
-
-### 4. Permanent Ban
-
-**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
-
-**Consequence**: A permanent ban from any sort of public interaction within the community.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
-available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
-
-Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
-
-[homepage]: https://www.contributor-covenant.org
-
-For answers to common questions about this code of conduct, see the FAQ at
-https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Rakefile

@@ -1,3 +0,0 @@
-require "bundler/setup"
-
-require "bundler/gem_tasks"

data/lib/tasks/vident_tasks.rake

@@ -1,4 +0,0 @@
-# desc "Explaining what the task does"
-# task :vident do
-#   # Task goes here
-# end

data/sig/vident.rbs

@@ -1,4 +0,0 @@
-module Vident
-  VERSION: String
-  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
-end

data/vident.gemspec

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "lib/vident/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "vident"
-  spec.version = Vident::VERSION
-  spec.authors = ["Stephen Ierodiaconou"]
-  spec.email = ["stevegeek@gmail.com"]
-
-  spec.summary = "Vident is the base of your design system implementation, which provides helpers for working with Stimulus. For component libraries with ViewComponent or Phlex."
-  spec.description = "Vident makes using Stimulus with your `ViewComponent` or `Phlex` view 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."
-  spec.homepage = "https://github.com/stevegeek/vident"
-  spec.license = "MIT"
-  spec.required_ruby_version = ">= 3.0.0"
-
-  spec.metadata["homepage_uri"] = spec.homepage
-  spec.metadata["source_code_uri"] = spec.homepage
-  spec.metadata["changelog_uri"] = spec.homepage + "/blob/main/CHANGELOG.md"
-
-  spec.files = Dir.chdir(__dir__) do
-    `git ls-files -z`.split("\x0").reject do |f|
-      (File.expand_path(f) == __FILE__) ||
-        f.start_with?(*%w[bin/ test/ spec/ features/ examples/ docs/ .git .github appveyor Gemfile])
-    end
-  end
-
-  spec.add_dependency "railties", ">= 7", "< 8.0"
-  spec.add_dependency "activesupport", ">= 7", "< 8.0"
-end