opal_proxy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 13a2623ddda8f5c4e6892bc3c96f4cca256c45bb7fa18831c75a38e738bb7cd1
+  data.tar.gz: 2a54e5826508f77937177d5354054ac6f48408977ee9ffe3eeb78926f2bc462c
+SHA512:
+  metadata.gz: 502c1850edd96983c5f1816aea4e365d9468bc18a558f2c57348126c52456a7847b7a5be8ac782008d5d195d795021e9b045a228944603631e2c84e3cca224d2
+  data.tar.gz: 4326f0e789b89a6279b68d1eba455b9133b4a0e9c7192de0c1ad9b21ef749acb7493213a820aadf6555782267bd04e3a93ad5ed35bd433c8e3d6a732f4fca106

data/.rubocop.yml

@@ -0,0 +1,8 @@
+AllCops:
+  TargetRubyVersion: 3.1
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-07-24
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Joseph Schito
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,102 @@
+# OpalProxy
+
+Opal Proxy provides a dynamic interface to JavaScript objects in Opal,
+allowing seamless property access, method calls, and Promise handling using idiomatic Ruby syntax.
+
+## Installation
+
+Add this line to your Gemfile:
+
+```ruby
+gem 'opal_proxy'
+```
+
+Execute:
+
+```bash
+bundle install
+```
+
+
+## Document example
+
+```ruby
+require "js/proxy"
+
+class Document < JSProxy
+  def initialize
+    super($$.document)
+  end
+end
+
+document = Document.new
+headers = document.querySelectorAll("h1") # or query_selector_all
+headers.each do |h1|
+  h1.text_content = "Opal is great!" # or textContent
+end
+
+document.body.style.background_color = "lightblue"
+document.body.style.font_family = "Arial, sans-serif"
+document.body.style.color = "darkblue"
+```
+
+## Window example
+
+```ruby
+require "js/proxy"
+# ... including document
+
+class Window < JSProxy
+  def initialize
+    super($$.window)
+  end
+end
+
+window = Window.new
+window.alert "Hello world!"
+window.set_timeout(-> {
+  puts "1. Timeout test OK (1s delay)"
+}, 1000)
+window.fetch("https://jsonplaceholder.typicode.com/todos/1")
+  .then do |response|
+    response.json().then do |data|
+      puts "5. Fetched: #{data["title"]}"
+      document.get_element_by_id("output").inner_html += "<p>5. Fetched: #{data["title"]}</p>"
+    end
+  end
+```
+
+## JQuery example
+
+```ruby
+require "js/proxy"
+# ... including document
+
+doc = Document.new
+jquery_script = doc.createElement('script')
+jquery_script.src = "https://code.jquery.com/jquery-3.7.1.min.js"
+doc.head.appendChild(jquery_script)
+jquery_script.onload = -> {
+  class JQuery < JS::Proxy
+    def initialize(node)
+      super(`$(node)`)
+    end
+  end
+
+  document = JQuery.new($$.document)
+  document.ready do
+    paragraph = doc.createElement('p')
+    paragraph.text_content = "If you click on me, I will disappear."
+    doc.body.appendChild(paragraph)
+    JQuery.new("p").click(&:hide)
+  end
+}
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/josephschito/opal_proxy.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/lib/js/proxy.rb

@@ -0,0 +1,177 @@
+require "opal"
+require "native"
+
+module JS
+  module Helpers
+    def wrap_result(result)
+      if `result && typeof result.then === 'function'`
+        Promise.new(result)
+      elsif `typeof result === 'object' && result !== null`
+        Proxy.new(result)
+      else
+        result
+      end
+    end
+
+    def native_methods
+      @native_methods ||= %x{
+        let obj = #{to_n};
+        const props = new Set();
+
+        while (obj !== null) {
+          for (const key of Reflect.ownKeys(obj)) {
+            const stringKey = key.toString()
+            const rubyName = #{to_rb_name(`stringKey`)}
+
+            if (typeof key !== 'symbol' && stringKey !== rubyName ) { props.add(rubyName); }
+            props.add(stringKey);
+          }
+          obj = Object.getPrototypeOf(obj);
+        }
+
+        return Array.from(props);
+      }
+    end
+  end
+
+  class Proxy
+    include Enumerable
+    include Helpers
+
+    attr_accessor :native
+
+    IRREGULARS = %w(html url uri)
+
+    def initialize(native)
+      @native = Native(native)
+    end
+
+    def method_missing(name, *args, &block)
+      js_name = to_js_name(name)
+
+      unless existing_property?(js_name) || js_name.end_with?("=")
+        raise NoMethodError, "undefined method `#{name}` for #{self}"
+      end
+
+      if js_name.end_with?("=")
+        prop = js_name[0..-2]
+        native[prop] = args.first
+      else
+        val = native[js_name]
+
+        if `typeof val === 'function'`
+          js_args = args.dup
+
+          if block
+            js_callback = %x{
+              function() {
+                let args = Array.prototype.slice.call(arguments);
+                return #{block.call(self.class.new(`this`), *args)};
+              }
+            }
+            js_args << js_callback
+          end
+
+          result = `val.apply(#{to_n}, #{js_args.to_n})`
+          wrap_result(result)
+        elsif `typeof val === 'object' && val !== null`
+          wrap_result(val)
+        else
+          val
+        end
+      end
+    end
+
+    def to_str
+      `#{to_n}.toString()`
+    end
+
+    def respond_to_missing?(name, include_private = false)
+      true
+    end
+
+    def each
+      return enum_for(:each) unless respond_to?(:length)
+
+      length = self.length
+      (0...length).each do |i|
+        yield self[i]
+      end
+    end
+
+    def [](index)
+      val = native[index]
+      wrap_result(val)
+    end
+
+    def to_n
+      native.to_n
+    end
+
+    def length
+      native.length
+    end
+
+    private
+
+    def to_js_name(name)
+      name.to_s.split('_').map.with_index do |part, index|
+        if IRREGULARS.include? part.gsub("=", "").downcase
+          part.upcase
+        else
+          index.zero? ? part : part.capitalize
+        end
+      end.join
+    end
+
+    def to_rb_name(name)
+      name
+        .to_s
+        .gsub(/([A-Z]+)/) { "_#{$1.downcase}" }
+        .sub(/^_/, '')
+    end
+
+    def existing_property?(property)
+      `#{property} in #{to_n}`
+    end
+  end
+
+  class Promise < Proxy
+    include Helpers
+
+    def then(&block)
+      js_callback = %x{
+        function(value) {
+          var ruby_result = #{block.call(wrap_result(`value`))};
+          if (ruby_result && typeof ruby_result.then === 'function') {
+            return ruby_result;
+          } else if (ruby_result && typeof ruby_result.to_n === 'function') {
+            return ruby_result.to_n();
+          } else {
+            return ruby_result;
+          }
+        }
+      }
+
+      self.native = `#{to_n}.then(#{js_callback})`
+    end
+
+    def catch(&block)
+      js_callback = %x{
+        function(error) {
+          var ruby_result = #{block.call(wrap_result(`error`))};
+
+          if (ruby_result && typeof ruby_result.then === 'function') {
+            return ruby_result;
+          } else if (ruby_result && typeof ruby_result.to_n === 'function') {
+            return ruby_result.to_n();
+          } else {
+            return ruby_result;
+          }
+        }
+      }
+
+      self.native = `#{to_n}.catch(#{js_callback})`
+    end
+  end
+end

data/lib/opal_proxy/version.rb

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

data/lib/opal_proxy.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+if RUBY_ENGINE == 'opal'
+  require_relative "js/proxy"
+else
+  require "opal"
+  require_relative "opal_proxy/version"
+
+  Opal.append_path File.expand_path('lib', __dir__)
+end
+
+module OpalProxy
+end

data/sig/opal_proxy.rbs

@@ -0,0 +1,4 @@
+module OpalProxy
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: opal_proxy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joseph Schito
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: opal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.8.2
+description: Opal Proxy provides a dynamic interface to JavaScript objects in Opal,
+  allowing seamless property access, method calls, and Promise handling using idiomatic
+  Ruby syntax.
+email:
+- joseph.schito@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/js/proxy.rb
+- lib/opal_proxy.rb
+- lib/opal_proxy/version.rb
+- sig/opal_proxy.rbs
+homepage: https://github.com/josephschito/opal_proxy
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/josephschito/opal_proxy
+  source_code_uri: https://github.com/josephschito/opal_proxy
+  changelog_uri: https://github.com/josephschito/opal_proxy/blob/main/CHANGELOG.md
+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.9
+specification_version: 4
+summary: Dynamic Ruby-style wrapper for JavaScript objects in Opal.
+test_files: []