diff --git a/src/nimble.nim b/src/nimble.nim index f94d1d0..486490d 100644 --- a/src/nimble.nim +++ b/src/nimble.nim @@ -45,45 +45,6 @@ proc refresh(options: Options) = else: "" - proc downloadList(list: PackageList, options: Options) = - display("Downloading", list.name & " package list", priority = HighPriority) - - var lastError = "" - for i in 0 .. 0: maskedUrl.password = "***" - display("Connecting", "to proxy at " & $maskedUrl, - priority = LowPriority) - - try: - downloadFile(url, tempPath, proxy = getProxy(options)) - except: - let message = "Could not download: " & getCurrentExceptionMsg() - display("Warning:", message, Warning) - lastError = message - continue - - if not validatePackagesList(tempPath): - lastError = "Downloaded packages.json file is invalid" - display("Warning:", lastError & ", discarding.", Warning) - continue - - copyFile(tempPath, - options.getNimbleDir() / "packages_$1.json" % list.name.toLowerAscii()) - display("Success", "Package list downloaded.", Success, HighPriority) - lastError = "" - break - - if lastError.len != 0: - raise newException(NimbleError, "Refresh failed\n" & lastError) - if parameter.len > 0: if parameter.isUrl: let cmdLine = PackageList(name: "commandline", urls: @[parameter]) @@ -275,17 +236,27 @@ proc processDeps(pkginfo: PackageInfo, options: Options): seq[string] = let msg = "Unsatisfied dependency: " & dep.name & " (" & $dep.ver & ")" raise newException(NimbleError, msg) else: - let depDesc = "$1@$2" % [dep.name, $dep.ver] - display("Checking", "for $1" % depDesc, priority = MediumPriority) + let resolvedDep = dep.resolveAlias(options) + display("Checking", "for $1" % $resolvedDep, priority = MediumPriority) var pkg: PackageInfo - if not findPkg(pkglist, dep, pkg): - display("Installing", depDesc, priority = HighPriority) - let (paths, installedPkg) = install(@[(dep.name, dep.ver)], options) + var found = findPkg(pkgList, resolvedDep, pkg) + # Check if the original name exists. + if not found and resolvedDep.name != dep.name: + display("Checking", "for $1" % $dep, priority = MediumPriority) + found = findPkg(pkgList, dep, pkg) + if found: + display("Warning:", "Installed package $1 should be renamed to $2" % + [dep.name, resolvedDep.name], Warning, HighPriority) + + if not found: + display("Installing", $resolvedDep, priority = HighPriority) + let toInstall = @[(resolvedDep.name, resolvedDep.ver)] + let (paths, installedPkg) = install(toInstall, options) result.add(paths) pkg = installedPkg # For addRevDep else: - display("Info:", "Dependency on $1 already satisfied" % depDesc, + display("Info:", "Dependency on $1 already satisfied" % $dep, priority = HighPriority) result.add(pkg.mypath.splitFile.dir) # Process the dependencies of this dependency. @@ -619,15 +590,6 @@ proc install(packages: seq[PkgTuple], if packages == @[]: result = installFromDir(getCurrentDir(), newVRAny(), options, "") else: - # If packages.json is not present ask the user if they want to download it. - if needsRefresh(options): - if doPrompt and - options.prompt("No local packages.json found, download it from " & - "internet?"): - refresh(options) - else: - raise newException(NimbleError, "Please run nimble refresh.") - # Install each package. for pv in packages: let (meth, url) = getDownloadInfo(pv, options, doPrompt) diff --git a/src/nimblepkg/packageinfo.nim b/src/nimblepkg/packageinfo.nim index e92eaf6..d09995f 100644 --- a/src/nimblepkg/packageinfo.nim +++ b/src/nimblepkg/packageinfo.nim @@ -1,7 +1,13 @@ # Copyright (C) Dominik Picheta. All rights reserved. # BSD License. Look at license.txt for more info. + +# Stdlib imports +import system except TResult import parsecfg, json, streams, strutils, parseutils, os, sets, tables -import version, tools, common, options, cli +import httpclient + +# Local imports +import version, tools, common, options, cli, config type Package* = object ## Definition of package from packages.json. @@ -16,6 +22,7 @@ type version*: string dvcsTag*: string web*: string # Info url for humans. + alias*: string ## A name of another package, that this package aliases. MetaData* = object url*: string @@ -102,16 +109,20 @@ proc fromJson(obj: JSonNode): Package = ## ## Aborts execution if the JSON node doesn't contain the required fields. result.name = obj.requiredField("name") - result.version = obj.optionalField("version") - result.url = obj.requiredField("url") - result.downloadMethod = obj.requiredField("method") - result.dvcsTag = obj.optionalField("dvcs-tag") - result.license = obj.requiredField("license") - result.tags = @[] - for t in obj["tags"]: - result.tags.add(t.str) - result.description = obj.requiredField("description") - result.web = obj.optionalField("web") + if obj.hasKey("alias"): + result.alias = obj.requiredField("alias") + else: + result.alias = "" + result.version = obj.optionalField("version") + result.url = obj.requiredField("url") + result.downloadMethod = obj.requiredField("method") + result.dvcsTag = obj.optionalField("dvcs-tag") + result.license = obj.requiredField("license") + result.tags = @[] + for t in obj["tags"]: + result.tags.add(t.str) + result.description = obj.requiredField("description") + result.web = obj.optionalField("web") proc readMetaData*(path: string): MetaData = ## Reads the metadata present in ``~/.nimble/pkgs/pkg-0.1/nimblemeta.json`` @@ -126,21 +137,107 @@ proc readMetaData*(path: string): MetaData = let jsonmeta = parseJson(cont) result.url = jsonmeta["url"].str -proc getPackage*(pkg: string, options: Options, - resPkg: var Package): bool = +proc needsRefresh*(options: Options): bool = + ## Determines whether a ``nimble refresh`` is needed. + ## + ## In the future this will check a stored time stamp to determine how long + ## ago the package list was refreshed. + result = true + for name, list in options.config.packageLists: + if fileExists(options.getNimbleDir() / "packages_" & name & ".json"): + result = false + +proc validatePackagesList(path: string): bool = + ## Determines whether package list at ``path`` is valid. + try: + let pkgList = parseFile(path) + if pkgList.kind == JArray: + if pkgList.len == 0: + display("Warning:", path & " contains no packages.", Warning, + HighPriority) + return true + except ValueError, JsonParsingError: + return false + +proc downloadList*(list: PackageList, options: Options) = + ## Downloads the specified package list and saves it in $nimbleDir. + display("Downloading", list.name & " package list", priority = HighPriority) + + var lastError = "" + for i in 0 .. 0: maskedUrl.password = "***" + display("Connecting", "to proxy at " & $maskedUrl, + priority = LowPriority) + + try: + downloadFile(url, tempPath, proxy = getProxy(options)) + except: + let message = "Could not download: " & getCurrentExceptionMsg() + display("Warning:", message, Warning) + lastError = message + continue + + if not validatePackagesList(tempPath): + lastError = "Downloaded packages.json file is invalid" + display("Warning:", lastError & ", discarding.", Warning) + continue + + copyFile(tempPath, + options.getNimbleDir() / "packages_$1.json" % list.name.toLowerAscii()) + display("Success", "Package list downloaded.", Success, HighPriority) + lastError = "" + break + + if lastError.len != 0: + raise newException(NimbleError, "Refresh failed\n" & lastError) + +proc readPackageList(name: string, options: Options): JsonNode = + # If packages.json is not present ask the user if they want to download it. + if needsRefresh(options): + if options.prompt("No local packages.json found, download it from " & + "internet?"): + for name, list in options.config.packageLists: + downloadList(list, options) + else: + raise newException(NimbleError, "Please run nimble refresh.") + return parseFile(options.getNimbleDir() / "packages_" & + name.toLowerAscii() & ".json") + +proc getPackage*(pkg: string, options: Options, resPkg: var Package): bool +proc resolveAlias(pkg: Package, options: Options): Package = + result = pkg + # Resolve alias. + if pkg.alias.len > 0: + display("Warning:", "The $1 package has been renamed to $2" % + [pkg.name, pkg.alias], Warning, HighPriority) + if not getPackage(pkg.alias, options, result): + raise newException(NimbleError, "Alias for package not found: " & + pkg.alias) + +proc getPackage*(pkg: string, options: Options, resPkg: var Package): bool = ## Searches any packages.json files defined in ``options.config.packageLists`` ## Saves the found package into ``resPkg``. ## ## Pass in ``pkg`` the name of the package you are searching for. As ## convenience the proc returns a boolean specifying if the ``resPkg`` was ## successfully filled with good data. + ## + ## Aliases are handled and resolved. for name, list in options.config.packageLists: display("Reading", "$1 package list" % name, priority = LowPriority) - let packages = parseFile(options.getNimbleDir() / - "packages_" & name.toLowerAscii() & ".json") + let packages = readPackageList(name, options) for p in packages: if normalize(p["name"].str) == normalize(pkg): resPkg = p.fromJson() + resPkg = resolveAlias(resPkg, options) return true proc getPackageList*(options: Options): seq[Package] = @@ -148,8 +245,7 @@ proc getPackageList*(options: Options): seq[Package] = result = @[] var namesAdded = initSet[string]() for name, list in options.config.packageLists: - let packages = parseFile(options.getNimbleDir() / - "packages_" & name.toLowerAscii() & ".json") + let packages = readPackageList(name, options) for p in packages: let pkg: Package = p.fromJson() if pkg.name notin namesAdded: @@ -207,6 +303,17 @@ proc withinRange*(pkgInfo: PackageInfo, verRange: VersionRange): bool = return withinRange(newVersion(pkgInfo.version), verRange) or withinRange(newVersion(pkgInfo.specialVersion), verRange) +proc resolveAlias*(dep: PkgTuple, options: Options): PkgTuple = + ## Looks up the specified ``dep.name`` in the packages.json files to resolve + ## a potential alias into the package's real name. + result = dep + var pkg: Package + # TODO: This needs better caching. + if getPackage(dep.name, options, pkg): + # The resulting ``pkg`` will contain the resolved name or the original if + # no alias is present. + result.name = pkg.name + proc findPkg*(pkglist: seq[tuple[pkgInfo: PackageInfo, meta: MetaData]], dep: PkgTuple, r: var PackageInfo): bool = @@ -254,12 +361,15 @@ proc getOutputDir*(pkgInfo: PackageInfo, bin: string): string = proc echoPackage*(pkg: Package) = echo(pkg.name & ":") - echo(" url: " & pkg.url & " (" & pkg.downloadMethod & ")") - echo(" tags: " & pkg.tags.join(", ")) - echo(" description: " & pkg.description) - echo(" license: " & pkg.license) - if pkg.web.len > 0: - echo(" website: " & pkg.web) + if pkg.alias.len > 0: + echo(" Alias for ", pkg.alias) + else: + echo(" url: " & pkg.url & " (" & pkg.downloadMethod & ")") + echo(" tags: " & pkg.tags.join(", ")) + echo(" description: " & pkg.description) + echo(" license: " & pkg.license) + if pkg.web.len > 0: + echo(" website: " & pkg.web) proc getDownloadDirName*(pkg: Package, verRange: VersionRange): string = result = pkg.name @@ -268,28 +378,6 @@ proc getDownloadDirName*(pkg: Package, verRange: VersionRange): string = result.add "_" result.add verSimple -proc needsRefresh*(options: Options): bool = - ## Determines whether a ``nimble refresh`` is needed. - ## - ## In the future this will check a stored time stamp to determine how long - ## ago the package list was refreshed. - result = true - for name, list in options.config.packageLists: - if fileExists(options.getNimbleDir() / "packages_" & name & ".json"): - result = false - -proc validatePackagesList*(path: string): bool = - ## Determines whether package list at ``path`` is valid. - try: - let pkgList = parseFile(path) - if pkgList.kind == JArray: - if pkgList.len == 0: - display("Warning:", path & " contains no packages.", Warning, - HighPriority) - return true - except ValueError, JsonParsingError: - return false - proc checkInstallFile(pkgInfo: PackageInfo, origDir, file: string): bool = ## Checks whether ``file`` should be installed. diff --git a/src/nimblepkg/version.nim b/src/nimblepkg/version.nim index 080c469..b4d42f5 100644 --- a/src/nimblepkg/version.nim +++ b/src/nimblepkg/version.nim @@ -291,6 +291,9 @@ proc findLatest*(verRange: VersionRange, if ver > result.ver: result = (ver, tag) +proc `$`*(dep: PkgTuple): string = + return dep.name & "@" & $dep.ver + when isMainModule: doAssert(newVersion("1.0") < newVersion("1.4")) doAssert(newVersion("1.0.1") > newVersion("1.0")) diff --git a/tests/tester.nim b/tests/tester.nim index ea1daa5..303fea4 100644 --- a/tests/tester.nim +++ b/tests/tester.nim @@ -172,7 +172,7 @@ test "can use nimscript's setCommand": let (output, exitCode) = execNimble("--verbose", "cTest") let lines = output.strip.splitLines() check exitCode == QuitSuccess - check "Compilation finished".normalize in lines[^1].normalize + check "Execution finished".normalize in lines[^1].normalize test "can use nimscript's setCommand with flags": cd "nimscript":