vident 0.6.3 → 0.8.0

data/lib/vident/root_component.rb

@@ -0,0 +1,235 @@
+# frozen_string_literal: true
+
+module Vident
+  module RootComponent
+    def initialize(
+      controllers: nil,
+      actions: nil,
+      targets: nil,
+      named_classes: nil, # https://stimulus.hotwired.dev/reference/css-classes
+      data_maps: nil,
+      element_tag: nil,
+      id: nil,
+      html_options: nil
+    )
+      @element_tag = element_tag
+      @html_options = html_options
+      @id = id
+      @controllers = Array.wrap(controllers)
+      @actions = actions
+      @targets = targets
+      @named_classes = named_classes
+      @data_map_kvs = {}
+      @data_maps = data_maps
+    end
+
+    # The view component's helpers for setting stimulus data-* attributes on this component.
+
+    # TODO: rename
+    # Create a Stimulus action string, and returns it
+    #   examples:
+    #   action(:my_thing) => "current_controller#myThing"
+    #   action(:click, :my_thing) => "click->current_controller#myThing"
+    #   action("click->current_controller#myThing") => "click->current_controller#myThing"
+    #   action("path/to/current", :my_thing) => "path--to--current_controller#myThing"
+    #   action(:click, "path/to/current", :my_thing) => "click->path--to--current_controller#myThing"
+    def action(*args)
+      part1, part2, part3 = args
+      (args.size == 1) ? parse_action_arg(part1) : parse_multiple_action_args(part1, part2, part3)
+    end
+
+    def action_data_attribute(*actions)
+      {action: parse_actions(actions).join(" ")}
+    end
+
+    # TODO: rename & make stimulus Target class instance and returns it, which can convert to String
+    # Create a Stimulus Target and returns it
+    #   examples:
+    #   target(:my_target) => {controller: 'current_controller' name: 'myTarget'}
+    #   target("path/to/current", :my_target) => {controller: 'path--to--current_controller', name: 'myTarget'}
+    def target(name, part2 = nil)
+      if part2.nil?
+        {controller: implied_controller_name, name: js_name(name)}
+      else
+        {controller: stimulize_path(name), name: js_name(part2)}
+      end
+    end
+
+    def target_data_attribute(name)
+      build_target_data_attributes([target(name)])
+    end
+
+    # Getter for a named classes list so can be used in view to set initial state on SSR
+    # Returns a String of classes that can be used in a `class` attribute.
+    def named_classes(*names)
+      names.map { |name| convert_classes_list_to_string(@named_classes[name]) }.join(" ")
+    end
+
+    # Helpers for generating the Stimulus data-* attributes directly
+
+    # 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 for the given targets
+    def as_targets(*targets)
+      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 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
+
+    private
+
+    # An implicit Stimulus controller name is built from the implicit controller path
+    def implied_controller_name
+      stimulize_path(implied_controller_path)
+    end
+
+    # When using the DSL if you dont specify, the first controller is implied
+    def implied_controller_path
+      @controllers&.first || raise(StandardError, "No controllers have been specified")
+    end
+
+    # A complete list of Stimulus controllers for this component
+    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(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
+    def target_list
+      return {} unless @targets&.size&.positive?
+      build_target_data_attributes(parse_targets(@targets))
+    end
+
+    def named_classes_list
+      return {} unless @named_classes&.size&.positive?
+      build_named_classes_data_attributes(@named_classes)
+    end
+
+    # stimulus "data-*" attributes map for this component
+    def tag_data_attributes
+      {controller: controller_list(@controllers), action: action_list(@actions)}
+        .merge!(target_list)
+        .merge!(named_classes_list)
+        .merge!(data_map_attributes)
+        .compact_blank!
+    end
+
+    # Actions can be specified as a symbol, in which case they imply an action on the primary
+    # controller, or as a string in which case it implies an action that is already fully qualified
+    # stimulus action.
+    # 1 Symbol: :my_action => "my_controller#myAction"
+    # 1 String: "my_controller#myAction"
+    # 2 Symbols: [:click, :my_action] => "click->my_controller#myAction"
+    # 1 String, 1 Symbol: ["path/to/controller", :my_action] => "path--to--controller#myAction"
+    # 1 Symbol, 1 String, 1 Symbol: [:hover, "path/to/controller", :my_action] => "hover->path--to--controller#myAction"
+
+    def parse_action_arg(part1)
+      if part1.is_a?(Symbol)
+        # 1 symbol arg, name of method on this controller
+        "#{implied_controller_name}##{js_name(part1)}"
+      elsif part1.is_a?(String)
+        # 1 string arg, fully qualified action
+        part1
+      end
+    end
+
+    def parse_multiple_action_args(part1, part2, part3)
+      if part3.nil? && part1.is_a?(Symbol)
+        # 2 symbol args = event + action
+        "#{part1}->#{implied_controller_name}##{js_name(part2)}"
+      elsif part3.nil?
+        # 1 string arg, 1 symbol = controller + action
+        "#{stimulize_path(part1)}##{js_name(part2)}"
+      else
+        # 1 symbol, 1 string, 1 symbol = as above but with event
+        "#{part1}->#{stimulize_path(part2)}##{js_name(part3)}"
+      end
+    end
+
+    # Parse actions, targets and attributes that are passed in as symbols or strings
+
+    def parse_targets(targets)
+      targets.map { |n| parse_target(n) }
+    end
+
+    def parse_target(raw_target)
+      return raw_target if raw_target.is_a?(String)
+      return raw_target if raw_target.is_a?(Hash)
+      target(raw_target)
+    end
+
+    def build_target_data_attributes(targets)
+      targets.map { |t| ["#{t[:controller]}-target".to_sym, t[:name]] }.to_h
+    end
+
+    def parse_actions(actions)
+      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}" }
+    end
+
+    def data_map_attributes
+      return {} unless @data_maps
+      @data_maps.each_with_object({}) do |m, obj|
+        if m.is_a?(Hash)
+          obj.merge!(parse_attributes(m))
+        elsif m.is_a?(Array)
+          controller_path = m.first
+          data = m.last
+          obj.merge!(parse_attributes(data, stimulize_path(controller_path)))
+        end
+      end
+    end
+
+    def parse_named_classes_hash(named_classes)
+      named_classes.map do |name, classes|
+        logical_name = name.to_s.dasherize
+        classes_str = convert_classes_list_to_string(classes)
+        if classes.is_a?(Hash)
+          {controller: stimulize_path(classes[:controller_path]), name: logical_name, classes: classes_str}
+        else
+          {controller: implied_controller_name, name: logical_name, classes: classes_str}
+        end
+      end
+    end
+
+    def build_named_classes_data_attributes(named_classes)
+      parse_named_classes_hash(named_classes)
+        .map { |c| ["#{c[:controller]}-#{c[:name]}-class", c[:classes]] }
+        .to_h
+    end
+
+    def convert_classes_list_to_string(classes)
+      return "" if classes.nil?
+      return classes if classes.is_a?(String)
+      return classes.join(" ") if classes.is_a?(Array)
+      classes[:classes].is_a?(Array) ? classes[:classes].join(" ") : classes[:classes]
+    end
+
+    # Convert a file path to a stimulus controller name
+    def stimulize_path(path)
+      path.split("/").map { |p| p.to_s.dasherize }.join("--")
+    end
+
+    # Convert a Ruby 'snake case' string to a JavaScript camel case strings
+    def js_name(name)
+      name.to_s.camelize(:lower)
+    end
+  end
+end

