repertoire-faceting 0.6.3 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3f493b2c43797a41070532955122147438ad1fd9
-  data.tar.gz: 85ae33e1ca933b3e9b527fad304206f1221daf32
+  metadata.gz: 0c71410502e44435a35e7cf549dda9c78c20419e
+  data.tar.gz: b3f634a720ca6a81836543c9c8dca09a8e108826
 SHA512:
-  metadata.gz: 1d01d1e0bbae61f613f20cac4bf604534ff9a48978077b25961df4d8833ab28275092559b7ae0e3144e09cbf53b7ebe7002c305b1ce1ab41eff37f7715af03a6
-  data.tar.gz: 3a4fa49cd423cd47a8aaf7313d4e83ecf94839958c5ab90c0ff9f07f42bd4140c9d14a72252915c2e16ec4b1860c675817e6a4835c3c9d68f70cf017bc22576f
+  metadata.gz: 36b6cf33096262214ed207969c97065c81c2712ed05aed8d944a36689b44ff4ad70ac19549c6a95867fc71f68c98d0d64fadbe8df3f1f1287912442173ed30ca
+  data.tar.gz: 50358733e4533681470cfef9f93b12337f639e8c9056e068db302fd4ddbb5b0ab550597188707efff7db5fc47b416f40a47b4197594cfe3aee05ff9b7e54879c

data/ext/Makefile

@@ -8,7 +8,7 @@
 #
 #-------------------------------------------------------------------------
 
-API_VERSION = 0.6.3
+API_VERSION = 0.7.0
 
 MODULES = signature/signature
 EXTENSION = signature/faceting \

data/ext/bytea/faceting_bytea.control

@@ -2,5 +2,5 @@
  
 comment = 'API for faceted indexing and queries (based on plv8 + bytea bitmaps)'
 requires = 'plv8, plpgsql'
-default_version = '0.6.3'
+default_version = '0.7.0'
 schema = 'facet'

data/ext/signature/faceting.control

@@ -2,5 +2,5 @@
  
 comment = 'API for faceted indexing and queries (based on custom C bitmap type)'
 requires = plpgsql
-default_version = '0.6.3'
+default_version = '0.7.0'
 schema = 'facet'

data/ext/varbit/faceting_varbit.control

@@ -3,5 +3,5 @@
 comment = 'API for faceted indexing and queries (based on builtin VARBIT bit strings)'
 requires = plpgsql
 superuser = false
-default_version = '0.6.3'
+default_version = '0.7.0'
 schema = 'facet'

data/lib/assets/javascripts/rep.faceting.js

@@ -46,4 +46,5 @@
 //= require ./rep.faceting/facet
 //= require ./rep.faceting/facet_widget
 //= require ./rep.faceting/nested_facet
-//= require ./rep.faceting/results
+//= require ./rep.faceting/results
+//= require ./rep.faceting/urls

data/lib/assets/javascripts/rep.faceting/context.js

