Merge pull request #38 from invenia/ox/fullname

add checkpoint_fullname

Project.toml

@@ -1,7 +1,7 @@
 name = "Checkpoints"
 uuid = "b4a3413d-e481-5afc-88ff-bdfbd6a50dce"
 authors = "Invenia Technical Computing Corporation"
-version = "0.3.14"
+version = "0.3.15"
 
 [deps]
 AWSS3 = "1c724243-ef5b-51ab-93f4-b0a88ac62a95"

src/Checkpoints.jl

@@ -21,7 +21,7 @@ export checkpoint, with_checkpoint_tags  # creating stuff
 export enabled_checkpoints
 # indexing stuff
 export IndexEntry, index_checkpoint_files, index_files
-export checkpoint_name, checkpoint_path, prefixes, tags
+export checkpoint_fullname, checkpoint_name, checkpoint_path, prefixes, tags
 
 const LOGGER = getlogger(@__MODULE__)
 

src/indexing.jl

@@ -63,6 +63,19 @@ specified (as in `checkpoint("forecasts",...)`). If it was saved as
 """
 prefixes(x::IndexEntry) = getfield(x, :prefixes)
 
+
+"""
+    checkpoint_fullname(x::IndexEntry)
+
+The full name of the checkpoint output file, including [`prefixes`](@ref), and 
+[`checkpoint_name`](@ref).
+If the checkpoint was saved using `checkpoint(Forecasters, "forecasts", ...)` then
+`checkpoint_fullname` will return `"Forecasters.forecasts"`.
+If the checkpoint was saved using `checkpoint("Foo.Bar", "forecasts.jlso")` then
+`checkpoint_fullname` will return `"Foo.Bar.forecasts"`.
+"""
+checkpoint_fullname(x::IndexEntry) = join((prefixes(x)..., checkpoint_name(x)), ".")
+
 """
     tags(x::IndexEntry)
 

test/indexing.jl

@@ -12,6 +12,7 @@
             @test entry.date == "2017-01-01"
             @test prefixes(entry) == ("TestPkg",)
             @test checkpoint_name(entry) == "bar"
+            @test checkpoint_fullname(entry) == "TestPkg.bar"
             @test ==(
                 checkpoint_path(entry),
                 Path(joinpath(path, "date=2017-01-01", "TestPkg", "bar.jlso"))