Class: Bundler::Installer

Inherits:
Environment show all
Defined in:
lib/bundler/installer.rb

Class Attribute Summary collapse

Attributes inherited from Environment

#root

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Environment

#current_dependencies, #dependencies, #initialize, #inspect, #lock, #requested_specs, #specs, #update

Constructor Details

This class inherits a constructor from Bundler::Environment

Class Attribute Details

.ambiguous_gems ⇒ Object

Returns the value of attribute ambiguous_gems.



12
13
14
 
# File 'lib/bundler/installer.rb', line 12

def ambiguous_gems
  @ambiguous_gems
end

.post_install_messages ⇒ Object

Returns the value of attribute post_install_messages.



12
13
14
 
# File 'lib/bundler/installer.rb', line 12

def post_install_messages
  @post_install_messages
end

Class Method Details

.install(root, definition, options = {}) ⇒ Object

Begins the installation process for Bundler. For more information see the #run method on this class.



20
21
22
23
24
 
# File 'lib/bundler/installer.rb', line 20

def self.install(root, definition, options = {})
  installer = new(root, definition)
  installer.run(options)
  installer
end

Instance Method Details

#generate_bundler_executable_stubs(spec, options = {}) ⇒ Object 



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
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
123
124
125
126
127
128
 
# File 'lib/bundler/installer.rb', line 77

def generate_bundler_executable_stubs(spec, options = {})
  if options[:binstubs_cmd] && spec.executables.empty?
    options = {}
    spec.runtime_dependencies.each do |dep|
      bins = @definition.specs[dep].first.executables
      options[dep.name] = bins unless bins.empty?
    end
    if options.any?
      Bundler.ui.warn "#{spec.name} has no executables, but you may want " \
        "one from a gem it depends on."
      options.each {|name, bins| Bundler.ui.warn "  #{name} has: #{bins.join(", ")}" }
    else
      Bundler.ui.warn "There are no executables for the gem #{spec.name}."
    end
    return
  end

  # double-assignment to avoid warnings about variables that will be used by ERB
  bin_path = bin_path = Bundler.bin_path
  template = template = File.read(File.expand_path("../templates/Executable", __FILE__))
  relative_gemfile_path = relative_gemfile_path = Bundler.default_gemfile.relative_path_from(bin_path)
  ruby_command = ruby_command = Thor::Util.ruby_command

  exists = []
  spec.executables.each do |executable|
    next if executable == "bundle"

    binstub_path = "#{bin_path}/#{executable}"
    if File.exist?(binstub_path) && !options[:force]
      exists << executable
      next
    end

    File.open(binstub_path, "w", 0777 & ~File.umask) do |f|
      f.puts ERB.new(template, nil, "-").result(binding)
    end
  end

  if options[:binstubs_cmd] && exists.any?
    case exists.size
    when 1
      Bundler.ui.warn "Skipped #{exists[0]} since it already exists."
    when 2
      Bundler.ui.warn "Skipped #{exists.join(" and ")} since they already exist."
    else
      items = exists[0...-1].empty? ? nil : exists[0...-1].join(", ")
      skipped = [items, exists[-1]].compact.join(" and ")
      Bundler.ui.warn "Skipped #{skipped} since they already exist."
    end
    Bundler.ui.warn "If you want to overwrite skipped stubs, use --force."
  end
end

#generate_standalone_bundler_executable_stubs(spec) ⇒ Object 



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/bundler/installer.rb', line 130

def generate_standalone_bundler_executable_stubs(spec)
  # double-assignment to avoid warnings about variables that will be used by ERB
  bin_path = Bundler.bin_path
  standalone_path = standalone_path = Bundler.root.join(Bundler.settings[:path]).relative_path_from(bin_path)
  template = File.read(File.expand_path("../templates/Executable.standalone", __FILE__))
  ruby_command = ruby_command = Thor::Util.ruby_command

  spec.executables.each do |executable|
    next if executable == "bundle"
    executable_path = executable_path = Pathname(spec.full_gem_path).join(spec.bindir, executable).relative_path_from(bin_path)
    File.open "#{bin_path}/#{executable}", "w", 0755 do |f|
      f.puts ERB.new(template, nil, "-").result(binding)
    end
  end
end

#run(options) ⇒ Object

Runs the install procedures for a specific Gemfile.

Firstly, this method will check to see if Bundler.bundle_path exists and if not then will create it. This is usually the location of gems on the system, be it RVM or at a system path.

Secondly, it checks if Bundler has been configured to be “frozen” Frozen ensures that the Gemfile and the Gemfile.lock file are matching. This stops a situation where a developer may update the Gemfile but may not run ‘bundle install`, which leads to the Gemfile.lock file not being correctly updated. If this file is not correctly updated then any other developer running `bundle install` will potentially not install the correct gems.

Thirdly, Bundler checks if there are any dependencies specified in the Gemfile using Bundler::Environment#dependencies. If there are no dependencies specified then Bundler returns a warning message stating so and this method returns.

Fourthly, Bundler checks if the default lockfile (Gemfile.lock) exists, and if so then proceeds to set up a defintion based on the default gemfile (Gemfile) and the default lock file (Gemfile.lock). However, this is not the case if the platform is different to that which is specified in Gemfile.lock, or if there are any missing specs for the gems.

Fifthly, Bundler resolves the dependencies either through a cache of gems or by remote. This then leads into the gems being installed, along with stubs for their executables, but only if the –binstubs option has been passed or Bundler.options has been set earlier.

Sixthly, a new Gemfile.lock is created from the installed gems to ensure that the next time that a user runs ‘bundle install` they will receive any updates from this process.

Finally: TODO add documentation for how the standalone process works.



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/bundler/installer.rb', line 57

def run(options)
  create_bundle_path

  if Bundler.settings[:frozen]
    @definition.ensure_equivalent_gemfile_and_lockfile(options[:deployment])
  end

  if dependencies.empty?
    Bundler.ui.warn "The Gemfile specifies no dependencies"
    lock
    return
  end

  resolve_if_need(options)
  install(options)

  lock unless Bundler.settings[:frozen]
  Standalone.new(options[:standalone], @definition).generate if options[:standalone]
end