Class: Bundler::Installer

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

Class Attribute Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(root, definition) ⇒ Installer

Returns a new instance of Installer.



28
29
30
31
32
 
# File 'lib/bundler/installer.rb', line 28

def initialize(root, definition)
  @root = root
  @definition = definition
  @post_install_messages = {}
end

Class Attribute Details

.ambiguous_gems ⇒ Object

Returns the value of attribute ambiguous_gems.



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

def ambiguous_gems
  @ambiguous_gems
end

Instance Attribute Details

#definition ⇒ Object (readonly)

Returns the value of attribute definition.



16
17
18
 
# File 'lib/bundler/installer.rb', line 16

def definition
  @definition
end

#post_install_messages ⇒ Object (readonly)

Returns the value of attribute post_install_messages.



16
17
18
 
# File 'lib/bundler/installer.rb', line 16

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
25
26
 
# File 'lib/bundler/installer.rb', line 20

def self.install(root, definition, options = {})
  installer = new(root, definition)
  Plugin.hook(Plugin::Events::GEM_BEFORE_INSTALL_ALL, definition.dependencies)
  installer.run(options)
  Plugin.hook(Plugin::Events::GEM_AFTER_INSTALL_ALL, definition.dependencies)
  installer
end

Instance Method Details

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



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
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
 
# File 'lib/bundler/installer.rb', line 93

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 = Bundler.bin_path
  bin_path = bin_path
  relative_gemfile_path = Bundler.default_gemfile.relative_path_from(bin_path)
  relative_gemfile_path = relative_gemfile_path
  ruby_command = Thor::Util.ruby_command
  ruby_command = ruby_command
  template_path = File.expand_path("templates/Executable", __dir__)
  if spec.name == "bundler"
    template_path += ".bundler"
    spec.executables = %(bundle)
  end
  template = File.read(template_path)

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

    mode = Gem.win_platform? ? "wb:UTF-8" : "w"
    require "erb"
    content = ERB.new(template, trim_mode: "-").result(binding)

    File.write(binstub_path, content, mode: mode, perm: 0o777 & ~File.umask)
    if Gem.win_platform? || options[:all_platforms]
      prefix = "@ruby -x \"%~f0\" %*\n@exit /b %ERRORLEVEL%\n\n"
      File.write("#{binstub_path}.cmd", prefix + content, mode: mode)
    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, options = {}) ⇒ Object 



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/bundler/installer.rb', line 158

def generate_standalone_bundler_executable_stubs(spec, options = {})
  # double-assignment to avoid warnings about variables that will be used by ERB
  bin_path = Bundler.bin_path
  unless path = Bundler.settings[:path]
    raise "Can't standalone without an explicit path set"
  end
  standalone_path = Bundler.root.join(path).relative_path_from(bin_path)
  standalone_path = standalone_path
  template = File.read(File.expand_path("templates/Executable.standalone", __dir__))
  ruby_command = Thor::Util.ruby_command
  ruby_command = ruby_command

  spec.executables.each do |executable|
    next if executable == "bundle"
    executable_path = Pathname(spec.full_gem_path).join(spec.bindir, executable).relative_path_from(bin_path)
    executable_path = executable_path

    mode = Gem.win_platform? ? "wb:UTF-8" : "w"
    require "erb"
    content = ERB.new(template, trim_mode: "-").result(binding)

    File.write("#{bin_path}/#{executable}", content, mode: mode, perm: 0o755)
    if Gem.win_platform? || options[:all_platforms]
      prefix = "@ruby -x \"%~f0\" %*\n@exit /b %ERRORLEVEL%\n\n"
      File.write("#{bin_path}/#{executable}.cmd", prefix + content, mode: mode)
    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 Bundler will create the directory. This is usually the same location as RubyGems which typically is the `~/.gem` directory unless other specified.

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. If there are no dependencies specified then Bundler returns a warning message stating so and this method returns.

Fourthly, Bundler checks if the Gemfile.lock exists, and if so then proceeds to set up a definition based on the Gemfile and the Gemfile.lock. During this step Bundler will also download information about any new gems that are not in the Gemfile.lock and resolve any dependencies if needed.

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, if the user has specified the standalone flag, Bundler will generate the needed require paths and save them in a ‘setup.rb` file. See `bundle standalone –help` for more information.



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/bundler/installer.rb', line 68

def run(options)
  Bundler.create_bundle_path

  ProcessLock.lock do
    @definition.ensure_equivalent_gemfile_and_lockfile(options[:deployment])

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

    if @definition.setup_domain!(options)
      ensure_specs_are_compatible!
      Bundler.load_plugins(@definition)
    end
    install(options)

    Gem::Specification.reset # invalidate gem specification cache so that installed gems are immediately available

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