forked from JuliaLang/julia
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Pkg: major rename and refactor of package generation code.
The major user-facing change is that Pkg.scaffold has been replaced by Pkg.generate, which has similar functionality but a slightly different interface – license is a required second argument instead of a "required" keyword argument. This change also factors all the little bits of content generation into their own separately callable functions. Finally, if you want to generate packages to a non-standard place, this no longer provides a keyword argument to do so. Being a non- standard code path, that was really prone to bit-rot. Now, instead what you can do is change JULIA_PKGDIR and then call Pkg.generate as you normally would. It doesn't require any METADATA or other special files to exist, so this can be an arbitary directory and it will just work. options that were available as keyw
- Loading branch information
1 parent
763bdee
commit 096c412
Showing
4 changed files
with
191 additions
and
180 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,178 @@ | ||
| module Generate | ||
|
|
||
| using Base.Git, ..Read | ||
|
|
||
| copyright_year() = readchomp(`date +%Y`) | ||
| copyright_name() = Git.readchomp(`config --global --get user.name`) | ||
| enable_github() = Git.success(`config --global --get github.user`) | ||
| enable_travis() = Git.success(`config --global --get github.user`) | ||
|
|
||
| function package( | ||
| pkg::String, | ||
| license::String; | ||
| authors::String = copyright_name(), | ||
| years::Union(Int,String) = copyright_year(), | ||
| github::Bool = enable_github(), | ||
| travis::Bool = enable_travis(), | ||
| ) | ||
| ispath(pkg) && error("$pkg exists, refusing to overwrite.") | ||
| try | ||
| Generate.init(pkg,github=github) | ||
| Generate.license(pkg,license,years=years,authors=authors) | ||
| Generate.readme(pkg,travis=travis) | ||
| Generate.entrypoint(pkg) | ||
| travis && Generate.travis(pkg) | ||
| info("Committing $pkg generated files") | ||
| msg = """ | ||
| $pkg.jl generated files. | ||
| license: $license | ||
| authors: $authors | ||
| years: $years | ||
| github: $github | ||
| travis: $travis | ||
| Julia Version $VERSION [$(Base.BUILD_INFO.commit[1:10])] | ||
| """ | ||
| Git.run(`commit -q -m $msg`, dir=pkg) | ||
| catch | ||
| run(`rm -rf $pkg`) | ||
| rethrow() | ||
| end | ||
| end | ||
|
|
||
| function init(pkg::String; github::Bool=enable_github()) | ||
| ispath(pkg) && error("$pkg exists, refusing to overwrite.") | ||
| info("Initializing $pkg repo: $(abspath(pkg))") | ||
| Git.run(`init -q $pkg`) | ||
| Git.run(`commit -q --allow-empty -m "initial empty commit"`, dir=pkg) | ||
| github || return | ||
| user = Git.readchomp(`config --get github.user`) | ||
| url = "git:https://github.com/$user/$pkg.jl.git" | ||
| info("Origin: $url") | ||
| Git.set_remote_url(url,dir=pkg) | ||
| end | ||
|
|
||
| function license(pkg::String, license::String; | ||
| years::Union(Int,String) = copyright_year(), | ||
| authors::String = copyright_name(), | ||
| ) | ||
| if !haskey(LICENSES,license) | ||
| licenses = join(sort!([keys(LICENSES)...], by=lowercase), ", ") | ||
| error("$license is not a known license choice, choose one of: $licenses.") | ||
| end | ||
| genfile(pkg,"LICENSE.md") do io | ||
| print(io, LICENSES[license](pkg, string(years), authors)) | ||
| end | ||
| end | ||
|
|
||
| function readme(pkg::String; travis::Bool=enable_travis()) | ||
| genfile(pkg,"README.md") do io | ||
| println(io, "# $pkg") | ||
| travis || return | ||
| user = Git.readchomp(`config --get github.user`) | ||
| url = "https://travis-ci.org/$user/$pkg.jl" | ||
| println(io, "\n[]($url)") | ||
| end | ||
| end | ||
|
|
||
| function travis(pkg::String) | ||
| genfile(pkg,".travis.yml") do io | ||
| print(io, """ | ||
| language: cpp | ||
| compiler: | ||
| - clang | ||
| notifications: | ||
| email: false | ||
| before_install: | ||
| - sudo add-apt-repository ppa:staticfloat/julia-deps -y | ||
| - sudo add-apt-repository ppa:staticfloat/julianightlies -y | ||
| - sudo apt-get update -qq -y | ||
| - sudo apt-get install libpcre3-dev julia -y | ||
| script: | ||
| - julia -e 'Pkg.init(); run(`ln -s \$(pwd()) \$(Pkg.dir())/$pkg`); Pkg.resolve()' | ||
| - julia -e 'using $pkg; @assert isdefined(:$pkg); @assert typeof($pkg) === Module' | ||
| """) | ||
| end | ||
| end | ||
|
|
||
| function entrypoint(pkg::String) | ||
| genfile(pkg,"src/$pkg.jl") do io | ||
| print(io, """ | ||
| module $pkg | ||
| # package code goes here | ||
| end # module | ||
| """) | ||
| end | ||
| end | ||
|
|
||
| function genfile(f::Function, pkg::String, file::String) | ||
| path = joinpath(pkg,file) | ||
| info("Generating $file") | ||
| mkpath(dirname(path)) | ||
| open(f, path, "w") | ||
| Git.run(`add $file`, dir=pkg) | ||
| end | ||
|
|
||
| mit(pkg::String, years::String, authors::String) = | ||
| """ | ||
| The $pkg.jl package is licensed under the MIT Expat License: | ||
| > Copyright (c) $years: $authors. | ||
| > | ||
| > Permission is hereby granted, free of charge, to any person obtaining | ||
| > a copy of this software and associated documentation files (the | ||
| > "Software"), to deal in the Software without restriction, including | ||
| > without limitation the rights to use, copy, modify, merge, publish, | ||
| > distribute, sublicense, and/or sell copies of the Software, and to | ||
| > permit persons to whom the Software is furnished to do so, subject to | ||
| > the following conditions: | ||
| > | ||
| > The above copyright notice and this permission notice shall be | ||
| > included in all copies or substantial portions of the Software. | ||
| > | ||
| > THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, | ||
| > EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF | ||
| > MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. | ||
| > IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY | ||
| > CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, | ||
| > TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE | ||
| > SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. | ||
| """ | ||
|
|
||
| bsd(pkg::String, years::String, authors::String) = | ||
| """ | ||
| The $pkg.jl package is licensed under the Simplified BSD License: | ||
| > Copyright (c) $years: $authors. | ||
| > | ||
| > Redistribution and use in source and binary forms, with or without | ||
| > modification, are permitted provided that the following conditions are | ||
| > met: | ||
| > | ||
| > 1. Redistributions of source code must retain the above copyright | ||
| > notice, this list of conditions and the following disclaimer. | ||
| > 2. Redistributions in binary form must reproduce the above copyright | ||
| > notice, this list of conditions and the following disclaimer in the | ||
| > documentation and/or other materials provided with the distribution. | ||
| > | ||
| > THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | ||
| > "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | ||
| > LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR | ||
| > A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | ||
| > OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, | ||
| > SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT | ||
| > LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, | ||
| > DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY | ||
| > THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT | ||
| > (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE | ||
| > OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. | ||
| """ | ||
|
|
||
| const LICENSES = [ "MIT" => mit, "BSD" => bsd ] | ||
|
|
||
| end # module |
Oops, something went wrong.