refinerycms 0.9.7.15 → 0.9.8

data/vendor/refinerycms/core/config/routes.rb

@@ -0,0 +1,15 @@
+Refinery::Application.routes.draw do
+
+  match 'wymiframe(/:id)', :to => 'refinery/fast#wymiframe', :as => :wymiframe
+
+  scope(:path => 'refinery', :as => 'admin', :module => 'admin') do
+    resources :refinery_core
+  end
+
+  match '/refinery/flash',                 :to => 'admin/refinery_core#render_flash_messages'
+  match '/refinery/update_menu_positions', :to => 'admin/refinery_core#update_plugin_positions'
+
+  scope(:path => 'refinery', :as => 'admin', :module => 'admin') do
+    resources :dialogs # FIXME: Rails 3, :only => [:show]
+  end
+end

data/vendor/refinerycms/core/engines.md

@@ -0,0 +1,213 @@
+# Extending Refinery with Plugins
+
+## Introduction
+
+__Refinery is designed to be easily extended so you can quickly customise your Refinery site to manage new areas you want to add to your site. If you see something you want to customise, the chances are you can customise it.__
+
+The main way of extending Refinery is through adding new plugins to your app. By default you can edit pages in Refinery's backend, but how do you add a new section to manage like products?
+
+## The Refinery Generator
+
+The Refinery generator is a standard Rails generator that functions just like the scaffold generator. It allows you to quickly add new managed sections to the Refinery backend and get the front end views for free.
+
+To see how to use the generator run
+
+    rails generate refinery_engine
+
+Usage instructions should appear.
+
+## Example of Using the Generator
+
+Let's say you have a client who has a range of products they want to show on their website. You've considered using a few pages to manage the products but you've decided it would be much nicer if there was a separate place that had forms dedicated to managing products.
+
+First decide what fields they need to manage. In our case, the client is going to want to edit the title and description of each product. They would also like a little "facts panel" to show on the right of the page.
+
+So go to the root of your project and run
+
+    rails generate refinery_engine
+
+This will output the help on how to use the generator. To generate the new section we want to manage products we run:
+
+    rails generate refinery_engine product title:string description:text image:image brochure:resource
+
+The generator will output a list of files it generated. You'll notice there is a new plugin that has been added in ``vendor/plugins/products``. This is where both the backend and front end files are held for this new products area.
+
+A new database migration has been added to add the products table in so run:
+
+    rake db:migrate
+
+Start up your app by running ``ruby script/server`` go to [http://localhost:3000](http://localhost:3000) and you'll see instantly a new menu item called "products". Click on that and you'll see there are no products yet.
+
+Now go to the backend of your site by visiting [http://localhost:3000/refinery](http://localhost:3000/refinery) and logging in. You'll see a new tab called "Products", click on that and then click "Add a new product", fill the form and add an example product. Now go back to the front end and you'll see your product is showing up in the products part of your site.
+
+Now you have a fully managed products section in Refinery, nice.
+
+If you want to modify your generated plugin you need to understand the basic structure of how they work.
+
+## The Structure of a Plugin
+
+Think of a plugin in Refinery as a small Rails app or an "engine". Plugins have a structure that is extremely similar to a Rails app. Here's an example of Refinery's pages plugin (located in Refinery's ``vendor/plugins/pages/`` folder)
+
+    pages
+      |- app
+      |   |- controllers
+      |   |   |- admin
+      |   |   |    |- pages_dialogs_controller.rb
+      |   |   |    |- page_parts_controller.rb
+      |   |   |    |- pages_controller.rb
+      |   |   |- pages_controller.rb
+      |   |- helpers
+      |   |   |- pages_helper.rb
+      |   |- models
+      |   |   |- page.rb
+      |   |- views
+      |       |- pages
+      |       |   |- home.html.erb
+      |       |   |- show.html.erb
+      |       |- admin
+      |           |- pages
+      |               |- _form.html.erb
+      |               |- edit.html.erb
+      |               |- index.html.erb
+      |               |- new.html.erb
+      |- config
+      |   |- routes.rb
+      |- rails
+          |- init.rb
+
+
+### app/controllers
+
+In this example you see one "public" controller ``app/controllers/pages_controller`` that is responsible for managing the front end when I view a page.
+
+### app/controllers/admin
+
+This bit is important. It's where all the controllers are held to manage pages in the Refinery back end in this example. You can ignore the ``pages_dialogs_controller.rb`` and ``page_parts_controller.rb`` for now and let's just focus on the ``admin/pages_controller.rb`` file. Here's what that looks like inside at a basic level:
+
+    class Admin::PagesController < Admin::BaseController
+
+      crudify :page, :conditions => "parent_id IS NULL",
+                     :order => "position ASC", :paging => false
+
+    end
+
+This single controller allows us to create, read, update and delete pages in the backend. With a little bit of Refinery magic we utilise the [crudify mixin](http://github.com/resolve/refinerycms/blob/master/vendor/plugins/refinery/crud.md) which gives us all of these regular features out of the box.
+
+How crudify works is an entire topic of it's own. Checkout the [crudify documentation](http://github.com/resolve/refinerycms/blob/master/vendor/plugins/refinery/crud.md) to get an insight into how that works.
+
+### app/views and app/helpers
+
+Works exactly the same as ``app/views`` and ``app/helpers`` in a normal Rails app. You just put the views and helpers related to this plugin in here instead of in your actual main app directory.
+
+### config/routes.rb
+
+Works exactly the same as ``config/routes.rb`` in your app except this routes file only loads the routes for this plugin.
+
+### rails/init.rb
+
+This file runs when your site is started up. All is does is registers this plugin with Refinery so it knows that it exists, how to handle it in the Refinery admin menu and how to render recent activity on the Dashboard (see "Getting your Plugin to Report Activity in the Dashboard")
+
+NOTE: The latest version of Refinery requires that you only specify a plugin.name. plugin.title &amp; plugin.description will be looked up by the I18n system.
+
+# pages/lib/pages.rb
+    Refinery::Plugin.register do |plugin|
+      plugin.name = "pages"
+      plugin.version = 1.0
+      plugin.menu_match = /(refinery|admin)\/page(_dialog|part)?s$/
+      plugin.activity = {
+        :class => Page,
+        :url_prefix => "edit_",
+        :title => "title",
+        :created_image => "page_add.png",
+        :updated_image => "page_edit.png"
+      }
+    end
+
+# pages/config/locales/en.yml
+    en:
+      plugins:
+        refinery_pages:
+          title: Pages
+          description: Manage content pages
+
+## Getting your Plugin to Report Activity in the Dashboard
+
+Recent activity reporting is built right in, so all you need to do is follow the convention below and your plugin will start showing up in the recent activity list of the Dashboard.
+
+In our example above we showed the use of ``plugin.activity`` for the pages plugin.
+
+    Refinery::Plugin.register do |plugin|
+      plugin.name = "pages"
+      plugin.version = 1.0
+      plugin.menu_match = /(refinery|admin)\/page(_dialog|part)?s$/
+      plugin.activity = {
+        :class => Page,
+        :url_prefix => "edit_",
+        :title => "title",
+        :created_image => "page_add.png",
+        :updated_image => "page_edit.png"
+      }
+    end
+
+Here's what the different activity options mean:
+
+### Required
+
+    :class
+    # the name of the class we're watching.
+
+    :url_prefix
+    # Just use "edit_" if you're not sure how this works.
+    #
+    # When it says "'About' page was updated about 4 hours ago", the page title "About"
+    # is linked to that page in a way we specify.  So by setting "_edit" as a :url_prefix what
+    # we're doing is making it link to the page that allows us to edit this page.
+    # So the next result is edit_admin_page_url(page)
+
+    :title
+    # which attribute on the :class should be in the activty message. In our case it's "title"
+    # because we want it to run something like this "#{page.title} was updated about ...."
+
+### Optional
+
+    :created_image and :updated_image
+    # the activity monitor knows if something is created or updated and shows a different icon
+    # depending on how you want that to look. You can specify the filename to any image you
+    # want in the public/images/refinery/icons/ directory.
+
+## Search Engine Optimisation: Improving the default URLs
+
+In our example above we extended Refinery to manage a products area. The problem is when I look at a product on the front end I get a URL like [http://localhost:3000/products/1](http://localhost:3000/products/1) but I would really like it to be something like [http://localhost:3000/products/my-product](http://localhost:3000/products/my-product)
+
+To achieve this all you need to do is open up the product model (found in ``/vendor/plugins/products/app/models/product.rb``) and add the following line inside your class:
+
+    has_friendly_id :title, :use_slug => true
+
+Note you want to change ``:title`` to the field which you want to show up in the URL.
+
+This will work just fine for new products added from this point, but you'll want to migrate any existing products you have to use this new URL format. All you have to do is save each product you have in the database to make it create a nice URL for you.
+
+    ruby script/console
+    >> Product.all.each {|p| p.save };nil
+
+Now all the products in your database will have nice URLs.
+
+## How to get a WYSIWYG editor to show on your form fields
+
+Refinery uses a standards compliant visual editor called [WYMeditor](http://www.wymeditor.org/)
+
+_Note: When using the Refinery generator, if you apply a field type of "text" to any of your fields, they automatically load as a WYMEditor._
+
+The WYSIWYG editor can only be applied to a ``textarea``. All you need to do is add a class of "wymeditor widest" to a ``textarea`` in your form and a WYSIWYG WYMEditor will load right in place.
+
+### Example
+
+Again going back to our product plugin example if you had this in your ``vendor/plugins/products/app/views/admin/products/_form.html.erb`` file:
+
+    <%= f.text_area :description %>
+
+Just change that to:
+
+    <%= f.text_area :description, :class => "wymeditor widest" %>
+
+Refresh and you're done.

data/vendor/refinerycms/core/lib/core.rb

@@ -0,0 +1,77 @@
+require 'rails/all'
+require 'acts_as_tree'
+require 'acts_as_indexed'
+require 'friendly_id'
+require 'truncate_html'
+require 'will_paginate'
+
+module Refinery
+
+  autoload :Plugin,  'refinery/plugin'
+  autoload :Plugins, 'refinery/plugins'
+  autoload :Activity, 'refinery/activity'
+
+  class Engine < Rails::Engine
+    initializer "static assets" do |app|
+      app.middleware.insert_after ::ActionDispatch::Static, ::ActionDispatch::Static, "#{root}/public"
+    end
+
+    config.autoload_paths += %W( #{config.root}/lib )
+
+    initializer 'add catch all routes' do |app|
+      app.routes_reloader.paths << File.expand_path('../refinery/catch_all_routes.rb', __FILE__)
+    end
+
+    config.to_prepare do
+      Rails.cache.clear
+
+      require_dependency 'refinery/form_helpers'
+      require_dependency 'refinery/base_presenter'
+
+      [
+        Refinery.root.join("vendor", "plugins", "*", "app", "presenters"),
+        Rails.root.join("app", "presenters")
+      ].each do |path|
+        Dir[path.to_s].each do |presenters_path|
+          $LOAD_PATH << presenters_path
+          ::ActiveSupport::Dependencies.load_paths << presenters_path
+        end
+      end
+
+      # Figure out a better way to cache assets.
+      ::ActionView::Helpers::AssetTagHelper.module_eval do
+        def asset_file_path(path)
+          unless File.exist?(return_path = File.join(config.assets_dir, path.split('?').first))
+            ::Refinery::Plugins.registered.collect{|p| p.pathname}.compact.each do |pathname|
+              if File.exist?(plugin_asset_path = File.join(pathname.to_s, 'public', path.split('?').first))
+                return_path = plugin_asset_path.to_s
+              end
+            end
+          end
+
+          return_path
+        end
+      end
+    end
+
+    config.after_initialize do
+      Refinery::Plugin.register do |plugin|
+        plugin.name ="refinery_core"
+        plugin.class_name ="RefineryEngine"
+        plugin.version = %q{0.9.8}
+        plugin.hide_from_menu = true
+        plugin.always_allow_access = true
+        plugin.menu_match = /(refinery|admin)\/(refinery_core|base)$/
+      end
+
+      # Register the dialogs plugin
+      Refinery::Plugin.register do |plugin|
+        plugin.name = "refinery_dialogs"
+        plugin.version = %q{0.9.8}
+        plugin.hide_from_menu = true
+        plugin.always_allow_access = true
+        plugin.menu_match = /(refinery|admin)\/(refinery_)?dialogs/
+      end
+    end
+  end
+end

data/vendor/refinerycms/core/lib/crud.rb

@@ -0,0 +1,265 @@
+# Base methods for CRUD actions
+# Simply override any methods in your action controller you want to be customised
+# Don't forget to add:
+#   resources :plural_model_name_here
+# to your routes.rb file.
+# Full documentation about CRUD and resources go here:
+# -> http://caboo.se/doc/classes/ActionController/Resources.html#M003716
+# Example (add to your controller):
+# crudify :foo, {:title_attribute => 'name'}
+
+module Crud
+
+  def self.append_features(base)
+    super
+    base.extend(ClassMethods)
+  end
+
+  module ClassMethods
+
+    def crudify(model_name, new_options = {})
+      singular_name = model_name.to_s
+      class_name = singular_name.camelize
+      plural_name = singular_name.pluralize
+
+      options = {
+        :title_attribute => "title",
+        :order => 'position ASC',
+        :conditions => '',
+        :sortable => true,
+        :searchable => true,
+        :include => [],
+        :paging => true,
+        :search_conditions => '',
+        :redirect_to_url => "admin_#{plural_name}_url"
+      }.merge!(new_options)
+
+      module_eval %(
+        prepend_before_filter :find_#{singular_name},
+                              :only => [:update, :destroy, :edit, :show]
+
+        def new
+          @#{singular_name} = #{class_name}.new
+        end
+
+        def create
+          # if the position field exists, set this object as last object, given the conditions of this class.
+          if #{class_name}.column_names.include?("position")
+            params[:#{singular_name}].merge!({
+              :position => ((#{class_name}.maximum(:position, :conditions => "#{options[:conditions]}")||-1) + 1)
+            })
+          end
+
+          if (@#{singular_name} = #{class_name}.create(params[:#{singular_name}])).valid?
+            unless request.xhr?
+              flash[:notice] = t('refinery.crudify.created',
+                                 :what => "'\#{@#{singular_name}.#{options[:title_attribute]}}'")
+            else
+              flash.now[:notice] = t('refinery.crudify.created',
+                                     :what => "'\#{@#{singular_name}.#{options[:title_attribute]}}'")
+            end
+            unless from_dialog?
+              unless params[:continue_editing] =~ /true|on|1/
+                redirect_back_or_default(#{options[:redirect_to_url]})
+              else
+                unless request.xhr?
+                  redirect_to :back
+                else
+                  render :partial => "/shared/message"
+                end
+              end
+            else
+              render :text => "<script type='text/javascript'>parent.window.location = '\#{#{options[:redirect_to_url]}}';</script>"
+            end
+          else
+            unless request.xhr?
+              render :action => 'new'
+            else
+              render :partial => "/shared/admin/error_messages",
+                     :locals => {
+                       :object => @#{singular_name},
+                       :include_object_name => true
+                     }
+            end
+          end
+        end
+
+        def edit
+          # object gets found by find_#{singular_name} function
+        end
+
+        def update
+          if @#{singular_name}.update_attributes(params[:#{singular_name}])
+            unless request.xhr?
+              flash[:notice] = t('refinery.crudify.updated',
+                                 :what => "'\#{@#{singular_name}.#{options[:title_attribute]}}'")
+            else
+              flash.now[:notice] = t('refinery.crudify.updated',
+                                     :what => "'\#{@#{singular_name}.#{options[:title_attribute]}}'")
+            end
+            unless from_dialog?
+              unless params[:continue_editing] =~ /true|on|1/
+                redirect_back_or_default(#{options[:redirect_to_url]})
+              else
+                unless request.xhr?
+                  redirect_to :back
+                else
+                  render :partial => "/shared/message"
+                end
+              end
+            else
+              render :text => "<script type='text/javascript'>parent.window.location = '\#{#{options[:redirect_to_url]}}';</script>"
+            end
+          else
+            unless request.xhr?
+              render :action => 'edit'
+            else
+              render :partial => "/shared/admin/error_messages",
+                     :locals => {
+                       :object => @#{singular_name},
+                       :include_object_name => true
+                     }
+            end
+          end
+        end
+
+        def destroy
+          if @#{singular_name}.destroy
+            flash[:notice] = t('refinery.crudify.destroyed',
+                               :what => "'\#{@#{singular_name}.#{options[:title_attribute]}}'")
+          end
+          redirect_to #{options[:redirect_to_url]}
+        end
+
+        def find_#{singular_name}
+          @#{singular_name} = #{class_name}.find(params[:id],
+                                                 :include => %w(#{options[:include].join(' ')}))
+        end
+
+        def find_all_#{plural_name}
+          @#{plural_name} = #{class_name}.find(
+            :all,
+            :order => "#{options[:order]}",
+            :conditions => "#{options[:conditions]}",
+            :include => %w(#{options[:include].join(' ')})
+          )
+        end
+
+        def paginate_all_#{plural_name}
+          @#{plural_name} = #{class_name}.paginate(
+            :page => params[:page],
+            :order => "#{options[:order]}",
+            :conditions => "#{options[:conditions]}",
+            :include => %w(#{options[:include].join(' ')})
+          )
+        end
+
+        def search_all_#{plural_name}
+          @#{plural_name} = #{class_name}.with_query(params[:search]).find(
+            :all,
+            :order => "#{options[:order]}",
+            :conditions => "#{options[:search_conditions]}",
+            :include => %w(#{options[:include].join(' ')})
+          )
+        end
+
+        def search_and_paginate_all_#{plural_name}
+          @#{plural_name} = #{class_name}.with_query(params[:search]).paginate(
+            :page => params[:page],
+            :order => "#{options[:order]}",
+            :conditions => "#{options[:search_conditions]}",
+            :include => %w(#{options[:include].join(' ')})
+          )
+        end
+
+        protected :find_#{singular_name},
+                  :find_all_#{plural_name},
+                  :paginate_all_#{plural_name},
+                  :search_all_#{plural_name},
+                  :search_and_paginate_all_#{plural_name}
+
+      )
+
+      if options[:searchable]
+        if options[:paging]
+          module_eval %(
+            def index
+              if searching?
+                search_and_paginate_all_#{plural_name}
+              else
+                paginate_all_#{plural_name}
+              end
+            end
+          )
+        else
+          module_eval %(
+            def index
+              if searching?
+                search_all_#{plural_name}
+              else
+                find_all_#{plural_name}
+              end
+            end
+          )
+        end
+
+      else
+        if options[:paging]
+          module_eval %(
+            def index
+              paginate_all_#{plural_name}
+            end
+          )
+        else
+          module_eval %(
+            def index
+              find_all_#{plural_name}
+            end
+          )
+        end
+
+      end
+
+      if options[:sortable]
+        module_eval %(
+          def reorder
+            find_all_#{plural_name}
+          end
+
+          def update_positions
+            unless params[:tree] == "true"
+              params[:sortable_list].each_with_index do |i, index|
+                #{class_name}.find(i).update_attribute(:position, index)
+              end
+            else
+              params[:sortable_list].each do |position, id_hash|
+                parse_branch(position, id_hash, nil)
+              end
+            end
+
+            find_all_#{plural_name}
+            render :partial => 'sortable_list',
+                   :layout => false,
+                   :locals => {
+                     :continue_reordering => params[:continue_reordering]
+                   }
+          end
+
+          # takes in a single branch and saves the nodes inside it
+          def parse_branch(position, id_hash, parent_id)
+            id_hash.each do |pos, id|
+              parse_branch(pos, id, id_hash["id"]) unless pos == "id"
+            end if id_hash.include?('0')
+
+            #{class_name}.update_all(["parent_id = ?, position = ?", parent_id, position], ["id = ?", id_hash["id"]])
+          end
+
+          protected :parse_branch
+        )
+      end
+
+    end
+
+  end
+
+end