Class: Bundler::Dsl

Inherits:
Object
  • Object
show all
Includes:
RubyDsl
Defined in:
lib/bundler/dsl.rb

Direct Known Subclasses

Plugin::DSL

Defined Under Namespace

Classes: DSLError

Constant Summary collapse

VALID_PLATFORMS = 
Bundler::Dependency::PLATFORM_MAP.keys.freeze
VALID_KEYS = 
%w[group groups git path glob name branch ref tag require submodules
platform platforms type source install_if gemfile force_ruby_platform].freeze
GITHUB_PULL_REQUEST_URL = 
%r{\Ahttps://github\.com/([A-Za-z0-9_\-\.]+/[A-Za-z0-9_\-\.]+)/pull/(\d+)\z}
GITLAB_MERGE_REQUEST_URL = 
%r{\Ahttps://gitlab\.com/([A-Za-z0-9_\-\./]+)/-/merge_requests/(\d+)\z}

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from RubyDsl

#normalize_ruby_file, #ruby

Constructor Details

#initialize ⇒ Dsl

Returns a new instance of Dsl.



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/bundler/dsl.rb', line 27

def initialize
  @source               = nil
  @sources              = SourceList.new
  @git_sources          = {}
  @dependencies         = []
  @groups               = []
  @install_conditionals = []
  @optional_groups      = []
  @platforms            = []
  @env                  = nil
  @ruby_version         = nil
  @gemspecs             = []
  @gemfile              = nil
  @gemfiles             = []
  add_git_sources
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(name, *args) ⇒ Object

Raises:



293
294
295
 
# File 'lib/bundler/dsl.rb', line 293

def method_missing(name, *args)
  raise GemfileError, "Undefined local variable or method `#{name}' for Gemfile"
end

Instance Attribute Details

#dependencies ⇒ Object

Returns the value of attribute dependencies.



25
26
27
 
# File 'lib/bundler/dsl.rb', line 25

def dependencies
  @dependencies
end

#gemfile ⇒ Object (readonly)

Returns the value of attribute gemfile.



24
25
26
 
# File 'lib/bundler/dsl.rb', line 24

def gemfile
  @gemfile
end

#gemspecs ⇒ Object (readonly)

Returns the value of attribute gemspecs.



24
25
26
 
# File 'lib/bundler/dsl.rb', line 24

def gemspecs
  @gemspecs
end

Class Method Details

.evaluate(gemfile, lockfile, unlock) ⇒ Object 



10
11
12
13
14
 
# File 'lib/bundler/dsl.rb', line 10

def self.evaluate(gemfile, lockfile, unlock)
  builder = new
  builder.eval_gemfile(gemfile)
  builder.to_definition(lockfile, unlock)
end

Instance Method Details

#check_primary_source_safety ⇒ Object 



297
298
299
300
 
# File 'lib/bundler/dsl.rb', line 297

def check_primary_source_safety
  check_path_source_safety
  check_rubygems_source_safety
end

#env(name) ⇒ Object 



281
282
283
284
285
286
287
 
# File 'lib/bundler/dsl.rb', line 281

def env(name)
  old = @env
  @env = name
  yield
ensure
  @env = old
end

#eval_gemfile(gemfile, contents = nil) ⇒ Object 



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/bundler/dsl.rb', line 44

def eval_gemfile(gemfile, contents = nil)
  with_gemfile(gemfile) do |current_gemfile|
    contents ||= Bundler.read_file(current_gemfile)
    instance_eval(contents, current_gemfile, 1)
  rescue GemfileEvalError => e
    message = "There was an error evaluating `#{File.basename current_gemfile}`: #{e.message}"
    raise DSLError.new(message, current_gemfile, e.backtrace, contents)
  rescue GemfileError, InvalidArgumentError, InvalidOption, DeprecatedError, ScriptError => e
    message = "There was an error parsing `#{File.basename current_gemfile}`: #{e.message}"
    raise DSLError.new(message, current_gemfile, e.backtrace, contents)
  rescue StandardError => e
    raise unless e.backtrace_locations.first.path == current_gemfile
    message = "There was an error parsing `#{File.basename current_gemfile}`: #{e.message}"
    raise DSLError.new(message, current_gemfile, e.backtrace, contents)
  end
end

#gem(name, *args) ⇒ Object 



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
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/bundler/dsl.rb', line 95

def gem(name, *args)
  options = args.last.is_a?(Hash) ? args.pop.dup : {}
  options["gemfile"] = @gemfile
  version = args || [">= 0"]

  normalize_options(name, version, options)

  dep = Dependency.new(name, version, options)

  # if there's already a dependency with this name we try to prefer one
  if current = @dependencies.find {|d| d.name == dep.name }
    if current.requirement != dep.requirement
      current_requirement_open = current.requirements_list.include?(">= 0")

      gemspec_dep = [dep, current].find(&:gemspec_dev_dep?)
      if gemspec_dep
        gemfile_dep = [dep, current].find(&:runtime?)

        if gemfile_dep && !current_requirement_open
          Bundler.ui.warn "A gemspec development dependency (#{gemspec_dep.name}, #{gemspec_dep.requirement}) is being overridden by a Gemfile dependency (#{gemfile_dep.name}, #{gemfile_dep.requirement}).\n" \
                          "This behaviour may change in the future. Please remove either of them, or make sure they both have the same requirement\n"
        elsif gemfile_dep.nil?
          require_relative "vendor/pub_grub/lib/pub_grub/version_range"
          require_relative "vendor/pub_grub/lib/pub_grub/version_constraint"
          require_relative "vendor/pub_grub/lib/pub_grub/version_union"
          require_relative "vendor/pub_grub/lib/pub_grub/rubygems"

          current_gemspec_range = PubGrub::RubyGems.requirement_to_range(current.requirement)
          next_gemspec_range = PubGrub::RubyGems.requirement_to_range(dep.requirement)

          if current_gemspec_range.intersects?(next_gemspec_range)
            dep = Dependency.new(name, current.requirement.as_list + dep.requirement.as_list, options)
          else
            raise GemfileError, "Two gemspecs have conflicting requirements on the same gem: #{dep} and #{current}"
          end
        end
      else
        update_prompt = ""

        if File.basename(@gemfile) == Injector::INJECTED_GEMS
          if dep.requirements_list.include?(">= 0") && !current_requirement_open
            update_prompt = ". Gem already added"
          else
            update_prompt = ". If you want to update the gem version, run `bundle update #{current.name}`"

            update_prompt += ". You may also need to change the version requirement specified in the Gemfile if it's too restrictive." unless current_requirement_open
          end
        end

        raise GemfileError, "You cannot specify the same gem twice with different version requirements.\n" \
                       "You specified: #{current.name} (#{current.requirement}) and #{dep.name} (#{dep.requirement})" \
                       "#{update_prompt}"
      end
    end

    unless current.gemspec_dev_dep? && dep.gemspec_dev_dep?
      # Always prefer the dependency from the Gemfile
      if current.gemspec_dev_dep?
        @dependencies.delete(current)
      elsif dep.gemspec_dev_dep?
        return
      elsif current.source != dep.source
        raise GemfileError, "You cannot specify the same gem twice coming from different sources.\n" \
                        "You specified that #{dep.name} (#{dep.requirement}) should come from " \
                        "#{current.source || "an unspecified source"} and #{dep.source}\n"
      else
        Bundler.ui.warn "Your Gemfile lists the gem #{current.name} (#{current.requirement}) more than once.\n" \
                        "You should probably keep only one of them.\n" \
                        "Remove any duplicate entries and specify the gem only once.\n" \
                        "While it's not a problem now, it could cause errors if you change the version of one of them later."
      end
    end
  end

  @dependencies << dep
end

#gemspec(opts = nil) ⇒ Object 



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/bundler/dsl.rb', line 61

def gemspec(opts = nil)
  opts ||= {}
  path              = opts[:path] || "."
  glob              = opts[:glob]
  name              = opts[:name]
  development_group = opts[:development_group] || :development
  expanded_path     = gemfile_root.join(path)

  gemspecs = Gem::Util.glob_files_in_dir("{,*}.gemspec", expanded_path).map {|g| Bundler.load_gemspec(g) }.compact
  gemspecs.reject! {|s| s.name != name } if name
  specs_by_name_and_version = gemspecs.group_by {|s| [s.name, s.version] }

  case specs_by_name_and_version.size
  when 1
    specs = specs_by_name_and_version.values.first
    spec = specs.find {|s| s.match_platform(Bundler.local_platform) } || specs.first

    @gemspecs << spec

    gem spec.name, name: spec.name, path: path, glob: glob

    group(development_group) do
      spec.development_dependencies.each do |dep|
        gem dep.name, *(dep.requirement.as_list + [type: :development])
      end
    end
  when 0
    raise InvalidOption, "There are no gemspecs at #{expanded_path}"
  else
    raise InvalidOption, "There are multiple gemspecs at #{expanded_path}. " \
      "Please use the :name option to specify which one should be used"
  end
end

#git(uri, options = {}, &blk) ⇒ Object 



222
223
224
225
226
227
228
229
230
231
232
233
234
235
 
# File 'lib/bundler/dsl.rb', line 222

def git(uri, options = {}, &blk)
  unless block_given?
    msg = "You can no longer specify a git source by itself. Instead, \n" \
          "either use the :git option on a gem, or specify the gems that \n" \
          "bundler should find in the git source by passing a block to \n" \
          "the git method, like: \n\n" \
          "  git 'git://github.com/rails/rails.git' do\n" \
          "    gem 'rails'\n" \
          "  end"
    raise DeprecatedError, msg
  end

  with_source(@sources.add_git_source(normalize_hash(options).merge("uri" => uri)), &blk)
end

#git_source(name, &block) ⇒ Object 



196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/bundler/dsl.rb', line 196

def git_source(name, &block)
  unless block_given?
    raise InvalidOption, "You need to pass a block to #git_source"
  end

  if valid_keys.include?(name.to_s)
    raise InvalidOption, "You cannot use #{name} as a git source. It " \
      "is a reserved key. Reserved keys are: #{valid_keys.join(", ")}"
  end

  @git_sources[name.to_s] = block
end

#github(repo, options = {}) ⇒ Object

Raises:



237
238
239
240
241
242
243
 
# File 'lib/bundler/dsl.rb', line 237

def github(repo, options = {})
  raise InvalidArgumentError, "GitHub sources require a block" unless block_given?
  github_uri  = @git_sources["github"].call(repo)
  git_options = normalize_hash(options).merge("uri" => github_uri)
  git_source  = @sources.add_git_source(git_options)
  with_source(git_source) { yield }
end

#group(*args, &blk) ⇒ Object 



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/bundler/dsl.rb', line 250

def group(*args, &blk)
  options = args.last.is_a?(Hash) ? args.pop.dup : {}
  normalize_group_options(options, args)

  @groups.concat args

  if options["optional"]
    optional_groups = args - @optional_groups
    @optional_groups.concat optional_groups
  end

  yield
ensure
  args.each { @groups.pop }
end

#install_if(*args) ⇒ Object 



266
267
268
269
270
271
 
# File 'lib/bundler/dsl.rb', line 266

def install_if(*args)
  @install_conditionals.concat args
  yield
ensure
  args.each { @install_conditionals.pop }
end

#path(path, options = {}, &blk) ⇒ Object 



209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/bundler/dsl.rb', line 209

def path(path, options = {}, &blk)
  source_options = normalize_hash(options).merge(
    "path" => Pathname.new(path),
    "root_path" => gemfile_root,
    "gemspec" => gemspecs.find {|g| g.name == options["name"] }
  )

  source_options["global"] = true unless block_given?

  source = @sources.add_path_source(source_options)
  with_source(source, &blk)
end

#platforms(*platforms) ⇒ Object Also known as: platform 



273
274
275
276
277
278
 
# File 'lib/bundler/dsl.rb', line 273

def platforms(*platforms)
  @platforms.concat platforms
  yield
ensure
  platforms.each { @platforms.pop }
end

#plugin(*args) ⇒ Object 



289
290
291
 
# File 'lib/bundler/dsl.rb', line 289

def plugin(*args)
  # Pass on
end

#source(source, *args, &blk) ⇒ Object 



172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/bundler/dsl.rb', line 172

def source(source, *args, &blk)
  options = args.last.is_a?(Hash) ? args.pop.dup : {}
  options = normalize_hash(options)
  source = normalize_source(source)

  if options.key?("type")
    options["type"] = options["type"].to_s
    unless Plugin.source?(options["type"])
      raise InvalidOption, "No plugin sources available for #{options["type"]}"
    end

    unless block_given?
      raise InvalidOption, "You need to pass a block to #source with :type option"
    end

    source_opts = options.merge("uri" => source)
    with_source(@sources.add_plugin_source(options["type"], source_opts), &blk)
  elsif block_given?
    with_source(@sources.add_rubygems_source("remotes" => source), &blk)
  else
    @sources.add_global_rubygems_remote(source)
  end
end

#to_definition(lockfile, unlock) ⇒ Object 



245
246
247
248
 
# File 'lib/bundler/dsl.rb', line 245

def to_definition(lockfile, unlock)
  check_primary_source_safety
  Definition.new(lockfile, @dependencies, @sources, unlock, @ruby_version, @optional_groups, @gemfiles)
end