Class: Isolate::Sandbox

Inherits:
Object
  • Object
show all
Includes:
Events
Defined in:
lib/isolate/sandbox.rb

Overview

An isolated environment. This class exposes lifecycle events for extension, see Isolate::Events for more information.

Constant Summary collapse

DEFAULT_PATH =

:nodoc:

"tmp/isolate"

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Events

#fire, fire, watch, watchers

Constructor Details

#initialize(options = {}, &block) ⇒ Sandbox

Create a new Isolate::Sandbox instance. See Isolate.now! for the most common use of the API. You probably don’t want to use this constructor directly. Fires :initializing and :initialized.

Raises:

  • (ArgumentError) 


39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/isolate/sandbox.rb', line 39

def initialize options = {}, &block
  @enabled      = false
  @entries      = []
  @environments = []
  @files        = []
  @options      = options

  path, name = options.values_at :path, :name

  raise ArgumentError, "can't specify both name and path!" if name && path
  options[:path] = File.expand_path("~/.gem/repos/#{name}") if name

  fire :initializing

  user = File.expand_path "~/.isolate/user.rb"
  load user if File.exist? user

  file, local = nil

  unless FalseClass === options[:file]
    file  = options[:file] || Dir["{Isolate,config/isolate.rb}"].first
    local = "#{file}.local" if file
  end

  load file if file

  if block_given?
    /\@(.+?):\d+/ =~ block.to_s
    files << ($1 || "inline block")
    instance_eval(&block)
  end

  load local if local && File.exist?(local)
  fire :initialized
end

Instance Attribute Details

#entries ⇒ Object (readonly)

:nodoc:



30
31
32
 
# File 'lib/isolate/sandbox.rb', line 30

def entries
  @entries
end

#environments ⇒ Object (readonly)

:nodoc:



31
32
33
 
# File 'lib/isolate/sandbox.rb', line 31

def environments
  @environments
end

#files ⇒ Object (readonly)

:nodoc:



32
33
34
 
# File 'lib/isolate/sandbox.rb', line 32

def files
  @files
end

Instance Method Details

#activate(environment = nil) ⇒ Object

Activate this set of isolated entries, respecting an optional environment. Points RubyGems to a separate repository, messes with paths, auto-installs gems (if necessary), activates everything, and removes any superfluous gem (again, if necessary). If environment isn’t specified, ISOLATE_ENV, RAILS_ENV, and RACK_ENV are checked before falling back to "development". Fires :activating and :activated.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/isolate/sandbox.rb', line 84

def activate environment = nil
  enable unless enabled?
  fire :activating

  env = (environment || Isolate.env).to_s

  install env if install?

  entries.each do |e|
    e.activate if e.matches? env
  end

  cleanup if cleanup?
  fire :activated

  self
end

#cleanup ⇒ Object

:nodoc:



102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/isolate/sandbox.rb', line 102

def cleanup # :nodoc:
  fire :cleaning

  gem_dir = Gem.dir

  global, local = Gem::Specification.partition { |s| s.base_dir != gem_dir }
  legit = legitimize!
  extra = (local - legit) + (local & global)

  self.remove(*extra)

  fire :cleaned
end

#cleanup? ⇒ Boolean

Returns:

  • (Boolean) 


116
117
118
 
# File 'lib/isolate/sandbox.rb', line 116

def cleanup?
  install? and @options.fetch(:cleanup, true)
end

#disable(&block) ⇒ Object 



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/isolate/sandbox.rb', line 120

def disable &block
  return self if not enabled?
  fire :disabling

  ENV.replace @old_env
  $LOAD_PATH.replace @old_load_path

  @enabled = false

  Isolate.refresh
  fire :disabled

  begin; return yield ensure enable end if block_given?

  self
end

#enable ⇒ Object

:nodoc:



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/isolate/sandbox.rb', line 137

def enable # :nodoc:
  return self if enabled?
  fire :enabling

  @old_env       = ENV.to_hash
  @old_load_path = $LOAD_PATH.dup

  path = self.path

  FileUtils.mkdir_p path
  ENV["GEM_HOME"] = path

  unless system?
    isolate_lib = File.expand_path "../..", __FILE__

    # manually deactivate pre-isolate gems...
    $LOAD_PATH.reject! { |lpath|
      (lpath.start_with?("/")  && # only full paths
       lpath.end_with?("/lib") && # and that end in lib
       lpath != isolate_lib    &&
       Gem.path.reject(&:empty?).any? { |gem_path| lpath.include?(gem_path) })
    }

    # HACK: Gotta keep isolate explicitly in the LOAD_PATH in
    # subshells, and the only way I can think of to do that is by
    # abusing RUBYOPT.

    unless ENV["RUBYOPT"] =~ /\s+-I\s*#{Regexp.escape isolate_lib}\b/
      ENV["RUBYOPT"] = "#{ENV['RUBYOPT']} -I#{isolate_lib}"
    end

    ENV["GEM_PATH"] = path
  end

  bin = File.join path, "bin"

  unless ENV["PATH"].split(File::PATH_SEPARATOR).include? bin
    ENV["PATH"] = [bin, ENV["PATH"]].join File::PATH_SEPARATOR
  end

  ENV["ISOLATED"] = path

  if system? then
    Gem.path.unshift path # HACK: this is just wrong!
    Gem.path.uniq!        # HACK: needed for the previous line :(
  end
  Isolate.refresh

  @enabled = true
  fire :enabled

  self
