vident 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 481f74d4370e94387dfa81c6d6287e8a5a8dd022d6e353d656cfa3807f069b03
+  data.tar.gz: b462c2871a4f48b2193ad91a630a773d37efb581d5efae91699523602d18b68f
+SHA512:
+  metadata.gz: d9eea045322f4bad4bcbc03bf4985163674385c08db20aa5aec398edabf56c428aeac532bacdbfd32f3188d3e5a7cc5f6b3bea4c9ba1c51209befd32c5810128
+  data.tar.gz: 06b566851995e5b4873dcca265345900b89cf516a13ae50fe4a6d08c848764e8fd6f7fd0c520d71985347a29befbcae8bd514639c525541bded0617f4188899a

data/.standard.yml

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

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/Gemfile

@@ -0,0 +1,29 @@
+# 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", "~> 0.5.3", require: "phlex/rails"
+gem "view_component", "2.74.1"
+
+gem "sqlite3"
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"
+
+gem "standard", "~> 1.3"

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

@@ -0,0 +1,349 @@
+# Vident
+
+Vident helps you create flexible & maintainable component libraries for your application.
+
+Vident makes using Stimulus with your [`ViewComponent`](https://viewcomponent.org/) or [`Phlex`](https://phlex.fun) components easier.
+
+## Things still to do...
+
+This is a work in progress. Here's what's left to do for first release:
+
+- Iterate on the interfaces and functionality
+- Add tests
+- Make the gem more configurable to fit more use cases
+- Create an example library of a few components for some design system
+  - Create a demo app with `lookbook` and those components
+- Add more documentation
+- split `vident` into `vident` + `vident-rails` gems (and maybe `vident-rspec`) (Phlex can be used outside of Rails)
+  - possibly also split into `vident-phlex` and `vident-view_component` gems ?
+
+# Motivation
+
+I love working with Stimulus, but I find manually crafting the data attributes for
+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 it has been constantly
+evolving.
+
+This gem is a work in progress and I would love to get your feedback and contributions!
+
+## What does Vident provide?
+
+- `Vident::Component`: A mixin for your `ViewComponent` components or `Phlex` components that provides the a helper to create the
+  root element component (in templated or template-less components).
+
+- `Vident::TypedComponent`: like `Vident::Component` but uses `dry-types` to define typed attributes for your components.
+
+- `Vident::RootComponent::*` which are components for creating the 'root' element in your view components. Similar to `Primer::BaseComponent` but
+  exposes a simple API for configuring and adding Stimulus controllers, targets and actions. Normally you create these
+  using the `root` helper method on `Vident::Component`/`Vident::TypedComponent`.
+
+# Example
+
+Consider the following ERB that might be part of an application's views. The app uses `ViewComponent`, `Stimulus` and `Vident`.
+
+The Greeter is a component that displays a text input and a button. When the button is clicked, the text input's value is
+used to greet the user. At the same time the button changes to be a 'reset' button, which resets the greeting when clicked again.
+
+![ex1.gif](examples%2Fex1.gif)
+
+```erb
+<%# app/views/home/index.html.erb %>
+
+<!-- ... -->
+
+<!-- render the Greeter ViewComponent (that uses Vident) -->
+<%= render ::GreeterComponent.new do |greeter| %>
+  <%# this component has a slot called `trigger` that renders a `ButtonComponent` (which also uses Vident) %> 
+  <% greeter.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" 
+     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">Greet</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>
+```
+
+Let's look at the components in more detail.
+
+The main component is the `GreeterComponent`:
+
+```ruby
+# app/components/greeter_component.rb
+
+class GreeterComponent < ViewComponent::Base
+  include Vident::Component
+
+  renders_one :trigger, ButtonComponent
+end
+```
+
+```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"
+} 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 %>
+
+```
+
+```js
+// app/components/greeter_component_controller.js
+
+import { Controller } from "@hotwired/stimulus"
+
+// This is a Stimulus controller that is automatically registered for the `GreeterComponent`
+// and is 'sidecar' to the component. You can see that while in the ERB we use Ruby naming conventions
+// with snake_case Symbols, here they are converted to camelCase names. We can also just use camelCase 
+// in the ERB if we want.
+export default class extends Controller {
+  static targets = [ "name", "output" ]
+  static classes = [ "preClick", "postClick" ]
+
+  greet() {
+    this.clicked = !this.clicked;
+    this.outputTarget.classList.toggle(this.preClickClasses, !this.clicked);
+    this.outputTarget.classList.toggle(this.postClickClasses, this.clicked);
+
+    if (this.clicked)
+      this.outputTarget.textContent = `Hello, ${this.nameTarget.value}!`
+    else
+      this.clear();
+  }
+
+  clear() {
+    this.outputTarget.textContent = '...';
+    this.nameTarget.value = '';
+  }
+}
+```
+
+The slot renders a `ButtonComponent` component:
+
+```ruby
+# app/components/button_component.rb
+
+class ButtonComponent < ViewComponent::Base
+  # This component uses Vident::TypedComponent which uses dry-types to define typed attributes.
+  include Vident::TypedComponent
+
+  # The attributes can specify an expected type, a default value and if nil is allowed.
+  attribute :after_clicked, String, default: "Greeted!"
+  attribute :before_clicked, String, allow_nil: false
+
+  # This example is a templateless ViewComponent.
+  def call
+    # The button is rendered as a <button> tag with an click action on its own controller.
+    render root(
+      element_tag: :button,
+      
+      # We can define actions as arrays of Symbols, or pass manually manually crafted strings.
+      # Here we specify the action name only, implying an action on the current components controller
+      # and the default event type of `click`.
+      actions: [:change_message],
+      # Alternatively: [:click, :change_message] or ["click", "changeMessage"] or even "click->button-component#changeMessage"
+      
+      # A couple of data values are also set which will be available to the controller
+      data_maps: [{after_clicked_message: after_clicked, before_clicked_message: before_clicked}],
+      
+      # The <button> tag has a default styling set directly on it. Note that
+      # if not using utility classes, you can style the component using its 
+      # canonical class name (which is equal to the component's stimulus identifier), 
+      # in this case `button-component`.
+      html_options: {class: "ml-4 whitespace-no-wrap bg-blue-500 hover:bg-blue-700 text-white font-bold py-2 px-4 rounded"}
+    ) do
+      @before_clicked
+    end
+  end
+end
+```
+
+```js  
+// app/components/button_component_controller.js
+
+import { Controller } from "@hotwired/stimulus"
+
+export default class extends Controller {
+  // The action is in camelCase.
+  changeMessage() {
+    this.clicked = !this.clicked;
+    // The data attributes have their naming convention converted to camelCase.
+    this.element.textContent = this.clicked ? this.data.get("afterClickedMessage") : this.data.get("beforeClickedMessage");
+  }
+}
+
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'vident'
+```
+
+Also ensure you have installed your chosen view component library, eg:
+
+```ruby
+gem 'view_component'
+```
+
+or
+
+```ruby
+gem 'phlex' # Must be version 0.5 or higher
+```
+
+or **both**!
+
+If you want to use typed attributes you must also include `dry-struct`
+
+```ruby
+gem 'dry-struct'
+```
+
+And then execute:
+
+    $ bundle install
+
+## Making 'sidecar' Stimulus Controllers work
+
+### When using `stimulus-rails`, `sprockets-rails` & `importmap-rails`
+
+Pin any JS modules from under `app/views` and `app/components` which are sidecar with their respective components.
+
+Add to `config/importmap.rb`:
+
+```ruby
+components_directories = [Rails.root.join("app/components"), Rails.root.join("app/views")]
+components_directories.each do |components_path|
+  prefix = components_path.basename.to_s
+  components_path.glob("**/*_controller.js").each do |controller|
+    name = controller.relative_path_from(components_path).to_s.remove(/\.js$/)
+    pin "#{prefix}/#{name}", to: name
+  end
+end
+```
+
+Note we don't use `pin_all_from` as it is meant to work with a subdirectory in `assets.paths`
+See this for more: https://stackoverflow.com/a/73228193/268602
+
+Then we need to ensure that sprockets picks up those files in build, so add
+to the `app/assets/config/manifest.js`:
+
+```js
+//= link_tree ../../components .js
+//= link_tree ../../views .js
+```
+
+We also need to add to `assets.paths`. Add to your to `config/application.rb`
+
+```ruby
+config.importmap.cache_sweepers.append(Rails.root.join("app/components"), Rails.root.join("app/views"))
+config.assets.paths.append("app/components", "app/views")
+```
+
+### When using `webpacker`
+
+TODO
+
+### When using `propshaft`
+
+TODO
+
+## Using TypeScript for Stimulus Controllers
+
+TODO
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Running the Examples in `test/dummy`
+
+```bash
+cd test/dummy
+bundle install
+rails assets:precompile
+rails s
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/stevegeek/vident. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/vident/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Vident project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/vident/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+require "standard/rake"
+
+task default: %i[test standard]

data/lib/tasks/vident.rake

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

data/lib/vident/attributes/not_typed.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module Vident
+  module Attributes
+    module NotTyped
+      extend ActiveSupport::Concern
+
+      def attributes
+        @__attributes ||= {}
+      end
+
+      def prepare_attributes(attributes)
+        @__attributes ||= {}
+        attribute_names.each do |attr_name|
+          options = self.class.attribute_options
+          default = options&.dig(attr_name, :default)
+          allow_nil = options[attr_name] ? options[attr_name].fetch(:allow_nil, true) : true
+          if attributes&.include? attr_name
+            value = attributes[attr_name]
+            @__attributes[attr_name] = (value.nil? && default) ? default : value
+          else
+            @__attributes[attr_name] = default
+          end
+          raise ArgumentError, "Attribute #{attr_name} cannot be nil" if @__attributes[attr_name].nil? && !allow_nil
+          instance_variable_set(self.class.attribute_ivar_names[attr_name], @__attributes[attr_name])
+        end
+      end
+
+      def attribute_names
+        self.class.attribute_names
+      end
+
+      def attribute(key)
+        attributes[key]
+      end
+
+      def to_hash
+        attributes.dup
+      end
+
+      class_methods do
+        def inherited(subclass)
+          subclass.instance_variable_set(:@attribute_ivar_names, @attribute_ivar_names.clone)
+          super
+        end
+
+        attr_reader :attribute_ivar_names, :attribute_names, :attribute_options
+
+        def attribute(name, **options)
+          @attribute_names ||= []
+          @attribute_names << name
+          @attribute_ivar_names ||= {}
+          @attribute_ivar_names[name] = :"@#{name}"
+          @attribute_options ||= {}
+          @attribute_options[name] = options
+          define_attribute_delegate(name) if delegates?(options)
+        end
+
+        def delegates?(options)
+          options[:delegates] != false
+        end
+
+        def define_attribute_delegate(attr_name)
+          # Define reader & presence check method
+          class_eval(<<-RUBY, __FILE__, __LINE__ + 1)
+          def #{attr_name}
+            @#{attr_name}
+          end
+
+          def #{attr_name}?
+            send(:#{attr_name}).present?
+          end
+          RUBY
+        end
+      end
+    end
+  end
+end