stimulus_attrs 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 31c234dcff3bfb134e7f02ed13f084dd712f787ae855ef4f02ba2d2e58b0eed7
+  data.tar.gz: afe2cc728ae77855ed37487d00d46b96a9819f582bbac00b439e1e5eb2c47d11
+SHA512:
+  metadata.gz: 9e0f166fc3375af1f43102f8ef1fee6bd21401b0c8d001e78acbda9b9371f9c4e784e7f0315e56443b8e9f44e554e89e945c6c09e34d5bd348c3c4501535f626
+  data.tar.gz: 3627534f617998ce45d75559d7635d3001c5d24532810d7ccdca0f903096dc202a8d568d7196a5300b42728a70488695ccf27e1d3d43a42cea678a9dd5bc7760

data/.standard.yml

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

data/Gemfile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in stimulus_attrs.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+
+gem 'minitest', '~> 5.0'
+
+group :test do
+  gem 'actionview', '>= 6.0.0'
+  gem 'activesupport', '>= 6.0.0'
+end

data/Gemfile.lock

@@ -0,0 +1,70 @@
+PATH
+  remote: .
+  specs:
+    stimulus_attrs (0.1.0)
+      activesupport (>= 6.0.0)
+      html_attrs (>= 1.1.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionview (7.1.3.2)
+      activesupport (= 7.1.3.2)
+      builder (~> 3.1)
+      erubi (~> 1.11)
+      rails-dom-testing (~> 2.2)
+      rails-html-sanitizer (~> 1.6)
+    activesupport (7.1.3.2)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
+    base64 (0.2.0)
+    bigdecimal (3.1.7)
+    builder (3.2.4)
+    concurrent-ruby (1.2.3)
+    connection_pool (2.4.1)
+    crass (1.0.6)
+    drb (2.2.1)
+    erubi (1.12.0)
+    html_attrs (1.1.2)
+      actionview (>= 6.0)
+      activesupport (>= 6.0)
+    i18n (1.14.4)
+      concurrent-ruby (~> 1.0)
+    loofah (2.22.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.12.0)
+    minitest (5.22.3)
+    mutex_m (0.2.0)
+    nokogiri (1.16.3-arm64-darwin)
+      racc (~> 1.4)
+    racc (1.7.3)
+    rails-dom-testing (2.2.0)
+      activesupport (>= 5.0.0)
+      minitest
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.6.0)
+      loofah (~> 2.21)
+      nokogiri (~> 1.14)
+    rake (13.1.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+
+PLATFORMS
+  arm64-darwin-22
+
+DEPENDENCIES
+  actionview (>= 6.0.0)
+  activesupport (>= 6.0.0)
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  stimulus_attrs!
+
+BUNDLED WITH
+   2.4.13

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Owais
+
+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,35 @@
+# StimulusAttrs
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/stimulus_attrs`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+## 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/owaiswiz/stimulus_attrs.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

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/stimulus_attrs/default_identifier.rb

@@ -0,0 +1,18 @@
+module StimulusAttrs::DefaultIdentifier
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    def identifier_for_stimulus_attrs
+      # Convert things like 'Admin::UserAvatarComponent' to 'admin--user-avatar'
+      @identifier_for_stimulus_attrs ||= name.gsub('::Component', '').gsub(/Component$/, '')
+                                             .underscore.gsub('/', '--').gsub('_', '-')
+    end
+  end
+
+  def identifier_for_stimulus_attrs
+    self.class.identifier_for_stimulus_attrs
+  end
+
+  ViewComponent::Base.include(self) if defined?(ViewComponent::Base)
+  Phlex::HTML.include(self) if defined?(Phlex::HTML)
+end

data/lib/stimulus_attrs/helpers.rb

@@ -0,0 +1,17 @@
+module StimulusAttrs::Helpers
+  %i[controller target values classes actions params outlets].each do |method|
+    define_method("stimulus_#{method}") do |*args, **kwargs|
+      kwargs[:identifier] ||= identifier_for_stimulus_attrs if respond_to?(:identifier_for_stimulus_attrs)
+      if self.class.respond_to?(:identifier_for_stimulus_attrs)
+        kwargs[:identifier] ||= self.class.identifier_for_stimulus_attrs
+      end
+      StimulusAttrs.public_send(method, *args, **kwargs)
+    end
+  end
+
+  ActiveSupport.on_load(:action_view) do
+    include StimulusAttrs::Helpers
+  end
+  ViewComponent::Base.include(self) if defined?(ViewComponent::Base)
+  Phlex::HTML.include(self) if defined?(Phlex::HTML)
+end

data/lib/stimulus_attrs/identifier_scope.rb

@@ -0,0 +1,13 @@
+class StimulusAttrs::IdentifierScope
+  def initialize(identifier)
+    @identifier = identifier
+  end
+
+  def method_missing(*args, **kwargs, &block)
+    StimulusAttrs.send(*args, **kwargs, identifier: @identifier, &block)
+  end
+
+  def respond_to_missing?(*args)
+    StimulusAttrs.respond_to?(*args)
+  end
+end

data/lib/stimulus_attrs.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+require 'active_support'
+require 'active_support/notifications'
+require 'active_support/concern'
+require 'active_support/core_ext/string/inflections'
+require 'html_attrs'
+
+class StimulusAttrs < HtmlAttrs # rubocop:disable Style/Documentation
+  VERSION = '0.1.0'
+
+  require_relative 'stimulus_attrs/identifier_scope'
+  require_relative 'stimulus_attrs/helpers'
+  require_relative 'stimulus_attrs/default_identifier'
+
+  alias merge smart_merge
+
+  def self.controller(identifier_as_arg = nil, values: nil, classes: nil, actions: nil, params: nil, outlets: nil, identifier: nil)
+    identifier ||= identifier_as_arg
+    raise ArgumentError, 'identifier is required' unless identifier
+    controller_referenced(identifier)
+
+    result = new(data: { controller: identifier })
+    result = result.merge(self.values(**values, identifier: identifier)) if values
+    result = result.merge(self.classes(**classes, identifier: identifier)) if classes
+    result = result.merge(self.actions(**actions, identifier: identifier)) if actions
+    result = result.merge(self.params(**params, identifier: identifier)) if params
+    result = result.merge(self.outlets(**outlets, identifier: identifier)) if outlets
+
+    result
+  end
+
+  def self.target(target_name, identifier:)
+    new(data: { "#{identifier}-target" => target_name.to_s.underscore.camelcase(:lower) })
+  end
+
+  def self.values(identifier:, **values)
+    new(data: values.transform_keys { |k| "#{identifier}-#{k.to_s.underscore.dasherize}-value" })
+  end
+
+  def self.classes(identifier:, **classes)
+    new(data: classes.transform_keys { |k| "#{identifier}-#{k.to_s.underscore.dasherize}-class" })
+  end
+
+  # `descriptor` is what stimulus calls things that go inside data-action: https://stimulus.hotwired.dev/reference/actions#descriptors
+  def self.actions(descriptor = nil, identifier: nil, params: nil, **descriptors)
+    if descriptor
+      # Keep the default descriptors near the start of the action list
+      descriptors = { nil => [descriptor] + Array(descriptors.delete(nil)) }.merge(descriptors)
+    end
+
+    action = descriptors.map do |event, methods|
+      Array(methods).map do |method|
+        method = method.to_s
+        prepend_identifier = !method.include?('#')
+        raise ArgumentError, 'identifier is required' if prepend_identifier && !identifier
+
+        method = method.to_s.underscore.camelcase(:lower) if prepend_identifier
+        method = "#{identifier}##{method}" if prepend_identifier
+        event ? "#{event}->#{method}" : method
+      end
+    end.flatten.join(' ')
+
+    result = new(data: { action: action })
+    result = result.merge(self.params(**params, identifier: identifier)) if params.present?
+    result
+  end
+
+  def self.params(identifier:, **params)
+    new(data: params.transform_keys { |k| "#{identifier}-#{k.to_s.underscore.dasherize}-param" })
+  end
+
+  def self.outlets(identifier:, **outlets)
+    new(data: outlets.transform_keys { |k| "#{identifier}-#{k.to_s.underscore.dasherize}-outlet" })
+  end
+
+  def self.with_identifier(identifier, &block)
+    scope = IdentifierScope.new(identifier)
+    yield scope if block
+    scope
+  end
+
+  def self.controller_referenced(identifier)
+    return unless instrumentation_enabled?
+    ActiveSupport::Notifications.instrument('controller_referenced.stimulus_attrs', identifier: identifier)
+  end
+
+  def self.instrumentation_enabled?
+    !!@instrumentation_enabled
+  end
+
+  def self.instrumentation_enabled=(value)
+    @instrumentation_enabled = value
+  end
+end

data/sig/stimulus_attrs.rbs

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

metadata

@@ -0,0 +1,85 @@
+--- !ruby/object:Gem::Specification
+name: stimulus_attrs
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Owais
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-03-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: html_attrs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+description: Helpers to simplify rendering Stimulus data attributes
+email:
+- owaiswiz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".standard.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/stimulus_attrs.rb
+- lib/stimulus_attrs/default_identifier.rb
+- lib/stimulus_attrs/helpers.rb
+- lib/stimulus_attrs/identifier_scope.rb
+- sig/stimulus_attrs.rbs
+homepage: https://github.com/owaiswiz/stimulus_attrs
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/owaiswiz/stimulus_attrs
+  source_code_uri: https://github.com/owaiswiz/stimulus_attrs
+  changelog_uri: https://github.com/owaiswiz/stimulus_attrs/releases
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Helpers to simplify rendering Stimulus data attributes
+test_files: []