TODO

DESIRED FEATURES / IMPROVEMENTS.

-- mysql support
   [ design: mysql has a count function and bitwise operators for blobs.
     Adding support is a matter of defining the adapter and moving signature()
     calls into the postgresql adapter ]

-- modify widgets to multiplex ajax calls to work around 2 call limit
   in many browsers
   [ design: fetch() queues ajax calls; update() implementations request
     queue  and merge current webservice call with ones already in the queue.
     on controller side, receive multiple facet names, iterate, and bundle.
     fetch() then unbundles the results can dispatches them to appropriate
     callbacks ]


TODO

-- adapter tests for existence of materialized views too often
-- need a way to merge version number into etags?

-- add info on CORS to FAQ                                      DONE
-- ensure pushState respects repertoire.defaults.path_prefix    DONE

-- gemcutter release of new faceting gem
-- revise example app to bundle gem                             DONE
--   redeploy to bytea / varbit targets                         DONE

-- reference to the ActiveRecord API in the README              DONE
-- revise the README to describe API layers & use               DONE

-- clean up population in postgresql adapter?                   NO
-- clean up throughout the facet definitions                    PARTIAL
-- test harness
   - test all extensions in order, skipping if cannot load      DONE
-- simplify the in-database API
   - use materialized views instead of dropping and adding tables   DONE
   - move signature_wastage into an aggregate function          DONE
   - remove the renumber function                               DONE
   - the only remaining function should be expand_nesting       MOVED
-- Makefile is verbose; use patterns                            NO
- check formatting of all docs                                 DONE
- make rake tasks smarter about detecting whether to run       NOT NECESSARY
- make rake tasks automatically choose task dep on db type     NOT TO DO
- make sure example app can be set up and deployed via rake    DONE

- README
  * recipe for running tests                                    DONE
  * deployment
  * recipe for adding facets to new app                         DONE
  * declaring facets                                            DONE
  * faceting db api                                             DONE
  * installing postgresql extensions                            DONE
  * migrations for indexing                                     DONE
  * updating indices (a) postgresql-crontab (b) rake crontab    DONE
- generate routes that don't conflict with resource routes
  (rails thinks /nobelists/results is the nobelist named 'results')	  NOT TO DO
- FAQ
  * "not grouped error"
  * migrations and facet decls
  * facet plugin registration (and multiple claims)

- repertoire-assets loaded automatically          DONE
- figure out the faceting context state default   DONE

- get rid of annoying load warnings on test       KNOWN ISSUE
- cannot refine on null values in facets          KNOWN ISSUE

- integration with postgresql crontab
- push compiled gems to gemcutter                 DONE (EXCEPT FACETING)

- check nested indexed facet queries              DONE
- test harness: unindexed / indexed for same test DONE

- optimize count query: (a) empty base query      DONE
                        (b) join masks rather than looping  NOT NECESSARY

- working on rails 3.0.1?                         NOT POSSIBLE
- citizens example                                DONE
- final level of nested faceting ~1 value         DONE
- birth_decade has a null value                   DONE
- sorting extension facet example not working     DONE
- final level of nested faceting ~1 value         DONE
- birth_decade has a null value                   DONE


- indexed nested facet widget not working         DONE
- factor out facet functionality from relation    DONE
- not obeying orders for synthesized facets       DONE
- auto-generated groups scan all joined tables    NOT NECESSARY
- allow facet defs in method bodies               KNOWN ISSUE RAILS 3

- calculated relations conflict with table names  DONE
- pluggable facet implementations                 DONE
- results from indexes                            DONE
- nested faceting not working                     DONE
- remove mysql references in test suite           DONE
- run all tests indexed and unindexed             DONE
- migrations for facet indexes                    DONE
- indexed counts                                  DONE
- mix indexed and non-indexed                     DONE
- test cases running in 'training wheels' mode    DONE
- controller mixin with counts/results            DONE
- routes extensions                               DONE
- get ride of annoying load warnings			  DONE - MUST REDO
- get core examples working                       DONE
- 'training wheels' using plain-jane SQL          DONE
- facets should inherit scope                     DONE
- install procedure for new app                   DONE
  * arrange to load without a generator/config file         DONE
  * check rake tasks load when installed in an app          DONE
- system for checking presence of indexes         DONE
- adapter for running indexed counts/queries      DONE
- sort mode option built in to widget           NOT TO DO
- minimum option built in to widget             NOT TO DO
- widgets multiplex calls to count              NOT TO DO
- rake task to update all indices               NOT TO DO
- rake task to verify all indices               NOT TO DO
- mysql for 'training wheels'                   NOT TO DO
- mysql adapter for indexing                    NOT TO DO
- rake task to install postgresql extensions                DONE
- new method: relation.facet[:name] ...  finds the facet relation, merges with current one, and returns result          DONE
- sorting defaults                                          NOT TO DO
- prettier output for raw facet relations in to_s           NOT TO DO [ db dependent ]