From: David Schoonover <dsc@wikimedia.org>
Date: Wed, 23 May 2012 23:30:11 +0000 (-0700)
Subject: Refactor of source modules, including:
X-Git-Url: http://git.less.ly:3516/?a=commitdiff_plain;h=4104257499b337b9868bb640eb990d488e06dfa3;p=kraken-ui.git

Refactor of source modules, including:
- dataset     -> data
- timeseries  -> util/timeseries
- scaffold    -> base/scaffold
- Adds templates/{chart,dashboard,data,graph} to match the structure of the modules
- Deletes unused/empty modules and templates
---

diff --git a/docs/internals/housekeeping.md b/docs/internals/housekeeping.md
index 978169b..c464fd2 100644
--- a/docs/internals/housekeeping.md
+++ b/docs/internals/housekeeping.md
@@ -49,15 +49,8 @@
 ## Misc
 - Generate markdoc wiki from `/docs` on Build, Deploy
 - Refactor directories:
-    - template/
-        graph/
-        chart/
-        data/
-        dashboard/
-    - dataset/ -> data/
+    - dataset/
         dataset/ +metric
         datasource/ +column
-    - scaffold/ -> base/scaffold/
-    - timeseries/ -> util/timeseries/
 - Wrap `Backbone.extend()` to fire `subclass` event on parent class
 
diff --git a/lib/base/scaffold/index.co b/lib/base/scaffold/index.co
new file mode 100644
index 0000000..6524ae6
--- /dev/null
+++ b/lib/base/scaffold/index.co
@@ -0,0 +1,3 @@
+models = require 'kraken/base/scaffold/scaffold-model'
+views  = require 'kraken/base/scaffold/scaffold-view'
+exports import models import views
diff --git a/lib/scaffold/scaffold-model.co b/lib/base/scaffold/scaffold-model.co
similarity index 100%
rename from lib/scaffold/scaffold-model.co
rename to lib/base/scaffold/scaffold-model.co
diff --git a/lib/scaffold/scaffold-view.co b/lib/base/scaffold/scaffold-view.co
similarity index 98%
rename from lib/scaffold/scaffold-view.co
rename to lib/base/scaffold/scaffold-view.co
index 4c187f9..b5299bc 100644
--- a/lib/scaffold/scaffold-view.co
+++ b/lib/base/scaffold/scaffold-view.co
@@ -3,7 +3,7 @@ op = require 'kraken/util/op'
 { BaseView,
 }  = require 'kraken/base'
 { Field, FieldList,
-}  = require 'kraken/scaffold/scaffold-model'
+}  = require 'kraken/base/scaffold/scaffold-model'
 
 
 FieldView = exports.FieldView = BaseView.extend do # {{{
diff --git a/lib/chart/chart-option-view.co b/lib/chart/chart-option-view.co
index 1fde054..6c9e2a0 100644
--- a/lib/chart/chart-option-view.co
+++ b/lib/chart/chart-option-view.co
@@ -14,7 +14,7 @@ DEBOUNCE_RENDER = exports.DEBOUNCE_RENDER = 100ms
 ChartOptionView = exports.ChartOptionView = BaseView.extend do # {{{
     tagName   : 'section'
     className : 'chart-option field'
-    template  : require 'kraken/template/chart-option'
+    template  : require 'kraken/template/chart/chart-option'
     
     type : 'string'
     isCollapsed : true
@@ -129,7 +129,7 @@ ChartOptionScaffold = exports.ChartOptionScaffold = BaseView.extend do # {{{
     __bind__       : <[ addField ]>
     tagName        : 'form'
     className      : 'chart-options scaffold'
-    template       : require 'kraken/template/chart-scaffold'
+    template       : require 'kraken/template/chart/chart-scaffold'
     
     collectionType : ChartOptionList
     subviewType    : ChartOptionView
diff --git a/lib/dashboard/dashboard-view.co b/lib/dashboard/dashboard-view.co
index 6fc4d59..fc0658c 100644
--- a/lib/dashboard/dashboard-view.co
+++ b/lib/dashboard/dashboard-view.co
@@ -17,7 +17,7 @@ DashboardView = exports.DashboardView = BaseView.extend do # {{{
     __bind__       : <[  ]>
     tagName        : 'section'
     className      : 'dashboard'
