Class: Bundler::Dsl

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

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

- (Dsl) initialize



18
19
20
21
22
23
24
25
26
27
28
# File 'lib/bundler/dsl.rb', line 18

def initialize
  @source          = nil
  @sources         = []
  @git_sources     = {}
  @dependencies    = []
  @groups          = []
  @platforms       = []
  @env             = nil
  @ruby_version    = nil
  add_github_sources
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

- (Object) method_missing(name, *args)

Raises:



203
204
205
206
207
# File 'lib/bundler/dsl.rb', line 203

def method_missing(name, *args)
  location = caller[0].split(':')[0..1].join(':')
  raise GemfileError, "Undefined local variable or method `#{name}' for Gemfile\n" \
    "        from #{location}"
end

Instance Attribute Details

- (Object) dependencies

Returns the value of attribute dependencies



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

def dependencies
  @dependencies
end

Class Method Details

+ (Object) evaluate(gemfile, lockfile, unlock)



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

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

Instance Method Details

- (Object) env(name)



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

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

- (Object) eval_gemfile(gemfile, contents = nil)



34
35
36
37
38
39
40
41
42
43
44
45
# File 'lib/bundler/dsl.rb', line 34

def eval_gemfile(gemfile, contents = nil)
  contents ||= Bundler.read_file(gemfile.to_s)
  instance_eval(contents, gemfile.to_s, 1)
rescue SyntaxError => e
  syntax_msg = e.message.gsub("#{gemfile.to_s}:", 'on line ')
  raise GemfileError, "Gemfile syntax error #{syntax_msg}"
rescue ScriptError, RegexpError, NameError, ArgumentError => e
  e.backtrace[0] = "#{e.backtrace[0]}: #{e.message} (#{e.class})"
  Bundler.ui.warn e.backtrace.join("\n       ")
  raise GemfileError, "There was an error in your Gemfile," \
    " and Bundler cannot continue."
end

- (Object) gem(name, *args)



72
73
74
75
76
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
# File 'lib/bundler/dsl.rb', line 72

def gem(name, *args)
  if name.is_a?(Symbol)
    raise GemfileError, %{You need to specify gem names as Strings. Use 'gem "#{name.to_s}"' instead.}
  end

  options = args.last.is_a?(Hash) ? args.pop.dup : {}
  version = args

  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
      elsif dep.type == :development
        return
      else
        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 just one of them later."
    end

    if current.source != dep.source
      if current.type == :development
        @dependencies.delete current
      elsif dep.type == :development
        return
      else
        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

- (Object) gemspec(opts = nil)



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
# File 'lib/bundler/dsl.rb', line 47

def gemspec(opts = nil)
  path              = opts && opts[:path] || '.'
  name              = opts && opts[:name] || '{,*}'
  development_group = opts && opts[:development_group] || :development
  expanded_path     = File.expand_path(path, Bundler.default_gemfile.dirname)

  gemspecs = Dir[File.join(expanded_path, "#{name}.gemspec")]

  case gemspecs.size
  when 1
    spec = Bundler.load_gemspec(gemspecs.first)
    raise InvalidOption, "There was an error loading the gemspec at #{gemspecs.first}." unless spec
    gem spec.name, :path => path
    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."
  end
end

- (Object) git(uri, options = {}, source_options = {}, &blk)



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

def git(uri, options = {}, source_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

  source Source::Git.new(normalize_hash(options).merge("uri" => uri)), source_options, &blk
end

- (Object) git_source(name, &block)



144
145
146
147
148
149
150
151
152
153
154
155
# File 'lib/bundler/dsl.rb', line 144

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

- (Object) group(*args, &blk)



181
182
183
184
185
186
# File 'lib/bundler/dsl.rb', line 181

def group(*args, &blk)
  @groups.concat args
  yield
ensure
  args.each { @groups.pop }
end

- (Object) path(path, options = {}, source_options = {}, &blk)



157
158
159
# File 'lib/bundler/dsl.rb', line 157

def path(path, options = {}, source_options = {}, &blk)
  source Source::Path.new(normalize_hash(options).merge("path" => Pathname.new(path))), source_options, &blk
end

- (Object) platforms(*platforms) Also known as: platform



188
189
190
191
192
193
# File 'lib/bundler/dsl.rb', line 188

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

- (Object) rubygems_source



30
31
32
# File 'lib/bundler/dsl.rb', line 30

def rubygems_source
  @rubygems_source ||= Source::Rubygems.new
end

- (Object) source(source, options = {})



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

def source(source, options = {})
  case source
  when :gemcutter, :rubygems, :rubyforge then
    Bundler.ui.warn "The source :#{source} is deprecated because HTTP " \
      "requests are insecure.\nPlease change your source to 'https://" \
      "rubygems.org' if possible, or 'http://rubygems.org' if not."
    rubygems_source.add_remote "http://rubygems.org"
    return
  when String
    rubygems_source.add_remote source
    return
  else
    @source = source
    if options[:prepend]
      @sources = [@source] | @sources
    else
      @sources = @sources | [@source]
    end

    yield if block_given?
    return @source
  end
ensure
  @source = nil
end

- (Object) to_definition(lockfile, unlock)



176
177
178
179
# File 'lib/bundler/dsl.rb', line 176

def to_definition(lockfile, unlock)
  @sources << rubygems_source unless @sources.include?(rubygems_source)
  Definition.new(lockfile, @dependencies, @sources, unlock, @ruby_version)
end