repertoire-faceting 0.5.5 → 0.6.0

data/ext/signature/signature.sql

@@ -0,0 +1,217 @@
+-- ============================================================================
+-- Faceting API implementing bitmap indices using a custom C datatype and
+-- associated functions.
+--
+-- This API is to be preferred in all situations where it is possible to
+-- build and install the datatype (requires superuser access to PostgreSQL)
+--
+-- Christopher York
+-- MIT Hyperstudio
+-- February 2014
+-- ============================================================================
+
+-- complain if script is sourced in psql, rather than via CREATE EXTENSION
+\echo Use "CREATE EXTENSION faceting" to load this the default faceting API.\quit
+
+-- functions for bitmap indices using datatype written in C
+
+CREATE TYPE @extschema@.signature;
+
+-- basic i/o functions for signatures
+
+CREATE FUNCTION @extschema@.sig_in(cstring)
+  RETURNS signature
+  AS 'signature.so', 'sig_in'
+  LANGUAGE C STRICT;
+
+CREATE FUNCTION @extschema@.sig_out(signature)
+  RETURNS cstring
+  AS 'signature.so', 'sig_out'
+  LANGUAGE C STRICT;
+
+-- signature postgresql type
+
+CREATE TYPE @extschema@.signature (
+	INTERNALLENGTH = VARIABLE,
+	INPUT = sig_in,
+	OUTPUT = sig_out,
+	STORAGE = extended
+);
+
+-- functions for signatures
+
+CREATE FUNCTION @extschema@.sig_resize( signature, INT )
+  RETURNS signature
+  AS 'signature.so', 'sig_resize'
+  LANGUAGE C STRICT IMMUTABLE;
+
+CREATE FUNCTION @extschema@.sig_set( signature, INT, INT )
+  RETURNS signature
+  AS 'signature.so', 'sig_set'
+  LANGUAGE C STRICT IMMUTABLE;
+
+CREATE FUNCTION @extschema@.sig_set( signature, INT )
+  RETURNS signature
+  AS 'signature.so', 'sig_set'
+  LANGUAGE C STRICT IMMUTABLE;
+
+CREATE FUNCTION @extschema@.sig_get( signature, INT )
+  RETURNS INT
+  AS 'signature.so', 'sig_get'
+  LANGUAGE C STRICT IMMUTABLE;
+
+CREATE FUNCTION @extschema@.sig_length( signature )
+	RETURNS INT
+	AS 'signature.so', 'sig_length'
+	LANGUAGE C STRICT IMMUTABLE;
+	
+CREATE FUNCTION @extschema@.sig_min( signature )
+	RETURNS INT
+	AS 'signature.so', 'sig_min'
+	LANGUAGE C STRICT IMMUTABLE;
+
+CREATE FUNCTION @extschema@.sig_and( signature, signature )
+  RETURNS signature
+  AS 'signature.so', 'sig_and'
+  LANGUAGE C STRICT IMMUTABLE;	
+
+CREATE FUNCTION @extschema@.sig_or( signature, signature )
+  RETURNS signature
+  AS 'signature.so', 'sig_or'
+  LANGUAGE C STRICT IMMUTABLE;
+
+CREATE FUNCTION @extschema@.sig_xor( signature )
+  RETURNS signature
+  AS 'signature.so', 'sig_xor'
+  LANGUAGE C STRICT IMMUTABLE;
+ 
+CREATE FUNCTION @extschema@.count( signature )
+	RETURNS INT
+	AS 'signature.so', 'count'
+	LANGUAGE C STRICT IMMUTABLE;
+	
+CREATE FUNCTION @extschema@.contains( signature, INT )
+  RETURNS BOOL
+  AS 'signature.so', 'contains'
+  LANGUAGE C STRICT IMMUTABLE;	
+	
+CREATE FUNCTION @extschema@.members( signature )
+  RETURNS SETOF INT
+  AS 'signature.so', 'members'
+  LANGUAGE C STRICT IMMUTABLE;
+  
+CREATE FUNCTION @extschema@.sig_cmp( signature, signature )
+  RETURNS INT
+  AS 'signature.so', 'sig_cmp'
+  LANGUAGE C STRICT IMMUTABLE;
+
+CREATE FUNCTION @extschema@.sig_lt( signature, signature )
+  RETURNS BOOL
+  AS 'signature.so', 'sig_lt'
+  LANGUAGE C STRICT IMMUTABLE;
+ 
+CREATE FUNCTION @extschema@.sig_lte( signature, signature )
+  RETURNS BOOL
+  AS 'signature.so', 'sig_lte'
+  LANGUAGE C STRICT IMMUTABLE;
+
+CREATE FUNCTION @extschema@.sig_eq( signature, signature )
+  RETURNS BOOL
+  AS 'signature.so', 'sig_eq'
+  LANGUAGE C STRICT IMMUTABLE;
+
+CREATE FUNCTION @extschema@.sig_gt( signature, signature )
+  RETURNS BOOL
+  AS 'signature.so', 'sig_gt'
+  LANGUAGE C STRICT IMMUTABLE;
+
+CREATE FUNCTION @extschema@.sig_gte( signature, signature )
+  RETURNS BOOL
+  AS 'signature.so', 'sig_gte'
+  LANGUAGE C STRICT IMMUTABLE;
+
+
+-- operators for signatures
+
+CREATE OPERATOR @extschema@.& (
+    leftarg = signature,
+    rightarg = signature,
+    procedure = @extschema@.sig_and,
+    commutator = &
+);
+
+CREATE OPERATOR @extschema@.| (
+    leftarg = signature,
+    rightarg = signature,
+    procedure = @extschema@.sig_or,
+    commutator = |
+);
+
+CREATE OPERATOR @extschema@.+ (
+    leftarg = signature,
+    rightarg = int,
+    procedure = @extschema@.sig_set
+);
+ 
+CREATE OPERATOR @extschema@.< (
+   leftarg = signature, rightarg = signature, procedure = sig_lt,
+   commutator = > , negator = >= ,
+   restrict = scalarltsel, join = scalarltjoinsel
+);
+
+CREATE OPERATOR @extschema@.<= (
+   leftarg = signature, rightarg = signature, procedure = sig_lte,
+   commutator = >= , negator = > ,
+   restrict = scalarltsel, join = scalarltjoinsel
+);
+
+CREATE OPERATOR @extschema@.= (
+   leftarg = signature, rightarg = signature, procedure = sig_eq,
+   commutator = = , negator = <> ,
+   restrict = eqsel, join = eqjoinsel
+);
+
+CREATE OPERATOR >= (
+   leftarg = signature, rightarg = signature, procedure = sig_gte,
+   commutator = <= , negator = < ,
+   restrict = scalargtsel, join = scalargtjoinsel
+);
+
+CREATE OPERATOR @extschema@.> (
+   leftarg = signature, rightarg = signature, procedure = sig_gt,
+   commutator = < , negator = <= ,
+   restrict = scalargtsel, join = scalargtjoinsel
+);
+
+-- index operator classes for signatures
+
+CREATE OPERATOR CLASS @extschema@.signature_ops
+    DEFAULT FOR TYPE signature USING btree AS
+        OPERATOR        1       < ,
+        OPERATOR        2       <= ,
+        OPERATOR        3       = ,
+        OPERATOR        4       >= ,
+        OPERATOR        5       > ,
+        FUNCTION        1       sig_cmp(signature, signature);
+
+
+-- aggregate functions for faceting
+
+CREATE AGGREGATE @extschema@.collect( signature )
+(
+	sfunc = @extschema@.sig_or,
+	stype = signature
+);
+
+CREATE AGGREGATE @extschema@.filter( signature )
+(
+   sfunc = @extschema@.sig_and,
+   stype = signature
+);
+
+CREATE AGGREGATE @extschema@.signature( INT )
+(
+	sfunc = @extschema@.sig_set,
+	stype = signature,
+  initcond = '0'
+);

