cedar 0.1.6.pre → 0.1.7.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 864ddc8254855ea4cd9be8c882e123fc3008f751
-  data.tar.gz: bae1dc187c21c92183fe0a20c9f70f04e5c6bc56
+  metadata.gz: 6463db6fe87cf5fa52432c57f921967b4c392114
+  data.tar.gz: 2f3c7a6016e9c5e0e9488c8540dc690b7db1eda2
 SHA512:
-  metadata.gz: 981cc68bfbfee8548d4011d486260c0d13d7a25b65a1b3939e30bff87e033b7f988776d1154542549f1c0154d7eed9b84ecf2ca8cb10098233fa6d40b51b2b43
-  data.tar.gz: aff94b364525d5ffa1fc97b99a38f32467baa0529067ce92a36ff4821a991660fe8b11de172f868d203c1d051cf507fe78cc58aadf874d9a5831a5d3827e5a60
+  metadata.gz: d2c3a7c4f125b200b2abf5472762b218d0fe952d7e76be65f6176b82652a526daf58681db3ce92500110f97e75934dc00915c142ac765d207b293202aae2ea20
+  data.tar.gz: 96d2f9995ab6592b1f6c5932e4df18c763cc07fa5dc7ab18fce711f6849be533cebd824e4cdbae6b3783c7a743c826379248d945297663ec300c18d19e724ac5

data/README.md

@@ -23,9 +23,10 @@ Or install it yourself as:
 To retrieve all available content and save it to `localStorage`, use the following function (returns a promise)
 
 ```javascript
-Cedar.store.getAll();
+Cedar.store.fetch();
 ```
 
+
 ### Handlebars
 
 To add Cedar-managed content to your Handlebars templates, use the following helper:

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

