reactive_component 0.1.0

data/lib/reactive_component.rb

@@ -0,0 +1,218 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+require_relative "reactive_component/version"
+require_relative "reactive_component/compiler"
+require_relative "reactive_component/erb_extractor"
+require_relative "reactive_component/data_evaluator"
+require_relative "reactive_component/wrapper"
+require_relative "reactive_component/engine" if defined?(Rails::Engine)
+
+module ReactiveComponent
+  extend ActiveSupport::Concern
+
+  mattr_accessor :debug, default: false
+  mattr_accessor :renderer, default: nil
+
+  class Error < StandardError; end
+
+  included do
+    class_attribute :_live_model_attr, instance_writer: false
+    class_attribute :_live_model_class_name, instance_writer: false
+    class_attribute :_live_actions, instance_writer: false, default: {}
+    class_attribute :_broadcast_config, instance_writer: false
+    class_attribute :_client_state_fields, instance_writer: false, default: {}
+  end
+
+  def render_in(view_context, &block)
+    inner_html = super
+    return inner_html unless self.class._live_model_attr
+    return inner_html if @_skip_live_wrapper
+
+    record = instance_variable_get(:"@#{self.class.live_model_attr}")
+    return inner_html unless record
+
+    stream = ReactiveComponent::Wrapper.find_stream_for(self.class, record)
+
+    client_state = if self.class._client_state_fields.any?
+      kwargs = {}
+      self.class._client_state_fields.each_key do |name|
+        val = instance_variable_get(:"@#{name}")
+        kwargs[name] = val unless val.nil?
+      end
+      self.class.client_state_values(**kwargs)
+    end
+
+    extra_opts = respond_to?(:live_wrapper_options, true) ? live_wrapper_options : {}
+
+    wrapped = ReactiveComponent::Wrapper.wrap(self.class, record, inner_html, stream: stream, client_state: client_state, **extra_opts)
+
+    template_script = self.class.template_script_tag(view_context)
+    template_script ? (template_script + wrapped).html_safe : wrapped
+  end
+
+  class_methods do
+    def subscribes_to(attr_name, class_name: nil)
+      self._live_model_attr = attr_name.to_sym
+      self._live_model_class_name = class_name || attr_name.to_s.classify
+    end
+
+    def live_model_class
+      _live_model_class_name&.constantize
+    end
+
+    def broadcasts(stream:, prepend_target: nil)
+      self._broadcast_config = {
+        stream: stream,
+        prepend_target: prepend_target
+      }
+    end
+
+    def live_model_attr
+      _live_model_attr
+    end
+
+    def client_state(name, default: nil)
+      self._client_state_fields = _client_state_fields.merge(
+        name.to_sym => { default: default }
+      )
+    end
+
+    def client_state_values(**kwargs)
+      _client_state_fields.each_with_object({}) do |(name, config), hash|
+        hash[name.to_s] = kwargs.key?(name) ? kwargs[name] : config[:default]
+      end
+    end
+
+    def live_action(action_name, params: [])
+      self._live_actions = _live_actions.merge(
+        action_name.to_sym => { params: Array(params).map(&:to_sym) }
+      )
+    end
+
+    def live_action_token(record)
+      live_action_verifier.generate(
+        { c: name, m: record.class.name, r: record.id },
+        purpose: :reactive_component_action
+      )
+    end
+
+    def execute_action(action_name, record, action_params = {})
+      action_name = action_name.to_sym
+      action_config = _live_actions[action_name]
+      raise ArgumentError, "Unknown live action: #{action_name}" unless action_config
+
+      instance = allocate
+      instance.instance_variable_set(:"@#{live_model_attr}", record)
+
+      allowed = action_config[:params]
+      if allowed.any?
+        filtered = action_params.symbolize_keys.slice(*allowed)
+        instance.send(action_name, **filtered)
+      else
+        instance.send(action_name)
+      end
+    end
+
+    def compiled_data
+      @compiled_data ||= ReactiveComponent::Compiler.compile(self)
+    end
+
+    def compiled_template_js
+      compiled_data[:js_body]
+    end
+
+    def encoded_template
+      @encoded_template ||= if ReactiveComponent.debug
+        compiled_template_js
+      else
+        Base64.strict_encode64(compiled_template_js)
+      end
+    end
+
+    def template_element_id
+      @template_element_id ||= "#{name.underscore}_template"
+    end
+
+    def template_script_tag(view_context)
+      emitted = (view_context.instance_variable_get(:@_reactive_component_templates) || Set.new)
+      return nil if emitted.include?(name)
+
+      emitted.add(name)
+      view_context.instance_variable_set(:@_reactive_component_templates, emitted)
+      %(<script type="text/x-template" id="#{template_element_id}">#{encoded_template}</script>).html_safe
+    end
+
+    def dom_id_for(record)
+      if respond_to?(:dom_id_prefix) && dom_id_prefix.present?
+        ActionView::RecordIdentifier.dom_id(record, dom_id_prefix)
+      else
+        ActionView::RecordIdentifier.dom_id(record)
+      end
+    end
+
+    def expression_field_map
+      compiled_data[:expressions].invert
+    end
+
+    def build_data_for_nested(**kwargs)
+      evaluator = ReactiveComponent::DataEvaluator.new(nil, nil, component_class: self, **kwargs)
+      data = {}
+      collection_computed = compiled_data[:collection_computed] || {}
+
+      compiled_data[:expressions].each do |var_name, ruby_source|
+        data[var_name] = if collection_computed.key?(var_name)
+          evaluator.evaluate_collection(ruby_source, collection_computed[var_name])
+        else
+          evaluator.evaluate(ruby_source)
+        end
+      end
+      compiled_data[:simple_ivars].each do |ivar_name|
+        data[ivar_name] = kwargs[ivar_name.to_sym] if kwargs.key?(ivar_name.to_sym)
+      end
+      data
+    end
+
+    def build_data(record, **kwargs)
+      evaluator = ReactiveComponent::DataEvaluator.new(live_model_attr, record, component_class: self, **kwargs)
+      data = {}
+      collection_computed = compiled_data[:collection_computed] || {}
+
+      compiled_data[:expressions].each do |var_name, ruby_source|
+        data[var_name] = if collection_computed.key?(var_name)
+          evaluator.evaluate_collection(ruby_source, collection_computed[var_name])
+        else
+          evaluator.evaluate(ruby_source)
+        end
+      end
+
+      compiled_data[:simple_ivars].each do |ivar_name|
+        data[ivar_name] = kwargs[ivar_name.to_sym] if kwargs.key?(ivar_name.to_sym)
+      end
+
+      (compiled_data[:nested_components] || {}).each do |key, info|
+        klass = info[:class_name].constantize
+        kwargs_values = {}
+        info[:kwargs].each do |kwarg_name, ruby_source|
+          kwargs_values[kwarg_name.to_sym] = evaluator.evaluate(ruby_source)
+        end
+        data[key] = if klass.respond_to?(:build_data_for_nested)
+          klass.build_data_for_nested(**kwargs_values)
+        else
+          ReactiveComponent::Compiler.build_data_for_nested(klass, **kwargs_values)
+        end
+      end
+
+      data["id"] = record.id
+      data["dom_id"] = dom_id_for(record)
+      data
+    end
+
+    private
+
+    def live_action_verifier
+      Rails.application.message_verifier(:reactive_component_action)
+    end
+  end
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: reactive_component
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Przemyslaw Lusar
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: view_component
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: turbo-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: ruby2js
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: prism
+  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'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9'
+description: Build reactive, real-time UI components that automatically re-render
+  server-side when subscribed models change. Uses ViewComponent, Turbo Streams, and
+  ActionCable to keep your UI in sync without writing custom JavaScript.
+email:
+- lluzak@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- app/channels/reactive_component/channel.rb
+- app/controllers/reactive_component/actions_controller.rb
+- app/javascript/reactive_component/controllers/reactive_renderer_controller.js
+- app/javascript/reactive_component/lib/reactive_renderer_utils.js
+- config/importmap.rb
+- config/routes.rb
+- lib/reactive_component.rb
+- lib/reactive_component/compiler.rb
+- lib/reactive_component/data_evaluator.rb
+- lib/reactive_component/engine.rb
+- lib/reactive_component/erb_extractor.rb
+- lib/reactive_component/version.rb
+- lib/reactive_component/wrapper.rb
+homepage: https://github.com/przymusiala/reactive_component
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/przymusiala/reactive_component
+  source_code_uri: https://github.com/przymusiala/reactive_component
+  changelog_uri: https://github.com/przymusiala/reactive_component/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.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: Reactive server-rendered components for Rails via ActionCable
+test_files: []