stimulus_helpers 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: dd7023b93ba3d485fbea28c5eee63938fab133d3a142d40494e0bf37b7216ab1
+  data.tar.gz: 61bd7b0845434ceffeece2f56560207c80f220646622abf207dde1fb79434cf8
+SHA512:
+  metadata.gz: 2d5a7e5abb4d4263004243f8967f9d1f04cc1b360acd68ca13359286a79928f6ce8407dc08962325d96e2bf146dece12193187bd7dcc9aa83f6bc42916723ab0
+  data.tar.gz: 22852bd7e2403fe4acc820cd7626a22caf3ca834f310a17a9751f9c003f7d91b497ad8065b988781cdcdc77f06c127b882904c021831dfb556f5762bc665cf23

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 stimulus_helpers.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,81 @@
+# StimulusHelpers
+
+[![StimulusHelpers](https://github.com/tomasc/stimulus_helpers/actions/workflows/ruby.yml/badge.svg)](https://github.com/tomasc/stimulus_helpers/actions/workflows/ruby.yml)
+
+Helpers to build stimulus controller attributes for use in views and components.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add stimulus_helpers
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install stimulus_helpers
+
+## Usage
+
+Simply include the `StimulusHelpers` module:
+
+```ruby
+class MyClass
+  include StimulusHelpers
+end
+
+# or
+
+ActionView::Base.send :include, StimulusHelpers
+
+# etc.
+```
+
+This will add the following helpers:
+
+```ruby
+stimulus_controller("component")
+# => { "controller" => "component" }
+
+stimulus_action("component", "click", "open")
+# => { "action" => "click->component#open" }
+
+stimulus_actions("component", click: "open", blur: "close")
+# => { "action" => "click->component#open blur->component#close" }
+
+stimulus_class("component", "open", "component--open")
+# => { "component-open-class" => "component--open" }
+
+stimulus_classes("component", open: "component--open", closed: "component--closed")
+# => { "component-open-class" => "component--open", "component-closed-class" => "component--closed" }
+
+stimulus_value("component", "open", true)
+# => { "component-open-value" => "true" }
+
+stimulus_values("component", user: { name: "Jens" }, names: ["foo", "bar"])
+# => { "component-user-value" => "{\"name\":\"Jens\"}", "component-names-value" => "[\"foo\",\"bar\"]" }
+
+stimulus_target("component", :input)
+# => { "component-target" => "input" }
+
+stimulus_param("component", "id", 123)
+# => { "component-id-param" => "123" }
+
+stimulus_params("component", id: 123, name: "Jens")
+# => { "component-id-param" => "123", "component-name-param" => "Jens" }
+
+stimulus_outlet("component", "result", ".result")
+# => { "component-result-outlet" => ".result" }
+
+stimulus_outlets("component", result: ".result", output: ".output")
+# => { "component-result-outlet" => ".result", "component-output-outlet" => ".output" }
+```
+
+## 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]/stimulus_helpers.

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/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/stimulus_helpers/version.rb

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

data/lib/stimulus_helpers.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+require_relative "stimulus_helpers/version"
+require "active_support/core_ext/string/inflections"
+require "json"
+
+module StimulusHelpers
+  # @see https://blog.saeloun.com/2021/09/28/ruby-allow-value-omission-in-hash-literals
+  def stimulus_controller(controller)
+    { controller: }
+  end
+
+  def stimulus_action(controller, action, listener)
+    build_stimulus_action(controller:, actions: { action => listener })
+  end
+
+  def stimulus_actions(controller, actions = {})
+    build_stimulus_action(controller:, actions:)
+  end
+
+  def stimulus_class(controller, name, value)
+    build_stimulus_attribute(
+      controller:,
+      attributes: { name => value },
+      type: "class"
+    )
+  end
+
+  def stimulus_classes(controller, classes = {})
+    build_stimulus_attribute(
+      controller:,
+      attributes: classes,
+      type: "class"
+    )
+  end
+
+  def stimulus_value(controller, name, value)
+    build_stimulus_attribute(
+      controller:,
+      attributes: { name => value },
+      type: "value"
+    )
+  end
+
+  def stimulus_values(controller, values = {})
+    build_stimulus_attribute(
+      controller:,
+      attributes: values,
+      type: "value"
+    )
+  end
+
+  def stimulus_target(controller, target)
+    build_stimulus_attribute(
+      controller:,
+      attributes: { target: }
+    )
+  end
+
+  def stimulus_param(controller, name, value)
+    build_stimulus_attribute(
+      controller:,
+      attributes: { name => value },
+      type: "param"
+    )
+  end
+
+  def stimulus_params(controller, params = {})
+    build_stimulus_attribute(
+      controller:,
+      attributes: params,
+      type: "param"
+    )
+  end
+
+  def stimulus_outlet(controller, name, value)
+    build_stimulus_attribute(
+      controller:,
+      attributes: { name => value },
+      type: "outlet"
+    )
+  end
+
+  def stimulus_outlets(controller, outlets = {})
+    build_stimulus_attribute(
+      controller:,
+      attributes: outlets,
+      type: "outlet"
+    )
+  end
+
+  private
+    def build_stimulus_action(controller:, actions: {})
+      action = actions.map do |action, listeners|
+        Array(listeners).map do |listener|
+          "#{action}->#{controller}##{listener}"
+        end
+      end.join(" ")
+      { action: }
+    end
+
+    def build_stimulus_attribute(controller:, type: nil, attributes: {})
+      attributes.transform_keys! { |key| "#{key}-#{type}" } if type
+      attributes.each_with_object({}) do |(key, value), res|
+        value = value.to_json if value.is_a?(Array) || value.is_a?(Hash)
+        res["#{controller}-#{key.to_s.dasherize}"] = value.to_s
+      end
+    end
+end

data/sig/stimulus_helpers.rbs

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

data/stimulus_helpers.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "lib/stimulus_helpers/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "stimulus_helpers"
+  spec.version = StimulusHelpers::VERSION
+  spec.authors = ["Tomas Celizna", "Asger Behncke Jacobsen"]
+  spec.email = ["tomas.celizna@gmail.com", "a@asgerbehnckejacobsen.dk"]
+
+  spec.summary = "Helper methods for stimulus controllers."
+  spec.description = "Helper methods for stimulus controllers."
+  spec.homepage = "https://github.com/tomasc/stimulus_helpers"
+  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/stimulus_helpers/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 "activesupport"
+
+  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

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: stimulus_helpers
+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: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '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 stimulus controllers.
+email:
+- tomas.celizna@gmail.com
+- a@asgerbehnckejacobsen.dk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lefthook.yml
+- lib/stimulus_helpers.rb
+- lib/stimulus_helpers/version.rb
+- sig/stimulus_helpers.rbs
+- stimulus_helpers.gemspec
+homepage: https://github.com/tomasc/stimulus_helpers
+licenses: []
+metadata:
+  homepage_uri: https://github.com/tomasc/stimulus_helpers
+  source_code_uri: https://github.com/tomasc/stimulus_helpers
+  changelog_uri: https://github.com/tomasc/stimulus_helpers/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 stimulus controllers.
+test_files: []