opal-vite 0.3.13 → 0.3.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 67f79084fe35586cb8dc0f98103778f6fe8a87a14876dc94d974c5ab434be56d
-  data.tar.gz: 4f4f7c07407bd93599f9230168992cd16af6f61a708fab7db12a3229300a1f55
+  metadata.gz: 3ff5610634e2852d6053397650789a4873d1dfa2faf891c634503849531a0a0c
+  data.tar.gz: f8169727ae99fb3faa4f9bd75e48786b667b1ad2c4cd261a985b411c60bbea6c
 SHA512:
-  metadata.gz: 2ef2c6d46990c04cc7b7d23267d255a384d4d6b263f7a1d83d47f2a7c82969796edd7d6e1ebcfa6cf209fd1eb53ff83cde108aced69e387b27e7ff9274a08a38
-  data.tar.gz: 11497fc562b1fc9a1ca9836cbe218988e771576a3bb2258915ceb7440c91aabfeecea843cea34a9f861f2c30498084574ccf94c10a311301c2bdb7130025761c
+  metadata.gz: 485d95f570220009668240c82cf363dbf092b743601045b78820c1b0628f041d4b1bda86393eaac16156261cd794190d062392f2303af0338b89646658f3c62c
+  data.tar.gz: e2970ff1eaaa5828ccc128f564aab1a1ce8b628300d480731aae8f6eaee6df094c2253940914b39049ebc5424efd188c316bfed4af0bba3a90c1fdc42e8d7d44

data/lib/opal/vite/compiler.rb

@@ -12,6 +12,10 @@ module Opal
         @config = options[:config] || Opal::Vite.config
         @include_concerns = options.fetch(:include_concerns, true)
         @stubs = options.fetch(:stubs, [])
+        # When true, Opal's corelib is treated as already loaded and left out
+        # of the output. The Vite plugin then imports the shared runtime
+        # (`/@opal-runtime`) instead, so corelib is only loaded once.
+        @external_runtime = options.fetch(:external_runtime, false)
       end
 
       # Compile Ruby source code to JavaScript
@@ -20,6 +24,7 @@ module Opal
         begin
           # Use Opal::Builder and add the file's directory to load paths
           builder = Opal::Builder.new(stubs: @stubs)
+          builder.prerequired = self.class.runtime_requires if @external_runtime
 
           # Add the directory containing the file to load paths
           # This allows require statements to work relative to the file
@@ -68,10 +73,24 @@ module Opal
       end
 
       # Get the Opal runtime code
+      #
+      # The runtime's entry file (opal.rb) is not registered as a requirable
+      # module, so mark it as loaded explicitly. Otherwise `require 'opal'` in
+      # a bundle compiled with external_runtime raises LoadError at runtime.
       def self.runtime_code
         builder = Opal::Builder.new
         builder.build('opal')
-        builder.to_s
+        "#{builder.to_s}\nOpal.loaded([\"opal\"]);\n"
+      end
+
+      # Logical require paths that are part of runtime_code (opal itself and
+      # the corelib files it pulls in).
+      def self.runtime_requires
+        @runtime_requires ||= begin
+          builder = Opal::Builder.new
+          builder.build('opal')
+          ['opal', *builder.already_processed.to_a].freeze
+        end
       end
 
       private

data/lib/opal/vite/version.rb

@@ -1,5 +1,5 @@
 module Opal
   module Vite
-    VERSION = "0.3.13"
+    VERSION = "0.3.15"
   end
 end

data/lib/opal-vite.rb

@@ -32,12 +32,14 @@ module Opal
       # @param include_concerns [Boolean] Whether to include built-in concerns
       # @param source_map [Boolean] Whether to generate source maps
       # @param stubs [Array<String>] List of modules to stub (return empty implementations)
-      def compile_for_vite(file_path, include_concerns: true, source_map: true, stubs: [])
+      # @param external_runtime [Boolean] Leave Opal's corelib out of the output
+      #   (the caller loads it separately, e.g. via the `/@opal-runtime` module)
+      def compile_for_vite(file_path, include_concerns: true, source_map: true, stubs: [], external_runtime: false)
         # Temporarily override source map setting if specified
         original_source_map = config.source_map_enabled
         config.source_map_enabled = source_map
 
-        compiler = Compiler.new(include_concerns: include_concerns, stubs: stubs)
+        compiler = Compiler.new(include_concerns: include_concerns, stubs: stubs, external_runtime: external_runtime)
         result = compiler.compile_file(file_path)
 
         # Output JSON to stdout for the Vite plugin to consume

data/opal/opal_vite/compat/opal_stimulus.rb

