cedar 0.1.4.pre → 0.1.5.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c5d280227fbd35a6d74fad592fc82ade118e7235
-  data.tar.gz: 98f6b8c3544fc3f053f6f7c7bc6b20fe5e128faa
+  metadata.gz: 94d2c597a7f479090911653296c9d179b97b7d04
+  data.tar.gz: a9f0edf34cf4e4b371c94918e4798aa7c99a6a89
 SHA512:
-  metadata.gz: 8598d491a8eea92e6395ad8626dac591f924ecfbd8f3566ebae1ad52c6ae82f6b4ac279d11188c33c8aad628c705e1c88148ceb75ffeb6ebfd8f02e6a63a00ba
-  data.tar.gz: 818dfac12dd59da8b8ff884caac69ddd582219aa9fd789627e14a84392010d83caae7d7b5b6e56e11ed0d13e2d2d3d4c7d4e2ee75344ed165514128ac2df4b45
+  metadata.gz: 36937266911e61807abc29ebb2db7c33d83bfec1143fd2984f1a0d927442cb49468b7e45b15483feb1319b7ee8dd14f286d31b4cf14e4938e22595b9e9fe84e1
+  data.tar.gz: e0ba878e2c81318fa8600760ed82a2cf8862657c1e7ef0021908a20a14f352ad63b44bf6fb00f5a6cefcdff54cfca17d35f14a0b43561bdeeb499c500017cff3

data/.gitignore

@@ -0,0 +1 @@
+pkg/

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cedar (0.1.2.pre)
+    cedar (0.1.5.pre)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -18,7 +18,31 @@ Or install it yourself as:
 
     $ gem install cedar
 
+## Usage
 
+To retrieve all available content and save it to `localStorage`, use the following function (returns a promise)
+
+```javascript
+Cedar.store.getAll();
+```
+
+### Handlebars
+
+To add Cedar-managed content to your Handlebars templates, use the following helper:
+
+```handlebars
+{{ cedar type="contentEntry" id="Today's Activities : Activities : Intro" }}
+```
+
+Set the `id` to a unique string that is used to identify this piece of content. The `type` attribute is optional and defaults to `contentEntry`.
+
+You can also use the block-helper style which allows you to define a template that the `JSON` content returned from Cedar will bind to.
+
+```handlebars
+{{#cedar type="contentEntry" id="Today's Activities : Activities : Empty Message" }}
+  <div class="notice">{{content}}</div>
+{{/cedar}}
+```
 
 ## Ply Dev Notes
 

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

