RubyProcess 0.0.12

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b0fa90bc235a48025533ac9be8417e8146dc8d14
+  data.tar.gz: 6b78bd08325c51d2e1a2e39f182da09a2ff76c2c
+SHA512:
+  metadata.gz: ca7b71117f7a38b2e9d41339ea28f775dc0ed2bf719a89600226e36e310807d569544720faa9f10873755355bba5d129a6c52bea334773b06c99441cd004a69a
+  data.tar.gz: 24b443cb94c1865e4b651a9bc9f7cebfd925c9b0cbb10b6c4c11f6dffa2e7af50854d147f83bf41b7a4ffe16fe1503ad52a319ceae3cf285bbba9df202bbc196

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,19 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+gem "wref"
+gem "tsafe"
+gem "string-cases"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "rspec", "~> 2.8.0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", ">= 1.0.0"
+  gem "jeweler", "~> 1.8.3"
+end
+
+gem "codeclimate-test-reporter", group: :test, require: nil

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Kasper Johansen
+
+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,98 @@
+# RubyProcess
+
+Start another Ruby process and manipulate it almost seamlessly.
+
+## Example
+
+The CSV lib will not be loaded in the main process and the writing of the file will also take place in another process.
+
+```ruby
+require "rubygems"
+require "ruby_process"
+
+RubyProcess.new.spawn_process do |rp|
+  rp.static(:Object, :require, "csv")
+
+  rp.static(:CSV, :open, "test.csv", "w") do |csv|
+    csv << ["ID", "Name"]
+    csv << [1, "Kasper"]
+  end
+end
+```
+
+
+## Install
+
+Add to your Gemfile and bundle.
+
+```ruby
+gem "ruby_process"
+```
+
+## Usage
+
+With a block.
+
+```ruby
+RubyProcess.new.spawn_process do |rp|
+  rp.static(:File, :open, "some_file", "w") do |fp|
+    fp.write("Test!")
+  end
+end
+```
+
+Almost seamless mode with ClassProxy.
+
+```ruby
+RubyProcess::ClassProxy.run do |data|
+  sp = data[:subproc]
+  sp.static(:Object, :require, "tempfile")
+  
+  # Tempfile will be created in the subprocess and not in the current process.
+  temp_file = RubyProcess::ClassProxy::Tempfile("temp")
+end
+```
+
+As a variable.
+
+```ruby
+rp = RubyProcess.new(debug: false)
+rp.spawn_process
+test_string = rp.new(:String, "Test")
+```
+
+Calling static methods on classes.
+
+```ruby
+rp.static(:File, :open, "file_path", "w")
+```
+
+Spawning new objects.
+
+```ruby
+file = rp.new(:File, "file_path", "r")
+```
+
+Serializing objects back to the main process.
+
+```ruby
+rp.static(:File, :size, "file_path") #=> RubyProcess::ProxyObject
+rp.static(:File, :size, "file_path").__rp_marshall #=> 2048
+```
+
+
+## Contributing to RubyProcess
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2012 Kasper Johansen. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,49 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "RubyProcess"
+  gem.homepage = "http://github.com/kaspernj/ruby_process"
+  gem.license = "MIT"
+  gem.summary = %Q{A framework for spawning and communicating with other Ruby-processes}
+  gem.description = %Q{A framework for spawning and communicating with other Ruby-processes}
+  gem.email = "k@spernj.org"
+  gem.authors = ["Kasper Johansen"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task default: :spec
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "RubyProcess #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.12

data/cmds/blocks.rb

@@ -0,0 +1,68 @@
+class RubyProcess
+  #Calls a block by its block-ID with given arguments.
+  def cmd_block_call(obj)
+    raise "Invalid block-ID: '#{obj}'." if obj[:block_id].to_i <= 0
+    block_ele = @proxy_objs[obj[:block_id]]
+    raise "No block by that ID: '#{obj[:block_id]}'." if !block_ele
+    raise "Not a block? '#{block_ele.class.name}'." if !block_ele.respond_to?(:call)
+    debug "Calling block #{obj[:block_id]}: #{obj}\n" if @debug
+
+    answer_id = obj[:answer_id]
+    raise "No ':answer_id' was given (#{obj})." if !answer_id
+
+    if answer = @answers[answer_id]
+      #Use a queue to sleep thread until the block has been executed.
+      queue = Queue.new
+      answer.push(type: :proxy_block_call, block: block_ele, args: read_args(obj[:args]), queue: queue)
+      res = queue.pop
+      raise "Expected true but didnt get that: '#{res}'." if res != true
+    else
+      block_ele.call(*read_args(obj[:args]))
+    end
+
+    return nil
+  end
+
+  #Spawns a block and returns its ID.
+  def cmd_spawn_proxy_block(obj)
+    block = proc{
+      send(cmd: :block_call, block_id: obj[:id], answer_id: obj[:answer_id])
+    }
+
+    id = block.__id__
+    raise "ID already exists: '#{id}'." if @objects.key?(id)
+    @objects[id] = block
+
+    return {id: id}
+  end
+
+  #Dynamically creates a block with a certain arity. If sub-methods measure arity, they will get the correct one from the other process.
+  def block_with_arity(args, &block)
+    eval_str = "proc{"
+    eval_argsarr = "\t\tblock.call("
+
+    if args[:arity] > 0
+      eval_str << "|"
+      1.upto(args[:arity]) do |i|
+        if i > 1
+          eval_str << ","
+          eval_argsarr << ","
+        end
+
+        eval_str << "arg#{i}"
+        eval_argsarr << "arg#{i}"
+      end
+
+      eval_str << "|\n"
+      eval_argsarr << ")\n"
+    end
+
+    eval_full = eval_str + eval_argsarr
+    eval_full << "}"
+
+    debug "Block eval: #{eval_full}\n" if @debug
+    dynamic_proc = eval(eval_full)
+
+    return dynamic_proc
+  end
+end

data/cmds/marshal.rb

@@ -0,0 +1,8 @@
+class RubyProcess
+  #This command returns an object as a marshalled string, so it can be re-created on the other side.
+  def cmd_obj_marshal(obj)
+    myobj = @objects[obj[:id]]
+    raise "Object by that ID does not exist: '#{obj[:id]}'." if !myobj
+    return Marshal.dump(myobj)
+  end
+end

data/cmds/new.rb

@@ -0,0 +1,44 @@
+class RubyProcess
+  #Spawns a new object in the process and returns a proxy-object for it.
+  def new(classname, *args, &block)
+    return send(cmd: :new, classname: classname, args: parse_args(args), &block)
+  end
+
+  #This command spawns a new object of a given class and returns its hash-handle, so a proxy-object can be spawned on the other side.
+  def cmd_new(obj)
+    const = obj[:classname].to_s.split("::").inject(Object, :const_get)
+
+    debug "New-args-before: #{obj[:args]}\n" if @debug
+    real_args = read_args(obj[:args])
+    debug "New-args-after: #{real_args}\n" if @debug
+
+    retobj = const.new(*real_args)
+    return handle_return_object(retobj)
+  end
+
+  #Calls a method on an object.
+  def cmd_obj_method(obj)
+    myobj = @objects[obj[:id]]
+    raise "Object by that ID does not exist: '#{obj[:id]}' '(#{@objects.keys.sort.join(",")})." if !myobj
+
+    if obj.key?(:block)
+      real_block = proc{|*args|
+        debug "Block called! #{args}\n" if @debug
+        send(cmd: :block_call, block_id: obj[:block][:id], answer_id: obj[:send_id], args: handle_return_args(args))
+      }
+
+      block = block_with_arity(arity: obj[:block][:arity], &real_block)
+      debug "Spawned fake block with arity: #{block.arity}\n" if @debug
+    else
+      block = nil
+    end
+
+    debug "Obj-method-args-before: #{obj[:args]}\n" if @debug
+    real_args = read_args(obj[:args])
+    debug "Obj-methods-args-after: #{real_args}\n" if @debug
+
+    debug "Calling #{myobj.class.name}.#{obj[:method]}(*#{obj[:args]}, &#{block})\n" if @debug
+    res = myobj.__send__(obj[:method], *real_args, &block)
+    return handle_return_object(res)
+  end
+end

data/cmds/numeric.rb

@@ -0,0 +1,14 @@
+class RubyProcess
+  #Returns a numeric value like a integer. This methods exists because it isnt possible to do: "Integer.new(5)".
+  #===Examples
+  # proxy_int = rp.numeric(5)
+  # proxy_int.__rp_marshal #=> 5
+  def numeric(val)
+    return send(cmd: :numeric, val: val)
+  end
+
+  #Process-method for the 'numeric'-method.
+  def cmd_numeric(obj)
+    return handle_return_object(obj[:val].to_i)
+  end
+end

data/cmds/static.rb

@@ -0,0 +1,36 @@
+class RubyProcess
+  #Calls a static method on the process-side.
+  #===Examples
+  # rp.static(:File, :open, "/tmp/somefile", "w") do |fp|
+  #   fp.write("Test")
+  # end
+  def static(classname, method, *args, &block)
+    debug "Args-before: #{args} (#{@my_pid})\n" if @debug
+    real_args = parse_args(args)
+    debug "Real-args: #{real_args}\n" if @debug
+
+    return send(cmd: :static, classname: classname, method: method, args: real_args, &block)
+  end
+
+  #Process-method for the 'static'-method.
+  def cmd_static(obj)
+    if obj.key?(:block)
+      real_block = proc{|*args|
+        debug "Block called! #{args}\n" if @debug
+        send(cmd: :block_call, block_id: obj[:block][:id], answer_id: obj[:send_id], args: handle_return_args(args))
+      }
+
+      block = block_with_arity(arity: obj[:block][:arity], &real_block)
+    else
+      block = nil
+    end
+
+    debug "Static-args-before: #{obj[:args]}\n" if @debug
+    real_args = read_args(obj[:args])
+    debug "Static-args-after: #{real_args}\n" if @debug
+
+    const = obj[:classname].to_s.split("::").inject(Object, :const_get)
+    retobj = const.__send__(obj[:method], *real_args, &block)
+    return handle_return_object(retobj)
+  end
+end

data/cmds/str_eval.rb

@@ -0,0 +1,16 @@
+class RubyProcess
+  #Evalulates the given string in the process.
+  #===Examples
+  # rp.str_eval("return 10").__rp_marshal #=> 10
+  def str_eval(str)
+    send(cmd: :str_eval, str: str)
+  end
+
+  #Process-method for 'str_eval'.
+  def cmd_str_eval(obj)
+    #Lamda is used here because 'return' might be used in evalled code and thereby return an unhandeled object.
+    return handle_return_object(lambda{
+      eval(obj[:str])
+    }.call)
+  end
+end

data/cmds/system.rb

@@ -0,0 +1,47 @@
+class RubyProcess
+  #Closes the process by executing exit.
+  def cmd_exit(obj)
+    exit
+  end
+
+  #Flushes various collected object-IDs to the subprocess, where they will be garbage-collected.
+  def flush_finalized
+    @flush_mutex.synchronize do
+      debug "Ruby-process-debug: Checking finalized\n" if @debug
+      ids = @proxy_objs_unsets.shift(500)
+      debug "IDS: #{ids} #{@proxy_objs_unsets}\n" if @debug
+      return nil if ids.empty?
+
+      debug "Ruby-process-debug: Finalizing (#{ids}).\n" if @debug
+      send(cmd: :flush_finalized, ids: ids)
+      @finalize_count += ids.length
+      return nil
+    end
+  end
+
+  #Flushes references to the given object IDs.
+  def cmd_flush_finalized(obj)
+    debug "Command-flushing finalized: '#{obj[:ids]}'.\n" if @debug
+    obj[:ids].each do |id|
+      raise "Unknown ID: '#{id}' (#{id.class.name})." unless @objects.key?(id)
+      @objects.delete(id)
+    end
+
+    return nil
+  end
+
+  #Starts garbage-collecting and then flushes the finalized objects to the sub-process. Does the same thing in the sub-process.
+  def garbage_collect
+    GC.start
+    self.flush_finalized
+    send(cmd: :garbage_collect)
+    return nil
+  end
+
+  #The sub-process-side execution of 'garbage_collect'.
+  def cmd_garbage_collect(obj)
+    GC.start
+    self.flush_finalized
+    return nil
+  end
+end