slices 1.0.5 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0b50a602b55d804ce6e82fd30ff4caeeae4e218f
-  data.tar.gz: 4a4788c7dcbe27ae76972168c36bcf74672b23d0
+  metadata.gz: 7351b77e31a685b3a9b8caf5f1591815408bd4e2
+  data.tar.gz: e1373f1063e41190ea32c92c4367de45b687e3a8
 SHA512:
-  metadata.gz: bcc62dbc628c164bb9e5939f1d7852014c91579b31fa590d013d3c80d149aa95ddc7e2f6ce0622932fbaee05d8645e13980c7fd899499d6b396b1850c3812f28
-  data.tar.gz: f48be52b0e4b7732ae5d809985aaf4994dd06f3b9e1de30cc737148e40dc6e0cb83fc19ee2232e8183b20260df002067b46252faef44374eb1f122615f4b84e5
+  metadata.gz: 86ef317f478a14a86267f71ef732ab81014241c83765dd13be39758eadc4398b2f65cb35a70b4f72dd8289c9b93cfbd6683e55c7c70a84bfa9e5e202a2157124
+  data.tar.gz: 3bf5b78441a9a342980297657fbfaab284216c2450345e7b0999efda1b245394fcf8de3a3c1d1bef60014476bf25f60f92a0dacbc9b5181493205dc318abfa18

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+# 2.0.0 / 2016-01-15
+
+* Rails I18n support
+* Refactor snippets to not piggy back on I18n
+* Upgrade to mongoid v3.1
+* Ensure (soft-)destroying an asset removes it from all pages/slices [#39](https://github.com/withassociates/slices/pull/39)
+* Drop support for ruby 1.9
+
 # 1.0.5 / 2014-08-21
 
 * Add confirmation when deleting set entries

data/README.md

@@ -2,35 +2,103 @@
 
 In-house CMS of [With Associates](http://withassociates.com/).
 
-## Starting a new Slices project
+[![Travis CI](https://api.travis-ci.org/withassociates/slices.png)](https://travis-ci.org/withassociates/slices)
+[![Code Climate](https://codeclimate.com/github/withassociates/slices.png)](https://codeclimate.com/github/withassociates/slices)
+[![Gemnasium](https://gemnasium.com/withassociates/slices.png)](https://gemnasium.com/withassociates/slices)
 
-Slices requires Ruby, MongoDB and ImageMagick. If you don't have them installed, follow this [guide](https://github.com/withassociates/slices/wiki/Installation.md) before beginning.
+## Getting Started
 
-Now we're ready to create the Slices project:
+### Prerequisites
 
-    $ cd ~/Projects
-    $ rails _3.2.16_ new mywebsite -O
-    $ cd ~/Projects/mywebsite
+Slices requires [Ruby](https://ruby-lang.org), [MongoDB](http://mongodb.org),
+and [ImageMagick](http://imagemagick.org).
 
-Add 'slices' to the Gemfile of your new project:
+We suggest installing Ruby using [ruby-install](https://github.com/postmodern/ruby-install):
 
-    gem 'slices'
+```sh
+$ ruby-install --latest ruby
+```
 
-Run `rails generate slices:install` in the terminal and follow the instructions.
+Install MongoDB and ImageMagick with [Homebrew](http://brew.sh):
 
-If you intend to deploy your Slices app to Heroku, run `rails generate slices:install --heroku` to make life easier.
+```sh
+$ brew install mongodb ImageMagick  # this can take a while
+```
 
-You're ready to go! Run `rails server` and visit http://localhost:3000/admin to begin using Slices.
+### Generating a Slices Project
 
-The next step is to create some [slices](https://github.com/withassociates/slices/wiki/Creating-Slices) - there are more guides in the [Wiki](https://github.com/withassociates/slices/wiki).
+We'll need to create a Rails project:
 
-## Code Status
+```sh
+$ gem install rails -v 3.2.22
+$ rails _3.2.22_ new mywebsite -JOT
+$ cd mywebsite
+```
 
-[![Travis CI   ](https://api.travis-ci.org/withassociates/slices.png)       ](https://travis-ci.org/withassociates/slices)
-[![Code Climate](https://codeclimate.com/github/withassociates/slices.png)  ](https://codeclimate.com/github/withassociates/slices)
-[![Gemnasium   ](https://gemnasium.com/withassociates/slices.png)           ](https://gemnasium.com/withassociates/slices)
+Add Slices to the project’s Gemfile:
+
+```ruby
+gem 'slices', '~> 2.0.0'
+```
+
+Run bundler:
+
+```sh
+$ bundle install
+```
+
+Run the generator and follow the instructions to configure Slices for the first time:
+
+```sh
+$ rails generate slices:install
+```
+
+At the end of this process we should have a new Slices project with a git
+repository created, gems installed, database seeded and ready to run:
+
+```sh
+$ rails server
+```
+
+Visit `http://localhost:3000/admin` to begin using Slices.
+
+### Generating Slices
+
+The quickest way to create a Slice is to use the generator. In this example
+we're going to create a Slice called `title_body` with title and body fields.
+
+```shell
+$ rails generate slice title_body title:string body:text
+```
+
+The syntax is `field_name:field_type`.
+
+This command will create a new folder called `title_body` within `apps/slices`,
+containing the required Ruby file, the Handlebars templates for the Admin view,
+and the HTML for the front-end.
+
+#### Slice Field Types
+
+```
+Field Type   | Best for               | HTML Control
+-------------+------------------------+--------------------
+string       | Single lines of text   | Text input
+text         | Multiple lines of text | Textarea
+boolean      | Settings               | Checkbox input
+date         | Dates                  | Date input
+datetime     | Times                  | Datetime input
+attachments  | Files and images       | Attachment composer
+page         | Links to other pages   | Internal link field
+```
+
+An example of a complicated Slice:
+
+```shell
+$ rails generate slice carousel title:string gallery:attachments link:page
+```
 
 ## License
 
-Slices is released under the [MIT license](http://www.opensource.org/licenses/MIT). Copyright (c) 2014 With Associates.
+Slices is released under the [MIT license](http://www.opensource.org/licenses/MIT).
 
+Copyright (c) 2016 With Associates.

data/app/assets/javascripts/slices/app/helpers/apply_defaults.js

@@ -0,0 +1,9 @@
+// Applys default values to the context.
+//
+// Example:
+//
+//     {{applyDefaults title="Hello world" text="Lorem ipsum dolor sit amet"}}
+//
+Handlebars.registerHelper('applyDefaults', function(options) {
+  _.defaults(this, options.hash);
+});

data/app/assets/javascripts/slices/app/helpers/composer.js

@@ -17,6 +17,8 @@ Handlebars.registerHelper('composer', function(options) {
   var view = new slices.ComposerView({
     id         : slices.fieldId(this, options.hash.field),
     value      : this[options.hash.field],
+    min        : options.hash.min,
+    max        : options.hash.max,
     fields     : options.fn,
     addLabel   : options.hash.addLabel,
     autoAttach : true

data/app/assets/javascripts/slices/app/helpers/i18n.js

@@ -0,0 +1,7 @@
+Handlebars.registerHelper('ifI18nEnabled', function(options) {
+  if (slices.i18n) {
+    return options.fn(this);
+  } else {
+    return options.inverse(this);
+  }
+});

data/app/assets/javascripts/slices/app/helpers/markdown_cheat_sheet.js

@@ -0,0 +1,50 @@
+// Adds a Markdown cheat sheet.
+//
+// Example:
+//
+//     {{markdownCheatSheet}}
+//
+Handlebars.registerHelper('markdownCheatSheet', function() {
+  return new Handlebars.SafeString(
+    '<div class="markdown-cheat-sheet">' +
+      '<h4>Markdown Cheat Sheet</h4>' +
+      '<div class="columns">' +
+        '<div class="column">' +
+          '<code># This is an &lt;h1&gt;</code>' +
+          '<code>## This is an &lt;h2&gt;</code>' +
+          '<code>###### This is an &lt;h6&gt;</code>' +
+          '<code>*This text will be italic*</code>' +
+          '<code>**This text will be bold**</code>' +
+          '<code>*You **can** combine them*</code>' +
+          '<code>[A Link](http://example.com/)</code>' +
+          '<code>![An Image](http://example.com/example.jpg)</code>' +
+        '</div>' +
+        '<div class="column">' +
+          '<code>' +
+            '* An\n' +
+            '* Unordered\n' +
+            '* List' +
+          '</code>' +
+          '<code>' +
+            '1. An\n' +
+            '2. Ordered\n' +
+            '3. List\n' +
+            '   * With\n' +
+            '   * Sub\n' +
+            '   * List' +
+          '</code>' +
+          '<code>' +
+            'The following is a blockquote:\n\n' +
+            '> Sed posuere consectetur est at lobortis. Aenean lacinia\n' +
+            '> bibendum nulla sed consectetur. Maecenas sed diam eget\n' +
+            '> risus varius blandit sit amet non magna.' +
+          '</code>' +
+        '</div>' +
+      '</div>' +
+    '</div>'
+  );
+});
+
+$(document).on('click', '.markdown-cheat-sheet h4', function() {
+  $(this).parent().toggleClass('display');
+});

data/app/assets/javascripts/slices/app/helpers/radio_field.js

@@ -0,0 +1,21 @@
+// Creates a radio field.
+//
+// Example:
+//
+//     {{#radioField field="example"}}
+//       <input type="radio" value="one">
+//       <input type="radio" value="two">
+//       <input type="radio" value="three">
+//     {{/radioField}}
+//
+Handlebars.registerHelper('radioField', function(options) {
+  var view = new slices.RadioFieldView({
+    id         : slices.fieldId(this, options.hash.field),
+    name       : options.hash.field,
+    value      : this[options.hash.field],
+    inner      : options.fn,
+    autoAttach : true
+  });
+
+  return new Handlebars.SafeString(view.placeholder());
+});

data/app/assets/javascripts/slices/app/helpers/sitemap.js

@@ -80,7 +80,7 @@ $(function () {
       contentType: 'application/json',
       dataType: 'json',
       success: function (data, statusText, xhr) {
-        // TODO:
+        location.reload();
       },
       error: function (xhr, textStatus, errorThrown) {
         // TODO:
@@ -146,5 +146,86 @@ $(function () {
     return false;
   });
 
+  function loadLocalStorage() {
+    var ids = JSON.parse(localStorage.getItem('sitemap.hidden'));
+
+    $('.toggle-children').filter(function() {
+      var id = $(this).attr('href').substring(1);
+      return $.inArray(id, ids) >= 0;
+    }).each(function() {
+      toggleChildren(this, false, true);
+    });
+  }
+
+  function updateLocalStorage() {
+    var ids = $('.page-children.hidden').map(function() {
+      return $(this).attr('id');
+    }).toArray();
+
+    localStorage['sitemap.hidden'] = JSON.stringify(ids);
+  }
+
+  function toggleChildren(target, value, instant) {
+    var toggle   = $(target),
+        selector = toggle.attr('href'),
+        element  = $(selector);
+
+    if (value) {
+      if (instant) {
+        element.show();
+      } else {
+        element.slideDown('fast');
+      }
+
+      element.removeClass('hidden');
+      toggle.removeClass('active');
+    } else {
+      if (instant) {
+        element.hide();
+      } else {
+        element.slideUp('fast');
+      }
+
+      element.addClass('hidden');
+      toggle.addClass('active');
+    }
+
+    updateLocalStorage();
+  }
+
+  function showChildren() {
+    toggleChildren(this, true);
+  }
+
+  function hideChildren() {
+    toggleChildren(this, false);
+  }
+
+  $('.hide-all-children').click(function() {
+    $('.toggle-children').each(hideChildren);
+  });
+
+  $('.show-all-children').click(function() {
+    $('.page-children:hidden .page-children').show();
+    $('.toggle-children').each(showChildren);
+  });
+
+  $('.toggle-children').click(function(event) {
+    event.preventDefault();
+
+    var toggle   = $(this),
+        selector = toggle.attr('href'),
+        element  = $(selector);
+
+    element.slideToggle('fast').toggleClass('hidden');
+    toggle.toggleClass('active');
+    updateLocalStorage();
+  });
+
+  if ($('.page-children .page-children').size() == 0) {
+    $('.toggle-actions').hide();
+  }
+
+  loadLocalStorage();
 });
 

data/app/assets/javascripts/slices/app/helpers/uploader.js

@@ -43,7 +43,7 @@ $.extend(slices.Uploader.prototype, Backbone.Events, {
       type     : 'file',
       multiple : 'multiple',
       style    : 'position: absolute; visibility: hidden'
-    });
+    }).appendTo('body');
   },
 
   observeEvents: function() {

data/app/assets/javascripts/slices/app/helpers/url_field.js

@@ -0,0 +1,17 @@
+// Creates a URL field.
+//
+// Example:
+//
+//     {{urlField field="example"}}
+//
+Handlebars.registerHelper('urlField', function(options) {
+  var view = new slices.UrlFieldView({
+    id         : slices.fieldId(this, options.hash.field),
+    name       : options.hash.field,
+    value      : this[options.hash.field],
+    autoAttach : true
+  });
+
+  return new Handlebars.SafeString(view.placeholder());
+});
+

data/app/assets/javascripts/slices/app/slices.js

@@ -51,17 +51,18 @@ var slices = {
 
       slices.availableContainers = settings.availableContainers;
       slices.availableSlices = settings.availableSlices;
+      slices.i18n = settings.i18n;
 
 
       addSliceOptions(slices.availableSlices);
 
-      templates = [
+      templates = _.flatten([
         'slice',
         settings.mainTemplate,
         settings.metaTemplate,
-        settings.mainExtraTemplate,
-        settings.metaExtraTemplate
-      ];
+        settings.mainExtraTemplates,
+        settings.metaExtraTemplates
+      ]);
 
       loadSliceTemplates(pageId);
       loadTemplates(templates, pageId, loadPageModel);
@@ -298,10 +299,12 @@ var slices = {
           $('#page-meta').slideDown('fast');
           $(this).html('<a href="#">hide advanced options</a>');
           $(this).addClass('open');
+          $(document).trigger('slices:didShowAdvancedOptions');
         }, function() {
           $('#page-meta').slideUp('fast');
           $(this).html('<a href="#">advanced options&hellip;</a>');
           $(this).removeClass('open');
+          $(document).trigger('slices:didHideAdvancedOptions');
         });
 
         if (slices.model.Page.seemsNew()) $('#show-meta').trigger('click');
@@ -312,16 +315,16 @@ var slices = {
 
     function initMeta() {
       $('#page-main').html(renderMetaFields(settings.mainTemplate));
-
       $('#page-meta').html(renderMetaFields(settings.metaTemplate));
+      $('#page-extra-main').empty();
 
-      if (settings.metaExtraTemplate) {
-        $('#page-meta').append(renderMetaFields(settings.metaExtraTemplate));
-      }
+      $.each(settings.metaExtraTemplates, function(i, template) {
+        $('#page-meta').append(renderMetaFields(template));
+      });
 
-      if (settings.mainExtraTemplate) {
-        $('#page-extra-main').html(renderMetaFields(settings.mainExtraTemplate));
-      }
+      $.each(settings.mainExtraTemplates, function(i, template) {
+        $('#page-extra-main').append(renderMetaFields(template));
+      });
 
       $('#page-meta-fields').applyDataValues().initDataPlugins();
 

data/app/assets/javascripts/slices/app/views/composer_view.js

@@ -86,12 +86,28 @@ slices.ComposerView = Backbone.View.extend({
   },
 
   update: function() {
+    this.ensureMinAndMax();
+
     var value = this.collection.toJSON();
     this.$el.data('computed-value', value);
     this.$el[this.collection.isEmpty() ? 'removeClass' : 'addClass']('not-empty');
     if (this.broadcastChanges) this.$el.trigger('change');
   },
 
+  ensureMinAndMax: function() {
+    var actions = this.$('.composer-actions');
+
+    if (this.collection.length < this.options.min) {
+      this.collection.add({});
+    }
+
+    if (this.collection.length >= this.options.max) {
+      actions.hide();
+    } else {
+      actions.show();
+    }
+  },
+
   addItem: function(item, collection, options) {
     var view = new slices.ComposerItemView({
       fields: this.options.fields,