@@ -1,6 +1,6 @@
 /*
 * Repertoire faceting ajax widgets
-* 
+*
 * Copyright (c) 2009 MIT Hyperstudio
 * Christopher York, 09/2009
 *
@@ -25,6 +25,8 @@
 
 //= require rep.widgets
 
+//= require deparam
+
 repertoire.facet_context = function(context_name, state_fn, options) {
   var self = repertoire.model(options);
   
@@ -51,6 +53,17 @@ repertoire.facet_context = function(context_name, state_fn, options) {
     }
   };
   
+  //
+  // Update each facet's refinements to the stored values
+  //
+  // If the stored values have no entry for the facet, it is cleared.
+  //
+  self.update_refinements = function(state) {
+    for (var facet in filter) {
+      filter[facet] = state[facet] || [];
+    };
+  };
+
   //
   // Calculate facet value counts from webservice
   //
@@ -61,7 +74,7 @@ repertoire.facet_context = function(context_name, state_fn, options) {
     // package up the faceting state and send back to results rendering service
     self.fetch(self.params(), url, 'json', callback, $elem);
   };
-  
+
   //
   // Update query results from webservice
   //
@@ -72,7 +85,7 @@ repertoire.facet_context = function(context_name, state_fn, options) {
     // package up the faceting state and send back to results rendering service
     self.fetch(self.params(), url, type, callback, $elem);
   };
-  
+
   //
   // Convenience function for constructing faceting urls
   //
@@ -80,9 +93,11 @@ repertoire.facet_context = function(context_name, state_fn, options) {
     var paths = [context_name, action]
     if (facet)
       paths.push(facet)
-    var url = self.default_url(paths, ext);
-    if (params)
-      return url + '?' + self.to_query_string(params);
+    var url = self.default_url(paths, ext),
+        search = '?' + self.to_query_string(params);
+
+    if (search != '?')
+      return url + search
     else
       return url;
   };
@@ -96,22 +111,6 @@ repertoire.facet_context = function(context_name, state_fn, options) {
     return $.extend({}, { filter: self.refinements() }, state);
   };
 
-
-  //
-  // Added to allow facet widgets to pass arguments to context.
-  //
-  // ( Have to revisit with Christopher, it seems like he had an
-  //   pre_update() function in mind for this kind of behavior,
-  //   But I'm not sure how he envisioned it functioning. )
-  //
-  self.update_state = function(new_state) {
-    var current_state = state_fn ? state_fn() : {};
-    state_fn = function () {
-      return $.extend({}, current_state, new_state);
-    }
-  };
-
-
   //
   // Return the identifying name for this context (usually the model class, pluralized)
   //
@@ -134,6 +133,22 @@ repertoire.facet_context = function(context_name, state_fn, options) {
     return values;
   };
   
+  //
+  // Provide a public url describing refinements
+  // (including any additional state defined by client app)
+  //
+  self.url = function() {
+    var url = self.default_url([context_name]),
+        params = self.params(),
+        search = '?' + self.to_query_string(params);
+
+    if (search != '?')
+      return url + search;
+    else
+      return url;
+  }
+
+
   // end of context factory method
   return self;
 }

data/lib/assets/javascripts/rep.faceting/urls.js

@@ -0,0 +1,84 @@
+/*
+* Repertoire faceting ajax widgets
+*
+* Copyright (c) 2014 MIT Hyperstudio
+* Christopher York, 05/2014
+*
+* Requires jquery 1.3.2+
+* Support: Firefox 3+ & Safari 4+.  IE emphatically not supported.
+*
+*
+* Register a faceting context to control the browser's url bar.
+*
+* Handles:
+*       - updating url bar when context changes
+*       - updating context from url bar when user goes back / forward
+*       - updating context from url on initial page load
+*
+* Usage:
+*       - attach this plugin to your faceting context *after* declaring
+*         all facets etc:
+*
+*   $('#nobelists').facet_context(function() {
+*     return { search: $("#search").val() } }
+*   $('.facet').facet();
+*   ...
+*
+*   $('#nobelists').urls(function(json) {
+*     $("#search").val(json.search); }
+*
+*/
+
+//= require deparam
+
+//
+// Set up history tracking
+//
+
+repertoire.urls = function(context, update_state_fn, options) {
+
+  // navigate to a new url whenever facet refinements change
+  context.bind('changed', function(data) {
+    if (!data.rerouting) {
+      history.pushState({}, '', context.url());
+    }
+  });
+
+  // copy refinements out of url when user travels in history
+  window.onpopstate = function (event) {
+    reroute();
+  };
+
+  // bootstrap refinements on page load
+  reroute();
+
+
+  function reroute() {
+    // parse search string
+    var search_string = location.search.substring(1),
+        params = $.deparam(search_string);
+        filter = params.filter || {};
+
+    // copy values into the declared facets
+    context.update_refinements(filter);
+
+    // allow client to update any fields it uses
+    if (update_state_fn)
+      update_state_fn(params);
+
+    // inform views of state change
+    context.trigger('changed', { rerouting : true });
+  }
+}
+
+
+// Urls plugin
+
+$.fn.urls = function(update_state_fn, options) {
+  return this.each(function() {
+    // add locator css class to element, and store faceting context data model in it
+    var $elem = $(this);
+    var context = $elem.data('context');
+    repertoire.urls(context, update_state_fn, $.extend({}, repertoire.defaults, options));
+  });
+};

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

@@ -40,9 +40,10 @@ repertoire.events = function(self, $proxy) {
 
   // wrap jquery's event trigger
   self.trigger = function(type, data) {
+    data = data || {};
     if (handlers[type]) {
       jQuery.each(handlers[type], function() {
-        this.call(self);
+        this.call(self, data);
       })
     }
   };

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

@@ -126,9 +126,9 @@ repertoire.model = function(options) {
         vs.push(self.to_query_string(v, (prefix.length > 0) ? (prefix + '[' + encodeURIComponent(k) + ']') : encodeURIComponent(k)));
       });
       // minor addition to merb: discard empty value lists { e.g. discipline: [] }
-      vs = array_filter(vs, function(x) { return x !== ""; });
+      vs = array_filter(vs, function(x) { return (x !== "") && (x != undefined); });
       return vs.join('&');
-    } else {
+    } else if (value) {
       return prefix + '=' + encodeURIComponent(value);
     }
   };
