page_engine 0.0.4 → 0.0.5

data/app/controllers/admin/pages_controller.rb

@@ -1,6 +1,5 @@
 class Admin::PagesController < ApplicationController
   before_filter :get_routes, :except => [:index, :destroy]
-  layout 'admin'
   
   def index
     @pages = Page.order(:lft).all.group_by(&:parent_id)
@@ -28,7 +27,7 @@ class Admin::PagesController < ApplicationController
     @page = Page.new
     PageEngine.page_parts.collect { |page_part| @page.page_parts.build(:title => page_part) }
     @parent = Page.find_by_permalink(params[:page_id])
-    @roles = PageEngine.class_exists?('Role') ? Role.all : []
+    @roles = PageEngine.uses_roles? ? PageEngine.role_class.classify.constantize.all : []
 
     respond_to do |format|
       format.html # new.html.erb
@@ -38,11 +37,11 @@ class Admin::PagesController < ApplicationController
 
   # GET /pages/1/edit
   def edit
-    @page = Page.includes([:parent, :page_parts]).where({ :permalink => params[:id] })
-    @page = @page.includes(:required_roles) if PageEngine.class_exists?('Role')
-    @page = @page.first
+    @page = Page.includes([:parent, :page_parts])
+    @page = @page.includes([:required_roles, :excluded_roles]) if PageEngine.uses_roles?
+    @page = @page.find_by_permalink(params[:id])
     @parent = @page.parent
-    @roles = PageEngine.class_exists?('Role') ? Role.all : []
+    @roles = PageEngine.uses_roles? ? PageEngine.role_class.classify.constantize.all : []
   end
 
   # POST /pages
@@ -50,6 +49,8 @@ class Admin::PagesController < ApplicationController
   def create
     @parent = Page.find_by_permalink(params[:page_id])
     @page = Page.new(params[:page])
+    
+    @page.author = send(PageEngine.current_author_helper) if PageEngine.has_author?
 
     respond_to do |format|
       if @page.save      

data/app/helpers/pages_helper.rb

@@ -41,19 +41,35 @@ module PagesHelper
     end
   end
   
-  def page_meta_keywords
-    if @page && !@page.meta_keywords.blank?
-      content_tag :meta, :name => 'keywords' do 
-        @page.meta_keywords
+  def page_meta_keywords(options={})
+    options = {
+      :with_tags => true
+    }.with_indifferent_access.merge(options)
+    
+    if options[:with_tags]
+      if @page && !@page.meta_keywords.blank?
+        content_tag :meta, :name => 'keywords' do 
+          @page.meta_keywords
+        end
       end
+    else
+      @page.meta_keywords
     end
   end
   
-  def page_meta_description
-    if @page && !@page.meta_description.blank?
-      content_tag :meta, :name => 'description' do 
-        @page.meta_description
+  def page_meta_description(options={})
+    options = {
+      :with_tags => true
+    }.with_indifferent_access.merge(options)
+    
+    if options[:with_tags]
+      if @page && !@page.meta_description.blank?
+        content_tag :meta, :name => 'description' do 
+          @page.meta_description
+        end
       end
+    else
+      @page.meta_description
     end
   end
   
@@ -85,15 +101,12 @@ module PagesHelper
     page.title
   end
   
-  # Add extra fields for an object in a form, in this case page parts
-  def link_to_add_fields(name, f, association)
-    new_object = f.object.class.reflect_on_association(association).klass.new
-    fields = simple_fields_for(association, new_object, :child_index => "new_#{association}") do |builder|
-      safe_concat(render(association.to_s.singularize + "_fields", :f => builder))
+  def page_part_fields(f)
+    fields = simple_fields_for(:page_parts, PagePart.new, :child_index => "new_page_parts") do |builder|
+      safe_concat(render('page_part_fields', :f => builder))
     end
-    
-    link_to('Add', '#', :onclick => "add_fields(this, \"#{association}\", \"#{escape_javascript(fields)}\")", :class => 'icon add')
-  end  
+    fields
+  end 
   
   # Return the specified page part content
   def page_content(options={})

