cedar 0.2.4.pre → 0.2.5.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 053f177a70a3eac7f6cd4a7a2078d428c984eb9d
-  data.tar.gz: 35cc270f62d73fb0cc826a3b8e1c0dd6bb6c5e5b
+  metadata.gz: d0f2cbdbbb9763368001f31b5043e6b2cff566c6
+  data.tar.gz: ba87685c025eefc461df4b023b5278e58036e132
 SHA512:
-  metadata.gz: 2f43f45836bd545b8625c719aec548979752a326e0746b76bfa9b8029d0a7be6a3e0df33dad8e848eb3735f515166496fe333752c5689b0825b23c8a9247d7c7
-  data.tar.gz: 279d832f1bdd09192fd6dc52d381756d3bfe72e742800e0d53a63b175029cec046a5382ba960c764c7126198ee2338d13f55bdbc605d82c6861ecdcf87d270bf
+  metadata.gz: 549c7b01125f1f5a50334004121c2f4221d8d23a1217da830f5fc7899e011ec94ebe6f2d88226ccafb5d9b51e544efcfc843d223d565816476048c0a21ebbc89
+  data.tar.gz: 1cf2652b3f6eb73965b525a47b0aabb58f01da62a1d0d28d0c26df062e672ee9a35cb757a954ac369ac7746e101388685ce55aa25563f22bfce6653e4f2e6223

data/README.md

@@ -47,6 +47,13 @@ You can also use the block-helper style which allows you to define a template th
 
 ## Ply Dev Notes
 
+### Updating Project Assets
+
+The authoritative source of the majority of the assets in this gem is the `cedar` Bower package. To update this gem with the latest version, you will need `bower` installed. You will also need to specify which version of `cedar` you want in the `bower.json` file. Finally you will need to run the following command from the root of this project:
+
+`bower install`
+
+### Publishing Gem
 
 add yourself as a user at:
 

data/lib/assets/javascripts/cedar.handlebars.js

@@ -33,6 +33,24 @@ Handlebars.registerHelper('cedar', function(options) {
     } else {
       return false;
     }
+  };
+
+  var replaceElement = function(id, content) {
+    // If rendered element exists than insert the content
+    var renderedEl = document.getElementById(id);
+    if (renderedEl !== null) {
+      var parentEl = renderedEl.parentNode;
+      var tempEl = document.createElement("div");
+      tempEl.innerHTML = content;
+
+      // Insert content node by node and then remove the existing element
+      var nodeList = tempEl.childNodes;
+      var nodeListLength = nodeList.length;
+      for(var i = 0; i < nodeListLength; i++) {
+        parentEl.insertBefore(nodeList[0], renderedEl);
+      }
+      parentEl.removeChild(renderedEl);
+    }
   }
 
   var tagName = options.hash.tagName || "span";
@@ -58,21 +76,7 @@ Handlebars.registerHelper('cedar', function(options) {
       output = contentEntry.getContent();
     }
 
-    // If rendered element exists than insert the content
-    var renderedEl = document.getElementById(outputEl.id);
-    if (renderedEl !== null) {
-      var parentEl = renderedEl.parentNode;
-      var tempEl = document.createElement("div");
-      tempEl.innerHTML = output;
-
-      // Insert content node by node and then remove the existing element
-      var nodeList = tempEl.childNodes;
-      var nodeListLength = nodeList.length;
-      for(var i = 0; i < nodeListLength; i++) {
-        parentEl.insertBefore(nodeList[0], renderedEl);
-      }
-      parentEl.removeChild(renderedEl);
-    }
+    replaceElement(outputEl.id, output);
   });
 
   return new Handlebars.SafeString(output || outputEl.outerHTML);

data/lib/assets/javascripts/cedar.js

@@ -1,15 +1,11 @@
 /**
  * Global object for settings and storage
  */
