cmsable 0.0.2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,56 @@
+= Cmsable
+
+This project rocks and uses MIT-LICENSE.
+
+Installation:
+
+Add to your Gemfile
+  gem 'cmsable'
+
+Make sure you're using ckeditor 4
+  bundle install
+If that doesn't work
+  bundle update ckeditor
+
+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 dm: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
+  Complete gemspec
+  Handle save fails
+  Rename to Messable
+  Allow to fallback to built in auth if no CanCan
+  Add other auth library support?
+  Setup config initializer for added customizability
+  Create some tests, I guess

data/Rakefile

@@ -0,0 +1,40 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Cmsable'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

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

@@ -0,0 +1,14 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require ckeditor/init
+//= require_tree .

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

@@ -0,0 +1,48 @@
+// Place all the behaviors and hooks related to the matching controller here.
+// All this logic will automatically be available in application.js.
+$(function() {
+
+  CKEDITOR.disableAutoInline = true;
+
+  $('.cmsable_edit').on('click', function() {
+    $('#cmsable_control a').toggleClass('cmsable_on');
+    if ($(this).hasClass('cmsable_on')) {
+      $('.cmsable_editor').addClass('reveal').attr('contenteditable', true);
+      CKEDITOR.inlineAll();
+    }else{
+      $('.cmsable_editor').removeClass('reveal').attr('contenteditable', false);
+      $.each(CKEDITOR.instances, function(index, instance) {
+        instance.destroy();
+      });
+    }
+  });
+
+  $(document).on('click', '.cmsable_save.cmsable_on', function() {
+    $('#cmsable_control').addClass('processing');
+    var that = this,
+        updated = 0,
+        instances = 0;
+    $.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, {
+                   _method: 'put',
+                     model: model,
+        authenticity_token: token,
+                   content: {
+                     body: body
+                   }
+      }, function(data) {
+        updated++;
+        if (updated === instances) {
+          $('#cmsable_control').removeClass('processing');
+        }
+      });
+    });
+    $('.cmsable_edit').click();
+  });
+
+});

data/app/assets/stylesheets/cmsable/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/app/assets/stylesheets/cmsable/cmsable.css

@@ -0,0 +1,74 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/
+.cmsable_editor.reveal {
+  background:url(/assets/cmsable/construction.png); /* http://www.patternsky.com/textures/hazard-stripes-texture/ */
+}
+
+#cmsable_control {
+  position:fixed;
+  left:80%;
+  top:-10px;
+  border-radius:0 0 5px 5px;
+  box-shadow:2px 2px 15px #454545;
+  background:#999;
+  -webkit-transition:All 0.5s ease; -moz-transition:All 0.5s ease; -o-transition:All 0.5s ease;
+  z-index:9999;
+}
+
+#cmsable_control a {
+  float:left;
+  display:block;
+  background:#454545;
+  padding:20px 10px 10px;
+  font-size:10px;
+  font-family:sans;
+  color:white;
+  cursor:pointer;
+  box-shadow:inset 0 0 10px #999;
+  z-index:1;
+  position:relative;
+}
+
+#cmsable_control a:hover {
+  background:#666;
+}
+
+#cmsable_control a.cmsable_edit {
+  border-radius:0 0 0 5px;
+}
+
+#cmsable_control a.cmsable_save {
+  border-radius:0 0 5px 0;
+  background:#858585;
+  color:#bbb;
+  cursor:default;
+}
+
+#cmsable_control a.cmsable_save.cmsable_on {
+  background:rgb(70, 121, 185);
+  color:white;
+  cursor:pointer;
+}
+
+#cmsable_control a.cmsable_edit.cmsable_on {
+  background:rgb(94, 182, 94);
+}
+
+#cmsable_control .cmsable_processing {
+  background:url(/assets/cmsable/ajax-loader.gif) no-repeat center 15px;
+  padding:10px;
+  width:16px;
+  height:16px;
+  display:block;
+  float:left;
+  text-indent:-9999px;
+  overflow:hidden;
+  margin-left:-40px;
+  -webkit-transition:All 0.5s ease; -moz-transition:All 0.5s ease; -o-transition:All 0.5s ease;
+}
+
+#cmsable_control.processing .cmsable_processing {
+  margin-left:0;
+}

data/app/controllers/cmsable/cmsable_controller.rb

