rich_cms 2.0.2 → 2.0.3

data/CHANGELOG

@@ -1,5 +1,10 @@
 = Rich-CMS CHANGELOG
 
+== Version 2.0.3 (September 30, 2010)
+
+* Added rails generators 'rich_authlogic_user' and 'rich_cms_content'
+* Finetuned the jQuery function $.keys()
+
 == Version 2.0.2 (September 9, 2010)
 
 * Corrected the Rich::Cms::Engine.to_content_tag implementation when using combined keys

data/README.textile

@@ -31,7 +31,46 @@ Install the Rich-CMS plugin:
   ./script/plugin install git://github.com/archan937/rich_cms.git 
 </pre>
 
-h2. Usage
+h2. Use the provided Rails generators
+
+Rich-CMS requires two entities:
+
+* 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.
+
+h3. Authlogic user
+
+Run the following in your console:
+
+<pre>
+  script/generate rich_authlogic_user
+</pre>
+
+*Note*: At default, it will create both the User and UserSesson classes and CreateUsers migration. You can alter the class names with the following:
+
+<pre>
+  script/generate rich_authlogic_user CodeHeroes::User
+</pre>
+
+h3. CMS content
+
+Run the following in your console:
+
+<pre>
+  script/generate rich_cms_content
+</pre>
+
+*Note*: At default, it will create the CmsContent model and CreateCmsContents migration. You can alter the class name with the following:
+
+<pre>
+  script/generate rich_cms_content CmsItem
+</pre>
+
+In case you have used the Rails generators, you can skip the *Create required entities manually* section and go straight to *Render Rich-CMS in your layout*.
+
+h2. Create required entities manually
 
 h3. Specify the authentication mechanism
 
@@ -163,9 +202,10 @@ SeatHolder<br>
 
 h2. ToDo's
 
+* Add feature with which textilized content is editable
 * 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
+* Add cache feature which uses the standard Rails cache (rich_cms_tag ".cms_content", "test_content", :cache => true)
 
 h2. E9s
 

data/Rakefile

@@ -12,6 +12,7 @@ begin
     gemspec.homepage    = "http://github.com/archan937/rich_cms"
     gemspec.author      = "Paul Engel"
 
+    gemspec.add_dependency "authlogic"
     gemspec.add_dependency "jzip", ">= 1.0.10"
     gemspec.add_dependency "haml", ">= 3"
     gemspec.add_dependency "formtastic", "0.9.7"

data/VERSION

@@ -1 +1 @@
-2.0.2
+2.0.3

data/lib/assets/jzip/jquery/extensions/object.js