@@ -28,6 +28,7 @@ Handlebars.registerHelper('cedar', function(options) {
   };
 
   options.el = document.createElement("div");
+  options.el.setAttribute("style", "display: inline");
   options.el.id = "cedar-js-" + hashCode(options.hash.id);
 
   new Cedar.ContentEntry({ cedarId: options.hash.id }).retrieve().then(function(contentEntry){
@@ -37,10 +38,18 @@ Handlebars.registerHelper('cedar', function(options) {
       domEl = options.el;
     }
 
-    if (typeof options.fn === "undefined") {
+    if (typeof options.fn === "undefined") { // If using inline-style helper
       domEl.innerHTML = contentEntry.getContent();
-    } else if (typeof options.fn === "function") {
-      domEl.innerHTML = unescapeHtml(options.fn(contentEntry.toJSON()));
+    } else if (typeof options.fn === "function") { // If using block-style helper
+      var output = '';
+      if (Cedar.auth.isEditMode()) {
+        output += contentEntry.getEditOpen();
+      }
+      output += unescapeHtml(options.fn(contentEntry.toJSON()));
+      if (Cedar.auth.isEditMode()) {
+        output += contentEntry.getEditClose();
+      }
+      domEl.innerHTML = output;
     }
   });
 

data/lib/assets/javascripts/cedar.js

@@ -116,6 +116,7 @@ Cedar.Auth.prototype.removeURLParameter = function(url, parameter) {
  */
 Cedar.Store = function() {
   this.loaded = false;
+  console.log("loaded: " + this.loaded);
   try {
     return 'localStorage' in window && window['localStorage'] !== null;
   } catch (e) {
@@ -126,7 +127,6 @@ Cedar.Store = function() {
 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
@@ -138,15 +138,15 @@ Cedar.Store.prototype.get = function ( object, key ) {
   if ( object.apiGet() === null ) {
     throw 'Cedar Error: must provide api "get" path';
   }
-
   if (typeof localStorage[key] !== "undefined") {
-    console.log('retrieved from cache');
+    console.log('getting from cache');
     return $.Deferred().resolve(localStorage[key]);
   } else {
-    console.log('retrieved from server');
+    console.log('getting from server...');
     return $.getJSON(Cedar.config.api + object.apiGet() + key, function(json) {
-      this.put(key, json);
-    }.bind(this));
+      console.log('got from server');
+      Cedar.store.put(key, json);
+    });
   }
 }
 
@@ -159,13 +159,13 @@ Cedar.Store.prototype.get = function ( object, key ) {
  *
  */
 Cedar.Store.prototype.query = function ( path, param, value ) {
-
-  jQuery.getJSON(Cedar.config.api + path + '?' + param + '=' + value ).done( function(json) {
+  $.getJSON(Cedar.config.api + path + '?' + param + '=' + value ).done( function(json) {
     $.each(json, function (key, val){
-      Cedar.store.put(key, val);
+      if ( typeof val.id !== 'undefined' && typeof val.settings.content !== 'undefined') {
+        Cedar.store.put(val.id, val);
+      }
     });
-  }.bind(this));
-
+  });
 }
 
 /**
@@ -173,18 +173,30 @@ Cedar.Store.prototype.query = function ( path, param, value ) {
  * TODO: (currently hardcoded to content entries - should be avail to any type in future)
  */
 Cedar.Store.prototype.getAll = function () {
+  console.log("loaded: " + Cedar.store.loaded);
+  return $.when(Cedar.store.checkData()).then( function() {
 
-  if (this.loaded) {
-    return $.Deferred().resolve({});
-  } else {
-    return $.getJSON(Cedar.config.api + "/queries/contententries/" ).done( function(json) {
-      $.each(json, function (key, val) {
-        this.put(val.id, val);
-        this.loaded = true;
-      }.bind(this));
-    }.bind(this));
-  }
+    console.log("loaded: " + Cedar.store.loaded);
+    if (Cedar.store.loaded) {
+
+      console.log("already loaded all items");
+      return $.Deferred().resolve({});
+
+    } else {
 
+      console.log("loading all items from server...");
+      return $.getJSON(Cedar.config.api + "/queries/contententries/" ).done( function(json) {
+        console.log("Got new stuff from the server");
+        $.each(json, function (key, val) {
+          Cedar.store.put(val.id, val);
+          console.log("storing: " + val.id + " / " + val);
+        });
+        Cedar.store.loaded = true;
+      });
+
+    }
+
+  });
 }
 
 /**
@@ -196,6 +208,30 @@ Cedar.Store.prototype.clear = function(key) {
   localStorage.removeItem(key);
 }
 
+Cedar.Store.prototype.setVersion = function(id) {
+  console.log("updating to version #" + id);
+  localStorage["___CEDAR__DATA__FINGERPRINT___"] = id;
+}
+Cedar.Store.prototype.getVersion = function() {
+  return localStorage["___CEDAR__DATA__FINGERPRINT___"];
+}
+/**
+ * Query the server for the latest version number (ie data freshness)
+ */
+Cedar.Store.prototype.checkData = function() {
+  console.log("checking version #" + Cedar.store.getVersion());
+  return $.getJSON(Cedar.config.api + '/queries/status').done( function(json) {
+
+    if ( Cedar.store.getVersion() != json.settings.version ) {
+      console.log("setting version");
+      Cedar.store.loaded = false;
+      Cedar.store.setVersion(json.settings.version);
+    }
+    else {
+      Cedar.store.loaded = true;
+    }
+  });
+}
 
 /**
  * Cedar.ContentEntry
@@ -263,7 +299,7 @@ Cedar.ContentEntry.prototype.setContent = function(json) {
 // takes into account edit mode styling
 Cedar.ContentEntry.prototype.getContent = function(){
   if (Cedar.auth.isEditMode()) {
-    return this.getEditOpen(this.cedarId) + this.content + this.getEditClose();
+    return this.getEditOpen() + this.content + this.getEditClose();
   }
   else {
     return this.content;
@@ -272,7 +308,7 @@ Cedar.ContentEntry.prototype.getContent = function(){
 
 Cedar.ContentEntry.prototype.toJSON = function(){
   return {
-    content: this.getContent()
+    content: this.content
   }
 };
 
@@ -298,9 +334,9 @@ Cedar.ContentEntry.prototype.retrieve = function() {
 }
 
 // query filtered on object name matches
-Cedar.ContentEntry.prototype.query = function(filter) {
-  return Cedar.store.query(filter, this);
-}
+//Cedar.ContentEntry.prototype.query = function(filter) {
+//  return Cedar.store.query(filter, this);
+//}
 
 // fill the asssociated element with the retrieved content
 Cedar.ContentEntry.prototype.render = function() {
@@ -310,7 +346,7 @@ Cedar.ContentEntry.prototype.render = function() {
 }
 
 // styling for edit box
-Cedar.ContentEntry.prototype.getEditOpen = function(id) {
+Cedar.ContentEntry.prototype.getEditOpen = function() {
   var jsString = "if(event.stopPropagation){event.stopPropagation();}" +
   "event.cancelBubble=true;" +
   "window.location.href=this.attributes.href.value + \'&referer=' + encodeURIComponent(window.location.href) + '\';" +
@@ -319,7 +355,7 @@ Cedar.ContentEntry.prototype.getEditOpen = function(id) {
   var block = '<span class="cedar-cms-editable clearfix">';
   block += '<span class="cedar-cms-edit-tools">';
   block += '<a onclick="' + jsString + '" href="' + Cedar.config.server +
-           '/cmsadmin/EditData?cdr=1&t=ContentEntry&o=' + encodeURIComponent(id) +
+           '/cmsadmin/EditData?cdr=1&t=ContentEntry&o=' + encodeURIComponent(this.cedarId) +
            '" class="cedar-cms-edit-icon cedar-js-edit" >';
   block += '<i class="cedar-cms-icon cedar-cms-icon-right cedar-cms-icon-edit"></i></a>';
   block += '</span>';

data/lib/assets/stylesheets/cedar.scss

@@ -6,17 +6,26 @@
 .cedar-cms-editable {
   position: relative;
   display: inline-block !important;
-  border: 1px dotted #F65126 !important;
-  padding-right: 20px;
   min-height: 22px;
   vertical-align: middle;
+
+  &:before {
+    content: "";
+    position: absolute;
+    top: 0;
+    left: 0;
+    width: 100%;
+    height: 100%;
+    border: 1px dotted #F65126 !important;
+    box-sizing: border-box;
+  }
 }
 
 .cedar-cms-edit-tools {
   font-family: Arial, sans-serif;
   position: absolute;
   top: 0;
-  right: 0;
+  right: -18px;
   display: block !important;
   font-size: 10px !important;
   line-height: 1.2 !important;
@@ -49,7 +58,7 @@
   height: 18px;
   background-color: transparent !important;
   padding: 0;
-  margin: 1px;
+  margin: 0;
 }
 
 /* 4 classes to display icons */

data/lib/cedar/version.rb

@@ -1,3 +1,3 @@
 module Cedar
-  VERSION = "0.1.4.pre"
+  VERSION = "0.1.5.pre"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cedar
 version: !ruby/object:Gem::Version
-  version: 0.1.4.pre
+  version: 0.1.5.pre
 platform: ruby
 authors:
 - Jed Murdock
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-26 00:00:00.000000000 Z
+date: 2015-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -45,6 +45,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt