class Bundler::Source::Path - bundler-1.15.4 Documentation

# class Bundler::Source::Path

### Constants

DEFAULT_GLOB

### Attributes

name[W]
options[R]
original_path[R]
path[R]
root_path[R]
version[RW]

### Public Class Methods

from_lock(options) click to toggle source

    # File lib/bundler/source/path.rb, line 44
    def self.from_lock(options)
      new(options.merge("path" => options.delete("remote")))
    end

new(options) click to toggle source

    # File lib/bundler/source/path.rb, line 14
    def initialize(options)
      @options = options.dup
      @glob = options["glob"] || DEFAULT_GLOB

      @allow_cached = false
      @allow_remote = false

      @root_path = options["root_path"] || Bundler.root

      if options["path"]
        @path = Pathname.new(options["path"])
        @path = expand(@path) unless @path.relative?
      end

      @name    = options["name"]
      @version = options["version"]

      # Stores the original path. If at any point we move to the
      # cached directory, we still have the original path to copy from.
      @original_path = @path
    end

### Public Instance Methods

==(other)
Alias for: eql?
app_cache_dirname() click to toggle source

    # File lib/bundler/source/path.rb, line 107
    def app_cache_dirname
      name
    end

cache(spec, custom_path = nil) click to toggle source

    # File lib/bundler/source/path.rb, line 81
    def cache(spec, custom_path = nil)
      app_cache_path = app_cache_path(custom_path)
      return unless Bundler.settings[:cache_all]
      return if expand(@original_path).to_s.index(root_path.to_s + "/") == 0

      unless @original_path.exist?
        raise GemNotFound, "Can't cache gem #{version_message(spec)} because #{self} is missing!"
      end

      FileUtils.rm_rf(app_cache_path)
      FileUtils.cp_r("#{@original_path}/.", app_cache_path)
      FileUtils.touch(app_cache_path.join(".bundlecache"))
    end

cached!() click to toggle source

    # File lib/bundler/source/path.rb, line 40
    def cached!
      @allow_cached = true
    end

eql?(other) click to toggle source

    # File lib/bundler/source/path.rb, line 63
    def eql?(other)
      return unless other.class == self.class
      expanded_original_path == other.expanded_original_path &&
        version == other.version
    end

Also aliased as: ==
expanded_original_path() click to toggle source

    # File lib/bundler/source/path.rb, line 119
    def expanded_original_path
      @expanded_original_path ||= expand(original_path)
    end

hash() click to toggle source

    # File lib/bundler/source/path.rb, line 59
    def hash
      [self.class, expanded_path, version].hash
    end

install(spec, options = {}) click to toggle source

    # File lib/bundler/source/path.rb, line 75
    def install(spec, options = {})
      Bundler.ui.info "Using #{version_message(spec)} from #{self}"
      generate_bin(spec, :disable_extensions => true)
      nil # no post-install message
    end

is_a_path?() click to toggle source

    # File lib/bundler/source/path.rb, line 115
    def is_a_path?
      instance_of?(Path)
    end

local_specs(*) click to toggle source

    # File lib/bundler/source/path.rb, line 95
    def local_specs(*)
      @local_specs ||= load_spec_files
    end

name() click to toggle source

    # File lib/bundler/source/path.rb, line 71
    def name
      File.basename(expanded_path.to_s)
    end

remote!() click to toggle source

    # File lib/bundler/source/path.rb, line 36
    def remote!
      @allow_remote = true
    end

root() click to toggle source

    # File lib/bundler/source/path.rb, line 111
    def root
      Bundler.root
    end

specs() click to toggle source

    # File lib/bundler/source/path.rb, line 99
    def specs
      if has_app_cache?
        @path = app_cache_path
        @expanded_path = nil # Invalidate
      end
      local_specs
    end

to_lock() click to toggle source

    # File lib/bundler/source/path.rb, line 48
    def to_lock
      out = String.new("PATH\n")
      out << "  remote: #{lockfile_path}\n"
      out << "  glob: #{@glob}\n" unless @glob == DEFAULT_GLOB
      out << "  specs:\n"
    end

to_s() click to toggle source

    # File lib/bundler/source/path.rb, line 55
    def to_s
      "source at `#{@path}`"
    end

### Private Instance Methods

app_cache_path(custom_path = nil) click to toggle source

    # File lib/bundler/source/path.rb, line 142
    def app_cache_path(custom_path = nil)
      @app_cache_path ||= Bundler.app_cache(custom_path).join(app_cache_dirname)
    end

