Class: Isolate
- Inherits:
-
Object
- Object
- Isolate
- 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.5.1"
- @@instance =
nil
Instance Attribute Summary collapse
-
#entries ⇒ Object
readonly
:nodoc:.
-
#path ⇒ Object
readonly
:nodoc:.
Class Method Summary collapse
-
.activate(environment) ⇒ Object
Activate (and possibly install) gems for a specific
environment
. -
.gems(path, options = {}, &block) ⇒ Object
Declare an isolated RubyGems environment, installed in
path
. -
.instance ⇒ Object
:nodoc:.
-
.refresh ⇒ Object
Poke RubyGems, we’ve probably monkeyed with a bunch of paths and suchlike.
Instance Method Summary collapse
-
#activate(environment = nil) ⇒ Object
:nodoc:.
- #cleanup ⇒ Object
-
#cleanup? ⇒ Boolean
:nodoc:.
-
#disable ⇒ Object
:nodoc:.
-
#enable ⇒ Object
:nodoc:.
-
#enabled? ⇒ Boolean
:nodoc:.
-
#environment(*environments, &block) ⇒ Object
Restricts
gem
calls insideblock
to a set ofenvironments
. -
#gem(name, *requirements) ⇒ Object
Express a gem dependency.
-
#initialize(path, options = {}, &block) ⇒ Isolate
constructor
Create a new Isolate instance.
-
#install(environment = nil) ⇒ Object
:nodoc:.
-
#install? ⇒ Boolean
:nodoc:.
- #log(s) ⇒ Object
-
#passthrough(&block) ⇒ Object
:nodoc:.
-
#passthrough? ⇒ Boolean
:nodoc:.
-
#verbose? ⇒ Boolean
:nodoc:.
Constructor Details
#initialize(path, options = {}, &block) ⇒ Isolate
Create a new Isolate instance. See Isolate.gems for the public API. Don’t use this constructor directly.
70 71 72 73 74 75 76 77 78 79 80 81 82 |
# File 'lib/isolate.rb', line 70 def initialize path, = {}, &block @enabled = false @entries = [] @environments = [] @passthrough = false @path = path @install = .fetch :install, true @verbose = .fetch :verbose, true @cleanup = @install && .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:
28 29 30 |
# File 'lib/isolate.rb', line 28 def path @path end |
Class Method Details
.activate(environment) ⇒ Object
Activate (and possibly install) gems for a specific environment
. This allows two-stage isolation, which is necessary for stuff like Rails. See README.rdoc for a detailed example.
34 35 36 37 |
# File 'lib/isolate.rb', line 34 def self.activate environment instance.activate environment instance.cleanup if instance.cleanup? end |
.gems(path, options = {}, &block) ⇒ Object
Declare an isolated RubyGems environment, installed in path
. The block given will be instance_eval
ed, see Isolate#gem and Isolate#environment for the sort of stuff you can do.
Option defaults:
{ :cleanup => true, :install => true, :verbose => true }
47 48 49 50 |
# File 'lib/isolate.rb', line 47 def self.gems path, = {}, &block @@instance = new path, , &block @@instance.activate end |
.instance ⇒ Object
:nodoc:
54 55 56 |
# File 'lib/isolate.rb', line 54 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.
61 62 63 64 65 |
# File 'lib/isolate.rb', line 61 def self.refresh # :nodoc: Gem.loaded_specs.clear Gem.clear_paths Gem.source_index.refresh! end |
Instance Method Details
#activate(environment = nil) ⇒ Object
:nodoc:
84 85 86 87 88 89 90 91 92 93 94 95 96 |
# File 'lib/isolate.rb', line 84 def activate environment = nil # :nodoc: return self if passthrough? enable unless enabled? env = environment.to_s if environment install environment if install? entries.each do |e| Gem.activate e.name, *e.requirement.as_list if e.matches? env end self end |
#cleanup ⇒ Object
98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 |
# File 'lib/isolate.rb', line 98 def cleanup 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 => self.path).uninstall end end end |
#cleanup? ⇒ Boolean
:nodoc:
124 125 126 |
# File 'lib/isolate.rb', line 124 def cleanup? # :nodoc: @cleanup end |
#disable ⇒ Object
:nodoc:
128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 |
# File 'lib/isolate.rb', line 128 def disable # :nodoc: return self if passthrough? return self unless enabled? ENV["GEM_PATH"] = @old_gem_path ENV["GEM_HOME"] = @old_gem_home ENV["RUBYOPT"] = @old_ruby_opt $LOAD_PATH.replace @old_load_path @enabled = false self.class.refresh self end |
#enable ⇒ Object
:nodoc:
144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 |
# File 'lib/isolate.rb', line 144 def enable # :nodoc: return self if passthrough? || enabled? @old_gem_path = ENV["GEM_PATH"] @old_gem_home = ENV["GEM_HOME"] @old_ruby_opt = ENV["RUBYOPT"] @old_load_path = $LOAD_PATH.dup $LOAD_PATH.reject! { |p| Gem.path.any? { |gp| p.include?(gp) } } # 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 self.class.refresh @enabled = true self end |
#enabled? ⇒ Boolean
:nodoc:
167 168 169 |
# File 'lib/isolate.rb', line 167 def enabled? # :nodoc: @enabled end |
#environment(*environments, &block) ⇒ Object
Restricts gem
calls inside block
to a set of environments
.
173 174 175 176 177 178 179 180 |
# File 'lib/isolate.rb', line 173 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.
186 187 188 189 190 191 192 193 194 195 196 197 198 199 |
# File 'lib/isolate.rb', line 186 def gem name, *requirements = 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, entries << entry entry end |
#install(environment = nil) ⇒ Object
:nodoc:
205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 |
# File 'lib/isolate.rb', line 205 def install environment = nil # :nodoc: return self if passthrough? env = environment.to_s if environment installable = entries.select do |e| !Gem.available?(e.name, *e.requirement.as_list) && e.matches?(env) 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 = e..merge(:install_dir => path, :generate_rdoc => false, :generate_ri => false) source = .delete :source args = .delete :args Gem.sources = Array(source) if source installer = Gem::DependencyInstaller.new 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:
241 242 243 |
# File 'lib/isolate.rb', line 241 def install? # :nodoc: @install end |
#log(s) ⇒ Object
201 202 203 |
# File 'lib/isolate.rb', line 201 def log s $stderr.puts s if verbose? end |
#passthrough(&block) ⇒ Object
:nodoc:
245 246 247 |
# File 'lib/isolate.rb', line 245 def passthrough &block # :nodoc: @passthrough = yield end |
#passthrough? ⇒ Boolean
:nodoc:
249 250 251 |
# File 'lib/isolate.rb', line 249 def passthrough? # :nodoc: @passthrough end |
#verbose? ⇒ Boolean
:nodoc:
253 254 255 |
# File 'lib/isolate.rb', line 253 def verbose? # :nodoc: @verbose end |