multi_ruby_runner 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 292bf31accd916a0752d0ec0092c16b409141735
+  data.tar.gz: b79c7dccb5560b865beb18e8ca516d421aaee77d
+SHA512:
+  metadata.gz: d69b5cc1d575c513b435320672eb52a07d0caec396f536593b9ac9187dc83cea08580596e5b277b4996ad884628d8b7d272d7d8845f5a92cd992c21f686ec177
+  data.tar.gz: 27e0a0134144d19c3018cf3e11f61d39ad8df788d55e738369281c42d034a7eaeb1df5932704cc56f3e0e47770599762823fe51a7f5182bd90ee18a04ef4ce94

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.ruby-gemset
+.ruby-version
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+
+script: "bundle exec rake test"
+
+rvm:
+  - 2.3.0

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 1.0.0
+
+Initial release

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in multi_ruby_runner.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Jo Hund
+
+MIT License
+
+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,122 @@
+# Multi Ruby Runner
+
+This gem lets you call Ruby code in one Ruby environment from Ruby code in another environment.
+
+It makes use of Ruby version managers to switch the Ruby runtime environment. Typically you will write a ruby script that executes the code you want and call that script via MultiRubyRunner in the desired Ruby runtime environment.
+
+Examples:
+
+* Call JRuby code from MRI 2.3.0
+* Call MRI 1.9.3 code from MRI 2.2.1
+
+## Requirements
+
+### Operating system
+
+* Linux: Not tested, but should work.
+* OS X: Tested and works.
+* Windows: I don’t think it works, and I have no plans of supporting this scenario.
+
+### Ruby version manager
+
+* rbenv: Works
+* RVM: Works
+* None: You really should use a Ruby version manager :-)
+
+### Ruby versions
+
+Caller: The Ruby code that invokes other ruby code.
+Callee: The Ruby code being invoked.
+
+* MRI: Works for caller and callee.
+* JRuby: Works for callee. May not work for caller as we use `fork` in a non-blocking use case.
+* Rubinius: Not tested, however it should work.
+
+### Bundler
+
+We have Bundler baked into the Gem via `Bundler.with_clean_env`. This is not necessary for overall functionality. I assume you’re using Bundler.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'multi_ruby_runner'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install multi_ruby_runner
+
+## Usage
+
+### Blocking (without fork)
+
+If you want to execute a Ruby script and wait for its result via output to STDOUT, use this snippet:
+
+    mrr = MultiRubyRunner.new
+    stdout = mrr.execute_command_in_directory(
+      "./bin/ruby-script-to-execute argument1 argument2",
+      "/path/to/folder/that/sets/ruby/env"
+    )
+
+Note that we’re passing `argument1` and `argument2` as positional arguments to the callee Ruby script.
+
+### Non blocking (with fork)
+
+If you just want to start a process and return back to the caller right away, you can set the `:fork` option to true. In that case you will get the child process’ PID as return value. This is useful if you want to start a service and communicate with it e.g., via `Sockets`.
+
+    mrr = MultiRubyRunner.new
+    child_pid = mrr.execute_command_in_directory(
+      "./bin/ruby-script-to-execute argument1 argument2",
+      "/path/to/folder/that/sets/ruby/env"
+    )
+
+You can communicate with the child process via pipes or sockets.
+
+### Ruby scripts to call
+
+Here is an example Ruby script that can be called via MultiRubyRunner:
+
+    #!/usr/bin/env ruby
+    
+    # This is an example callee script for MultiRubyRunner
+    
+    require_relative '../lib/path/to/your/ruby/code'
+    
+    # Check for arguments
+    arg1 = ARGV[0]
+    arg2 = ARGV[1]
+    
+    # Puts will return some text to STDOUT
+    puts "The current time is #{ Time.now }"
+
+Please note that even if you use JRuby, you keep `ruby` in the shebang. Your Ruby version manager will make sure that the code will be executed by JRuby.
+
+## Additional resources
+
+I found Jesse Storimer’s books `Working With Unix Processes` and `Working With TCP Sockets` very helpful.
+
+## Contributing
+
+1. Fork it ( https://github.com/jhund/multi_ruby_runner/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+### Resources
+
+* [Source code (github)](https://github.com/jhund/multi_ruby_runner)
+* [Issues](https://github.com/jhund/multi_ruby_runner/issues)
+* [Rubygems.org](http://rubygems.org/gems/multi_ruby_runner)
+
+### License
+
+[MIT licensed](https://github.com/jhund/multi_ruby_runner/blob/master/LICENSE.txt).
+
+### Copyright
+
+Copyright (c) 2016 Jo Hund. See [(MIT) LICENSE](https://github.com/jhund/multi_ruby_runner/blob/master/LICENSE.txt) for details.

data/Rakefile

@@ -0,0 +1,14 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+Rake::TestTask.new do |test|
+  test.libs << 'spec'
+  test.pattern = 'spec/**/*_spec.rb'
+  test.verbose = true
+end

data/doc/meta.md

@@ -0,0 +1,19 @@
+# Gem meta info
+
+## Release a new version
+
+* Make and commit code changes.
+* Update `CHANGELOG.md`.
+* Update the gem version in `lib/multi_ruby_runner/version.rb`.
+* Commit version bump and changelog with message ‘Bumped version to x.y.z’.
+* Run `rake release`. This will perform the following steps:
+    * Build a gem package to e.g. pkg/multi_ruby_runner-1.0.1.gem.
+    * Push the `.gem` package to `Rubygems.org`
+    * Add and push a tag like “v1.0.1” to git.
+    * Push commits to the git remote.
+
+## Run tests
+
+    rake test
+
+Also every push to github will trigger a test run at travis CI.

data/lib/multi_ruby_runner/version.rb

@@ -0,0 +1,3 @@
+class MultiRubyRunner
+  VERSION = "1.0.0"
+end

data/lib/multi_ruby_runner/version_manager/none.rb

@@ -0,0 +1,10 @@
+class MultiRubyRunner
+  class VersionManager
+
+    # Represents a ruby environment without a version manager.
+    # In this case MultiRubyRunner won't work and will raise errors instead.
+    class None < VersionManager
+    end
+
+  end
+end

data/lib/multi_ruby_runner/version_manager/rbenv.rb

@@ -0,0 +1,37 @@
+class MultiRubyRunner
+  class VersionManager
+
+    # Represents the [rbenv](https://github.com/rbenv/rbenv) ruby version manager.
+    class Rbenv < VersionManager
+
+      # Returns the string to be executed in shell to activate self in a shell.
+      # @return [String]
+      def activation_string
+        %(eval "$(rbenv init -)")
+      end
+
+      # This is what `rbenv init -` returns:
+
+      # export PATH="/home/deploy/.rbenv/shims:${PATH}"
+      # export RBENV_SHELL=bash
+      # source '/home/deploy/.rbenv/libexec/../completions/rbenv.bash'
+      # command rbenv rehash 2>/dev/null
+      # rbenv() {
+      #   local command
+      #   command="$1"
+      #   if [ "$#" -gt 0 ]; then
+      #     shift
+      #   fi
+
+      #   case "$command" in
+      #   rehash|shell)
+      #     eval "$(rbenv "sh-$command" "$@")";;
+      #   *)
+      #     command rbenv "$command" "$@";;
+      #   esac
+      # }
+
+    end
+
+  end
+end

data/lib/multi_ruby_runner/version_manager/rvm.rb

@@ -0,0 +1,28 @@
+class MultiRubyRunner
+  class VersionManager
+
+    # Represents the [rvm](https://rvm.io/) ruby version manager.
+    class Rvm < VersionManager
+
+      # Returns the string to be executed in shell to activate self in a shell.
+      # @return [String]
+      def activation_string
+        # Given the @ruby_executable_path, we can compute the rvm script path
+        # that needs to be sourced:
+        # /Users/uname/.rvm/rubies/ruby-2.2.3/bin/ruby
+        #            ~/.rvm/scripts/rvm
+        script_path = @ruby_executable_path.match(
+          /^.+(#{ Regexp.escape("/.rvm/") })(?=rubies)/
+        )[0]
+        if script_path.nil?
+          raise RuntimeError.new("Could not detect rvm script path! (#{ @ruby_executable_path.inspect }")
+        end
+        script_path << 'scripts/rvm'
+        # Rvm requires sourcing of script_path:
+        "source #{ script_path }"
+      end
+
+    end
+
+  end
+end

data/lib/multi_ruby_runner/version_manager.rb

@@ -0,0 +1,31 @@
+class MultiRubyRunner
+
+  # Abstract class for ruby version managers like rbenv and rvm (or none)
+  class VersionManager
+
+    # Detects if and which ruby version manager is present.
+    def self.detect
+      which_ruby = `which ruby`
+      case which_ruby
+      when /\/\.rbenv\//
+        Rbenv.new(which_ruby)
+      when /\/\.rvm\//
+        Rvm.new(which_ruby)
+      else
+        None.new(which_ruby)
+      end
+    end
+
+    # Instantiates a new VersionManager.
+    # @param ruby_path [String] path to ruby executable, as returned by `which ruby`
+    def initialize(ruby_executable_path)
+      @ruby_executable_path = ruby_executable_path
+    end
+
+    def activation_string
+      raise "Implement #activation_string in subclasses!"
+    end
+
+  end
+
+end

data/lib/multi_ruby_runner.rb

@@ -0,0 +1,63 @@
+# -*- coding: utf-8 -*-
+
+require "multi_ruby_runner/version"
+require 'multi_ruby_runner'
+require 'multi_ruby_runner/version_manager'
+require 'multi_ruby_runner/version_manager/none'
+require 'multi_ruby_runner/version_manager/rbenv'
+require 'multi_ruby_runner/version_manager/rvm'
+
+# Allows calling of Ruby code in various Ruby environments.
+class MultiRubyRunner
+
+  def initialize
+  end
+
+  # Executes a blocking command in a directory.
+  # Command will be executed in the ruby environment specified in .ruby-version
+  # file in the directory.
+  # Example command:
+  # `/bin/bash -c 'source /Users/johund/.rvm/scripts/rvm; cd /Users/johund/development/vgr-table-export; ruby -v'`
+  # @param command_string [String] the command to run in directory
+  # @param directory [String] the dir containing the ".ruby-version" file and the ruby project to run
+  # @param options [Hash, optional]
+  # @option options [String, optional] shell_invocation what shell to use, defaults to bash
+  # @option options [Boolean, optional] blocking, defaults to true.
+  # @return [String] STDOUT output
+  def execute_command_in_directory(command_string, directory, options = {})
+    shell_path = ENV['SHELL'] || '/bin/bash'
+    options = {
+      blocking: true,
+      shell_invocation: "#{ shell_path } -c",
+    }.merge(options)
+    shell_command_string = [
+      ruby_version_manager.activation_string, # e.g., "source ~/.rvm/scripts/rvm"
+      "cd #{ directory }",
+      command_string
+    ].join('; ')
+    entire_command = "#{ options[:shell_invocation] } '#{ shell_command_string }'"
+
+    # Bundler.with_clean_env avoids spilling over of any bundler environment
+    # e.g., BUNDLE_BIN_PATH, BUNDLE_GEMFILE, and RUBYOPT
+    if options[:blocking]
+      # Wait for command to complete
+      Bundler.with_clean_env do
+        `#{ entire_command }`
+      end
+    else
+      # Fork new process, execute command there and return immediately to caller.
+      fork do
+        Bundler.with_clean_env do
+          `#{ entire_command }`
+        end
+      end
+    end
+  end
+
+  # Returns the ruby version manager used
+  # @return [MultiRubyRunner::VersionManager] 'rbenv', 'rvm', 'none'
+  def ruby_version_manager
+    VersionManager.detect
+  end
+
+end

data/multi_ruby_runner.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'multi_ruby_runner/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "multi_ruby_runner"
+  spec.version       = MultiRubyRunner::VERSION
+  spec.authors       = ["Jo Hund"]
+  spec.email         = ["jhund@clearcove.ca"]
+  spec.summary       = %q{Execute Ruby code in different Ruby environments.}
+  spec.description   = %q{This gem lets you for example call JRuby code from MRI. It relies on rbenv or RVM to manage the Ruby runtime environment.}
+  spec.homepage      = "https://github.com/jhund/multi_ruby_runner"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+end

data/spec/multi_ruby_runner/version_manager_spec.rb

@@ -0,0 +1,13 @@
+# -*- coding: utf-8 -*-
+
+require_relative '../spec_helper'
+
+class MultiRubyRunner
+  describe VersionManager do
+
+    it "responds to .detect" do
+      VersionManager.respond_to?(:detect).must_equal(true)
+    end
+
+  end
+end

data/spec/multi_ruby_runner_spec.rb

@@ -0,0 +1,17 @@
+# -*- coding: utf-8 -*-
+
+require_relative './spec_helper'
+
+describe MultiRubyRunner do
+
+  it "responds to #execute_command_in_directory" do
+    mrr = MultiRubyRunner.new
+    mrr.respond_to?(:execute_command_in_directory).must_equal(true)
+  end
+
+  it "responds to #ruby_version_manager" do
+    mrr = MultiRubyRunner.new
+    mrr.respond_to?(:ruby_version_manager).must_equal(true)
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+# -*- coding: utf-8 -*-
+
+require 'bundler/setup'
+require 'minitest/autorun'
+require 'multi_ruby_runner'

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: multi_ruby_runner
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jo Hund
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem lets you for example call JRuby code from MRI. It relies on
+  rbenv or RVM to manage the Ruby runtime environment.
+email:
+- jhund@clearcove.ca
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- doc/meta.md
+- lib/multi_ruby_runner.rb
+- lib/multi_ruby_runner/version.rb
+- lib/multi_ruby_runner/version_manager.rb
+- lib/multi_ruby_runner/version_manager/none.rb
+- lib/multi_ruby_runner/version_manager/rbenv.rb
+- lib/multi_ruby_runner/version_manager/rvm.rb
+- multi_ruby_runner.gemspec
+- spec/multi_ruby_runner/version_manager_spec.rb
+- spec/multi_ruby_runner_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/jhund/multi_ruby_runner
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Execute Ruby code in different Ruby environments.
+test_files:
+- spec/multi_ruby_runner/version_manager_spec.rb
+- spec/multi_ruby_runner_spec.rb
+- spec/spec_helper.rb