bundler 1.12.6 → 1.13.0.pre.1

data/lib/bundler/plugin/api.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Bundler
+  # This is the interfacing class represents the API that we intend to provide
+  # the plugins to use.
+  #
+  # For plugins to be independent of the Bundler internals they shall limit their
+  # interactions to methods of this class only. This will save them from breaking
+  # when some internal change.
+  #
+  # Currently we are delegating the methods defined in Bundler class to
+  # itself. So, this class acts as a buffer.
+  #
+  # If there is some change in the Bundler class that is incompatible to its
+  # previous behavior or if otherwise desired, we can reimplement(or implement)
+  # the method to preserve compatibility.
+  #
+  # To use this, either the class can inherit this class or use it directly.
+  # For example of both types of use, refer the file `spec/plugins/command.rb`
+  #
+  # To use it without inheriting, you will have to create an object of this
+  # to use the functions (except for declaration functions like command, source,
+  # and hooks).
+  module Plugin
+    class API
+      # The plugins should declare that they handle a command through this helper.
+      #
+      # @param [String] command being handled by them
+      # @param [Class] (optional) class that shall handle the command. If not
+      #                 provided, the `self` class will be used.
+      def self.command(command, cls = self)
+        Plugin.add_command command, cls
+      end
+
+      # The cache dir to be used by the plugins for persistance storage
+      #
+      # @return [Pathname] path of the cache dir
+      def cache
+        Plugin.cache.join("plugins")
+      end
+
+      # A tmp dir to be used by plugins
+      # Accepts names that get concatenated as suffix
+      #
+      # @return [Pathname] object for the new directory created
+      def tmp(*names)
+        Bundler.tmp(["plugin", *names].join("-"))
+      end
+
+      def method_missing(name, *args, &blk)
+        super unless Bundler.respond_to?(name)
+        Bundler.send(name, *args, &blk)
+      end
+    end
+  end
+end

data/lib/bundler/plugin/dsl.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Bundler
+  # Dsl to parse the Gemfile looking for plugins to install
+  module Plugin
+    class DSL < Bundler::Dsl
+      class PluginGemfileError < PluginError; end
+      alias_method :_gem, :gem # To use for plugin installation as gem
+
+      # So that we don't have to override all there methods to dummy ones
+      # explicitly.
+      # They will be handled by method_missing
+      [:gemspec, :gem, :path, :install_if, :platforms, :env].each {|m| undef_method m }
+
+      def initialize
+        super
+        @sources = Plugin::SourceList.new
+      end
+
+      def plugin(name, *args)
+        _gem(name, *args)
+      end
+
+      def method_missing(name, *args)
+        raise PluginGemfileError, "Undefined local variable or method `#{name}' for Gemfile" unless Bundler::Dsl.method_defined? name
+      end
+    end
+  end
+end

data/lib/bundler/plugin/index.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module Bundler
+  # Manages which plugins are installed and their sources. This also is supposed to map
+  # which plugin does what (currently the features are not implemented so this class is
+  # now a stub class).
+  module Plugin
+    class Index
+      class CommandConflict < PluginError
+        def initialize(plugin, commands)
+          msg = "Command(s) `#{commands.join("`, `")}` declared by #{plugin} are already registered."
+          super msg
+        end
+      end
+
+      def initialize
+        @plugin_paths = {}
+        @commands = {}
+
+        load_index
+      end
+
+      # This function is to be called when a new plugin is installed. This function shall add
+      # the functions of the plugin to existing maps and also the name to source location.
+      #
+      # @param [String] name of the plugin to be registered
+      # @param [String] path where the plugin is installed
+      # @param [Array<String>] commands that are handled by the plugin
+      def register_plugin(name, path, commands)
+        @plugin_paths[name] = path
+
+        common = commands & @commands.keys
+        raise CommandConflict.new(name, common) unless common.empty?
+        commands.each {|c| @commands[c] = name }
+
+        save_index
+      end
+
+      # Path where the index file is stored
+      def index_file
+        Plugin.root.join("index")
+      end
+
+      def plugin_path(name)
+        Pathname.new @plugin_paths[name]
+      end
+
+      # Fetch the name of plugin handling the command
+      def command_plugin(command)
+        @commands[command]
+      end
+
+      def installed?(name)
+        @plugin_paths[name]
+      end
+
+    private
+
+      # Reads the index file from the directory and initializes the instance variables.
+      def load_index
+        SharedHelpers.filesystem_access(index_file, :read) do |index_f|
+          valid_file = index_f && index_f.exist? && !index_f.size.zero?
+          break unless valid_file
+          data = index_f.read
+          require "bundler/yaml_serializer"
+          index = YAMLSerializer.load(data)
+          @plugin_paths = index["plugin_paths"] || {}
+          @commands = index["commands"] || {}
+        end
+      end
+
+      # Should be called when any of the instance variables change. Stores the instance
+      # variables in YAML format. (The instance variables are supposed to be only String key value pairs)
+      def save_index
+        index = {
+          "plugin_paths" => @plugin_paths,
+          "commands" => @commands,
+        }
+
+        require "bundler/yaml_serializer"
+        SharedHelpers.filesystem_access(index_file) do |index_f|
+          FileUtils.mkdir_p(index_f.dirname)
+          File.open(index_f, "w") {|f| f.puts YAMLSerializer.dump(index) }
+        end
+      end
+    end
+  end
+end

