vident 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9144ee8a1b3361914b568d5dfbdcc22df506818813573e91ede2302e3a6775aa
-  data.tar.gz: 6476408b4f5acf6e4dd40d96539df7fb5588bb225200d3fbd05d35310a7c1c2d
+  metadata.gz: 95a2b00a3176fdc3fbd06569b20665b3e1d1bc8032758b0945d2dc58990d2fa5
+  data.tar.gz: e946108732b2abd5af47e5437b13e72983838cad032fb6b5c4c460504dc4cf8c
 SHA512:
-  metadata.gz: 3098fa53c35329dc0ab5bbae9c4d2ca368ce8d9486fa5cfad29fddf8b006bed162dd8eb89cc1b76d42be91daecb0f0b41f979c866734f5a05f99580936444728
-  data.tar.gz: 47dff0e200721e7b48498e13cb27cf58fd7b0da9be6b428be201bb4f73593ffc233a459dc2e0b16f2c925097c65956a274a41c3707c1bfb45be1eccc7b2edbc7
+  metadata.gz: 3fd4da39749c72675965bf507287db253b305a2203c29a323a6342fa593709c06480ce1a3671e6044b562503853b78c56ca9a698e5962217a4a1becf23a29722
+  data.tar.gz: 11e8f9e658bb2ff4459719a205ae13bcecb7f2c65b1e4d89edb718879d5a54fe947922c0328cf5c15b19f066d46695250a935599fa37fcfd8de0fbfb9e2975af

data/.ruby-version

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

data/.standard.yml

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

data/CHANGELOG.md

@@ -0,0 +1,108 @@
+
+# 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.10.0] - 2024-02-21
+
+### Added
+
+- `outlets` option for components, used to specify Stimulus outlets 
+
+## [0.9.0] - 2023-08-11
+
+### Added
+
+- `#cache_key` support is now part of the core gem, and can be added to components using `Vident::Caching` module
+
+## [0.8.0] - 2023-03-31
+
+### Added
+
+- new gems for Vident related functionality, eg `vident-typed` and `vident-tailwind`
+- `vident` is now the core gem which can be used with any component system. Gems for Phlex and ViewComponent are available, `vident-phlex` and `vident-view_component`, and `vident-typed-phlex` and `vident-typed-view_component` are available with typed attributes support.
+
+### Changed
+
+- removed functionality for `better_html`, `dry-types`, `view_component`, and `phlex` from the core gem
+- gem is now a Rails Engine and supports eager and autoloading
+
+### Fixed
+
+- Fix untyped attributes inheritance
+
+## [0.7.0] - 2023-03-08  
+
+### Added
+
+- new `Vident::Tailwind` module which uses [tailwind_merge](https://github.com/gjtorikian/tailwind_merge) to merge TailwindCSS classes
+
+### Changed
+
+- Removed a dependency on intenal constants from `phlex`
+
+## [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

@@ -0,0 +1,84 @@
+# 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/LICENSE.txt

@@ -0,0 +1,21 @@
+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/README.md

@@ -2,7 +2,7 @@
 
 **Vident** is a collection of gems that help you create **flexible** & **maintainable** component libraries for your Rails application.
 
-<a href="https://github.com/stevegeek/vident"><img alt="Vident logo" src="https://raw.githubusercontent.com/stevegeek/vident/main/logo-by-sd-256-colors.png" width="180" /></a>
+<a href="https://github.com/stevegeek/vident"><img alt="Vident logo" src="https://raw.githubusercontent.com/stevegeek/vident/main/docs/images/logo-by-sd-256-colors.png" width="180" /></a>
 
 Vident also provides a neat Ruby DSL to make wiring up **Stimulus easier & less error prone** in your view components.
 
@@ -14,10 +14,111 @@ I love working with Stimulus, but I find manually crafting the data attributes f
 targets and actions error-prone and tedious. Vident aims to make this process easier
 and keep me thinking in Ruby.
 
-I have been using Vident with `ViewComponent` in production apps for a while now (and recently `Phlex`!) 
-and it has been constantly evolving.
+Vident has been used with `ViewComponent` and `Phlex` in production apps for a while now 
+but is still evolving.
 
-This gem is a work in progress and I would love to get your feedback and contributions!
+I would love to get your feedback and contributions!
+
+## Example
+
+The Greeter ViewComponent (that uses Vident):
+
+![docs/images/ex1.gif](docs/images/ex1.gif)
+
+Consider a component, the `GreeterComponent`:
+
+```ruby
+# app/components/greeter_component.rb
+
+class GreeterComponent < ::Vident::ViewComponent::Base
+  renders_one :trigger, ButtonComponent
+end
+```
+
+with ERB as follows:
+
+```erb
+<%# app/components/greeter_component.html.erb %>
+
+<%# Rendering the `root` element creates a tag which has stimulus `data-*`s, a unique id & other attributes set. %>
+<%# The stimulus controller name (identifier) is derived from the component name, and then used to generate the relavent data attribute names. %>
+
+<%= render root named_classes: {
+  pre_click: "text-md text-gray-500", # named classes are exposed to Stimulus as `data-<controller>-<name>-class` attributes
+  post_click: "text-xl text-blue-700",
+  html_options: {class: "py-2"}
+} do |greeter| %>
+  <%# `greeter` is the root element and exposes methods to generate stimulus targets and actions %>
+  <input type="text"
+         <%= greeter.as_target(:name) %>
+         class="shadow appearance-none border rounded py-2 px-3 text-gray-700 leading-tight focus:outline-none focus:shadow-outline">
+  
+  <%# Render the slot %>
+  <%= trigger %>
+  
+  <%# you can also use the `target_tag` helper to render targets %>
+  <%= greeter.target_tag(
+        :span, 
+        :output, 
+        # Stimulus named classes can be referenced to set class attributes at render time
+        class: "ml-4 #{greeter.named_classes(:pre_click)}" 
+      ) do %>
+    ...
+  <% end %>
+<% end %>
+```
+
+Now, imagine we render it in a view, and render a `ButtonComponent` in the `trigger` slot:
+
+```erb
+<%= render ::GreeterComponent.new(cta: "Hey!", html_options: {class: "my-4"}) do |greeter| %>
+  <%# this component has a slot called `trigger` that renders a `ButtonComponent` (which also uses Vident) %> 
+  <% greeter.with_trigger(
+       
+       # The button component has attributes that are typed
+       before_clicked: "Greet",
+       after_clicked: "Greeted! Reset?",
+       
+       # A stimulus action is added to the button that triggers the `greet` action on the greeter stimulus controller.
+       # This action will be added to any defined on the button component itself
+       actions: [
+         greeter.action(:click, :greet),
+       ],
+       
+       # We can also override the default button classes of our component, or set other HTML attributes
+       html_options: {
+         class: "bg-red-500 hover:bg-red-700"
+       }
+     ) %>
+<% end %>
+```
+
+The output HTML of the above, using Vident, is:
+
+```html 
+<div class="greeter-component py-2 my-4" 
+     data-controller="greeter-component" 
+     data-greeter-component-pre-click-class="text-md text-gray-500" 
+     data-greeter-component-post-click-class="text-xl text-blue-700" 
+     id="greeter-component-1599855-6">
+  <input type="text" 
+         data-greeter-component-target="name" 
+         class="shadow appearance-none border rounded py-2 px-3 text-gray-700 leading-tight focus:outline-none focus:shadow-outline">
+  <button class="button-component ml-4 whitespace-no-wrap bg-blue-500 hover:bg-blue-700 text-white font-bold py-2 px-4 rounded bg-red-500 hover:bg-red-700" 
+          data-controller="button-component" 
+          data-action="click->greeter-component#greet button-component#changeMessage" 
+          data-button-component-after-clicked-message="Greeted! Reset?" 
+          data-button-component-before-clicked-message="Greet" 
+          id="button-component-7799479-7">Hey!</button>
+  <!-- you can also use the `target_tag` helper to render targets -->
+  <span class="ml-4 text-md text-gray-500" 
+        data-greeter-component-target="output">
+    ...
+  </span>
+</div>
+```
+
+To see this example in more detail, see the [vident-typed-view_component](https://github.com/stevegeek/vident-typed-view_component/tree/main/test/dummy/app/components) test dummy app.
 
 # Vident is a collection of gems
 

data/lib/vident/base.rb

@@ -145,6 +145,7 @@ module Vident
         ) + Array.wrap(options[:controllers]) + attribute(:controllers),
         actions: attribute(:actions) + Array.wrap(options[:actions]),
         targets: attribute(:targets) + Array.wrap(options[:targets]),
+        outlets: attribute(:outlets) + Array.wrap(options[:outlets]),
         named_classes: merge_stimulus_option(options, :named_classes),
         data_maps: prepare_stimulus_option(options, :data_maps)
       }

