refinerycms-routes 1.0

data/app/controllers/admin/routes_controller.rb

@@ -0,0 +1,43 @@
+module Admin
+  class RoutesController < Admin::BaseController
+    before_filter :find_all_locales
+    before_filter :find_locale
+    before_filter :find_routes_to_redirect, :except => [:index, :redirections]
+    before_filter :find_all_pages, :except => [:index, :redirections]
+
+    crudify :route, :sortable => false,
+            :title_attribute => 'url', :xhr_paging => true, :include => [:target]
+
+
+    def redirections
+      @routes = Route.where(:redirect => true)
+      render :index
+    end
+
+    def find_all_locales
+      @locales ||= ::Refinery::I18n.frontend_locales
+    end
+
+    def find_all_pages
+      @pages = Page.all
+    end
+
+    def find_all_routes
+      @routes = Route.where(:locale => @current_locale).order(:url)
+    end
+
+    def find_routes_to_redirect
+      @routes = Route.where(:redirect => [false, nil])
+    end
+
+    def default_locale
+      ::Refinery::I18n.default_frontend_locale
+    end
+
+    protected
+
+    def find_locale
+      @current_locale ||= (params[:route_locale] || default_locale).to_sym
+    end
+  end
+end

data/app/helpers/router_helper.rb

@@ -0,0 +1,11 @@
+module RouterHelper
+  def custom_url_for(page, locale = nil)
+    locale ||= Globalize.locale
+
+    if route = Route.where(:target_id => page.id, :target_type => 'Page', :locale => locale).first
+      "/#{route.url}"
+    else
+      page.url
+    end
+  end
+end

data/app/models/route.rb

@@ -0,0 +1,10 @@
+class Route < ActiveRecord::Base
+
+  acts_as_indexed :fields => [:url, :locale]
+
+  validates :url, :presence => true, :uniqueness => true,
+            :format => { :with => /(^[\da-zA-Z_-]+)/ }
+
+  belongs_to :target, :polymorphic => true
+
+end

data/app/views/admin/routes/_actions.html.erb

@@ -0,0 +1,25 @@
+<ul>
+  <% if Admin::RoutesController.searchable? %>
+    <li>
+      <%= render :partial => "/shared/admin/search",
+                  :locals => {
+                    :url => admin_routes_url
+                  } %>
+    </li>
+  <% end unless action_name == 'redirections' %>
+  <li>
+    <% type = action_name == 'redirections' ? 'redirection' : 'route' %>
+    <%= link_to t(".create_new_#{type}"), new_admin_route_url(:route_locale => @current_locale, :dialog => true, :type => type),
+                 :class => "add_icon" %>
+  </li>
+  <%= render 'locale_filters' unless action_name == 'redirections' %>
+  <li>
+    <% if action_name == 'redirections' %>
+    <%= link_to t(".manage_routes"), admin_routes_url,
+                 :class => "edit_icon" %>
+    <% else %>
+    <%= link_to t(".manage_redirections"), redirections_admin_routes_url,
+                 :class => "edit_icon" %>
+    <% end %>
+  </li>
+</ul>

data/app/views/admin/routes/_form.html.erb

