stimulus-controller 0.0.0 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 798abb5408b0b8f06b89fb2497c59039b5711b148cd0851d4171162822a7100f
-  data.tar.gz: ed2461a44d469b9812d2ca949ca54d29a53ff5c6d44eb1faa36a5af5b0f338ad
+  metadata.gz: fba998e8b72b91d84ca482b10b2e8e7bb0fedfa0b875b4a18f1b5e5461c5097b
+  data.tar.gz: 72b1e7b36a1d38648b59cf3aa2a00fc740c3c78c627c9d8f33af0a14e6c2e585
 SHA512:
-  metadata.gz: e0bcefaf47bbd36c620f68c82f2b58fd0258a9fc566b35c4ea899d0ef02402cba75f753d9933e0f00f789979a73d9dc98271f2efc855a2e37516477be99b227b
-  data.tar.gz: '0835bc01065a15c232b9aa69da6f0983281189964edfead38bdb363290767462d6f4bb0480723f862ada265893fb455ba1915bc99f0acdf90be79d5fc24ba835'
+  metadata.gz: 06d819531887cbfe6964e9229923a2bc2195c6b1128c9247aad11ae7f8c50469e9dcf36ad97a3d8982347a0cfe8aaa456be39dc5e7f8cd18d9eb3c819916801d
+  data.tar.gz: 8e034be8a25b551ddb0bb4bc98e86a4a9b4d2752ab7c3b5bd729659220f84a3e637cdd2be894180d899f941a6bf197bab7047e0e8880151ce5901b0c89e8e0d8

data/README.md

@@ -1,3 +1,51 @@
 # Stimulus Controller
 
-Rubygem for add a view helper to a rails app for creating a stimulus controller
+A Ruby gem that adds a view helper to a Rails app for embedding a stimulus controller with its most essential functions.
+
+It does not support all functions from Stimulus because, in our opinion, Stimulus should only be
+used as an initialiser with Hotwired and nothing else.
+
+### Installation
+
+Add
+
+```ruby
+gem 'stimulus-controller'
+```
+
+to your gemfile and run `bundle`
+
+### Usage example with .haml
+
+```haml
+= stimulus_controller("my-controller", { items: ["Item-1"] }, class: 'my-css-class') do |sc|
+  = content_tag :div, data: sc.click('myAction') do
+    = "my-Action-Button"
+```
+
+Arguments: 
+- Controller Identifier
+- Values (optional):
+  - It must be a Hash.
+  - When the value is a hash or an array, such as in the example of the string '["Item-1"]', it is automatically parsed as JSON.
+- Options for the rendered tag
+
+Have a controller like:
+
+```javascript
+import {Controller} from "@hotwired/stimulus"
+
+export default class extends Controller {
+    static values = {
+        items: Array
+    }
+    
+    myAction() {
+        alert(`Items are: «${JSON.stringify(this.itemsValue)}»`)
+    }
+}
+```
+
+### Stimulus is mainly a initializer!
+
+If you want reactive front-end components, please use our [svelte-on-rails](https://svelte-on-rails.dev/) gem :)

data/lib/stimulus-controller.rb

@@ -1,5 +1,3 @@
 require "stimulus_controller/railtie" if defined?(Rails)
-
-module StimulusController
-
-end
+require "stimulus_controller/view_helpers"
+require "stimulus_controller/helper"

data/lib/stimulus_controller/helper.rb

@@ -0,0 +1,53 @@
+module StimulusController
+  class Helper
+
+    def initialize(controller_identifier)
+      @ctrl_id = controller_identifier
+    end
+
+    def value(key, value)
+      k = "#{@ctrl_id}-#{key}-value"
+      {
+        k.to_sym => value
+      }
+    end
+
+    def action(action)
+      {
+        action: action.sub('->#', "->#{@ctrl_id}#"),
+      }
+    end
+
+    def click(function)
+      {
+        action: "click->#{@ctrl_id}##{function}",
+      }
+    end
+
+    def change(function)
+      {
+        action: "change->#{@ctrl_id}##{function}",
+      }
+    end
+
+    def keyup(function)
+      {
+        action: "keyup->#{@ctrl_id}##{function}",
+      }
+    end
+
+    def target(name)
+      {
+        "#{@ctrl_id}-target": name,
+      }
+    end
+
+    def props(options)
+
+      change(options[:change])
+        .merge(
+          target(options[:target])
+        )
+    end
+  end
+end

data/lib/stimulus_controller/railtie.rb

@@ -1,9 +1,9 @@
 module StimulusController
   class Railtie < Rails::Railtie
 
-    initializer "csedl_stimulus_dropdown.view_helpers" do
+    initializer "stimulus_controller.view_helpers" do
       ActiveSupport.on_load(:action_view) do
-        include CsedlStimulusDropdown::ViewHelpers
+        include StimulusController::ViewHelpers
       end
     end
   end

data/lib/stimulus_controller/view_helpers.rb

@@ -1,7 +1,35 @@
 module StimulusController
   module ViewHelpers
-    def stimulus_controller
+    # first argument: stimulus identifier/path
+    # second argument: values (must be a hash)
+    # following argument: class, id, of the wrapping tag
+    def stimulus_controller(controller_identifier, values = {}, **options)
 
+      if values.present?
+        _values = values.each_with_object({}) do |(k, v), h|
+          _k = "#{controller_identifier}-#{k}-value"
+          if [Array, Hash].include?(v.class)
+            h[_k] = v.to_json
+          else
+            h[_k] = v
+          end
+        end
+        options[:data] = _values
+      end
+
+      hlp = StimulusController::Helper.new(controller_identifier)
+
+      options = options.deep_merge(
+        {
+          data: {
+            controller: controller_identifier
+          }
+        }
+      )
+
+      content_tag :div, options do
+        yield hlp
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stimulus-controller
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.2
 platform: ruby
 authors:
 - Christian Sedlmair
@@ -18,6 +18,7 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/stimulus-controller.rb
+- lib/stimulus_controller/helper.rb
 - lib/stimulus_controller/railtie.rb
 - lib/stimulus_controller/view_helpers.rb
 homepage: https://gitlab.com/sedl/stimulus-controller
@@ -35,7 +36,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="