sourceafFpm::PodFile.fan

** Represents a pod backed by a repository.
const class PodFile {

    ** The name of this pod.
    const Str       name
    
    ** The version of this pod.
    const Version   version
    
    ** The dependencies of this pod.
    const Depend[]  dependsOn

    ** Absolute URL of where this pod is located.
    const Uri       location
    
    // TODO maybe have a canonical FPM URL like `fpm://default/afIoc/3.0.6`
//  const Uri       url

    ** This pod's name and version expressed as a dependency.
    const Depend    depend

    ** The repository where this pod file is held.
    const Repository repository
    
    ** Internal ctor
    @NoDoc  // reserve make() for serialisation - if / when it happens!
    new makeFields(Str name, Version version, Depend[] dependsOn, Uri location, Repository repository) {
        this.name       = name
        this.version    = version
        this.dependsOn  = dependsOn
        this.location   = location
        this.depend     = Depend("$name $version")
        this.repository = repository
    }
    
    ** Creates a 'PodFile' from a file.  
    static new fromFile(File file) {
        SinglePodRepository(file).podFile
    }
    
    ** Returns 'true' if this is a core Fantom pod.
    Bool isCore() {
        CorePods.instance.isCorePod(name)
    }
    
    ** The backing file for this pod.
    ** If the pod has a remote location, this will download it to a local / memory representation.
    File file() {
        repository.download(this)
    }
    
    ** Deletes this pod from its owning repository.
    Void delete() {
        repository.delete(this)
    }
    
    ** Installs this pod in to the given repository.
    ** Returns the 'PodFile' representation of the newly installed pod.
    PodFile installTo(Repository repository) {
        repository.upload(this)
    }
    
    ** Returns 'true' if this *fits* the given dependency.
    Bool fits(Depend depend) {
        depend.name == this.name && depend.match(this.version)
    }
    
    ** Returns 'true' if this is a core Fantom pod.
    Bool isCorePod() {
        CorePods.instance.isCorePod(name)
    }
    
    @NoDoc override Str toStr()             { "$name $version - $location" }
    @NoDoc override Int hash()              { location.hash }
    @NoDoc override Bool equals(Obj? that)  { (that as PodFile)?.location == location }
    
    @NoDoc
    override Int compare(Obj obj) {
        that := obj as PodFile
        return this.name == that.name
            ? this.version <=> that.version
            : this.name    <=> that.name
    }
}