brew/Library/Homebrew/cask/lib/hbc/cask.rb

require "forwardable"

require "hbc/dsl"

module Hbc
  class Cask
    extend Forwardable

    attr_reader :token, :sourcefile_path
    def initialize(token, sourcefile_path: nil, &block)
      @token = token
      @sourcefile_path = sourcefile_path
      @dsl = DSL.new(@token)
      return unless block_given?
      @dsl.instance_eval(&block)
      @dsl.language_eval
    end

    DSL::DSL_METHODS.each do |method_name|
      define_method(method_name) { @dsl.send(method_name) }
    end

    METADATA_SUBDIR = ".metadata".freeze

    def metadata_master_container_path
      @metadata_master_container_path ||= caskroom_path.join(METADATA_SUBDIR)
    end

    def metadata_versioned_container_path
      cask_version = version ? version : :unknown
      metadata_master_container_path.join(cask_version.to_s)
    end

    def metadata_path(timestamp = :latest, create = false)
      if create && timestamp == :latest
        raise CaskError, "Cannot create metadata path when timestamp is :latest"
      end
      path = if timestamp == :latest
        Pathname.glob(metadata_versioned_container_path.join("*")).sort.last
      elsif timestamp == :now
        Utils.nowstamp_metadata_path(metadata_versioned_container_path)
      else
        metadata_versioned_container_path.join(timestamp)
      end
      if create
        odebug "Creating metadata directory #{path}"
        FileUtils.mkdir_p path
      end
      path
    end

    def metadata_subdir(leaf, timestamp = :latest, create = false)
      if create && timestamp == :latest
        raise CaskError, "Cannot create metadata subdir when timestamp is :latest"
      end
      unless leaf.respond_to?(:length) && !leaf.empty?
        raise CaskError, "Cannot create metadata subdir for empty leaf"
      end
      parent = metadata_path(timestamp, create)
      return nil unless parent.respond_to?(:join)
      subdir = parent.join(leaf)
      if create
        odebug "Creating metadata subdirectory #{subdir}"
        FileUtils.mkdir_p subdir
      end
      subdir
    end

    def timestamped_versions
      Pathname.glob(metadata_master_container_path.join("*", "*"))
              .map { |p| p.relative_path_from(metadata_master_container_path) }
              .sort_by(&:basename) # sort by timestamp
              .map { |p| p.split.map(&:to_s) }
    end

    def versions
      timestamped_versions.map(&:first)
                          .reverse
                          .uniq
                          .reverse
    end

    def installed?
      !versions.empty?
    end

    def installed_caskfile
      installed_version = timestamped_versions.last
      metadata_master_container_path.join(*installed_version, "Casks", "#{token}.rb")
    end

    def outdated?(greedy = false)
      !outdated_versions(greedy).empty?
    end

    def outdated_versions(greedy = false)
      # special case: tap version is not available
      return [] if version.nil?

      if greedy
        return versions if version.latest?
      elsif auto_updates
        return []
      end

      installed = versions
      current   = installed.last

      # not outdated unless there is a different version on tap
      return [] if current == version

      # collect all installed versions that are different than tap version and return them
      installed.select { |v| v != version }
    end

    def to_s
      @token
    end

    def dumpcask
      return unless CLI.debug?

      odebug "Cask instance dumps in YAML:"
      odebug "Cask instance toplevel:", to_yaml
      [
        :name,
        :homepage,
        :url,
        :appcast,
        :version,
        :sha256,
        :artifacts,
        :caveats,
        :depends_on,
        :conflicts_with,
        :container,
        :gpg,
        :accessibility_access,
        :auto_updates,
      ].each do |method|
        odebug "Cask instance method '#{method}':", send(method).to_yaml
      end
    end
  end
end