data/lib/vident/version.rb

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

data/lib/vident.rb

@@ -1,41 +1,8 @@
 # frozen_string_literal: true
 
-require_relative "vident/version"
-require_relative "vident/railtie"
+require "vident/version"
+require "vident/engine"
 
 module Vident
-  class << self
-    def configuration
-      @configuration ||= Configuration.new
-    end
-
-    def configure
-      yield(configuration) if block_given?
-      configuration
-    end
-  end
-
-  class Configuration
-    attr_accessor :include_i18n_helpers
-
-    def initialize
-      @include_i18n_helpers = true
-    end
-  end
+  # Your code goes here...
 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"
-require_relative "vident/component"
-require_relative "vident/typed_component"
-require_relative "vident/caching/cache_key"
-
-require_relative "vident/testing/attributes_tester"
-require_relative "vident/testing/auto_test"
-
-# TODO: what if not using view_component?
-require_relative "vident/test_case"

metadata

@@ -1,22 +1,22 @@
 --- !ruby/object:Gem::Specification
 name: vident
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.8.0
 platform: ruby
 authors:
 - Stephen Ierodiaconou
 autorequire:
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2023-03-03 00:00:00.000000000 Z
+date: 2023-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7'
     - - "<"
       - !ruby/object:Gem::Version
         version: '8'
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7'
     - - "<"
       - !ruby/object:Gem::Version
         version: '8'