data/lib/bundler/plugin/installer.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module Bundler
+  # Handles the installation of plugin in appropriate directories.
+  #
+  # This class is supposed to be wrapper over the existing gem installation infra
+  # but currently it itself handles everything as the Source's subclasses (e.g. Source::RubyGems)
+  # are heavily dependent on the Gemfile.
+  module Plugin
+    class Installer
+      autoload :Rubygems, "bundler/plugin/installer/rubygems"
+      autoload :Git,      "bundler/plugin/installer/git"
+
+      def install(names, options)
+        version = options[:version] || [">= 0"]
+
+        if options[:git]
+          install_git(names, version, options)
+        else
+          sources = options[:source] || Bundler.rubygems.sources
+          install_rubygems(names, version, sources)
+        end
+      end
+
+      # Installs the plugin from Definition object created by limited parsing of
+      # Gemfile searching for plugins to be installed
+      #
+      # @param [Definition] definiton object
+      # @return [Hash] map of plugin names to thier paths
+      def install_definition(definition)
+        plugins = definition.dependencies.map(&:name)
+
+        def definition.lock(*); end
+        definition.resolve_remotely!
+        specs = definition.specs
+
+        paths = install_from_specs specs
+
+        Hash[paths.select {|name, _| plugins.include? name }]
+      end
+
+    private
+
+      def install_git(names, version, options)
+        uri = options.delete(:git)
+        options["uri"] = uri
+
+        source_list = SourceList.new
+        source_list.add_git_source(options)
+
+        # To support both sources
+        if options[:source]
+          source_list.add_rubygems_source("remotes" => options[:source])
+        end
+
+        deps = names.map {|name| Dependency.new name, version }
+
+        definition = Definition.new(nil, deps, source_list, true)
+        install_definition(definition)
+      end
+
+      # Installs the plugin from rubygems source and returns the path where the
+      # plugin was installed
+      #
+      # @param [String] name of the plugin gem to search in the source
+      # @param [Array] version of the gem to install
+      # @param [String, Array<String>] source(s) to resolve the gem
+      #
+      # @return [String] the path where the plugin was installed
+      def install_rubygems(names, version, sources)
+        deps = names.map {|name| Dependency.new name, version }
+
+        source_list = SourceList.new
+        source_list.add_rubygems_source("remotes" => sources)
+
+        definition = Definition.new(nil, deps, source_list, true)
+        install_definition(definition)
+      end
+
+      # Installs the plugins and deps from the provided specs and returns map of
+      # gems to their paths
+      #
+      # @param specs to install
+      #
+      # @return [Hash] map of names to path where the plugin was installed
+      def install_from_specs(specs)
+        paths = {}
+
+        specs.each do |spec|
+          spec.source.install spec
+
+          paths[spec.name] = spec.full_gem_path
+        end
+
+        paths
+      end
+    end
+  end
+end

data/lib/bundler/plugin/installer/git.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Bundler
+  module Plugin
+    class Installer
+      class Git < Bundler::Source::Git
+        def cache_path
+          @cache_path ||= begin
+            git_scope = "#{base_name}-#{uri_hash}"
+
+            Plugin.cache.join("bundler", "git", git_scope)
+          end
+        end
+
+        def install_path
+          @install_path ||= begin
+            git_scope = "#{base_name}-#{shortref_for_path(revision)}"
+
+            Plugin.root.join("bundler", "gems", git_scope)
+          end
+        end
+
+        def version_message(spec)
+          "#{spec.name} #{spec.version}"
+        end
+
+        def root
+          Plugin.root
+        end
+
+        def generate_bin(spec, disable_extensions = false)
+          # Need to find a way without code duplication
+          # For now, we can ignore this
+        end
+      end
+    end
+  end
+end

