berkshelf 3.0.0.beta7 → 3.0.0.beta8

data/lib/berkshelf/locations/git_location.rb

@@ -1,135 +0,0 @@
-module Berkshelf
-  class GitLocation < Location::ScmLocation
-    set_location_key :git
-    set_valid_options :ref, :branch, :tag, :rel
-
-    attr_accessor :uri
-    attr_accessor :branch
-    attr_accessor :rel
-    attr_accessor :ref
-    attr_reader :options
-
-    alias_method :tag, :branch
-
-    # @param [Dependency] dependency
-    # @param [Hash] options
-    #
-    # @option options [String] :git
-    #   the Git URL to clone
-    # @option options [String] :ref
-    #   the commit hash or an alias to a commit hash to clone
-    # @option options [String] :branch
-    #   same as ref
-    # @option options [String] :tag
-    #   same as tag
-    # @option options [String] :rel
-    #   the path within the repository to find the cookbook
-    def initialize(dependency, options = {})
-      super
-      @uri    = options[:git]
-      @ref    = options[:ref]
-      @branch = options[:branch] || options[:tag] || "master" unless ref
-      @sha    = ref
-      @rel    = options[:rel]
-
-      Git.validate_uri!(@uri)
-    end
-
-    # @example
-    #     irb> location.checkout_info
-    #     { kind: "branch", rev: "master" }
-    #
-    # @return [Hash]
-    def checkout_info
-      if @sha
-        kind, rev = "ref", @sha
-      else
-        kind, rev = "branch", branch
-      end
-
-      { kind: kind, rev: rev }
-    end
-
-    # @param [#to_s] destination
-    #
-    # @return [Berkshelf::CachedCookbook]
-    def do_download
-      destination = Berkshelf::CookbookStore.instance.storage_path
-
-      if cached?(destination)
-        @ref ||= Berkshelf::Git.rev_parse(revision_path(destination))
-        return local_revision(destination)
-      end
-
-      repo_path = Berkshelf::Git.clone(uri)
-
-      Berkshelf::Git.checkout(repo_path, ref || checkout_info[:rev])
-      @ref = Berkshelf::Git.rev_parse(repo_path)
-
-      tmp_path = rel ? File.join(repo_path, rel) : repo_path
-      unless File.chef_cookbook?(tmp_path)
-        msg = "Cookbook '#{dependency.name}' not found at #{to_s}"
-        msg << " at path '#{rel}'" if rel
-        raise CookbookNotFound, msg
-      end
-
-      cb_path = revision_path(destination)
-      FileUtils.rm_rf(cb_path)
-      FileUtils.mv(tmp_path, cb_path)
-
-      cached = CachedCookbook.from_store_path(cb_path)
-      validate_cached(cached)
-
-      cached
-    end
-
-    def to_hash
-      super.tap do |h|
-        h[:value]  = self.uri
-        h[:branch] = self.branch if branch
-      end
-    end
-
-    def ==(other)
-      other.is_a?(GitLocation) &&
-      other.uri == uri &&
-      other.branch == branch &&
-      other.ref == ref &&
-      other.rel == rel
-    end
-
-    def to_s
-      if rel
-        "#{uri} (at #{branch || ref[0...7]}/#{rel})"
-      else
-        "#{uri} (at #{branch || ref[0...7]})"
-      end
-    end
-
-    def to_lock
-      out =  "    git: #{uri}\n"
-      out << "    branch: #{branch}\n" if branch
-      out << "    ref: #{ref}\n"       if ref
-      out << "    rel: #{rel}\n"       if rel
-      out
-    end
-
-    private
-
-      def cached?(destination)
-        revision_path(destination) && File.exists?(revision_path(destination))
-      end
-
-      def local_revision(destination)
-        path = revision_path(destination)
-        cached = Berkshelf::CachedCookbook.from_store_path(path)
-        validate_cached(cached)
-        return cached
-      end
-
-      def revision_path(destination)
-        return unless ref
-        File.join(destination, "#{dependency.name}-#{ref}")
-      end
-  end
-end

data/lib/berkshelf/locations/github_location.rb

@@ -1,55 +0,0 @@
-module Berkshelf
-  class GithubLocation < GitLocation
-    DEFAULT_PROTOCOL = :git
-
-    set_location_key :github
-    set_valid_options :protocol
-
-    attr_accessor :protocol
-    attr_accessor :repo_identifier
-
-    # Wraps GitLocation allowing the short form GitHub repo identifier
-    # to be used in place of the complete repo url.
-    #
-    # @see GitLocation#initialize for parameter documentation
-    #
-    # @option options [String] :github
-    #   the GitHub repo identifier to clone
-    # @option options [#to_sym] :protocol
-    #   the protocol with which to communicate with GitHub
-    def initialize(dependency, options = {})
-      @repo_identifier = options.delete(:github)
-      if repo_identifier.end_with?(".git")
-        raise InvalidGitHubIdentifier.new(repo_identifier)
-      end
-      @protocol        = (options.delete(:protocol) || DEFAULT_PROTOCOL).to_sym
-      options[:git]    = github_url
-      super
-    end
-
-    # Returns the appropriate GitHub url given the specified protocol
-    #
-    # @raise [UnknownGitHubProtocol] if the specified protocol is not supported.
-    #
-    # @return [String]
-    #   GitHub url
-    def github_url
-      case protocol
-      when :ssh
-        "git@github.com:#{repo_identifier}.git"
-      when :https
-        "https://github.com/#{repo_identifier}.git"
-      when :git
-        "git://github.com/#{repo_identifier}.git"
-      else
-        raise UnknownGitHubProtocol.new(protocol)
-      end
-    end
-
-    private
-
-      def default_protocol?
-        self.protocol == DEFAULT_PROTOCOL
-      end
-  end
-end

data/lib/berkshelf/locations/mercurial_location.rb

@@ -1,114 +0,0 @@
-module Berkshelf
-  class MercurialLocation < Location::ScmLocation
-    set_location_key :hg
-    set_valid_options :rev, :branch, :tag, :rel
-
-    attr_accessor :uri
-    attr_accessor :rel
-    attr_accessor :rev
-    attr_reader :options
-
-    alias_method :tag, :rev
-    alias_method :branch, :rev
-
-    # @param [Dependency] dependency
-    # @param [Hash] options
-    #
-    # @option options [String] :hg
-    #   the URL to clone
-    # @option options [String] :rev
-    #   the revision to checkout
-    # @option options [String] :branch
-    #   same as rev
-    # @option options [String] :tag
-    #   same as rev
-    # @option options [String] :rel
-    #   the path within the repository to find the cookbook
-    def initialize(dependency, options = {})
-      super
-      @uri = options[:hg]
-      @rev = options[:rev] || options[:branch] || options[:tag] || 'default'
-      @rel = options[:rel]
-
-      Mercurial.validate_uri!(@uri)
-    end
-
-    # @return [Berkshelf::CachedCookbook]
-    def do_download
-      destination = Berkshelf::CookbookStore.instance.storage_path
-
-      if cached?(destination)
-        @rev ||= Berkshelf::Mercurial.rev_parse(revision_path(destination))
-        return local_revision(destination)
-      end
-
-      repo_path = Berkshelf::Mercurial.clone(uri)
-
-      Berkshelf::Mercurial.checkout(repo_path, rev || branch || tag) if rev || branch || tag
-      @rev = Berkshelf::Mercurial.rev_parse(repo_path)
-
-      tmp_path = rel ? File.join(repo_path, rel) : repo_path
-      unless File.chef_cookbook?(tmp_path)
-        msg = "Cookbook '#{dependency.name}' not found at #{to_s}"
-        msg << " at path '#{rel}'" if rel
-        raise CookbookNotFound, msg
-      end
-
-      cb_path = revision_path(destination)
-      FileUtils.rm_rf(cb_path)
-      FileUtils.mv(tmp_path, cb_path)
-
-      cached = CachedCookbook.from_store_path(cb_path)
-      validate_cached(cached)
-
-      cached
-    end
-
-    def to_hash
-      super.tap do |h|
-        h[:value]  = self.uri
-        h[:branch] = self.branch if branch
-      end
-    end
-
-    def ==(other)
-      other.is_a?(MercurialLocation) &&
-      other.uri == uri &&
-      other.rev == rev &&
-      other.rel == rel
-    end
-
-    def to_s
-      if rel
-        "#{uri} (at #{rev}/#{rel})"
-      else
-        "#{uri} (at #{rev})"
-      end
-    end
-
-    def to_lock
-      out =  "    hg: #{uri}\n"
-      out << "    rev: #{rev}\n" if rev
-      out << "    rel: #{rel}\n" if rel
-      out
-    end
-
-    private
-
-      def cached?(destination)
-        revision_path(destination) && File.exists?(revision_path(destination))
-      end
-
-      def local_revision(destination)
-        path = revision_path(destination)
-        cached = Berkshelf::CachedCookbook.from_store_path(path)
-        validate_cached(cached)
-        return cached
-      end
-
-      def revision_path(destination)
-        return unless rev
-        File.join(destination, "#{dependency.name}-#{rev}")
-      end
-  end
-end