@@ -0,0 +1,12 @@
+module Cmsable
+  class CmsableController < ApplicationController
+    def update
+      model = params[:model].constantize
+
+      render :text => false and return if cannot? :update, model
+
+      attribute = model.cmsable_body
+      render :text => model.find(params[:id]).update_attribute(attribute, params[:content][:body])
+    end
+  end
+end

data/app/helpers/cmsable/application_helper.rb

@@ -0,0 +1,4 @@
+module Cmsable
+  module ApplicationHelper
+  end
+end

data/app/helpers/cmsable/cmsable_helper.rb

@@ -0,0 +1,56 @@
+module Cmsable
+  module CmsableHelper
+
+    def cmsable_assets
+      javascript_include_tag('cmsable/application') +
+      stylesheet_link_tag('cmsable/application')
+    end
+
+    def cmsable name_or_model, options = {}
+
+      model = get_model name_or_model
+
+      options = {
+        authorised:authorised?(model)
+      }.merge options
+
+      content_or_editable_content model, options[:authorised]
+
+    end
+
+  private
+
+    def get_model name_or_model
+      if name_or_model.class < ActiveRecord::Base
+        name_or_model
+      else
+        Content.get(name_or_model)
+      end
+    end
+
+    def content_or_editable_content model, authorised
+      control = render :template => 'cmsable/cmsable/control' unless @cmsable_control_rendered
+      @cmsable_control_rendered = true
+      content = model.send(model.cmsable_body).html_safe
+      if authorised
+        content_tag(:div, content, {
+                    class: :cmsable_editor,
+                       id: "cmsable_edit_#{model.class.to_s.parameterize}_#{model.id}",
+          :'data-model' => model.class,
+        }) + (control or '')
+      else
+        content
+      end
+    end
+
+    def authorised? model
+      authorised = false
+      if Cmsable.const_defined? :CanCan
+        authorised = can? :update, model
+      else
+        authorised = Cmsable.authorised
+      end
+    end
+
+  end
+end

data/app/models/cmsable/content.rb

@@ -0,0 +1,29 @@
+module Cmsable
+  class Content < ActiveRecord::Base
+    # Extensions
+    cmsable
+
+    # Attribute accessibility
+    attr_accessible :body, :name
+
+    # Validations
+    validates :name, :presence => true
+
+    # Virtual Attributes
+
+    # Callbacks
+
+    # Instance Methods
+
+    # Class Methods
+    def self.set name, body
+      find_by_name(name).update_attribute :body, body
+    end
+
+    def self.get name
+      find_or_create_by_name name, :body => "Awaiting Content"
+    end
+
+    # Scopes
+  end
+end

data/app/views/cmsable/cmsable/control.html.erb

@@ -0,0 +1,5 @@
+<div id="cmsable_control">
+  <a class="cmsable_edit">Edit Mode</a>
+  <a class="cmsable_save" data-token="<%= form_authenticity_token %>">Save Changes</a>
+  <span class="cmsable_processing">Processing...</span>
+</div>

data/config/routes.rb

@@ -0,0 +1,4 @@
+Cmsable::Engine.routes.draw do
+  get '/:action', :to => 'cmsable'
+  put '/:id', :to => 'cmsable#update'
+end

data/db/migrate/20130308053818_create_cmsable_contents.rb

@@ -0,0 +1,10 @@
+class CreateCmsableContents < ActiveRecord::Migration
+  def change
+    create_table :cmsable_contents do |t|
+      t.string :name
+      t.text :body
+
+      t.timestamps
+    end
+  end
+end

data/lib/cmsable/engine.rb

@@ -0,0 +1,11 @@
+module Cmsable
+  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
+      end
+    end
+  end
+end

data/lib/cmsable/version.rb

@@ -0,0 +1,3 @@
+module Cmsable
+  VERSION = "0.0.2"
+end

data/lib/cmsable.rb

@@ -0,0 +1,24 @@
+require "cmsable/engine"
+
+module Cmsable
+
+  mattr_accessor :authorised
+
+  module ClassMethods
+    def cmsable options = {}
+
+      cattr_accessor :cmsable_body
+
+      options = {
+        :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/tasks/cmsable_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :cmsable do
+#   # Task goes here
+# end

data/test/cmsable_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class CmsableTest < ActiveSupport::TestCase
+  test "truth" do
+    assert_kind_of Module, Cmsable
+  end
+end