end

#enabled? ⇒ Boolean

Returns:

  • (Boolean) 


191
192
193
 
# File 'lib/isolate/sandbox.rb', line 191

def enabled?
  @enabled
end

#environment(*environments, &block) ⇒ Object Also known as: env

Restricts gem calls inside block to a set of environments.



197
198
199
200
201
202
203
204
 
# File 'lib/isolate/sandbox.rb', line 197

def environment *environments, &block
  old = @environments
  @environments = @environments.dup.concat environments.map { |e| e.to_s }

  instance_eval(&block)
ensure
  @environments = old
end

#gem(name, *requirements) ⇒ Object

Express a gem dependency. Works pretty much like RubyGems’ gem method, but respects environment and doesn’t activate ‘til later.



212
213
214
215
216
217
218
 
# File 'lib/isolate/sandbox.rb', line 212

def gem name, *requirements
  entry = entries.find { |e| e.name == name }
  return entry.update(*requirements) if entry

  entries << entry = Entry.new(self, name, *requirements)
  entry
end

#index ⇒ Object

A source index representing only isolated gems.



222
223
224
 
# File 'lib/isolate/sandbox.rb', line 222

def index
  @index ||= Gem::SourceIndex.from_gems_in File.join(path, "specifications")
end

#install(environment) ⇒ Object

:nodoc:



226
227
228
229
230
231
232
233
234
235
 
# File 'lib/isolate/sandbox.rb', line 226

def install environment # :nodoc:
  fire :installing

  install_missing environment
  rebuild_extensions

  fire :installed

  self
end

#install? ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


276
277
278
 
# File 'lib/isolate/sandbox.rb', line 276

def install? # :nodoc:
  @options.fetch :install, true
end

#install_missing(environment) ⇒ Object 



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/isolate/sandbox.rb', line 237

def install_missing environment
  installable = entries.select do |e|
    !e.specification && e.matches?(environment)
  end

  unless installable.empty?
    padding = Math.log10(installable.size).to_i + 1
    format  = "[%0#{padding}d/%s] Isolating %s (%s)."

    installable.each_with_index do |entry, i|
      log format % [i + 1, installable.size, entry.name, entry.requirement]
      entry.install
    end

    Gem::Specification.reset
  end
end

#load(file) ⇒ Object

:nodoc:



280
281
282
283
 
# File 'lib/isolate/sandbox.rb', line 280

def load file # :nodoc:
  files << file
  instance_eval IO.read(file), file, 1
end

#log(s) ⇒ Object

:nodoc:



285
286
287
 
# File 'lib/isolate/sandbox.rb', line 285

def log s # :nodoc:
  $stderr.puts s if verbose?
end

#multiruby? ⇒ Boolean

Returns:

  • (Boolean) 


289
290
291
 
# File 'lib/isolate/sandbox.rb', line 289

def multiruby?
  @options.fetch :multiruby, false
end

#options(options = nil) ⇒ Object 



293
294
295
296
 
# File 'lib/isolate/sandbox.rb', line 293

def options options = nil
  @options.merge! options if options
  @options
end

#path ⇒ Object 



298
299
300
301
302
303
304
305
306
307
 
# File 'lib/isolate/sandbox.rb', line 298

def path
  base = @options.fetch :path, DEFAULT_PATH

  if multiruby? then
    suffix = "#{Gem.ruby_engine}-#{RbConfig::CONFIG['ruby_version']}"
    base   = File.join(base, suffix) unless base =~ /#{suffix}/
  end

  File.expand_path base
end

#rebuild_extensions ⇒ Object 



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/isolate/sandbox.rb', line 255

def rebuild_extensions
  broken = entries.find_all { |e|
    e.specification && e.specification.missing_extensions?
  }

  unless broken.empty?
    padding = Math.log10(broken.size).to_i + 1
    format  = "[%0#{padding}d/%d] Building extensions for %s (ruby v%s)."

    broken.each_with_index do |e, i|
      spec = e.specification
      log format % [i + 1, broken.size, e.name, RUBY_VERSION]

      builder = Gem::Ext::Builder.new spec
      builder.build_extensions
    end

    Gem::Specification.reset
  end
end

#remove(*extra) ⇒ Object 



309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/isolate/sandbox.rb', line 309

def remove(*extra)
  unless extra.empty?
    padding = Math.log10(extra.size).to_i + 1
    format  = "[%0#{padding}d/%s] Nuking %s."

    extra.each_with_index do |e, i|
      log format % [i + 1, extra.size, e.full_name]

      Gem::DefaultUserInteraction.use_ui Gem::SilentUI.new do
        uninstaller =
          Gem::Uninstaller.new(e.name,
                               :version     => e.version,
                               :ignore      => true,
                               :executables => true,
                               :install_dir => e.base_dir)
        uninstaller.uninstall
      end
    end
  end
end

#system? ⇒ Boolean

Returns:

  • (Boolean) 


330
331
332
 
# File 'lib/isolate/sandbox.rb', line 330

def system?
  @options.fetch :system, true
end

#verbose? ⇒ Boolean

Returns:

  • (Boolean) 


334
335
336
 
# File 'lib/isolate/sandbox.rb', line 334

def verbose?
  @options.fetch :verbose, true
end