turbo_power 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2100e6501a16f8b18459a8cb2072e8d9c8f0fda27363a9185275886b4f9e102c
-  data.tar.gz: 3bd04cb90cc78d23a481240217403f0aea950fca60e83fb800093a68938468bc
+  metadata.gz: 4ec77740a41b50382edd8441dcb76a453fc60d57d5429e107398de38578e147b
+  data.tar.gz: f4419c8721ffd08fdcc02b1f1449d2671af16cc34c7e2f73185777276236bc27
 SHA512:
-  metadata.gz: b05a8b3f4423f0cf19acc08983bdc4e9cd99586b462a971f5e889b9adbe452a3d79f4b2feba087a569f3a8533156bb62484eadddd7b0798ed2fcee6cba2b8b07
-  data.tar.gz: 4998190fa7ef683921c6460a291ff16800bb452578f98bade23844b2500ae26ae8418d3f97da095a99523ca0d1ce722939b8247812a30a3592856f026778cb32
+  metadata.gz: 8f1a90e7eae214a0f6d3d1bcb371f4c8a9f06e302f5a8135a68027be105a6c93f549ba860de1bdc9be7959309c277458295661d9dbd14e2158583017ee931101
+  data.tar.gz: 0a8753c7d57f4865ca27641d8767723dc1d97bda6c5e6fb37aee54f6f1d2e58e64d3e79d2a9472abbce1664e7abb22793d0073ad4d1e999bcc125838424d2f3c

data/Gemfile

@@ -11,3 +11,4 @@ gem "minitest", "~> 5.0"
 gem "rubocop", "~> 1.21"
 
 gem "turbo-rails", github: "marcoroth/turbo-rails", branch: "custom-action-helpers"
+gem "turbo_ready", github: "marcoroth/turbo_ready", branch: "main"

data/Gemfile.lock

@@ -8,15 +8,50 @@ GIT
       activejob (>= 6.0.0)
       railties (>= 6.0.0)
 
+GIT
+  remote: https://github.com/marcoroth/turbo_ready.git
+  revision: ccd0ceb7a1209501f60591c833aba2a150d46066
+  branch: main
+  specs:
+    turbo_ready (0.0.5)
+      rails (>= 6.1)
+      turbo-rails (>= 1.1)
+
 PATH
   remote: .
   specs:
-    turbo_power (0.1.0)
+    turbo_power (0.1.1)
       turbo-rails
+      turbo_ready
 
 GEM
   remote: https://rubygems.org/
   specs:
+    actioncable (7.0.3.1)
+      actionpack (= 7.0.3.1)
+      activesupport (= 7.0.3.1)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (7.0.3.1)
+      actionpack (= 7.0.3.1)
+      activejob (= 7.0.3.1)
+      activerecord (= 7.0.3.1)
+      activestorage (= 7.0.3.1)
+      activesupport (= 7.0.3.1)
+      mail (>= 2.7.1)
+      net-imap
+      net-pop
+      net-smtp
+    actionmailer (7.0.3.1)
+      actionpack (= 7.0.3.1)
+      actionview (= 7.0.3.1)
+      activejob (= 7.0.3.1)
+      activesupport (= 7.0.3.1)
+      mail (~> 2.5, >= 2.5.4)
+      net-imap
+      net-pop
+      net-smtp
+      rails-dom-testing (~> 2.0)
     actionpack (7.0.3.1)
       actionview (= 7.0.3.1)
       activesupport (= 7.0.3.1)
@@ -24,6 +59,13 @@ GEM
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (7.0.3.1)
+      actionpack (= 7.0.3.1)
+      activerecord (= 7.0.3.1)
+      activestorage (= 7.0.3.1)
+      activesupport (= 7.0.3.1)
+      globalid (>= 0.6.0)
+      nokogiri (>= 1.8.5)
     actionview (7.0.3.1)
       activesupport (= 7.0.3.1)
       builder (~> 3.1)
@@ -33,6 +75,18 @@ GEM
     activejob (7.0.3.1)
       activesupport (= 7.0.3.1)
       globalid (>= 0.3.6)
