live_component 0.1.0

data/lib/live_component/time_with_zone_serializer.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module LiveComponent
+  class TimeWithZoneSerializer < ObjectSerializer
+    NANO_PRECISION = 9
+
+    private
+
+    def object_to_hash(time_with_zone)
+      {
+        "value" => time_with_zone.iso8601(NANO_PRECISION),
+        "time_zone" => time_with_zone.time_zone.tzinfo.name
+      }
+    end
+
+    def hash_to_object(hash)
+      Time.iso8601(hash["value"]).in_time_zone(hash["time_zone"] || Time.zone)
+    end
+  end
+end

data/lib/live_component/utils.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+module LiveComponent
+  module Utils
+    WHITESPACE_REGEX = /[\f\n\r\t\v ]{2,}/
+    PLURAL_DATA_ATTRIBUTES = %i[action target].freeze
+
+    def normalize_html_whitespace(str)
+      str.gsub(WHITESPACE_REGEX, " ")
+    end
+
+    def lookup_component_class(const_str)
+      const = safe_lookup_component_class(const_str)
+      return const if const
+
+      raise UnexpectedConstantError,
+        "cannot find constant '#{const_str}' that does not inherit from ViewComponent::Base"
+    end
+
+    def safe_lookup_component_class(const_str)
+      const = const_str.safe_constantize
+
+      if const && const < ::ViewComponent::Base
+        const
+      end
+    end
+
+    def html_params_for_rerender(object)
+      case object
+      when :self, :parent
+        return { "data-rerender-target" => ":#{object}" }
+      when Symbol
+        const = safe_lookup_component_class(object.to_s)
+        return({ "data-rerender-target" => const.name }) if const
+
+        raise UnexpectedConstantError, "cannot find constant '#{object}' to use as a rerender target"
+      when String
+        return { "data-rerender-id" => object }
+      when Class
+        if object < LiveComponent::Base
+          return { "data-rerender-target" => object.name }
+        end
+      else
+        if object.respond_to?(:__lc_id)
+          return { "data-rerender-id" => object.__lc_id }
+        end
+      end
+
+      nil
+    end
+
+    def translate_all_attrs(kwargs)
+      # TODO: allow folks to add their own attr classes?
+      [Action, Target].inject(kwargs) do |memo, attr_klass|
+        if kwargs.include?(attr_klass.attr_name)
+          translate_attrs(attr_klass, memo)
+        else
+          memo
+        end
+      end
+    end
+
+    def translate_attrs(attr_klass, kwargs)
+      if kwargs[attr_klass.attr_name].is_a?(Array)
+        return kwargs unless kwargs[attr_klass.attr_name].all? { |action| action.is_a?(attr_klass) }
+      else
+        return kwargs unless kwargs[attr_klass.attr_name].is_a?(attr_klass)
+      end
+
+      attrs = Array(kwargs.delete(attr_klass.attr_name))
+
+      attrs.each do |attr|
+        kwargs[:data] = merge_data(kwargs, attr.to_attributes)
+      end
+
+      kwargs
+    end
+
+    # Borrowed from primer_view_components
+    # See: https://github.com/primer/view_components/blob/b0acdfffaa30e606a07db657d9b444b4de8ca860/app/lib/primer/attributes_helper.rb
+    #
+    # Merges hashes that contain "data-*" keys and nested data: hashes. Removes keys from
+    # each hash and returns them in the new hash.
+    #
+    # Eg. merge_data({ "data-foo": "true" }, { data: { bar: "true" } })
+    #     => { foo: "true", bar: "true" }
+    #
+    # Certain data attributes can contain multiple values separated by spaces. merge_data
+    # will combine these plural attributes into a composite string.
+    #
+    # Eg. merge_data({ "data-target": "foo" }, { data: { target: "bar" } })
+    #     => { target: "foo bar" }
+    def merge_data(*hashes)
+      merge_prefixed_attribute_hashes(
+        *hashes, prefix: :data, plural_keys: PLURAL_DATA_ATTRIBUTES
+      )
+    end
+
+    def merge_prefixed_attribute_hashes(*hashes, prefix:, plural_keys:)
+      {}.tap do |result|
+        hashes.each do |hash|
+          next unless hash
+
+          prefix_hash = hash.delete(prefix) || {}
+
+          prefix_hash.each_pair do |key, val|
+            result[key] =
+              if plural_keys.include?(key)
+                [*(result[key] || "").split, val].join(" ").strip
+              else
+                val
+              end
+          end
+
+          hash.delete_if do |key, val|
+            key_s = key.to_s
+
+            if key.start_with?("#{prefix}-")
+              bare_key = key_s.sub("#{prefix}-", "").to_sym
+
+              result[bare_key] =
+                if plural_keys.include?(bare_key)
+                  [*(result[bare_key] || "").split, val].join(" ").strip
+                else
+                  val
+                end
+
+              true
+            else
+              false
+            end
+          end
+        end
+      end
+    end
+
+    extend self
+  end
+end

data/lib/live_component/version.rb

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