data/ext/varbit/faceting_varbit.control

@@ -0,0 +1,7 @@
+# Faceting PostgreSQL extension module
+ 
+comment = 'API for faceted indexing and queries (based on builtin VARBIT bit strings)'
+requires = plpgsql
+superuser = false
+default_version = '0.6.0'
+schema = 'facet'

data/ext/varbit/varbit.sql

@@ -0,0 +1,164 @@
+-- ============================================================================
+-- Faceting API implementing bitmap indices using PostgreSQL's built-in VARBIT
+-- type, processed using the built-in language pl/pgsql.
+--
+-- This API is suitable for deployment on any host, since it requires no
+-- PostgreSQL extensions outside the default install.
+--
+-- However, performance is limited to around 30,000 items in practice (in part
+-- because of unnecessary duplication of varbit values when pl/pgsql evaluates
+-- the count function.)
+--
+-- The 'signature' C-based faceting API is preferable for any install where
+-- you have superuser access to the database.
+--
+-- Christopher York
+-- MIT Hyperstudio
+-- February 2014
+-- ============================================================================
+
+CREATE FUNCTION @extschema@.sig_resize( sig VARBIT, bits INT ) RETURNS VARBIT AS $$
+DECLARE
+  len INT;
+BEGIN
+  len := length(sig);
+  IF bits > len THEN
+    RETURN sig || repeat('0', bits - len)::VARBIT;
+  ELSIF bits < len THEN
+    RETURN substring(sig FROM 1 FOR bits);
+  END IF;
+  RETURN sig;
+END $$ LANGUAGE plpgsql STRICT IMMUTABLE;
+
+CREATE FUNCTION @extschema@.sig_set( sig VARBIT, pos INT, val INT) RETURNS VARBIT AS $$
+DECLARE
+  len INT;
+BEGIN
+  len := length(sig);
+  IF pos >= len THEN
+    IF val > 0 THEN
+      RETURN set_bit(@extschema@.sig_resize(sig, pos+1), pos, 1);
+    ELSE
+      RETURN sig;
+    END IF;
+  ELSE
+    RETURN set_bit(sig, pos, val);
+  END IF;
+END $$ LANGUAGE plpgsql STRICT IMMUTABLE;
+
+CREATE FUNCTION @extschema@.sig_set( sig VARBIT, pos INT) RETURNS VARBIT AS $$
+BEGIN
+  RETURN @extschema@.sig_set(sig, pos, 1);
+END $$ LANGUAGE plpgsql STRICT IMMUTABLE;
+
+CREATE FUNCTION @extschema@.sig_get( sig VARBIT, pos INT ) RETURNS INT AS $$
+DECLARE
+  len INT;
+BEGIN
+  len := length(sig);
+  IF pos >= len THEN
+    RETURN 0;
+  ELSE
+    RETURN get_bit(sig, pos);
+  END IF;
+END $$ LANGUAGE plpgsql STRICT IMMUTABLE;
+
+CREATE FUNCTION @extschema@.sig_length( sig VARBIT ) RETURNS INT AS $$
+BEGIN
+  RETURN length(sig);
+END $$ LANGUAGE plpgsql STRICT IMMUTABLE;
+
+CREATE FUNCTION @extschema@.sig_min( sig VARBIT ) RETURNS INT AS $$
+BEGIN
+  RETURN position('1' in sig) - 1;
+END $$ LANGUAGE plpgsql STRICT IMMUTABLE;
+
+CREATE FUNCTION @extschema@.sig_and( sig1 VARBIT, sig2 VARBIT ) RETURNS VARBIT AS $$
+DECLARE
+  len INT;
+BEGIN
+  len := GREATEST(length(sig1), length(sig2));
+  RETURN bitand(@extschema@.sig_resize(sig1, len), @extschema@.sig_resize(sig2, len)) ;
+END $$ LANGUAGE plpgsql STRICT IMMUTABLE;
+
+CREATE FUNCTION @extschema@.sig_or( sig1 VARBIT, sig2 VARBIT ) RETURNS VARBIT AS $$
+DECLARE
+  len INT;
+BEGIN
+  len := GREATEST(length(sig1), length(sig2));
+  RETURN bitor(@extschema@.sig_resize(sig1, len), @extschema@.sig_resize(sig2, len)) ;
+END $$ LANGUAGE plpgsql STRICT IMMUTABLE;
+
+CREATE FUNCTION @extschema@.sig_xor( sig1 VARBIT, sig2 VARBIT ) RETURNS VARBIT AS $$
+DECLARE
+  len INT;
+BEGIN
+  len := GREATEST(length(sig1), length(sig2));
+  RETURN bitxor(@extschema@.sig_resize(sig1, len), @extschema@.sig_resize(sig2, len)) ;
+END $$ LANGUAGE plpgsql STRICT IMMUTABLE;
+
+CREATE FUNCTION @extschema@.count( sig VARBIT ) RETURNS INT AS $$
+BEGIN
+  -- This is, by any measure, horrific. However, it appears to be the only 
+  -- way to use PostgreSQL built in functions to count bits in a bit string.
+  RETURN length(replace(sig::TEXT, '0', ''));
+END $$ LANGUAGE plpgsql STRICT IMMUTABLE;
+
+CREATE FUNCTION @extschema@.contains( sig VARBIT, pos INT ) RETURNS BOOL AS $$
+BEGIN
+  RETURN @extschema@.sig_get(sig, pos) = 1;
+END $$ LANGUAGE plpgsql STRICT IMMUTABLE;
+
+CREATE FUNCTION @extschema@.members( sig VARBIT ) RETURNS SETOF INT AS $$
+BEGIN
+  FOR i IN 0 .. length(sig) - 1 LOOP
+    IF @extschema@.contains(sig, i) THEN
+      RETURN NEXT i;
+    END IF;
+  END LOOP;
+END $$ LANGUAGE plpgsql STRICT IMMUTABLE;
+
+
+-- operators for faceting
+
+CREATE OPERATOR @extschema@.& (
+    leftarg = VARBIT,
+    rightarg = VARBIT,
+    procedure = @extschema@.sig_and,
+    commutator = &
+);
+
+CREATE OPERATOR @extschema@.| (
+    leftarg = VARBIT,
+    rightarg = VARBIT,
+    procedure = @extschema@.sig_or,
+    commutator = |
+);
+
+CREATE OPERATOR @extschema@.+ (
+    leftarg = VARBIT,
+    rightarg = int,
+    procedure = @extschema@.sig_set
+);
+
+
+-- aggregate functions for faceting
+
+CREATE AGGREGATE @extschema@.collect( VARBIT )
+(
+	sfunc = @extschema@.sig_or,
+	stype = VARBIT
+);
+
+CREATE AGGREGATE @extschema@.filter( VARBIT )
+(
+   sfunc = @extschema@.sig_and,
+   stype = VARBIT
+);
+
+CREATE AGGREGATE @extschema@.signature( INT )
+(
+	sfunc = @extschema@.sig_set,
+  stype = VARBIT,
+  initcond = '0'
+);