data/lib/berkshelf/locations/path_location.rb

@@ -1,88 +0,0 @@
-module Berkshelf
-  class PathLocation < Location::Base
-    set_location_key :path
-    set_valid_options :path, :metadata
-
-    attr_accessor :path
-
-    # @param [#to_s] dependency
-    # @param [Solve::Constraint] version_constraint
-    # @param [Hash] options
-    #
-    # @option options [#to_s] :path
-    #   a filepath to the cookbook on your local disk
-    # @option options [Boolean] :metadata
-    #   true if this is a metadata source
-    def initialize(dependency, options = {})
-      super
-      @path     = options[:path].to_s
-      @metadata = options[:metadata]
-    end
-
-    def do_download
-      CachedCookbook.from_path(path, name: name)
-    end
-
-    # Returns true if the location is a metadata location. By default, no
-    # locations are the metadata location.
-    #
-    # @return [Boolean]
-    def metadata?
-      !!@metadata
-    end
-
-    # Return this PathLocation's path relative to the given target.
-    #
-    # @param [#to_s] target
-    #   the path to a file or directory to be relative to
-    #
-    # @return [String]
-    #   the relative path relative to the target
-    def relative_path(target = '.')
-      my_path     = Pathname.new(path).expand_path
-      target_path = Pathname.new(target.to_s).expand_path
-      target_path = target_path.dirname if target_path.file?
-
-      new_path = my_path.relative_path_from(target_path).to_s
-
-      return new_path if new_path.index('.') == 0
-      "./#{new_path}"
-    end
-
-    #
-    # The expanded path of this path on disk, relative to the berksfile.
-    #
-    # @return [String]
-    #
-    def expanded_path
-      relative_path(dependency.berksfile.filepath)
-    end
-
-    # Valid if the path exists and is readable
-    #
-    # @return [Boolean]
-    def valid?
-      File.exist?(path) && File.readable?(path)
-    end
-
-    def to_hash
-      super.merge(value: self.path)
-    end
-
-    def ==(other)
-      other.is_a?(PathLocation) &&
-      other.metadata? == metadata? &&
-      other.expanded_path == expanded_path
-    end
-
-    def to_lock
-      out =  "    path: #{relative_path(dependency.berksfile.filepath)}\n"
-      out << "    metadata: true\n" if metadata?
-      out
-    end
-
-    def to_s
-      "source at #{relative_path(dependency.berksfile.filepath)}"
-    end
-  end
-end

data/lib/berkshelf/mercurial.rb