data/app/models/page.rb

@@ -2,13 +2,11 @@ class Page < ActiveRecord::Base
   acts_as_nested_set
 
   # Relationships
-#  has_many :descendants, :class_name => "Page", :conditions => proc { "pages.lft between #{self.send(:lft)} and #{self.send(:rgt)}" }
-#  has_many :ancestors, :class_name => "Page", :conditions => proc { "(pages.lft <= #{self.send(:lft)} AND pages.rgt >= #{self.send(:rgt)}) AND (pages.id != #{self.send(:id)})" }, :foreign_key => false
   has_many :pages, :foreign_key => :parent_id
   has_many :page_parts, :dependent => :destroy
   
-  if PageEngine.class_exists?('Role')
-    has_many :page_roles
+  if PageEngine.uses_roles?
+    has_many :page_roles, :dependent => :destroy
     has_many :required_roles, :through => :page_roles, :source => :required_role
     has_many :excluded_roles, :through => :page_roles, :source => :excluded_role
   end
@@ -17,8 +15,8 @@ class Page < ActiveRecord::Base
     has_assets
   end
   
-  if PageEngine.class_exists?('User')
-    belongs_to :user
+  if PageEngine.has_author?
+    belongs_to :author, :class_name => PageEngine.author_class, :foreign_key => :authorable_id
   end
   
   accepts_nested_attributes_for :page_parts, :allow_destroy => true
@@ -26,7 +24,6 @@ class Page < ActiveRecord::Base
   # Filters
   before_validation :set_permalink
   before_save :check_publish_window
-  before_save :set_controller_and_action
 
   # Validations
   validates :title, :presence => true
@@ -44,15 +41,24 @@ class Page < ActiveRecord::Base
   scope :just_controller_and_actions, select("controller || '|' || action as taken").group('taken')
   scope :for_nav, select([:id, :title, :parent_id, :menu_css_class, :no_link, :url, :controller, :action, :permalink])
 
-  attr_accessor :no_publish_window, :controller_action  
+  attr_accessor :no_publish_window
 
   def no_publish_window
     no_publish_window_set?
   end
 
   def controller_action
-    if controller && action
-      "#{controller}|#{action}"
+    "#{controller}|#{action}" if controller && action
+  end
+  
+  def controller_action=(c)
+    if c.is_a?(String)
+      controller_and_action = c.split('|')
+      self.controller = controller_and_action.first
+      self.action = controller_and_action.last      
+    else
+      self.controller = nil
+      self.action = nil
     end
   end
 
@@ -98,7 +104,7 @@ class Page < ActiveRecord::Base
     end
 
     # Roles
-    if PageEngine.class_exists?('Role')
+    if PageEngine.uses_roles?
       page.required_roles = self.required_roles 
       page.excluded_roles = self.excluded_roles
     end
@@ -114,7 +120,7 @@ class Page < ActiveRecord::Base
   end
 
   def is_viewable_by?(user)
-    if PageEngine.class_exists?('Role')
+    if PageEngine.uses_roles?
       if PageEngine.class_exists?('User') && user
         return true if self.roles.length == 0
         self.role_ids.length != (self.role_ids - user.role_ids.uniq).length        
@@ -153,6 +159,10 @@ class Page < ActiveRecord::Base
 
   class << self
     
+    def should_be_found?(params)
+      PageEngine.required_route_actions.include?(params[:action]) && !PageEngine.excluded_route_controllers.include?(params[:controller])
+    end
+    
     def breadcrumbs_for(user, url)
       root = Page.published.viewable_by(user).find_by_url(url)
       root.nil? ? [] : root.self_and_ancestors
@@ -165,25 +175,17 @@ class Page < ActiveRecord::Base
     # Scopes
 
     def viewable_by(user)
-      if PageEngine.class_exists?('Role') && PageEngine.class_exists?('User')
+      if PageEngine.uses_roles?
         if user
           # This is a bit of a kludge until I can figure out how to get it to work properly in a single sql query
           includes(:page_roles).where("pages.id in (?) or (page_roles.required_role_id is null and page_roles.excluded_role_id is null)", PageRole.viewable_page_ids_for(user))
         else
