cmsable 0.0.9 → 0.4.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    Nzc0ZDhiMTI0NjI3NzRmZDNhOTY1YWM3YzM4Yjc2OWYyYjM4NDVhNw==
+    ZDExMzlmMDNmOTdmODBjNGYyM2NjNzBhMjgxZjliMGYxODY0MWMxMQ==
   data.tar.gz: !binary |-
-    NTc4ZmM3ZDQ1NzY2Njc0MTYxOWNiOGVjYzRjMGQ4YjM4MDA2NjI4NQ==
+    ZDhiZmQwYzNlZjgwODU2NjI5OWRiZjI0NTljMzQ5YWViMzFmMWJjNw==
 SHA512:
   metadata.gz: !binary |-
-    YjhiYzQ0NWIyZGYzOWM4OWQzN2UyZTIxZjQ3MmYyMWM1MzMwYTA3NzBlMjI3
-    N2I3OTY2NDNiODlmNGVmM2Q5MjMwYWNmNDA2Mjk1NDY5YTk0MDFkOTY0NjBh
-    OTI2MjYxODhhMTY3MjU2MzI4NDNlY2Y5ODZlZGIyNzQxYWNmYjc=
+    YjM2YmY0MDRjZmYwMTBlYmQwNTBlY2M1NzdhN2I1OTQ0NDk2YjkzY2IwNmVm
+    ZGEzMjgwYjcyMzlkNTgzNzU3NDkwNTgxN2M0MmEzMjAyNDIzMzRlYTk4N2Ni
+    ZjZiNWNlOTBmNzRmZmIwYWFiZDcxOTZhMzkzMDZhZmVhOWViMGU=
   data.tar.gz: !binary |-
-    YjkxZjFlNmViYjMzMTU2MzNjOGNlMTBjY2EyNDZkOTY5MWEzYTk5MjI3Yjhh
-    OTFhYjQ1YzlhODc4MTVkNzg4MGVhOTg4NTk5NzZkZDUwZTg5NDEwM2M4MWVk
-    YTA0ZjkzZmIyMWE4ZTNiYTJiMjI1OTcyNmU4M2I5YTMyZGNmZDY=
+    OTQ3Y2Q1ZjQ4Yzc1NmIxZDdjMDM0MmY1NzBiYTdmMzY5MWQyZDRmNTVmNDkw
+    Y2Y2ZDczZDhiYjZiYzljMjExNDk1YmMxZTVlNmNlN2I1NmRkNTczY2IxZTli
+    YzdkZmEzMGRjYmUxYjBhZWUzNWIwNjA3N2E2ZTI0ZDJlOTUzYzM=

data/README.md

@@ -0,0 +1,106 @@
+# Cmsable
+---------
+
+Add inline editable content to pages.
+
+## Installation
+
+Add to your Gemfile
+
+```ruby
+gem 'cmsable'
+```
+
+Get Dependencies
+
+    bundle install
+
+Add to your routes
+
+```ruby
+  mount Cmsable::Engine => '/cmsable'
+```
+
+Install and run the migrations if you want to use the built in model
+
+    rake cmsable:install:migrations
+    rake db:migrate
+
+Cmsable uses CanCan so make sure this is set up in your necessary controller(s)
+If your users aren't called users then you'll get something like:
+
+    undefined local variable or method `current_user' for ...
+
+You need to define the current_ability, e.g.
+
+```ruby
+def current_ability
+  @current_ability ||= AccountAbility.new(current_account)
+end
+```
+(From https://github.com/ryanb/cancan/wiki/changing-defaults)
+
+## Usage
+
+Add to your layout:
+
+```ruby
+<%= cmsable_assets %>
+```
+
+### To use the built in model
+In your view files
+
+```ruby
+<%= cmsable 'identifier' %>
+```
+
+Identifier can be any string or symbol, for example `'Homepage Intro'` or `:something`
+
+For plain text areas pass `plain: true` as an option.
+This way you can put content in any tag you want without worrying about users
+messing up the markup.
+
+```ruby
+<span><%= cmsable :identifier, plain: true %></span>
+```
+
+The problem with the above is that in edit mode you'll end up with invalid HTML:
+
+```html
+<span><div contenteditable>Content</div></span>
+```
+
+To avoid this you can override the tag used in edit mode:
+
+```ruby
+<%= cmsable :identifier, plain: true, tag: 'span' %>
+```
+Resulting in:
+```html
+<span contenteditable>Content</span>
+```
+
+### To use your own models
+Add to your model:
+
+```ruby
+cmsable :body => :column_to_use_for_content
+```
+
+Then in your views:
+```ruby
+<%= cmsable @model_instance %>
+```
+
+## TODO
+  - Handle saving errors
+  - Remove CanCan dependancy
+  - Decouple ckeditor
+  - Support different editors
+  - Setup config initializer for added customizability
+  - Add file mode
+  - Add image mode
+  - Add video mode (youtube/vimeo/etc)
+  - Add support for langs/i18n
+  - Fix highlight so empty areas are still visible

data/app/assets/javascripts/cmsable/cmsable.js

@@ -8,7 +8,9 @@ $(function() {
     $('#cmsable_control a').toggleClass('cmsable_on');
     if ($(this).hasClass('cmsable_on')) {
       $('.cmsable_editor').addClass('cmsable_reveal').attr('contenteditable', true);
-      CKEDITOR.inlineAll();
+      $('.cmsable_rich').each(function(idx, ele) {
+        CKEDITOR.inline(ele);
+      });
     }else{
       $('.cmsable_editor').removeClass('cmsable_reveal').attr('contenteditable', false);
       $.each(CKEDITOR.instances, function(index, instance) {
@@ -20,29 +22,44 @@ $(function() {
   $(document).on('click', '.cmsable_save.cmsable_on', function() {
     $('#cmsable_control').addClass('processing');
     var that = this,
-        updated = 0,
-        instances = 0;
+        token = that.getAttribute('data-token');
+
+    var cmsables = [];
+
+    // Submit plain text fields
+    $('.cmsable_plain').each(function(idx, ele) {
+      $ele = $(ele);
+      cmsables.push({
+        id: ele.id.replace(/\D/g, ''),
+        model: $ele.data('model'),
+        body: $ele.text()
+      });
+    });
+
+    // Submit CKEditor fields
     $.each(CKEDITOR.instances, function(index, instance) {
-      instances++;
-      var id = instance.name.replace(/\D/g, ''),
-          model = instance.element.$.getAttribute('data-model'),
-          token = that.getAttribute('data-token'),
-          body = instance.getData();
-      $.post('/cmsable/' + id, {
+      cmsables.push({
+        id: instance.name.replace(/\D/g, ''),
+        model: instance.element.$.getAttribute('data-model'),
+        body: instance.getData()
+      });
+    });
+
+    $.each(cmsables, function(idx, cmsable) {
+      $.post('/cmsable/' + cmsable.id, {
                    _method: 'put',
-                     model: model,
+                     model: cmsable.model,
         authenticity_token: token,
                    content: {
-                     body: body
+                     body: cmsable.body
                    }
       }, function(data) {
-        updated++;
-        if (updated === instances) {
+        if (idx == cmsables.length - 1) {
           $('#cmsable_control').removeClass('processing');
         }
       });
     });
+
     $('.cmsable_edit').click();
   });
-
 });

data/app/helpers/cmsable/cmsable_helper.rb

@@ -1,32 +1,50 @@
+# encoding: utf-8
 module Cmsable
+  # Cmsable view helpers
   module CmsableHelper
-
     def cmsable_assets
       javascript_include_tag('cmsable/application') +
       stylesheet_link_tag('cmsable/application')
     end
 
-    def cmsable name_or_model, options = {}
+    TYPES = [
+      :rich, # CKEditor (default)
+      :plain # Nothing fancy
+    ]
+
+    DEFAULTS = {
+      readonly: false, # Can edit by default
+      type: :rich,      # Use rich text editor by default
+      plantext: false,  # No text editor
+      tag: nil # What tag to use for contenteditable
+    }
 
+    def cmsable(name_or_model, options = {})
       model = get_model name_or_model
 
-      options = {
-        readonly:false
-      }.merge options
+      options = DEFAULTS.merge options
+
+      # Fail on unknow types
+      typefail options[:type] unless TYPES.include? options[:type]
 
-      # Skip checking permission of set to readonly or
+      # Skip checking permission if set to readonly or
       # explicit authorisation is passed
-      unless options.include?(:authorised) or options[:readonly]
-        options[:authorised] = authorised?(model)
-      end
+      readonly = options.include?(:authorised) || options[:readonly]
+      options[:authorised] = authorised?(model) unless readonly
 
-      content_or_editable_content model, (options[:authorised] and !options[:readonly])
+      content = model.send(model.cmsable_body).html_safe
+      editable = options[:authorised] && !options[:readonly]
 
+      editable ? show_cmsable(content, model, options) : uncmsable(content, options[:tag])
     end
 
-  private
+    private
+
+    def type_fail(type)
+      fail "Unknown cmsable type: #{type}." + "Must be one of #{TYPES * ', '}"
+    end
 
-    def get_model name_or_model
+    def get_model(name_or_model)
       if name_or_model.class < ActiveRecord::Base
         name_or_model
       else
@@ -34,31 +52,33 @@ module Cmsable
       end
     end
 
-    def content_or_editable_content model, editable
-      control = if(!@cmsable_control_rendered and editable)
-        render :template => 'cmsable/cmsable/control'
-      end
+    def show_cmsable(content, model, options)
+      control = unless @cmsable_control_rendered
+                  render template: 'cmsable/cmsable/control'
+                end
       @cmsable_control_rendered = true
-      content = model.send(model.cmsable_body).html_safe
-      if editable
-        content_tag(:div, content, {
-                    class: :cmsable_editor,
-                       id: "cmsable_edit_#{model.class.to_s.parameterize}_#{model.id}",
-          :'data-model' => model.class,
-        }) + (control or '')
+      id = "cmsable_edit_#{model.class.to_s.parameterize}_#{model.id}"
+      content_tag((options[:tag] || :div), content,
+                  class: "cmsable_editor cmsable_#{options[:type]}",
+                  id: id,
+                  'data-model' => model.class,
+      ) + (control || '')
+    end
+
+    def uncmsable(content, tag)
+      if tag
+        content_tag tag, content
       else
         content
       end
     end
 
-    def authorised? model
-      authorised = false
+    def authorised?(model)
       if Cmsable.const_defined? :CanCan
-        authorised = can? :update, model
+        can? :update, model
       else
-        authorised = Cmsable.authorised
+        Cmsable.authorised
       end
     end
-
   end
 end

data/lib/cmsable.rb

@@ -1,24 +1,21 @@
-require "cmsable/engine"
+# encoding: utf-8
+require 'cmsable/engine'
 
 module Cmsable
-
   mattr_accessor :authorised
 
+  # Add cmsable method to ActiveRecord classes
   module ClassMethods
-    def cmsable options = {}
-
+    def cmsable(options = {})
       cattr_accessor :cmsable_body
 
       options = {
-        :body => :body
+        body: :body
       }.merge options
 
       self.cmsable_body = options[:body]
-
     end
   end
-
 end
 
-# Add cmsable method to ActiveRecord classes
 ActiveRecord::Base.send :extend, Cmsable::ClassMethods

data/lib/cmsable/engine.rb

@@ -1,7 +1,8 @@
+# encoding: utf-8
 module Cmsable
+# This makes the consuming app load our helpers
   class Engine < ::Rails::Engine
     isolate_namespace Cmsable
-    # This makes the consuming app load our helpers
     initializer 'cmsable.action_controller' do |app|
       ActiveSupport.on_load :action_controller do
         helper Cmsable::CmsableHelper

data/lib/cmsable/version.rb

@@ -1,3 +1,3 @@
 module Cmsable
-  VERSION = "0.0.9"
+  VERSION = '0.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cmsable
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.4.0
 platform: ruby
 authors:
 - Nick Butler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-16 00:00:00.000000000 Z
+date: 2014-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -75,7 +75,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - MIT-LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - app/assets/images/cmsable/ajax-loader.gif
 - app/assets/images/cmsable/construction.png

data/README.rdoc

@@ -1,57 +0,0 @@
-# Cmsable
-
-Add inline editable content to pages.
-
-Installation:
-
-Add to your Gemfile
-  gem 'cmsable'
-
-Get Dependencies
-  bundle install
-
-Add to your routes
-  mount Cmsable::Engine => '/cmsable'
-
-Install and run the migrations if you want to use the built in model
-  rake cmsable:install:migrations
-  rake db:migrate
-
-Cmsable uses CanCan so make sure this is setup in your necessary controller(s)
-If your users aren't called users then you'll get something like:
-  undefined local variable or method `current_user' for ...
-
-You need to define the current_ability, e.g.
-  def current_ability
-    @current_ability ||= AccountAbility.new(current_account)
-  end
-From https://github.com/ryanb/cancan/wiki/changing-defaults
-
-Usage:
-
-In your layout
-  <%= cmsable_assets %>
-
-To use the built in model
-  In your view files
-    <%= cmsable 'identifier' %>
-
-Identifier can be anything, for example 'Homepage Intro' or something
-
-To use existing models
-  Add to your model
-    cmsable :body => :column_to_use_for_content
-  Then in your views
-    <%= cmsable @model_instance %>
-
-## TODO
-  - Handle saving errors
-  - Remove CanCan dependancy
-  - Decouple ckeditor
-  - Support different editors
-  - Setup config initializer for added customizability
-  - Add plain text mode
-  - Add file mode
-  - Add image mode
-  - Add video mode (youtube/vimeo/etc)
-  - Fix highlight so empty areas are still visible