Class: Bundler::Dsl

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

attr_reader :gemspecs

# File 'lib/bundler/dsl.rb', line 450

def check_path_source_safety
  return if @sources.global_path_source.nil?

  msg = "You can no longer specify a path source by itself. Instead, \n" \
          "either use the :path option on a gem, or specify the gems that \n" \
          "bundler should find in the path source by passing a block to \n" \
          "the path method, like: \n\n" \
          "    path 'dir/containing/rails' do\n" \
          "      gem 'rails'\n" \
          "    end\n\n"

  SharedHelpers.major_deprecation(2, msg.strip)
end

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

def check_primary_source_safety
  check_path_source_safety
  check_rubygems_source_safety
end

# File 'lib/bundler/dsl.rb', line 464

def check_rubygems_source_safety
  if @sources.implicit_global_source?
    implicit_global_source_warning
  elsif @sources.aggregate_global_source?
    multiple_global_source_warning
  end
end

# File 'lib/bundler/dsl.rb', line 255

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

# 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

# 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

# File 'lib/bundler/dsl.rb', line 610

def gemfile_root
  @gemfile ||= Bundler.default_gemfile
  @gemfile.dirname
end

# 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

# 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

# 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

# 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

# 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

# File 'lib/bundler/dsl.rb', line 472

def implicit_global_source_warning
  Bundler::SharedHelpers.major_deprecation 2, "This Gemfile does not include an explicit global source. " \
    "Not using an explicit global source may result in a different lockfile being generated depending on " \
    "the gems you have installed locally before bundler is run. " \
    "Instead, define a global source in your Gemfile like this: source \"https://rubygems.org\"."
end

# File 'lib/bundler/dsl.rb', line 240

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

# File 'lib/bundler/dsl.rb', line 479

def multiple_global_source_warning
  if Bundler.feature_flag.bundler_3_mode?
    msg = "This Gemfile contains multiple primary sources. " \
      "Each source after the first must include a block to indicate which gems " \
      "should come from that source"
    raise GemfileEvalError, msg
  else
    Bundler::SharedHelpers.major_deprecation 2, "Your Gemfile contains multiple primary sources. " \
      "Using `source` more than once without a block is a security risk, and " \
      "may result in installing unexpected gems. To resolve this warning, use " \
      "a block to indicate which gems should come from the secondary source."
  end
end

# File 'lib/bundler/dsl.rb', line 404

def normalize_group_options(opts, groups)
  normalize_hash(opts)

  groups = groups.map {|group| ":#{group}" }.join(", ")
  validate_keys("group #{groups}", opts, %w[optional])

  opts["optional"] ||= false
end

# File 'lib/bundler/dsl.rb', line 326

def normalize_hash(opts)
  opts.keys.each do |k|
    opts[k.to_s] = opts.delete(k) unless k.is_a?(String)
  end
  opts
end

# File 'lib/bundler/dsl.rb', line 337