@@ -136,21 +136,21 @@ repertoire.model = function(options) {
   // Apparently IE doesn't support the filter function? -DD via Brett
   var array_filter = function (thisArray, fun) {
     var len = thisArray.length;
-      if (typeof fun != "function")
-        throw new TypeError();
+    if (typeof fun != "function")
+      throw new TypeError();
 
-      var res = new Array();
-      var thisp = arguments[1];
+    var res = new Array();
+    var thisp = arguments[1];
 
-      for (var i = 0; i < len; i++) {
-        if (i in thisArray) {
-          var val = thisArray[i]; // in case fun mutates this
-          if (fun.call(thisp, val, i, thisArray)) 
-            res.push(val);
-	}
-      }
+    for (var i = 0; i < len; i++) {
+      if (i in thisArray) {
+        var val = thisArray[i]; // in case fun mutates this
+        if (fun.call(thisp, val, i, thisArray))
+          res.push(val);
+	     }
+    }
 
-      return res;
+    return res;
   };
 
     

data/lib/repertoire-faceting/version.rb

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

data/vendor/assets/javascripts/deparam.js

@@ -0,0 +1,97 @@
+/*
+  jQuery deparam is an extraction of the deparam method from Ben Alman's jQuery BBQ
+  http://benalman.com/projects/jquery-bbq-plugin/
+*/
+(function ($) {
+  $.deparam = function (params, coerce) {
+    var obj = {},
+        coerce_types = { 'true': !0, 'false': !1, 'null': null };
+
+    // Iterate over all name=value pairs.
+    $.each(params.replace(/\+/g, ' ').split('&'), function (j,v) {
+      var param = v.split('='),
+          key = decodeURIComponent(param[0]),
+          val,
+          cur = obj,
+          i = 0,
+
+          // If key is more complex than 'foo', like 'a[]' or 'a[b][c]', split it
+          // into its component parts.
+          keys = key.split(']['),
+          keys_last = keys.length - 1;
+
+      // If the first keys part contains [ and the last ends with ], then []
+      // are correctly balanced.
+      if (/\[/.test(keys[0]) && /\]$/.test(keys[keys_last])) {
+        // Remove the trailing ] from the last keys part.
+        keys[keys_last] = keys[keys_last].replace(/\]$/, '');
+
+        // Split first keys part into two parts on the [ and add them back onto
+        // the beginning of the keys array.
+        keys = keys.shift().split('[').concat(keys);
+
+        keys_last = keys.length - 1;
+      } else {
+        // Basic 'foo' style key.
+        keys_last = 0;
+      }
+
+      // Are we dealing with a name=value pair, or just a name?
+      if (param.length === 2) {
+        val = decodeURIComponent(param[1]);
+
+        // Coerce values.
+        if (coerce) {
+          val = val && !isNaN(val)              ? +val              // number
+              : val === 'undefined'             ? undefined         // undefined
+              : coerce_types[val] !== undefined ? coerce_types[val] // true, false, null
+              : val;                                                // string
+        }
+
+        if ( keys_last ) {
+          // Complex key, build deep object structure based on a few rules:
+          // * The 'cur' pointer starts at the object top-level.
+          // * [] = array push (n is set to array length), [n] = array if n is
+          //   numeric, otherwise object.
+          // * If at the last keys part, set the value.
+          // * For each keys part, if the current level is undefined create an
+          //   object or array based on the type of the next keys part.
+          // * Move the 'cur' pointer to the next level.
+          // * Rinse & repeat.
+          for (; i <= keys_last; i++) {
+            key = keys[i] === '' ? cur.length : keys[i];
+            cur = cur[key] = i < keys_last
+              ? cur[key] || (keys[i+1] && isNaN(keys[i+1]) ? {} : [])
+              : val;
+          }
+
+        } else {
+          // Simple key, even simpler rules, since only scalars and shallow
+          // arrays are allowed.
+
+          if ($.isArray(obj[key])) {
+            // val is already an array, so push on the next value.
+            obj[key].push( val );
+
+          } else if (obj[key] !== undefined) {
+            // val isn't an array, but since a second value has been specified,
+            // convert val into an array.
+            obj[key] = [obj[key], val];
+
+          } else {
+            // val is a scalar.
+            obj[key] = val;
+          }
+        }
+
+      } else if (key) {
+        // No value was defined, so set something meaningful.
+        obj[key] = coerce
+          ? undefined
+          : '';
+      }
+    });
+
+    return obj;
+  };
+})(jQuery);

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: repertoire-faceting
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.7.0
 platform: ruby
 authors:
 - Christopher York
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-22 00:00:00.000000000 Z
+date: 2014-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -97,6 +97,7 @@ files:
 - lib/assets/javascripts/rep.faceting/facet_widget.js
 - lib/assets/javascripts/rep.faceting/nested_facet.js
 - lib/assets/javascripts/rep.faceting/results.js
+- lib/assets/javascripts/rep.faceting/urls.js
 - lib/assets/javascripts/rep.protovis-facets.js
 - lib/assets/javascripts/rep.widgets.js
 - lib/assets/javascripts/rep.widgets/events.js
@@ -123,6 +124,7 @@ files:
 - lib/repertoire-faceting/tasks/all.rake
 - lib/repertoire-faceting/tasks/client.rake
 - lib/repertoire-faceting/version.rb
+- vendor/assets/javascripts/deparam.js
 - vendor/assets/javascripts/google-earth-extensions.js
 - vendor/assets/javascripts/protovis.js
 homepage: http://github.com/repertoire/repertoire-faceting