@@ -40,41 +40,24 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".standard.yml"
-- CHANGELOG.md
-- CODE_OF_CONDUCT.md
-- Gemfile
-- LICENSE.txt
 - README.md
 - Rakefile
-- examples/ex1.gif
-- lib/tasks/vident.rake
+- lib/tasks/vident_tasks.rake
 - lib/vident.rb
 - lib/vident/attributes/not_typed.rb
-- lib/vident/attributes/typed.rb
-- lib/vident/attributes/typed_niling_struct.rb
-- lib/vident/attributes/types.rb
 - lib/vident/base.rb
-- lib/vident/caching/cache_key.rb
 - 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/engine.rb
+- lib/vident/root_component.rb
 - lib/vident/stable_id.rb
-- lib/vident/test_case.rb
-- lib/vident/testing/attributes_tester.rb
-- lib/vident/testing/auto_test.rb
-- lib/vident/typed_component.rb
 - lib/vident/version.rb
-- sig/vident.rbs
 homepage: https://github.com/stevegeek/vident
 licenses:
 - MIT
 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:
@@ -90,7 +73,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.4.6
 signing_key:
 specification_version: 4
 summary: Vident is the base of your design system implementation, which provides helpers

data/.standard.yml

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

data/CHANGELOG.md

@@ -1,69 +0,0 @@
-
-# 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.3] - 2023-03-03
-
-### Fixed
-
-- Fix for changes to HTML tag collection in Phlex
-
-
-## [0.6.2] - 2023-02-23
-
-### Fixed
-
-- Element tag options are not set when no ID is provided
-
-
-## [0.6.1] - 2023-02-20
-
-### Fixed
-
-- `better_html` support fix for aliased dsl methods
-
-
-## [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/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/Gemfile

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in vident.gemspec
-gemspec
-
-gem "puma"
-
-gem "rails", ">= 7"
-# TODO: move examples to another app?
-gem "sprockets-rails"
-gem "tailwindcss-rails"
-gem "turbo-rails"
-gem "importmap-rails"
-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"
-
-gem "sqlite3"
-
-gem "rake", "~> 13.0"
-
-gem "minitest", "~> 5.0"
-gem "minitest-hooks"
-gem "faker"
-
-gem "standard", "~> 1.3"

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2022 Stephen Ierodiaconou
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.

data/lib/tasks/vident.rake

@@ -1,37 +0,0 @@
-require "stimulus/manifest"
-
-namespace :vident do
-  task :stimulus_controller_imports do
-    paths = {
-      "app/components" => "../../../app/components",
-      "app/views" => "../../../app/views",
-      "app/javascript/controllers" => "."
-    }
-    manifests = []
-    paths.each do |controllers_path, import_path|
-      vc_controllers_path = Rails.root.join(controllers_path)
-      manifests << Stimulus::Manifest.extract_controllers_from(vc_controllers_path).collect do |controller_path|
-        controller_path = controller_path.relative_path_from(vc_controllers_path).to_s
-        module_path = controller_path.split(".").first
-        controller_class_name = module_path.camelize.gsub(/::/, "__")
-        tag_name = module_path.remove(/_controller/).tr("_", "-").gsub(/\//, "--")
-
-        <<~JS
-          import #{controller_class_name} from "#{import_path}/#{controller_path.gsub(".ts", "")}"
-          application.register("#{tag_name}", #{controller_class_name});
-        JS
-      end
-    end
-
-    File.open(Rails.root.join("app/javascript/controllers/index.js"), "w+") do |index|
-      index.puts "// This file is auto-generated by ./bin/rails stimulus_controller_imports"
-      index.puts "// Run that command whenever you add a new controller or create them with"
-      index.puts "// ./bin/rails generate stimulus controllerName"
-      index.puts
-      index.puts %(import { application } from "./application")
-      manifests.each do |manifest|
-        index.puts manifest
-      end
-    end
-  end
-end