@@ -1,146 +0,0 @@
-require 'uri'
-require 'buff/shell_out'
-
-module Berkshelf
-  class Mercurial
-    HG_REGEXP = URI.regexp(%w(http https file ssh))
-
-    HAS_QUOTE_RE = %r{\"}.freeze
-    HAS_SPACE_RE = %r{\s}.freeze
-
-    class << self
-      include Buff::ShellOut
-
-      # @overload hg(commands)
-      #   Shellout to the Mercurial executable on your system with the given commands.
-      #
-      #   @param [Array<String>]
-      #
-      #   @return [String]
-      #     the output of the execution of the Mercurial command
-      def hg(*command)
-        command.unshift(hg_cmd)
-        command_str = command.map { |p| quote_cmd_arg(p) }.join(' ')
-        response    = shell_out(command_str)
-
-        unless response.success?
-          raise MercurialError.new(response.stderr.strip)
-        end
-
-        response.stdout.strip
-      end
-
-      # Clone a remote Mercurial repository to disk
-      #
-      # @param [String] uri
-      #   a Mercurial URI to clone
-      # @param [#to_s] destination
-      #   a local path on disk to clone to
-      #
-      # @return [String]
-      #   the destination the URI was cloned to
-      def clone(uri, destination = Dir.mktmpdir)
-        hg('clone', uri, destination.to_s)
-        destination
-      end
-
-      # Checkout the given revision in the given repository
-      #
-      # @param [String] repo_path
-      #   path to a mercurial repo on disk
-      # @param [String] rev
-      #   revision to checkout
-      def checkout(repo_path, rev)
-        Dir.chdir repo_path do
-          hg('update','--clean', '--rev', rev)
-        end
-      end
-
-      # @param [String] repo_path
-      def rev_parse(repo_path)
-        Dir.chdir repo_path do
-          hg('id', '-i')
-        end
-      end
-
-      # Return an absolute path to the Mercurial executable on your system
-      #
-      # @return [String]
-      #   absolute path to mercurial executable
-      #
-      # @raise [MercurialNotFound] if executable is not found in system path
-      def find_hg
-        hg_path = nil
-        ENV['PATH'].split(::File::PATH_SEPARATOR).each do |path|
-          hg_path = detect_hg_path(path)
-          break if hg_path
-        end
-
-        unless hg_path
-          raise MercurialNotFound
-        end
-
-        return hg_path
-      end
-
-      # Determines if the given URI is a valid mercurial URI. A valid mercurial URI is a string
-      # containing the location of a mercurial repository by either the HTTP protocol,
-      # HTTPS protocol, or SSH protocol.
-      #
-      # @example Valid HTTP protocol URI
-      #   'http://hghub.com/project'
-      # @example Valid HTTPS URI
-      #   'https://hghub.com/project'
-      # @example Valid SSH protocol URI
-      #   'ssh://user@hghub.com:22/path/to/repo'
-      #
-      # @param [String] uri
-      #
-      # @return [Boolean]
-      def validate_uri(uri)
-        unless uri.is_a?(String)
-          return false
-        end
-
-        unless uri.slice(HG_REGEXP).nil?
-          return true
-        end
-
-        false
-      end
-
-      # @raise [InvalidMercurialURI] if the given object is not a String containing a valid Mercurial URI
-      #
-      # @see validate_uri
-      def validate_uri!(uri)
-        unless validate_uri(uri)
-          raise InvalidHgURI.new(uri)
-        end
-
-        true
-      end
-
-      private
-
-        def hg_cmd
-          @hg_cmd ||= find_hg
-        end
-
-        def quote_cmd_arg(arg)
-          return arg if HAS_QUOTE_RE.match(arg)
-          return arg unless HAS_SPACE_RE.match(arg)
-          "\"#{arg}\""
-        end
-
-        def detect_hg_path(base_dir)
-          %w(hg hg.exe hg.cmd).each do |hg_cmd|
-            potential_path = File.join(base_dir, hg_cmd)
-            if File.executable?(potential_path)
-              return potential_path
-            end
-          end
-          nil
-        end
-      end
-  end
-end