drb_protocol_drubyws 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4d60c97e74095d8c66fca1f9d8de34014abaace7411322de312cb2a115ca6cfb
+  data.tar.gz: cfb17c1f4bd9351f321024ad7cb2f285c578b8c80a204537420caeb5acf72642
+SHA512:
+  metadata.gz: 8ee27234e9e09402504117580564d09ecdef784f64c7e620537ba7d09f4e81ff47294d9bc5b2424b3aba936afd8af8acefa3a7c0b67af5f80918a5d02b6253d9
+  data.tar.gz: cbde11820a22e8e638ff7cac3fea7831c7bed0b5c917bdc94a249266a72fbf949cd48ae864c67ae85af7c1c2649f5f86e564548da4beca5aeea7d7da835c2d3f

data/.idea/.gitignore

@@ -0,0 +1,3 @@
+# Default ignored files
+/shelf/
+/workspace.xml

data/.idea/drb_web_socket.iml

@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="RUBY_MODULE" version="4">
+  <component name="ModuleRunConfigurationManager">
+    <shared />
+  </component>
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$">
+      <sourceFolder url="file://$MODULE_DIR$/features" isTestSource="true" />
+      <sourceFolder url="file://$MODULE_DIR$/spec" isTestSource="true" />
+      <sourceFolder url="file://$MODULE_DIR$/test" isTestSource="true" />
+    </content>
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+    <orderEntry type="library" scope="PROVIDED" name="ast (v2.4.2, rbenv: 3.3.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="drb (v2.2.1, rbenv: 3.3.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="fiber-annotation (v0.2.0, rbenv: 3.3.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="fiber-local (v1.1.0, rbenv: 3.3.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="fiber-storage (v1.0.0, rbenv: 3.3.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="language_server-protocol (v3.17.0.3, rbenv: 3.3.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="protocol-websocket (v0.20.1, rbenv: 3.3.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="racc (v1.8.1, rbenv: 3.3.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rainbow (v3.1.1, rbenv: 3.3.5) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rake (v13.2.1, rbenv: 3.3.5) [gem]" level="application" />
+  </component>
+</module>

data/.idea/misc.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectRootManager" version="2" project-jdk-name="rbenv: 3.3.5" project-jdk-type="RUBY_SDK" />
+</project>

data/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/drb_web_socket.iml" filepath="$PROJECT_DIR$/.idea/drb_web_socket.iml" />
+    </modules>
+  </component>
+</project>

data/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="" vcs="Git" />
+  </component>
+</project>

data/.rubocop.yml

@@ -0,0 +1,13 @@
+require:
+  - rubocop-rake
+  - rubocop-minitest
+
+AllCops:
+  TargetRubyVersion: 3.1
+  NewCops: enable
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/README.md

@@ -0,0 +1,35 @@
+# Drb Protocol drubyws
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/drb_web_socket`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/drb_web_socket.

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/examples/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gem "drb_web_socket", path: "../"

data/examples/Gemfile.lock

@@ -0,0 +1,28 @@
+PATH
+  remote: ..
+  specs:
+    drb_web_socket (0.1.0)
+      drb (~> 2.2)
+      wands (~> 0.6)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    drb (2.2.1)
+    protocol-http (0.47.1)
+    protocol-websocket (0.20.1)
+      protocol-http (~> 0.2)
+    wands (0.6.0)
+      protocol-websocket (~> 0.20)
+      webrick (~> 1.9)
+    webrick (1.9.1)
+
+PLATFORMS
+  ruby
+  x86_64-linux
+
+DEPENDENCIES
+  drb_web_socket!
+
+BUNDLED WITH
+   2.6.2

data/examples/hello_c.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require "drb_web_socket"
+
+foo = DRbObject.new_with_uri("drubyws://localhost:12345")
+foo.greeting

data/examples/hello_s.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "drb_web_socket"
+
+# This is a sample class.
+class Foo
+  def greeting = puts "Hello, world!"
+end
+
+DRb.start_service "drubyws://localhost:12345", Foo.new
+sleep

data/lib/drb_web_socket/connection_to_client.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module DRbWebSocket
+  # A connection instance from DrbWebSocket::Server#accept.
+  class ConnectionToClient
+    # DRb::DRbServer#main_loop calls `client.uri` method.
+    attr_reader :uri
+
+    def initialize(uri, socket, config = {})
+      @uri = uri
+      @socket = socket
+      @config = config
+      @msg = DRb::DRbMessage.new(config)
+    end
+
+    # Receive a request from the client and return a [object, message, args, block] tuple.
+    def recv_request
+      @msg.recv_request(@socket)
+    end
+
+    #  Send a reply to the client.
+    def send_reply(succ, result)
+      @msg.send_reply(@socket, succ, result)
+    end
+
+    # Close this connection.
+    def close
+      return unless @socket
+
+      @socket.close
+      @socket = nil
+    end
+  end
+end

data/lib/drb_web_socket/connection_to_server.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require "drb/drb"
+
+module DRbWebSocket
+  # A protocol instance from DrbWebSocket::Protocol.open.
+  class ConnectionToServer
+    def initialize(uri, socket, config = {})
+      @uri = uri
+      @socket = socket
+      @config = config
+      @msg = DRb::DRbMessage.new(config)
+    end
+
+    # Send a request to +ref+ with the given message id and arguments.
+    def send_request(ref, msg_id, arg, block)
+      @msg.send_request(@socket, ref, msg_id, arg, block)
+    end
+
+    # Receive a reply from the server and return it as a [success-boolean, reply-value] pair.
+    def recv_reply
+      @msg.recv_reply(@socket)
+    end
+
+    # Close this connection.
+    def close
+      return unless @socket
+
+      @socket.close
+      @socket = nil
+    end
+
+    # Is this connection still alive?
+    def alive?
+      return false unless @socket
+
+      true
+    end
+  end
+end

data/lib/drb_web_socket/protocol.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require "wands"
+require "uri"
+
+module DRbWebSocket
+  # A protocol with WebSocket for drb.
+  module Protocol
+    class << self
+      def open(uri, config)
+        host, port = parse_uri(uri)
+        socket = Wands::WebSocket.open(host, port)
+        ConnectionToServer.new(uri, socket, config)
+      end
+
+      def open_server(uri, config)
+        host, port = parse_uri(uri)
+        server = Wands::WebSocketServer.open(host, port)
+
+        if port.zero?
+          addr = server.addr
+          port = addr[1]
+        end
+        uri = "drubyws://#{host}:#{port}"
+
+        Server.new(uri, server, config)
+      end
+
+      def uri_option(uri, _config)
+        [uri, nil]
+      end
+
+      private
+
+      def parse_uri(uri)
+        parsed_uri = URI.parse(uri)
+        raise(DRb::DRbBadScheme, uri) unless parsed_uri.scheme == "drubyws"
+
+        [parsed_uri.host, parsed_uri.port]
+      rescue URI::InvalidURIError
+        raise(DRb::DRbBadURI, "can't parse uri:#{uri}")
+      end
+    end
+  end
+end

data/lib/drb_web_socket/server.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module DRbWebSocket
+  # A protocol instance from DrbWebSocket::Protocol.open_server.
+  class Server
+    #  Get the URI for this server.
+    attr_reader :uri
+
+    def initialize(uri, socket, config = {})
+      raise ArgumentError, "socket Must respond to :to_io" unless socket.respond_to?(:to_io)
+
+      @uri = uri
+      @socket = socket
+      @config = config
+    end
+
+    # Accept a new connection to the server.
+    # Returns a protocol instance capable of communicating with the client.
+    def accept
+      socket = @socket.accept
+      ConnectionToClient.new(@uri, socket, @config)
+    end
+
+    # Close the server connection.
+    def close
+      return unless @socket
+
+      @socket.close
+      @socket = nil
+    end
+  end
+end

data/lib/drb_web_socket/version.rb

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

data/lib/drb_web_socket.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative "drb_web_socket/version"
+require_relative "drb_web_socket/protocol"
+require_relative "drb_web_socket/server"
+require_relative "drb_web_socket/connection_to_client"
+require_relative "drb_web_socket/connection_to_server"
+
+# DrbWebSocket provides a protocol with WebSocket for the drb.
+DRb::DRbProtocol.add_protocol(DRbWebSocket::Protocol)

data/sig/drb_web_socket.rbs

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

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: drb_protocol_drubyws
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- shigeru.nakajima
+bindir: exe
+cert_chain: []
+date: 2025-03-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: drb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: wands
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+description: A transport protocol for dRuby that uses WebSocket. It enables connections
+  from a browser to a dRuby server.
+email:
+- shigeru.nakajima@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".idea/.gitignore"
+- ".idea/drb_web_socket.iml"
+- ".idea/misc.xml"
+- ".idea/modules.xml"
+- ".idea/vcs.xml"
+- ".rubocop.yml"
+- README.md
+- Rakefile
+- examples/Gemfile
+- examples/Gemfile.lock
+- examples/hello_c.rb
+- examples/hello_s.rb
+- lib/drb_web_socket.rb
+- lib/drb_web_socket/connection_to_client.rb
+- lib/drb_web_socket/connection_to_server.rb
+- lib/drb_web_socket/protocol.rb
+- lib/drb_web_socket/server.rb
+- lib/drb_web_socket/version.rb
+- sig/drb_web_socket.rbs
+homepage: https://github.com/ledsun/drb_web_socket
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/ledsun/drb_web_socket
+  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.2
+specification_version: 4
+summary: A protocol with WebSocket for drb.
+test_files: []