rich_cms 1.0.0

data/.gitignore

@@ -0,0 +1,2 @@
+.DS_Store
+pkg/*

data/CHANGELOG

@@ -0,0 +1,5 @@
+= Rich-CMS CHANGELOG
+
+== Version 1.0.0 (August 15, 2010)
+
+* Initial release

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Paul Engel
+
+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.textile

@@ -0,0 +1,158 @@
+
+h1. Rich-CMS
+
+A Rails gem (and also plugin) for a pluggable CMS frontend
+
+h2. Introduction
+
+Rich-CMS is a module of E9s ("http://github.com/archan937/e9s":http://github.com/archan937/e9s) which provides a frontend for your CMS content.
+
+h2. Installation
+
+h3. Using Rich-CMS as gem
+
+Install the Rich-CMS gem:
+
+<pre>
+  sudo gem install rich_cms
+</pre>
+
+Add rich_cms in @environment.rb@ as a gem dependency:
+
+<pre>
+  config.gem "rich_cms"
+</pre>
+
+h3. Using Rich-CMS as plugin
+
+Install the Rich-CMS plugin:
+
+<pre>
+  ./script/plugin install git://github.com/archan937/rich_cms.git 
+</pre>
+
+h2. Usage
+
+h3. Specify the authentication mechanism
+
+Provide the mechanism as a symbol (e.g. @:authlogic@) and the authenticated class along with the attribute used to identify the instance in a hash.
+
+<pre>
+  Rich::Cms::Engine.authenticate(:authlogic, {:class_name => "Betty::User", :identifier => :name})
+</pre>      
+
+Unfortunately, only AuthLogic ("http://github.com/binarylogic/authlogic":http://github.com/binarylogic/authlogic) is supported, but we are working hard on making Rich-CMS compatible with other mechanisms.
+
+h3. Register CMS content
+
+Every type of content is identified with its correspending CSS selector (used by the jQuery based Javascript module of Rich-CMS). You will have to provide some specifications:
+
+* @:class_name@ - The class of the CMS content model which contain the data
+
+The following specifications are optional as Rich-Cms uses defaults:
+
+* @:key@ (default: @:key@) - The key used for identification of content. You can also provide an array for a combined key (e.g. @[:key, :locale]@)
+* @:value@ (default: @:value@) - The attribute which stores the value of the content instance.
+* @:tag@ (default: @:span@) - The tag used for content items.
+* @:add@ (default: @[]@) - An array of the content item attributes included within the HTML attributes.
+* @:before_edit@ (default: @nil@) - Javascript function called before showing the edit form of a content item
+* @:after_update@ (default: @Rich.Cms.Editor.afterUpdate@) - Javascript function called after update a content item
+
+<pre>
+  Rich::Cms::Engine.register(".betty_cms_content", {:class_name => "Betty::Cms::StaticContent"})
+  Rich::Cms::Engine.register(".i18n"             , {:class_name => "Translation", :key => [:key, :locale], :before_edit => "Rich.I18n.beforeEdit", :after_update => "Rich.I18n.afterUpdate"})
+</pre>
+
+h3. Render CMS content in your views
+
+Rich-CMS requires a rendered DOM element provided with meta data of the content instance. Fortunately, you can call a method provided by Rich-CMS. Just specify the identifier of the content type and the key of the CMS content instance in question:
+
+<pre>
+  >> key = "test_content"
+  => "test_content"
+  >> Rich::Cms::Engine.to_content_tag(".betty_cms_content", key)
+  => "<div class='betty_cms_content' data-key='test_content' data-value='Hello world!'>Hello world!</div>"
+</pre>
+
+h3. Rich-CMS in your browser
+
+Open "http://localhost:3000/cms":http://localhost:3000/cms, log in and start managing CMS content.
+
+h2. Customizing the after update implementation
+
+The @update@ action response of @Rich::CmsController@ is provided with "JSON":http://www.json.org data regarding the updated content item. The response will be passed to the @after_update@ Javascript function. Its default JSON data:
+
+<pre>
+  {"__selector__": ".betty_cms_content", "__identifier__": {"key": "test_paragraph"}, "value": "Hello world!"}
+</pre>
+
+*Note*: @__selector__@ and @__identifier__@ are *always* provided in the JSON data.
+
+When specifying a custom after update Javascript function, you probably want to acquire more information than provided in the default JSON data. You can customize this by defining the @to_rich_cms_response@ method in the CMS content model class:
+
+<pre>
+  class Translation < ActiveRecord::Base
+  
+    def to_rich_cms_response(params)
+      {:value => value, :translations => Hash[*params[:derivative_keys].split(";").uniq.collect{|x| [x, x.t]}.flatten]}
+    end
+  
+  end
+</pre>
+
+The JSON data provided will be look like:
+
+<pre>
+  {"__selector__": ".i18n", "__identifier__": {"locale": "nl", "key": "word.user"}, "value": "gebruiker", "translations": {"users": "gebruikers"}}
+</pre>
+
+h2. Contact me
+
+For support, remarks and requests please mail me at "paul.engel@holder.nl":mailto:paul.engel@holder.nl.
+
+h2. Credit
+
+This Rails gem / plugin depends on:
+
+jQuery<br>
+"http://jquery.com":http://jquery.com
+
+Jzip<br>
+"http://github.com/archan937/jzip":http://github.com/archan937/jzip
+
+SASS<br>
+"http://sass-lang.com":http://sass-lang.com
+
+Formtastic<br>
+"http://github.com/justinfrench/formtastic":http://github.com/justinfrench/formtastic
+
+SeatHolder (optional)<br>
+"http://github.com/archan937/seat_holder":http://github.com/archan937/seat_holder
+
+h2. ToDo's
+
+* Complete README.textile (provide documentation about optional features)
+* Integrate Rich-CMS in the E9s demo application ("http://github.com/archan937/e9s-demo":http://github.com/archan937/e9s-demo)
+* Provide compatibility with other authentication mechanisms other than AuthLogic
+
+h2. E9s
+
+E9s - "http://github.com/archan937/e9s":http://github.com/archan937/e9s
+
+h3. E9s modules
+
+* Rich-CMS - "http://github.com/archan937/rich_cms":http://github.com/archan937/rich_cms
+* Rich-i18n - "http://github.com/archan937/rich_i18n":http://github.com/archan937/rich_i18n
+* Rich-pluralization - "http://github.com/archan937/rich_pluralization":http://github.com/archan937/rich_pluralization
+
+h2. License
+
+Copyright (c) 2010 Paul Engel, released under the MIT license
+
+"http://holder.nl":http://holder.nl - "http://codehero.es":http://codehero.es - "http://gettopup.com":http://gettopup.com - "http://twitter.com/archan937":http://twitter.com/archan937 - "paul.engel@holder.nl":mailto:paul.engel@holder.nl
+
+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/Rakefile

@@ -0,0 +1,43 @@
+require "rake"
+require "rake/testtask"
+require "rake/rdoctask"
+
+begin
+  require "jeweler"
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name        = "rich_cms"
+    gemspec.summary     = "Enrichments (e9s) module for a pluggable CMS frontend"
+    gemspec.description = "Rich-CMS is a module of E9s (http://github.com/archan937/e9s) which provides a frontend for your CMS content. You can use this gem to manage CMS content or translations (in an internationalized application). The installation and setup process is very easily done. You will have to register content at the Rich-CMS engine and also you will have to specify the authentication mechanism. Both are one-liners."
+    gemspec.email       = "paul.engel@holder.nl"
+    gemspec.homepage    = "http://github.com/archan937/rich_cms"
+    gemspec.author      = "Paul Engel"
+
+    gemspec.add_dependency "jzip"
+    gemspec.add_dependency "haml", ">= 3"
+    gemspec.add_dependency "formtastic"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+desc "Default: run unit tests."
+task :default => :test
+
+desc "Test the rich_cms plugin."
+Rake::TestTask.new(:test) do |t|
+  t.libs    << "lib"
+  t.libs    << "test"
+  t.pattern  = "test/**/*_test.rb"
+  t.verbose  = true
+end
+
+desc "Generate documentation for the rich_cms plugin."
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title    = "Rich-CMS"
+  rdoc.options << "--line-numbers" << "--inline-source"
+  rdoc.rdoc_files.include "README"
+  rdoc.rdoc_files.include "MIT-LICENSE"
+  rdoc.rdoc_files.include "lib/**/*.rb"
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/init.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), "rails", "init")

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/app/controllers/rich/cms_controller.rb

