rich_cms 2.1.7 → 3.0.0

data/{CHANGELOG → CHANGELOG.rdoc}

@@ -1,5 +1,29 @@
 = Rich-CMS CHANGELOG
 
+== Version 3.0.0 (February 7, 2011)
+
+* Refactored the authentication code. Being able to run Rich-CMS with:
+  - no authentication
+  - Devise 1.0.9 (for Rails 2)
+  - Devise 1.1.5 (for Rails 3)
+  - Authlogic 2.1.6
+* Altered configurating the authentication setup
+* Altered the login/logout Rich-CMS routes
+* Altered the admin generator (this was rich:autlogic_user at first, but it is rich:cms_admin from now on)
+* Updated gem dependencies (not using Formtastic and Authlogic anymore)
+* Improved the test suite. Being able to test Rich-CMS with:
+  - Rails 2 without authentication
+  - Rails 2 with Devise 1.0.9
+  - Rails 2 with Authlogic 2.1.6
+  - Rails 3 without authentication
+  - Rails 3 with Devise 1.1.5
+  - Rails 3 with Authlogic 2.1.6
+  - All tests include testing the Rails generators and migrating the test database (woot!)
+  - Added very handy rake tasks for testing
+  - Outputting extra info during integration tests
+* Altered file encoding of cleditor.js which removes the weird characters within rich_cms.js
+* Implemented Array.indexOf for our IE friends. Thanks Mark Mulder (@bitterzoet) for contributing
+
 == Version 2.1.7 (November 24, 2010)
 
 * Fixed loading the correct config/routes.rb when using a Rails 2 application with another gem / plugin also containing config/routes.rb

data/README.textile

@@ -20,7 +20,7 @@ Add Rich-CMS in @Gemfile@ as a gem dependency:
 Run the following in your console to install with Bundler:
 
 <pre>
-  sudo bundle install
+  bundle install
 </pre>
 
 h3. Using Rich-CMS as gem in Rails 2
@@ -37,53 +37,59 @@ Run the following in your console:
   sudo rake gems:install
 </pre>
 
-h3. Using Rich-CMS as plugin in Rails 3
-
-<pre>
-  rails plugin install git://github.com/archan937/rich_cms.git
-</pre>
-
-h3. Using Rich-CMS as plugin in Rails 2
-
-<pre>
-  script/plugin install git://github.com/archan937/rich_cms.git
-</pre>
-
 h2. Use the provided Rails generators
 
-Rich-CMS requires two entities:
+Rich-CMS requires one entity:
 
-* An @Authlogic@ authenticated user model
 * An @ActiveRecord@ model used for CMS content storage
 
-Fortunately, Rich-CMS is provided with two Rails generators with which you can generate both entities.
+For (optional) authentication, Rich-CMS requires one of the following:
+
+* A @Devise@ authenticated admin model
+* A @Authlogic@ authenticated admin model
 
-h3. Authlogic user
+Fortunately, Rich-CMS is provided with two Rails generators with which you can generate those entities.
+
+h3. CMS admin
 
 h4. In Rails 3
 
 Run the following in your console:
 
 <pre>
-  rails g rich:authlogic_user -m
+  rails g rich:cms_admin -m
 </pre>
 
