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].freeze
GITHUB_PULL_REQUEST_URL = 
%r{\Ahttps://github\.com/([A-Za-z0-9_\-\.]+/[A-Za-z0-9_\-\.]+)/pull/(\d+)\z}.freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from RubyDsl

#ruby

Constructor Details

#initialize ⇒ Dsl

Returns a new instance of Dsl.



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

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:



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

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.



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

def dependencies
  @dependencies
end

#gemspecs ⇒ Object (readonly)

Returns the value of attribute gemspecs.



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

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 



271
272
273
274
 
# File 'lib/bundler/dsl.rb', line 271

def check_primary_source_safety
  check_path_source_safety
  check_rubygems_source_safety
end

#env(name) ⇒ Object 



255
256
257
258
259
260
261
 
# File 'lib/bundler/dsl.rb', line 255

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

#eval_gemfile(gemfile, contents = nil) ⇒ Object 



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

def eval_gemfile(gemfile, contents = nil)
  expanded_gemfile_path = Pathname.new(gemfile).expand_path(@gemfile && @gemfile.parent)
  original_gemfile = @gemfile
  @gemfile = expanded_gemfile_path
  @gemfiles << expanded_gemfile_path
  contents ||= Bundler.read_file(@gemfile.to_s)
  instance_eval(contents.dup.tap {|x| x.untaint if RUBY_VERSION < "2.7" }, gemfile.to_s, 1)
rescue Exception => e # rubocop:disable Lint/RescueException
  message = "There was an error " \
    "#{e.is_a?(GemfileEvalError) ? "evaluating" : "parsing"} " \
    "`#{File.basename gemfile.to_s}`: #{e.message}"

  raise DSLError.new(message, gemfile, e.backtrace, contents)
ensure
  @gemfile = original_gemfile
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
 
# 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 }
    deleted_dep = @dependencies.delete(current) if current.type == :development

    unless deleted_dep
      if current.requirement != dep.requirement
        return if dep.type == :development

        update_prompt = ""

        if File.basename(@gemfile) == Injector::INJECTED_GEMS
          if dep.requirements_list.include?(">= 0") && !current.requirements_list.include?(">= 0")
            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.requirements_list.include?(">= 0")
          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}"
      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

      if current.source != dep.source
        return if dep.type == :development
        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"
      end
    end
  end

  @dependencies << dep
end

#gemspec(opts = nil) ⇒ Object 



60
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 60

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
  Index.sort_specs(gemspecs)
  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 



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

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 



170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/bundler/dsl.rb', line 170

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:

  • (ArgumentError) 


211
212
213
214
215
216
217
 
# File 'lib/bundler/dsl.rb', line 211

def github(repo, options = {})
  raise ArgumentError, "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 



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

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 



240
241
242
243
244
245
 
# File 'lib/bundler/dsl.rb', line 240

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

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



183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/bundler/dsl.rb', line 183

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 



247
248
249
250
251
252
 
# File 'lib/bundler/dsl.rb', line 247

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

#plugin(*args) ⇒ Object 



263
264
265
 
# File 'lib/bundler/dsl.rb', line 263

def plugin(*args)
  # Pass on
end

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



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/bundler/dsl.rb', line 146

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 



219
220
221
222
 
# File 'lib/bundler/dsl.rb', line 219

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