-          includes(:page_roles).where({ 'page_roles.required_role_id' => nil })
+          includes(:page_roles).where('page_roles.required_role_id' => nil, 'page_roles.excluded_role_id' => nil)
         end
       else
         scoped
       end      
-    end
-
-    def with_roles(roles)
-      if Extras.class_exists?('Role')
-        includes(:roles).where([ "roles.id IN (?)", roles.join(',') ])
-      else
-        scoped
-      end
-    end
+    end  
 
     def with_url(request, params)
       url = request.fullpath
@@ -201,17 +203,6 @@ class Page < ActiveRecord::Base
       self.menu_css_class = self.permalink if self[:menu_css_class].blank?
     end
 
-    def set_controller_and_action
-      if @controller_action
-        controller_and_action = @controller_action.split('|')
-        self.controller = controller_and_action.first
-        self.action = controller_and_action.last
-      else
-        self.controller = nil
-        self.action = nil
-      end
-    end
-
     def check_publish_window
       if @no_publish_window == "1"
         self.publish_to = self.publish_from = nil

data/app/models/page_role.rb

@@ -1,15 +1,17 @@
 class PageRole < ActiveRecord::Base
   # Relationships
-  belongs_to :required_role, :class_name => 'Role'
-  belongs_to :excluded_role, :class_name => 'Role'
+  belongs_to :required_role, :class_name => PageEngine.role_class
+  belongs_to :excluded_role, :class_name => PageEngine.role_class
   
   # Scopes
-  scope :viewable_by, lambda { |user| where(:required_role_id => user.role_ids) } 
-  scope :not_viewable_by, lambda { |user| where(:excluded_role_id => user.role_ids) }
+  scope :viewable_by, lambda { |user| user ? where(:required_role_id => user.send("#{PageEngine.role_class.underscore}_ids")) : scoped }
+  scope :not_viewable_by, lambda { |user| user ? where(['excluded_role_id not in (?)', user.send("#{PageEngine.role_class.underscore}_ids")]) : scoped }
   
   class << self
+    
     def viewable_page_ids_for(user)
-      PageRole.viewable_by(user).map(&:page_id) - PageRole.not_viewable_by(user).map(&:page_id)
+      PageRole.viewable_by(user).select(:page_id).map(&:page_id) - PageRole.not_viewable_by(user).select(:page_id).map(&:page_id)
     end
+    
   end
 end

data/app/views/admin/page_snippets/_form.html.haml

@@ -3,8 +3,8 @@
   
   .inputs
     = f.input :name
-    = f.input :filter, :collection => Page.filters, :include_blank => false, :class => 'filter', :input_html => { :class => 'filter', :rel => 'page_snippet_content' }
+    = f.input :filter, :collection => PageEngine.filters, :include_blank => false, :class => 'filter', :input_html => { :class => 'filter', :rel => 'page_snippet_content' }
     = f.input :content, :input_html => { :class => 'editor', 'data-filter' => @page_snippet.filter }
     
-  .action
+  .actions
     = f.submit

data/app/views/admin/pages/_form.html.haml

@@ -1,29 +1,31 @@
 = simple_form_for([:admin, @parent, @page]) do |f|
   = f.error_notification
   = hidden_field_tag :the_page_id, @page.id
+  
+  - if !@page.new_record? && PageEngine.has_author? && @page.author
+    %p== Originally authored by: #{@page.author}
 
   .inputs  
     = f.input :title
     = f.input :permalink, :required => false
     
-    .page_parts
+    #page_engine_page_parts{ 'data-fields' => page_part_fields(f) }
       .input.new_page_part_name
-        %label New page part name
-        = text_field_tag :new_page_part_name 
-        = link_to_add_fields 'Add page part', f, :page_parts
+        = link_to('Add a page part', '#', :id => 'add_page_part')
         
-      %ul.tabs
+      %ul
         - @page.page_parts.each do |page_part|
           %li{ :class => "#{page_part.title.parameterize} #{'tab_with_errors' if page_part.errors.any?}"}
