RiotGames/berkshelf

module Berkshelf
  class Dependency
    class << self
      # Returns the name of this cookbook (because it's the key in hash tables).
      #
      # @param [Dependency, #to_s] dependency
      #   the dependency to find the name from
      #
      # @return [String]
      #   the name of the cookbook
      def name(dependency)
        if dependency.is_a?(Dependency)
          dependency.name.to_s
        else
          dependency.to_s
        end
      end
    end

    # @return [Berkshelf::Berksfile]
    attr_reader :berksfile
    # @return [String]
    attr_reader :name
    # @return [Array<String,Symbol>]
    attr_writer :groups
    # @return [Berkshelf::Location]
    attr_reader :location
    # @return [Semverse::Version]
    attr_reader :locked_version
    # @return [Semverse::Constraint]
    attr_reader :version_constraint
    # @return [Source]
    attr_accessor :source

    # @param [Berkshelf::Berksfile] berksfile
    #   the berksfile this dependency belongs to
    # @param [String] name
    #   the name of dependency
    #
    # @option options [String, Semverse::Constraint] :constraint
    #   version constraint for this dependency
    # @option options [String] :git
    #   the Git URL to clone
    # @option options [String] :path
    #   a filepath to the cookbook on your local disk
    # @option options [String] :metadata
    #   use the metadata at the given pat
    # @option options [Symbol, Array] :group
    #   the group or groups that the cookbook belongs to
    # @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] :locked_version
    def initialize(berksfile, name, options = {})
      @options            = options
      @berksfile          = berksfile
      @name               = name
      @metadata           = options[:metadata]
      @location           = Location.init(self, options)

      if options[:locked_version]
        @locked_version = Semverse::Version.coerce(options[:locked_version])
      end

      # The coerce method automatically gives us a default constraint of
      # >= 0.0.0 if the constraint is not set.
      @version_constraint = Semverse::Constraint.coerce(options[:constraint])

      add_group(options[:group]) if options[:group]
      add_group(:default) if groups.empty?
    end

    # Return true if this is a metadata location.
    #
    # @return [Boolean]
    def metadata?
      !!@metadata
    end

    # Set this dependency's locked version.
    #
    # @param [#to_s] version
    #   the version to set
    def locked_version=(version)
      @locked_version = Semverse::Version.coerce(version)
    end

    # Set this dependency's constraint(s).
    #
    # @param [#to_s] constraint
    #   the constraint to set
    def version_constraint=(constraint)
      @version_constraint = Semverse::Constraint.coerce(constraint)
    end

    def add_group(*local_groups)
      local_groups = local_groups.first if local_groups.first.is_a?(Array)

      local_groups.each do |group|
        group = group.to_sym
        groups << group unless groups.include?(group)
      end
    end

    # Determine if this dependency is installed. A dependency is "installed" if
    # the associated {CachedCookbook} exists on disk.
    #
    # @return [Boolean]
    def installed?
      !cached_cookbook.nil?
    end

    # Attempt to load the cached_cookbook for this dependency. For SCM/path
    # locations, this method delegates to {BaseLocation#cached_cookbook}. For
    # generic dependencies, this method tries attemps to load a matching
    # cookbook from the {CookbookStore}.
    #
    # @return [CachedCookbook, nil]
    def cached_cookbook
      return @cached_cookbook if @cached_cookbook

      @cached_cookbook =
        if location
          cookbook = location.cached_cookbook

          # If we have a cached cookbook, tighten our constraints
          if cookbook
            self.locked_version     = cookbook.version
            self.version_constraint = cookbook.version
          end

          cookbook
        else
          if locked_version
            CookbookStore.instance.cookbook(name, locked_version)
          else
            CookbookStore.instance.satisfy(name, version_constraint)
          end
        end

      @cached_cookbook
    end

    # Returns true if this dependency has the given group.
    #
    # @return [Boolean]
    def has_group?(group)
      groups.include?(group.to_sym)
    end

    # The list of groups this dependency belongs to.
    #
    # @return [Array<Symbol>]
    def groups
      @groups ||= []
    end

    def <=>(other)
      [name, version_constraint] <=> [other.name, other.version_constraint]
    end

    def to_s
      "#{name} (#{locked_version || version_constraint})"
    end

    def inspect
      "#<Berkshelf::Dependency: " << [
        "#{name} (#{version_constraint})",
        "locked_version: #{locked_version.inspect}",
        "groups: #{groups}",
        "location: #{location || "default"}>",
      ].join(", ")
    end

    def to_lock
      out =
        if location || version_constraint.to_s == ">= 0.0.0"
          "  #{name}\n"
        else
          "  #{name} (#{version_constraint})\n"
        end

      out << location.to_lock if location
      out
    end
  end
end