data/lib/live_component.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module LiveComponent
+  autoload :Action,                 "live_component/action"
+  autoload :Base,                   "live_component/base"
+  autoload :BigDecimalSerializer,   "live_component/big_decimal_serializer"
+  autoload :ControllerMethods,      "live_component/controller_methods"
+  autoload :DateSerializer,         "live_component/date_serializer"
+  autoload :DateTimeSerializer,     "live_component/date_time_serializer"
+  autoload :DurationSerializer,     "live_component/duration_serializer"
+  autoload :InlineSerializer,       "live_component/inline_serializer"
+  autoload :Middleware,             "live_component/middleware"
+  autoload :ModelSerializer,        "live_component/model_serializer"
+  autoload :ModuleSerializer,       "live_component/module_serializer"
+  autoload :ObjectSerializer,       "live_component/object_serializer"
+  autoload :RangeSerializer,        "live_component/range_serializer"
+  autoload :RecordProxy,            "live_component/record_proxy"
+  autoload :SafeDispatcher,         "live_component/safe_dispatcher"
+  autoload :Serializer,             "live_component/serializer"
+  autoload :TimeWithZoneSerializer, "live_component/time_with_zone_serializer"
+  autoload :TagBuilder,             "live_component/tag_builder"
+  autoload :Target,                 "live_component/target"
+  autoload :TimeObjectSerializer,   "live_component/time_object_serializer"
+  autoload :TimeSerializer,         "live_component/time_serializer"
+  autoload :TimeWithZoneSerializer, "live_component/time_with_zone_serializer"
+  autoload :React,                  "live_component/react"
+  autoload :State,                  "live_component/state"
+  autoload :Utils,                  "live_component/utils"
+
+  class UnexpectedConstantError < StandardError; end
+  class SerializationError < ArgumentError; end
+  class SafeDispatchError < StandardError; end
+
+  class << self
+    def register_prop_serializer(name, klass)
+      registered_prop_serializers[name] = klass
+    end
+
+    def registered_prop_serializers
+      @registered_prop_serializers ||= {}
+    end
+
+    def serializer
+      @serializer ||= Serializer.make
+    end
+  end
+end
+
+LiveComponent.register_prop_serializer(:model_serializer, LiveComponent::ModelSerializer)
+
+if defined?(Rails)
+  require "live_component/engine"
+end
+
+require File.join(File.dirname(__dir__), "ext", "view_component_patch")

data/lib/tasks/test.rake

@@ -0,0 +1 @@
+# System tests are defined in the Rakefile to avoid Rails test infrastructure issues

data/live_component.gemspec

@@ -0,0 +1,21 @@
+$:.unshift File.join(File.dirname(__FILE__), "lib")
+require "live_component/version"
+
+Gem::Specification.new do |s|
+  s.name     = "live_component"
+  s.version  = ::LiveComponent::VERSION
+  s.authors  = ["Cameron Dutro"]
+  s.email    = ["camertron@gmail.com"]
+  s.homepage = "http://github.com/camertron/live_component"
+  s.description = s.summary = "Client-side rendering and state management for ViewComponent."
+  s.platform = Gem::Platform::RUBY
+
+  s.add_dependency "railties", "~> 8.0"
+  s.add_dependency "view_component", "~> 4.0"
+  s.add_dependency "use_context", "~> 1.2"
+  s.add_dependency "weak_key_map", "~> 1.0"
+
+  s.require_path = "lib"
+
+  s.files = Dir["{app,config,ext,lib}/**/*", "Gemfile", "LICENSE", "CHANGELOG.md", "README.md", "Rakefile", "live_component.gemspec"]
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: live_component
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Cameron Dutro
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+- !ruby/object:Gem::Dependency
+  name: view_component
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: use_context
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: weak_key_map
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+description: Client-side rendering and state management for ViewComponent.
+email:
+- camertron@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- Rakefile
+- app/channels/live_component_channel.rb
+- app/components/live_component/render_component.rb
+- app/controllers/live_component/render_controller.rb
+- app/helpers/live_component/application_helper.rb
+- app/views/live_component/render/show.html.erb
+- config/routes.rb
+- ext/view_component_patch.rb
+- lib/live_component.rb
+- lib/live_component/action.rb
+- lib/live_component/base.rb
+- lib/live_component/big_decimal_serializer.rb
+- lib/live_component/component.html.erb
+- lib/live_component/controller_methods.rb
+- lib/live_component/date_serializer.rb
+- lib/live_component/date_time_serializer.rb
+- lib/live_component/duration_serializer.rb
+- lib/live_component/engine.rb
+- lib/live_component/inline_serializer.rb
+- lib/live_component/middleware.rb
+- lib/live_component/model_serializer.rb
+- lib/live_component/module_serializer.rb
+- lib/live_component/object_serializer.rb
+- lib/live_component/range_serializer.rb
+- lib/live_component/react.rb
+- lib/live_component/record_proxy.rb
+- lib/live_component/safe_dispatcher.rb
+- lib/live_component/serializer.rb
+- lib/live_component/state.rb
+- lib/live_component/tag_builder.rb
+- lib/live_component/target.rb
+- lib/live_component/time_object_serializer.rb
+- lib/live_component/time_serializer.rb
+- lib/live_component/time_with_zone_serializer.rb
+- lib/live_component/utils.rb
+- lib/live_component/version.rb
+- lib/tasks/test.rake
+- live_component.gemspec
+homepage: http://github.com/camertron/live_component
+licenses: []
+metadata: {}
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: Client-side rendering and state management for ViewComponent.
+test_files: []