Update signatures and CI config for 0.7/1.0. (#64)

Author: fredrikekre

.travis.yml

@@ -9,6 +9,7 @@ sudo: false
 julia:
   - 0.6
   - 0.7
+  - 1.0
   - nightly
 
 notifications:

appveyor.yml

@@ -1,11 +1,19 @@
 environment:
   matrix:
-  - JULIA_URL: "https://julialang-s3.julialang.org/bin/winnt/x86/0.6/julia-0.6-latest-win32.exe"
-  - JULIA_URL: "https://julialang-s3.julialang.org/bin/winnt/x64/0.6/julia-0.6-latest-win64.exe"
-  - 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.6
+  - julia_version: 0.7
+  - julia_version: 1
+  - julia_version: nightly
+
+platform:
+  - x86 # 32-bit
+  - x64 # 64-bit
+
+# # Uncomment the following lines to allow failures on nightly julia
+# # (tests will run but not make your overall status red)
+# matrix:
+#   allow_failures:
+#   - julia_version: latest
 
 branches:
   only:
@@ -19,19 +27,18 @@ notifications:
     on_build_status_changed: false
 
 install:
-  - ps: "[System.Net.ServicePointManager]::SecurityProtocol = [System.Net.SecurityProtocolType]::Tls12"
-# 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(), \"DocStringExtensions\"); Pkg.build(\"DocStringExtensions\")"
+  - echo "%JL_BUILD_SCRIPT%"
+  - C:\julia\bin\julia -e "%JL_BUILD_SCRIPT%"
 
 test_script:
-  - C:\projects\julia\bin\julia -e "Pkg.test(\"DocStringExtensions\")"
+  - echo "%JL_TEST_SCRIPT%"
+  - C:\julia\bin\julia -e "%JL_TEST_SCRIPT%"
+
+# # Uncomment to support code coverage upload. Should only be enabled for packages
+# # which would have coverage gaps without running on Windows
+# on_success:
+#   - echo "%JL_CODECOV_SCRIPT%"
+#   - C:\julia\bin\julia -e "%JL_CODECOV_SCRIPT%"

src/abbreviations.jl

@@ -352,26 +352,56 @@ struct MyType{S, T<:Integer} <: AbstractArray
 """
 const TYPEDEF = TypeDefinition()
 
+function print_supertype(buf, object)
+    super = supertype(object)
+    super != Any && print(buf, " <: ", super)
+end
+
+function print_params(buf, object)
+    if !isempty(object.parameters)
+        print(buf, "{")
+        join(buf, object.parameters, ", ")
+        print(buf, "}")
+    end
+end
+
+function print_primitive_type(buf, object)
+    print(buf, "primitive type ", object.name.name)
+    print_supertype(buf, object)
+    print(buf, " ", sizeof(object) * 8)
+    println(buf)
+end
+
+function print_abstract_type(buf, object)
+    print(buf, "abstract type ", object.name.name)
+    print_supertype(buf, object)
+    println(buf)
+end
+
+function print_mutable_struct_or_struct(buf, object)
+    object.mutable && print(buf, "mutable ")
+    print(buf, "struct ", object.name.name)
+    print_params(buf, object)
+    print_supertype(buf, object)
+    println(buf)
+end
+
+@static if VERSION < v"0.7.0"
+    isprimitivetype(x) = isbitstype(x)
+end
+
 function format(::TypeDefinition, buf, doc)
     local binding = doc.data[:binding]
     local object = gettype(Docs.resolve(binding))
     if isa(object, DataType)
         println(buf, "\n```julia")
-        if isbitstype(object)
-            print(buf, "bitstype ", sizeof(object) * 8, " ")
+        if isprimitivetype(object)
+            print_primitive_type(buf, object)
         elseif isabstracttype(object)
-            print(buf, "abstract ")
+            print_abstract_type(buf, object)
         else
-            print(buf, object.mutable ? "type " : "struct ")
-        end
-        print(buf, object.name.name)
-        if !isempty(object.parameters)
-            print(buf, "{")
-            join(buf, object.parameters, ", ")
-            print(buf, "}")
+            print_mutable_struct_or_struct(buf, object)
         end
-        local super = supertype(object)
-        super == Any ? println(buf) : println(buf, " <: ", super)
         println(buf, "```\n")
     end
 end

src/utilities.jl

@@ -312,7 +312,7 @@ url(m::Method) = url(m.module, string(m.file), m.line)
 import Compat.LibGit2
 
 function url(mod::Module, file::AbstractString, line::Integer)
-    file = Compat.Sys.iswindows() ? replace(file, '\\', '/') : file
+    file = Compat.Sys.iswindows() ? replace(file, '\\' => '/') : file
     if Base.inbase(mod) && !isabspath(file)
         local base = "https://github.com/JuliaLang/julia/tree"
         if isempty(Base.GIT_VERSION_INFO.commit)

test/tests.jl

@@ -195,9 +195,7 @@ end
             )
             DSE.format(TYPEDEF, buf, doc)
             str = String(take!(buf))
-            @test occursin("\n```julia\n", str)
-            @test occursin("\nabstract AbstractType <: Integer\n", str)
-            @test occursin("\n```\n", str)
+            @test str == "\n```julia\nabstract type AbstractType <: Integer\n```\n\n"
 
             doc.data = Dict(
                 :binding => Docs.Binding(M, :CustomType),
@@ -206,9 +204,7 @@ end
             )
             DSE.format(TYPEDEF, buf, doc)
             str = String(take!(buf))
-            @test occursin("\n```julia\n", str)
-            @test occursin("\nstruct CustomType{S, T<:Integer} <: Integer\n", str)
-            @test occursin("\n```\n", str)
+            @test str == "\n```julia\nstruct CustomType{S, T<:Integer} <: Integer\n```\n\n"
 
             doc.data = Dict(
                 :binding => Docs.Binding(M, :BitType8),
@@ -217,9 +213,7 @@ end
             )
             DSE.format(TYPEDEF, buf, doc)
             str = String(take!(buf))
-            @test occursin("\n```julia\n", str)
-            @test occursin("\nbitstype 8 BitType8\n", str)
-            @test occursin("\n```\n", str)
+            @test str == "\n```julia\nprimitive type BitType8 8\n```\n\n"
 
             doc.data = Dict(
                 :binding => Docs.Binding(M, :BitType32),
@@ -228,9 +222,7 @@ end
             )
             DSE.format(TYPEDEF, buf, doc)
             str = String(take!(buf))
-            @test occursin("\n```julia\n", str)
-            @test occursin("\nbitstype 32 BitType32 <: Real", str)
-            @test occursin("\n```\n", str)
+            @test str == "\n```julia\nprimitive type BitType32 <: Real 32\n```\n\n"
         end
     end
     @testset "templates" begin