turbo_boost-commands 0.0.1 → 0.0.3

data/app/helpers/turbo_boost/commands/application_helper.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+module TurboBoost::Commands::ApplicationHelper
+end

data/app/javascript/index.js

@@ -16,7 +16,7 @@ import uuids from './uuids'
 function buildCommandPayload (id, element) {
   return {
     id, // uniquely identifies the command
-    name: element.dataset.command,
+    name: element.getAttribute(schema.commandAttribute),
     elementId: element.id.length > 0 ? element.id : null,
     elementAttributes: elements.buildAttributePayload(element),
     startedAt: new Date().getTime()
@@ -32,7 +32,7 @@ function invokeCommand (event) {
     if (!element) return
     if (!delegates.isRegisteredForElement(event.type, element)) return
 
-    const commandId = `command-${uuids.v4()}`
+    const commandId = `turbo-command-${uuids.v4()}`
     let driver = drivers.find(element)
     let payload = {
       ...buildCommandPayload(commandId, element),

data/app/javascript/schema.js

@@ -1,7 +1,7 @@
 const schema = {
   frameAttribute: 'data-turbo-frame',
   methodAttribute: 'data-turbo-method',
-  commandAttribute: 'data-command'
+  commandAttribute: 'data-turbo-command'
 }
 
 export default { ...schema }

data/bin/standardize

@@ -2,6 +2,6 @@
 
 bundle exec magic_frozen_string_literal
 bundle exec standardrb --fix
-yarn run prettier-standard "app/javascript/**/*.js"
+yarn run prettier-standard package.json app/javascript/**/*.js
 yarn run rustywind --write test/dummy/app
 yarn run rustywind --write --custom-regex "(:\s[\"'])(.+)[\"']" test/dummy/app/views/_tailwind.yml.erb

data/fly.toml

@@ -1,11 +1,13 @@
-# fly.toml file generated for turbo-boost-commands on 2022-09-19T05:16:01-06:00
+# fly.toml file generated for turboboost-commands on 2022-12-23T12:55:35-07:00
 
-app = "turbo-boost-commands"
+app = "turboboost-commands"
 kill_signal = "SIGINT"
 kill_timeout = 5
 processes = []
 
 [env]
+  # Must match the proxy config in the smallteam-tech/proxy repo
+  RAILS_RELATIVE_URL_ROOT = "/@turbo-boost/commands"
 
 [experimental]
   allowed_public_ports = []

data/lib/turbo_boost/commands/attribute_hydration.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module TurboBoost::Commands::AttributeHydration
+  extend self
+
+  def hydrate(value)
+    case value
+    when Array
+      value.map { |val| hydrate(val) }
+    when Hash
+      value.each_with_object(HashWithIndifferentAccess.new) do |(key, val), memo|
+        memo[key] = hydrate(val)
+      end
+    when String
+      parsed_value = parse_json(value)
+      hydrated_value = hydrate(parsed_value) unless parsed_value.nil?
+      hydrated_value ||= GlobalID::Locator.locate_signed(value) if possible_sgid_string?(value)
+      hydrated_value || value
+    else
+      value
+    end
+  rescue => error
+    Rails.logger.error "Failed to hydrate value! #{value}; #{error}"
+    value
+  end
+
+  def dehydrate(value)
+    return value unless has_sgid?(value)
+    case value
+    when Array
+      value.map { |val| dehydrate val }
+    when Hash
+      value.each_with_object(HashWithIndifferentAccess.new) do |(key, val), memo|
+        val = dehydrate(val)
+        memo[key] = convert_to_json?(key, val) ? val.to_json : val
+      end
+    else
+      implements_sgid?(value) ? value.to_sgid_param : value
+    end
+  end
+
+  private
+
+  # simple regular expressions checked before attempting specific hydration strategies
+  PREFIX_ATTRIBUTE_REGEXP = /\Aaria|data\z/i
+  JSON_REGEX = /.*(\[|\{).*(\}|\]).*/
+  SGID_PARAM_REGEX = /.{100,}/i
+
+  # Rails implicitly converts certain keys to JSON,
+  # so we check keys before performing JSON conversion
+  def prefixed_attribute?(name)
+    PREFIX_ATTRIBUTE_REGEXP.match? name.to_s
+  end
+
+  def convert_to_json?(key, value)
+    return false if prefixed_attribute?(key)
+    case value
+    when Array, Hash then true
+    else false
+    end
+  end
+
+  def possible_json_string?(value)
+    return false unless value.is_a?(String)
+    JSON_REGEX.match? value
+  end
+
+  def possible_sgid_string?(value)
+    return false unless value.is_a?(String)
+    SGID_PARAM_REGEX.match? value
+  end
+
+  def implements_sgid?(value)
+    value.respond_to?(:to_sgid_param) && value.try(:persisted?)
+  end
+
+  def find_sgid_value(value)
+    case value
+    when Array then value.find { |val| find_sgid_value val }
+    when Hash then find_sgid_value(value.values)
+    else implements_sgid?(value) ? value : nil
+    end
+  end
+
+  def has_sgid?(value)
+    find_sgid_value(value).present?
+  end
+
+  def parse_json(value)
+    return nil unless possible_json_string?(value)
+    JSON.parse value
+  rescue
+    nil
+  end
+end

data/lib/turbo_boost/commands/attribute_set.rb

@@ -1,18 +1,29 @@
 # frozen_string_literal: true
 
+require_relative "attribute_hydration"
+
 class TurboBoost::Commands::AttributeSet
-  def initialize(prefix, attributes: {})
+  include TurboBoost::Commands::AttributeHydration
+
+  # These methods enable Ruby pattern matching
+  delegate :deconstruct, :deconstruct_keys, to: :to_h
+
+  def initialize(attributes = {}, prefix: nil)
     prefix = prefix.to_s
-    attrs = attributes.to_h.transform_values(&:to_s)
+    attrs = hydrate(attributes)
 
     attrs.each do |key, value|
       key = key.to_s.strip
 
-      next unless key.start_with?(prefix)
+      next unless prefix.blank? || key.start_with?(prefix)
 
-      name = key.parameterize.underscore.delete_prefix("#{prefix}_")
-      value = value.to_i if value.to_s.match?(/\A\d+\z/)
+      name = key.parameterize.underscore
+      name.delete_prefix!("#{prefix}_") unless prefix.blank?
+
+      # type casting
+      value = value.to_i if value.is_a?(String) && value.match?(/\A\d+\z/)
       value = value == "true" if value.is_a?(String) && value.match?(/\A(true|false)\z/i)
+
       instance_variable_set "@#{name}", value
 
       next if orig_respond_to_missing?(name, false)
@@ -22,6 +33,23 @@ class TurboBoost::Commands::AttributeSet
     end
   end
 
+  def to_h
+    instance_variables.each_with_object({}.with_indifferent_access) do |name, memo|
+      value = instance_variable_get(name)
+      value = value.to_h if value.is_a?(self.class)
+      memo[name.to_s.delete_prefix("@").to_sym] = value
+    end
+  end
+
+  def render_options
+    options = {
+      partial: renders,
+      assigns: assigns,
+      locals: locals
+    }
+    options.deep_symbolize_keys
+  end
+
   def respond_to?(name, include_all = false)
     respond_to_missing? name, include_all
   end

data/lib/turbo_boost/commands/command.rb

@@ -8,18 +8,19 @@ require_relative "attribute_set"
 # Commands are executed via a before_action in the Rails controller lifecycle.
 # They have access to the following methods and properties.
 #
+# * controller .................. The Rails controller processing the HTTP request
+# * css_id_selector ............. Returns a CSS selector for an element `id` i.e. prefixes with `#`
 # * dom_id ...................... The Rails dom_id helper
 # * dom_id_selector ............. Returns a CSS selector for a dom_id
-# * controller .................. The Rails controller processing the HTTP request
 # * element ..................... A struct that represents the DOM element that triggered the command
 # * morph ....................... Appends a Turbo Stream to morph a DOM element
 # * params ...................... Commands specific params (frame_id, element, etc.)
 # * render ...................... Renders Rails templates, partials, etc. (doesn't halt controller request handling)
 # * render_response ............. Renders a full controller response
 # * renderer .................... An ActionController::Renderer
+# * state ....................... An object that stores ephemeral `state`
 # * turbo_stream ................ A Turbo Stream TagBuilder
 # * turbo_streams ............... A list of Turbo Streams to append to the response (also aliased as streams)
-# * state ....................... An object that stores ephemeral `state`
 #
 # They also have access to the following class methods:
 #
@@ -27,6 +28,11 @@ require_relative "attribute_set"
 #
 class TurboBoost::Commands::Command
   class << self
+    def css_id_selector(id)
+      return id if id.to_s.start_with?("#")
+      "##{id}"
+    end
+
     def preventers
       @preventers ||= Set.new
     end
@@ -70,6 +76,7 @@ class TurboBoost::Commands::Command
   attr_reader :controller, :turbo_streams
   alias_method :streams, :turbo_streams
 
+  delegate :css_id_selector, to: :"self.class"
   delegate :dom_id, to: :"controller.view_context"
   delegate(
     :controller_action_prevented?,
@@ -86,7 +93,7 @@ class TurboBoost::Commands::Command
   end
 
   def dom_id_selector(...)
-    "##{dom_id(...)}"
+    css_id_selector dom_id(...)
   end
 
   # Same method signature as ActionView::Rendering#render (i.e. controller.view_context.render)
@@ -105,12 +112,14 @@ class TurboBoost::Commands::Command
     ivars&.each { |key, value| controller.instance_variable_set "@#{key}", value }
   end
 
-  def morph(selector, html)
+  def morph(html:, id: nil, selector: nil)
+    selector ||= css_id_selector(id)
     turbo_streams << turbo_stream.invoke("morph", args: [html], selector: selector)
   end
 
   # default command invoked when method not specified
-  def noop
+  # can be overridden in subclassed commands
+  def perform
   end
 
   def params
@@ -119,11 +128,11 @@ class TurboBoost::Commands::Command
 
   def element
     @element ||= begin
-      attributes = params[:element_attributes]
-      OpenStruct.new attributes.merge(
-        aria: TurboBoost::Commands::AttributeSet.new(:aria, attributes: attributes),
-        dataset: TurboBoost::Commands::AttributeSet.new(:data, attributes: attributes)
-      )
+      attributes = params[:element_attributes].to_h
+      TurboBoost::Commands::AttributeSet.new(attributes.merge(
+        aria: TurboBoost::Commands::AttributeSet.new(attributes, prefix: "aria"),
+        data: TurboBoost::Commands::AttributeSet.new(attributes, prefix: "data")
+      ))
     end
   end
 

data/lib/turbo_boost/commands/controller_pack.rb

@@ -3,6 +3,8 @@
 require_relative "runner"
 
 class TurboBoost::Commands::ControllerPack
+  include TurboBoost::Commands::AttributeHydration
+
   attr_reader :command, :controller, :runner
 
   delegate(

data/lib/turbo_boost/commands/engine.rb

@@ -3,9 +3,11 @@
 require "turbo-rails"
 require "turbo_boost/streams"
 require_relative "version"
+require_relative "patches"
 require_relative "command"
 require_relative "controller_pack"
 require_relative "../../../app/controllers/concerns/turbo_boost/commands/controller"
+require_relative "../../../app/helpers/turbo_boost/commands/application_helper"
 
 module TurboBoost::Commands
   def self.config
@@ -24,8 +26,15 @@ module TurboBoost::Commands
     initializer "turbo_boost_commands.configuration" do
       Mime::Type.register "text/vnd.turbo-boost.html", :turbo_boost
 
-      ActiveSupport.on_load(:action_controller_base) do
+      ActiveSupport.on_load :action_controller_base do
+        # `self` is ActionController::Base
         include TurboBoost::Commands::Controller
+        helper TurboBoost::Commands::ApplicationHelper
+      end
+
+      ActiveSupport.on_load :action_view do
+        # `self` is ActionView::Base
+        ActionView::Helpers::TagHelper::TagBuilder.prepend TurboBoost::Commands::Patches::ActionViewHelpersTagHelperTagBuilderPatch
       end
     end
   end

data/lib/turbo_boost/commands/patches/action_view_helpers_tag_helper_tag_builder_patch.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "../attribute_hydration"
+
+module TurboBoost::Commands::Patches::ActionViewHelpersTagHelperTagBuilderPatch
+  def tag_options(options, ...)
+    dehydrated_options = TurboBoost::Commands::AttributeHydration.dehydrate(options)
+    super(dehydrated_options, ...)
+  end
+end

data/lib/turbo_boost/commands/patches.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module TurboBoost::Commands::Patches
+end
+
+require_relative "patches/action_view_helpers_tag_helper_tag_builder_patch"

data/lib/turbo_boost/commands/runner.rb

@@ -77,12 +77,14 @@ class TurboBoost::Commands::Runner
 
   def command_class_name
     return nil unless command_requested?
-    command_name.split("#").first
+    name = command_name.split("#").first
+    name << "Command" unless name.end_with?("Command")
+    name
   end
 
   def command_method_name
     return nil unless command_requested?
-    return "noop" unless command_name.include?("#")
+    return "perform" unless command_name.include?("#")
     command_name.split("#").last
   end
 

data/lib/turbo_boost/commands/version.rb

@@ -2,6 +2,6 @@
 
 module TurboBoost
   module Commands
-    VERSION = "0.0.1"
+    VERSION = "0.0.3"
   end
 end

data/package.json

@@ -1,13 +1,24 @@
 {
   "name": "@turbo-boost/commands",
-  "version": "0.0.0",
+  "version": "0.0.2",
   "description": "Commands to help you build robust reactive applications with Rails & Hotwire.",
-  "main": "app/javascript/index.js",
+  "keywords": [
+    "hotwire",
+    "hotwired",
+    "rails",
+    "turbo",
+    "turbo-boost"
+  ],
+  "type": "module",
+  "main": "app/assets/builds/@turbo-boost/commands.js",
+  "files": [
+    "app/assets/builds"
+  ],
   "repository": "https://github.com/hopsoft/turbo_boost-commands",
   "author": "Nate Hopkins (hopsoft) <natehop@gmail.com>",
   "license": "MIT",
   "dependencies": {
-    "@turbo-boost/streams": ">= 0.0.1"
+    "@turbo-boost/streams": ">= 0.0.4"
   },
   "peerDependencies": {
     "@hotwired/turbo-rails": ">= 7.2.0"
@@ -20,6 +31,6 @@
     "rustywind": "^0.15.1"
   },
   "scripts": {
-    "build": "esbuild app/javascript/index.js --bundle --minify --sourcemap --format=esm --target=es2017 --analyze --outfile=app/assets/builds/@turbo-boost/commands.js"
+    "build": "esbuild app/javascript/index.js --bundle --minify --sourcemap --format=esm --target=es2020,chrome58,firefox57,safari11 --analyze --outfile=app/assets/builds/@turbo-boost/commands.js"
   }
 }