repertoire-faceting 0.7.0 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0c71410502e44435a35e7cf549dda9c78c20419e
-  data.tar.gz: b3f634a720ca6a81836543c9c8dca09a8e108826
+  metadata.gz: 5d3aadcd08762f8d0eb82f1b0a0a91f5866836f2
+  data.tar.gz: 3261f97f7058932bd1e0a1a424b2c869903b8c8f
 SHA512:
-  metadata.gz: 36b6cf33096262214ed207969c97065c81c2712ed05aed8d944a36689b44ff4ad70ac19549c6a95867fc71f68c98d0d64fadbe8df3f1f1287912442173ed30ca
-  data.tar.gz: 50358733e4533681470cfef9f93b12337f639e8c9056e068db302fd4ddbb5b0ab550597188707efff7db5fc47b416f40a47b4197594cfe3aee05ff9b7e54879c
+  metadata.gz: 1a6e1019f798bc2356afab1e5a2eec80b8dd289591a27095da38e296f86ea5c771008fb367be4869bab1ef2c1c2d009052c5a5c1cab55c93a4811dc35da1f705
+  data.tar.gz: d897d8d5aa4ba04e747d46b81a2fb1dc05451991f6c0222a8cdae1fefa1269cea2b8575c4b90b690c1543fbea5e014b18746d8fb0ed9bb3664b4bd7c9228a721

data/FAQ

@@ -45,6 +45,34 @@
 == About the ajax faceting widgets
 
 
+*Q* How to access the faceting API from a client on a different origin.
+
+*A* This is easily done. Configure your rails project to accept CORS ajax GET requests, then configure the API server
+    name in repertoire.defaults.path_prefix :
+
+    $().ready(function() {
+      repertoire.defaults = { path_prefix: '<YOUR API SERVER>' };
+      ...
+
+    For future reference, here is how to enable CORS for rails. In your GEMFILE:
+
+      gem 'rack-cors', :require => 'rack/cors'
+
+    In your config.rb:
+
+      require 'rack/cors'
+      use Rack::Cors do
+
+        # allow get requests from all origins
+        allow do
+          origins '*'
+          resource '*',
+              :headers => :any,
+              :methods => [:get, :options]
+        end
+      end
+
+
 *Q* Rails is sending JSON data in a format that my javascript widgets don't understand.
 
 *A* Put the following line in config/application.rb:

data/TODO

@@ -16,6 +16,9 @@ DESIRED FEATURES / IMPROVEMENTS.
 
 TODO
 
+-- 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

data/ext/Makefile

@@ -8,7 +8,7 @@
 #
 #-------------------------------------------------------------------------
 
-API_VERSION = 0.7.0
+API_VERSION = 0.7.2
 
 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.7.0'
+default_version = '0.7.2'
 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.7.0'
+default_version = '0.7.2'
 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.7.0'
+default_version = '0.7.2'
 schema = 'facet'

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

@@ -64,6 +64,16 @@ repertoire.facet_context = function(context_name, state_fn, options) {
     };
   };
 
+  //
+  // Register a facet in this context.
+  //
+  // Necessary so context knows which parameters to read from the
+  // search path on initial page load
+  //
+  self.register = function(facet) {
+    filter[facet] = filter[facet] || [];
+  }
+
   //
   // Calculate facet value counts from webservice
   //
@@ -90,14 +100,14 @@ repertoire.facet_context = function(context_name, state_fn, options) {
   // Convenience function for constructing faceting urls
   //
   self.facet_url = function(action, facet, ext, params) {
-    var paths = [context_name, action]
+    var paths = [context_name, action];
     if (facet)
-      paths.push(facet)
+      paths.push(facet);
     var url = self.default_url(paths, ext),
-        search = '?' + self.to_query_string(params);
+        search = self.to_query_string(params);
 
-    if (search != '?')
-      return url + search
+    if (search)
+      return url + '?' + search;
     else
       return url;
   };
@@ -138,12 +148,17 @@ repertoire.facet_context = function(context_name, state_fn, options) {
   // (including any additional state defined by client app)
   //
   self.url = function() {
-    var url = self.default_url([context_name]),
+    var prefix = options.url || '',
+        parts = [context_name];
+
+    parts.unshift(prefix);
+
+    var url = parts.join('/'),
         params = self.params(),
-        search = '?' + self.to_query_string(params);
+        search = self.to_query_string(params);
 
-    if (search != '?')
-      return url + search;
+    if (search)
+      return url + '?' + search;
     else
       return url;
   }

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

@@ -117,6 +117,9 @@ repertoire.facet = function($facet, options) {
   self.is_selected = function(values, item) {
     return ($.inArray(item, values) > -1);
   };
+
+  // register this facet with the context
+  self.context().register(self.facet_name());
     
   // end of faceting widget factory method
   return self;

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

@@ -69,6 +69,7 @@ repertoire.model = function(options) {
     var spinnerClass = options.spinner || 'loading';
     if ($elem)
       $elem.addClass(spinnerClass);
+
     $.ajax({
       async:    async,
       url:      url,
@@ -97,7 +98,7 @@ repertoire.model = function(options) {
     var parts       = default_parts.slice();
 
     parts.unshift(path_prefix);
-    url = options.url || parts.join('/')
+    url = options.url || parts.join('/');
 
     if (ext)
       url += '.' + ext;

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

@@ -45,7 +45,7 @@ repertoire.widget = function(selector, options) {
     // register any custom handlers
     if (options.handlers !== undefined)
       register_handlers(options.handlers);
-      
+
     // load once at beginning
     self.refresh();
   }
@@ -55,14 +55,27 @@ repertoire.widget = function(selector, options) {
   //
   // Integrates state and markup injectors
   //
+  // TODO. ajaxStamp and callbackStamp are used to accept only the most
+  //       recent ajax sync for this widget.  Better solution would be to wait
+  //       until document.ready() has finished before initializing and refreshing
+  //       any widgets; or use xhr.abort().
+  //
+  var ajaxStamp;
   self.refresh = function() {
-    var callback;
+    var callback,
+        callbackStamp;
     
     // pass to custom state processor
     if (options.state !== undefined)
       options.state(self);
+
+    // adjust timestamp to most recent ajax call
+    ajaxStamp = callbackStamp = Date.now();
       
     callback = function() {
+      // reject if this is an old ajax request
+      if (callbackStamp < ajaxStamp) return;
+
       // render the widget
       var markup = self.render.apply(self, arguments);
       

data/lib/repertoire-faceting/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: repertoire-faceting
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.2
 platform: ruby
 authors:
 - Christopher York
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-26 00:00:00.000000000 Z
+date: 2014-05-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails