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.



28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/isolate/sandbox.rb', line 28

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

  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:



19
20
21
 
# File 'lib/isolate/sandbox.rb', line 19

def entries
  @entries
end

#environments ⇒ Object (readonly)

:nodoc:



20
21
22
 
# File 'lib/isolate/sandbox.rb', line 20

def environments
  @environments
end

#files ⇒ Object (readonly)

:nodoc:



21
22
23
 
# File 'lib/isolate/sandbox.rb', line 21

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.



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/isolate/sandbox.rb', line 68

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:



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

def cleanup # :nodoc:
  fire :cleaning

  installed = Gem::Specification.map.to_a
  legit     = legitimize!
  extra     = installed - legit

  gem_dir = Gem.dir
  extra.reject! { |s| s.base_dir != gem_dir }

  self.remove(*extra)

  fire :cleaned
end

#cleanup? ⇒ Boolean

Returns:

  • (Boolean) 


101
102
103
 
# File 'lib/isolate/sandbox.rb', line 101

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

#disable(&block) ⇒ Object 



105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/isolate/sandbox.rb', line 105

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:



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
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
 
# File 'lib/isolate/sandbox.rb', line 122

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... is this just for 1.9.1?
    $LOAD_PATH.reject! do |p|
      p != isolate_lib && Gem.path.any? { |gp| p.include?(gp) }
    end

    # 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) 


173
174
175
 
# File 'lib/isolate/sandbox.rb', line 173

def enabled?
  @enabled
end

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

Restricts gem calls inside block to a set of environments.



179
180
181
182
183
184
185
186
 
# File 'lib/isolate/sandbox.rb', line 179

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.



194
195
196
197
198
199
200
 
# File 'lib/isolate/sandbox.rb', line 194

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.



204
205
206
 
# File 'lib/isolate/sandbox.rb', line 204

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

#install(environment) ⇒ Object

:nodoc:



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/isolate/sandbox.rb', line 208

def install environment # :nodoc:
  fire :installing

  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

  fire :installed

  self
end

#install? ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


232
233
234
 
# File 'lib/isolate/sandbox.rb', line 232

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

#load(file) ⇒ Object

:nodoc:



236
237
238
239
 
# File 'lib/isolate/sandbox.rb', line 236

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

#log(s) ⇒ Object

:nodoc:



241
242
243
 
# File 'lib/isolate/sandbox.rb', line 241

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

#multiruby? ⇒ Boolean

Returns:

  • (Boolean) 


245
246
247
 
# File 'lib/isolate/sandbox.rb', line 245

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

#options(options = nil) ⇒ Object 



249
250
251
252
 
# File 'lib/isolate/sandbox.rb', line 249

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

#path ⇒ Object 



254
255
256
257
258
259
260
261
262
263
 
# File 'lib/isolate/sandbox.rb', line 254

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

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

  File.expand_path base
end

#remove(*extra) ⇒ Object 



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/isolate/sandbox.rb', line 265

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) 


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

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

#verbose? ⇒ Boolean

Returns:

  • (Boolean) 


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

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