Move backedge analysis here from Revise, add docs, and release 1.0 (#30)

* Move Revise's BackEdges here as CodeEdges

This package seems like a more natural home. It might be useful in
contexts outside of Revise. In Revise they are a means to an end,
and that's resulted in limited direct testing.

Moving them here also encourages fleshing out the API.
This adds many new utitilies and `show` methods.
Testing is done by checking the selectivity of execution, an easier
but thorough way of examining whether its making the correct decisions.

* Add Documenter docs and bump to version 1.0

* Add some precompiles

* Fix an apparent bug in bodymethod

Author: timholy

.travis.yml

@@ -20,9 +20,20 @@ branches:
 notifications:
   email: false
 
-script:
-    - export JULIA_PROJECT=""
-    - julia --project -e 'using Pkg; Pkg.build(); Pkg.test();'
+codecov: true
 
-after_success:
-  - julia -e 'import Pkg; Pkg.add("Coverage"); using Coverage; Codecov.submit(Codecov.process_folder())'
+jobs:
+  include:
+    - stage: "Documentation"
+      julia: 1.4
+      os: linux
+      arch: x64
+      script:
+        - julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd()));
+                                               Pkg.instantiate()'
+        - julia --project=docs/ docs/make.jl
+      name: "HTML"
+      after_success: skip
+  exclude:
+  - os: osx
+    arch: x86

Project.toml

@@ -1,13 +1,13 @@
 name = "LoweredCodeUtils"
 uuid = "6f1432cf-f94c-5a45-995e-cdbf5db27b0b"
 authors = ["Tim Holy <[email protected]>"]
-version = "0.4.5"
+version = "1.0.0"
 
 [deps]
 JuliaInterpreter = "aa1ae85d-cabe-5617-a682-6adf51b2e16a"
 
 [compat]
-JuliaInterpreter = "0.3, 0.4, 0.5, 0.6, 0.7"
+JuliaInterpreter = "0.7"
 julia = "1"
 
 [extras]

README.md

@@ -1,10 +1,5 @@
 # LoweredCodeUtils
 
-This package performs operations on Julia's [lowered AST](https://docs.julialang.org/en/latest/devdocs/ast/).
-Current utilities include:
-- `signature`: compute the signature of a single method from its lowered definition
-- `methoddef!`: find signatures and optionally evaluate methods from lowered code
-- `rename_framemethods!`, resolve gensymmed names (https://github.com/JuliaLang/julia/issues/30908)
-- `bodymethod`: find the method that executes the body of a keyword-argument function
+[![](https://img.shields.io/badge/docs-stable-blue.svg)](https://JuliaDebug.github.io/LoweredCodeUtils.jl/stable)
 
-You can learn more about these with, e.g., `?methoddef!`
+This package performs operations on Julia's [lowered AST](https://docs.julialang.org/en/latest/devdocs/ast/). See the documentation for details.

docs/.gitignore

@@ -0,0 +1,2 @@
+build/
+site/

docs/Project.toml

@@ -0,0 +1,5 @@
+[deps]
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+
+[compat]
+Documenter = "0.24"

docs/make.jl

@@ -0,0 +1,14 @@
+using Documenter
+using LoweredCodeUtils
+
+makedocs(
+    sitename = "LoweredCodeUtils",
+    format = Documenter.HTML(prettyurls = get(ENV, "CI", nothing) == "true"),
+    modules = [LoweredCodeUtils],
+    pages = ["Home" => "index.md", "signatures.md", "edges.md", "api.md"]
+)
+
+deploydocs(
+    repo = "github.com/JuliaDebug/LoweredCodeUtils.jl.git",
+    push_preview = true
+)

docs/src/api.md

@@ -0,0 +1,35 @@
+# API
+
+## Signatures
+
+```@docs
+signature
+methoddef!
+rename_framemethods!
+bodymethod
+```
+
+## Edges
+
+```@docs
+CodeEdges
+lines_required
+lines_required!
+selective_eval!
+selective_eval_fromstart!
+```
+
+## Internal utilities
+
+```@docs
+LoweredCodeUtils.print_with_code
+LoweredCodeUtils.next_or_nothing
+LoweredCodeUtils.skip_until
+LoweredCodeUtils.MethodInfo
+LoweredCodeUtils.identify_framemethod_calls
+LoweredCodeUtils.iscallto
+LoweredCodeUtils.getcallee
+LoweredCodeUtils.find_corrected_name
+LoweredCodeUtils.replacename!
+LoweredCodeUtils.Variable
+```