-    template       : require 'kraken/template/dashboard'
+    template       : require 'kraken/template/dashboard/dashboard'
     
     graph_ids : <[
         unique_visitors
diff --git a/lib/dataset/data-view.co b/lib/data/data-view.co
similarity index 95%
rename from lib/dataset/data-view.co
rename to lib/data/data-view.co
index 7201d84..c57eaa8 100644
--- a/lib/dataset/data-view.co
+++ b/lib/data/data-view.co
@@ -4,11 +4,11 @@ Seq = require 'seq'
 { BaseView, ViewList,
 } = require 'kraken/base'
 { DataSetView,
-} = require 'kraken/dataset/dataset-view'
+} = require 'kraken/data/dataset-view'
 { MetricEditView,
-} = require 'kraken/dataset/metric-edit-view'
+} = require 'kraken/data/metric-edit-view'
 { DataSource, 
-} = require 'kraken/dataset/datasource-model'
+} = require 'kraken/data/datasource-model'
 
 /**
  * @class DataSet selection and customization UI (root of the `data` tab).
@@ -17,7 +17,7 @@ DataView = exports.DataView = BaseView.extend do # {{{
     __bind__       : <[ onMetricsChanged ]>
     tagName        : 'section'
     className      : 'data-ui'
-    template       : require 'kraken/template/data'
+    template       : require 'kraken/template/data/data'
     
     datasources : null
     
diff --git a/lib/dataset/dataset-model.co b/lib/data/dataset-model.co
similarity index 98%
rename from lib/dataset/dataset-model.co
rename to lib/data/dataset-model.co
index dfe8aa9..b96480b 100644
--- a/lib/dataset/dataset-model.co
+++ b/lib/data/dataset-model.co
@@ -6,9 +6,9 @@ ColorBrewer = require 'colorbrewer'
 { BaseModel, BaseList,
 } = require 'kraken/base'
 { Metric, MetricList,
-} = require 'kraken/dataset/metric-model'
+} = require 'kraken/data/metric-model'
 { DataSource, DataSourceList,
-} = require 'kraken/dataset/datasource-model'
+} = require 'kraken/data/datasource-model'
 
 
 
diff --git a/lib/dataset/dataset-view.co b/lib/data/dataset-view.co
similarity index 97%
rename from lib/dataset/dataset-view.co
rename to lib/data/dataset-view.co
index bc8189f..4a55a14 100644
--- a/lib/dataset/dataset-view.co
+++ b/lib/data/dataset-view.co
@@ -10,7 +10,7 @@
 DataSetView = exports.DataSetView = BaseView.extend do # {{{
     tagName   : 'section'
     className : 'dataset-ui dataset'
-    template  : require 'kraken/template/dataset'
+    template  : require 'kraken/template/data/dataset'
     
     events:
         'click  .new-metric-button'                     : 'onNewMetric'
@@ -112,7 +112,7 @@ DataSetView = exports.DataSetView = BaseView.extend do # {{{
 DataSetMetricView = exports.DataSetMetricView = BaseView.extend do # {{{
     tagName   : 'tr'
     className : 'dataset-metric metric'
-    template  : require 'kraken/template/dataset-metric'
+    template  : require 'kraken/template/data/dataset-metric'
     
     
     
diff --git a/lib/dataset/datasource-model.co b/lib/data/datasource-model.co
similarity index 98%
rename from lib/dataset/datasource-model.co
rename to lib/data/datasource-model.co
index 19f6bfc..490ede7 100644
--- a/lib/dataset/datasource-model.co
+++ b/lib/data/datasource-model.co
@@ -1,11 +1,11 @@
 { _, op,
 } = require 'kraken/util'
 { TimeSeriesData, CSVData,
-} = require 'kraken/timeseries'
+} = require 'kraken/util/timeseries'
 { BaseModel, BaseList, ModelCache,
 } = require 'kraken/base'
 { Metric, MetricList,
-} = require 'kraken/dataset/metric-model'
+} = require 'kraken/data/metric-model'
 
 
 /**
diff --git a/lib/dataset/datasource-ui-view.co b/lib/data/datasource-ui-view.co
similarity index 97%
rename from lib/dataset/datasource-ui-view.co
rename to lib/data/datasource-ui-view.co
index f40c69b..7f04041 100644
--- a/lib/dataset/datasource-ui-view.co
+++ b/lib/data/datasource-ui-view.co
@@ -12,7 +12,7 @@ DataSourceUIView = exports.DataSourceUIView = BaseView.extend do # {{{
     __bind__       : <[  ]>
     tagName        : 'section'
     className      : 'datasource-ui'
-    template       : require 'kraken/template/datasource-ui'
+    template       : require 'kraken/template/data/datasource-ui'
     
     events :
         'click .datasource-summary'       : 'onHeaderClick'
diff --git a/lib/dataset/datasource-view.co b/lib/data/datasource-view.co
similarity index 86%
rename from lib/dataset/datasource-view.co
rename to lib/data/datasource-view.co
index 57dc290..95e5ee1 100644
--- a/lib/dataset/datasource-view.co
+++ b/lib/data/datasource-view.co
@@ -11,7 +11,7 @@ DataSourceView = exports.DataSourceView = BaseView.extend do # {{{
     __bind__       : <[  ]>
     tagName        : 'section'
     className      : 'datasource'
-    template       : require 'kraken/template/datasource'
+    template       : require 'kraken/template/data/datasource'
     
     
     
diff --git a/lib/data/index.co b/lib/data/index.co
new file mode 100644
index 0000000..df014f4
--- /dev/null
+++ b/lib/data/index.co
@@ -0,0 +1,13 @@
+metric_model       = require 'kraken/data/metric-model'
+metric_edit_view   = require 'kraken/data/metric-edit-view'
+datasource_model   = require 'kraken/data/datasource-model'
+datasource_view    = require 'kraken/data/datasource-view'
+datasource_ui_view = require 'kraken/data/datasource-ui-view'
+dataset_model      = require 'kraken/data/dataset-model'
+dataset_view       = require 'kraken/data/dataset-view'
+data_view          = require 'kraken/data/data-view'
+
+exports import datasource_model import datasource_view  import datasource_ui_view   \
+        import dataset_model    import dataset_view                                 \
+        import metric_model     import metric_edit_view                             \
+                                import data_view
\ No newline at end of file
diff --git a/lib/dataset/metric-edit-view.co b/lib/data/metric-edit-view.co
similarity index 94%
rename from lib/dataset/metric-edit-view.co
rename to lib/data/metric-edit-view.co
index f1b0fef..de4353f 100644
--- a/lib/dataset/metric-edit-view.co
+++ b/lib/data/metric-edit-view.co
@@ -3,9 +3,9 @@
 { BaseView,
 } = require 'kraken/base'
 { Metric,
-} = require 'kraken/dataset/metric-model'
+} = require 'kraken/data/metric-model'
 { DataSourceUIView,
-} = require 'kraken/dataset/datasource-ui-view'
+} = require 'kraken/data/datasource-ui-view'
 
 
 
@@ -17,7 +17,7 @@ MetricEditView = exports.MetricEditView = BaseView.extend do # {{{
     __bind__       : <[ onChange ]>
     tagName        : 'section'
     className      : 'metric-edit-ui'
-    template       : require 'kraken/template/metric-edit'
+    template       : require 'kraken/template/data/metric-edit'
     
     callOnReturnKeypress : 'onChange'
     events:
diff --git a/lib/dataset/metric-model.co b/lib/data/metric-model.co
similarity index 97%
rename from lib/dataset/metric-model.co
rename to lib/data/metric-model.co
index 2757b5b..ac3df80 100644
--- a/lib/dataset/metric-model.co
+++ b/lib/data/metric-model.co
@@ -154,6 +154,6 @@ MetricList = exports.MetricList = BaseList.extend do # {{{
 
 ### FIXME: LOLHACKS ###
 setTimeout do
-    -> { DataSource, DataSourceList, } := require 'kraken/dataset/datasource-model'
+    -> { DataSource, DataSourceList, } := require 'kraken/data/datasource-model'
     10
 
diff --git a/lib/dataset/index.co b/lib/dataset/index.co
deleted file mode 100644
index 56d3e89..0000000
--- a/lib/dataset/index.co
+++ /dev/null
@@ -1,14 +0,0 @@
-metric_model       = require 'kraken/dataset/metric-model'
-metric_view        = require 'kraken/dataset/metric-view'
-metric_edit_view   = require 'kraken/dataset/metric-edit-view'
-datasource_model   = require 'kraken/dataset/datasource-model'
-datasource_view    = require 'kraken/dataset/datasource-view'
-datasource_ui_view = require 'kraken/dataset/datasource-ui-view'
-dataset_model      = require 'kraken/dataset/dataset-model'
-dataset_view       = require 'kraken/dataset/dataset-view'
-data_view          = require 'kraken/dataset/data-view'
-
-exports import metric_model     import metric_view      import metric_edit_view     \
-        import datasource_model import datasource_view  import datasource_ui_view   \
-        import dataset_model    import dataset_view                                 \
-                                import data_view
diff --git a/lib/dataset/metric-view.co b/lib/dataset/metric-view.co
deleted file mode 100644
index e69de29..0000000
diff --git a/lib/graph/graph-display-view.co b/lib/graph/graph-display-view.co
index 3460149..b802f0d 100644
--- a/lib/graph/graph-display-view.co
+++ b/lib/graph/graph-display-view.co
@@ -17,7 +17,7 @@ root = do -> this
 GraphDisplayView = exports.GraphDisplayView = GraphView.extend do # {{{
     tagName   : 'section'
     className : 'graph graph-display'
-    template  : require 'kraken/template/graph-display'
+    template  : require 'kraken/template/graph/graph-display'
     
     events:
         # Select the whole permalink URI text when it receives focus.
diff --git a/lib/graph/graph-edit-view.co b/lib/graph/graph-edit-view.co
index aa260f5..12ef920 100644
--- a/lib/graph/graph-edit-view.co
+++ b/lib/graph/graph-edit-view.co
@@ -8,7 +8,7 @@ _ = require 'kraken/util/underscore'
 { ChartOptionScaffold, DEBOUNCE_RENDER,
 } = require 'kraken/chart'
 { DataView, DataSetView, DataSet,
-} = require 'kraken/dataset'
+} = require 'kraken/data'
 
 root = do -> this
 
@@ -26,7 +26,7 @@ GraphEditView = exports.GraphEditView = GraphView.extend do # {{{
         onFirstClickRenderOptionsTab onFirstClickRenderDataTab
     ]>
     className : 'graph-edit graph'
-    template  : require 'kraken/template/graph-edit'
+    template  : require 'kraken/template/graph/graph-edit'
     
     events:
         'click    .redraw-button'                        : 'stopAndRender'
diff --git a/lib/graph/graph-list-view.co b/lib/graph/graph-list-view.co
index 952845c..14bd007 100644
--- a/lib/graph/graph-list-view.co
+++ b/lib/graph/graph-list-view.co
@@ -19,7 +19,7 @@ GraphListView = exports.GraphListView = BaseView.extend do # {{{
     
     tagName   : 'section'
     className : 'graph-list-view'
-    template  : require 'kraken/template/graph-list'
+    template  : require 'kraken/template/graph/graph-list'
     
     data  : {}
     ready : false
diff --git a/lib/graph/graph-model.co b/lib/graph/graph-model.co
index 0a2e02e..385ad7b 100644
--- a/lib/graph/graph-model.co
+++ b/lib/graph/graph-model.co
@@ -7,7 +7,7 @@ Seq = require 'seq'
 { ChartType,
 } = require 'kraken/chart'
 { DataSet
-} = require 'kraken/dataset'
+} = require 'kraken/data'
 
 root = do -> this
 
diff --git a/lib/main-edit.co b/lib/main-edit.co
index ee463f3..18e21cb 100644
--- a/lib/main-edit.co
+++ b/lib/main-edit.co
@@ -8,7 +8,7 @@ Backbone = require 'backbone'
 { ChartType,
 } = require 'kraken/chart'
 { DataSource, DataSourceList,
-} = require 'kraken/dataset'
+} = require 'kraken/data'
 { Graph, GraphList, GraphEditView,
 } = require 'kraken/graph'
 
diff --git a/lib/scaffold/index.co b/lib/scaffold/index.co
deleted file mode 100644
index d183e5f..0000000
--- a/lib/scaffold/index.co
+++ /dev/null
@@ -1,3 +0,0 @@
-models = require 'kraken/scaffold/scaffold-model'
-views  = require 'kraken/scaffold/scaffold-view'
-exports import models import views
diff --git a/lib/template/chart-option.jade b/lib/template/chart/chart-option.jade
similarity index 98%
rename from lib/template/chart-option.jade
rename to lib/template/chart/chart-option.jade
index 97353f6..ca88b53 100644
--- a/lib/template/chart-option.jade
+++ b/lib/template/chart/chart-option.jade
@@ -1,4 +1,4 @@
-include browser-helpers
+include ../browser-helpers
 - var option_id    = _.domize('option', id)
 
 - var value_id     = _.domize('value', id)
diff --git a/lib/template/chart-scaffold.jade b/lib/template/chart/chart-scaffold.jade
similarity index 100%
rename from lib/template/chart-scaffold.jade
rename to lib/template/chart/chart-scaffold.jade
diff --git a/lib/template/dashboard.jade b/lib/template/dashboard/dashboard.jade
similarity index 100%
rename from lib/template/dashboard.jade
rename to lib/template/dashboard/dashboard.jade
diff --git a/lib/template/data.jade b/lib/template/data/data.jade
similarity index 100%
rename from lib/template/data.jade
rename to lib/template/data/data.jade
diff --git a/lib/template/dataset-metric.jade b/lib/template/data/dataset-metric.jade
similarity index 100%
rename from lib/template/dataset-metric.jade
rename to lib/template/data/dataset-metric.jade
diff --git a/lib/template/dataset.jade b/lib/template/data/dataset.jade
similarity index 100%
rename from lib/template/dataset.jade
rename to lib/template/data/dataset.jade
diff --git a/lib/template/datasource-ui.jade b/lib/template/data/datasource-ui.jade
similarity index 100%
rename from lib/template/datasource-ui.jade
rename to lib/template/data/datasource-ui.jade
diff --git a/lib/template/datasource.jade b/lib/template/data/datasource.jade
similarity index 100%
rename from lib/template/datasource.jade
rename to lib/template/data/datasource.jade
diff --git a/lib/template/metric-edit.jade b/lib/template/data/metric-edit.jade
similarity index 100%
rename from lib/template/metric-edit.jade
rename to lib/template/data/metric-edit.jade
diff --git a/lib/template/graph-display.jade b/lib/template/graph/graph-display.jade
similarity index 96%
rename from lib/template/graph-display.jade
rename to lib/template/graph/graph-display.jade
index 9906e6e..d13f0fd 100644
--- a/lib/template/graph-display.jade
+++ b/lib/template/graph/graph-display.jade
@@ -1,4 +1,4 @@
-include browser-helpers
+include ../browser-helpers
 - var graph_id = view.id
 section.graph-display.graph(id=graph_id)
     
diff --git a/lib/template/graph-edit.jade b/lib/template/graph/graph-edit.jade
similarity index 100%
rename from lib/template/graph-edit.jade
rename to lib/template/graph/graph-edit.jade
diff --git a/lib/template/graph-list.jade b/lib/template/graph/graph-list.jade
similarity index 100%
rename from lib/template/graph-list.jade
rename to lib/template/graph/graph-list.jade
diff --git a/lib/template/index.co b/lib/template/index.co
deleted file mode 100644
index e69de29..0000000
diff --git a/lib/timeseries/index.co b/lib/timeseries/index.co
deleted file mode 100644
index 6fa58c2..0000000
--- a/lib/timeseries/index.co
+++ /dev/null
@@ -1,2 +0,0 @@
-exports.TimeSeriesData = require 'kraken/timeseries/timeseries'
-exports.CSVData        = require 'kraken/timeseries/csv'
diff --git a/lib/timeseries/csv.co b/lib/util/timeseries/csv.co
similarity index 98%
rename from lib/timeseries/csv.co
rename to lib/util/timeseries/csv.co
index 84ef3a3..e89053b 100644
--- a/lib/timeseries/csv.co
+++ b/lib/util/timeseries/csv.co
@@ -1,5 +1,5 @@
 _  = require 'kraken/util/underscore'
-TimeSeriesData = require 'kraken/timeseries/timeseries'
+TimeSeriesData = require 'kraken/util/timeseries/timeseries'
 
 
 DASH_PATTERN       = /-/g
diff --git a/lib/util/timeseries/index.co b/lib/util/timeseries/index.co
new file mode 100644
index 0000000..b583a6b
--- /dev/null
+++ b/lib/util/timeseries/index.co
@@ -0,0 +1,2 @@
+exports.TimeSeriesData = require 'kraken/util/timeseries/timeseries'
+exports.CSVData        = require 'kraken/util/timeseries/csv'
diff --git a/lib/timeseries/timeseries.co b/lib/util/timeseries/timeseries.co
similarity index 100%
rename from lib/timeseries/timeseries.co
rename to lib/util/timeseries/timeseries.co
diff --git a/www/misc/test.co b/www/misc/test.co
index a50dccf..21f3d13 100644
--- a/www/misc/test.co
+++ b/www/misc/test.co
@@ -6,7 +6,7 @@ Backbone = require 'backbone'
 { BaseView, BaseModel, BaseList,
 } = require 'kraken/base'
 { Field, FieldList, FieldView, Scaffold,
-} = require 'kraken/scaffold'
+} = require 'kraken/base/scaffold'
 { ChartType, DygraphsChartType,
   ChartOption, ChartOptionList, TagSet,
   ChartOptionView, ChartOptionScaffold,
diff --git a/www/modules.yaml b/www/modules.yaml
index 9e51454..aba31e8 100644
--- a/www/modules.yaml
+++ b/www/modules.yaml
@@ -46,8 +46,24 @@ dev:
     paths:
     - js:
         - kraken:
+            - template:
+                - chart:
+                    - chart-option.jade
+                    - chart-scaffold.jade
+                - dashboard:
+                    - dashboard.jade
+                - data:
+                    - dataset.jade
+                    - dataset-metric.jade
+                    - metric-edit.jade
+                    - datasource.jade
+                    - datasource-ui.jade
+                    - data.jade
+                - graph:
+                    - graph-display.jade
+                    - graph-edit.jade
+                    - graph-list.jade
             - util:
-                - op
                 - underscore:
                     - array
                     - object
@@ -58,15 +74,20 @@ dev:
                     - ready-emitter
                     - waiting-emitter
                     - index
+                - timeseries:
+                    - timeseries
+                    - csv
+                    - index
+                - op
                 - backbone
                 - parser
                 - cascade
                 - index
-            - timeseries:
-                - timeseries
-                - csv
-                - index
             - base:
+                - scaffold:
+                    - scaffold-model
+                    - scaffold-view
+                    - index
                 - base-mixin
                 - base-model
                 - base-view
@@ -74,33 +95,21 @@ dev:
                 - model-cache
                 - cascading-model
                 - index
-            - scaffold:
-                - scaffold-model
-                - scaffold-view
+            - graph:
+                - graph-model
+                - graph-view
+                - graph-display-view
+                - graph-edit-view
+                - graph-list-view
                 - index
-            - template:
-                - chart-option.jade
-                - chart-scaffold.jade
-                - dataset.jade
-                - dataset-metric.jade
-                - metric.jade
-                - metric-edit.jade
-                - datasource.jade
-                - datasource-ui.jade
-                - data.jade
-                - graph-display.jade
-                - graph-edit.jade
-                - dashboard.jade
-                - graph-list.jade
             - chart:
                 - chart-type
                 - dygraphs
                 - chart-option-view
                 - chart-option-model
                 - index
-            - dataset:
+            - data:
                 - metric-model
-                - metric-view
                 - metric-edit-view
                 - datasource-model
                 - datasource-view
@@ -109,13 +118,6 @@ dev:
                 - dataset-view
                 - data-view
                 - index
-            - graph:
-                - graph-model
-                - graph-view
-                - graph-display-view
-                - graph-edit-view
-                - graph-list-view
-                - index
             - dashboard:
                 - dashboard-model
                 - dashboard-view