gen_server 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9e256c6d2994f782837aea8435a41ba8f5d4322ac62ed4f9f9cf4ec1cdb1fa5a
+  data.tar.gz: 53342fd0596658d3a616298813368423efae86aaaf3069cc68b2c855e61c84d4
+SHA512:
+  metadata.gz: 1674611e97fa539f90b02dfd77f3f7c367c654fb54d586371ee2ff5b8f40edce90ed9e97a9e2ae787cdd5da51f491d36d17eb6a9fde61bd99ced341fc6532eb7
+  data.tar.gz: dce0274547ef0dab17c71e16a7bab93708b6de2bcb7b25544a79b033cae2af4db3dd2c00f625f9857017d7234e51f6dfe8df222b69c7198e1d69addd5f71c16a

data/.rubocop.yml

@@ -0,0 +1,24 @@
+require:
+  - rubocop-minitest
+  - rubocop-rake
+
+AllCops:
+  TargetRubyVersion: 3.1
+  NewCops: enable
+
+Metrics/MethodLength:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Layout/LineLength:
+  Max: 120

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'minitest', '~> 5.0'
+gem 'minitest-proveit'
+gem 'rake', '~> 13.0'
+gem 'rubocop', '~> 1.21'
+gem 'rubocop-minitest', require: false
+gem 'rubocop-rake', require: false

data/Gemfile.lock

