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.8.2"
- @@instance =
nil
Instance Attribute Summary collapse
-
#entries ⇒ Object
readonly
:nodoc:.
-
#path ⇒ Object
readonly
:nodoc:.
Class Method Summary collapse
-
.env ⇒ Object
:nodoc:.
-
.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
Activate this set of isolated entries, respecting an optional
environment
. -
#cleanup ⇒ Object
:nodoc:.
-
#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) ⇒ Object
:nodoc:.
-
#install? ⇒ Boolean
:nodoc:.
-
#log(s) ⇒ Object
:nodoc:.
-
#verbose? ⇒ Boolean
:nodoc:.
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.
64 65 66 67 68 69 70 71 72 73 74 75 |
# File 'lib/isolate.rb', line 64 def initialize path, = {}, &block @enabled = false @entries = [] @environments = [] @path = File. 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:
27 28 29 |
# File 'lib/isolate.rb', line 27 def path @path end |
Class Method Details
.env ⇒ Object
:nodoc:
29 30 31 |
# File 'lib/isolate.rb', line 29 def self.env # :nodoc: ENV["ISOLATE_ENV"] || ENV["RAILS_ENV"] || ENV["RACK_ENV"] || "development" 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 }
41 42 43 44 |
# File 'lib/isolate.rb', line 41 def self.gems path, = {}, &block @@instance = new path, , &block @@instance.activate end |
.instance ⇒ Object
:nodoc:
48 49 50 |
# File 'lib/isolate.rb', line 48 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.
55 56 57 58 59 |
# File 'lib/isolate.rb', line 55 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"
.
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 |
# File 'lib/isolate.rb', line 85 def activate environment = nil enable unless enabled? env = (environment || self.class.env).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:
101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 |
# File 'lib/isolate.rb', line 101 def cleanup # :nodoc: 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 } } return if 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 Gem::Uninstaller.new(e.name, :version => e.version, :ignore => true, :executables => true, :install_dir => path).uninstall end end end |
#cleanup? ⇒ Boolean
:nodoc:
126 127 128 |
# File 'lib/isolate.rb', line 126 def cleanup? # :nodoc: @cleanup end |
#disable ⇒ Object
:nodoc:
130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 |
# File 'lib/isolate.rb', line 130 def disable # :nodoc: return self if 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:
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 |
# File 'lib/isolate.rb', line 147 def enable # :nodoc: return self if 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:
178 179 180 |
# File 'lib/isolate.rb', line 178 def enabled? # :nodoc: @enabled end |
#environment(*environments, &block) ⇒ Object
Restricts gem
calls inside block
to a set of environments
.
184 185 186 187 188 189 190 191 |
# File 'lib/isolate.rb', line 184 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.
197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 |
# File 'lib/isolate.rb', line 197 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) ⇒ Object
:nodoc:
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 240 241 242 243 244 245 |
# File 'lib/isolate.rb', line 213 def install environment # :nodoc: installable = entries.select do |e| !Gem.available?(e.name, *e.requirement.as_list) && e.matches?(environment) end return self if installable.empty? padding = Math.log10(installable.size).to_i + 1 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 = Array(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:
247 248 249 |
# File 'lib/isolate.rb', line 247 def install? # :nodoc: @install end |
#log(s) ⇒ Object
:nodoc:
251 252 253 |
# File 'lib/isolate.rb', line 251 def log s # :nodoc: $stderr.puts s if verbose? end |
#verbose? ⇒ Boolean
:nodoc:
255 256 257 |
# File 'lib/isolate.rb', line 255 def verbose? # :nodoc: @verbose end |