Class: Isolate

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

Overview

Restricts GEM_PATH and GEM_HOME and provides a DSL for expressing your code’s runtime Gem dependencies. See README.rdoc for rationale, limitations, and examples.

Defined Under Namespace

Classes: Entry

Constant Summary collapse

VERSION =

:nodoc:

"1.7.1"
@@instance = 
nil

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Create a new Isolate instance. See Isolate.gems for the public API. You probably don’t want to use this constructor directly.



67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/isolate.rb', line 67

def initialize path, options = {}, &block
  @enabled      = false
  @entries      = []
  @environments = []
  @passthrough  = false
  @path         = File.expand_path path

  @install      = options.fetch :install, true
  @verbose      = options.fetch :verbose, true
  @cleanup      = @install && options.fetch(:cleanup, true)

  instance_eval(&block) if block_given?
end

Instance Attribute Details

#entries ⇒ Object (readonly)

:nodoc:



26
27
28
 
# File 'lib/isolate.rb', line 26

def entries
  @entries
end

#path ⇒ Object (readonly)

:nodoc:



27
28
29
 
# File 'lib/isolate.rb', line 27

def path
  @path
end

Class Method Details

.activate(environment) ⇒ Object

Deprecated. This is no a no-op, and will be removed shortly.



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

def self.activate environment
  puts "DEPRECATED: Isolate.activate is a no-op now. " +
    "It'll be removed in v1.8. See the README for details."
end

.gems(path, options = {}, &block) ⇒ Object

Declare an isolated RubyGems environment, installed in path. The block given will be instance_evaled, see Isolate#gem and Isolate#environment for the sort of stuff you can do.

Option defaults:

{ :cleanup => true, :install => true, :verbose => true }



44
45
46
47
 
# File 'lib/isolate.rb', line 44

def self.gems path, options = {}, &block
  @@instance = new path, options, &block
  @@instance.activate
end

.instance ⇒ Object

:nodoc:



51
52
53
 
# File 'lib/isolate.rb', line 51

def self.instance # :nodoc:
  @@instance
end

.refresh ⇒ Object

Poke RubyGems, we’ve probably monkeyed with a bunch of paths and suchlike. Clears paths, loaded specs, and source indexes.



58
59
60
61
62
 
# File 'lib/isolate.rb', line 58

def self.refresh # :nodoc:
  Gem.loaded_specs.clear
  Gem.clear_paths
  Gem.source_index.refresh!
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".



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/isolate.rb', line 89

def activate environment = nil
  enable unless enabled?

  env = (environment        ||
         ENV["ISOLATE_ENV"] ||
         ENV["RAILS_ENV"]   ||
         ENV["RACK_ENV"]    ||
         "development").to_s

  install env if install?

  entries.each do |e|
    Gem.activate e.name, *e.requirement.as_list if e.matches? env
  end

  cleanup if cleanup?

  self
end

#cleanup ⇒ Object

:nodoc:



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/isolate.rb', line 109

def cleanup # :nodoc:
  return self if passthrough?

  activated = Gem.loaded_specs.values.map { |s| s.full_name }
  extra     = Gem.source_index.gems.values.sort.reject { |spec|
    activated.include? spec.full_name or
      entries.any? { |e| e.matches_spec? spec }
  }

  log "Cleaning..." unless extra.empty?

  padding = extra.size.to_s.size # omg... heaven forbid you use math
  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
      Gem::Uninstaller.new(e.name,
                           :version     => e.version,
                           :ignore      => true,
                           :executables => true,
                           :install_dir => path).uninstall
    end
  end
end

#cleanup? ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


135
136
137
 
# File 'lib/isolate.rb', line 135

def cleanup? # :nodoc:
  @cleanup
end

#disable ⇒ Object

:nodoc:



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/isolate.rb', line 139

def disable # :nodoc:
  return self if passthrough? or not enabled?

  ENV["GEM_PATH"] = @old_gem_path
  ENV["GEM_HOME"] = @old_gem_home
  ENV["PATH"]     = @old_path
  ENV["RUBYOPT"]  = @old_ruby_opt

  $LOAD_PATH.replace @old_load_path

  @enabled = false

  self.class.refresh

  self
end

#enable ⇒ Object

:nodoc:



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
 
# File 'lib/isolate.rb', line 156

def enable # :nodoc:
  return self if passthrough? or enabled?

  @old_gem_path  = ENV["GEM_PATH"]
  @old_gem_home  = ENV["GEM_HOME"]
  @old_path      = ENV["PATH"]
  @old_ruby_opt  = ENV["RUBYOPT"]
  @old_load_path = $LOAD_PATH.dup

  $LOAD_PATH.reject! do |p|
    p != File.dirname(__FILE__) &&
      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.

  ENV["RUBYOPT"]  = "#{ENV['RUBYOPT']} -I#{File.dirname(__FILE__)}"
  ENV["GEM_PATH"] = ENV["GEM_HOME"] = path

  bin = File.join path, "bin"
  ENV["PATH"] = [bin, ENV["PATH"]].join File::PATH_SEPARATOR

  self.class.refresh

  @enabled = true

  self
end

#enabled? ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


187
188
189
 
# File 'lib/isolate.rb', line 187

def enabled? # :nodoc:
  @enabled
end

#environment(*environments, &block) ⇒ Object

Restricts gem calls inside block to a set of environments.



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

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.



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/isolate.rb', line 206

def gem name, *requirements
  options = Hash === requirements.last ? requirements.pop : {}

  requirement = if requirements.empty? then
                  Gem::Requirement.default
                else
                  Gem::Requirement.new requirements
                end

  entry = Entry.new name, requirement, @environments,  options

  entries << entry

  entry
end

#install(environment) ⇒ Object

:nodoc:



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/isolate.rb', line 222

def install environment # :nodoc:
  return self if passthrough?

  installable = entries.select do |e|
    !Gem.available?(e.name, *e.requirement.as_list) && e.matches?(environment)
  end

  log "Isolating #{environment}..." unless installable.empty?

  padding = installable.size.to_s.size # omg... heaven forbid you use math
  format  = "[%0#{padding}d/%s] Isolating %s (%s)."
  installable.each_with_index do |e, i|
    log format % [i + 1, installable.size, e.name, e.requirement]

    old         = Gem.sources.dup
    options     = e.options.merge(:install_dir   => path,
                                  :generate_rdoc => false,
                                  :generate_ri   => false)
    source      = options.delete :source
    args        = options.delete :args
    Gem.sources = Array(source) if source
    installer   = Gem::DependencyInstaller.new options

    Gem::Command.build_args = args if args
    installer.install e.name, e.requirement

    Gem.sources = old
    Gem::Command.build_args = nil if args
  end

  Gem.source_index.refresh!

  self
end

#install? ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


257
258
259
 
# File 'lib/isolate.rb', line 257

def install? # :nodoc:
  @install
end

#log(s) ⇒ Object

:nodoc:



261
262
263
 
# File 'lib/isolate.rb', line 261

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

#passthrough(&block) ⇒ Object

:nodoc:



265
266
267
 
# File 'lib/isolate.rb', line 265

def passthrough &block # :nodoc:
  @passthrough = yield
end

#passthrough? ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


269
270
271
 
# File 'lib/isolate.rb', line 269

def passthrough? # :nodoc:
  @passthrough
end

#verbose? ⇒ Boolean

:nodoc:

Returns:

  • (Boolean) 


273
274
275
 
# File 'lib/isolate.rb', line 273

def verbose? # :nodoc:
  @verbose
end