-var Cedar = {
+window.Cedar = {
   initialized: false,
   store: null,
   auth: null,
-  config: {
-    api: '',
-    server: '',
-    debug: false
-  }
+  config: {}
 };
 
 
@@ -21,7 +17,7 @@ var Cedar = {
 */
 Cedar.Init = function(options) {
   return new Cedar.Application(options);
-}
+};
 
 /**
  * Global function to display message to console if Cedar.debug = true
@@ -30,9 +26,9 @@ Cedar.Init = function(options) {
  */
 Cedar.debug = function(msg) {
   if (Cedar.config.debug) {
-    console.log(msg);
+    window.console.log(msg);
   }
-}
+};
 
 /**
 * Cedar.Application
@@ -59,7 +55,7 @@ Cedar.Application = function(options) {
 
   this.options = $.extend({}, defaults, options);
 
-  if ( typeof this.options.server === 'undefined' ) {
+  if (this.options.server === undefined) {
     throw 'Cedar Error: must provide "server" value on Init()';
   }
 
@@ -69,8 +65,8 @@ Cedar.Application = function(options) {
   Cedar.config.wait = this.options.wait;
   Cedar.config.fetch = this.options.fetch;
 
-  if (typeof Cedar.$ === "undefined") {
-    Cedar.$ = jQuery({});
+  if (Cedar.events === undefined) {
+    Cedar.events = jQuery({});
   }
 
   if ( Cedar.store === null ) {
@@ -85,14 +81,10 @@ Cedar.Application = function(options) {
     this.showGlobalActions();
   }
 
-  if (Cedar.config.fetch) {
-    Cedar.store.fetched = Cedar.store.fetch();
-  }
-
   Cedar.initialized = true;
 
-  this.initializeHTML()
-}
+  this.initializeHTML();
+};
 
 Cedar.Application.prototype.initializeHTML = function() {
   $('[data-cedar-id]').each(function(){
@@ -102,12 +94,12 @@ Cedar.Application.prototype.initializeHTML = function() {
       cedarId: $this.data("cedarId")
     }));
 
-    Cedar.$.on("content:loaded", function() {
+    Cedar.events.on("content:loaded", function() {
       $this.data("cedarObject").render();
     }.bind(this));
   });
-  Cedar.$.trigger("content:loaded");
-}
+  Cedar.events.trigger("content:loaded");
+};
 
 Cedar.Application.prototype.getProtocol = function() {
   if (this.options.forceHttps || window.location.protocol === 'https:') {
@@ -115,7 +107,7 @@ Cedar.Application.prototype.getProtocol = function() {
   } else {
     return 'http://';
   }
-}
+};
 
 Cedar.Application.prototype.showGlobalActions = function() {
   $(document).ready(function() {
@@ -132,7 +124,7 @@ Cedar.Application.prototype.showGlobalActions = function() {
       '</div>';
     $body.append(globalActions);
   });
-}
+};
 
 
 /**
@@ -141,24 +133,32 @@ Cedar.Application.prototype.showGlobalActions = function() {
  * responsible for determining if we're in edit mode
  */
 Cedar.Auth = function() {
-}
+  return;
+};
+
 Cedar.Auth.prototype.isEditMode = function() {
   return this.isEditUrl();
-}
+};
+
 Cedar.Auth.prototype.isEditUrl = function() {
   var sPageURL = window.location.search.substring(1);
   var sURLVariables = sPageURL.split('&');
-  for (var i = 0; i < sURLVariables.length; i++) {
-    if (sURLVariables[i] == 'cdrlogin') {
+  var i = 0;
+  while (i < sURLVariables.length) {
+    if (sURLVariables[i] === 'cdrlogin') {
       return true;
     }
+    i++;
   }
   return false;
-}
+};
+
 Cedar.Auth.prototype.getLogOffURL = function() {
   return this.removeURLParameter(window.location.href, 'cdrlogin');
-}
-// adapted from stackoverflow: http://stackoverflow.com/questions/1634748/how-can-i-delete-a-query-string-parameter-in-javascript
+};
+
+// adapted from stackoverflow:
+// http://stackoverflow.com/questions/1634748/how-can-i-delete-a-query-string-parameter-in-javascript
 Cedar.Auth.prototype.removeURLParameter = function(url, parameter) {
   var splitUrl = url.split('#');
   var serverUrl = splitUrl[0];
@@ -166,7 +166,7 @@ Cedar.Auth.prototype.removeURLParameter = function(url, parameter) {
   if (clientUrl) {
     clientUrl = '#' + clientUrl;
   }
-  //prefer to use l.search if you have a location/link object
+  // prefer to use l.search if you have a location/link object
   var splitServerUrl= serverUrl.split('?');
   if (splitServerUrl.length>=2) {
 
@@ -174,11 +174,13 @@ Cedar.Auth.prototype.removeURLParameter = function(url, parameter) {
     var pars = splitServerUrl[1].split(/[&;]/g);
 
     //reverse iteration as may be destructive
-    for (var i= pars.length; i-- > 0;) {
-      //idiom for string.startsWith
+    var i = pars.length - 1;
+    while (i >= 0) {
+      // idiom for string.startsWith
       if (pars[i].lastIndexOf(prefix, 0) !== -1) {
         pars.splice(i, 1);
       }
+      i--;
     }
 
     var updatedServerUrl= splitServerUrl[0];
@@ -189,7 +191,7 @@ Cedar.Auth.prototype.removeURLParameter = function(url, parameter) {
   } else {
     return url;
   }
-}
+};
 
 
 /**
@@ -203,12 +205,19 @@ Cedar.Auth.prototype.removeURLParameter = function(url, parameter) {
 Cedar.Store = function() {
   this.loaded = false;
 
+  this.cache = window.hasOwnProperty('localStorage') ? window.localStorage : {};
+
+  if (Cedar.config.fetch) {
+    this.refresh();
+  }
+
   try {
-    return 'localStorage' in window && window['localStorage'] !== null;
+    return window.hasOwnProperty('localStorage');
   } catch (e) {
     return false;
   }
-}
+};
+
 /**
  * store a single json item by key
  *
@@ -216,95 +225,92 @@ Cedar.Store = function() {
  * @param <json> 'item'
  */
 Cedar.Store.prototype.put = function ( key, item ) {
-  localStorage[key] = JSON.stringify(item);
-}
-/**
- * get a single item based on id (key)
- * if the item isn't in the local store, then get it from the server
- *
- * @param <Cedar> 'object'
- * @param <string> 'key'
- */
-Cedar.Store.prototype.get = function ( object, key ) {
-  if ( object.apiGet() === null ) {
-    throw 'Cedar Error: must provide api "get" path';
-  }
+  this.cache[key] = JSON.stringify(item);
+};
 
-  if (Cedar.store.loaded || (object.hasLocalContent() && !Cedar.config.wait)) {
-    Cedar.debug("loaded in get: " + Cedar.store.loaded);
-    Cedar.debug('get from cache: ' + key);
-    return $.Deferred().resolve(localStorage[key]);
+// Return local content immediately if possible. Otherwise return deferred remote content
+Cedar.Store.prototype.get = function(key) {
+  var cachedDeferred = this.cachedDeferred(key);
+  var remoteDeferred = this.remoteDeferred(key);
 
+  if (Cedar.config.wait || !this.cache[key]) {
+    Cedar.debug('checking remote: ' + key);
+    return remoteDeferred;
   } else {
-    Cedar.debug("loaded: " + Cedar.store.loaded);
-    return $.getJSON(Cedar.config.api + object.apiGet() + key, function(json) {
-      Cedar.debug('get from server: ' + key);
-      Cedar.store.put(key, json);
-    });
-  }
-}
-/**
- * fetch records from the server if necessary
- *
- * @param options <Array>
- *  - filter:<string> return only objects which match object IDs containing the string
- *  - path:<string> provide an api path other than the default (content entry query)
- *  - clear:<bool> clear local storage first
- */
-Cedar.Store.prototype.fetch = function ( options ) {
-  var apiPath = '/queries/contententries/';
-  var queryParams = {};
-
-  if ( typeof options !== 'undefined' && typeof options.path !== 'undefined' ) {
-    apiPath = options.path;
-  }
-  if ( typeof options !== 'undefined' && typeof options.filter !== 'undefined' ) {
-    queryParams['guidfilter'] = options.filter;
-  }
-  if ( typeof options !== 'undefined' && typeof options.clear !== 'undefined' && options.clear) {
-    this.clear();
+    Cedar.debug('get from cache: ' + key);
+    return cachedDeferred;
   }
+};
 
-  return $.when(Cedar.store.checkData()).then( function(response) {
-
-    Cedar.debug("fetch data check complete");
-
-    if (Cedar.store.loaded) {
+// Deferred object containing local content
+Cedar.Store.prototype.cachedDeferred = function(key) {
+  return $.Deferred().resolve(this.cache[key]);
+};
 
-      Cedar.debug("loaded: " + Cedar.store.loaded);
-      return $.Deferred().resolve({});
+// Refresh local storage if needed and then return content
+Cedar.Store.prototype.remoteDeferred = function(key) {
+  return this.refresh().then(function() {
+    return this.cachedDeferred(key);
+  }.bind(this));
+};
 
+// Check content version and update if needed
+Cedar.Store.prototype.refresh = function() {
+  return this.checkVersion().then(function() {
+    if (this.loaded) {
+      return $.Deferred().resolve();
     } else {
-
-      Cedar.debug("loaded: " + Cedar.store.loaded);
-      return $.getJSON(Cedar.config.api + apiPath, queryParams ).done( function(json) {
-        $.each(json, function (key, val) {
-          if ( typeof val.id !== 'undefined' && typeof val.settings.content !== 'undefined') {
-            Cedar.store.put(val.id, val);
-            Cedar.debug("storing: " + val.id);
-          }
-        });
-        Cedar.debug("setting loaded to true");
-        Cedar.store.loaded = true;
-        Cedar.$.trigger("content:loaded");
-      });
+      return this.getRemote();
     }
+  }.bind(this));
+};
+
+// Get content objects from server and save to local storage
+Cedar.Store.prototype.getRemote = function(options) {
+  var defaultOptions = {
+    path: '/queries/contententries/'
+  };
+  options = $.extend({}, defaultOptions, options);
+  var defaultParams = {};
+  var params = $.extend({}, defaultParams, {
+    guidfilter: options.filter
+  });
 
+  return this.lockedRequest({
+    path: options.path,
+    params: params,
+    success: function(response) {
+      $.each(response, function (index, value) {
+        if (value.hasOwnProperty('id') && value.settings.hasOwnProperty('content')) {
+          this.put(value.id, value);
+          Cedar.debug("storing: " + value.id);
+        }
+      }.bind(this));
+      Cedar.debug("local storage was updated");
+      this.loaded = true;
+      Cedar.events.trigger("content:loaded");
+    }.bind(this)
   });
-}
+};
+
 /**
  * clear the local storage or remove a single locally store item by key
  *
  * @param {ID} key
  */
-Cedar.Store.prototype.clear = function( key ) {
-  if ( typeof key === 'undefined' ) {
-    localStorage.clear();
-  }
-  else {
-    localStorage.removeItem(key);
-  }
-}
+ Cedar.Store.prototype.clear = function(key) {
+   if (key === undefined) {
+     if (window.hasOwnProperty('localStorage')) {
+       this.cache.clear();
+     } else {
+       this.cache = {};
+     }
+   }
+   else {
+     delete this.cache[key];
+   }
+ };
+
 /**
  * set the locally stored data version number
  *
@@ -312,37 +318,55 @@ Cedar.Store.prototype.clear = function( key ) {
  */
 Cedar.Store.prototype.setVersion = function(id) {
   Cedar.debug("updating to version #" + id);
-  localStorage["___CEDAR__DATA__FINGERPRINT___"] = id;
-}
+  this.cache["___CEDAR__DATA__FINGERPRINT___"] = id;
+};
+
 /**
  * return the currently stored data version number
  *
  * @return <string> data version number
  */
 Cedar.Store.prototype.getVersion = function() {
-  return localStorage["___CEDAR__DATA__FINGERPRINT___"];
-}
+  return this.cache["___CEDAR__DATA__FINGERPRINT___"];
+};
+
 /**
  * Query the server for the latest data version number
  *
  * @return <Deferred>
  */
-Cedar.Store.prototype.checkData = function() {
-  Cedar.debug("checking version #" + Cedar.store.getVersion());
-  return $.when($.getJSON(Cedar.config.api + '/queries/status'))
-
-  .then( function(response) {
-    if ( Cedar.store.getVersion() != response.settings.version ) {
-      Cedar.debug('setting version: ' + response.settings.version);
-      Cedar.store.loaded = false;
-      Cedar.store.setVersion(response.settings.version);
-    } else {
-      Cedar.debug("version is up to date");
-      Cedar.store.loaded = true;
-      Cedar.$.trigger("content:loaded");
-    }
+Cedar.Store.prototype.checkVersion = function() {
+  return this.lockedRequest({
+    path: '/queries/status',
+    success: function(response) {
+      Cedar.debug("checking version #" + this.getVersion());
+
+      // response.settings.version is being returned as an array and must be converted
+      if ( this.getVersion() !== response.settings.version.toString() ) {
+        Cedar.debug('setting version: ' + response.settings.version);
+        this.loaded = false;
+        this.setVersion(response.settings.version);
+      } else {
+        Cedar.debug("version is up to date");
+        this.loaded = true;
+        Cedar.events.trigger("content:loaded");
+      }
+    }.bind(this)
   });
-}
+};
+
+// Returns an already resolving getJSON request if it matches
+Cedar.Store.prototype.lockedRequest = function(options) {
+  options = options || {};
+  this.requestCache || (this.requestCache = {});
+
+  var requestKey = JSON.stringify({path: options.path, params: options.params});
+
+  return this.requestCache[requestKey] || (this.requestCache[requestKey] = $
+    .getJSON(Cedar.config.api + options.path, options.params).then(function(response){
+      options.success(response);
+    }.bind(this)));
+};
 
 /**
  * Cedar.ContentEntry
@@ -365,7 +389,7 @@ Cedar.ContentEntry = function(options) {
   this.cedarId = this.options.cedarId;
   this.el = this.options.el;
   this.$el = $(this.el);
-}
+};
 
 Cedar.ContentEntry.prototype.apiGet = function() {
   return '/objects/contententries/';
@@ -383,39 +407,26 @@ Cedar.ContentEntry.prototype.apiList = function() {
   return 'guidlist';
 };
 
-Cedar.ContentEntry.prototype.hasLocalContent = function() {
-  if (typeof this.localContentExists === "undefined") {
-    var content = localStorage[this.cedarId];
-    this.localContentExists = false;
-    if (typeof content !== "undefined") {
-      var json = JSON.parse(content);
-      if (typeof json.id !== "undefined") {
-        this.localContentExists = true;
-      }
-    }
-  }
-  return this.localContentExists;
-}
-
 /**
  * parse the json for content and set this object's content
  *
  * @param <json>
  */
 Cedar.ContentEntry.prototype.setContent = function(data) {
-  if (typeof data === 'undefined') return;
   if (typeof data === 'string') {
     data = JSON.parse(data);
   }
-  if (data.code == 'UNKNOWN_ID'){
+
+  if (!data || data.code === 'UNKNOWN_ID'){
     this.content = '';
-  } else if (typeof data.settings.content !== 'undefined') {
+  } else if (data.settings.hasOwnProperty('content')) {
     this.content = data.settings.content;
   } else {
     this.content = '';
     Cedar.debug('Cedar Error: Unable to parse json');
   }
-}
+};
+
 /**
  * return the object's content - takes into account edit mode styling
  *
@@ -428,7 +439,8 @@ Cedar.ContentEntry.prototype.getContent = function(){
   else {
     return this.content;
   }
-}
+};
+
 /**
  * is this a content entry json structure?
  *
@@ -436,44 +448,48 @@ Cedar.ContentEntry.prototype.getContent = function(){
  * @return <bool>
  */
 Cedar.ContentEntry.prototype.isContentEntry = function (json) {
-  if (typeof json === 'undefined') {
+  if (json === undefined) {
     return false;
   }
-  if (typeof json.settings === 'undefined' && typeof json.settings.content === 'undefined') {
+  if (json.hasOwnProperty('settings') && json.settings.hasOwnProperty('content')) {
     return false;
   }
 
   return true;
-}
+};
+
 /**
  * @return <json>
  */
 Cedar.ContentEntry.prototype.toJSON = function(){
   return {
     content: this.content
-  }
+  };
 };
+
 /**
  * fill self or provided element with content
  *
  * @param <element> optional
  */
 Cedar.ContentEntry.prototype.fill = function(element) {
-  if (typeof element !== 'undefined') {
+  if (element !== undefined) {
     $(element).html(this.getContent());
-  } else if (typeof this.$el !== 'undefined') {
+  } else if (this.$el instanceof jQuery) {
     this.$el.html(this.getContent());
   }
-}
+};
+
 /**
  * check store for this object's content
  */
 Cedar.ContentEntry.prototype.retrieve = function() {
- return Cedar.store.get(this, this.cedarId).then(function(response) {
-   this.setContent(response);
-   return this;
- }.bind(this));
-}
+  return Cedar.store.get(this.cedarId).then(function(response) {
+    this.setContent(response);
+    return this;
+  }.bind(this));
+};
+
 /**
  * retrive and fill the associated element
  */
@@ -481,7 +497,7 @@ Cedar.ContentEntry.prototype.render = function() {
   this.retrieve().done(function() {
     this.fill();
   }.bind(this));
-}
+};
 
 /**
  * provides styling for edit box
@@ -500,7 +516,8 @@ Cedar.ContentEntry.prototype.getEditOpen = function() {
   block += '<i class="cedar-cms-icon cedar-cms-icon-right cedar-cms-icon-edit"></i></a>';
   block += '</span>';
   return block;
-}
+};
+
 Cedar.ContentEntry.prototype.getEditClose = function(){
   return '</span>';
-}
+};

data/lib/cedar/version.rb

@@ -1,3 +1,3 @@
 module Cedar
-  VERSION = "0.2.4.pre"
+  VERSION = "0.2.5.pre"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cedar
 version: !ruby/object:Gem::Version
-  version: 0.2.4.pre
+  version: 0.2.5.pre
 platform: ruby
 authors:
 - Jed Murdock
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-08 00:00:00.000000000 Z
+date: 2015-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -51,7 +51,7 @@ files:
 - lib/assets/javascripts/cedar.handlebars.js
 - lib/assets/javascripts/cedar.js
 - lib/assets/stylesheets/cedar.scss
-- lib/assets/stylesheets/cedar_source.css
+- lib/assets/stylesheets/cedar_source.scss
 - lib/cedar.rb
 - lib/cedar/version.rb
 homepage: http://plyinteractive.com