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

VALID_PLATFORMS =
Bundler::Dependency::PLATFORM_MAP.keys.freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from RubyDsl

#ruby

Constructor Details

#initializeDsl

Returns a new instance of Dsl



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
# File 'lib/bundler/dsl.rb', line 20

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

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(name, *args) ⇒ Object

Raises:



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

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

Instance Attribute Details

#dependenciesObject

Returns the value of attribute dependencies



18
19
20
# File 'lib/bundler/dsl.rb', line 18

def dependencies
  @dependencies
end

#gemspecsObject (readonly)

Returns the value of attribute gemspecs



17
18
19
# File 'lib/bundler/dsl.rb', line 17

def gemspecs
  @gemspecs
end

Class Method Details

.evaluate(gemfile, lockfile, unlock) ⇒ Object



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

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

Instance Method Details

#env(name) ⇒ Object



234
235
236
237
238
239
240
# File 'lib/bundler/dsl.rb', line 234

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

#eval_gemfile(gemfile, contents = nil) ⇒ Object



36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
# File 'lib/bundler/dsl.rb', line 36

def eval_gemfile(gemfile, contents = nil)
  expanded_gemfile_path = Pathname.new(gemfile).expand_path
  original_gemfile = @gemfile
  @gemfile = expanded_gemfile_path
  contents ||= Bundler.read_file(gemfile.to_s)
  instance_eval(contents.dup.untaint, gemfile.to_s, 1)
rescue Exception => e
  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



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

def gem(name, *args)
  options = args.last.is_a?(Hash) ? args.pop.dup : {}
  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
      if current.type == :development
        @dependencies.delete current
      else
        return if dep.type == :development
        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})"
      end

    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" \
                      "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
      if current.type == :development
        @dependencies.delete current
      else
        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



52
53
54
55
56
57
58
59
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
# File 'lib/bundler/dsl.rb', line 52

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 = Dir[File.join(expanded_path, "{,*}.gemspec")].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(Gem::Platform.local) } || specs.first

    @gemspecs << spec

    gem_platforms = Bundler::Dependency::REVERSE_PLATFORM_MAP[Bundler::GemHelpers.generic_local_platform]
    gem spec.name, :name => spec.name, :path => path, :glob => glob, :platforms => gem_platforms

    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



176
177
178
179
180
181
182
183
184
185
186
187
188
189
# File 'lib/bundler/dsl.rb', line 176

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



153
154
155
156
157
158
159
160
161
162
163
164
# File 'lib/bundler/dsl.rb', line 153

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)


191
192
193
194
195
196
197
# File 'lib/bundler/dsl.rb', line 191

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



203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
# File 'lib/bundler/dsl.rb', line 203

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

  @groups.concat args

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

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

#install_if(*args, &blk) ⇒ Object



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

def install_if(*args, &blk)
  @install_conditionals.concat args
  blk.call
ensure
  args.each { @install_conditionals.pop }
end

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



166
167
168
169
170
171
172
173
174
# File 'lib/bundler/dsl.rb', line 166

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 = @sources.add_path_source(source_options)
  with_source(source, &blk)
end

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



226
227
228
229
230
231
# File 'lib/bundler/dsl.rb', line 226

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

#plugin(*args) ⇒ Object



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

def plugin(*args)
  # Pass on
end

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



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
# File 'lib/bundler/dsl.rb', line 128

def source(source, *args, &blk)
  options = args.last.is_a?(Hash) ? args.pop.dup : {}
  options = normalize_hash(options)
  if options.key?("type")
    options["type"] = options["type"].to_s
    unless Plugin.source?(options["type"])
      raise "No 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?
    source = normalize_source(source)
    with_source(@sources.add_rubygems_source("remotes" => source), &blk)
  else
    source = normalize_source(source)
    check_primary_source_safety(@sources)
    @sources.add_rubygems_remote(source)
  end
end

#to_definition(lockfile, unlock) ⇒ Object



199
200
201
# File 'lib/bundler/dsl.rb', line 199

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