data/lib/vident/component.rb

@@ -16,6 +16,7 @@ module Vident
       attribute :controllers, default: [], delegates: false
       attribute :actions, default: [], delegates: false
       attribute :targets, default: [], delegates: false
+      attribute :outlets, default: [], delegates: false
       attribute :data_maps, default: [], delegates: false
       attribute :named_classes, delegates: false
     end

data/lib/vident/root_component.rb

@@ -6,6 +6,7 @@ module Vident
       controllers: nil,
       actions: nil,
       targets: nil,
+      outlets: nil,
       named_classes: nil, # https://stimulus.hotwired.dev/reference/css-classes
       data_maps: nil,
       element_tag: nil,
@@ -18,6 +19,7 @@ module Vident
       @controllers = Array.wrap(controllers)
       @actions = actions
       @targets = targets
+      @outlets = outlets
       @named_classes = named_classes
       @data_map_kvs = {}
       @data_maps = data_maps
@@ -123,11 +125,17 @@ module Vident
     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)
         .compact_blank!
     end
 
+    def outlet_list
+      return {} unless @outlets&.size&.positive?
+      @outlets.each_with_object({}) { |o, obj| obj["#{implied_controller_name}-#{o.stimulus_identifier}-outlet"] = "[data-controller~=#{o.stimulus_identifier}]" }
+    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.
@@ -173,7 +181,7 @@ module Vident
     end
 
     def build_target_data_attributes(targets)
-      targets.map { |t| ["#{t[:controller]}-target".to_sym, t[:name]] }.to_h
+      targets.map { |t| [:"#{t[:controller]}-target", t[:name]] }.to_h
     end
 
     def parse_actions(actions)

data/lib/vident/version.rb

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

data/sig/vident.rbs

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

data/vident.gemspec

@@ -0,0 +1,30 @@
+# 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

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: vident
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
 platform: ruby
 authors:
 - Stephen Ierodiaconou
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-08-11 00:00:00.000000000 Z
+date: 2024-02-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -19,7 +19,7 @@ dependencies:
         version: '7'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '8.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,27 @@ dependencies:
         version: '7'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '8'
+        version: '8.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
 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
@@ -40,6 +60,11 @@ 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
@@ -52,6 +77,8 @@ 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
@@ -74,7 +101,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: Vident is the base of your design system implementation, which provides helpers