gem_isolator 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 09ed7c8a98c30e7514975a626310801132f33458
+  data.tar.gz: ac418d8c8c303f4463a1de38bb3132591c4c08ff
+SHA512:
+  metadata.gz: 1eda65173f7419182d89c00ffe2a3d71004e9d66f8fa6d27c482d11cce5035859d31b721c4e4a419991fc1dd3ad36f3faba0ac17034deaedd631f5db0a8627da
+  data.tar.gz: b3f5df4b52ba9d37910e4ea8f4d5e63693b187b5dc2e35e0dc1babb0ac41c860c1c2aeadd8516a4db3c04cc17ff7f14c75041fa5de2c0e41bdc6bc53f885a414

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Cezary Baginski
+
+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,114 @@
+[![Gem Version](https://badge.fury.io/rb/gem_isolator.png)](http://badge.fury.io/rb/gem_isolator) [![Build Status](https://secure.travis-ci.org/e2/gem_isolator.png?branch=master)](http://travis-ci.org/e2/gem_isolator) 
+
+# GemIsolator
+
+Allows running commands in an isolated set of gems.
+
+Useful for testing gem dependencies in your project and reproducing related bugs.
+
+NOTE: It currently requires Bundler to setup the isolated environment, but
+Bundler isn't necessary to run your Ruby code in isolation.
+
+## Requirements
+
+For supported Ruby versions, check the .travis.yml file.
+
+(For supporting older versions, open an issue - with some info about why you are unable to upgrade).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gem_isolator'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+E.g. in an RSpec test:
+
+```ruby
+cmd = "ruby #{File.expand_path('lib/foo.rb')}"
+GemIsolator.isolate(gems: %w(bar >=3.2.1)) do |env, isolation|
+  expect(isolation.system(env, cmd)).to eq(true)
+end
+```
+
+1. 'lib/foo.rb' is relative to your project's current directory.
+2. `system` acts just like `Kernel.system`.
+3. you can pass custom environment variables, e.g `env.merge('FOO' => '1')`
+4. `:gems` is a list of gems you want installed
+
+## Features
+
+- [x] sets up temp dir with bundled gems
+- [x] allows defining which gems you need installed in the sandbox
+- [x] allows overriding environment
+- [x] allows running commands via Bundler or plain RubyGems
+- [x] allows multiple commands within same sandbox
+- [x] fails if sandbox can't be initialized
+- [ ] seemlessly allows you to run same tests using Docker
+- [ ] smart caching and/or proxy for faster gem installations
+- [ ] allows reusing same sandbox object between tests
+- [ ] release a 1.x as soon as API is useful and comfortable enough
+
+## Things to be careful about
+
+You can run commands in 3 ways:
+
+1. `system('foo')` will search for 'foo' among the binaries of installed isolated gems first
+2. `system('bin/foo')` a binstubbed version of binary from isolated gems (uses Bundler)
+3. `system('bundle exec foo')` uses Bundler instead of RubyGems
+
+Capturing output is not yet supported (open a PR if you're interested).
+
+NOTE: Inside the block, the current directory is set to a temporary directory,
+so it's best to expand your paths outside the block.
+
+NOTE: Variables other than those reset by `Bundler.with_clean_env` are left
+alone, so it's up to you to reset them. (Open an issue if you want to have a
+"clean slate").
+
+NOTE: You might prefer to use caching, by e.g. setting a gem source or proxy.
+Open a feature request if you're interested.
+
+NOTE: `:gems` option is an array (for each gem) of arrays (Gemfile `gem` keyword arguments). `.inspect` is used to stringify, so things should work as expected, even if you use a hash.
+
+
+## Debugging
+
+Just use system() commands to find out what's going on, e.g.:
+
+```ruby
+cmd = "ruby #{File.expand_path('lib/foo.rb')}"
+GemIsolator.isolate(gems: [%w(bar ~>1.2)]) do |env, isolation|
+  # debugging
+  isolation.system("pwd")
+  isolation.system("gem env")
+  isolation.system("gem list")
+  isolation.system("cat Gemfile")
+  isolation.system("cat Gemfile.lock")
+  isolatior.system("ls -l")
+  isolatior.system("find bundle -name 'foo'")
+
+  expect(isolation.system(env, cmd)).to eq(true)
+end
+```
+
+## Development
+
+Run `rake spec` to run the tests.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/gem_isolator.
+
+If there are no other major open pull requests (or active branches), feel free to refactor/reorganize the project as you like.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/gem_isolator.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+require 'gem_isolator/version'
+require 'gem_isolator/isolation'
+
+# Namespace
+module GemIsolator
+  def self.isolate(options, &block)
+    Isolation.new(options, &block)
+  end
+end

data/lib/gem_isolator/isolation.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+# Show warnings about vulnerabilities, bugs and outdated Rubies, since previous
+# versions aren't tested or officially supported.
+require 'ruby_dep/warning'
+RubyDep::Warning.new.show_warnings
+
+require 'gem_isolator/isolation/environment'
+require 'gem_isolator/isolation/sandbox'
+
+module GemIsolator
+  # Main class for setting up sandbox/isolation environment
+  class Isolation
+    def initialize(options)
+      gem_defs = options.fetch(:gems, [[]])
+      within_sandbox do
+        @sandbox = Sandbox.new(gems: gem_defs)
+        sandbox.setup
+        environment = Environment.new(gem_home: sandbox.gem_home).to_hash
+        yield(environment, self)
+      end
+    end
+
+    def system(*args)
+      sandbox.system(*args)
+    end
+
+    private
+
+    attr_reader :sandbox
+
+    def within_sandbox
+      Bundler.with_clean_env do
+        Dir.mktmpdir do |path|
+          Dir.chdir(path) do
+            yield
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gem_isolator/isolation/environment.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+module GemIsolator
+  class Isolation
+    # RubyGems isolating environment
+    class Environment
+      def initialize(options)
+        @gem_home = options.fetch(:gem_home)
+      end
+
+      def to_hash
+        @environment ||= {
+          'GEM_HOME' => gem_home.to_s,
+          'GEM_PATH' => gem_home.to_s,
+          'PATH' => "#{bin_path}:#{ENV['PATH']}"
+        }.freeze
+      end
+
+      private
+
+      attr_reader :gem_home
+
+      def bin_path
+        @bin_path ||= gem_home + 'bin'
+      end
+    end
+  end
+end

data/lib/gem_isolator/isolation/gemfile.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+module GemIsolator
+  class Isolation
+    # Creates a Gemfile
+    class Gemfile
+      def initialize(options)
+        gem_defs = options.fetch(:gems)
+        @content = generate(gem_defs)
+      end
+
+      def create
+        IO.write('Gemfile', @content)
+      end
+
+      private
+
+      def generate(gem_defs)
+        content = "source 'https://rubygems.org';\n"
+        gem_defs.each do |requirements|
+          content += "gem #{requirements.map(&:inspect).join(', ')};\n"
+        end
+        content
+      end
+    end
+  end
+end

data/lib/gem_isolator/isolation/sandbox.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+require 'gem_isolator/isolation/gemfile'
+
+module GemIsolator
+  class Isolation
+    # Class for installing gems into the sandbox in the current directory
+    class Sandbox
+      class Error < RuntimeError
+        class BundlerFailed < Error; end
+      end
+
+      def initialize(options)
+        @gem_defs = options.fetch(:gems)
+      end
+
+      def setup
+        Gemfile.new(gems: @gem_defs).create
+        case Kernel.system(*%w(bundle install --standalone --binstubs))
+        when false
+          raise Error::BundlerFailed, 'sandbox setup with bundler failed'
+        when nil
+          raise Errno::ENOENT, "cannot run command 'bundle'"
+        end
+      end
+
+      def gem_home
+        @gem_home ||= gem_base_path + ruby_dir
+      end
+
+      def system(*args)
+        Kernel.system(*args)
+      end
+
+      private
+
+      def gem_base_path
+        @gem_base_path ||= Pathname.pwd + 'bundle/ruby'
+      end
+
+      def ruby_dir
+        subdirs = gem_base_path.children
+        unknown_dirs = subdirs[1..-1]
+        return subdirs.first if unknown_dirs.empty?
+        raise ArgumentError, "Unknown gem home subdirs: #{unknown_dirs.inspect}"
+      end
+    end
+  end
+end

data/lib/gem_isolator/version.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+module GemIsolator
+  VERSION = '0.2.1'
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: gem_isolator
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- Cezary Baginski
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby_dep
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+description: Good for testing dependencies of a gem and/or different gem version combinations
+email:
+- cezary@chronomantic.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/gem_isolator.rb
+- lib/gem_isolator/isolation.rb
+- lib/gem_isolator/isolation/environment.rb
+- lib/gem_isolator/isolation/gemfile.rb
+- lib/gem_isolator/isolation/sandbox.rb
+- lib/gem_isolator/version.rb
+homepage: https://github.com/e2/gem_isolator
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.2'
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.2.5
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.4
+signing_key: 
+specification_version: 4
+summary: Use an isolated set of gems in your tests
+test_files: []