@@ -3,7 +3,9 @@ $.extend({
   keys: function(object) {
     var result = [];
     for (var key in object) {
-      result.push(key);
+      if (object.hasOwnProperty(key)) {
+        result.push(key);
+      }
     }
     return result;
   },

data/rails_generators/rich_authlogic_user/rich_authlogic_user_generator.rb

@@ -0,0 +1,61 @@
+class RichAuthlogicUserGenerator < Rails::Generator::Base
+  def initialize(runtime_args, runtime_options = {})
+    super
+    @name = @args.first || "user"
+  end
+
+  def manifest
+    record do |m|
+      m.directory                          "app/models"
+      m.template               "model.rb", "app/models/#{model_file_name}.rb"
+      m.template             "session.rb", "app/models/#{model_file_name}_session.rb"
+      m.template              "config.rb", "config/initializers/enrichments.rb", {:collision => :skip}
+      m.migration_template "migration.rb", "db/migrate", :migration_file_name => migration_file_name
+    end
+  end
+  
+  def after_generate
+    File.open(destination_path("config/initializers/enrichments.rb"), "a+") do |file|
+      file << "\nRich::Cms::Engine.authenticate(:authlogic, {:class_name => \"#{model_class_name}\", :identifier => :email})"
+    end
+    
+    system "rake db:migrate" if options[:migrate]
+  end
+
+  def model_file_name
+    @name.underscore
+  end
+
+  def model_class_name
+    @name.classify
+  end
+  
+  def table_name
+    model_file_name.gsub("/", "_").pluralize
+  end
+
+  def migration_file_name
+    "create_#{table_name}"
+  end
+
+  def migration_class_name
+    migration_file_name.camelize
+  end
+
+protected
+
+  def add_options!(opt)
+    opt.separator ""
+    opt.separator "Options:"
+    opt.on("-m", "--migrate", "Run 'rake db:migrate' after generating model and migration.") { options[:migrate] = true }
+  end
+  
+  def banner
+    <<-EOS
+Creates Authlogic model and migration and also registers authenticated model to Rich-CMS.
+
+USAGE: #{$0} #{spec.name} [model_name]
+EOS
+  end
+
+end

data/rails_generators/rich_authlogic_user/templates/migration.rb

@@ -0,0 +1,25 @@
+class <%= migration_class_name %> < ActiveRecord::Migration
+  def self.up
+    create_table :<%= table_name %> do |t|
+      t.string   :name
+      t.string   :email
+      t.string   :crypted_password
+      t.string   :password_salt
+      t.datetime :created_at
+      t.string   :persistence_token  , :default => "", :null => false
+      t.string   :single_access_token, :default => "", :null => false
+      t.string   :perishable_token   , :default => "", :null => false
+      t.integer  :login_count
+      t.datetime :last_request_at
+      t.datetime :current_login_at
+      t.datetime :last_login_at
+      t.timestamps
+    end
+    
+    add_index :<%= table_name %>, :email
+  end
+
+  def self.down
+    drop_table :<%= table_name %>
+  end
+end

data/rails_generators/rich_authlogic_user/templates/model.rb

@@ -0,0 +1,8 @@
+class <%= model_class_name %> < ActiveRecord::Base
+
+  acts_as_authentic do |c|
+    c.login_field            = :email
+    c.crypted_password_field = :crypted_password
+  end
+  
+end

data/rails_generators/rich_authlogic_user/templates/session.rb

@@ -0,0 +1,7 @@
+class <%= model_class_name %>Session < Authlogic::Session::Base
+
+  authenticate_with <%= model_class_name %>
+  generalize_credentials_error_messages true
+  params_key "user_credentials"
+
+end

data/rails_generators/rich_cms_content/rich_cms_content_generator.rb

@@ -0,0 +1,60 @@
+class RichCmsContentGenerator < Rails::Generator::Base
+  def initialize(runtime_args, runtime_options = {})
+    super
+    @name = @args.first || "cms_content"
+  end
+
+  def manifest
+    record do |m|
+      m.directory                          "app/models"
+      m.template               "model.rb", "app/models/#{model_file_name}.rb"
+      m.template              "config.rb", "config/initializers/enrichments.rb", {:collision => :skip}
+      m.migration_template "migration.rb", "db/migrate", :migration_file_name => migration_file_name
+    end
+  end
+  
+  def after_generate
+    File.open(destination_path("config/initializers/enrichments.rb"), "a+") do |file|
+      file << "\nRich::Cms::Engine.register(\".#{model_file_name}\", {:class_name => \"#{model_class_name}\"})"
+    end
+    
+    system "rake db:migrate" if options[:migrate]
+  end
+
+  def model_file_name
+    @name.underscore
+  end
+
+  def model_class_name
+    @name.classify
+  end
+  
+  def table_name
+    model_file_name.gsub("/", "_").pluralize
+  end
+
+  def migration_file_name
+    "create_#{table_name}"
+  end
+
+  def migration_class_name
+    migration_file_name.camelize
+  end
+
+protected
+
+  def add_options!(opt)
+    opt.separator ""
+    opt.separator "Options:"
+    opt.on("-m", "--migrate", "Run 'rake db:migrate' after generating model and migration.") { options[:migrate] = true }
+  end
+
+  def banner
+    <<-EOS
+Creates Rich-CMS content model and migration and also registers content to Rich-CMS.
+
+USAGE: #{$0} #{spec.name} [model_name]
+EOS
+  end
+
+end

data/rails_generators/rich_cms_content/templates/migration.rb

@@ -0,0 +1,15 @@
+class <%= migration_class_name %> < ActiveRecord::Migration
+  def self.up
+    create_table :<%= table_name %> do |t|
+      t.string :key
+      t.text   :value
+      t.timestamps
+    end
+    
+    add_index :<%= table_name %>, :key
+  end
+
+  def self.down
+    drop_table :<%= table_name %>
+  end
+end

data/rails_generators/rich_cms_content/templates/model.rb

@@ -0,0 +1,2 @@
+class <%= model_class_name %> < ActiveRecord::Base
+end

data/rich_cms.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rich_cms}
-  s.version = "2.0.2"
+  s.version = "2.0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Paul Engel"]
-  s.date = %q{2010-09-09}
+  s.date = %q{2010-09-30}
   s.description = %q{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.}
   s.email = %q{paul.engel@holder.nl}
   s.extra_rdoc_files = [
@@ -74,6 +74,15 @@ Gem::Specification.new do |s|
      "lib/rich/cms/engine.rb",
      "lib/rich_cms.rb",
      "rails/init.rb",
+     "rails_generators/rich_authlogic_user/rich_authlogic_user_generator.rb",
+     "rails_generators/rich_authlogic_user/templates/config.rb",
+     "rails_generators/rich_authlogic_user/templates/migration.rb",
+     "rails_generators/rich_authlogic_user/templates/model.rb",
+     "rails_generators/rich_authlogic_user/templates/session.rb",
+     "rails_generators/rich_cms_content/rich_cms_content_generator.rb",
+     "rails_generators/rich_cms_content/templates/config.rb",
+     "rails_generators/rich_cms_content/templates/migration.rb",
+     "rails_generators/rich_cms_content/templates/model.rb",
      "rich_cms.gemspec",
      "tasks/rich_cms_tasks.rake",
      "test/engine_test.rb",
@@ -95,15 +104,18 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<authlogic>, [">= 0"])
       s.add_runtime_dependency(%q<jzip>, [">= 1.0.10"])
       s.add_runtime_dependency(%q<haml>, [">= 3"])
       s.add_runtime_dependency(%q<formtastic>, ["= 0.9.7"])
     else