-            = link_to page_part.title, "##{page_part.title.parameterize}_#{page_part.id}"
+            = link_to page_part.title, "#page_part_#{page_part.title.parameterize}"
+            %span.icon.delete
       
       = f.simple_fields_for :page_parts do |builder|
-        .page_part{ :id => "#{builder.object.title.parameterize}_#{builder.object.id}" }
+        .page_part{ :id => "page_part_#{builder.object.title.parameterize}" }
           = render 'page_part_fields', :f => builder      
         
-    - unless @roles.empty?
-      = f.association :required_roles, :as => :check_boxes
-      = f.association :excluded_roles, :as => :check_boxes
+    - if PageEngine.uses_roles?
+      = f.association :required_roles, :as => :check_boxes, :collection => @roles
+      = f.association :excluded_roles, :as => :check_boxes, :collection => @roles
     
     = f.input :css, :label => 'CSS', :input_html => { 'data-filter' => 'css' }
     = f.input :js, :label => 'Javascript', :input_html => { 'data-filter' => 'javascript' }
@@ -36,7 +38,7 @@
     = f.input :url
     
     = f.input :controller_action, :as => :select do 
-      = f.select :controller_action, grouped_options_for_select(@routes), :include_blank => true
+      = f.select :controller_action, grouped_options_for_select(@routes, @page.controller_action), :include_blank => true
         
     = f.input :display_in_menu
     = f.input :display_in_sitemap

data/app/views/admin/pages/_page_part_fields.html.haml

@@ -1,9 +1,7 @@
-.delete
-  = f.hidden_field :_destroy
-  = link_to 'Delete', '#', :class => 'icon delete', :title => "Delete the current page part"
+= f.hidden_field :_destroy, :id => "delete_#{f.object.title}"
 
 = f.error_notification
 
 = f.input :title, :class => 'page_part_title'
 = f.input :filter, :collection => PageEngine.filters, :include_blank => false, :class => 'filter', :input_html => { :class => 'filter', :rel => "page_part_content_#{f.object.id}" }
-= f.input :content, :input_html => { 'data-filter' => f.object.filter, :class => 'editor ignore_tab', :id => "page_part_content_#{f.object.id}" }
+= f.input :content, :input_html => { 'data-filter' => f.object.filter, :class => 'page_engine_editor ignore_tab', :id => "page_part_content_#{f.object.id}" }

data/db/seed.rb

@@ -1,8 +1,3 @@
 page = Page.create(:title => 'Home')
 body = page.page_parts.find_by_title('body')
-body.update_attributes(:filter => 'textile', :content => "h1. Welcome
-
-Aenean dictum porttitor arcu vitae vehicula. Nullam posuere augue vitae lorem ultrices facilisis? Lorem ipsum dolor sit amet, consectetur adipiscing elit. Praesent non nisi erat? Donec id eros sed metus lobortis semper sed non nulla. Cras cursus ipsum eget neque imperdiet feugiat. Etiam sed sapien id felis aliquam aliquet. Nam fermentum tempus suscipit.
-
-Mauris non mi mi, a vulputate nunc! Phasellus aliquam urna nec lorem consectetur in porttitor sapien laoreet! Nam erat elit, aliquam quis auctor et, tempor quis arcu. Cras diam nunc, mollis pharetra pulvinar eu, dapibus in augue. Aenean malesuada nulla ac neque facilisis congue? Nulla interdum euismod eros; at tempor magna sagittis id. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Aliquam orci aliquam.
-)")
+body.update_attributes(:filter => 'textile', :content => "h1. Welcome\n\nAenean dictum porttitor arcu vitae vehicula. Nullam posuere augue vitae lorem ultrices facilisis? Lorem ipsum dolor sit amet, consectetur adipiscing elit. Praesent non nisi erat? Donec id eros sed metus lobortis semper sed non nulla. Cras cursus ipsum eget neque imperdiet feugiat. Etiam sed sapien id felis aliquam aliquet. Nam fermentum tempus suscipit.\n\nMauris non mi mi, a vulputate nunc! Phasellus aliquam urna nec lorem consectetur in porttitor sapien laoreet! Nam erat elit, aliquam quis auctor et, tempor quis arcu. Cras diam nunc, mollis pharetra pulvinar eu, dapibus in augue. Aenean malesuada nulla ac neque facilisis congue? Nulla interdum euismod eros; at tempor magna sagittis id. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Aliquam orci aliquam.")