+    activemodel (7.0.3.1)
+      activesupport (= 7.0.3.1)
+    activerecord (7.0.3.1)
+      activemodel (= 7.0.3.1)
+      activesupport (= 7.0.3.1)
+    activestorage (7.0.3.1)
+      actionpack (= 7.0.3.1)
+      activejob (= 7.0.3.1)
+      activerecord (= 7.0.3.1)
+      activesupport (= 7.0.3.1)
+      marcel (~> 1.0)
+      mini_mime (>= 1.1.0)
     activesupport (7.0.3.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
@@ -42,6 +96,7 @@ GEM
     builder (3.2.4)
     concurrent-ruby (1.1.10)
     crass (1.0.6)
+    digest (3.1.0)
     erubi (1.11.0)
     globalid (1.0.0)
       activesupport (>= 5.0)
@@ -51,8 +106,27 @@ GEM
     loofah (2.18.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (1.0.2)
     method_source (1.0.0)
+    mini_mime (1.1.2)
     minitest (5.16.3)
+    net-imap (0.2.3)
+      digest
+      net-protocol
+      strscan
+    net-pop (0.1.1)
+      digest
+      net-protocol
+      timeout
+    net-protocol (0.1.3)
+      timeout
+    net-smtp (0.3.1)
+      digest
+      net-protocol
+      timeout
+    nio4r (2.5.8)
     nokogiri (1.13.8-x86_64-darwin)
       racc (~> 1.4)
     parallel (1.22.1)
@@ -62,6 +136,20 @@ GEM
     rack (2.2.4)
     rack-test (2.0.2)
       rack (>= 1.3)
+    rails (7.0.3.1)
+      actioncable (= 7.0.3.1)
+      actionmailbox (= 7.0.3.1)
+      actionmailer (= 7.0.3.1)
+      actionpack (= 7.0.3.1)
+      actiontext (= 7.0.3.1)
+      actionview (= 7.0.3.1)
+      activejob (= 7.0.3.1)
+      activemodel (= 7.0.3.1)
+      activerecord (= 7.0.3.1)
+      activestorage (= 7.0.3.1)
+      activesupport (= 7.0.3.1)
+      bundler (>= 1.15.0)
+      railties (= 7.0.3.1)
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
@@ -91,10 +179,15 @@ GEM
     rubocop-ast (1.21.0)
       parser (>= 3.1.1.0)
     ruby-progressbar (1.11.0)
+    strscan (3.0.4)
     thor (1.2.1)
+    timeout (0.3.0)
     tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.2.0)
+    websocket-driver (0.7.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
     zeitwerk (2.6.0)
 
 PLATFORMS
@@ -106,6 +199,7 @@ DEPENDENCIES
   rubocop (~> 1.21)
   turbo-rails!
   turbo_power!
+  turbo_ready!
 
 BUNDLED WITH
    2.3.19

data/README.md

@@ -1,20 +1,109 @@
-# TurboPower
+# TurboPower Rails
 
-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/turbo_power`. To experiment with that code, run `bin/console` for an interactive prompt.
+`turbo_power` is a power-pack for Turbo Streams. This gem provides server-side Ruby helpers for the NPM package [`turbo_power`](https://github.com/marcoroth/turbo_power).
 
 ## Installation
 
 Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add turbo_power
+```shell
+bundle add turbo_power
+```
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+Install the JavaScript package:
 
-    $ gem install turbo_power
+```shell
+yarn add turbo_power
+```
+
+Initialize TurboPower in `application.js`:
+
+```diff
+// application.js
+import * as Turbo from '@hotwired/turbo'
+
++import TurboPower from 'turbo_power'
++TurboPower.initialize(Turbo.StreamActions)
+```
 
 ## Usage
 
-TODO: Write usage instructions here
+### Actions from `turbo_ready`
+
+* [`turbo_stream.invoke(method, *args, selector: nil, camelize: true, id: nil)`](https://github.com/hopsoft/turbo_ready)
+
+### Actions from `turbo-morph`
+
+* [`turbo_stream.morph(target, html = nil, **attributes, &block)`](https://github.com/marcoroth/turbo-morph)
+
+### DOM Actions
+
+* `turbo_stream.graft(target, parent, **attributes)`
+* `turbo_stream.inner_html(target, html = nil, **attributes, &block)`
+* `turbo_stream.insert_adjacent_html(target, html = nil, position: 'beforeend', **attributes, &block)`
+* `turbo_stream.insert_adjacent_text(target, text, position: 'beforebegin', **attributes)`
+* `turbo_stream.morph(target, html = nil, **attribtues, &block)`
+* `turbo_stream.outer_html(target, html = nil, **attributes, &block)`
+* `turbo_stream.text_content(target, text, **attributes)`
+* `turbo_stream.set_meta(name, content, **attributes)`
+
+
+### Attribute Actions
+
+* `turbo_stream.add_css_class(target, classes, **attributes)`
+* `turbo_stream.remove_attribute(target, attribute, **attributes)`
+* `turbo_stream.remove_css_class(target, classes, **attributes)`
+* `turbo_stream.set_attribute(target, attribute, value, **attributes)`
+* `turbo_stream.set_dataset_attribute(target, attribute, value, **attributes)`
+* `turbo_stream.set_property(target, property, value, **attributes)`
+* `turbo_stream.set_style(target, name, value, **attributes)`
+* `turbo_stream.set_styles(target, styles, **attributes)`
+* `turbo_stream.set_value(target, value, **attributes)`
+
+
+### Event Actions
+
+* `turbo_stream.dispatch_event(target, name, detail: {}, **attributes)`
+
+
+### Storage Actions
+
+* `turbo_stream.clear_storage(type, **attributes)`
+* `turbo_stream.clear_local_storage(**attributes)`
+* `turbo_stream.clear_session_storage(**attributes)`
+* `turbo_stream.remove_storage_item(key, type, **attributes)`
+* `turbo_stream.remove_local_storage_item(key, **attributes)`
+* `turbo_stream.remove_session_storage_item(key, **attributes)`
+* `turbo_stream.set_storage_item(key, value, type, **attributes)`
+* `turbo_stream.set_local_storage_item(key, value, **attributes)`
+* `turbo_stream.set_session_storage_item(key, value, **attributes)`
+
+
+### Browser Actions
+
+* `turbo_stream.redirect_to(url, action_name = nil, **attributes)`
+* `turbo_stream.reload(**attributes)`
+* `turbo_stream.scroll_into_view(target, inline = "nearest", **attributes)`
+* `turbo_stream.set_cookie(cookie, **attributes)`
+* `turbo_stream.set_cookie_item(key, value, **attributes)`
+* `turbo_stream.set_focus(target, **attributes)`
+
+
+### Browser History Actions
+
+* `turbo_stream.history_go(delta, **attributes)`
+* `turbo_stream.push_state(url, title = nil, state = nil, **attributes)`
+* `turbo_stream.replace_state(url, title = nil, state = nil, **attributes)`
+
+
+### Debug Actions
+
+* `turbo_stream.console_log(message, level = 'log', **attributes)`
+* `turbo_stream.console_table(data, columns, **attributes)`
+
+### Notification Actions
+
+* `turbo_stream.notification(title, options, **attributes)`
 
 ## Development
 
@@ -24,7 +113,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/marcoroth/turbo_power. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/marcoroth/turbo_power/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/marcoroth/turbo_power-rails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/marcoroth/turbo_power-rails/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -32,4 +121,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the TurboPower project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/marcoroth/turbo_power/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the TurboPower project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/marcoroth/turbo_power-rails/blob/master/CODE_OF_CONDUCT.md).

data/lib/turbo_power/stream_helper.rb

@@ -3,7 +3,7 @@ require "turbo-rails"
 module TurboPower
   module StreamHelper
 
-    # DOM Mutations
+    # DOM Actions
 
     def graft(target, parent, **attributes)
       action_all :graft, targets: target, attributes: attributes.merge(parent: parent)
@@ -33,9 +33,12 @@ module TurboPower
       action_all :text_content, targets: target, attributes: attributes.merge(text: text)
     end
 
+    def set_meta(name, content, **attributes)
+      action :set_meta, attributes: attributes.merge(name: name, content: content)
+    end
 
-    # Element Attribute/Property Mutations
 
+    # Attribute Actions
 
     def add_css_class(target, classes, **attributes)
       action_all :add_css_class, targets: target, attributes: attributes.merge(classes: classes)
@@ -74,18 +77,14 @@ module TurboPower
     end
 
 
-    # DOM Events
+    # Event Actions
 
     def dispatch_event(target, name, detail: {}, **attributes)
       action_all :dispatch_event, targets: target, attributes: attributes.merge(detail: detail)
     end
 
-    def set_meta(name, content)
-      action :set_meta, attributes: attributes.merge(name: name, content: content)
-    end
 
-
-    # LocalStorage / SessionStorage
+    # Storage Actions
 
     def clear_storage(type, **attributes)
       action :clear_storage, attributes: attributes.merge(type: type)
@@ -99,7 +98,6 @@ module TurboPower
       clear_storage("session", **attributes)
     end
 
-
     def remove_storage_item(key, type, **attributes)
       action :remove_storage_item, attributes: attributes.merge(key: key, type: type)
     end
@@ -126,18 +124,18 @@ module TurboPower
     end
 
 
-    # Browser Manipulations
+    # Browser Actions
 
     def redirect_to(url, action_name = nil, **attributes)
       action :redirect_to, attributes: attributes.merge(url: url, action: action_name)
     end
 
     def reload(**attributes)
-      action :relaod, attributes: attributes
+      action :reload, attributes: attributes
     end
 
-    def scroll_into_view(target, inline = "nearest")
-      action_all :relaod, targets: target, attributes: attributes.merge(inline: inline)
+    def scroll_into_view(target, inline = "nearest", **attributes)
+      action_all :scroll_into_view, targets: target, attributes: attributes.merge(inline: inline)
     end
 
     def set_cookie(cookie, **attributes)
@@ -145,7 +143,7 @@ module TurboPower
     end
 
     def set_cookie_item(key, value, **attributes)
-      action :set_cookie, attributes: attributes.merge(key: key, value: value)
+      action :set_cookie_item, attributes: attributes.merge(key: key, value: value)
     end
 
     def set_focus(target, **attributes)
@@ -153,7 +151,7 @@ module TurboPower
     end
 
 
-    # Browser History
+    # Browser History Actions
 
     def history_go(delta, **attributes)
       action :history_go, attributes: attributes.merge(delta: delta)
@@ -168,16 +166,18 @@ module TurboPower
     end
 
 
-    # Notifications
+    # Debug Actions
 
-    def console_log(message, level: :log)
-      action :console_log, attributes: { message: message, level: level }
+    def console_log(message, level = :log, **attributes)
+      action :console_log, attributes: attributes.merge(message: message, level: level)
     end
 
     def console_table(data, columns, **attributes)
       action :console_table, attributes: attributes.merge(data: data, columns: columns)
     end
 
+    # Notification Actions
+
     def notification(title, options, **attributes)
       action :notification, attributes: attributes.merge(title: title, options: options)
     end

data/lib/turbo_power/version.rb

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

data/lib/turbo_power.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
 
+require "turbo_ready"
 require_relative "turbo_power/version"
 require_relative "turbo_power/stream_helper"
 
+TurboReady.patch!
+
 module TurboPower
 end

data/turbo_power.gemspec

@@ -29,4 +29,5 @@ Gem::Specification.new do |spec|
   spec.test_files = Dir["test/**/*.rb"]
 
   spec.add_dependency "turbo-rails"
+  spec.add_dependency "turbo_ready"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: turbo_power
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Marco Roth
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-26 00:00:00.000000000 Z
+date: 2022-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: turbo-rails
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: turbo_ready
+  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'
 description: Powerpack for Turbo
 email:
 - marco.roth@hey.com