@@ -0,0 +1,56 @@
+
+module Rich
+  class CmsController < ::ApplicationController
+
+    before_filter :require_current_rich_cms_admin, :except => [:show, :hide, :login]
+  
+    def show
+      display_bar(true)
+    end
+
+    def hide
+      display_bar(false)
+    end
+
+    def login
+      case rich_cms_auth.logic
+      when :authlogic
+        @current_rich_cms_admin_session = rich_cms_authenticated_class.new params[key = rich_cms_authenticated_class.name.underscore.gsub("/", "_")]
+        authenticated = @current_rich_cms_admin_session.save
+
+        if request.xhr?
+          render :update do |page|
+            if authenticated
+              page.reload
+            else
+              page["##{key}_#{rich_cms_authentication_inputs.first}"].focus
+            end
+          end
+        else
+          redirect_to request.referrer
+        end        
+      end
+    end
+
+    def logout
+      case rich_cms_auth.logic
+      when :authlogic
+        (@current_rich_cms_admin_session ||= rich_cms_authenticated_class.find).destroy
+      end
+      hide
+    end
+
+    def update
+      render :json => Cms::Content::Item.new(params[:content_item]).save
+    end
+
+  private
+
+    def display_bar(display)
+      (session[:rich_cms] ||= {})[:display] = display
+      redirect_to request.referrer
+    end
+
+  end
+  
+end

