page_engine 0.0.4 → 0.0.5

data/README.markdown

@@ -1,88 +1,98 @@
-# Page Engine
-
 Page engine is a (_reasonably_) simple way to extend your rails application with pages. This allows you to automatically generate navigation, breadcrumbs and create page snippets to use anywhere in your app views.
 
-## Installation
+Installation
+------------
 
 For rails 3 and above simply add the following to your gemfile:
 
-	gem 'page_engine'
+`gem 'page_engine'`
 
 Then bundle install.
 
 To make use of the assets in the gem add the following to your stylesheets manifest
 
-   *= require page_engine
-   
+`*= require page_engine`
+  
 and after jquery in your javascripts manifest 
   
-   //= require page_engine
-
-Since rails 3.0 doesn't support the asset pipeline out of the box you will also need to install the gems assets (images, css and javascript) using:
+`//= require page_engine`
 
-	rails g page_engine
+Run the installation generator to install the config file in config/initializers (for versions of rails that don't support the asset pipeline the assets will be copied across at the same time).
 
-If you've managed to get the asset pipeline working in rails 3.0 then you can skip the above step... and feel free to give yourself a biscuit.
+`rails g page_engine:install`
 
 To install the migrations run
 
-  rake page_engine_engine:install:migrations
-  
-
+`rake page_engine_engine:install:migrations`
 
-## Usage
+Usage
+-----
 
 In application_controller add the line
 
-	page_engine
+`page_engine`
 
 and you're good to go. 
 
-You can supply options to page engine, currently just the layouts that should be available to the pages, and you can do this using
+You can supply options to page engine by editing the page_engine.rb initializer file.
+
+For rails 3 the required stylesheet and javascript files can be included with:
 
-	page_engine { :layouts => ['application'] }
+`stylesheet_link_tag :page_engine`
 
-## How it works
+and 
+
+`javascript_include_tag :page_engine`
+
+How it works
+------------
 
 PageEngine comes with an admin namespace where you can CRUD your pages. It uses [jquery.nestedSortable](http://mjsarfatti.com/sandbox/nestedSortable/ "jquery.nestedSortable") to allow reordering and nesting of pages using drag and drop. When you create the page you can set a url or a controller and action and PageEngine use these to find the correct page. So, for example, say you have a welcome page at welcome#index, if you set the url to '/welcome' or choose welcome#index from the dropdown that page record will be retrieved when the welcome index page is hit and be available to your views.
 
 Using [MarkItUp](http://markitup.jaysalvat.com/home/ "MarkItUp") it's possible to write page content using textile, markdown or plain html. There's also the option to use erb but this is pretty dangerous and open to abuse so don't count on it being in there forever.
 
-## In the views
+In the views
+------------
 
 PageEngine comes with a few helpers:
 
-	navigation(root page permalink, options)
+`navigation(root page permalink, options)`
 
 This generates an unordered list (ul) containing the root page and it's descendants up to the depth specified in the options.
 
-	page_content
+`page_content`
 
 Renders the page content using the filter specified (textile, markdown etc). Defaults to using the automatically found page and it's body page part but this can be overriden in the options
 
-	breadcrumbs
+`breadcrumbs`
 
 Generates a set of links that represent the current page and it's ancestors
 
-	page_title
-	
+`page_title(default_text)`
 
-	page_js
+Outputs the page title, or the default text if no page record has been found.
 	
+`page_js`
 
-	page_css
+Outputs a javascript tag containing the page javascript, or just the straight css if :with_tags => false.
 	
+`page_css`
 
-	page_meta_keywords
+Outputs a stylesheet tag containing the page css, or just the straight css if :with_tags => false.
 	
+`page_meta_keywords`
 
-	page_meta_description
-	
+Outputs a meta tag containing the pages keywords, or just the keywords if :with_tags => false
+
+`page_meta_description`
 
-	page_snippet snippet name
+Outputs a meta tag containing the pages description, or just the description if :with_tags => false
+	
+`page_snippet(snippet name)`
 
-Renders the named snippet
+Renders the named snippet.
 
-## Rails engine
+Rails engine
+------------
 
 Since this was built using the rails 3.1 plugin generator you can test the gem using the dummy application which can be found under spec/dummy.

data/Rakefile

@@ -23,17 +23,4 @@ end
 APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
 load 'rails/tasks/engine.rake'
 
-
 Bundler::GemHelper.install_tasks
-
-require 'rake/testtask'
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = false
-end
-
-
-task :default => :test

data/app/assets/javascripts/page_engine.js

@@ -39,17 +39,18 @@ $(document).ready(function(){
     return false;
   });
   
-  var selected_tab = 0;
-  var page_parts = $('.page_parts').tabs({
-    select: function(event, ui){
-      selected_tab = ui.index;
-    }
+  var page_parts = $('#page_engine_page_parts').tabs({
+    tabTemplate: "<li><a href='#{href}'>#{label}</a> <span class='icon delete'>Remove page part</span></li>"
   });
 
-  $('.page_part a.delete').live('click', function(){
-    $(this).prev().val(true);
-    $('.page_parts').after($(this).prev());
-    page_parts.tabs('remove', selected_tab);     
+  $('#page_engine_page_parts ul li span.delete').live('click', function(){
+    hidden_delete = $($(this).prev().attr('href')).find('input[type=hidden]:first');
+    hidden_delete.val(true);
+    $('.page_parts').after(hidden_delete);
+    
+    var index = $("li", page_parts).index($(this).parent());
+    page_parts.tabs('remove', index);     
+    
     return false;
   });
   
@@ -94,6 +95,32 @@ $(document).ready(function(){
       return false;
     }
   });
+  
+  $('#add_page_part').click(function(){
+    page_part_name = prompt('Enter the new page part name').replace(/[^a-z0-9\-_]+/ig, '-');
+    
+    if (page_part_name != ''){
+      if ($('#page_part_' + page_part_name).length == 0){
+        var new_id = new Date().getTime();
+        var content = unescape($('#page_engine_page_parts').attr('data-fields'));
+        
+        content = content.replace(/name="page_parts/g, 'name="page[page_parts_attributes][' + new_id + ']');
+        content = content.replace(/for="page_parts/g, 'for="page_page_parts_attributes_' + new_id);
+
+        $('#page_engine_page_parts').tabs('add', '#' + new_id, page_part_name);
+        $('#' + new_id).html(content);
+        $('#' + new_id).addClass('page_part');
+        $('#' + new_id + ' .input:first input').val(page_part_name);
+      }
+      else {
+        alert('Name already exists');      
+      }
+    } else {
+      alert('You need to specify a name');
+    }
+    
+    return false;
+  });
 });
 
 check_filter = function(filter){

data/app/assets/stylesheets/page_engine.css

@@ -1,5 +1,4 @@
 /*
- *= require jquery-ui
  *= require markitup/skins/simple/style
  *= require markitup/sets/html/style
  *= require markitup/sets/textile/style
@@ -9,226 +8,3 @@
  *= require codemirror/codemirror
  *= require codemirror/themes/default
 */
-
-.js .hidden {
-  display: none;
-}
-
-.icon, nav.pagination .first a, nav.pagination .prev a, nav.pagination .next a, nav.pagination .last a {
-  display: -moz-inline-box;
-  -moz-box-orient: vertical;
-  display: inline-block;
-  vertical-align: middle;
-  *vertical-align: auto;
-  height: 16px;
-  width: 16px;
-  text-indent: -119988px;
-  overflow: hidden;
-  text-align: left;
-  background-image: url(/assets/page_engine/ruby.png);
-  background-repeat: no-repeat;
-  background-position: 50% 50%;
-  vertical-align: middle;
-  cursor: pointer;
-  background-repeat: no-repeat;
-  background-position: center center;
-}
-
-.icon, nav.pagination .first a, nav.pagination .prev a, nav.pagination .next a, nav.pagination .last a {
-  *display: inline;
-}
-
-.icon.add {
-  background-image: url(/assets/page_engine/add.png);
-}
-
-.icon.delete {
-  background-image: url(/assets/page_engine/delete.png);
-}
-
-.icon.edit {
-  background-image: url(/assets/page_engine/pencil.png);
-}
-
-.icon.show {
-  background-image: url(/assets/page_engine/zoom.png);
-}
-
-
-.icon.waiting {
-  background-image: url(/assets/page_engine/waiting.gif);
-}
-
-form.button_to {
-  display: inline;
-}
-
-form.button_to * {
-  display: inline;
-}
-
-ol#page_engine,
-ol#page_engine ol {
-  margin: 0;
-  padding: 0 0 0 16px;
-  border-left: solid white 1px;
-}
-
-ol#page_engine li.page {
-  background: white;
-}
-
-ol#page_engine li.placeholder {
-  border: dashed 1px #333;
-}
-
-ol#page_engine * {
-  list-style: none;
-}
-
-ol#page_engine .icon.add {
-  margin: 0 0 0 6px;
-  background-image: url(/assets/page_engine/page_add.png);
-}
-
-ol#page_engine .icon.edit {
-  background-image: url(/assets/page_engine/page_edit.png);
-}
-
-ol#page_engine .icon.delete {
-  background-image: url(/assets/page_engine/page_delete.png);
-}
-
-ol#page_engine .icon.duplicate {
-  background-image: url(/assets/page_engine/page_copy.png);
-}
-
-ol#page_engine .icon.published {
-  margin: 0 6px 0 0;
-  background-image: url(/assets/page_engine/page_green.png);
-}
-
-ol#page_engine .icon.live {
-  margin: 0 6px 0 0;
-  background-image: url(/assets/page_engine/page_lightning.png);
-}
-
-ol#page_engine .icon.draft {
-  margin: 0 6px 0 0;
-  background-image: url(/assets/page_engine/page_red.png);
-}
-
-ol#page_engine .icon.hidden {
-  margin: 0 6px 0 0;
-  background-image: url(/assets/page_engine/page_hidden.png);
-}
-
-ol#page_engine .icon.review {
-  margin: 0 6px 0 0;
-  background-image: url(/assets/page_engine/page_gear.png);
-}
-
-.page_part .delete {
-  float: right;
-}
-
-.page_part.ui-tabs-panel {
-  padding: 5px;
-}
-
-.page_part .field textarea {
-  width: 98.5%;
-}
-
-.tabs li.tab_with_errors {
-  background: #CC0000 !important;
-}
-
-.tabs li.tab_with_errors a {
-  color: white !important;
-}
-
-.page_form br {
-  display: none;
-}
-
-.page_form .field input[type="text"] {
-  width: 44.6em;
-}
-
-.page_form #new_page_part_name {
-  width: 20em;
-}
-
-.page_form .field.new_page_part_name {
-  text-align: right;
-}
-
-.page_form .field.page_part_title label {
-  width: 6em;
-  display: inline-block;
-  text-align: right;
-}
-
-.page_form .field.status label,
-.page_form .field.css label,
-.page_form .field.js label,
-.page_form .field.no_publish_window label,
-.page_form .field.publish_from label,
-.page_form .field.publish_to label,
-.page_form .field.controller_action label,
-.page_form .field.url label,
-.page_form .field.display_in_sitemap label,
-.page_form .field.display_in_menu label,
-.page_form .field.menu_css_class label,
-.page_form .field.no_link label,
-.page_form .field.layout label,
-.page_form .field.title label,
-.page_form .field.permalink label,
-.page_form .field.meta_description label,
-.page_form .field.meta_keywords label,
-.page_form .field.page_part_title label,
-.page_form .field.filter label,
-.page_form .field.roles label:first-child {
-  padding: 0 10px 0 0;
-  width: 10em;
-  display: inline-block;
-  text-align: right;
-}
-
-.page_form .field.page_part_title label,
-.page_form .field.filter label {
-  width: 4em;
-}
-
-.page_form #page_meta_keywords,
-.page_form #page_meta_description,
-.page_form #page_css,
-.page_form #page_js {
-  height: 12em;
-  vertical-align: middle;
-  width: 49.5em;
-}
-
-.page_form .field.roles .roles_list {
-  display: inline;
-}
-
-form#page_snippet .field.name br,
-form#page_snippet .field.filter br {
-  display: none;
-}
-
-form#page_snippet .field.name label,
-form#page_snippet .field.filter label {
-  display: inline-block;
-  width: 80px;
-}
-
-form#page_snippet .field.name input[type="text"] {
-  width: 645px;
-}
-
-form#page_snippet .field.content textarea {
-  width: 98.4%;
-}

data/app/controllers/admin/page_snippets_controller.rb

@@ -1,6 +1,4 @@
-class Admin::PageSnippetsController < ApplicationController
-  layout 'admin'
-  
+class Admin::PageSnippetsController < ApplicationController  
   def index
     @page_snippets = PageSnippet.all