@@ -0,0 +1,168 @@
+# backtick_javascript: true
+#
+# Fixes for opal_stimulus (0.2.x) accessors that look up the wrong
+# JavaScript property for multi-word names.
+#
+# opal_stimulus builds names such as "hasSoundButtonTarget" with
+# String#capitalize, which lowercases the rest of the word ("hasSoundbuttonTarget"),
+# and passes snake_case value names straight to Stimulus. As a result:
+#
+# - has_*_target / has_*_outlet / has_*_class always return undefined for
+#   multi-word names
+# - multi-word values read and write the wrong property, use the wrong
+#   data attribute, and never fire *_value_changed
+# - dashed outlet names (e.g. "user-status") read the wrong property and never
+#   fire *_outlet_connected / *_outlet_disconnected
+#
+# Usage (after opal_stimulus, before defining controllers):
+#
+#   require 'opal_stimulus/stimulus_controller'
+#   require 'opal_vite/compat/opal_stimulus'
+#
+# Values declared as `self.values = { latest_paid: :number }` then map to
+# Stimulus' latestPaidValue / data-<controller>-latest-paid-value, as they
+# would in a JavaScript controller.
+require 'opal_stimulus/stimulus_controller'
+
+module OpalVite
+  module Compat
+    module OpalStimulus
+      # "soundButton" -> "SoundButton" (String#capitalize gives "Soundbutton")
+      def self.upcase_first(name)
+        str = name.to_s
+        str.empty? ? str : str[0].upcase + str[1..-1]
+      end
+
+      # Stimulus' camelize: "latest_paid" / "user-status" -> "latestPaid" / "userStatus"
+      def self.camelize(name)
+        name.to_s.gsub(/[_-]([a-z0-9])/) { $1.upcase }
+      end
+
+      # Stimulus' namespaceCamelize for outlet names ("admin--user-status" -> "adminUserStatus")
+      def self.namespace_camelize(name)
+        camelize(name.to_s.gsub('--', '-').gsub('__', '_'))
+      end
+
+      module ClassMethods
+        def targets=(targets = [])
+          super
+
+          targets.each do |target|
+            has_prop = "has#{OpalStimulus.upcase_first(target)}Target"
+            define_method("has_#{to_ruby_name(target)}_target") do
+              `this[#{has_prop}]`
+            end
+          end
+        end
+
+        def outlets=(outlets = [])
+          super
+
+          outlets.each do |outlet|
+            ruby_name = to_ruby_name(outlet).tr('-', '_')
+            js_name = OpalStimulus.namespace_camelize(outlet)
+            outlet_prop = "#{js_name}Outlet"
+            outlets_prop = "#{js_name}Outlets"
+            has_prop = "has#{OpalStimulus.upcase_first(js_name)}Outlet"
+
+            define_method("#{ruby_name}_outlet") do
+              `this[#{outlet_prop}]`
+            end
+
+            define_method("#{ruby_name}_outlets") do
+              `this[#{outlets_prop}]`
+            end
+
+            define_method("has_#{ruby_name}_outlet") do
+              `this[#{has_prop}]`
+            end
+
+            # Stimulus calls the camelized callbacks; forward them to Ruby.
+            ["connected", "disconnected"].each do |event|
+              snake_case_callback = "#{ruby_name}_outlet_#{event}"
+              camel_case_callback = "#{js_name}Outlet#{OpalStimulus.upcase_first(event)}"
+              %x{
+                #{stimulus_controller}.prototype[#{camel_case_callback}] = function(outlet, element) {
+                  if (this['$respond_to?'] && this['$respond_to?'](#{snake_case_callback})) {
+                    return this['$' + #{snake_case_callback}](outlet, element);
+                  }
+                }
+              }
+            end
+          end
+        end
+
+        # Stimulus uses the class key as-is for xxxClass / xxxClasses, so only
+        # the has_ accessor needs fixing.
+        def classes=(class_names = [])
+          super
+
+          class_names.each do |class_name|
+            has_prop = "has#{OpalStimulus.upcase_first(class_name)}Class"
+            define_method("has_#{to_ruby_name(class_name)}_class") do
+              `this[#{has_prop}]`
+            end
+          end
+        end
+
+        # Replaces (does not wrap) the original: the original registers
+        # snake_case keys with Stimulus, which changes the data attribute
+        # name, so it cannot be fixed after the fact.
+        def values=(values_hash = {})
+          js_values = {}
+
+          values_hash.each do |name, type|
+            ruby_name = to_ruby_name(name)
+            js_name = OpalStimulus.camelize(ruby_name)
+
+            js_type = case type
+            when :string then `String`
+            when :number then `Number`
+            when :boolean then `Boolean`
+            when :array then `Array`
+            when :object then `Object`
+            else
+              raise ArgumentError,
+                "Unsupported value type: #{type}, please use :string, :number, :boolean, :array, or :object"
+            end
+
+            js_values[js_name] = js_type
+
+            value_prop = "#{js_name}Value"
+            has_prop = "has#{OpalStimulus.upcase_first(js_name)}Value"
+
+            define_method("#{ruby_name}_value") do
+              Native(`this[#{value_prop}]`)
+            end
+
+            define_method("#{ruby_name}_value=") do |value|
+              Native(`this[#{value_prop}] = #{value}`)
+            end
+
+            define_method("has_#{ruby_name}") do
+              `this[#{has_prop}]`
+            end
+
+            snake_case_changed = "#{ruby_name}_value_changed"
+            camel_case_changed = "#{js_name}ValueChanged"
+            %x{
+              #{stimulus_controller}.prototype[#{camel_case_changed}] = function(value, previousValue) {
+                if (#{type == :object}) {
+                  value = JSON.stringify(value)
+                  previousValue = JSON.stringify(previousValue)
+                }
+                if (this['$respond_to?'] && this['$respond_to?'](#{snake_case_changed})) {
+                  return this['$' + #{snake_case_changed}](value, previousValue);
+                }
+              }
+            }
+          end
+
+          `#{stimulus_controller}.values = #{js_values.to_n}`
+        end
+      end
+    end
+  end
+end
+
+StimulusController.singleton_class.prepend(OpalVite::Compat::OpalStimulus::ClassMethods)

data/opal/opal_vite/concerns/v1/action_cable_helpers.rb

@@ -318,7 +318,7 @@ module OpalVite
           json_str = cable_data(data, key)
           return nil if json_str.nil?
           `JSON.parse(#{json_str})`
-        rescue
+        rescue Exception
           nil
         end
 

data/opal/opal_vite/concerns/v1/base64_helpers.rb

@@ -29,7 +29,7 @@ module OpalVite
         # @return [String] Base64 encoded string
         def base64_encode(str)
           `btoa(#{str})`
-        rescue
+        rescue Exception
           nil
         end
 
@@ -38,7 +38,7 @@ module OpalVite
         # @return [String] Decoded string
         def base64_decode(str)
           `atob(#{str})`
-        rescue
+        rescue Exception
           nil
         end
 
@@ -81,7 +81,7 @@ module OpalVite
         def base64_encode_unicode(str)
           # Convert to UTF-8 bytes, then encode
           `btoa(unescape(encodeURIComponent(#{str})))`
-        rescue
+        rescue Exception
           nil
         end
 
@@ -90,7 +90,7 @@ module OpalVite
         # @return [String] Decoded Unicode string
         def base64_decode_unicode(str)
           `decodeURIComponent(escape(atob(#{str})))`
-        rescue
+        rescue Exception
           nil
         end
 
@@ -108,7 +108,7 @@ module OpalVite
             }
             return btoa(binary);
           `
-        rescue
+        rescue Exception
           nil
         end
 
@@ -124,7 +124,7 @@ module OpalVite
             }
             return bytes;
           `
-        rescue
+        rescue Exception
           nil
         end
 
@@ -202,7 +202,7 @@ module OpalVite
           return nil unless payload_json
 
           `JSON.parse(#{payload_json})`
-        rescue
+        rescue Exception
           nil
         end
 
@@ -264,7 +264,9 @@ module OpalVite
 
           len = str.length
           padding = str.end_with?('==') ? 2 : (str.end_with?('=') ? 1 : 0)
-          (len * 3 / 4) - padding
+          # Use integer division: in Opal `len * 3 / 4` is JS float division, so
+          # unpadded/URL-safe input (len % 4 == 2 or 3) would yield e.g. 16.5.
+          ((len * 3) / 4).floor - padding
         end
       end
     end

data/opal/opal_vite/concerns/v1/react_helpers.rb

@@ -275,7 +275,10 @@ module OpalVite
 
         # Stringify to JSON
         def to_json(object)
-          `JSON.stringify(#{object})`
+          # Convert Ruby Hash/Array to a native JS value first; passing a raw
+          # Opal Hash to JSON.stringify serializes to "{}" (silent data loss).
+          native = object.respond_to?(:to_n) ? object.to_n : object
+          `JSON.stringify(#{native})`
         end
 
         # ===================

data/opal/opal_vite/concerns/v1/stimulus_helpers.rb

@@ -857,11 +857,12 @@ module OpalVite
       end
 
       # Call a method on a JavaScript object
-      # @param obj [Native] JavaScript object
+      # @param obj [Object] JavaScript object (raw, Native or JS::Proxy)
       # @param method [Symbol, String] Method name
       # @param args [Array] Arguments to pass
       # @return [Native] Method return value
       def js_call_on(obj, method, *args)
+        obj = to_native_element(obj)
         if args.empty?
           `#{obj}[#{method.to_s}]()`
         else
@@ -871,21 +872,40 @@ module OpalVite
       end
 
       # Get a property from a JavaScript object
-      # @param obj [Native] JavaScript object
+      #
+      # Unlike calling the property as a method on a JS::Proxy (e.g. the
+      # elements opal_stimulus' `*_target` methods return), a missing property
+      # does not raise NoMethodError; you get JavaScript's undefined.
+      #
+      # @param obj [Object] JavaScript object (raw, Native or JS::Proxy)
       # @param prop [Symbol, String] Property name
-      # @return [Native] Property value
+      # @return [Object] Raw property value (may be undefined)
       def js_get(obj, prop)
+        obj = to_native_element(obj)
         `#{obj}[#{prop.to_s}]`
       end
 
       # Set a property on a JavaScript object
-      # @param obj [Native] JavaScript object
+      # @param obj [Object] JavaScript object (raw, Native or JS::Proxy)
       # @param prop [Symbol, String] Property name
       # @param value [Object] Value to set
       def js_set(obj, prop, value)
+        obj = to_native_element(obj)
         `#{obj}[#{prop.to_s}] = #{value}`
       end
 
+      # Read a data-* attribute through element.dataset
+      # @param element [Object] DOM element (raw, Native or JS::Proxy)
+      # @param key [Symbol, String] Attribute name without "data-", in
+      #   snake_case or camelCase (:confirm_message and :confirmMessage both
+      #   read data-confirm-message)
+      # @return [String, nil] The attribute value, or nil when it is absent
+      def dataset_value(element, key)
+        el = to_native_element(element)
+        name = camelize(key, false)
+        `(#{el}.dataset[#{name}] == null) ? nil : #{el}.dataset[#{name}]`
+      end
+
       # ===== JSON Methods =====
 
       # Parse JSON string to JavaScript object

data/opal/opal_vite/concerns/v1/storable.rb

@@ -11,7 +11,7 @@ module OpalVite
 
         begin
           `JSON.parse(stored)`
-        rescue
+        rescue Exception
           nil
         end
       end

data/opal/opal_vite/concerns/v1/turbo_helpers.rb

@@ -356,7 +356,13 @@ module OpalVite
         #   source = turbo_stream_from("/notifications/stream")
         #   # Turbo will automatically process incoming streams
         def turbo_stream_from(url)
-          `window.Turbo.connectStreamSource(new EventSource(#{url}))`
+          # Keep a reference to the EventSource and return it: connectStreamSource
+          # returns undefined, so returning its result would make the documented
+          # `turbo_stream_disconnect(source)` call `undefined.close()` and leak
+          # the SSE connection.
+          source = `new EventSource(#{url})`
+          `window.Turbo.connectStreamSource(#{source})`
+          source
         end
 
         # Disconnect a Turbo Stream SSE source

data/opal/opal_vite/concerns/v1/uri_helpers.rb

@@ -27,7 +27,7 @@ module OpalVite
         # @return [Native] JavaScript URL object
         def parse_url(url_string)
           `new URL(#{url_string})`
-        rescue
+        rescue Exception
           nil
         end
 
@@ -37,7 +37,7 @@ module OpalVite
         # @return [Native] JavaScript URL object
         def parse_url_with_base(url_string, base)
           `new URL(#{url_string}, #{base})`
-        rescue
+        rescue Exception
           nil
         end
 
@@ -225,7 +225,7 @@ module OpalVite
         # @return [String] Decoded string
         def decode_uri_component(str)
           `decodeURIComponent(#{str})`
-        rescue
+        rescue Exception
           str
         end
 
@@ -241,7 +241,7 @@ module OpalVite
         # @return [String] Decoded URI
         def decode_uri(str)
           `decodeURI(#{str})`
-        rescue
+        rescue Exception
           str
         end
 

data/opal/opal_vite/concerns/v1/vue_helpers.rb

@@ -315,7 +315,10 @@ module OpalVite
 
         # Stringify to JSON
         def to_json_string(object)
-          `JSON.stringify(#{object})`
+          # Convert Ruby Hash/Array to a native JS value first; passing a raw
+          # Opal Hash to JSON.stringify serializes to "{}" (silent data loss).
+          native = object.respond_to?(:to_n) ? object.to_n : object
+          `JSON.stringify(#{native})`
         end
 
         # ===================

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: opal-vite
 version: !ruby/object:Gem::Version
-  version: 0.3.13
+  version: 0.3.15
 platform: ruby
 authors:
 - stofu1234
@@ -112,6 +112,7 @@ files:
 - lib/opal/vite/testing/stable_helpers.rb
 - lib/opal/vite/version.rb
 - opal/opal_vite.rb
+- opal/opal_vite/compat/opal_stimulus.rb
 - opal/opal_vite/concerns.rb
 - opal/opal_vite/concerns/dom_helpers.rb
 - opal/opal_vite/concerns/js_proxy_ex.rb