data/lib/app/views/rich/cms/_bar.html.erb

@@ -0,0 +1,4 @@
+<div id="rich_cms_bar">
+  <%= render :partial => "rich/cms/bar/menu"  %>
+  <%= render :partial => "rich/cms/bar/panel" %>
+</div>

data/lib/app/views/rich/cms/_config.html.erb

@@ -0,0 +1,5 @@
+<script type="text/javascript">
+  $(function() {
+    Rich.Cms.Editor.register(<%= Rich::Cms::Engine.editable_content_javascript_hash %>);
+  });
+</script>

data/lib/app/views/rich/cms/bar/_menu.html.erb

@@ -0,0 +1,16 @@
+<div class="menu">
+  <% if current_rich_cms_admin %>
+    <%= link "Mark copy", :class => "mark" %>
+  <% end %>
+  
+  <% unless current_rich_cms_admin %>
+    <%= link "Login" %>
+  <% else %>
+    <div class="admin">
+      Logged in as <strong><%= current_rich_cms_admin_name %></strong>
+      &nbsp;&nbsp;
+      <%= link_to "Hide"  , rich_cms_hide_path   %>
+      <%= link_to "Logout", rich_cms_logout_path %>
+    </div>
+  <% end %>
+</div>

data/lib/app/views/rich/cms/bar/_panel.html.erb

@@ -0,0 +1,3 @@
+<div class="panel">
+  <%= render :partial => "rich/cms/bar/panel/#{current_rich_cms_admin.nil? ? "login" : "edit"}" %>
+</div>

data/lib/app/views/rich/cms/bar/panel/_edit.html.erb

@@ -0,0 +1,10 @@
+<div class="edit" style="display: none">
+  <% form_tag rich_cms_update_path, :name => "rich_cms_content", :class => "ajaxify" do %>
+    <fieldset class="inputs">
+      <label></label>
+    </fieldset>
+    <fieldset class="buttons">
+      <%= submit_tag "Save" %> <%= link "Close" %>
+    </fieldset>
+  <% end %>
+</div>

data/lib/app/views/rich/cms/bar/panel/_login.html.erb

@@ -0,0 +1,11 @@
+<div class="login" style="display: none">
+  <% semantic_form_for rich_cms_authenticated_class.new, :url => rich_cms_login_path, :html => {:class => "ajaxify"} do |form| %>
+
+    <%= form.inputs *rich_cms_authentication_inputs %>
+
+    <% form.buttons do %>
+      <%= form.submit "Login" %>
+    <% end %>
+    
+  <% end %>
+</div>

data/lib/app/views/rich_cms.html.erb

@@ -0,0 +1,5 @@
+<%= stylesheet_link_tag    "rich_cms" %>
+<%= javascript_include_tag "rich_cms" %>
+
+<%= render :partial => "rich/cms/config" %>
+<%= render :partial => "rich/cms/bar" %>