-*Note*: At default, it will create both the @User@ and @UserSession@ classes and @CreateUsers@ migration. You can alter the class names with the following:
+*Note*: At default, it will create a ("Devise":http://github.com/plataformatec/devise powered) @User@ model, the @CreateUsers@ migration and it will configure your routes.
+
+You can alter the class name as follows:
 
 <pre>
-  rails g rich:authlogic_user CodeHeroes::User -m
+  rails g rich:cms_admin CodeHeroes::User -m
 </pre>
 
 *Note*: Both generators have the @-m@ or @--migrate@ option which runs @rake db:migrate@ after creating the files.
 
+*Using Authlogic*
+
+You can use Authlogic by specifying the @-a@ or @--authlogic@ option:
+
+<pre>
+  rails g rich:cms_admin CodeHeroes::User -a -m
+</pre>
+
+*Note*: As mentioned earlier, Devise is the default authentication logic. Having that said, you can explicitly specify Devise with the @-d@ or @--devise@ option.
+
 h4. In Rails 2
 
 Run the following in your console:
 
 <pre>
-  script/generate rich_authlogic_user -m
+  script/generate rich_cms_admin -m
 </pre>
 
+*Attention*: The @Devise@ Rails generator code is (practically) a copy of the "Devise 1.0.9 generator code":https://github.com/plataformatec/devise/tree/v1.0.9/generators/devise. For there are problems calling the original Devise generators in Rails 2. See also this "Stackoverflow issue":http://stackoverflow.com/questions/3366508/couldnt-find-devise-install-generator-rails-2-3-8-devise-1-0-8.
+
 h3. CMS content
 
 h4. In Rails 3
@@ -114,13 +120,22 @@ h2. Create required entities manually
 
 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.
+Rich-CMS can be used without an authentication mechanism (which is the default by the way), you just have to open "/cms" in your browser and you are ready to go. But it is common to have authentication and Rich-CMS support "Devise":http://github.com/plataformatec/devise and "Authlogic":http://github.com/binarylogic/authlogic.
+
+Provide the authentication logic as a symbol (e.g. @:devise@) and the authenticated class like this:
 
 <pre>
-  Rich::Cms::Engine.authenticate(:authlogic, {:class_name => "User", :identifier => :email})
+  Rich::Cms::Auth.setup do |config|
+    config.logic = :devise
+    config.klass = "User"
+  end
 </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.
+The following specifications are optional as Rich-Cms uses defaults:
+
+* @:inputs@ (default: @[:email, :password]@) - The attributes used for the login panel of Rich-CMS
+* @:identifier@ (default: based on @inputs@) - The method used for displaying the identity of the current Rich-CMS admin (this is the first entry of @inputs@, so usually @:email@)
+* @:current_admin_method@ (default: based on @klass@) - The controller method used to retrieve the current Rich-CMS admin (e.g. @current_user@ when configured @User@ as authenticated class)
 
 h3. Register CMS content
 
@@ -157,25 +172,25 @@ Add the following line at the beginning of the @<body>@ tag:
 
 h3. Use the Rich-CMS helper method
 
-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:
+Rich-CMS requires a rendered DOM element provided with meta data of the content instance. Fortunately, you can call a helper method to render Rich-CMS content tags. 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(".cms_content", key)
+  >> rich_cms_tag(".cms_content", key)
   => "<div class='cms_content' data-key='test_content' data-value='Hello world!'>Hello world!</div>"
 </pre>
 
 When using a combined key for content identification, just call it as follows:
 
 <pre>
-  >> Rich::Cms::Engine.to_content_tag(".cms_content", {:key => key, :locale => I18n.locale})
+  >> rich_cms_tag(".cms_content", {:key => key, :locale => I18n.locale})
   => "<div class='cms_content' data-key='test_content' data-locale='nl' data-value='Hallo wereld!'>Hallo wereld!</div>"
 </pre>
 
 *Note*: In this case, the content was registered with @Rich::Cms::Engine.register(".cms_content", {:class_name => "Cms::StaticContent", :key => [:key, :locale]})@
 
-We have also provided you a helper method to render Rich-CMS content tags. It is provided with several options:
+The helper method is provided with the following options:
 
 * @:as@ (default: auto-determine @:string@ or @:text@) - Specify the input type shown in the edit form (@:string@ for an input text, @:text@ for a textarea and @:html@ for a WYSIWYG HTML editor).
 * @:tag@ (default: auto-determine @:div@ or @:span@) - The HTML tag used for content items.
@@ -231,11 +246,11 @@ This Rails gem / plugin depends on:
 jQuery<br>
 "http://jquery.com":http://jquery.com
 
-AuthLogic<br>
-"http://github.com/binarylogic/authlogic":http://github.com/binarylogic/authlogic
+Devise (optional)<br>
+"http://github.com/plataformatec/devise":http://github.com/plataformatec/devise
 
-Formtastic<br>
-"http://github.com/justinfrench/formtastic":http://github.com/justinfrench/formtastic
+AuthLogic (optional)<br>
+"http://github.com/binarylogic/authlogic":http://github.com/binarylogic/authlogic
 
 SASS<br>
 "http://sass-lang.com":http://sass-lang.com
@@ -262,9 +277,10 @@ Stephan Kaag - "@stephankaag":http://twitter.com/stephankaag - "http://hollandon
 
 h2. ToDo's
 
+* Support alternative ORM's and key/value stores (with "Toystore":https://github.com/newtoy/toystore and "Moneta":https://github.com/wycats/moneta probably)
+* Check out compatibility with Devise 1.2.0
 * Provide better conventions for content rendering
 * Provide tools to use Textile, MarkDown, image files upload and models (e.g. products)
-* Provide compatibility with other authentication mechanisms other than AuthLogic
 * Add cache feature which uses the standard Rails cache (rich_cms_tag ".cms_content", "test_content", :cache => true)
 
 h2. Enrichments

data/Rakefile

@@ -1,6 +1,7 @@
 require "rake"
 require "rake/testtask"
 require "rake/rdoctask"
+require "test/integrator"
 
 begin
   require "jeweler"
@@ -12,10 +13,8 @@ begin
     gemspec.homepage    = "http://codehero.es/rails_gems_plugins/rich_cms"
     gemspec.author      = "Paul Engel"
 
-    gemspec.add_dependency "authlogic" , ">= 2.1.2"
-    gemspec.add_dependency "formtastic", ">= 1.1.0"
-    gemspec.add_dependency "haml"      , ">= 3"
-    gemspec.add_dependency "jzip"      , ">= 1.0.11"
+    gemspec.add_dependency "haml", "~> 3.0.25"
+    gemspec.add_dependency "jzip", "~> 1.0.11"
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError
@@ -25,12 +24,94 @@ 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
+task :test do
+  Rake::Task["test:all"].execute
+end
+
+task :restore do
+  Rake::Task["restore:all"].execute
+end
+
+task :stash do
+  Rake::Task["stash:all"].execute
+end
+
+namespace :test do
+  desc "Test the rich_cms plugin in Rails 2 and 3."
+  task :all do
+    system "rake test:rails-2"
+    system "rake test:rails-3"
+  end
+  desc "Test the rich_cms plugin in Rails 2."
+  Rake::TestTask.new(:"rails-2") do |t|
+    t.libs    << "lib"
+    t.libs    << "test"
+    t.pattern  = "test/rails-2/{,/*/**}/*_test.rb"
+    t.verbose  = true
+  end
+  desc "Test the rich_cms plugin in Rails 3."
+  Rake::TestTask.new(:"rails-3") do |t|
+    t.libs    << "lib"
+    t.libs    << "test"
+    t.pattern  = "test/rails-3/{,/*/**}/*_test.rb"
+    t.verbose  = true
+  end
+  desc "Run all integration tests (non-authenticated, with Devise, with Authlogic) in Rails 2 and 3."
+  task :integration do
+    Integrator.run do |test|
+      test.all
+    end
+  end
+  namespace :integration do
+    desc "Run all integration tests (non-authenticated, with Devise, with Authlogic) in Rails 2."
+    task :"rails-2" do
+      Integrator.run do |test|
+        test.rails 2
+      end
+    end
+    desc "Run all integration tests (non-authenticated, with Devise, with Authlogic) in Rails 3."
+    task :"rails-3" do
+      Integrator.run do |test|
+        test.rails 2
+      end
+    end
+  end
+end
+
+namespace :restore do
+  desc "Restore the Rails 2 and 3 dummy apps."
+  task :all do
+    system "rake restore:rails-2"
+    system "rake restore:rails-3"
+  end
+  desc "Restore the Rails 2 dummy app."
+  task :"rails-2" do
+    require "test/rails-2/rich_cms/dummy_app.rb"
+    DummyApp.restore_all
+  end
+  desc "Restore the Rails 3 dummy app."
+  task :"rails-3" do
+    require "test/rails-3/rich_cms/dummy_app.rb"
+    DummyApp.restore_all
+  end
+end
+
+namespace :stash do
+  desc "Stash the Rails 2 and 3 dummy apps."
+  task :all do
+    system "rake stash:rails-2"
+    system "rake stash:rails-3"
+  end
+  desc "Stash the Rails 2 dummy app."
+  task :"rails-2" do
+    require "test/rails-2/rich_cms/dummy_app.rb"
+    DummyApp.stash_all
+  end
+  desc "Stash the Rails 3 dummy app."
+  task :"rails-3" do
+    require "test/rails-3/rich_cms/dummy_app.rb"
+    DummyApp.stash_all
+  end
 end
 
 desc "Generate documentation for the rich_cms plugin."
@@ -42,3 +123,4 @@ Rake::RDocTask.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include "MIT-LICENSE"
   rdoc.rdoc_files.include "lib/**/*.rb"
 end
+

data/VERSION

@@ -1 +1 @@
-2.1.7
+3.0.0

data/app/controllers/rich/cms_controller.rb

@@ -1,8 +1,6 @@
-
 module Rich
   class CmsController < ::ApplicationController
-
-    before_filter :require_current_rich_cms_admin, :except => [:display, :position, :login]
+    before_filter :require_login, :except => [:display, :position]
 
     def display
       (session[:rich_cms] ||= {})[:display] = params[:display]
@@ -14,52 +12,25 @@ module Rich
       render :nothing => true
     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
-
-        after_rich_cms_login authenticated, key
-      end
+    def update
+      render :json => Cms::Content::Item.new(params[:content_item]).save
     end
 
-    def logout
-      case rich_cms_auth.logic
-      when :authlogic
-        (@current_rich_cms_admin_session ||= rich_cms_authenticated_class.find).destroy
-      end
-      session[:rich_cms] = nil
-
-      after_rich_cms_logout
-    end
+  private
 
-    unless ::ApplicationController.instance_methods.include?("after_rich_cms_login")
-      def after_rich_cms_login(authenticated, key)
+    def require_login
+      if Rich::Cms::Auth.login_required?
         if request.xhr?
           render :update do |page|
-            if authenticated
-              page.reload
-            else
-              page["##{key}_#{rich_cms_authentication_inputs.first}"].focus
-            end
+            page.reload
           end
         else
           redirect_to request.referrer
         end
+        return false
       end
-    end
-
-    unless ::ApplicationController.instance_methods.include?("after_rich_cms_logout")
-      def after_rich_cms_logout
-        redirect_to request.referrer
-      end
-    end
-
-    def update
-      render :json => Cms::Content::Item.new(params[:content_item]).save
+      true
     end
 
   end
-
-end
+end

data/app/controllers/rich/cms_sessions_controller.rb

@@ -0,0 +1,31 @@
+module Rich
+  class CmsSessionsController < ::ApplicationController
+
+    def login
+      Rich::Cms::Auth.login
+      if request.xhr?
+        render :update do |page|
+          if Rich::Cms::Auth.admin
+            page.reload
+          else
+            page["##{Rich::Cms::Auth.klass_symbol}_#{Rich::Cms::Auth.inputs.first}"].focus
+          end
+        end
+      else
+        redirect_to request.referrer
+      end
+    end
+
+    def logout
+      Rich::Cms::Auth.logout
+      if request.xhr?
+        render :update do |page|
+          page.reload
+        end
+      else
+        redirect_to request.referrer
+      end
+    end
+
+  end
+end

data/app/views/rich/cms/dock/_menu.html.erb

@@ -1,23 +1,25 @@
 <ul id="rich_cms_menu">
-  <% unless current_rich_cms_admin %>
+  <% if rich_cms_login_required? %>
     <li>
       Rich-CMS
     </li>
     <li class="last">
-      <%= link "Login" %>
+      <%= link_to "Login", "#", :class => "login" %>
     </li>
   <% else %>
     <li>
-      <%= current_rich_cms_admin_name %>
+      <%= current_rich_cms_admin_label %>
     </li>
     <li>
-      <%= link "Mark content", :class => "mark" %>
+      <%= link_to "Mark content", "#", :class => "mark" %>
     </li>
-    <li>
+    <li class="<%= "last" unless Rich::Cms::Auth.enabled? %>">
       <%= link_to "Hide"  , rich_cms_hide_path   %>
     </li>
-    <li class="last">
-      <%= link_to "Logout", rich_cms_logout_path %>
-    </li>
+    <% if Rich::Cms::Auth.enabled? %>
+      <li class="last">
+        <%= link_to "Logout", rich_cms_logout_path %>
+      </li>
+    <% end %>
   <% end %>
 </ul>

data/app/views/rich/cms/dock/_panel.html.erb

@@ -1,3 +1,3 @@
 <div id="rich_cms_panel" style="display: none">
-  <%= render :partial => "rich/cms/dock/panel/#{current_rich_cms_admin.nil? ? "login" : "edit"}" %>
+  <%= render :partial => "rich/cms/dock/panel/#{rich_cms_login_required? ? "login" : "edit"}" %>
 </div>

data/app/views/rich/cms/dock/panel/edit/_rails2.html.erb

@@ -1,10 +1,12 @@
 <div class="edit">
-  <% form_tag rich_cms_update_path, :name => "rich_cms_content", :class => "ajaxify" do %>
+  <%  form_tag rich_cms_update_path, :name => "rich_cms_content", :class => "ajaxify" do %>
     <fieldset class="inputs">
-      <label></label>
+      <div class="keys">
+        <label>Editing:&nbsp; </label>
+      </div>
     </fieldset>
     <fieldset class="buttons">
-      <%= submit_tag "Save" %> <%= link "Close" %>
+      <%= submit_tag "Save" %> <%= link_to "Close", "#", :class => "close" %>
     </fieldset>
   <% end %>
 </div>

data/app/views/rich/cms/dock/panel/edit/_rails3.html.erb

@@ -1,10 +1,12 @@
 <div class="edit">
   <%= form_tag rich_cms_update_path, :name => "rich_cms_content", :class => "ajaxify" do %>
     <fieldset class="inputs">
-      <label></label>
+      <div class="keys">
+        <label>Editing:&nbsp; </label>
+      </div>
     </fieldset>
     <fieldset class="buttons">
-      <%= submit_tag "Save" %> <%= link "Close" %>
+      <%= submit_tag "Save" %> <%= link_to "Close", "#", :class => "close" %>
     </fieldset>
   <% end %>
 </div>

data/app/views/rich/cms/dock/panel/login/_rails2.html.erb

@@ -1,15 +1,21 @@
 <div class="login">
-  <% semantic_form_for rich_cms_authenticated_class.new, :url => rich_cms_login_path, :html => {:class => "ajaxify"} do |form| %>
-
-    <%  form.inputs do %>
-      <% rich_cms_authentication_inputs.each do |input| %>
-        <%= form.input input, :input_html => {:size => ""} %>
-      <% end %>
-    <% end %>
-
-    <% form.buttons do %>
-      <%= form.submit "Login" %>
-    <% end %>
-
+  <%  form_for rich_cms_admin_class.new, :url => rich_cms_login_path, :html => {:class => "ajaxify"} do |form| %>
+    <fieldset class="inputs">
+      <ol>
+        <% rich_cms_admin_inputs.each do |input| %>
+          <li class="<%= input.to_s =~ /password/ ? "password" : "string" %> required">
+            <%= form.label input, "#{input.to_s.humanize} <abbr title='required'>*</abbr>" %>
+            <%= form.send :"#{input.to_s =~ /password/ ? "password" : "text"}_field", input, :html => {:size => ""} %>
+          </li>
+        <% end %>
+      </ol>
+    </fieldset>
+    <fieldset class="buttons">
+      <ol>
+        <li>
+          <%= submit_tag "Login" %>
+        </li>
+      </ol>
+    </fieldset>
   <% end %>
 </div>

data/app/views/rich/cms/dock/panel/login/_rails3.html.erb

@@ -1,15 +1,21 @@
 <div class="login">
-  <%= semantic_form_for rich_cms_authenticated_class.new, :url => rich_cms_login_path, :html => {:class => "ajaxify"} do |form| %>
-
-    <%=  form.inputs do %>
-      <% rich_cms_authentication_inputs.each do |input| %>
-        <%= form.input input, :input_html => {:size => ""} %>
-      <% end %>
-    <% end %>
-
-    <%= form.buttons do %>
-      <%= form.submit "Login" %>
-    <% end %>
-
+  <%= form_for rich_cms_admin_class.new, :url => rich_cms_login_path, :html => {:class => "ajaxify"} do |form| %>
+    <fieldset class="inputs">
+      <ol>
+        <% rich_cms_admin_inputs.each do |input| %>
+          <li class="<%= input.to_s =~ /password/ ? "password" : "string" %> required">
+            <%= form.label input, "#{input.to_s.humanize} <abbr title='required'>*</abbr>".html_safe %>
+            <%= form.send :"#{input.to_s =~ /password/ ? "password" : "text"}_field", input, :html => {:size => ""} %>
+          </li>
+        <% end %>
+      </ol>
+    </fieldset>
+    <fieldset class="buttons">
+      <ol>
+        <li>
+          <%= submit_tag "Login" %>
+        </li>
+      </ol>
+    </fieldset>
   <% end %>
 </div>

data/app/views/rich_cms.html.erb

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