@@ -40,18 +40,13 @@ Handlebars.registerHelper('cedar', function(options) {
     tagName = options.hash.tagName || "div";
   }
 
-  options.el = document.createElement(tagName);
-  options.el.id = "cedar-js-" + hashCode(options.hash.id);
+  var outputEl = document.createElement(tagName);
+  outputEl.id = "cedar-js-" + hashCode(options.hash.id);
 
-  new Cedar.ContentEntry({ cedarId: options.hash.id }).retrieve().then(function(contentEntry){
-
-    var domEl = document.getElementById(options.el.id);
-    if (domEl === null) {
-      domEl = options.el;
-    }
+  var output = '';
 
+  new Cedar.ContentEntry({ cedarId: options.hash.id }).retrieve().then(function(contentEntry){
     if (blockHelperStyle()) {
-      var output = '';
       if (Cedar.auth.isEditMode()) {
         output += contentEntry.getEditOpen();
       }
@@ -59,11 +54,16 @@ Handlebars.registerHelper('cedar', function(options) {
       if (Cedar.auth.isEditMode()) {
         output += contentEntry.getEditClose();
       }
-      domEl.innerHTML = output;
     } else {
-      domEl.innerHTML = contentEntry.getContent();
+      output = contentEntry.getContent();
+    }
+
+    // If rendered element exists than insert the content
+    var renderedEl = document.getElementById(outputEl.id);
+    if (renderedEl !== null) {
+      renderedEl.innerHTML = output;
     }
   });
 
-  return new Handlebars.SafeString(options.el.outerHTML);
+  return new Handlebars.SafeString(output || outputEl.outerHTML);
 });

data/lib/assets/javascripts/cedar.js

@@ -17,6 +17,10 @@ var Cedar = {
 * Cedar.Init
 *
 * take care of global initializations
+*
+* @param <Array> options
+*   - server : 'test.cdr.plyinc.com' - *required
+*   - debug : true | false
 */
 Cedar.Init = function(options) {
   if ( Cedar.initialized ) {
@@ -61,17 +65,22 @@ Cedar.Init = function(options) {
 
   Cedar.initialized = true;
 }
-
+/**
+ * display message to console if Cedar.debug = true
+ *
+ * @param <string> message
+ */
 Cedar.debug = function(msg) {
   if (Cedar.config.debug) {
     console.log(msg);
   }
 }
 
+
 /**
  * Cedar.Auth
  *
- * responsible for determining if we're authorized for edit mode
+ * responsible for determining if we're in edit mode
  */
 Cedar.Auth = function() {
 }
@@ -91,7 +100,6 @@ Cedar.Auth.prototype.isEditUrl = function() {
 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
 Cedar.Auth.prototype.removeURLParameter = function(url, parameter) {
   var splitUrl = url.split('#');
@@ -133,14 +141,19 @@ Cedar.Auth.prototype.removeURLParameter = function(url, parameter) {
  */
 Cedar.Store = function() {
   this.loaded = false;
-  Cedar.debug("loaded: " + this.loaded);
+
   try {
     return 'localStorage' in window && window['localStorage'] !== null;
   } catch (e) {
     return false;
   }
 }
-
+/**
+ * store a single json item by key
+ *
+ * @param <string> 'key'
+ * @param <json> 'item'
+ */
 Cedar.Store.prototype.put = function ( key, item ) {
   localStorage[key] = JSON.stringify(item);
 }
@@ -148,99 +161,110 @@ Cedar.Store.prototype.put = function ( key, 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'
+ * @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';
   }
   if (typeof localStorage[key] !== "undefined") {
-    Cedar.debug('getting from cache');
+    Cedar.debug('get from cache: ' + key);
     return $.Deferred().resolve(localStorage[key]);
   } else {
-    Cedar.debug('getting from server...');
+    Cedar.debug('checking server...');
     return $.getJSON(Cedar.config.api + object.apiGet() + key, function(json) {
-      Cedar.debug('got from server');
+      Cedar.debug('get from server: ' + key);
       Cedar.store.put(key, json);
     });
   }
 }
-
 /**
- * query the api and fill the local store with the results
- *
- * @param string 'path'
- * @param string 'param'
- * @param string 'value'
+ * 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.query = function ( path, param, value ) {
-  $.getJSON(Cedar.config.api + path + '?' + param + '=' + value ).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.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();
+  }
 
-/**
- * get all objects and store locally
- * TODO: (currently hardcoded to content entries - should be avail to any type in future)
- */
-Cedar.Store.prototype.getAll = function () {
-  Cedar.debug("loaded: " + Cedar.store.loaded);
   return $.when(Cedar.store.checkData()).then( function() {
 
-    Cedar.debug("loaded: " + Cedar.store.loaded);
     if (Cedar.store.loaded) {
 
-      Cedar.debug("already loaded all items");
+      Cedar.debug("loaded: " + Cedar.store.loaded);
       return $.Deferred().resolve({});
 
     } else {
 
-      Cedar.debug("loading all items from server...");
-      return $.getJSON(Cedar.config.api + "/queries/contententries/" ).done( function(json) {
-        Cedar.debug("Got new stuff from the server");
+      Cedar.debug("loaded: " + Cedar.store.loaded);
+      return $.getJSON(Cedar.config.api + apiPath, queryParams ).done( function(json) {
         $.each(json, function (key, val) {
-          Cedar.store.put(val.id, val);
-          Cedar.debug("storing: " + val.id + " / " + val);
+          if ( typeof val.id !== 'undefined' && typeof val.settings.content !== 'undefined') {
+            Cedar.store.put(val.id, val);
+            Cedar.debug("storing: " + val.id);
+          }
         });
         Cedar.store.loaded = true;
       });
-
     }
 
   });
 }
-
 /**
- * remove a single locally store item by key
+ * clear the local storage or remove a single locally store item by key
  *
- * @param ID key
+ * @param {ID} key
  */
-Cedar.Store.prototype.clear = function(key) {
-  localStorage.removeItem(key);
+Cedar.Store.prototype.clear = function( key ) {
+  if ( typeof key === 'undefined' ) {
+    localStorage.clear();
+  }
+  else {
+    localStorage.removeItem(key);
+  }
 }
-
+/**
+ * set the locally stored data version number
+ *
+ * @return <string> data version number
+ */
 Cedar.Store.prototype.setVersion = function(id) {
   Cedar.debug("updating to version #" + id);
   localStorage["___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___"];
 }
 /**
- * Query the server for the latest version number (ie data freshness)
+ * Query the server for the latest data version number
+ *
+ * @return <Deferred>
  */
 Cedar.Store.prototype.checkData = function() {
   Cedar.debug("checking version #" + Cedar.store.getVersion());
   return $.getJSON(Cedar.config.api + '/queries/status').done( function(json) {
 
     if ( Cedar.store.getVersion() != json.settings.version ) {
-      Cedar.debug("setting version");
+      Cedar.debug('setting version: ' + json.settings.version);
       Cedar.store.loaded = false;
       Cedar.store.setVersion(json.settings.version);
     }
@@ -255,8 +279,6 @@ Cedar.Store.prototype.checkData = function() {
  *
  * basic content block class
  *
- *
- *
  * options:
  *
  * {
@@ -275,31 +297,30 @@ Cedar.ContentEntry = function(options) {
   this.$el = $(this.el);
 }
 
-Cedar.ContentEntry.query = function(thing) {
-  Cedar.store.query( "/queries/contententries/", "guidfilter", thing );
-}
-
 Cedar.ContentEntry.prototype.apiGet = function() {
-  return "/objects/contententries/";
+  return '/objects/contententries/';
 };
 
 Cedar.ContentEntry.prototype.apiQuery = function() {
-  return "/queries/contententries/";
+  return '/queries/contententries/';
 };
 
 Cedar.ContentEntry.prototype.apiFilter = function() {
-  return "guidfilter";
+  return 'guidfilter';
 };
 
 Cedar.ContentEntry.prototype.apiList = function() {
-  return "guidlist";
+  return 'guidlist';
 };
 
-
-// parse the json for the relevant content
+/**
+ * parse the json for content and set this object's content
+ *
+ * @param <json>
+ */
 Cedar.ContentEntry.prototype.setContent = function(json) {
-  if (typeof json === "undefined") return;
-  if (json.code == "UNKNOWN_ID"){
+  if (typeof json === 'undefined') return;
+  if (json.code == 'UNKNOWN_ID'){
     this.content = '&nbsp;'; // if an element is new, fill with blank space to allow edit box to display
   }
   else if (typeof json.settings.content !== 'undefined') {
@@ -310,8 +331,11 @@ Cedar.ContentEntry.prototype.setContent = function(json) {
     Cedar.debug('Cedar Error: Unable to parse json');
   }
 }
-
-// takes into account edit mode styling
+/**
+ * return the object's content - takes into account edit mode styling
+ *
+ * @return <HTML>
+ */
 Cedar.ContentEntry.prototype.getContent = function(){
   if (Cedar.auth.isEditMode()) {
     return this.getEditOpen() + this.content + this.getEditClose();
@@ -320,14 +344,35 @@ Cedar.ContentEntry.prototype.getContent = function(){
     return this.content;
   }
 }
+/**
+ * is this a content entry json structure?
+ *
+ * @param <json>
+ * @return <bool>
+ */
+Cedar.ContentEntry.prototype.isContentEntry = function (json) {
+  if (typeof json === 'undefined') {
+    return false;
+  }
+  if (typeof json.settings === 'undefined' && typeof json.settings.content === 'undefined') {
+    return false;
+  }
 
+  return true;
+}
+/**
+ * @return <json>
+ */
 Cedar.ContentEntry.prototype.toJSON = function(){
   return {
     content: this.content
   }
 };
-
-// element is optional parameter
+/**
+ * fill self or provided element with content
+ *
+ * @param <element> optional
+ */
 Cedar.ContentEntry.prototype.fill = function(element) {
   if (typeof element !== 'undefined') {
     $(element).html(this.getContent());
@@ -336,31 +381,29 @@ Cedar.ContentEntry.prototype.fill = function(element) {
     this.$el.html(this.getContent());
   }
 }
-
-// check store for content
+/**
+ * check store for this object's content
+ */
 Cedar.ContentEntry.prototype.retrieve = function() {
   return Cedar.store.get(this, this.cedarId).then(function(response) {
-    if (typeof response === "string") {
+    if (typeof response === 'string') {
       response = JSON.parse(response);
     }
     this.setContent(response);
     return this;
   }.bind(this));
 }
-
-// query filtered on object name matches
-//Cedar.ContentEntry.prototype.query = function(filter) {
-//  return Cedar.store.query(filter, this);
-//}
-
-// fill the asssociated element with the retrieved content
+/**
+ * retrive and fill the associated element
+ */
 Cedar.ContentEntry.prototype.render = function() {
   this.retrieve().done(function() {
     this.fill();
   }.bind(this));
 }
-
-// styling for edit box
+/**
+ * provides styling for edit box
+ */
 Cedar.ContentEntry.prototype.getEditOpen = function() {
   var jsString = "if(event.stopPropagation){event.stopPropagation();}" +
   "event.cancelBubble=true;" +

data/lib/cedar/version.rb

@@ -1,3 +1,3 @@
 module Cedar
-  VERSION = "0.1.6.pre"
+  VERSION = "0.1.7.pre"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cedar
 version: !ruby/object:Gem::Version
-  version: 0.1.6.pre
+  version: 0.1.7.pre
 platform: ruby
 authors:
 - Jed Murdock
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-03 00:00:00.000000000 Z
+date: 2015-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler