turbo_ready 0.0.1 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d874913424577d763aad4fcc948b8527f85f0ac27b47b81a520f4dd6c999a6a0
-  data.tar.gz: ec9feee0db78ef6f8affa77a67e9420849e830d6cd861e081e4d59b6d2f7287e
+  metadata.gz: b07e0ce9c51b2f3bc6fab5d95f97266115e1faa7347aae49650e3218f21c9d65
+  data.tar.gz: 589586d61a2c1845dbbabdf19a5ab13b03ef3c06b9ebe7522edab8cdfa9ac9dd
 SHA512:
-  metadata.gz: 25ba8ba8685ecb0d9a63ae5a509b146e089ced8fad07a3b754d24cfc2bd853fdab55ff1da776c0145dc49b57178c0ffdcf7a7710ce1d02d3eafaa047f2b6289e
-  data.tar.gz: 546fbda6d1bc72701d45e1c84925893e9d8c88c56521983fb693e7162861e9a929b9b7c0c66ea1e9525540f4cbf4d45bdbe770ea275019724714fadbf41f8b17
+  metadata.gz: 1c49feb4f8599ce6cd57021fca945fc72df43b9e71202a6c03f4bd7b64f948d09eb8bb7788e5a0fb43a614a37f4ddc210fa919ae79e8437f178a1ced9a76edf2
+  data.tar.gz: b2ad53e8b8799c804f5cfd87dbb5920166943029d524da9a48df8b91f2e23d31fda431e89a047763301ef205d0930bf56e12402b5dfaaa919a366cf702fca1c9

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    turbo_ready (0.0.1)
-      rails (>= 7.0)
+    turbo_ready (0.0.4)
+      rails (>= 6.1)
       turbo-rails (>= 1.1)
 
 GEM
@@ -132,6 +132,8 @@ GEM
       racc (~> 1.4)
     nokogiri (1.13.8-arm64-darwin)
       racc (~> 1.4)
+    nokogiri (1.13.8-x86_64-linux)
+      racc (~> 1.4)
     parallel (1.22.1)
     parser (3.1.2.1)
       ast (~> 2.4.1)
@@ -237,6 +239,7 @@ GEM
 PLATFORMS
   aarch64-linux-musl
   arm64-darwin-21
+  x86_64-linux
 
 DEPENDENCIES
   magic_frozen_string_literal

data/README.md

@@ -8,7 +8,7 @@
   </h1>
   <p align="center">
     <a href="http://blog.codinghorror.com/the-best-code-is-no-code-at-all/" target="_blank">
-      <img alt="Lines of Code" src="https://img.shields.io/badge/lines_of_code-275-brightgreen.svg?style=flat" />
+      <img alt="Lines of Code" src="https://img.shields.io/badge/lines_of_code-278-brightgreen.svg?style=flat" />
     </a>
     <a href="https://github.com/testdouble/standard" target="_blank">
       <img alt="Ruby Code Style" src="https://img.shields.io/badge/Ruby_Code_Style-standard-brightgreen.svg" />
@@ -16,6 +16,9 @@
     <a href="https://github.com/sheerun/prettier-standard" target="_blank">
       <img alt="JavaScript Code Style" src="https://img.shields.io/badge/JavaScript_Code_Style-prettier_standard-ff69b4.svg" />
     </a>
+    <a href="https://bundlephobia.com/package/turbo_ready" target="_blank">
+      <img alt="npm bundle size" src="https://img.shields.io/bundlephobia/minzip/turbo_ready?label=minified%20size">
+    </a>
   </p>
 </p>
 