+      s.add_dependency(%q<authlogic>, [">= 0"])
       s.add_dependency(%q<jzip>, [">= 1.0.10"])
       s.add_dependency(%q<haml>, [">= 3"])
       s.add_dependency(%q<formtastic>, ["= 0.9.7"])
     end
   else
+    s.add_dependency(%q<authlogic>, [">= 0"])
     s.add_dependency(%q<jzip>, [">= 1.0.10"])
     s.add_dependency(%q<haml>, [">= 3"])
     s.add_dependency(%q<formtastic>, ["= 0.9.7"])

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rich_cms
 version: !ruby/object:Gem::Version 
-  hash: 11
+  hash: 9
   prerelease: false
   segments: 
   - 2
   - 0
-  - 2
-  version: 2.0.2
+  - 3
+  version: 2.0.3
 platform: ruby
 authors: 
 - Paul Engel
@@ -15,13 +15,27 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-09 00:00:00 +02:00
+date: 2010-09-30 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: jzip
+  name: authlogic
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: jzip
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -33,11 +47,11 @@ dependencies:
         - 10
         version: 1.0.10
   type: :runtime
-  version_requirements: *id001
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: haml
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -47,11 +61,11 @@ dependencies:
         - 3
         version: "3"
   type: :runtime
-  version_requirements: *id002
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: formtastic
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
@@ -63,7 +77,7 @@ dependencies:
         - 7
         version: 0.9.7
   type: :runtime
-  version_requirements: *id003
+  version_requirements: *id004
 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.
 email: paul.engel@holder.nl
 executables: []
@@ -131,6 +145,15 @@ files:
 - lib/rich/cms/engine.rb
 - lib/rich_cms.rb
 - rails/init.rb
+- rails_generators/rich_authlogic_user/rich_authlogic_user_generator.rb
+- rails_generators/rich_authlogic_user/templates/config.rb
+- rails_generators/rich_authlogic_user/templates/migration.rb
+- rails_generators/rich_authlogic_user/templates/model.rb
+- rails_generators/rich_authlogic_user/templates/session.rb
+- rails_generators/rich_cms_content/rich_cms_content_generator.rb
+- rails_generators/rich_cms_content/templates/config.rb
+- rails_generators/rich_cms_content/templates/migration.rb
+- rails_generators/rich_cms_content/templates/model.rb
 - rich_cms.gemspec
 - tasks/rich_cms_tasks.rake
 - test/engine_test.rb