phlex-stimulus 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5f51c97b602da2ffe25109fc4229e2980839134de4602912fcda7de9993331a
-  data.tar.gz: 16897e82b71726d0b84e33b1f3b7fdb00387408f892180d7e529aa48ce53b177
+  metadata.gz: '01190c3e09b4d2381741d1191ba5b06f2222fed5c20246e69732f80672e742b0'
+  data.tar.gz: 79686f42a9561d53b17c94f7652c762ba9d43358ad710f8fd456129907ea0e76
 SHA512:
-  metadata.gz: 304b3c3b6a8a9160a5e873864621cfa6a9f6047bd1808e93a595eb9f5a47a86fecde535b060278cdbaae49c546d24bc79dadba3ec1f3038920f4592b26e92fbe
-  data.tar.gz: b815213393ae0d157571a6fe46fc081386bd657bfa71a4f93afc369b9bc1d1b65f25c404d67d8ed17ad24a66fbae9294bc849527742dbd9508c411b7f5ee7717
+  metadata.gz: 5e857f549c94fa68e8639f9e8bbcfda48626bbf2e3fb960d25d0e1490f97c453cce96174239c660532a1be4a2abd2be85a82221f3a8c2c380da24b5d9ed24fde
+  data.tar.gz: 7d459a8ff17f0626c0fc692b5b9fa929c2081815b8438e38a198518f10e94a16d0157a2c6e5ce94597c37914085d2a8216d121e8e67ffa51bb845af437d43334

data/CHANGELOG.md

@@ -9,6 +9,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 Add changes in new features here. Do not change the gem's version in pull/merge requests.
 
+## [0.2.0] - 29.07.2026
+
+[Diff](https://github.com/espago/phlex-stimulus/compare/v0.1.3...v0.2.0)
+
+- Add action parameter support
+
+## [0.1.3] - 28.07.2026
+
+[Diff](https://github.com/espago/phlex-stimulus/compare/v0.1.2...v0.1.3)
+
+- Fix tapioca compiler
+
 ## [0.1.2] - 27.07.2026
 
 [Diff](https://github.com/espago/phlex-stimulus/compare/v0.1.1...v0.1.2)

data/README.md

@@ -210,6 +210,40 @@ This is the same as:
 div(data: { 'summary:redirected' => 'other#do' })
 ```
 
+#### `param`
+
+This method helps you get the names of parameters
+given to stimulus actions.
+You can read more about action parameters [here](https://stimulus.hotwired.dev/reference/https://stimulus.hotwired.dev/reference/actions#action-parameters).
+
+```rb
+class SummaryController < Controller
+  self.controller_name = 'summary'
+
+  actions :foo
+end
+
+SummaryController.param('id') #=> "summary-id-param"
+```
+
+You would use it like so to define a parameter for a stimulus action:
+
+```rb
+div(
+  data: {
+    action: event('click', SummaryController.foo_action),
+    # will be available as `event.id` in the action
+    SummaryController.param('id') => 35,
+  },
+)
+```
+
+This is the same as:
+
+```rb
+div(data: { 'summary:redirected' => 'other#do' })
+```
+
 ### Component Helpers
 
 There are some useful helper methods you can use in every phlex component.

data/lib/generators/phlex/stimulus/install/install_generator.rb

@@ -59,6 +59,17 @@ module Phlex::Stimulus::Generators
 
       copy_template 'app/javascript/utils/misc.ts'
       copy_template 'app/javascript/utils/template.ts'
+
+      append_to_file File.join(destination_root, 'sorbet', 'tapioca', 'require.rb'), <<~RUBY
+
+        # monkey patch so that tapioca doesn't override
+        # the default `new` constructor
+        class Phlex::SGML
+          class << self
+            undef_method :new
+          end
+        end
+      RUBY
     end
 
     private

data/lib/phlex/stimulus/components/controller.rb

@@ -84,6 +84,16 @@ module Phlex::Stimulus
           @target_defs ||= []
         end
 
+        # Constructs a Stimulus action parameter name
+        # eg.
+        #
+        #     SummaryController.param('id') #=> "summary-id-param"
+        #
+        #: (String) -> String
+        def param(param_name)
+          "#{controller_name}-#{param_name}-param"
+        end
+
         # Constructs a Stimulus dispatched event name
         # eg.
         #

data/lib/phlex/stimulus/version.rb

@@ -3,6 +3,6 @@
 
 module Phlex
   module Stimulus
-    VERSION = '0.1.2'
+    VERSION = '0.2.0'
   end
 end

data/{sorbet/tapioca → lib/tapioca/dsl}/compilers/phlex_controller.rb

@@ -23,7 +23,7 @@ module Tapioca
       def decorate
         root.create_path(constant) do |klass|
           klass.comments << RBI::Comment.new(
-            <<~DOC
+            <<~DOC,
               A Phlex component that wraps the `#{constant.controller_name.inspect}` Stimulus controller.
 
               LINK: #{constant.controller_path}
@@ -43,12 +43,12 @@ module Tapioca
 
                   Result: `#{action.full_name.inspect}`
                 DOC
-              )
+              ),
             ]
             mod.create_method(
               action.ruby_action_method_name,
               return_type: 'String',
-              comments: comments,
+              comments:    comments,
             )
           end
 
