rich_cms 2.1.7 → 3.0.0

data/lib/rich/cms/engine.rb

@@ -1,4 +1,3 @@
-
 module Rich
   module Cms
     class Engine < Rails::Engine
@@ -7,24 +6,41 @@ module Rich
       end
 
       class << self
-
-        attr_reader :authentication, :editable_content
+        attr_reader :editable_content
+        attr_writer :current_controller
 
         def init
-          @authentication   = AuthenticationSpecs.new
           @editable_content = {}
+          append_to_load_path
+          setup_assets
+        end
 
+        def register(*args)
+          (editables = args.first.is_a?(Hash) ? args.first : Hash[*args]).each do |selector, specs|
+            if @editable_content.keys.include?(selector)
+              raise RichCmsError, "Already registered editable content identified with #{selector.inspect}"
+            else
+              @editable_content[selector] = Cms::Content::Group.build(selector, specs)
+            end
+          end
+        end
+
+      private
+
+        def append_to_load_path
           %w(controllers).each do |dir|
             path = File.join File.dirname(__FILE__), "..", "..", "app", dir
             $LOAD_PATH << path
             ActiveSupport::Dependencies.autoload_paths << path
             ActiveSupport::Dependencies.autoload_once_paths.delete path
           end
+        end
 
+        def setup_assets
           procedure = proc {
             ::Jzip::Engine.add_template_location({File.expand_path("../../../../assets/jzip", __FILE__) => File.join(Rails.root, "public", "javascripts")})
             ::Sass::Plugin.add_template_location( File.expand_path("../../../../assets/sass", __FILE__),   File.join(Rails.root, "public", "stylesheets") )
-            copy_assets
+            copy_images
           }
 
           if Rails::VERSION::MAJOR >= 3
@@ -36,7 +52,7 @@ module Rich
           end
         end
 
-        def copy_assets
+        def copy_images
           return if Rails.env == "test"
 
           source_dir = File.join File.dirname(__FILE__), "..", "..", "..", "assets", "images", "."
@@ -47,54 +63,10 @@ module Rich
           FileUtils.cp_r    source_dir, target_dir
         end
 
-        def current_controller=(current_controller)
-          @current_controller  = current_controller
-          @can_render_metadata = nil
-        end
-
-        def authenticate(logic, specs)
-          @authentication = AuthenticationSpecs.new(logic, specs)
-        end
-
-        def register(*args)
-          (editables = args.first.is_a?(Hash) ? args.first : Hash[*args]).each do |selector, specs|
-            if @editable_content.keys.include?(selector)
-              raise RichCmsError, "Already registered editable content identified with #{selector.inspect}"
-            else
-              @editable_content[selector] = Cms::Content::Group.build(selector, specs)
-            end
-          end
-        end
-
-        def to_content_tag(selector, identifiers, options = {})
-          editable_content[selector].fetch(identifiers).to_tag options
-        end
-
-        def editable_content_javascript_hash
-          "{#{@editable_content.collect{|k, v| v.to_javascript_hash}.join ", "}}".html_safe
-        end
-
-        def can_render_metadata?
-          if @can_render_metadata.nil?
-            @can_render_metadata = case authentication.logic
-                                   when :authlogic
-                                     @current_controller.try :current_rich_cms_admin
-                                   when nil
-                                     true
-                                   end
-          else
-            @can_render_metadata
-          end
-        end
-
-      private
-
-        AuthenticationSpecs = Struct.new(:logic, :specs)
-
       end
 
     end
   end
 end
 
-Rich::Cms::Engine.init
+Rich::Cms::Engine.init

data/lib/rich/cms/rails/engine.rb

@@ -1,5 +1,4 @@
-
 unless defined?(Rails::Engine)
   class Rails::Engine
   end
-end
+end

data/lib/rich/cms/version.rb

@@ -0,0 +1,11 @@
+module Rich
+  module Cms
+    module VERSION
+      MAJOR = 3
+      MINOR = 0
+      TINY  = 0
+
+      STRING = [MAJOR, MINOR, TINY].join(".")
+    end
+  end
+end