data/{public → lib/assets}/javascripts/rep.faceting/context.js

@@ -21,9 +21,9 @@
 *       - hooks for managing custom data
 */
 
-//= require <jquery>
+//= require jquery
 
-//= require <rep.widgets>
+//= require rep.widgets
 
 repertoire.facet_context = function(context_name, state_fn, options) {
   var self = repertoire.model(options);

data/{public → lib/assets}/javascripts/rep.faceting/ext/earth_facet.js

@@ -24,11 +24,9 @@
 *     None are required.
 */
 
-//= require "../facet"
+//= require ../facet
 
-//= provide "../../../images/repertoire-faceting/proportional_symbol.png"
-
-//= require <google-earth-extensions>
+//= require google-earth-extensions
 
 
 // bootstrap Google Earth API

data/{public → lib/assets}/javascripts/rep.faceting/facet.js

@@ -21,7 +21,7 @@
 *     None are required.
 */
 
-//= require "facet_widget"
+//= require ./facet_widget
 
 
 repertoire.facet = function($facet, options) {

data/{public → lib/assets}/javascripts/rep.faceting/facet_widget.js

@@ -28,15 +28,10 @@
 * See the documentation for these methods for more details.
 */
 
-//= require <jquery>
-
-//= require <rep.widgets>
-
-//= require "context"
-
-//= require "../../stylesheets/rep.faceting.css"
-//= provide "../../images/**/*"
+//= require jquery
 
+//= require rep.widgets
+//= require ./context
 
 repertoire.facet_widget = function($widget, options) {
   var self = repertoire.widget($widget, options);

data/{public → lib/assets}/javascripts/rep.faceting/nested_facet.js

@@ -20,7 +20,7 @@
 *     None are required.
 */
 
-//= require "facet_widget"
+//= require ./facet_widget
 
 repertoire.nested_facet = function($facet, options) {
   // inherit complete facet-value-count widget behaviour

data/{public → lib/assets}/javascripts/rep.faceting/results.js

@@ -19,7 +19,7 @@
 *           None are required.
 */
 
-//= require "facet_widget"
+//= require ./facet_widget
 
 
 repertoire.results = function($results, options) {

data/{public → lib/assets}/javascripts/rep.faceting.js

@@ -42,4 +42,8 @@
 * TODO. can the css for this module be namespaced?
 */
 
-//= require "rep.faceting/*"
+//= require ./rep.faceting/context
+//= require ./rep.faceting/facet
+//= require ./rep.faceting/facet_widget
+//= require ./rep.faceting/nested_facet
+//= require ./rep.faceting/results

data/{public → lib/assets}/javascripts/rep.protovis-facets.js

@@ -13,9 +13,9 @@
 *      since Safari doesn't support them.
 */
 
-//= require <jquery>
-//= require "rep.faceting"
-//= require "protovis"
+//= require jquery
+//= require ./rep.faceting
+//= require protovis
 
 (function($) {
 

data/lib/assets/javascripts/rep.widgets/events.js

@@ -0,0 +1,51 @@
+/*
+* Repertoire abstract event model, for use with widget model
+*
+* Copyright (c) 2009 MIT Hyperstudio
+* Christopher York, 11/2009
+*
+* Requires jquery 1.3.2+
+* Support: Firefox 3+ & Safari 4+.  IE emphatically not supported.
+*/
+
+//
+// Mixin that adds functionality for event listening to an arbitrary javascript object.
+//
+// API is the similar to jquery's bind, unbind, and trigger - except that events cannot be
+//     namespaced.
+//
+// N.B. This is not a true event dispatch system: there is no event object, just callbacks.
+//      Implementation may change.
+//
+repertoire.events = function(self, $proxy) {
+  
+  var handlers = {};
+
+  // mimic jquery's event bind
+  self.bind = function(type, fn) {
+    if (!handlers[type])
+      handlers[type] = [];
+      
+    handlers[type].push(fn);
+  };
+  
+  // mimic jquery's event unbind
+  self.unbind = function(type, fn) {
+    if (handlers[type]) {
+      handlers[type] = jQuery.grep(handlers[type], function(h) {
+        return h !== fn;
+      });
+    }
+  };
+
+  // wrap jquery's event trigger
+  self.trigger = function(type, data) {
+    if (handlers[type]) {
+      jQuery.each(handlers[type], function() {
+        this.call(self);
+      })
+    }
+  };
+  
+  return self;
+};

data/lib/assets/javascripts/rep.widgets/global.js

@@ -0,0 +1,50 @@
+/*
+* Repertoire abstract ajax widget
+*
+* Copyright (c) 2009 MIT Hyperstudio
+* Christopher York, 09/2009
+*
+* Requires jquery 1.3.2+
+* Support: Firefox 3+ & Safari 4+.  IE emphatically not supported.
+*/
+
+// claim a single global namespace, 'repertoire'
+repertoire = {};
+
+// Global defaults inherited by all widgets
+//
+// Options:
+//   path_prefix - prefix to add before all generated urls
+//
+repertoire.defaults = {
+  path_prefix: ''
+};
+
+//
+// Generates a jquery plugin that attaches a widget instance to each matched element
+// and exposes plugin defaults.
+//
+// N.B. This method is currently only in use in the faceting module, and may be deprecated.
+//
+// Usage:
+//    $.fn.my_widget = repertoire.plugin(my_widget);
+//    $.fn.my_widget.defaults = { /* widget option defaults */ };
+//
+repertoire.plugin = function(self) {
+  var fn = function(options) {
+    return this.each(function() {
+      var settings = $.extend({}, repertoire.defaults, fn.defaults, html_options($(this)), options);
+      self($(this), settings).initialize();
+    });
+  };
+  fn.defaults = { };
+  return fn;
+
+  // helper: default widget name and title options from dom
+  function html_options($elem) {
+    return {
+      name: $elem.attr('id'),
+      title: $elem.attr('title')
+    };
+  }
+};