@@ -62,12 +62,12 @@ module Tapioca
 
                   Result: `#{target.target_name.inspect}`
                 DOC
-              )
+              ),
             ]
             mod.create_method(
               target.ruby_target_method_name,
               return_type: 'String',
-              comments: comments,
+              comments:    comments,
             )
           end
 

data/rbi/phlex.rbi

@@ -0,0 +1,41 @@
+# typed: true
+
+class Phlex::HTML < Phlex::SGML
+  include ActionView::Helpers::AssetUrlHelper
+  include ActionView::Helpers::FormHelper
+  include ActionView::Helpers::AssetTagHelper
+  include ActionView::Helpers::NumberHelper
+
+  sig { params(key: T.untyped, options: T.untyped).returns(String) }
+  def t(key, **options); end
+
+  def label(**attributes); end
+
+  def form_authenticity_token(*_arg0, **_arg1, &_arg2); end
+
+  sig { returns(ApplicationController::HelperProxy) }
+  def view_context; end
+
+  # Outputs an `<svg>` tag.
+  #
+  # [MDN Docs](https://developer.mozilla.org/docs/Web/SVG/Element/svg)
+  # [Spec](https://html.spec.whatwg.org/#the-svg-element)
+  #
+  # source://phlex//lib/phlex/html.rb#20
+  #
+  #: (*untyped, **String) ?{ (Phlex::SVG) -> void } -> void
+  def svg(*args, **attrs, &block); end
+end
+
+class Phlex::SGML
+  #: (String?) -> void
+  def plain(content); end
+
+  #: (String?) -> void
+  def raw(content); end
+end
+
+module Phlex::Rails::Helpers::Translate
+  sig { params(key: String, _arg1: T.anything).returns(String) }
+  def t(key, **_arg1); end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: phlex-stimulus
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Espago
@@ -130,6 +130,8 @@ files:
 - lib/phlex/stimulus/components/base.rb
 - lib/phlex/stimulus/components/controller.rb
 - lib/phlex/stimulus/version.rb
+- lib/tapioca/dsl/compilers/phlex_controller.rb
+- rbi/phlex.rbi
 - sorbet/config
 - sorbet/rbi/annotations/.gitattributes
 - sorbet/rbi/annotations/actionmailer.rbi
@@ -234,7 +236,6 @@ files:
 - sorbet/rbi/shims/gems/rails.rbi
 - sorbet/rbi/shims/gems/refract.rbi
 - sorbet/rbi/shims/gems/shoulda-context.rbi
-- sorbet/tapioca/compilers/phlex_controller.rb
 - sorbet/tapioca/config.yml
 - sorbet/tapioca/extensions/load_gem.rb
 - sorbet/tapioca/require.rb