multi_ruby_runner 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 292bf31accd916a0752d0ec0092c16b409141735
-  data.tar.gz: b79c7dccb5560b865beb18e8ca516d421aaee77d
+  metadata.gz: 5c7ae88ea7e74814b50a117afb6f0e9d59989544
+  data.tar.gz: 3fbde0fa5cf8d984166f428a33ceb95b2de2355e
 SHA512:
-  metadata.gz: d69b5cc1d575c513b435320672eb52a07d0caec396f536593b9ac9187dc83cea08580596e5b277b4996ad884628d8b7d272d7d8845f5a92cd992c21f686ec177
-  data.tar.gz: 27e0a0134144d19c3018cf3e11f61d39ad8df788d55e738369281c42d034a7eaeb1df5932704cc56f3e0e47770599762823fe51a7f5182bd90ee18a04ef4ce94
+  metadata.gz: f0557fcf48a607f2d3fca67e9ae7faa659d0e0495c20cd18825849b5328a875f74967b1662515032c3156d33fc18c983f8f6ab5d1150eab1e23989b975442623
+  data.tar.gz: 84d428a261c85b818ca34e46b71e72081a70a767ee6a325d8ce5ed0b7626edd32fb2b8875753eb8a488ad9f64ee919f03984219ed3264a7ba85bde8821d5ef3f

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+### 1.0.1
+
+* Added rbenv support
+* Improved process spawning
+
 # 1.0.0
 
 Initial release

data/lib/multi_ruby_runner/version.rb

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

data/lib/multi_ruby_runner/version_manager/rbenv.rb

@@ -4,33 +4,34 @@ class MultiRubyRunner
     # 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 -)")
+      # See MultiRubyRunner#execute_command_in_directory
+      # @return [Hash]
+      #     {
+      #       entire_command: includes shell invocation,
+      #                       ruby version manager activation and command
+      #       blocking: Boolean
+      #       environment_overrides: {}
+      #     }
+      def compute_process_args(command_string, directory, options)
+        shell_command_string = [
+          "cd #{ directory }", # cd into the directory containing .ruby-version file
+          command_string, # execute command
+        ].join('; ')
+        # For rbenv we just have to reset RBENV_VERSION and override RBENV_DIR
+        # to get the ruby environment specified in `.ruby-version` in directory.
+        {
+          entire_command: [
+            options[:shell_invocation],
+            shell_command_string,
+          ].join(' '),
+          blocking: options[:blocking],
+          environment_overrides: {
+            'RBENV_VERSION' => nil,
+            'RBENV_DIR' => directory,
+          },
+        }
       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

data/lib/multi_ruby_runner/version_manager/rvm.rb

@@ -4,13 +4,41 @@ class MultiRubyRunner
     # 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.
+      # See MultiRubyRunner#execute_command_in_directory
+      # @return [Hash]
+      #     {
+      #       entire_command: includes shell invocation,
+      #                       ruby version manager activation and command
+      #       blocking: Boolean
+      #       environment_overrides: {}
+      #     }
+      def compute_process_args(command_string, directory, options)
+        {
+          entire_command: [
+            options[:shell_invocation],
+            %('#{ shell_command_string(command_string, directory) }')
+          ].join(' '),
+          blocking: options[:blocking],
+          environment_overrides: {},
+        }
+      end
+
+      # Returns the command string to be passed to the shell
+      def shell_command_string(command_string, directory)
+        [
+          activation_string, # activate rvm
+          "cd #{ directory }", # cd into the directory containing .ruby-version file
+          command_string, # execute command
+        ].join('; ')
+      end
+
+      # Returns the string to be executed in shell to activate rvm 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
+        # /Users/username/.rvm/rubies/ruby-2.2.3/bin/ruby
+        #               ~/.rvm/scripts/rvm
         script_path = @ruby_executable_path.match(
           /^.+(#{ Regexp.escape("/.rvm/") })(?=rubies)/
         )[0]

data/lib/multi_ruby_runner/version_manager.rb

@@ -22,8 +22,8 @@ class MultiRubyRunner
       @ruby_executable_path = ruby_executable_path
     end
 
-    def activation_string
-      raise "Implement #activation_string in subclasses!"
+    def compute_process_args(command_string, directory, options)
+      raise "Implement #compute_process_args in subclasses!"
     end
 
   end

data/lib/multi_ruby_runner.rb

@@ -1,7 +1,6 @@
 # -*- 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'
@@ -13,45 +12,29 @@ 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
+  # Executes a command in a directory. Command will be executed in the
+  # ruby environment specified in `.ruby-version` file in `directory`.
+  # Returns stdout in the blocking form and pid of child process in the
+  # non-blocking form.
+  #
+  # @param command_string [String] the shell command to run in directory
+  # @param directory [String] the dir containing the ".ruby-version" file
   # @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
+  # @return [String, Integer, Nil] STDOUT output when blocking, pid when non-blocking.
   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
+    process_args = ruby_version_manager.compute_process_args(
+      command_string,
+      directory,
+      options
+    )
+    execute_command(process_args)
   end
 
   # Returns the ruby version manager used
@@ -60,4 +43,52 @@ class MultiRubyRunner
     VersionManager.detect
   end
 
+protected
+
+  # @param process_args [Hash]
+  #     {
+  #       entire_command: includes shell invocation,
+  #                       ruby version manager activation and command
+  #       blocking: Boolean
+  #       environment_overrides: {}
+  #     }
+  def execute_command(process_args)
+    if process_args[:blocking]
+      # Wait for command to complete
+      execute_blocking_command(process_args)
+    else
+      # Spawn new process, execute command there and return immediately to caller.
+      execute_non_blocking_command(process_args)
+    end
+  end
+
+  def execute_blocking_command(process_args)
+    stdout_str = stderr_str = status = nil
+    Bundler.with_clean_env do
+      stdout_str, stderr_str, status = Open3.capture3(
+        process_args[:environment_overrides],
+        process_args[:entire_command]
+      )
+    end
+    if 0 == status
+      # return stdout
+      stdout_str
+    else
+      # Raise exception
+      raise "Command failed with status #{ status.inspect }. stderr: #{ stderr_str }"
+    end
+  end
+
+  def execute_non_blocking_command(process_args)
+    pid = nil
+    Bundler.with_clean_env do
+      pid = Process.spawn(
+        process_args[:environment_overrides],
+        process_args[:entire_command]
+      )
+    end
+    Process.detach(pid) # Avoid zombie process
+    pid # return spawned process' pid
+  end
+
 end

data/multi_ruby_runner.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   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.description   = %q{Execute Ruby code in different Ruby environments. 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"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: multi_ruby_runner
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Jo Hund
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-16 00:00:00.000000000 Z
+date: 2016-03-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,8 +52,9 @@ dependencies:
     - - ">="
       - !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.
+description: Execute Ruby code in different Ruby environments. 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: []