@@ -0,0 +1,56 @@
+<%= form_for [:admin, @route] do |f| -%>
+  <%= render :partial => "/shared/admin/error_messages", :locals => {
+          :object => @route,
+          :include_object_name => true
+        } %>
+
+  <%= hidden_field_tag 'type', params[:type] -%>
+
+  <div class='url-field'>
+    <%= f.label :url, "#{request.protocol}#{request.domain}/" -%>
+    <%= f.text_field :url -%>
+  </div>
+
+  <% if defined?(::Refinery::I18n) and ::Refinery::I18n.enabled? and params[:type] == 'route' %>
+  <div class='field'>
+    <%= f.label :locale -%>
+    <%= f.select :locale, ::Refinery::I18n.locales.reject {|locale, title| !@locales.include?( locale ) }.invert, :selected => @current_locale -%>
+  </div>
+  <% end %>
+
+  <%= hidden_field_tag 'route[redirect]', params[:type] == 'redirection' -%>
+
+  <div class='field'>
+    <%= f.label :target_id -%>
+    <% if params[:type] == 'route' %>
+    <%= f.select :target_id, @pages.map {|p| [p.title, p.id] } -%>
+    <% target_type = 'Page' %>
+    <% else %>
+    <%= f.select :target_id, grouped_options_for_select(@routes.group_by(&:locale).map {|locale, routes| [locale, routes.map { |r| [r.url, r.id] }] }) -%>
+    <% target_type = 'Route' %>
+    <% end %>
+    <%= hidden_field_tag 'route[target_type]', target_type -%>
+  </div>
+  
+  <%= render :partial => "/shared/admin/form_actions",
+              :locals => {
+                :f => f,
+                :continue_editing => false,
+                :delete_title => t('delete', :scope => 'admin.routes.route'),
+                :delete_confirmation => t('message', :scope => 'shared.admin.delete', :title => @route.url)
+              } %>
+<% end -%>
+
+<style type='text/css'>
+.url-field { border: 1px solid #7F9DB9; }
+.url-field label, .url-field input { padding: 5px; margin: 5px; }
+.url-field label { 
+  font-size: 1.4em;
+  clear:both; float:left; display:inline; 
+  margin-right: 1px; padding-right: 1px; }
+.url-field input { 
+  border: 0; 
+  margin-left: 1px; display:block; 
+  overflow: hidden; zoom:1; position:relative; 
+  font-weight: bold; font-size: 1.1em; }
+</style>

data/app/views/admin/routes/_locale_filters.html.erb

@@ -0,0 +1,26 @@
+<% if defined?(::Refinery::I18n) and ::Refinery::I18n.enabled? %>
+<% locales = ::Refinery::I18n.locales.reject {|locale, title| !@locales.include?( locale ) } %>
+<ul class='collapsible_menu closed'>
+
+  <% if @current_locale %>
+    <% current_locale = @current_locale %>
+    <% current_locale_title = locales[current_locale] %>
+      <li>
+        <%= link_to "#", :style => "background-image: url('/images/refinery/icons/flags/#{current_locale}.png');" do %>
+          <%= current_locale_title.respond_to?(:force_encoding) ? 
+              current_locale_title.force_encoding('utf-8') : current_locale_title %>
+          <span><%= t('.change_language') %></span>
+          <span style='display:none;'><%= t('cancel', :scope => 'shared.admin.form_actions') %></span>
+        <% end %>
+      </li>
+  <% end %>
+
+  <% locales.sort_by{|key, value| value}.each do |locale, locale_title| %>
+    <li>
+      <%= link_to locale_title, params.dup.tap { |p| p[:route_locale] = locale },
+                  :style => "background-image: url('/images/refinery/icons/flags/#{locale}.png');" %>
+    </li>
+  <% end %>
+</ul>
+
+<% end %>

data/app/views/admin/routes/_records.html.erb

@@ -0,0 +1,22 @@
+<% if searching? %>
+  <h2><%= t('results_for', :scope => 'shared.admin.search', :query => params[:search]) %></h2>
+<% end %>
+<% if @routes.any? %>
+  <div class='pagination_container'>
+    <%= render :partial => 'routes' %>
+  </div>
+<% else %>
+  <p>
+    <% unless searching? %>
+      <strong>
+        <% if action_name == 'redirections' %>
+          <%= t('.no_redirections_yet') %>
+        <% else %>
+          <%= t('.no_routes_yet') %>
+        <% end %>
+      </strong>
+    <% else %>
+      <%= t('no_results', :scope => 'shared.admin.search') %>
+    <% end %>
+  </p>
+<% end %>

data/app/views/admin/routes/_redirection.html.erb

@@ -0,0 +1,28 @@
+<li class='clearfix record <%= cycle("on", "on-hover") %>' id="<%= dom_id(redirection) -%>">
+  <span class='title'>
+    <% url = "#{request.protocol}#{request.host}/#{redirection.url}" -%>
+    <%= url %> →
+
+    <% if redirection.target.is_a? Route -%>
+    <% target_url = "#{request.protocol}#{request.host}/#{redirection.target.url}" -%>
+    <span class="preview">
+      <% if defined?(::Refinery::I18n) and ::Refinery::I18n.enabled? %>
+      <%= refinery_icon_tag("flags/#{redirection.target.locale}.png", :size => '16x11') %>
+      <% end %>
+      <%= target_url %>
+    </span>
+    <% end %>
+  </span>
+  <span class='actions'>
+    <%= link_to refinery_icon_tag("application_go.png"), url,
+        :title => t('.view_live_html'),
+        :target => "_blank" %>
+    <%= link_to refinery_icon_tag("application_edit.png"), edit_admin_route_path(redirection, :dialog => true, :type => 'redirection'),
+         :title => t('.edit') %>
+    <%= link_to refinery_icon_tag("delete.png"), admin_route_path(redirection),
+        :class => "cancel confirm-delete",
+        :title => t('.delete'),
+        :confirm => t('message', :scope => 'shared.admin.delete', :title => redirection.url),
+        :method => :delete %>
+  </span>
+</li>

data/app/views/admin/routes/_route.html.erb

@@ -0,0 +1,27 @@
+<li class='clearfix record <%= cycle("on", "on-hover") %>' id="<%= dom_id(route) -%>">
+  <span class='title'>
+    <% if defined?(::Refinery::I18n) and ::Refinery::I18n.enabled? %>
+    <%= refinery_icon_tag("flags/#{route.locale}.png", :size => '16x11') %>
+    <% end %>
+    <% url = "#{request.protocol}#{request.host}/#{route.url}" -%>
+    <%= url %> →
+
+    <% if route.target.is_a? Page -%>
+    <span class="preview">
+      <%= link_to route.target.title, edit_admin_page_path(route.target, :switch_locale => route.locale) %>
+    </span>
+    <% end %>
+  </span>
+  <span class='actions'>
+    <%= link_to refinery_icon_tag("application_go.png"), url,
+        :title => t('.view_live_html'),
+        :target => "_blank" %>
+    <%= link_to refinery_icon_tag("application_edit.png"), edit_admin_route_path(route, :dialog => true, :type => 'route'),
+         :title => t('.edit') %>
+    <%= link_to refinery_icon_tag("delete.png"), admin_route_path(route),
+        :class => "cancel confirm-delete",
+        :title => t('.delete'),
+        :confirm => t('message', :scope => 'shared.admin.delete', :title => route.url),
+        :method => :delete %>
+  </span>
+</li>

data/app/views/admin/routes/_routes.html.erb

@@ -0,0 +1,7 @@
+<ul>
+  <% if action_name == 'redirections' %>
+    <%= render :partial => 'redirection', :collection => @routes %>
+  <% else %>
+    <%= render :partial => 'route', :collection => @routes %>
+  <% end %>
+</ul>

data/app/views/admin/routes/edit.html.erb

@@ -0,0 +1 @@
+<%= render :partial => "form" %>

data/app/views/admin/routes/index.html.erb

@@ -0,0 +1,6 @@
+<section id='records'>
+  <%= render :partial => 'records' %>
+</section>
+<aside id='actions'>
+  <%= render :partial => 'actions' %>
+</aside>

data/app/views/admin/routes/new.html.erb

@@ -0,0 +1 @@
+<%= render :partial => "form" %>

data/config/locales/en.yml

@@ -0,0 +1,24 @@
+en:
+  plugins:
+    refinerycms_routes:
+      title: Routes
+  admin:
+    routes:
+      actions:
+        create_new_route: Add New Route
+        create_new_redirection: Add New Redirection
+        manage_routes: Manage Routes
+        manage_redirections: Manage Redirections
+      locale_filters:
+        change_language: Change language
+      records:
+        title: Routes
+        sorry_no_results: Sorry! There are no results found.
+        no_items_yet: There are no Routes yet. Click "Add New Route" to add your first route.
+      route:
+        view_live_html: View this route live <br/><em>(opens in a new window)</em>
+        edit: Edit this route
+        delete: Remove this route forever
+  routes:
+    show:
+      other: Other Routes

data/config/routes.rb

@@ -0,0 +1,11 @@
+Refinery::Application.routes.draw do
+  resources :routes, :only => [:index, :show]
+
+  scope(:path => 'refinery', :as => 'admin', :module => 'admin') do
+    resources :routes, :except => :show do
+      collection do
+        get :redirections
+      end
+    end
+  end
+end

data/lib/generators/refinerycms_routes_generator.rb

@@ -0,0 +1,14 @@
+class RefinerycmsRoutesGenerator < Refinery::Generators::EngineInstaller
+
+  source_root File.expand_path('../../../', __FILE__)
+  engine_name "refinerycms_routes"
+
+  class_option :page_controller, :type => :boolean, :default => true, :description => "Include a default custom page controller"
+
+  def generate
+    super
+    copy_file "#{self.class.source_root}/lib/generators/templates/pages_controller.rb", 
+              "app/controllers/pages_controller.rb" if options.page_controller?
+  end
+
+end

data/lib/generators/templates/pages_controller.rb

@@ -0,0 +1,42 @@
+class PagesController < ApplicationController
+
+  # This action is usually accessed with the root path, normally '/'
+  def home
+    error_404 unless (@page = Page.where(:link_url => '/').first).present?
+  end
+
+  # This is where the custom routing happen.
+  def show
+    # Try to find a routes that match with the request path
+    if route = Route.where(:url => "#{params[:path]}").first
+      route_target = route.target
+      case route_target
+      when Page then
+        # If the target of the route is a page, render that page.
+        @page = route.target
+        Globalize.locale = route.locale
+      when Route
+        # If the target of the route is another route, redirect to that page.
+        url = URI.parse(request.url)
+        url.path = '/' + route.target.url
+        redirect_to url.to_s, :status => :moved_permanently and return
+      end
+    end
+
+    # Fallback to refinerycms default if no routes is found.
+    @page ||= Page.find("#{params[:path]}/#{params[:id]}".split('/').last)
+
+    # proceed as usual...
+    if @page.try(:live?) || (refinery_user? && current_user.authorized_plugins.include?("refinery_pages"))
+      # if the admin wants this to be a "placeholder" page which goes to its first child, go to that instead.
+      if @page.skip_to_first_child && (first_live_child = @page.children.order('lft ASC').live.first).present?
+        redirect_to first_live_child.url
+      elsif @page.link_url.present?
+        redirect_to @page.link_url and return
+      end
+    else
+      error_404
+    end
+  end
+
+end

data/lib/refinerycms-routes.rb

@@ -0,0 +1,33 @@
+require 'refinerycms-base'
+require 'refinerycms-pages'
+
+module Refinery
+  module Routes
+    class Engine < Rails::Engine
+      initializer "static assets" do |app|
+        app.middleware.insert_after ::ActionDispatch::Static, ::ActionDispatch::Static, "#{root}/public"
+      end
+
+      config.to_prepare do
+        ::ApplicationController.helper(RouterHelper)
+
+        Page.module_eval do
+          has_many :routes, :dependent => :destroy
+        end
+      end
+
+      config.after_initialize do
+        Refinery::Plugin.register do |plugin|
+          plugin.name = 'refinerycms_routes'
+          plugin.url = {:controller => '/admin/routes', :action => 'index'}
+          plugin.menu_match = /routes/
+          plugin.activity = {
+            :class => Route,
+            :title => 'Url'
+          }
+        end
+
+      end
+    end
+  end
+end

data/lib/tasks/routes.rake

@@ -0,0 +1,15 @@
+namespace :refinery do
+  
+  namespace :routes do
+    
+    desc "List custom routes"
+    task :list => :environment do
+      Route.order(:locale).all.each do |route|
+        route_type = route.redirect? ? 'Redirection' : 'Map'
+        puts %(GET | /#{route.url}    {#{route_type} => #{route.target.class} id: #{route.target.id} #{' locale: ' + route.locale unless route.redirect?}})
+      end
+    end
+  
+  end
+  
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+name: refinerycms-routes
+version: !ruby/object:Gem::Version 
+  hash: 15
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  version: "1.0"
+platform: ruby
+authors: 
+- Charles Barbier
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-14 00:00:00 Z
+dependencies: []
+
+description: Custom routing for Refinery CMS
+email: unixcharles@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/generators/refinerycms_routes_generator.rb
+- lib/generators/templates/pages_controller.rb
+- lib/refinerycms-routes.rb
+- lib/tasks/routes.rake
+- config/locales/en.yml
+- config/routes.rb
+- app/controllers/admin/routes_controller.rb
+- app/helpers/router_helper.rb
+- app/models/route.rb
+- app/views/admin/routes/_actions.html.erb
+- app/views/admin/routes/_form.html.erb
+- app/views/admin/routes/_locale_filters.html.erb
+- app/views/admin/routes/_records.html.erb
+- app/views/admin/routes/_redirection.html.erb
+- app/views/admin/routes/_route.html.erb
+- app/views/admin/routes/_routes.html.erb
+- app/views/admin/routes/edit.html.erb
+- app/views/admin/routes/index.html.erb
+- app/views/admin/routes/new.html.erb
+homepage: http://github.com/unixcharles/refinerycms-copywriting
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.5
+signing_key: 
+specification_version: 3
+summary: Refinery CMS engine that allow you to manage custom localized routes and redirection.
+test_files: []
+