@@ -0,0 +1,51 @@
+PATH
+  remote: .
+  specs:
+    gen_server (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    minitest (5.16.1)
+    minitest-proveit (1.0.0)
+      minitest (> 5, < 7)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
+    rubocop (1.30.1)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.18.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.18.0)
+      parser (>= 3.1.1.0)
+    rubocop-minitest (0.20.1)
+      rubocop (>= 0.90, < 2.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.1.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  gen_server!
+  minitest (~> 5.0)
+  minitest-proveit
+  rake (~> 13.0)
+  rubocop (~> 1.21)
+  rubocop-minitest
+  rubocop-rake
+
+BUNDLED WITH
+   2.4.0.dev

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Shannon Skipper
+
+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,19 @@
+# GenServer
+
+This is a Ruby implementation of GenServer using Ractors.
+
+## Installation
+
+Add it to your bundle.
+```sh
+bundle add gen_server
+```
+
+Or just install it directly.
+```sh
+gem install gen_server
+```
+
+## Usage
+
+Check out the `example/` directory for now.

data/Rakefile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rubocop/rake_task'
+
+Rake::TestTask.new :test do |task|
+  task.libs << 'test'
+  task.libs << 'lib'
+  task.test_files = FileList['test/**/test_*.rb']
+end
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/Steepfile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+target :lib do
+  signature 'sig'
+
+  check 'lib'
+
+  library 'securerandom', 'singleton'
+end

data/example/basic_stack.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative '../lib/gen_server'
+
+class BasicStack
+  include GenServer
+
+  def init(stack)
+    [:ok, stack]
+  end
+
+  def handle_call(message, _from, (head, *tail))
+    message => :pop
+
+    [:reply, head, tail]
+  end
+
+  def handle_cast((cast, element), state)
+    cast => :push
+    state.unshift(element)
+
+    [:noreply, element]
+  end
+end
+
+GenServer.start_link(BasicStack, [:hello]) => [:ok, pid]
+p GenServer.call(pid, :pop)
+p GenServer.cast(pid, %i[push world])
+p GenServer.call(pid, :pop)

data/example/noop.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require_relative '../lib/gen_server'
+
+class Noop
+  include GenServer
+end
+
+GenServer.start_link(Noop, []) => [:ok, pid]
+p GenServer.call(pid, :foo)
+p GenServer.cast(pid, %i[push bar])
+p GenServer.call(pid, :foo)

data/example/stack.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require_relative '../lib/gen_server'
+
+class Stack
+  include GenServer
+
+  ##
+  # Client
+  class << self
+    def start_link(default = [])
+      GenServer.start_link(self, default)
+    end
+
+    def push(pid, element)
+      GenServer.cast(pid, [:push, element])
+    end
+
+    def pop(pid)
+      GenServer.call(pid, :pop)
+    end
+  end
+
+  ##
+  # Server (callbacks)
+  def init(stack)
+    [:ok, stack]
+  end
+
+  def handle_call(message, _from, (head, *tail))
+    message => :pop
+
+    [:reply, head, tail]
+  end
+
+  def handle_cast((cast, element), state)
+    cast => :push
+    state.unshift(element)
+
+    [:noreply, element]
+  end
+end
+
+Stack.start_link([:hello]) => [:ok, pid]
+p Stack.pop(pid)
+p Stack.push(pid, :world)
+p Stack.pop(pid)

data/lib/gen_server/registry/info.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module GenServer
+  class Registry
+    Info = Struct.new(:actor, :klass)
+  end
+end

data/lib/gen_server/registry.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative 'registry/info'
+
+module GenServer
+  class Registry
+    include Singleton
+
+    attr_reader :pids
+
+    def initialize
+      @pids = {}
+    end
+
+    class << self
+      def []=(pid, info)
+        instance.pids[pid] = info
+      end
+
+      def actor(pid)
+        instance.pids.fetch(pid).actor
+      end
+
+      def klass(pid)
+        instance.pids.fetch(pid).klass
+      end
+    end
+  end
+end

data/lib/gen_server/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module GenServer
+  VERSION = '0.0.1'
+end

data/lib/gen_server.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'securerandom'
+require 'singleton'
+require_relative 'gen_server/registry'
+require_relative 'gen_server/version'
+
+module GenServer
+  def initialize(...)
+    init(...)
+  end
+
+  def init(...) = nil
+  def handle_call(...) = [:reply, nil, nil]
+  def handle_cast(...) = [:noreply, nil]
+
+  class << self
+    def start_link(klass, state = [])
+      pid = SecureRandom.uuid
+
+      actor = Ractor.new(state, name: pid) do |state|
+        GenServer.receive(state)
+      end
+
+      Registry[pid] = Registry::Info.new(actor:, klass:)
+
+      [:ok, pid]
+    end
+
+    def receive(state)
+      case Ractor.receive
+      in [:cast, message, klass]
+        klass.allocate.handle_cast(message, state) => [:noreply, new_state]
+        receive(new_state)
+      in [:call, sender, message, klass]
+        klass.allocate.handle_call(message, sender, state) => [:reply, reply, new_state]
+        sender.send [:ok, reply]
+        receive(new_state)
+      end
+    end
+
+    def cast(pid, message)
+      Registry.actor(pid).send [:cast, message, Registry.klass(pid)]
+
+      :ok
+    end
+
+    def call(pid, message)
+      Registry.actor(pid).send [:call, Ractor.current, message, Registry.klass(pid)]
+      Ractor.receive => [:ok, response]
+
+      response
+    end
+  end
+end

data/sig/gen_server.rbs

@@ -0,0 +1,27 @@
+module GenServer
+  VERSION: String
+
+  def initialize: (*untyped noname) -> void
+  def init: (*untyped noname) -> untyped
+  def handle_call: (*untyped noname) -> [:reply, untyped, untyped]
+  def handle_cast: (*untyped noname) -> [:noreply, untyped]
+  def self.start_link: (singleton(Class) klass, ?Array[untyped] state) -> bot
+  def self.receive: (untyped state) -> bot
+  def self.cast: (String pid, [:push, untyped] message) -> :ok
+  def self.call: (String pid, :pop message) -> untyped
+
+  class Registry
+    include Singleton
+
+    attr_reader pids: Hash[String, Struct[untyped]]
+    def initialize: -> void
+    def self.[]=: (String pid, Struct[untyped] info) -> untyped
+    def self.actor: (String pid) -> Ractor
+    def self.klass: (String pid) -> Class
+
+    class Info < Struct[untyped]
+      attr_accessor actor(): Ractor
+      attr_accessor klass(): Class
+    end
+  end
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: gen_server
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Shannon Skipper
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2022-06-22 00:00:00.000000000 Z
+dependencies: []
+description: A GenServer implemented with Ruby Ractors
+email:
+- shannonskipper@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- Steepfile
+- example/basic_stack.rb
+- example/noop.rb
+- example/stack.rb
+- lib/gen_server.rb
+- lib/gen_server/registry.rb
+- lib/gen_server/registry/info.rb
+- lib/gen_server/version.rb
+- sig/gen_server.rbs
+homepage: https://github.com/havenwood/gen_server
+licenses:
+- MIT
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message: 
+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.4.0.dev
+signing_key: 
+specification_version: 4
+summary: A Ractor-backed GenServer
+test_files: []