data/lib/generators/page_engine/install/install_generator.rb

@@ -7,19 +7,20 @@ module PageEngine
       include Rails::Generators::Migration
       desc "This generator installs PageEngine supporting assets"
 
-      source_root File.expand_path('../../../../', __FILE__) 
+      source_root File.expand_path('../../../../../', __FILE__) 
       
       def self.next_migration_number(path)
         Time.now.utc.strftime("%Y%m%d%H%M%S")
       end
       
       def install
-        create_migrations
-        copy_stylesheets
-        copy_javascripts
-        copy_images
-        
-        copy_file 'app/views/layouts/admin.html.haml', 'app/views/layouts/admin.html.haml'
+        if Rails.version < "3.1"
+          create_migrations
+          copy_stylesheets
+          copy_javascripts
+          copy_images
+        end
+        copy_file 'lib/generators/page_engine/templates/page_engine.rb', 'config/initializers/page_engine.rb'
       end
 
       private
@@ -37,7 +38,7 @@ module PageEngine
           directory 'vendor/assets/stylesheets', 'public/stylesheets'
           
           puts 'Updating image location'
-          ['css', 'textile', 'markdown', 'html', 'javascript'].each do |area|
+          ['textile', 'markdown', 'html'].each do |area|
             gsub_file "public/stylesheets/markitup/sets/#{area}/style.css", /\/assets\//, '/images/'
           end
           
@@ -55,10 +56,9 @@ module PageEngine
         end
         
         def copy_images
-          directory 'app/assets/images', 'public/images'
           directory 'vendor/assets/images', 'public/images'            
         end
 
     end
   end
-end if Rails.version < "3.1"
+end

data/lib/generators/page_engine/templates/page_engine.rb

@@ -0,0 +1,34 @@
+PageEngine.setup do |config|
+  # Layouts available to the psge
+  # config.layouts = [:application]
+  
+  # Page parts that are created by default with a new page
+  # config.page_parts = %w{ body left right header footer }
+  
+  # Extra page status options, added to defaults 
+  # config.statuses = []
+  
+  # Filters that can be applied to the page parts content
+  # config.filters = %w{ none html textile markdown }
+  
+  # List of actions that should be included when getting the available routes
+  # config.required_route_actions = %w{ index show new edit create update }
+  
+  # List of controllers that should be excluded when getting the available routes
+  # config.excluded_route_controllers = []
+  
+  # To give more control over which controllers are returned
+  # config.excluded_route_controllers_regex = /^admin.*/  
+  
+  # If a page should only be vieawable by a specific role set the role class here
+  # config.role_class = 'Role'
+  
+  # Author class for the created pages
+  # config.author_class = 'User'
+  
+  # Set the helper method that will be used to get the current author
+  # config.current_author_helper = 'current_user'
+  
+  # Set the helper method that will be used to get the current viewer
+  # config.current_viewer_helper = 'current_user'
+end

data/lib/page_engine.rb

@@ -2,7 +2,6 @@ require 'page_engine/defaults'
 require "page_engine/engine"
 require 'page_engine/extensions'
 require 'page_engine/helpers'
-require 'page_engine/routes_finder'
 require 'RedCloth'
 require 'bluecloth'
 require 'haml'
@@ -26,7 +25,34 @@ module PageEngine
   mattr_accessor :filters
   @@filters = %w{ none html textile markdown erb erb+textile }
   
+  # List of actions that should be included when getting the available routes
+  mattr_accessor :required_route_actions
+  @@required_route_actions = %w{ index show new edit create update }
   
