has_stimulus_attrs 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e702f304344f1da5c028901abba68b02aec77c575cef53dedc213aa5b684c68d
+  data.tar.gz: 15d9bd70b5bf3a905a8b7a4a32f685763e0f57a0a7c38f340d989aaf6191f28a
+SHA512:
+  metadata.gz: 7fb5adfb5f24e1434260cb128ed8055238498e93a21ae97d94a4ebfffab95dab23646db78cadec1598482ab3f5b5db7a2e9c59181cbaeab7a8f95dd3d6deb1bd
+  data.tar.gz: 598f5ad7b233c3ba368d897fa8fa4a57ca9601f790c9afe843e5df625b432c1d0bfeb8a371843f1c760fdacaae600b1fbc84b6de1ac8816ca83b4327c7d9452f

data/.rubocop.yml

@@ -0,0 +1,6 @@
+inherit_gem:
+  rubocop-rails_config:
+    - config/rails.yml
+
+AllCops:
+  TargetRubyVersion: 3.1

data/.ruby-version

@@ -0,0 +1 @@
+3.1.2

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in has_stimulus_attrs.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Tomáš Celizna
+
+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,89 @@
+# HasStimulusAttrs
+
+[![HasStimulusAttrs](https://github.com/tomasc/has_stimulus_attrs/actions/workflows/ruby.yml/badge.svg)](https://github.com/tomasc/has_stimulus_attrs/actions/workflows/ruby.yml)
+
+Helper methods for dealing with [stimulus](https://stimulus.hotwired.dev/) data attributes.
+
+Relies on [`has_dom_attrs`](github.com/tomasc/has_dom_attrs) and [`stimulus_helpers`](github.com/tomasc/stimulus_helpers).
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add has_stimulus_attrs
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install has_stimulus_attrs
+
+## Usage
+
+Include `HasStimulusAttrs` in your class and define a `controller_name` class method:
+
+```ruby
+class ModalComponent
+  include HasStimulusAttrs
+
+  def self.controller_name
+    "modal-component"
+  end
+end
+```
+
+`controller_name` can also be defined in a base class and dynamically resolved:
+
+```ruby
+class ApplicationComponent
+  include HasStimulusAttrs
+
+  def self.controller_name
+    self.name.underscore.dasherize
+  end
+end
+
+class DetailsComponent < ApplicationComponent
+end
+
+DetailsComponent.new.controller_name
+# => "details-component"
+```
+
+You can then use the included class methods to easily set stimulus attributes on
+your class:
+
+```ruby
+class ModalComponent < ApplicationComponent
+  has_stimulus_controller # sets the "controller" data attribute using :controller_name by default
+  has_stimulus_controller "click-outside"
+  has_stimulus_controller "scroll-lock", if: :open? # conditionally add the controller
+  has_stimulus_controller "scroll-lock", unless: :closed? # conditionally add the controller
+
+  has_stimulus_action "click", "onClick"
+  has_stimulus_action "click", "onClick", if: :open?
+
+  has_stimulus_class "open", "modal--open"
+  has_stimulus_class "width", -> { "modal--#{width}" } # resolve the class name dynamically
+
+  has_stimulus_outlet "outlet", ".selector"
+
+  has_stimulus_param id: 123
+  has_stimulus_param id: -> { id }
+
+  has_stimulus_target "target"
+  has_stimulus_target "target", controller: "other-controller"
+
+  has_stimulus_value "id", 123
+  has_stimulus_value "id", -> { id }
+  has_stimulus_value "id", -> { id }, controller: "other-controller"
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/[USERNAME]/has_stimulus_attrs.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+task default: :test

data/has_stimulus_attrs.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require_relative "lib/has_stimulus_attrs/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "has_stimulus_attrs"
+  spec.version = HasStimulusAttrs::VERSION
+  spec.authors = ["Tomas Celizna", "Asger Behncke Jacobsen"]
+  spec.email = ["tomas.celizna@gmail.com", "a@asgerbehnckejacobsen.dk"]
+
+  spec.summary = "Helper methods for dealing with stimulus attributes."
+  spec.description = "Helper methods for dealing with stimulus attributes."
+  spec.homepage = "https://github.com/tomasc/has_stimulus_attrs"
+  spec.required_ruby_version = ">= 3.1.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "https://github.com/tomasc/has_stimulus_attrs/CHANGELOG.md"
+
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "stimulus_helpers", "~> 0.1.0"
+  spec.add_dependency "has_dom_attrs", "~> 0.1.0"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest", "~> 5.0"
+
+  spec.add_development_dependency "lefthook"
+  spec.add_development_dependency "rubocop-rails_config"
+end

data/lefthook.yml

@@ -0,0 +1,5 @@
+pre-commit:
+  parallel: true
+  commands:
+    rubocop:
+      run: bundle exec rubocop {staged_files} -A --display-cop-names --extra-details --force-exclusion

data/lib/has_stimulus_attrs/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module HasStimulusAttrs
+  VERSION = "0.1.0"
+end

data/lib/has_stimulus_attrs.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+require_relative "has_stimulus_attrs/version"
+
+require "has_dom_attrs"
+require "stimulus_helpers"
+
+module HasStimulusAttrs
+  include HasDomAttrs
+  include StimulusHelpers
+
+  class << self
+    def included(base)
+      base.extend ClassMethods
+    end
+  end
+
+  module ClassMethods
+    def controller_name
+      raise NotImplementedError
+    end
+
+    def has_stimulus_controller(name = controller_name, **options)
+      key = :controller
+      val = name
+
+      prepend___has_stimulus___method(key, val, **options)
+    end
+
+    def has_stimulus_action(event, action, controller: nil, **options)
+      key = :action
+      val = -> { stimulus_action((controller || controller_name), event, action).values.first }
+
+      prepend___has_stimulus___method(key, val, **options)
+    end
+
+    def has_stimulus_class(name, value, controller: nil, **options)
+      key = -> { stimulus_class((controller || controller_name), name, "N/A").keys.first }
+      val = -> {
+        v = case value
+            when Proc then instance_exec(&value)
+            else value.to_s
+        end
+        stimulus_class((controller || controller_name), name, v).values.first
+      }
+
+      prepend___has_stimulus___method(key, val, **options)
+    end
+
+    def has_stimulus_outlet(name, value, controller: nil, **options)
+      key = -> { stimulus_outlet((controller || controller_name), name, "N/A").keys.first }
+      val = -> {
+        v = case value
+            when Proc then instance_exec(&value)
+            when Symbol then send(value)
+            else value
+        end
+        stimulus_outlet((controller || controller_name), name, v).values.first
+      }
+
+      prepend___has_stimulus___method(key, val, **options)
+    end
+
+    def has_stimulus_param(name, value, controller: nil, **options)
+      key = -> { stimulus_param((controller || controller_name), name, "N/A").keys.first }
+      val = -> {
+        v = case value
+            when Proc then instance_exec(&value)
+            when Symbol then send(value)
+            else value
+        end
+        stimulus_param((controller || controller_name), name, v).values.first
+      }
+
+      prepend___has_stimulus___method(key, val, **options)
+    end
+
+    def has_stimulus_target(name, controller: nil, **options)
+      key = -> { stimulus_target((controller || controller_name), name).keys.first }
+      val = -> { stimulus_target((controller || controller_name), name).values.first }
+
+      prepend___has_stimulus___method(key, val, **options)
+    end
+
+    def has_stimulus_value(name, value = nil, controller: nil, **options)
+      key = -> { stimulus_value((controller || controller_name), name, "N/A").keys.first }
+      val = -> {
+        v = case value
+            when Proc then instance_exec(&value)
+            when Symbol then send(value)
+            when NilClass then send(name)
+            else value
+        end
+        stimulus_value((controller || controller_name), name, v).values.first
+      }
+
+      prepend___has_stimulus___method(key, val, **options)
+    end
+
+    private
+      def prepend___has_stimulus___method(key, value, **options)
+        prepend(
+          Module.new do
+            define_method :dom_data do
+              cond = options[:if] || options[:unless]
+              cond_value = case cond
+                           when Proc then instance_exec(&cond)
+                           when Symbol, String then send(cond)
+              end
+
+              if cond && options.key?(:if)
+                return super() unless cond_value
+              end
+
+              if cond && options.key?(:unless)
+                return super() if cond_value
+              end
+
+              k = case key
+                  when Proc then instance_exec(&key)
+                  else key
+              end
+
+              v = case value
+                  when Proc then instance_exec(&value)
+                  else value
+              end
+
+              super().tap do |data|
+                data[k] = [data[k], v].reject(&:blank?).uniq.join(" ")
+              end
+            end
+          end
+        )
+      end
+  end
+end

data/sig/has_stimulus_attrs.rbs

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

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: has_stimulus_attrs
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tomas Celizna
+- Asger Behncke Jacobsen
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-03-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: stimulus_helpers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: has_dom_attrs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: lefthook
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rails_config
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Helper methods for dealing with stimulus attributes.
+email:
+- tomas.celizna@gmail.com
+- a@asgerbehnckejacobsen.dk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- ".ruby-version"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- has_stimulus_attrs.gemspec
+- lefthook.yml
+- lib/has_stimulus_attrs.rb
+- lib/has_stimulus_attrs/version.rb
+- sig/has_stimulus_attrs.rbs
+homepage: https://github.com/tomasc/has_stimulus_attrs
+licenses: []
+metadata:
+  homepage_uri: https://github.com/tomasc/has_stimulus_attrs
+  source_code_uri: https://github.com/tomasc/has_stimulus_attrs
+  changelog_uri: https://github.com/tomasc/has_stimulus_attrs/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Helper methods for dealing with stimulus attributes.
+test_files: []