repertoire-faceting 0.5.3 → 0.5.4

data/ext/signature.sql

@@ -0,0 +1,342 @@
+SET search_path TO 'public';
+
+CREATE TYPE signature;
+
+-- basic i/o functions for signatures
+
+CREATE OR REPLACE FUNCTION sig_in(cstring)
+  RETURNS signature
+  AS 'signature.so', 'sig_in'
+  LANGUAGE C STRICT;
+
+CREATE OR REPLACE FUNCTION sig_out(signature)
+  RETURNS cstring
+  AS 'signature.so', 'sig_out'
+  LANGUAGE C STRICT;
+
+-- signature postgresql type
+
+CREATE TYPE signature (
+	INTERNALLENGTH = VARIABLE,
+	INPUT = sig_in,
+	OUTPUT = sig_out,
+	STORAGE = extended
+);
+
+-- functions for signatures
+
+CREATE OR REPLACE FUNCTION sig_resize( signature, INT )
+  RETURNS signature
+  AS 'signature.so', 'sig_resize'
+  LANGUAGE C STRICT IMMUTABLE;
+
+CREATE OR REPLACE FUNCTION sig_set( signature, INT, INT )
+  RETURNS signature
+  AS 'signature.so', 'sig_set'
+  LANGUAGE C STRICT IMMUTABLE;
+
+CREATE OR REPLACE FUNCTION sig_set( signature, INT )
+  RETURNS signature
+  AS 'signature.so', 'sig_set'
+  LANGUAGE C STRICT IMMUTABLE;
+
+CREATE OR REPLACE FUNCTION sig_get( signature, INT )
+  RETURNS INT
+  AS 'signature.so', 'sig_get'
+  LANGUAGE C STRICT IMMUTABLE;
+
+CREATE OR REPLACE FUNCTION sig_length( signature )
+	RETURNS INT
+	AS 'signature.so', 'sig_length'
+	LANGUAGE C STRICT IMMUTABLE;
+	
+CREATE OR REPLACE FUNCTION sig_min( signature )
+	RETURNS INT
+	AS 'signature.so', 'sig_min'
+	LANGUAGE C STRICT IMMUTABLE;
+
+CREATE OR REPLACE FUNCTION sig_and( signature, signature )
+  RETURNS signature
+  AS 'signature.so', 'sig_and'
+  LANGUAGE C STRICT IMMUTABLE;	
+
+CREATE OR REPLACE FUNCTION sig_or( signature, signature )
+  RETURNS signature
+  AS 'signature.so', 'sig_or'
+  LANGUAGE C STRICT IMMUTABLE;
+
+CREATE OR REPLACE FUNCTION sig_xor( signature )
+  RETURNS signature
+  AS 'signature.so', 'sig_xor'
+  LANGUAGE C STRICT IMMUTABLE;
+ 
+CREATE OR REPLACE FUNCTION count( signature )
+	RETURNS INT
+	AS 'signature.so', 'count'
+	LANGUAGE C STRICT IMMUTABLE;
+	
+CREATE OR REPLACE FUNCTION contains( signature, INT )
+  RETURNS BOOL
+  AS 'signature.so', 'contains'
+  LANGUAGE C STRICT IMMUTABLE;	
+	
+CREATE OR REPLACE FUNCTION members( signature )
+RETURNS SETOF INT
+AS 'signature.so', 'members'
+LANGUAGE C STRICT IMMUTABLE;
+  
+CREATE OR REPLACE FUNCTION sig_cmp( signature, signature )
+  RETURNS INT
+  AS 'signature.so', 'sig_cmp'
+  LANGUAGE C STRICT IMMUTABLE;
+
+CREATE OR REPLACE FUNCTION sig_lt( signature, signature )
+  RETURNS BOOL
+  AS 'signature.so', 'sig_lt'
+  LANGUAGE C STRICT IMMUTABLE;
+ 
+CREATE OR REPLACE FUNCTION sig_lte( signature, signature )
+  RETURNS BOOL
+  AS 'signature.so', 'sig_lte'
+  LANGUAGE C STRICT IMMUTABLE;
+
+CREATE OR REPLACE FUNCTION sig_eq( signature, signature )
+  RETURNS BOOL
+  AS 'signature.so', 'sig_eq'
+  LANGUAGE C STRICT IMMUTABLE;
+
+CREATE OR REPLACE FUNCTION sig_gt( signature, signature )
+  RETURNS BOOL
+  AS 'signature.so', 'sig_gt'
+  LANGUAGE C STRICT IMMUTABLE;
+
+CREATE OR REPLACE FUNCTION sig_gte( signature, signature )
+  RETURNS BOOL
+  AS 'signature.so', 'sig_gte'
+  LANGUAGE C STRICT IMMUTABLE;
+
+-- operators for signatures
+
+CREATE OPERATOR & (
+    leftarg = signature,
+    rightarg = signature,
+    procedure = sig_and,
+    commutator = &
+);
+
+CREATE OPERATOR | (
+    leftarg = signature,
+    rightarg = signature,
+    procedure = sig_or,
+    commutator = |
+);
+
+CREATE OPERATOR + (
+    leftarg = signature,
+    rightarg = int,
+    procedure = sig_set
+);
+ 
+CREATE OPERATOR < (
+   leftarg = signature, rightarg = signature, procedure = sig_lt,
+   commutator = > , negator = >= ,
+   restrict = scalarltsel, join = scalarltjoinsel
+);
+
+CREATE OPERATOR <= (
+   leftarg = signature, rightarg = signature, procedure = sig_lte,
+   commutator = >= , negator = > ,
+   restrict = scalarltsel, join = scalarltjoinsel
+);
+
+CREATE OPERATOR = (
+   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 > (
+   leftarg = signature, rightarg = signature, procedure = sig_gt,
+   commutator = < , negator = <= ,
+   restrict = scalargtsel, join = scalargtjoinsel
+);
+
+-- index operator classes for signatures
+
+CREATE OPERATOR CLASS 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 signature( INT )
+(
+	sfunc = sig_set,
+	stype = signature,
+  initcond = '0'
+);
+
+CREATE AGGREGATE collect( signature )
+(
+	sfunc = sig_or,
+	stype = signature
+);
+
+CREATE AGGREGATE filter( signature )
+(
+   sfunc = sig_and,
+   stype = signature
+);
+
+-- utility functions for maintaining facet indices
+
+-- Utility function to drop and recreate a table, given an sql select statement
+--
+CREATE OR REPLACE FUNCTION recreate_table(tbl TEXT, select_expr TEXT) RETURNS VOID AS $$
+BEGIN
+  SET client_min_messages = warning;
+  EXECUTE 'DROP TABLE IF EXISTS ' || quote_ident(tbl);
+  EXECUTE 'CREATE TABLE ' || quote_ident(tbl) || ' AS ' || select_expr;
+  RESET client_min_messages;
+END;
+$$ LANGUAGE plpgsql;
+
+
+-- Utility function to add or update a packed id column on a table
+-- 
+-- If provided, the threshold indicates a percentage of acceptable wastage or "scatter" 
+-- in the ids, which keeps the packing algorithm from running until absolutely needed.
+-- 
+-- Because ids only become scattered when model rows are deleted, this means repacking
+-- will occur very infrequently.  The default threshold is 15%.
+--
+CREATE OR REPLACE FUNCTION renumber_table(tbl TEXT, col TEXT) RETURNS BOOLEAN AS $$
+BEGIN
+  RETURN renumber_table(tbl, col, 0.15);
+END;
+$$ LANGUAGE plpgsql;
+
+
+CREATE OR REPLACE FUNCTION renumber_table(tbl TEXT, col TEXT, threshold REAL) RETURNS BOOLEAN AS $$
+DECLARE
+  seq TEXT;
+  wastage REAL;
+  renumber BOOLEAN;
+BEGIN
+  seq = tbl || '_' || col || '_seq';
+
+  -- Drop numbered column if it already exists
+  SET client_min_messages = 'WARNING';
+  BEGIN
+    IF signature_wastage(tbl, col) <= threshold THEN
+      renumber := false;
+    ELSE
+      renumber := true;
+      EXECUTE 'DROP INDEX IF EXISTS ' || quote_ident(tbl || '_' || col || '_ndx');
+      EXECUTE 'ALTER TABLE ' || quote_ident(tbl) || ' DROP COLUMN ' || quote_ident(col);
+      EXECUTE 'DROP SEQUENCE IF EXISTS ' || quote_ident(seq);
+    END IF;
+  EXCEPTION
+    WHEN undefined_column THEN renumber := true;
+  END;
+  RESET client_min_messages;
+
+  --  Create numbered column & its index
+  IF renumber THEN
+    EXECUTE 'CREATE SEQUENCE ' || quote_ident(seq) || ' MINVALUE 0 ';
+    EXECUTE 'ALTER TABLE ' || quote_ident(tbl) || ' ADD COLUMN ' || quote_ident(col) || ' INT4 DEFAULT nextval(''' || quote_ident(seq) || ''')';
+    EXECUTE 'ALTER SEQUENCE ' || quote_ident(seq) || ' OWNED BY ' || quote_ident(tbl) || '.' || quote_ident(col);
+    EXECUTE 'CREATE INDEX ' || quote_ident(tbl || '_' || col || '_ndx') || ' ON ' || quote_ident(tbl) || '(' || col || ')';
+  END IF;
+
+  RETURN renumber;
+END;
+$$ LANGUAGE plpgsql;
+
+
+-- Utility function to measure how many bits from a loosely-packed id column would be wasted,
+-- if they were all collected into a bitset signature. Returns a float between 0 (no waste) 
+-- and 1.0 (all waste).
+--
+CREATE OR REPLACE FUNCTION signature_wastage(tbl TEXT, col TEXT) RETURNS REAL AS $$
+DECLARE
+  max REAL;
+  count REAL;
+BEGIN
+  EXECUTE 'SELECT count(*) FROM ' || quote_ident(tbl)
+          INTO count;
+  EXECUTE 'SELECT max(' || quote_ident(col) || ') FROM ' || quote_ident(tbl)
+          INTO max;
+  RETURN 1.0 - (count / (COALESCE(max, 0) + 1));
+END;
+$$ LANGUAGE plpgsql;
+
+
+-- Utility function to identify columns for a nested facet index
+--
+CREATE OR REPLACE FUNCTION nest_levels(tbl TEXT) RETURNS SETOF TEXT AS $$
+  SELECT quote_ident(a.attname::TEXT)
+    FROM pg_attribute a LEFT JOIN pg_attrdef d ON a.attrelid = d.adrelid AND a.attnum = d.adnum
+    WHERE a.attrelid = $1::regclass
+      AND NOT a.attname IN ('signature', 'level')
+      AND a.attnum > 0 AND NOT a.attisdropped
+    ORDER BY a.attnum;
+$$ LANGUAGE sql;
+
+
+--Utility function to expand nesting in facet indices
+--
+-- Initially a facet index will include only leaves of the
+-- nesting tree.  This function adds all interior nodes
+-- with their respective aggregate signatures, and adds a
+-- postgresql index to the nested facet value.
+--
+-- e.g. given the nested facet values
+--  {USA,Florida}  '10'
+--  {USA,Iowa}     '01'
+--
+-- the function interpolates
+--  {USA}          '11'
+--
+-- N.B. expand_nesting may only be called once on a table
+--      it refuses to add internal node duplicates
+--
+CREATE OR REPLACE FUNCTION expand_nesting(tbl TEXT) RETURNS VOID AS $$
+DECLARE
+  cols  TEXT[];
+  len   INT;
+  aggr  TEXT;
+BEGIN
+  -- determine column names
+  SELECT array_agg(col) INTO cols FROM nest_levels(tbl) AS col;
+  len := array_length(cols, 1);
+  
+  -- add unique index on facet value columns
+  aggr := array_to_string(cols, ', ');
+  EXECUTE 'CREATE UNIQUE INDEX ' || quote_ident(tbl) || '_ndx  ON ' || quote_ident(tbl) || '(' || aggr || ')';
+    
+  -- expand each level in turn
+  FOR i IN REVERSE (len-1)..1 LOOP
+    aggr := array_to_string(cols[1:i], ', ');
+    EXECUTE 'INSERT INTO ' || quote_ident(tbl) || '(' || aggr || ', level, signature)'
+         || ' SELECT ' || aggr || ', ' || i || ' AS level, collect(signature)'
+         || ' FROM ' || quote_ident(tbl)
+         || ' GROUP BY ' || aggr;
+  END LOOP;
+  
+  -- root node
+  EXECUTE 'INSERT INTO ' || quote_ident(tbl) || '(level, signature)'
+       || ' SELECT 0 AS level, collect(signature) FROM ' || quote_ident(tbl);
+END;
+$$ LANGUAGE plpgsql;

data/ext/uninstall_signature.sql

@@ -0,0 +1,4 @@
+-- Adjust this setting to control where the objects get dropped.
+SET search_path = public;
+
+DROP TYPE signature CASCADE;

data/lib/repertoire-faceting/version.rb

@@ -1,5 +1,5 @@
 module Repertoire
   module Faceting #:nodoc:
-    VERSION = "0.5.3"
+    VERSION = "0.5.4"
   end
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 5
-  - 3
-  version: 0.5.3
+  - 4
+  version: 0.5.4
 platform: ruby
 authors: 
 - Christopher York
@@ -14,12 +14,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-03 00:00:00 +00:00
+date: 2010-11-18 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: repertoire-assets
-  prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -31,10 +30,10 @@ dependencies:
         - 0
         version: 0.2.0
   type: :runtime
+  prerelease: false
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: rep.jquery
-  prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -42,14 +41,14 @@ dependencies:
       - !ruby/object:Gem::Version 
         segments: 
         - 1
+        - 4
         - 3
-        - 2
-        version: 1.3.2
+        version: 1.4.3
   type: :runtime
+  prerelease: false
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: rep.ajax.toolkit
-  prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -61,10 +60,10 @@ dependencies:
         - 0
         version: 0.3.0
   type: :runtime
+  prerelease: false
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: rails
-  prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -72,14 +71,14 @@ dependencies:
       - !ruby/object:Gem::Version 
         segments: 
         - 3
-        - 1
         - 0
-        version: 3.1.0
+        - 3
+        version: 3.0.3
   type: :runtime
+  prerelease: false
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: pg
-  prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -91,6 +90,7 @@ dependencies:
         - 0
         version: 0.9.0
   type: :runtime
+  prerelease: false
   version_requirements: *id005
 description: Repertoire-faceting adds scalable facet indexing, ajax facet widgets, and extras like GIS facets to Rails 3
 email: 
@@ -106,7 +106,10 @@ files:
 - ext/Makefile
 - ext/README.signature
 - ext/signature.c
+- ext/signature.so
+- ext/signature.sql
 - ext/signature.sql.IN
+- ext/uninstall_signature.sql
 - ext/uninstall_signature.sql.IN
 - lib/repertoire-faceting/adapters/abstract_adapter.rb
 - lib/repertoire-faceting/adapters/postgresql_adapter.rb
@@ -160,6 +163,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 1982922249327133464
       segments: 
       - 0
       version: "0"