@@ -35,15 +38,16 @@ turbo_stream.invoke "console.log", "Hello World!"
 
   - [Why TurboReady?](#why-turboready)
   - [Discord Community](#discord-community)
-  - [A Word of Caution ⚠️](#a-word-of-caution-)
-  - [Sponsor](#sponsor)
+  - [Sponsors](#sponsors)
   - [Dependencies](#dependencies)
   - [Installation](#installation)
   - [Setup](#setup)
   - [Usage](#usage)
   - [Endless Possibilities](#endless-possibilities)
   - [Advanced Usage](#advanced-usage)
+    - [Extending Behavior](#extending-behavior)
   - [Public API](#public-api)
+  - [A Word of Caution](#a-word-of-caution)
   - [Releasing](#releasing)
   - [License](#license)
 
@@ -58,33 +62,16 @@ considerable number of use cases and you should push Streams as far as possible
 
 If you discover that CRUD isn't enough, TurboReady covers pretty much everything else.
 
-## Discord Community
+## Community
 
 Please join nearly 2000 of us on [Discord](https://discord.gg/stimulus-reflex) for support getting started,
-as well as active discussions around Rails, Hotwire, Stimulus, Turbo (Drive, Frames, Streams), TurboReady, CableReady, and StimulusReflex.
+as well as active discussions around Rails, Hotwire, Stimulus, Turbo (Drive, Frames, Streams), TurboReady, CableReady, StimulusReflex, ViewComponent, Phlex, and more.
 
 ![](https://img.shields.io/discord/629472241427415060)
 
 Stop by #newcomers and introduce yourselves!
 
-## A Word of Caution ⚠️
-
-Manually orchestrating DOM activity gets tedious fast.
-**Don't abuse this superpower!**
-
-> With great power comes great responsibility. *-Uncle Ben*
-
-This library is an extremely sharp tool. 🔪
-Consider it a low-level building block that can be used to craft additional libraries with
-great [DX](https://en.wikipedia.org/wiki/User_experience#Developer_experience)
-like [CableReady](https://github.com/stimulusreflex/cable_ready)
-and [StimulusReflex](https://github.com/stimulusreflex/stimulus_reflex).
-
-Restrict your direct application usage to DOM manipulations that fall outside the purview of
-[Turbo's official actions](https://turbo.hotwired.dev/reference/streams#the-seven-actions)...
-*and for Pete's sake, don't overdo it and find yourself maintaining spaghetti code reminicent of the jQuery days.*
-
-## Sponsor
+## Sponsors
 
 <p align="center">
   <em>Proudly sponsored by</em>
@@ -97,7 +84,7 @@ Restrict your direct application usage to DOM manipulations that fall outside th
 
 ## Dependencies
 
-- [rails](https://rubygems.org/gems/rails) `>=7.0`
+- [rails](https://rubygems.org/gems/rails) `>=6.1`
 - [turbo-rails](https://rubygems.org/gems/turbo-rails) `>=1.1`
 - [@hotwired/turbo-rails](https://yarnpkg.com/package/@hotwired/turbo-rails) `>=7.2.0-beta.2`
 
@@ -131,11 +118,11 @@ yarn add "turbo_ready@VERSION --exact"
 ## Usage
 
 Manipulate the DOM from anywhere you use [official Turbo Streams](https://turbo.hotwired.dev/handbook/streams#integration-with-server-side-frameworks).
-Namely, [ActiveRecord Models](https://github.com/hotwired/turbo-rails/blob/main/app/models/concerns/turbo/broadcastable.rb),
-[Controllers](https://github.com/hotwired/turbo-rails/blob/main/app/models/concerns/turbo/broadcastable.rb),
-and [View Templates](https://github.com/hotwired/turbo-rails/blob/main/app/models/concerns/turbo/broadcastable.rb).
+Namely, [**M**odels](https://github.com/hotwired/turbo-rails/blob/main/app/models/concerns/turbo/broadcastable.rb),
+[**V**iews](https://github.com/hotwired/turbo-rails/blob/main/app/models/concerns/turbo/broadcastable.rb),
+and [**C**ontrollers](https://github.com/hotwired/turbo-rails/blob/main/app/models/concerns/turbo/broadcastable.rb).
 
-You can also **chain invocations.** ❤️
+You can **chain invocations.** ❤️
 
 ```ruby
 turbo_stream
@@ -146,7 +133,7 @@ turbo_stream
 ```
 
 You can use [dot notation](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Property_accessors#dot_notation)
-or a [selector](https://developer.mozilla.org/en-US/docs/Web/API/Document/querySelectorAll)... or even **use them together!** 🤯
+or [selectors](https://developer.mozilla.org/en-US/docs/Web/API/Document/querySelectorAll)... and can even combine them!** 🤯
 
 Can I dispatch events? **You bet!** ⚡️
 
@@ -165,9 +152,28 @@ MDN has your back... [learn about the DOM and web APIs here.](https://developer.
 
 ## Advanced Usage
 
-Want to extend things further with some custom functionality? **Let's do it.** 🔌
+You can use symbols and [snake case](https://en.wikipedia.org/wiki/Snake_case) when invoking DOM functionality.
+It'll implicitly convert to [camel case](https://en.wikipedia.org/wiki/Camel_case). 💎
+
+```ruby
+turbo_stream
+  .invoke(:animate, [{opacity: 0}, {opacity: 1}], 2000)
+  .invoke(:dispatch_event, {detail: {converts_to_camel_case: true}})
+  .flush
+```
+
+Need to opt out of camelize? No problem... just disable it.
+
+```ruby
+turbo_stream.invoke :contrived_demo, camelize: false
+```
+
+### Extending Behavior
+
+Want to extend things with custom functionality? **Let's do it.** 🔌
 
 ```js
+// JavaScript
 import morphdom from 'morphdom'
 
 window.MyNamespace = {
@@ -178,24 +184,9 @@ window.MyNamespace = {
 ```
 
 ```ruby
-turbo_stream.invoke "MyNamespace.morph", "#demo", "<div id='demo'><p>You've changed...</p></div>", {childrenOnly: true}
-```
-
-**But this doesn't look like Ruby...** well then, just use symbols and
-[snake case](https://en.wikipedia.org/wiki/Snake_case) when invoking DOM functionality.
-It'll implicitly convert to [camel case](https://en.wikipedia.org/wiki/Camel_case).
-
-```ruby
+# Ruby
 turbo_stream
-  .invoke(:animate, [{opacity: 0}, {opacity: 1}], 2000)
-  .invoke(:dispatch_event, {detail: {converts_camel_case: true}})
-  .flush
-```
-
-Need to opt out of camelize? No problem... just disable it.
-
-```ruby
-turbo_stream.invoke :contrived_demo, camelize: false
+  .invoke "MyNamespace.morph", "#demo", "<div id='demo'><p>You've changed...</p></div>", {childrenOnly: true}
 ```
 
 ## Public API
@@ -204,6 +195,7 @@ There's only one method to consider, `invoke` defined in the
 [tag builder](https://github.com/hopsoft/turbo_ready/blob/main/lib/turbo_ready/tag_builder.rb).
 
 ```ruby
+# Ruby
 turbo_stream
   .invoke(method, *args, selector: nil, camelize: true, id: nil)
 #         |        |     |              |               |
@@ -221,6 +213,23 @@ turbo_stream
 
 **NOTE:** The JavaScript method will be invoked on all matching elements when a `selector` is passed.
 
+## A Word of Caution
+
+Manually orchestrating DOM activity gets tedious fast.
+**⚠️ Don't abuse this superpower!**
+
+> With great power comes great responsibility. *-Uncle Ben*
+
+This library is an extremely sharp tool. 🔪
+Consider it a low-level building block that can be used to craft additional libraries with
+great [DX](https://en.wikipedia.org/wiki/User_experience#Developer_experience)
+like [CableReady](https://github.com/stimulusreflex/cable_ready)
+and [StimulusReflex](https://github.com/stimulusreflex/stimulus_reflex).
+
+Restrict your direct application usage to DOM manipulation that falls outside the purview of
+[Turbo's official actions](https://turbo.hotwired.dev/reference/streams#the-seven-actions)...
+*and for Pete's sake, don't overdo it and find yourself maintaining spaghetti code reminiscent of the jQuery days.*
+
 ## Releasing
 
 1. Run `yarn` and `bundle` to pick up the latest

data/app/assets/builds/turbo_ready.js

@@ -1,2 +1,2 @@
-function l(){let n=JSON.parse(this.templateContent.textContent),{id:h,method:a,args:i,receiver:c,selector:r}=n,t=[self];switch(r&&(t=Array.from(document.querySelectorAll(r))),c&&(t=t.map(o=>{let e=o,s=c.split(".");for(;s.length>0;)e=e[s.shift()];return e})),a){case"dispatchEvent":let o=new CustomEvent(i[0],i[1]||{});t.forEach(e=>e.dispatchEvent(o));break;default:t.forEach(e=>e[a].apply(e,i))}}var f={initialize:n=>n.invoke=l};export{f as default};
+function l(){let n=JSON.parse(this.templateContent.textContent),{id:h,method:c,args:i,receiver:a,selector:r}=n,t=[self];switch(r&&(t=Array.from(document.querySelectorAll(r))),a&&(t=t.map(o=>{let e=o,s=a.split(".");for(;s.length>0;)e=e[s.shift()];return e})),c){case"dispatchEvent":let o=new CustomEvent(i[0],i[1]||{});t.forEach(e=>e.dispatchEvent(o));break;default:t.forEach(e=>e[c].apply(e,i))}}function f(n){n.invoke=l}var p={initialize:f};export{p as default};
 //# sourceMappingURL=turbo_ready.js.map

data/app/assets/builds/turbo_ready.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../javascript/turbo_ready.js"],
-  "sourcesContent": ["function invoke () {\n  const payload = JSON.parse(this.templateContent.textContent)\n  const { id, method, args, receiver, selector } = payload\n  let receivers = [self]\n  if (selector) receivers = Array.from(document.querySelectorAll(selector))\n\n  if (receiver) {\n    receivers = receivers.map(r => {\n      let context = r\n      const chain = receiver.split('.')\n      while (chain.length > 0) context = context[chain.shift()]\n      return context\n    })\n  }\n\n  switch (method) {\n    case 'dispatchEvent':\n      const evt = new CustomEvent(args[0], args[1] || {})\n      receivers.forEach(r => r.dispatchEvent(evt))\n      break\n    default:\n      receivers.forEach(r => r[method].apply(r, args))\n  }\n}\n\nexport default {\n  initialize: streamActions => (streamActions.invoke = invoke)\n}\n"],
-  "mappings": "AAAA,SAASA,GAAU,CACjB,IAAMC,EAAU,KAAK,MAAM,KAAK,gBAAgB,WAAW,EACrD,CAAE,GAAAC,EAAI,OAAAC,EAAQ,KAAAC,EAAM,SAAAC,EAAU,SAAAC,CAAS,EAAIL,EAC7CM,EAAY,CAAC,IAAI,EAYrB,OAXID,IAAUC,EAAY,MAAM,KAAK,SAAS,iBAAiBD,CAAQ,CAAC,GAEpED,IACFE,EAAYA,EAAU,IAAIC,GAAK,CAC7B,IAAIC,EAAUD,EACRE,EAAQL,EAAS,MAAM,GAAG,EAChC,KAAOK,EAAM,OAAS,GAAGD,EAAUA,EAAQC,EAAM,MAAM,GACvD,OAAOD,CACT,CAAC,GAGKN,OACD,gBACH,IAAMQ,EAAM,IAAI,YAAYP,EAAK,GAAIA,EAAK,IAAM,CAAC,CAAC,EAClDG,EAAU,QAAQC,GAAKA,EAAE,cAAcG,CAAG,CAAC,EAC3C,cAEAJ,EAAU,QAAQC,GAAKA,EAAEL,GAAQ,MAAMK,EAAGJ,CAAI,CAAC,EAErD,CAEA,IAAOQ,EAAQ,CACb,WAAYC,GAAkBA,EAAc,OAASb,CACvD",
-  "names": ["invoke", "payload", "id", "method", "args", "receiver", "selector", "receivers", "r", "context", "chain", "evt", "turbo_ready_default", "streamActions"]
+  "sourcesContent": ["function invoke () {\n  const payload = JSON.parse(this.templateContent.textContent)\n  const { id, method, args, receiver, selector } = payload\n  let receivers = [self]\n  if (selector) receivers = Array.from(document.querySelectorAll(selector))\n\n  if (receiver) {\n    receivers = receivers.map(r => {\n      let context = r\n      const chain = receiver.split('.')\n      while (chain.length > 0) context = context[chain.shift()]\n      return context\n    })\n  }\n\n  switch (method) {\n    case 'dispatchEvent':\n      const evt = new CustomEvent(args[0], args[1] || {})\n      receivers.forEach(r => r.dispatchEvent(evt))\n      break\n    default:\n      receivers.forEach(r => r[method].apply(r, args))\n  }\n}\n\nfunction initialize (streamActions) {\n  streamActions.invoke = invoke\n}\n\nexport default { initialize }\n"],
+  "mappings": "AAAA,SAASA,GAAU,CACjB,IAAMC,EAAU,KAAK,MAAM,KAAK,gBAAgB,WAAW,EACrD,CAAE,GAAAC,EAAI,OAAAC,EAAQ,KAAAC,EAAM,SAAAC,EAAU,SAAAC,CAAS,EAAIL,EAC7CM,EAAY,CAAC,IAAI,EAYrB,OAXID,IAAUC,EAAY,MAAM,KAAK,SAAS,iBAAiBD,CAAQ,CAAC,GAEpED,IACFE,EAAYA,EAAU,IAAIC,GAAK,CAC7B,IAAIC,EAAUD,EACRE,EAAQL,EAAS,MAAM,GAAG,EAChC,KAAOK,EAAM,OAAS,GAAGD,EAAUA,EAAQC,EAAM,MAAM,GACvD,OAAOD,CACT,CAAC,GAGKN,OACD,gBACH,IAAMQ,EAAM,IAAI,YAAYP,EAAK,GAAIA,EAAK,IAAM,CAAC,CAAC,EAClDG,EAAU,QAAQC,GAAKA,EAAE,cAAcG,CAAG,CAAC,EAC3C,cAEAJ,EAAU,QAAQC,GAAKA,EAAEL,GAAQ,MAAMK,EAAGJ,CAAI,CAAC,EAErD,CAEA,SAASQ,EAAYC,EAAe,CAClCA,EAAc,OAASb,CACzB,CAEA,IAAOc,EAAQ,CAAE,WAAAF,CAAW",
+  "names": ["invoke", "payload", "id", "method", "args", "receiver", "selector", "receivers", "r", "context", "chain", "evt", "initialize", "streamActions", "turbo_ready_default"]
 }

data/app/javascript/turbo_ready.js

@@ -23,6 +23,8 @@ function invoke () {
   }
 }
 
-export default {
-  initialize: streamActions => (streamActions.invoke = invoke)
+function initialize (streamActions) {
+  streamActions.invoke = invoke
 }
+
+export default { initialize }

data/lib/turbo_ready/string.rb

@@ -5,6 +5,7 @@ module TurboReady
     attr_reader :ruby_string, :turbo_ready_tag_builder
 
     delegate_missing_to :ruby_string
+    delegate :to_s, to: :ruby_string
 
     def initialize(ruby_string, turbo_ready_tag_builder:)
       @ruby_string = ruby_string

data/lib/turbo_ready/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TurboReady
-  VERSION = "0.0.1"
+  VERSION = "0.0.4"
 end

data/package.json

@@ -1,7 +1,7 @@
 {
   "name": "turbo_ready",
-  "version": "0.0.1",
-  "description": "Take full control of the DOM with TurboStreams",
+  "version": "0.0.3",
+  "description": "Take full control of the DOM with Turbo Streams",
   "main": "app/assets/builds/turbo_ready.js",
   "repository": "https://github.com/hopsoft/turbo_ready",
   "author": "Nate Hopkins (hopsoft) <natehop@gmail.com>",

data/turbo_ready.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.authors = ["Nate Hopkins (hopsoft)"]
   spec.email = ["natehop@gmail.com"]
   spec.homepage = "https://github.com/hopsoft/turbo_ready"
-  spec.summary = "Take full control of the DOM with TurboStreams"
+  spec.summary = "Take full control of the DOM with Turbo Streams"
   spec.description = spec.summary
   spec.license = "MIT"
 
@@ -18,7 +18,7 @@ Gem::Specification.new do |spec|
 
   spec.files = Dir["lib/**/*.rb", "app/**/*", "bin/*", "[A-Z]*"]
 
-  spec.add_dependency "rails", ">= 7.0"
+  spec.add_dependency "rails", ">= 6.1"
   spec.add_dependency "turbo-rails", ">= 1.1"
 
   spec.add_development_dependency "magic_frozen_string_literal"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: turbo_ready
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.4
 platform: ruby
 authors:
 - Nate Hopkins (hopsoft)
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '7.0'
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: turbo-rails
   requirement: !ruby/object:Gem::Requirement
@@ -94,7 +94,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Take full control of the DOM with TurboStreams
+description: Take full control of the DOM with Turbo Streams
 email:
 - natehop@gmail.com
 executables: []
@@ -109,6 +109,7 @@ files:
 - Rakefile
 - app/assets/builds/turbo_ready.js
 - app/assets/builds/turbo_ready.js.map
+- app/assets/images/turbo-ready-logo.jpg
 - app/assets/images/turbo-ready-logo.png
 - app/assets/images/turbo-ready-logo.svg
 - app/javascript/turbo_ready.js
@@ -149,5 +150,5 @@ requirements: []
 rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
-summary: Take full control of the DOM with TurboStreams
+summary: Take full control of the DOM with Turbo Streams
 test_files: []