panels now loaded by their full lua 'require' path

Author: cahna

README.md

@@ -57,7 +57,7 @@ Luminary uses the Tup build system.
 ## Privacy and Security Notice ##
 
 This toolbar should __never__ be exposed to a production/public-facing website. It will expose the entire configuration and
-environment of your server, display request contents (including passwords), and slow down your site. Luminary will
+environment of your server, display request contents (including passwords), and impact your site's performance. Luminary will
 restrict itself to the "development" environment by default.
 
 ## Usage ##
@@ -170,12 +170,12 @@ Each link in Luminary's navigation bar corresponds to an associated panel. A pan
 a lapis widget rendered as a tab within the toolbar. Luminary comes with several panels
 that are loaded by default:
 
-* __request__: Lapis request data
-* __router__: Lapis router information
-* __queries__: Database queries performed while serving request (pgsql through lapis.db)
-* __ngx__: OpenResty build information, server configuration, and Nginx variables
-* __environment__: Lapis environment configuration
-* __console__: Embedded lapis-console
+* `luminary.panels.request`: Lapis request data
+* `luminary.panels.router`: Lapis router information
+* `luminary.panels.queries`: Database queries performed while serving request (pgsql through lapis.db)
+* `luminary.panels.ngx`: OpenResty build information, server configuration, and Nginx variables
+* `luminary.panels.environment`: Lapis environment configuration
+* `luminary.panels.console`: Embedded lapis-console
 
 Since panels are just Lapis widgets, you can extend Luminary by creating your own panels filled
 with whatever debug information you want. Take a look at any of the panels in `luminary/panels/`
@@ -197,21 +197,15 @@ config {"development", "test"}, ->
   session_name "MyApp"
   postgresql_url "postgres://#{pg.user}:#{pg.pass}@127.0.0.1/#{pg.db}"
 
-  -- This example removes the default "ngx" panel
+  -- This example removes all of the defaults except for the 'request' and 'router' panels
   luminary ->
     panels {
-      "request"
-      "router"
-      "console"
+      "luminary.panels.request"
+      "luminary.panels.router"
     }
 ```
 
-Panels are loaded internally using something like:
-
-```moonscript
-p = require "luminary.panels.#{panel_name}"
-p\include_helper @
-```
+Panels are loaded internally using their Lua path (much like Python Debug Toolbar's panel loading scheme)
 
 ### Creating Panels ###
 

panels/db.lua

@@ -5,7 +5,7 @@ do
 end
 local label_wrap, float_wrap
 do
-  local _obj_0 = require("luminary.panels.util")
+  local _obj_0 = require("luminary.util")
   label_wrap, float_wrap = _obj_0.label_wrap, _obj_0.float_wrap
 end
 local sort, concat

panels/db.moon

@@ -1,6 +1,6 @@
 
 import render_html from require "lapis.html"
-import label_wrap, float_wrap from require "luminary.panels.util"
+import label_wrap, float_wrap from require "luminary.util"
 import sort, concat from table
 
 format_query = (q) ->

panels/environment.lua

@@ -1,7 +1,7 @@
 local config = require("lapis.config").get()
 local label_wrap, float_wrap
 do
-  local _obj_0 = require("luminary.panels.util")
+  local _obj_0 = require("luminary.util")
   label_wrap, float_wrap = _obj_0.label_wrap, _obj_0.float_wrap
 end
 local sort, concat

panels/environment.moon

@@ -1,7 +1,7 @@
 
 config = require"lapis.config".get!
 
-import label_wrap, float_wrap from require "luminary.panels.util"
+import label_wrap, float_wrap from require "luminary.util"
 import sort, concat from table
 
 class LapisEnvironmentPanel extends require "luminary.panels.base"

panels/ngx.lua

@@ -1,6 +1,6 @@
 local label_wrap, float_wrap
 do
-  local _obj_0 = require("luminary.panels.util")
+  local _obj_0 = require("luminary.util")
   label_wrap, float_wrap = _obj_0.label_wrap, _obj_0.float_wrap
 end
 local sort, concat

panels/ngx.moon

@@ -1,5 +1,5 @@
 
-import label_wrap, float_wrap from require "luminary.panels.util"
+import label_wrap, float_wrap from require "luminary.util"
 import sort, concat from table
 
 -- Available ngx variables

panels/util.lua renamed to util.lua

@@ -9,12 +9,12 @@ do
   insert, concat = _obj_0.insert, _obj_0.concat
 end
 local defaults = {
-  "request",
-  "db",
-  "ngx",
-  "router",
-  "environment",
-  "console"
+  "luminary.panels.request",
+  "luminary.panels.db",
+  "luminary.panels.ngx",
+  "luminary.panels.router",
+  "luminary.panels.environment",
+  "luminary.panels.console"
 }
 local LuminaryIndex
 do
@@ -28,7 +28,7 @@ do
     load_all = function(self, names)
       local conf = { }
       for i, name in ipairs(names) do
-        local panel = self:load_panel("luminary.panels." .. tostring(name))
+        local panel = self:load_panel(name)
         local id = "luminary-" .. tostring(i) .. "-" .. tostring(slugify(panel.title or panel.__name or 'DefaultPanel'))
         insert(conf, {
           id,

panels/util.moon renamed to util.moon

@@ -2,14 +2,13 @@
 import slugify from require "lapis.util"
 import insert, concat from table
 
--- TODO: Add ability to override/extend defaults from config.moon
 defaults = {
-  "request"
-  "db"
-  "ngx"
-  "router"
-  "environment"
-  "console"
+  "luminary.panels.request"
+  "luminary.panels.db"
+  "luminary.panels.ngx"
+  "luminary.panels.router"
+  "luminary.panels.environment"
+  "luminary.panels.console"
 }
 
 class LuminaryIndex extends require "luminary.views.base"
@@ -21,7 +20,7 @@ class LuminaryIndex extends require "luminary.views.base"
   load_all: (names) =>
     conf = {}
     for i,name in ipairs names
-      panel = @load_panel "luminary.panels.#{name}"
+      panel = @load_panel name
       id = "luminary-#{i}-#{slugify panel.title or panel.__name or 'DefaultPanel'}"
       insert(conf, {id, panel.title, panel})
     conf