expand(somepath) click to toggle source

    # File lib/bundler/source/path.rb, line 129
    def expand(somepath)
      somepath.expand_path(root_path)
    rescue ArgumentError => e
      Bundler.ui.debug(e)
      raise PathError, "There was an error while trying to use the path "            "`#{somepath}`.\nThe error message was: #{e.message}."
    end

expanded_path() click to toggle source

    # File lib/bundler/source/path.rb, line 125
    def expanded_path
      @expanded_path ||= expand(path)
    end

generate_bin(spec, options = {}) click to toggle source

    # File lib/bundler/source/path.rb, line 211
    def generate_bin(spec, options = {})
      gem_dir = Pathname.new(spec.full_gem_path)

      # Some gem authors put absolute paths in their gemspec
      # and we have to save them from themselves
      spec.files = spec.files.map do |p|
        next p unless p =~ /\A#{Pathname::SEPARATOR_PAT}/
        next if File.directory?(p)
        begin
          Pathname.new(p).relative_path_from(gem_dir).to_s
        rescue ArgumentError
          p
        end
      end.compact

      installer = Path::Installer.new(
        spec,
        :env_shebang => false,
        :disable_extensions => options[:disable_extensions],
        :build_args => options[:build_args]
      )
      installer.post_install
    rescue Gem::InvalidSpecificationException => e
      Bundler.ui.warn "\n#{spec.name} at #{spec.full_gem_path} did not have a valid gemspec.\n"                          "This prevents bundler from installing bins or native extensions, but "                          "that may not affect its functionality."

      if !spec.extensions.empty? && !spec.email.empty?
        Bundler.ui.warn "If you need to use this package without installing it from a gem "                            "repository, please contact #{spec.email} and ask them "                            "to modify their .gemspec so it can work with `gem build`."
      end

      Bundler.ui.warn "The validation message from Rubygems was:\n  #{e.message}"
    end

has_app_cache?() click to toggle source

    # File lib/bundler/source/path.rb, line 146
    def has_app_cache?
      SharedHelpers.in_bundle? && app_cache_path.exist?
    end

load_gemspec(file) click to toggle source

    # File lib/bundler/source/path.rb, line 150
    def load_gemspec(file)
      return unless spec = Bundler.load_gemspec(file)
      Bundler.rubygems.set_installed_by_version(spec)
      spec
    end

load_spec_files() click to toggle source

    # File lib/bundler/source/path.rb, line 160
    def load_spec_files
      index = Index.new

      if File.directory?(expanded_path)
        # We sort depth-first since `<<` will override the earlier-found specs
        Dir["#{expanded_path}/#{@glob}"].sort_by {|p| -p.split(File::SEPARATOR).size }.each do |file|
          next unless spec = load_gemspec(file)
          spec.source = self

          # Validation causes extension_dir to be calculated, which depends
          # on #source, so we validate here instead of load_gemspec
          validate_spec(spec)
          index << spec
        end

        if index.empty? && @name && @version
          index << Gem::Specification.new do |s|
            s.name     = @name
            s.source   = self
            s.version  = Gem::Version.new(@version)
            s.platform = Gem::Platform::RUBY
            s.summary  = "Fake gemspec for #{@name}"
            s.relative_loaded_from = "#{@name}.gemspec"
            s.authors = ["no one"]
            if expanded_path.join("bin").exist?
              executables = expanded_path.join("bin").children
              executables.reject! {|p| File.directory?(p) }
              s.executables = executables.map {|c| c.basename.to_s }
            end
          end
        end
      else
        message = String.new("The path `#{expanded_path}` ")
        message << if File.exist?(expanded_path)
                     "is not a directory."
                   else
                     "does not exist."
                   end
        raise PathError, message
      end

      index
    end

lockfile_path() click to toggle source

    # File lib/bundler/source/path.rb, line 137
    def lockfile_path
      return relative_path(original_path) if original_path.absolute?
      expand(original_path).relative_path_from(Bundler.root)
    end

relative_path(path = self.path) click to toggle source

    # File lib/bundler/source/path.rb, line 204
    def relative_path(path = self.path)
      if path.to_s.start_with?(root_path.to_s)
        return path.relative_path_from(root_path)
      end
      path
    end

validate_spec(spec) click to toggle source

    # File lib/bundler/source/path.rb, line 156
    def validate_spec(spec)
      Bundler.rubygems.validate(spec)
    end