refinerycms 0.9.5.30 → 0.9.5.31

data/vendor/plugins/refinery/app/views/shared/_submenu.html.erb

@@ -1,4 +1,5 @@
-<% children = @page.root.children %>
-<ul id='submenu'<%= " class='empty'" if children.empty? %>>
-  <%= render :partial => "/shared/submenu_branch", :collection => children %>
-</ul>
+<% unless (children = @page.root.children).empty? -%>
+  <ul id='submenu'>
+    <%= render :partial => "/shared/submenu_branch", :collection => children %>
+  </ul>
+<% end -%>

data/vendor/plugins/refinery/crud.md

@@ -0,0 +1,197 @@
+# The Magical Mixin: Crudify (create, read, update & delete)
+
+## Introduction
+
+__Most controllers Refinery and other apps do four common things, create, read, update and delete stuff.__ Instead of writing the same logic for these actions over and over again we wrap all this functionality up into what we called ``crudify``.
+
+``crudify`` takes these four basic actions and extends them to allow easy paging, searching and sorting too.
+
+Although this single file is included in Refinery, you could take just this single file and use it in any app you like.
+
+The best part about ``crudify`` is that this gives you a smart default and if there is anything you want to work differently just override that method.
+
+## Where is it located?
+
+``vendor/plugins/refinery/lib/crud.rb``
+
+## How do I use it in my plugins?
+
+All you need to do is call ``crudify`` in your controller.
+
+If you used the Refinery generator you're plugin will already be using ``crudify``.
+
+### Example
+
+    class NewsItemsController < ApplicationController
+
+      crudify :news_item, :order => "created_at DESC"
+
+    end
+  
+### Complex Example
+
+    class NewsItemsController < ApplicationController
+
+      crudify :news_item, :order => "created_at DESC"
+                          :conditions => 'published = true',
+                          :sortable => false,
+                          :searchable => true,
+                          :include => [:author],
+                          :paging => true,
+                          :search_conditions => ''
+
+    end
+
+## What can you configure with ``crudify``?
+
+### ``:title_attribute``
+
+Default value is ``title``
+
+This is the human readable value you want ``crudify`` to use throughout. Just choose an attribute that is on your model that is short and descriptive to what the model is.
+
+#### Example
+
+On a page model you'd probably use "title" (which is default so you don't need to specify this)
+
+#### Example 2
+
+On a ``team_member`` model you'd probably want to use an attribute like ``name``.
+
+### ``:order``
+
+Default value is ``position ASC``
+
+This is the position that is used when listing out what you're crudifying. If you have ``:sortable`` set to ``true`` you probably want to have your ``:order`` set to ``position ASC`` so it uses the order you have set when sorting.
+
+If you have a news area, it makes more sense to sort by ``posted_at``. So you might set it like this
+
+    :order => "posted_at DESC"
+
+### ``:conditions``
+
+Default value is ``nil``
+
+This will filter down the list of items you have when you're asking for all records.
+
+An example here is say you're crudifying a photos table that uses attachment_fu. Attachment_fu creates several photo records, 1 for the main photo and others for it's "children" thumbnails. Those thumbnails have a parent id set.
+
+So when viewing a list of the images you have you don't want it to show all the thumbnails too, you just want to each see unique image listed so you need to apply some conditions to hide the thumbnails.
+
+You do that like this:
+
+    :conditions => "parent_id IS NULL"
+
+### ``:sortable``
+
+Default value is ``true``
+
+Enabling ``:sortable`` gives you several handy methods which "just work" with sortable JavaScript lists. One of the methods is ``update_positions()`` which handles saving the new position items have been sorted into.
+
+### ``:searchable``
+
+Default value is ``true``
+
+When this option is ``true``, the routes are modified so when you go to the next page of results the search continues on.
+
+### ``:include``
+
+Default value is ``[]``
+
+For performance optimisation, sometimes you might want to eager load other related models to this one. For example a ``news_post`` might below to a ``user`` who wrote the post. But in our index view we're printing out the name of each user.
+
+Instead of having to look up each user for each of the ``news_posts`` we iterate over, the ``:include`` option allows you to load the ``news_post`` and user all at the same time which'll allow you to save on expensive database queries.
+
+Here's an example of that.
+  
+    class NewsItem
+    
+      belongs_to :user
+  
+    end
+  
+    class NewsItemsController < ApplicationController
+
+      crudify :news_item, :order => "created_at DESC", :include => [:user]
+
+    end
+
+### ``:paging``
+
+Default value is ``true``
+
+The ``:paging`` option tells ``crudify`` you don't just want one big long list but rather to break it out into pages and support paging methods uses [will_paginate](http://wiki.github.com/mislav/will_paginate/).
+
+### ``:search_conditions``
+
+Default value is ``nil``
+
+Similar to the ``:conditions`` options, ``:search_conditions`` just apply these conditions when delivering search results.
+
+## Easy Accessor Methods
+
+``crudify`` automatically writes up finder methods for the model you're crudifying. The easier way to explain this is with an example.
+
+Say we have a pages controller that is going to manage pages.
+
+    class PagesController < ApplicationController
+
+      crudify :page
+
+    end
+  
+In this controller, automatically I have these methods:
+
+    find_page()
+    find_all_pages()
+  
+So say I wanted to change the way all pages are found, all I do is override the ``find_all_pages`` method.
+
+    class PagesController < ApplicationController
+
+      crudify :page
+  
+      def find_all_pages
+        @pages = Page.find(...) # apply any logic I want here to get all pages.
+      end
+
+    end
+
+## Overriding or Extending Crudify
+
+Before overriding anything, the best thing to do is check out how the default works. Read the ``vendor/plugins/refinery/lib/crud.rb`` and see what code it's injecting into your controller.
+
+Pick the method you want to override and then override it in your controller.
+
+Let's go back to the example above with the pages controller.
+
+    class PagesController < ApplicationController
+
+      crudify :page
+
+    end
+  
+Say every time someone deletes a page I want my ``NotificationMailer`` to email me to say someone just deleted a page.
+
+When I look in the ``crud.rb`` file I see that my controller has this added to it
+
+    def destroy
+      flash[:notice] = "'\#{@#{singular_name}.#{options[:title_attribute]}}' was successfully deleted." if @#{singular_name}.destroy
+      redirect_to admin_#{plural_name}_url
+    end
+  
+To override this all I would is create my own delete method that works the same but just with my mailer code on it.
+
+    class PagesController < ApplicationController
+
+      crudify :page
+
+      def destroy
+        if @page.destroy
+          flash[:notice] = "'#{@page.title}' was successfully deleted."
+          NotificationMailer.deliver_page_deleted(@page) # sends me an email to say a page was deleted
+        end
+        redirect_to admin_pages_url
+      end
+
+    end