data/lib/bundler/plugin/installer/rubygems.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Bundler
+  module Plugin
+    class Installer
+      class Rubygems < Bundler::Source::Rubygems
+        def version_message(spec)
+          "#{spec.name} #{spec.version}"
+        end
+
+      private
+
+        def requires_sudo?
+          false # Will change on implementation of project level plugins
+        end
+
+        def rubygems_dir
+          Plugin.root
+        end
+
+        def cache_path
+          Plugin.cache
+        end
+      end
+    end
+  end
+end

data/lib/bundler/plugin/source_list.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Bundler
+  # SourceList object to be used while parsing the Gemfile, setting the
+  # approptiate options to be used with Source classes for plugin installation
+  module Plugin
+    class SourceList < Bundler::SourceList
+      def initialize
+        @path_sources       = []
+        @git_sources        = []
+        @rubygems_aggregate = Plugin::Installer::Rubygems.new
+        @rubygems_sources   = []
+      end
+
+      def add_git_source(options = {})
+        add_source_to_list Plugin::Installer::Git.new(options), git_sources
+      end
+
+      def add_rubygems_source(options = {})
+        add_source_to_list Plugin::Installer::Rubygems.new(options), @rubygems_sources
+      end
+    end
+  end
+end

data/lib/bundler/postit_trampoline.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+postit_lib = File.expand_path("../vendor/postit/lib", __FILE__)
+$:.unshift(postit_lib)
+require "postit"
+require "rubygems"
+
+environment = BundlerVendoredPostIt::Environment.new([])
+version = Gem::Requirement.new(environment.bundler_version)
+
+installed_version =
+  if defined?(Bundler::VERSION)
+    Bundler::VERSION
+  else
+    File.read(File.expand_path("../version.rb", __FILE__)) =~ /VERSION = "(.+)"/
+    $1
+  end
+installed_version &&= Gem::Version.new(installed_version)
+
+if !version.satisfied_by?(installed_version)
+  begin
+    installer = BundlerVendoredPostIt::Installer.new(version)
+    installer.install!
+  rescue => e
+    abort <<-EOS.strip
+Installing the inferred bundler version (#{version}) failed.
+If you'd like to update to the current bundler version (#{installed_version}) in this project, run `bundle update --bundler`.
+The error was: #{e}
+    EOS
+  end
+
+  Gem.loaded_specs.delete("bundler") unless defined?(Bundler)
+  gem "bundler", version
+  $:.delete(File.expand_path("../..", __FILE__))
+else
+  begin
+    gem "bundler", version
+  rescue LoadError
+    $:.unshift(File.expand_path("../..", __FILE__))
+  end
+end
+
+running_version = begin
+  require "bundler/version"
+  Bundler::VERSION
+rescue LoadError, NameError
+  nil
+end
+
+if !Gem::Version.correct?(running_version.to_s) || !version.satisfied_by?(Gem::Version.create(running_version))
+  abort "The running bundler (#{running_version}) does not match the required `#{version}`"
+end
+
+$:.delete_at($:.find_index(postit_lib))

data/lib/bundler/psyched_yaml.rb

@@ -5,7 +5,7 @@ begin
 rescue LoadError
 end if defined?(gem)
 
-# Psych could just be in the stdlib
+# Psych could be in the stdlib
 # but it's too late if Syck is already loaded
 begin
   require "psych" unless defined?(Syck)

data/lib/bundler/remote_specification.rb

@@ -66,6 +66,10 @@ module Bundler
       [@name, @version, @platform == Gem::Platform::RUBY ? -1 : 1]
     end
 
+    def to_s
+      "#<#{self.class} name=#{name} version=#{version} platform=#{platform}>"
+    end
+
   private
 
     def _remote_specification
@@ -75,11 +79,7 @@ module Bundler
     end
 
     def method_missing(method, *args, &blk)
-      if Gem::Specification.new.respond_to?(method)
-        _remote_specification.send(method, *args, &blk)
-      else
-        super
-      end
+      _remote_specification.send(method, *args, &blk)
     end
   end
 end