Merge pull request #66 from JuliaMath/aa/modernize

Modernize the doc setup and add a Project file

Author: ararslan

.gitignore

@@ -1,5 +1,7 @@
 *.jl.cov
 *.jl.*.cov
 *.jl.mem
+Manifest.toml
 docs/build
 docs/site
+docs/Manifest.toml

.travis.yml

@@ -4,6 +4,8 @@ os:
   - linux
 julia:
   - 0.7
+  - 1.0
+  - 1.1
   - nightly
 notifications:
   email: false
@@ -12,6 +14,13 @@ notifications:
 #  - if [[ -a .git/shallow ]]; then git fetch --unshallow; fi
 #  - julia -e 'Pkg.clone(pwd()); Pkg.build("Primes"); Pkg.test("Primes"; coverage=true)'
 after_success:
-  - julia -e 'Pkg.add("Coverage"); ps=Pkg.PackageSpec(name="Documenter", version="0.19"); Pkg.add(ps); Pkg.pin(ps)'
-  - julia -e 'cd(Pkg.dir("Primes")); using Coverage; Coveralls.submit(Coveralls.process_folder())'
-  - julia -e 'cd(Pkg.dir("Primes")); include(joinpath("docs", "make.jl"))'
+  - julia -e 'using Pkg; Pkg.add("Coverage"); using Coverage; Coveralls.submit(Coveralls.process_folder())'
+jobs:
+  include:
+    - stage: "Documentation"
+      julia: 1.0
+      os: linux
+      script:
+        - julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
+        - julia --project=docs/ docs/make.jl
+      after_success: skip

Project.toml

@@ -0,0 +1,9 @@
+name = "Primes"
+uuid = "27ebfcd6-29c5-5fa9-bf4b-fb8fc14df3ae"
+
+[extras]
+DataStructures = "864edb3b-99cc-5e75-8d2d-829cb0a9cfe8"
+Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
+
+[targets]
+test = ["DataStructures", "Test"]

REQUIRE

@@ -1 +1 @@
-julia 0.7-alpha
+julia 0.7

appveyor.yml

@@ -1,40 +1,26 @@
 environment:
   matrix:
-  - JULIA_URL: "https://julialang-s3.julialang.org/bin/winnt/x86/0.7/julia-0.7-latest-win32.exe"
-  - JULIA_URL: "https://julialang-s3.julialang.org/bin/winnt/x64/0.7/julia-0.7-latest-win64.exe"
-  - JULIA_URL: "https://julialangnightlies-s3.julialang.org/bin/winnt/x86/julia-latest-win32.exe"
-  - JULIA_URL: "https://julialangnightlies-s3.julialang.org/bin/winnt/x64/julia-latest-win64.exe"
-
+  - julia_version: 0.7
+  - julia_version: 1.0
+  - julia_version: 1.1
+  - julia_version: nightly
+platform:
+  - x86 # 32-bit
+  - x64 # 64-bit
 branches:
   only:
     - master
     - /release-.*/
-
 notifications:
   - provider: Email
     on_build_success: false
     on_build_failure: false
     on_build_status_changed: false
-
 install:
-  - ps: "[System.Net.ServicePointManager]::SecurityProtocol = [System.Net.SecurityProtocolType]::Tls12"
-# If there's a newer build queued for the same PR, cancel this one
-  - ps: if ($env:APPVEYOR_PULL_REQUEST_NUMBER -and $env:APPVEYOR_BUILD_NUMBER -ne ((Invoke-RestMethod `
-        https://ci.appveyor.com/api/projects/$env:APPVEYOR_ACCOUNT_NAME/$env:APPVEYOR_PROJECT_SLUG/history?recordsNumber=50).builds | `
-        Where-Object pullRequestId -eq $env:APPVEYOR_PULL_REQUEST_NUMBER)[0].buildNumber) { `
-        throw "There are newer queued builds for this pull request, failing early." }
-# Download most recent Julia Windows binary
-  - ps: (new-object net.webclient).DownloadFile(
-        $env:JULIA_URL,
-        "C:\projects\julia-binary.exe")
-# Run installer silently, output to C:\projects\julia
-  - C:\projects\julia-binary.exe /S /D=C:\projects\julia
-
+  - ps: iex ((new-object net.webclient).DownloadString("https://raw.githubusercontent.com/JuliaCI/Appveyor.jl/version-1/bin/install.ps1"))
 build_script:
-# Need to convert from shallow to complete for Pkg.clone to work
-  - IF EXIST .git\shallow (git fetch --unshallow)
-  - C:\projects\julia\bin\julia -e "versioninfo();
-      Pkg.clone(pwd(), \"Primes\"); Pkg.build(\"Primes\")"
-
+  - echo "%JL_BUILD_SCRIPT%"
+  - C:\julia\bin\julia -e "%JL_BUILD_SCRIPT%"
 test_script:
-  - C:\projects\julia\bin\julia --check-bounds=yes -e "Pkg.test(\"Primes\")"
+  - echo "%JL_TEST_SCRIPT%"
+  - C:\julia\bin\julia -e "%JL_TEST_SCRIPT%"

docs/Project.toml

@@ -0,0 +1,6 @@
+[deps]
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+Primes = "27ebfcd6-29c5-5fa9-bf4b-fb8fc14df3ae"
+
+[compat]
+Documenter = "~0.20"

docs/make.jl

@@ -2,8 +2,6 @@ using Documenter, Primes
 
 makedocs(
     modules = [Primes],
-    clean = false,
-    format = :html,
     sitename = "Primes.jl",
     pages = Any[
         "Home" => "index.md",
@@ -12,9 +10,6 @@ makedocs(
 )
 
 deploydocs(
-    julia = "nightly",
     repo = "github.com/JuliaMath/Primes.jl.git",
     target = "build",
-    deps = nothing,
-    make = nothing,
 )

docs/src/api.md

@@ -1,3 +1,7 @@
+```@meta
+DocTestSetup = :(using Primes)
+```
+
 # Prime number functions
 
 ## Prime factorization

src/Primes.jl

@@ -1,5 +1,5 @@
-# This includes parts that were formerly a part of Julia. License is MIT: http://julialang.org/license
-VERSION < v"0.7.0-beta2.199" && __precompile__()
+# This file includes code that was formerly a part of Julia. License is MIT: http://julialang.org/license
+
 module Primes
 
 using Base.Iterators: repeated
@@ -338,13 +338,8 @@ Set([2,5])
 """
 factor(::Type{D}, n::T) where {T<:Integer, D<:AbstractDict} = factor!(n, D(Dict{T,Int}()))
 factor(::Type{A}, n::T) where {T<:Integer, A<:AbstractArray} = A(factor(Vector{T}, n))
-if VERSION >= v"0.7.0-beta.81"
-    factor(::Type{Vector{T}}, n::T) where {T<:Integer} =
-        mapreduce(collect, vcat, [repeated(k, v) for (k, v) in factor(n)], init=Vector{T}())
-else
-    factor(::Type{Vector{T}}, n::T) where {T<:Integer} =
-        mapreduce(collect, vcat, Vector{T}(), [repeated(k, v) for (k, v) in factor(n)])
-end
+factor(::Type{Vector{T}}, n::T) where {T<:Integer} =
+    mapreduce(collect, vcat, [repeated(k, v) for (k, v) in factor(n)], init=Vector{T}())
 factor(::Type{S}, n::T) where {T<:Integer, S<:Union{Set,BitSet}} = S(keys(factor(n)))
 factor(::Type{T}, n) where {T<:Any} = throw(MethodError(factor, (T, n)))
 
@@ -435,12 +430,6 @@ function pollardfactors!(n::T, h::AbstractDict{K,Int}) where {T<:Integer,K<:Inte
     end
 end
 
-if VERSION >= v"0.7.0-beta.183"
-    ndigits2(n) = ndigits(n, base=2)
-else
-    ndigits2(n) = ndigits(n, 2)
-end
-
 """
     ismersenneprime(M::Integer; [check::Bool = true]) -> Bool
 
@@ -461,7 +450,7 @@ true
 """
 function ismersenneprime(M::Integer; check::Bool = true)
     if check
-        d = ndigits2(M)
+        d = ndigits(M, base=2)
         M >= 0 && isprime(d) && (M >> d == 0) ||
             throw(ArgumentError("The argument given is not a valid Mersenne Number (`M = 2^p - 1`)."))
     end
@@ -486,7 +475,7 @@ true
 ```
 """
 function isrieselprime(k::Integer, Q::Integer)
-    n = ndigits2(Q)
+    n = ndigits(Q, base=2)
     0 < k < Q || throw(ArgumentError("The condition 0 < k < Q must be met."))
     if k == 1 && isodd(n)
         return n % 4 == 3 ? ll_primecheck(Q, 3) : ll_primecheck(Q)
@@ -500,7 +489,7 @@ end
 
 # LL backend -- not for export
 function ll_primecheck(X::Integer, s::Integer = 4)
-    S, N = BigInt(s), BigInt(ndigits2(X))
+    S, N = BigInt(s), BigInt(ndigits(X, base=2))
     X < 7 && throw(ArgumentError("The condition X ≥ 7 must be met."))
     for i in 1:(N - 2)
         S = (S^2 - 2) % X
@@ -543,12 +532,10 @@ end
 
 # modify a BigInt in-place
 function add_!(n::BigInt, x::Int)
-    # TODO: Change `Any` to `Ref{BigInt}` when 0.6 support is dropped.
-    # The two have the same effect but `Ref{BigInt}` won't be optimized on 0.6.
     if x < 0
-        ccall((:__gmpz_sub_ui, :libgmp), Cvoid, (Any, Any, Culong), n, n, -x)
+        ccall((:__gmpz_sub_ui, :libgmp), Cvoid, (Ref{BigInt}, Ref{BigInt}, Culong), n, n, -x)
     else
-        ccall((:__gmpz_add_ui, :libgmp), Cvoid, (Any, Any, Culong), n, n, x)
+        ccall((:__gmpz_add_ui, :libgmp), Cvoid, (Ref{BigInt}, Ref{BigInt}, Culong), n, n, x)
     end
     n
 end