data/vendor/plugins/refinery/lib/generators/refinery/templates/public_controller.rb

@@ -4,11 +4,16 @@ class <%= class_name.pluralize %>Controller < ApplicationController
 
   def index
     @<%= plural_name %> = <%= class_name %>.find(:all, :order => "position ASC")
+    present(@page)
   end
 
   def show
     @<%= plural_name %> = <%= class_name %>.find(:all, :order => "position ASC") # for body_content_right
     @<%= singular_name %> = <%= class_name %>.find(params[:id])
+
+    # you can use meta fields from your model instead (e.g. browser_title)
+    # by swapping @page for @<%= singular_name %> in the line below:
+    present(@page)
   end
 
 protected
@@ -17,4 +22,4 @@ protected
     @page = Page.find_by_link_url("/<%= plural_name %>")
   end
 
-end
+end

data/vendor/plugins/refinery/lib/refinery/application_controller.rb

@@ -7,7 +7,8 @@ class Refinery::ApplicationController < ActionController::Base
   include Crud # basic create, read, update and delete methods
   include AuthenticatedSystem
 
-  before_filter :find_pages_for_menu, :setup_theme, :show_welcome_page, :take_down_for_maintenance?
+  before_filter :take_down_for_maintenance?, :setup_theme, :find_pages_for_menu, :show_welcome_page
+
   rescue_from ActiveRecord::RecordNotFound, :with => :error_404
   rescue_from ActionController::UnknownAction, :with => :error_404
 
@@ -43,13 +44,12 @@ class Refinery::ApplicationController < ActionController::Base
 protected
 
 	def setup_theme
