backtor 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 36d7183f82af76c0f66866c460ba199ada9a2aa6f1e263b505bd7f31367a8980
+  data.tar.gz: 205efd80e76cd8d8128eb24fe29a72412a5850e70c0f36de92d71d92895bed9f
+SHA512:
+  metadata.gz: 1a4ce39c94e9e640d5069e301288f138e35d2e124596ffa5a42b3eb36433d7a8f565fdb2ebafd51236299a12c60da32e96f507fd30a09fbb2485c78f14c5d851
+  data.tar.gz: fbbe8a9548a078db62b90abec42555fb10ddfb3c0f527ced5292fd150e38ed0748cac74f8ba555cac1b4356cadbd044d8115bc50d5ab33c1118281d034c003c6

data/.github/workflows/main.yml

@@ -0,0 +1,18 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0.0
+    - name: Run the default task
+      run: |
+        gem install bundler -v 2.2.0.dev
+        bundle install
+        bundle exec rake

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in backtor.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,39 @@
+PATH
+  remote: .
+  specs:
+    backtor (1.0.0)
+      concurrent-ruby
+      concurrent-ruby-edge
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    concurrent-ruby (1.1.7)
+    concurrent-ruby-edge (0.6.0)
+      concurrent-ruby (~> 1.1.6)
+    diff-lcs (1.4.4)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  backtor!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Aaron Christiansen
+
+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,20 @@
+# Backtor
+
+Backtor is an experimental, thread-based backport of Ractor to earlier Ruby
+versions.
+
+Since it's based on Ruby's `Thread` mechanism, you don't get the true
+concurrency of Ractors, but it does mean that you can write applications using
+Ractor and still have them work at a reduced speed in Ruby 2.
+
+This is still a work in progress! The basic `yield`/`take` and `send`/`recv`
+mechanisms are implemented, but very little else.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/AaronC81/backtor.
+
+
+## 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,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/backtor.gemspec

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |spec|
+  spec.name          = "backtor"
+  spec.version       = '0.1.0'
+  spec.authors       = ["Aaron Christiansen"]
+  spec.email         = ["aaronc20000@gmail.com"]
+
+  spec.summary       = "Backport of Ractor using threads"
+  spec.homepage      = "https://github.com/AaronC81/backtor"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'concurrent-ruby'
+  spec.add_dependency 'concurrent-ruby-edge'
+end

data/lib/backtor.rb

@@ -0,0 +1,96 @@
+require 'concurrent-ruby'
+require 'concurrent-edge'
+
+class Backtor
+  def self.new_id
+    @last_id ||= 0
+    @last_id += 1
+    @last_id
+  end
+
+  def initialize(*args, name: nil, __backtor_special_main: false, &block)
+    raise ArgumentError, 'must be called with a block' if block.nil?
+    raise TypeError, "no implicit conversion of #{name.class} into String" \
+      unless name.nil? || name.is_a?(String)
+    
+    @name = name
+    @backtor_id = Backtor.new_id
+    @__backtor_special_main = __backtor_special_main
+
+    @thread = Thread.new do
+      unless __backtor_special_main
+        # TODO: send parameters the proper way, see spec
+        # TODO: exceptions
+        Backtor.yield(self.instance_exec(*args, &block))
+      end
+    end
+    @thread.abort_on_exception = true
+    @thread.instance_variable_set(:@backtor, self)
+
+    @incoming_queue = []
+    @incoming_queue_mutex = Mutex.new
+    @incoming_queue_cv = ConditionVariable.new
+    @outgoing_port = Concurrent::Channel.new
+  end
+
+  MAIN = Backtor.new(__backtor_special_main: true) {}
+
+  # TODO: proper clone behaviour like real ractors
+
+  def send(obj)
+    @incoming_queue_mutex.synchronize do
+      @incoming_queue << obj
+      @incoming_queue_cv.signal
+    end
+  end
+  alias << send
+
+  def self.recv
+    mutex = Thread.current.instance_variable_get(:@backtor).instance_variable_get(:@incoming_queue_mutex)
+
+    mutex.synchronize do
+      queue = Thread.current.instance_variable_get(:@backtor).instance_variable_get(:@incoming_queue)
+      cv = Thread.current.instance_variable_get(:@backtor).instance_variable_get(:@incoming_queue_cv)
+
+      cv.wait(mutex) if queue.empty?
+      queue.shift
+    end
+  end
+
+  def take
+    @outgoing_port.take
+  end
+
+  def self.yield(obj)
+    Thread.current.instance_variable_get(:@backtor).instance_variable_get(:@outgoing_port).put(obj)
+  end
+
+  def inspect
+    "#<Backtor:##{@backtor_id} #{status}>"
+  end
+
+  def self.current
+    if Thread.current == Thread.main
+      Backtor::MAIN
+    elsif !Thread.current.instance_variable_get(:@backtor).nil?
+      Thread.current.instance_variable_get(:@backtor)
+    else
+      raise 'current thread is not main nor a backtor'
+    end
+  end
+
+  def status
+    return "running" if @__backtor_special_main
+    
+    case @thread.status
+    when "run"
+      "running"
+    when false
+      "terminated"
+    else
+      "unimplemented"
+    end
+  end
+
+  attr_reader :name
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification
+name: backtor
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Aaron Christiansen
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2020-09-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby-edge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description:
+email:
+- aaronc20000@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- backtor.gemspec
+- lib/backtor.rb
+homepage: https://github.com/AaronC81/backtor
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/AaronC81/backtor
+  source_code_uri: https://github.com/AaronC81/backtor
+  changelog_uri: https://github.com/AaronC81/backtor/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key:
+specification_version: 4
+summary: Backport of Ractor using threads
+test_files: []