def normalize_options(name, version, opts)
  if name.is_a?(Symbol)
    raise GemfileError, %(You need to specify gem names as Strings. Use 'gem "#{name}"' instead)
  end
  if name =~ /\s/
    raise GemfileError, %('#{name}' is not a valid gem name because it contains whitespace)
  end
  raise GemfileError, %(an empty gem name is not valid) if name.empty?

  normalize_hash(opts)

  git_names = @git_sources.keys.map(&:to_s)
  validate_keys("gem '#{name}'", opts, valid_keys + git_names)

  groups = @groups.dup
  opts["group"] = opts.delete("groups") || opts["group"]
  groups.concat Array(opts.delete("group"))
  groups = [:default] if groups.empty?

  install_if = @install_conditionals.dup
  install_if.concat Array(opts.delete("install_if"))
  install_if = install_if.reduce(true) do |memo, val|
    memo && (val.respond_to?(:call) ? val.call : val)
  end

  platforms = @platforms.dup
  opts["platforms"] = opts["platform"] || opts["platforms"]
  platforms.concat Array(opts.delete("platforms"))
  platforms.map!(&:to_sym)
  platforms.each do |p|
    next if VALID_PLATFORMS.include?(p)
    raise GemfileError, "`#{p}` is not a valid platform. The available options are: #{VALID_PLATFORMS.inspect}"
  end

  # Save sources passed in a key
  if opts.key?("source")
    source = normalize_source(opts["source"])
    opts["source"] = @sources.add_rubygems_source("remotes" => source)
  end

  git_name = (git_names & opts.keys).last
  if @git_sources[git_name]
    git_opts = @git_sources[git_name].call(opts[git_name])
    git_opts = { "git" => git_opts } if git_opts.is_a?(String)
    opts.merge!(git_opts) do |key, _gemfile_value, _git_source_value|
      raise GemfileError, %(The :#{key} option can't be used with `#{git_name}: #{opts[git_name].inspect}`)
    end
  end

  %w[git path].each do |type|
    next unless param = opts[type]
    if version.first && version.first =~ /^\s*=?\s*(\d[^\s]*)\s*$/
      options = opts.merge("name" => name, "version" => $1)
    else
      options = opts.dup
    end
    source = send(type, param, options) {}
    opts["source"] = source
  end

  opts["source"]         ||= @source
  opts["env"]            ||= @env
  opts["platforms"]      = platforms.dup
  opts["group"]          = groups
  opts["should_include"] = install_if
end

# File 'lib/bundler/dsl.rb', line 436

def normalize_source(source)
  case source
  when :gemcutter, :rubygems, :rubyforge
    Bundler::SharedHelpers.major_deprecation 2, "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."
    "http://rubygems.org"
  when String
    source
  else
    raise GemfileError, "Unknown source '#{source}'"
  end
end

# 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

# File 'lib/bundler/dsl.rb', line 253

alias_method :platform, :platforms

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

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

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

def plugin(*args)
  # Pass on
end

# 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

# 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

# File 'lib/bundler/dsl.rb', line 333

def valid_keys
  @valid_keys ||= VALID_KEYS
end

# File 'lib/bundler/dsl.rb', line 413

def validate_keys(command, opts, valid_keys)
  invalid_keys = opts.keys - valid_keys

  git_source = opts.keys & @git_sources.keys.map(&:to_s)
  if opts["branch"] && !(opts["git"] || opts["github"] || git_source.any?)
    raise GemfileError, %(The `branch` option for `#{command}` is not allowed. Only gems with a git source can specify a branch)
  end

  return true unless invalid_keys.any?

  message = String.new
  message << "You passed #{invalid_keys.map {|k| ":" + k }.join(", ")} "
  message << if invalid_keys.size > 1
    "as options for #{command}, but they are invalid."
  else
    "as an option for #{command}, but it is invalid."
  end

  message << " Valid options are: #{valid_keys.join(", ")}."
  message << " You may be able to resolve this by upgrading Bundler to the newest version."
  raise InvalidOption, message
end

# File 'lib/bundler/dsl.rb', line 493

def warn_deprecated_git_source(name, replacement, additional_message = nil)
  additional_message &&= " #{additional_message}"
  replacement = if replacement.count("\n").zero?
    "{|repo_name| #{replacement} }"
  else
    "do |repo_name|\n#{replacement.to_s.gsub(/^/, "      ")}\n    end"
  end

  Bundler::SharedHelpers.major_deprecation 3, <<-EOS
The :#{name} git source is deprecated, and will be removed in the future.#{additional_message} Add this code to the top of your Gemfile to ensure it continues to work:

git_source(:#{name}) #{replacement}

  EOS
end

# File 'lib/bundler/dsl.rb', line 315

def with_source(source)
  old_source = @source
  if block_given?
    @source = source
    yield
  end
  source
ensure
  @source = old_source
end