-	  self.view_paths = ::ActionController::Base.view_paths.dup.unshift("#{RAILS_ROOT}/themes/#{RefinerySetting[:theme]}/views")
+	  self.view_paths = ::ActionController::Base.view_paths.dup.unshift(File.join(%W(#{RAILS_ROOT} themes #{RefinerySetting[:theme]} views)))
 	end
 
   def take_down_for_maintenance?
     if RefinerySetting.find_or_set(:down_for_maintenance, false)
-      @page = Page.find_by_menu_match("^/maintenance$", :include => [:parts, :slugs])
-      unless @page.nil?
+      if (@page = Page.find_by_menu_match("^/maintenance$", :include => [:parts, :slugs])).present?
         render :template => "/pages/show", :status => 503
       else
         render :text => "Our website is currently down for maintenance. Please try back soon."
@@ -61,8 +61,21 @@ protected
     render :template => "/welcome", :layout => "admin" if just_installed? and params[:controller] != "users"
   end
 
+  # get all the pages to be displayed in the site menu.
   def find_pages_for_menu
     @menu_pages = Page.top_level(include_children=true)
   end
 
-end
+  # use a different model for the meta information.
+  def present(model)
+    presenter = Object.const_get("#{model.class}Presenter") rescue Refinery::BasePresenter
+    @meta = presenter.new(model)
+  end
+
+  # this hooks into the Rails render method.
+  def render(action = nil, options = {}, &blk)
+    present(@page) unless admin? or @meta.present?
+    super
+  end
+
+end

data/vendor/plugins/refinery/lib/refinery/application_helper.rb

@@ -1,27 +1,25 @@
 # Methods added to this helper will be available to all templates in the application.
 module Refinery::ApplicationHelper
-  include Refinery::HtmlTruncationHelper
 
-  def add_meta_tags
-    content_for :head, "<meta name=\"keywords\" content=\"#{@page.meta_keywords}\" />" unless @page.meta_keywords.blank?
-    content_for :head, "<meta name=\"description\" content=\"#{@page.meta_description}\" />" unless @page.meta_description.blank?
-  end
+  include Refinery::HtmlTruncationHelper
 
-  def add_page_title
-    content_for :title,
-    if @page.browser_title.blank?
-      @page.path
-    else
-      @page.browser_title
-    end
+  def setup
+    logger.warn("*** Refinery::ApplicationHelper::setup has now been deprecated from the Refinery API. ***")
   end
 
-  def setup
-    add_meta_tags
-    add_page_title
+  def browser_title(yield_title=nil)
+    [
+      yield_title.present? ? yield_title : nil,
+      @meta.browser_title.present? ? @meta.browser_title : @meta.path,
+      RefinerySetting.find_or_set(:site_name, "Company Name")
+    ].compact.join(" - ")
   end
 
+  # you can override the object used for the title by supplying options[:object]
+  # this object must support custom_title_type if you want custom titles.
   def page_title(options = {})
+    object = options.fetch(:object, @page)
+    options.delete(:object)
     options = RefinerySetting.find_or_set(:page_title, {
       :chain_page_title => false,
       :ancestors => {
@@ -37,32 +35,37 @@ module Refinery::ApplicationHelper
     }).merge(options)
 
     title = []
-    pages = options[:chain_page_title] ? [@page.ancestors, @page].flatten : [@page]
+    objects = (options[:chain_page_title] and object.respond_to?(:ancestors)) ? [object.ancestors, object] : [object]
 
-    pages.flatten.each do |page|
-      title << case page.custom_title_type
-        when "none"
-          page.title
-        when "text"
-          page.custom_title
-        when "image"
-          image_fu page.custom_title_image, nil, {:alt => page.title} rescue page.title
+    objects.flatten.each do |obj|
+      if obj.respond_to?(:custom_title_type)
+        title << case obj.custom_title_type
+          when "text"
+            obj.custom_title
+          when "image"
+            image_fu obj.custom_title_image, nil, {:alt => obj.title} rescue obj.title
+          else
+            obj.title
+          end
+      else
+        title << obj.title
       end
     end
 
     final_title = title.pop
     if (options[:page_title][:wrap_if_not_chained] and title.empty?) and !options[:page_title][:tag].blank?
-      final_title = "<#{options[:page_title][:tag]}#{" class='#{options[:page_title][:class]}'" unless options[:page_title][:class].blank?}>#{final_title}</#{options[:page_title][:tag]}>"
+      css = options[:page_title][:class].present? ? " class='#{options[:page_title][:class]}'" : nil
+      final_title = "<#{options[:page_title][:tag]}#{css}>#{final_title}</#{options[:page_title][:tag]}>"
     end
     if (title.empty?)
-      final_title
+      return final_title
     else
-      "<#{options[:ancestors][:tag]} class='#{options[:ancestors][:class]}'>#{title.join options[:ancestors][:separator]}#{options[:ancestors][:separator]}</#{options[:ancestors][:tag]}>#{final_title}"
+      return "<#{options[:ancestors][:tag]} class='#{options[:ancestors][:class]}'>#{title.join options[:ancestors][:separator]}#{options[:ancestors][:separator]}</#{options[:ancestors][:tag]}>#{final_title}"
     end
   end
 
   def descendant_page_selected?(page)
-    not page.descendants.reject {|descendant| not selected_page?(descendant) }.empty?
+    page.descendants.any? {|descendant| selected_page?(descendant) }
   end
 
   def selected_page?(page)

data/vendor/plugins/refinery/lib/refinery/base_presenter.rb

@@ -0,0 +1,27 @@
+class Refinery::BasePresenter
+
+  DEFAULT_FIELDS = {
+    :title              => Proc.new { |p| p.model.class.name.titleize },
+    :path               => Proc.new { |p| p.title },
+    :browser_title      => nil,
+    :meta_description   => nil,
+    :meta_keywords      => nil
+  }
+
+  attr_reader :model
+
+  def initialize(obj)
+    @model = obj
+  end
+
+  def method_missing(method, *args)
+    if @model.respond_to? method
+      @model.send method
+    elsif DEFAULT_FIELDS.has_key? method
+      (value = DEFAULT_FIELDS[method]).is_a?(Proc) ? value.call(self) : value
+    else
+      raise NoMethodError.new("#{self.class.name} doesn't know #{method}. Define or delegate it.", method)
+    end
+  end
+
+end

data/vendor/plugins/refinery/lib/refinery/initializer.rb

@@ -5,19 +5,21 @@ rescue LoadError => load_error
 end
 
 module Refinery
+
   if defined? Rails::Configuration
     class Configuration < Rails::Configuration
       def default_plugin_paths
-        paths = super.push("#{REFINERY_ROOT}/vendor/plugins").uniq
+        paths = super.push(File.join(%W(#{REFINERY_ROOT} vendor plugins))).uniq
       end
     end
   end
+
   if defined? Rails::Plugin::Loader
     class PluginLoader < Rails::Plugin::Loader
       def add_plugin_load_paths
         super
         # add plugin lib paths to the $LOAD_PATH so that rake tasks etc. can be run when using a gem for refinery or gems for plugins.
-        search_for = Regexp.new(File.join('(', REFINERY_ROOT, %w(vendor plugins \)? .+? lib)))
+        search_for = Regexp.new(File.join(%W(\( #{REFINERY_ROOT} vendor plugins \)? .+? lib)))
         paths = plugins.collect{ |plugin| plugin.load_paths }.flatten.reject{|path| path.scan(search_for).empty? or path.include?('/rails-') }
         paths = paths.reject{ |path| path.include?(REFINERY_ROOT) } if REFINERY_ROOT == RAILS_ROOT # superfluous when not in gem.
         ($refinery_gem_plugin_lib_paths = paths).each do |path|
@@ -27,6 +29,7 @@ module Refinery
       end
     end
   end
+
   if defined? Rails::Initializer
     class Initializer < Rails::Initializer
       def self.run(command = :process, configuration = Configuration.new)
@@ -42,4 +45,5 @@ module Refinery
       end
     end
   end
-end
+
+end

data/vendor/plugins/refinery/lib/tasks/doc.rake

@@ -1,11 +1,11 @@
 namespace :doc do
-	
+
 	task :app => [:refinery]
-	
+
 	desc "Generate documentation for the application"
 	Rake::RDocTask.new(:refinery) { |rdoc|
 	  rdoc.title    = "Refinery CMS Documentation"
-	  rdoc.main = "README.rdoc"
+	  rdoc.main = "readme.md"
 	  rdoc.options = ['--inline-source']
 	  rdoc.rdoc_files.include('lib/**/*.rb',
 	              						 'lib/*',
@@ -23,7 +23,7 @@ namespace :doc do
 	              						 'vendor/plugins/refinery_settings/**/*.rb',
 	              						 'vendor/plugins/resources/**/*.rb',
 	              						 'vendor/plugins/themes/**/*.rb',
-														 'README.rdoc', 'LICENSE', 'CONTRIBUTORS', 'vendor/plugins/themes/themes.rdoc')
+														 'readme.md', 'license.md', 'contributors.md', 'vendor/plugins/themes/themes.md')
 	}
 
 end