data/lib/rich_cms.rb

@@ -1,12 +1,12 @@
-require "authlogic"
-require "formtastic"
 require "jzip"
 require "haml"
+require "devise/version" if defined?(Devise)
 
 require "rich/cms/core"
 require "rich/cms/activesupport"
 require "rich/cms/actionpack"
 require "rich/cms/rails"
+require "rich/cms/auth"
 require "rich/cms/engine"
 require "rich/cms/content/group"
 require "rich/cms/content/item"

data/rails_generators/rich_cms_admin/lib/devise/route_devise.rb

@@ -0,0 +1,32 @@
+module Rails
+  module Generator
+    module Commands
+      class Create < Base
+
+        # Create devise route. Based on route_resources
+        def route_devise(*resources)
+          resource_list = resources.map { |r| r.to_sym.inspect }.join(', ')
+          sentinel = 'ActionController::Routing::Routes.draw do |map|'
+
+          logger.route "map.devise_for #{resource_list}"
+          unless options[:pretend]
+            gsub_file 'config/routes.rb', /(#{Regexp.escape(sentinel)})/mi do |match|
+              "#{match}\n  map.devise_for #{resource_list}\n"
+            end
+          end
+        end
+      end
+
+      class Destroy < RewindBase
+
+        # Destroy devise route. Based on route_resources
+        def route_devise(*resources)
+          resource_list = resources.map { |r| r.to_sym.inspect }.join(', ')
+          look_for = "\n  map.devise_for #{resource_list}\n"
+          logger.route "map.devise_for #{resource_list}"
+          gsub_file 'config/routes.rb', /(#{look_for})/mi, ''
+        end
+      end
+    end
+  end
+end

data/rails_generators/rich_cms_admin/rich_cms_admin_generator.rb

@@ -0,0 +1,113 @@
+require File.expand_path("../lib/devise/route_devise.rb", __FILE__)
+
+class RichCmsAdminGenerator < Rails::Generator::Base
+  def initialize(runtime_args, runtime_options = {})
+    super
+    @name  = @args.first || "user"
+    @logic = options[:logic] || "Devise"
+  end
+
+  def manifest
+    check_for_warnings
+    record do |m|
+      m.file "config.rb", "config/initializers/enrichments.rb", {:collision => :skip}
+      send :"generate_#{@logic.underscore}_assets", m
+    end
+  end
+
+  def after_generate
+    filename = destination_path("config/initializers/enrichments.rb")
+    line     = "Rich::Cms::Auth.setup do |config|"
+
+    return if File.open(filename).readlines.collect(&:strip).include? line.strip
+
+    File.open(filename, "a+") do |file|
+      file << "#{line}\n"
+      file << "  config.logic = :#{@logic.underscore}\n"
+      file << "  config.klass = \"#{model_class_name}\"\n"
+      file << "end"
+    end
+
+    system "rake db:migrate" if options[:migrate]
+  end
+
+  # //////////////////////////////////
+  # // Helper methods
+  # //////////////////////////////////
+
+  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 banner
+    <<-BANNER.gsub(/^ {7}/, "")
+Creates Devise / Authlogic model and configures your Rails application for Rich-CMS authentication.
+
+USAGE: #{$0} #{spec.name} [model_name]
+    BANNER
+  end
+
+  def add_options!(opt)
+    opt.separator ""
+    opt.separator "Options:"
+    opt.on("-d", "--devise"   , "Use Devise as authentication logic (this is default)."      ) { options[:logic  ] = "Devise"    }
+    opt.on("-a", "--authlogic", "Use Authlogic as authentication logic."                     ) { options[:logic  ] = "Authlogic" }
+    opt.on("-m", "--migrate"  , "Run 'rake db:migrate' after generating model and migration.") { options[:migrate] = true        }
+  end
+
+private
+
+  def check_for_warnings
+    unless defined?(Devise)    || @logic.to_s.underscore != "devise"
+      puts <<-WARNING.gsub(/^ {9}/, "")
+        Don't forget to install Devise 1.0.9!
+      WARNING
+    end
+    unless defined?(Authlogic) || @logic.to_s.underscore != "authlogic"
+      puts <<-WARNING.gsub(/^ {9}/, "")
+        Don't forget to install Authlogic 2.1.6!
+      WARNING
+    end
+  end
+
+  def generate_devise_assets(m)
+    if defined?(Devise)
+      m.directory          "config/initializers"
+      m.directory          "config/locales"
+      m.template           "devise/devise.rb", "config/initializers/devise.rb"
+      m.file               "devise/en.yml"   , "config/locales/devise.en.yml"
+      m.readme             "devise/README"
+    end
+
+    m.directory          "app/models"
+    m.template           "devise/model.rb"    , "app/models/#{model_file_name}.rb"
+    m.migration_template "devise/migration.rb", "db/migrate", :migration_file_name => "devise_#{migration_file_name}"
+    m.route_devise       table_name
+  end
+
+  def generate_authlogic_assets(m)
+    m.directory          "app/models"
+    m.template           "authlogic/model.rb"    , "app/models/#{model_file_name}.rb"
+    m.template           "authlogic/session.rb"  , "app/models/#{model_file_name}_session.rb"
+    m.migration_template "authlogic/migration.rb", "db/migrate", :migration_file_name => migration_file_name
+  end
+
+end

data/rails_generators/rich_cms_admin/templates/devise/README

@@ -0,0 +1,23 @@
+===============================================================================
+
+Some setup you must do manually if you haven't yet:
+
+  1. Setup default url options for your specific environment. Here is an
+     example of development environment:
+
+       config.action_mailer.default_url_options = { :host => 'localhost:3000' }
+
+     This is a required Rails configuration. In production is must be the
+     actual host of your application
+
+  2. Ensure you have defined root_url to *something* in your config/routes.rb:
+
+       map.root :controller => 'home'
+
+ 3. Ensure you have a default layout in app/views/layouts and it shows
+     flash messages. For example:
+
+       <p class="notice"><%= flash[:notice] %></p>
+       <p class="alert"><%= flash[:alert] %></p>
+
+===============================================================================

data/rails_generators/rich_cms_admin/templates/devise/devise.rb

@@ -0,0 +1,105 @@
+# Use this hook to configure devise mailer, warden hooks and so forth. The first
+# four configuration values can also be set straight in your models.
+Devise.setup do |config|
+  # Configure the e-mail address which will be shown in DeviseMailer.
+  config.mailer_sender = "please-change-me@config-initializers-devise.com"
+  
+  # Configure the content type of DeviseMailer mails (defaults to text/html")
+  # config.mailer_content_type = "text/plain"
+
+  # ==> Configuration for :authenticatable
+  # Invoke `rake secret` and use the printed value to setup a pepper to generate
+  # the encrypted password. By default no pepper is used.
+  # config.pepper = "rake secret output"
+
+  # Configure how many times you want the password is reencrypted. Default is 10.
+  # config.stretches = 10
+
+  # Define which will be the encryption algorithm. Supported algorithms are :sha1
+  # (default), :sha512 and :bcrypt. Devise also supports encryptors from others
+  # authentication tools as :clearance_sha1, :authlogic_sha512 (then you should set
+  # stretches above to 20 for default behavior) and :restful_authentication_sha1
+  # (then you should set stretches to 10, and copy REST_AUTH_SITE_KEY to pepper)
+  # config.encryptor = :sha1
+
+  # Configure which keys are used when authenticating an user. By default is
+  # just :email. You can configure it to use [:username, :subdomain], so for
+  # authenticating an user, both parameters are required. Remember that those
+  # parameters are used only when authenticating and not when retrieving from
+  # session. If you need permissions, you should implement that in a before filter.
+  # config.authentication_keys = [ :email ]
+
+  # The realm used in Http Basic Authentication
+  # config.http_authentication_realm = "Application"
+
+  # ==> Configuration for :confirmable
+  # The time you want give to your user to confirm his account. During this time
+  # he will be able to access your application without confirming. Default is nil.
+  # config.confirm_within = 2.days
+
+  # ==> Configuration for :rememberable
+  # The time the user will be remembered without asking for credentials again.
+  # config.remember_for = 2.weeks
+
+  # ==> Configuration for :timeoutable
+  # The time you want to timeout the user session without activity. After this
+  # time the user will be asked for credentials again.
+  # config.timeout_in = 10.minutes
+
+  # ==> Configuration for :lockable
+  # Number of authentication tries before locking an account.
+  # config.maximum_attempts = 20
+
+  # Defines which strategy will be used to unlock an account.
+  # :email = Sends an unlock link to the user email
+  # :time  = Reanables login after a certain ammount of time (see :unlock_in below)
+  # :both  = enables both strategies
+  # config.unlock_strategy = :both
+
+  # Time interval to unlock the account if :time is enabled as unlock_strategy.
+  # config.unlock_in = 1.hour
+
+  # ==> Configuration for :token_authenticatable
+  # Defines name of the authentication token params key
+  # config.token_authentication_key = :auth_token
+
+  # ==> General configuration
+  # Load and configure the ORM. Supports :active_record (default), :mongo_mapper
+  # (requires mongo_ext installed) and :data_mapper (experimental).
+  # require 'devise/orm/mongo_mapper'
+  # config.orm = :mongo_mapper
+
+  # Turn scoped views on. Before rendering "sessions/new", it will first check for
+  # "sessions/users/new". It's turned off by default because it's slower if you
+  # are using only default views.
+  # config.scoped_views = true
+
+  # By default, devise detects the role accessed based on the url. So whenever
+  # accessing "/users/sign_in", it knows you are accessing an User. This makes
+  # routes as "/sign_in" not possible, unless you tell Devise to use the default
+  # scope, setting true below.
+  # config.use_default_scope = true
+
+  # Configure the default scope used by Devise. By default it's the first devise
+  # role declared in your routes.
+  # config.default_scope = :user
+
+  # If you want to use other strategies, that are not (yet) supported by Devise,
+  # you can configure them inside the config.warden block. The example below
+  # allows you to setup OAuth, using http://github.com/roman/warden_oauth
+  #
+  # config.warden do |manager|
+  #   manager.oauth(:twitter) do |twitter|
+  #     twitter.consumer_secret = <YOUR CONSUMER SECRET>
+  #     twitter.consumer_key  = <YOUR CONSUMER KEY>
+  #     twitter.options :site => 'http://twitter.com'
+  #   end
+  #   manager.default_strategies.unshift :twitter_oauth
+  # end
+
+  # Configure default_url_options if you are using dynamic segments in :path_prefix
+  # for devise_for.
+  # config.default_url_options do
+  #   { :locale => I18n.locale }
+  # end
+end

data/rails_generators/rich_cms_admin/templates/devise/en.yml

@@ -0,0 +1,35 @@
+en:
+  devise:
+    sessions:
+      link: 'Sign in'
+      signed_in: 'Signed in successfully.'
+      signed_out: 'Signed out successfully.'
+      unauthenticated: 'You need to sign in or sign up before continuing.'
+      unconfirmed: 'You have to confirm your account before continuing.'
+      locked: 'Your account is locked.'
+      invalid: 'Invalid email or password.'
+      invalid_token: 'Invalid authentication token.'
+      timeout: 'Your session expired, please sign in again to continue.'
+      inactive: 'Your account was not activated yet.'
+    passwords:
+      link: 'Forgot password?'
+      send_instructions: 'You will receive an email with instructions about how to reset your password in a few minutes.'
+      updated: 'Your password was changed successfully. You are now signed in.'
+    confirmations:
+      link: "Didn't receive confirmation instructions?"
+      send_instructions: 'You will receive an email with instructions about how to confirm your account in a few minutes.'
+      confirmed: 'Your account was successfully confirmed. You are now signed in.'
+    registrations:
+      link: 'Sign up'
+      signed_up: 'You have signed up successfully. If enabled, a confirmation was sent to your e-mail.'
+      updated: 'You updated your account successfully.'
+      destroyed: 'Bye! Your account was successfully cancelled. We hope to see you again soon.'
+    unlocks:
+      link: "Didn't receive unlock instructions?"
+      send_instructions: 'You will receive an email with instructions about how to unlock your account in a few minutes.'
+      unlocked: 'Your account was successfully unlocked. You are now signed in.'
+    mailer:
+      confirmation_instructions: 'Confirmation instructions'
+      reset_password_instructions: 'Reset password instructions'
+      unlock_instructions: 'Unlock Instructions'
+

data/rails_generators/rich_cms_admin/templates/devise/migration.rb

@@ -0,0 +1,23 @@
+class Devise<%= migration_class_name %> < ActiveRecord::Migration
+  def self.up
+    create_table(:<%= table_name %>) do |t|
+      t.database_authenticatable :null => false
+      t.confirmable
+      t.recoverable
+      t.rememberable
+      t.trackable
+      # t.lockable
+
+      t.timestamps
+    end
+
+    add_index :<%= table_name %>, :email,                :unique => true
+    add_index :<%= table_name %>, :confirmation_token,   :unique => true
+    add_index :<%= table_name %>, :reset_password_token, :unique => true
+    # add_index :<%= table_name %>, :unlock_token,         :unique => true
+  end
+
+  def self.down
+    drop_table :<%= table_name %>
+  end
+end

data/rails_generators/rich_cms_admin/templates/devise/model.rb

@@ -0,0 +1,9 @@
+class <%= model_class_name %> < ActiveRecord::Base
+  # Include default devise modules. Others available are:
+  # :http_authenticatable, :token_authenticatable, :confirmable, :lockable, :timeoutable and :activatable
+  devise :registerable, :database_authenticatable, :recoverable,
+         :rememberable, :trackable, :validatable
+
+  # Setup accessible (or protected) attributes for your model
+  attr_accessible :email, :password, :password_confirmation
+end

data/rails_generators/rich_cms_content/rich_cms_content_generator.rb

@@ -6,9 +6,9 @@ class RichCmsContentGenerator < Rails::Generator::Base
 
   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.directory          "app/models"
+      m.template           "model.rb"    , "app/models/#{model_file_name}.rb"
+      m.file               "config.rb"   , "config/initializers/enrichments.rb", {:collision => :skip}
       m.migration_template "migration.rb", "db/migrate", :migration_file_name => migration_file_name
     end
   end
@@ -17,13 +17,19 @@ class RichCmsContentGenerator < Rails::Generator::Base
     filename = destination_path("config/initializers/enrichments.rb")
     line     = "\nRich::Cms::Engine.register(\".#{model_file_name}\", {:class_name => \"#{model_class_name}\"})"
 
+    return if File.open(filename).readlines.collect(&:strip).include? line.strip
+
     File.open(filename, "a+") do |file|
       file << line
-    end unless File.open(filename).readlines.collect(&:strip).include? line.strip
+    end
 
     system "rake db:migrate" if options[:migrate]
   end
 
+  # //////////////////////////////////
+  # // Helper methods
+  # //////////////////////////////////
+
   def model_file_name
     @name.underscore
   end
@@ -46,18 +52,18 @@ class RichCmsContentGenerator < Rails::Generator::Base
 
 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
+    <<-BANNER.gsub(/^ {7}/, "")
 Creates Rich-CMS content model and migration and also registers content to Rich-CMS.
 
 USAGE: #{$0} #{spec.name} [model_name]
-EOS
+    BANNER
+  end
+
+  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
 
 end