+  # List of controllers that should be excluded when getting the available routes
+  mattr_accessor :excluded_route_controllers
+  @@excluded_route_controllers = []
+  
+  # To give more control over which controllers are returned
+  mattr_accessor :excluded_route_controllers_regex
+  @@excluded_route_controllers_regex = /^admin.*/
+  
+  # If the page should be only viewable by a specific role, set the role class here
+  mattr_accessor :role_class
+  @@role_class = 'Role'
+  
+  # The author class
+  mattr_accessor :author_class
+  @@author_class = 'User'
+  
+  # Set the helper method that will be used to get the current author
+  mattr_accessor :current_author_helper
+  @@author_class = 'current_user'
+  
+  # Set the helper method that will be used to get the current user
+  mattr_accessor :current_viewer_helper
+  @@current_viewer_helper = 'current_user'
+
   # Module methods
   
   def self.statuses=s
@@ -44,29 +70,44 @@ module PageEngine
       return false
   end
   
-  def self.available_routes
+  def self.available_routes(options = {})
+    options = {
+      :required_actions => @@required_route_actions,
+      :excluded_controllers => @@excluded_route_controllers,
+      :excluded_controller_regex => @@excluded_route_controllers_regex
+    }.merge!(options.symbolize_keys)
+    
     available = {}
-
-    Rails.application.routes.routes.each do |route|
-      unless route.requirements.empty?
-        unless ['DELETE'].include?(route.verb.to_s) || route.requirements[:controller].match(/^admin.*/) || ['delete', :delete].include?(route.requirements[:method].to_s)
-          available[route.requirements[:controller]] = [] unless available[route.requirements[:controller]]
-          unless route.requirements[:controller] == 'pages' && route.requirements[:action] == 'show'
-            available[route.requirements[:controller]] << route.requirements[:action] unless available[route.requirements[:controller]].include?(route.requirements[:action])
-          end
-        end
-
-      end
+    
+    controller_actions = Rails.application.routes.routes.map(&:requirements)
+    
+    controller_actions.delete_if { |c| c.empty? || c[:controller] == 'rails/info' || c[:controller] == 'pages' || !options[:required_actions].include?(c[:action]) || options[:excluded_controllers].include?(c[:controller]) || c[:controller] =~ options[:excluded_controller_regex] }
+    
+    controller_actions.each do |c|
+      available[c[:controller]] ||= []
+      available[c[:controller]] << c[:action]
     end
-
-    available.delete('rails/info')
+    
     available
   end
   
   def self.setup
     yield self
-  end  
+  end   
+  
+  def self.uses_roles?
+    !self.role_class.blank?
+  end
+  
+  def self.has_author?
+    !self.author_class.blank?
+  end
+  
+  def self.has_viewers?
+    !self.current_viewer_helper.blank?
+  end
+ 
 end
 
-ActionView::Helpers::AssetTagHelper.register_javascript_expansion :page_engine => ["jquery-ui-1.8.15.custom.min", "jquery.ui.nestedSortable", "jquery.markitup", "markitup/sets/html/set", "markitup/sets/textile/set", "markitup/sets/markdown/set", "markitup/sets/css/set", "markitup/sets/javascript/set", "page_engine"]
-ActionView::Helpers::AssetTagHelper.register_stylesheet_expansion :page_engine => ["jquery-ui", "markitup/skins/simple/style", "markitup/sets/html/style", "markitup/sets/textile/style", "markitup/sets/markdown/style", "markitup/sets/css/style", "markitup/sets/javascript/style", "page_engine"]
+ActionView::Helpers::AssetTagHelper.register_javascript_expansion :page_engine => ["jquery-ui-1.8.15.custom.min", "jquery.ui.nestedSortable", "jquery.markitup", "markitup/sets/html/set", "markitup/sets/textile/set", "markitup/sets/markdown/set", "codemirror/codemirror", "codemirror/modes/javascript", "codemirror/modes/css", "page_engine"]
+ActionView::Helpers::AssetTagHelper.register_stylesheet_expansion :page_engine => ["jquery-ui", "markitup/skins/simple/style", "markitup/sets/html/style", "markitup/sets/textile/style", "markitup/sets/markdown/style", "codemirror/codemirror", "codemirror/themes/default", "page_engine"]