Add a show method for PkgFiles and update the README

Author: timholy

README.md

@@ -2,8 +2,8 @@
 
 CodeTracking is a minimal package designed to work with (a future version of)
 [Revise.jl](https://github.com/timholy/Revise.jl).
-Its main purpose is to support packages that need to know the location
-(file and line number) of code that might move around as it's edited.
+Its main purpose is to support packages that need to interact with code that might move
+around as it's edited.
 
 CodeTracking is a very lightweight dependency.
 
@@ -23,6 +23,29 @@ In this (ficticious) example, `sum` moved because I deleted a few lines higher i
 these didn't affect the functionality of `sum` (so we didn't need to redefine and recompile it),
 but it does change the starting line number of the file at which this method appears.
 
+Other features:
+
+```julia
+julia> using CodeTracking, ColorTypes
+
+julia> pkgfiles(ColorTypes)
+PkgFiles(ColorTypes [3da002f7-5984-5a60-b8a6-cbb66c0b333f]):
+  basedir: /home/tim/.julia/packages/ColorTypes/BsAWO
+  files: ["src/ColorTypes.jl", "src/types.jl", "src/traits.jl", "src/conversions.jl", "src/show.jl", "src/operations.jl"]
+
+julia> m = @which red(RGB(1,1,1))
+red(c::AbstractRGB) in ColorTypes at /home/tim/.julia/packages/ColorTypes/BsAWO/src/traits.jl:14
+
+julia> definition(m)
+:(red(c::AbstractRGB) = begin
+          #= /home/tim/.julia/packages/ColorTypes/BsAWO/src/traits.jl:14 =#
+          c.r
+      end)
+
+julia> definition(m, String)
+"red(c::AbstractRGB   ) = c.r\n"
+```
+
 ## A few details
 
 CodeTracking won't do anything *useful* unless the user is also running Revise,
@@ -32,15 +55,12 @@ file/line info in the method itself if Revise isn't running.)
 
 However, Revise is a fairly large (and fairly complex) package, and currently it's not
 easy to discover how to extract particular kinds of information from its internal storage.
-CodeTracking will be designed to be the new "query" part of Revise.jl.
+CodeTracking is designed to be the new "query" part of Revise.jl.
 The aim is to have a very simple API that developers can learn in a few minutes and then
 incorporate into their own packages; its lightweight nature means that they potentially gain
 a lot of functionality without being forced to take a big hit in startup time.
 
-## Current state
+## Status
 
-Currently this package is just a stub---it doesn't do anything useful,
-but neither should it hurt anything.
-Candidate users may wish to start `import`ing it and then file issues
-or submit PRs as they discover what kinds of functionality they need
-from CodeTracking.
+If you want CodeTracking to do anything useful, currently you have to check out the `teh/codetracking`
+branch of Revise.

src/CodeTracking.jl

@@ -3,6 +3,7 @@ module CodeTracking
 using Base: PkgId
 using Core: LineInfoNode
 
+export PkgFiles
 export whereis, definition, pkgfiles
 
 include("data.jl")

src/data.jl

@@ -26,6 +26,13 @@ Base.PkgId(info::PkgFiles) = info.id
 srcfiles(info::PkgFiles) = info.files
 basedir(info::PkgFiles) = info.basedir
 
+function Base.show(io::IO, info::PkgFiles)
+    println(io, "PkgFiles(", info.id, "):")
+    println(io, "  basedir: ", info.basedir)
+    print(io, "  files: ")
+    show(io, info.files)
+end
+
 const method_locations = IdDict{Type,LineInfoNode}()
 
 const method_definitions = IdDict{Type,Expr}()

test/runtests.jl

@@ -20,7 +20,12 @@ include("script.jl")
     f2(x, y) = x + y
     """
 
-    info = CodeTracking.PkgFiles(Base.PkgId(CodeTracking))
+    info = PkgFiles(Base.PkgId(CodeTracking))
     @test Base.PkgId(info) === info.id
     @test CodeTracking.basedir(info) == dirname(@__DIR__)
+
+    io = IOBuffer()
+    show(io, info)
+    str = String(take!(io))
+    @test startswith(str, "PkgFiles(CodeTracking [da1fd8a2-8d9e-5ec2-8556-3022fb5608a2]):\n  basedir:")
 end