radiant-templates-extension 1.0.0

data/HELP_designer.textile

@@ -0,0 +1,79 @@
+The Templates extension provides internal structure to Radiant pages, adding a layer of flexibility in Layout development.  This allows a single Layout to serve as a wireframe for the entire site, with many different template page designs filling the "content well."  Using templates, you now only need a single <r:content /> tag within the Layout.  Thus we simplify and ensure layout consistency in the creation of pages by the end user of the CMS.  
+
+h2. Usage
+
+h3. Creating a template
+
+For each new template:
+
+* Add the template parts, specifying the part type, and  their filters. Each part will be editable in the page interface.
+* Create the structure of the page, using the template parts you have created.
+* Specify the Layout and page class that will be used by pages with a given template.
+
+Let's say I want a template for press releases.  Press releases consist of a short description which also serves as the first paragraph, a longer description, a location, contact information, and standard information about the company.  So I would create the new template like so:
+
+h4. The template parts
+
+For each template part, you specify _name_, _description_, _type_ (part type) and _filter_ (formatting filter like Textile or Markdown):
+
+The would be, respectively, for the needed parts:
+
+# Location, City of Origin, One-line, none
+# Short description, Introductory blurb,  One-line, none
+# Long description, The full text of the Press Release, Plain textarea, Textile
+# Contact information, Whom to contact for details, Plain textarea, Textile
+
+h4. The structure
+
+Now you set the structure (which becomes the 'body' page-part) to be something like:
+
+<pre><code>
+<div class="press-release">
+  <p class="contact"><r:content part="Contact information" /></p>
+  <p><strong><r:date format="%d %m %Y"/>,  
+    <r:content part="Location"/></strong> - 
+    <r:content part="Short description"/>
+  </p>
+  <r:content part="Long description" />
+  <r:snippet name="corporate-press-release-blurb" />
+</div>
+</code></pre>
+
+This will not be visible to the Page Editors.  They will only see the Template parts you've defined, along with their descriptions as form field labels.
+
+h4. Layout and Page Type
+
+Finally, at the bottom of the Edit page, set the Layout (normally your standard one), and Page Type according to preference.  These cannot be changed by the Page editors.
+
+h3. Applying a template
+
+h4. Creating a new page
+
+* Click "Add Child" to create a child page an existing page.
+* Dropdown menu appears listing "Blank Page" (no template), and all the currently defined templates.
+* Select the template you wish for the new page.
+* Voilá.  Now just fill in the template-defined page parts.
+
+h4. Changing the template for an existing page
+
+* When editing the page, expand the meta drawer, by clicking 'More' underneath the Page Title.
+* You will see the current template bolded, and the others as links
+* To change to another template, simply select it, and save the page.
+
+WARNING: For page parts of your old template, if your new template does a page parts of the same name, then that content will be lost.  This is a good reason to follow naming standards when creating templates, e.g. define a page part "main_content" for all your templates.
+
+h2. Admin
+
+h3. Template Part Types (Admin users only)
+
+h4. Access
+
+Only Admin users have access to create and edit part types.  Default part types should not be removed.  Care should be taken in editing them, since any change to part type will affect every template which uses it, and hence potentially every page which is built with any of those templates.
+
+h4. Management
+
+Each Part type has Name and Field Type (e.g. radio_button, or text_field).  They also have optional Field Class and Field Style, by which the admin user can alter the display characteristics of the parts to the page editors.  
+
+Normally new part types would only be created to refine display characteristics.  For example, you might want a "Small Textarea" part type, which would be exactly the same as the default "Plain Textarea" part type, except that Field Style would have "height:80px".
+
+

data/README.textile

@@ -0,0 +1,123 @@
+h1. Templates
+
+The Templates extension provides internal structure to Radiant pages which adds an extra layer
+of flexibility in Layout development.  This allows my one Layout to serve as a wireframe for the entire site, with many different page designs filling the "content well."  I now only need a single <r:content /> tag within the Layout to accomplish this.  Thus we simplify and ensure layout consistency in the creation of pages by the end user of the CMS.  
+
+h2. Requirements
+
+The current version of the Templates extension is intended for use with Radiant 0.9.1 or higher, since its UI was made to match the new "Blade" UI of Radiant 9.  It may work with earlier versions, but there are no guarantees.  The "radiant-0.7.1 branch":https://github.com/avonderluft/radiant-templates-extension/tree/radiant-0.7.1  works with Radiant >= 0.7.1 and < 0.9.
+
+h2. Version History
+
+* 1.0.0 - gemified by Andrew vonderLuft, March 2011
+* 0.9 - Radiant 0.9 Blade UI, i18n additions Andrew vonderLuft, January 2011 - 
+* -- Radiant 0.8 compatible, Andrew vonderLuft, May 2010
+* -- Refactored to standard structure under /admin, admin UI for Part Types added, backward compatibility to < 0.8, by Andrew vonderLuft, November 2009, 
+* -- Refactored by Sean Cribbs, August 2008
+* -- Radiant 0.7 Compatible, March 2009 ("radiant-0.7.1 branch":https://github.com/avonderluft/radiant-templates-extension/tree/radiant-0.7.1)
+* -- Created by Sean Cribbs, September 2007
+
+h3. Installation
+
+h4. From github:
+
+* From your Radiant root run:
+
+<pre>git clone git://github.com/avonderluft/radiant-templates-extension.git ./vendor/extensions/templates
+rake radiant:extensions:templates:migrate
+rake radiant:extensions:templates:update
+</pre>
+
+* Restart your radiant app, and you should be good to go.
+
+h4. Using the gem
+
+* Install the gem
+
+<pre>gem install radiant-concurrent_draft-extension</pre>
+
+* Update your Radiant config:  add to environment.rb with other gem.configs
+
+<pre>config.gem 'radiant-concurrent_draft-extension', :lib => false</pre>
+
+h2. Usage
+
+h3. Creating a template
+
+For each new template:
+
+* Add the template parts, specifying the part type, and  their filters. Each part will be editable in the page interface.
+* Create the structure of the page, using the template parts you have created.
+* Specify the Layout and page class that will be used by pages with a given template.
+
+Let's say I want a template for press releases.  Press releases consist of a short description which also serves as the first paragraph, a longer description, a location, contact information, and standard information about the company.  So I would create the new template like so:
+
+h4. The template parts
+
+For each template part, you specify _name_, _description_, _type_ (part type) and _filter_ (formatting filter like Textile or Markdown):
+
+The would be, respectively, for the needed parts:
+
+# Location, City of Origin, One-line, none
+# Short description, Introductory blurb,  One-line, none
+# Long description, The full text of the Press Release, Plain textarea, Textile
+# Contact information, Whom to contact for details, Plain textarea, Textile
+
+h4. The structure
+
+Now you set the structure (which becomes the 'body' page-part) to be something like:
+
+<pre><code>
+<div class="press-release">
+  <p class="contact"><r:content part="Contact information" /></p>
+  <p><strong><r:date format="%d %m %Y"/>,  
+    <r:content part="Location"/></strong> - 
+    <r:content part="Short description"/>
+  </p>
+  <r:content part="Long description" />
+  <r:snippet name="corporate-press-release-blurb" />
+</div>
+</code></pre>
+
+This will not be visible to the Page Editors.  They will only see the Template parts you've defined, along with their descriptions as form field labels.
+
+h4. Layout and Page Type
+
+Finally, at the bottom of the Edit page, set the Layout (normally your standard one), and Page Type according to preference.  These cannot be changed by the Page editors.
+
+h3. Applying a template
+
+h4. Creating a new page
+
+* Click "Add Child" to create a child page an existing page.
+* Dropdown menu appears listing "Blank Page" (no template), and all the currently defined templates.
+* Select the template you wish for the new page.
+* Voilá.  Now just fill in the template-defined page parts.
+
+h4. Changing the template for an existing page
+
+* When editing the page, expand the meta drawer, by clicking 'More' underneath the Page Title.
+* You will see the current template bolded, and the others as links
+* To change to another template, simply select it, and save the page.
+
+WARNING: For page parts of your old template, if your new template does a page parts of the same name, then that content will be lost.  This is a good reason to follow naming standards when creating templates, e.g. define a page part "main_content" for all your templates.
+
+h2. Admin
+
+h3. Template Part Types (Admin users only)
+
+h4. Access
+
+Only Admin users have access to create and edit part types.  Default part types should not be removed.  Care should be taken in editing them, since any change to part type will affect every template which uses it, and hence potentially every page which is built with any of those templates.
+
+h4. Management
+
+Each Part type has Name and Field Type (e.g. radio_button, or text_field).  They also have optional Field Class and Field Style, by which the admin user can alter the display characteristics of the parts to the page editors.  
+
+Normally new part types would only be created to refine display characteristics.  For example, you might want a "Small Textarea" part type, which would be exactly the same as the default "Plain Textarea" part type, except that Field Style would have "height:80px".
+
+h2. Acknowledgments
+
+Thanks to Digital Pulp for funding the initial development of this extension
+for use in the Redken project, and to Con-way for funding further
+development.

data/Rakefile

@@ -0,0 +1,136 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "radiant-templates-extension"
+    gem.summary = %Q{Templates Extension for Radiant CMS}
+    gem.description = %Q{Imposes structure on pages via content templates.}
+    gem.email = "avonderluft@avlux.net"
+    gem.homepage = "https://github.com/avonderluft/radiant-templates-extension"
+    gem.authors = ['Andrew vonderLuft','Sean Cribbs']
+    gem.add_dependency 'radiant', ">=0.9.1"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. This is only required if you plan to package concurrent_draft as a gem."
+end
+
+# I think this is the one that should be moved to the extension Rakefile template
+
+# In rails 1.2, plugins aren't available in the path until they're loaded.
+# Check to see if the rspec plugin is installed first and require
+# it if it is.  If not, use the gem version.
+
+# Determine where the RSpec plugin is by loading the boot
+unless defined? RADIANT_ROOT
+  ENV["RAILS_ENV"] = "test"
+  case
+  when ENV["RADIANT_ENV_FILE"]
+    require File.dirname(ENV["RADIANT_ENV_FILE"]) + "/boot"
+  when File.dirname(__FILE__) =~ %r{vendor/radiant/vendor/extensions}
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../../../")}/config/boot"
+  else
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../")}/config/boot"
+  end
+end
+
+require 'rake'
+require 'rake/rdoctask'
+require 'rake/testtask'
+
+rspec_base = File.expand_path(RADIANT_ROOT + '/vendor/plugins/rspec/lib')
+$LOAD_PATH.unshift(rspec_base) if File.exist?(rspec_base)
+require 'spec/rake/spectask'
+# require 'spec/translator'
+
+# Cleanup the RADIANT_ROOT constant so specs will load the environment
+Object.send(:remove_const, :RADIANT_ROOT)
+
+extension_root = File.expand_path(File.dirname(__FILE__))
+
+task :default => :spec
+task :stats => "spec:statsetup"
+
+desc "Run all specs in spec directory"
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.spec_opts = ['--options', "\"#{extension_root}/spec/spec.opts\""]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+namespace :spec do
+  desc "Run all specs in spec directory with RCov"
+  Spec::Rake::SpecTask.new(:rcov) do |t|
+    t.spec_opts = ['--options', "\"#{extension_root}/spec/spec.opts\""]
+    t.spec_files = FileList['spec/**/*_spec.rb']
+    t.rcov = true
+    t.rcov_opts = ['--exclude', 'spec', '--rails']
+  end
+  
+  desc "Print Specdoc for all specs"
+  Spec::Rake::SpecTask.new(:doc) do |t|
+    t.spec_opts = ["--format", "specdoc", "--dry-run"]
+    t.spec_files = FileList['spec/**/*_spec.rb']
+  end
+
+  [:models, :controllers, :views, :helpers].each do |sub|
+    desc "Run the specs under spec/#{sub}"
+    Spec::Rake::SpecTask.new(sub) do |t|
+      t.spec_opts = ['--options', "\"#{extension_root}/spec/spec.opts\""]
+      t.spec_files = FileList["spec/#{sub}/**/*_spec.rb"]
+    end
+  end
+  
+  # Hopefully no one has written their extensions in pre-0.9 style
+  # desc "Translate specs from pre-0.9 to 0.9 style"
+  # task :translate do
+  #   translator = ::Spec::Translator.new
+  #   dir = RAILS_ROOT + '/spec'
+  #   translator.translate(dir, dir)
+  # end
+
+  # Setup specs for stats
+  task :statsetup do
+    require 'code_statistics'
+    ::STATS_DIRECTORIES << %w(Model\ specs spec/models)
+    ::STATS_DIRECTORIES << %w(View\ specs spec/views)
+    ::STATS_DIRECTORIES << %w(Controller\ specs spec/controllers)
+    ::STATS_DIRECTORIES << %w(Helper\ specs spec/views)
+    ::CodeStatistics::TEST_TYPES << "Model specs"
+    ::CodeStatistics::TEST_TYPES << "View specs"
+    ::CodeStatistics::TEST_TYPES << "Controller specs"
+    ::CodeStatistics::TEST_TYPES << "Helper specs"
+    ::STATS_DIRECTORIES.delete_if {|a| a[0] =~ /test/}
+  end
+
+  namespace :db do
+    namespace :fixtures do
+      desc "Load fixtures (from spec/fixtures) into the current environment's database.  Load specific fixtures using FIXTURES=x,y"
+      task :load => :environment do
+        require 'active_record/fixtures'
+        ActiveRecord::Base.establish_connection(RAILS_ENV.to_sym)
+        (ENV['FIXTURES'] ? ENV['FIXTURES'].split(/,/) : Dir.glob(File.join(RAILS_ROOT, 'spec', 'fixtures', '*.{yml,csv}'))).each do |fixture_file|
+          Fixtures.create_fixtures('spec/fixtures', File.basename(fixture_file, '.*'))
+        end
+      end
+    end
+  end
+end
+
+desc 'Generate documentation for the templates extension.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'TemplatesExtension'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+# For extensions that are in transition
+desc 'Test the templates extension.'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = true
+end
+
+# Load any custom rakefiles for extension
+Dir[File.dirname(__FILE__) + '/tasks/*.rake'].sort.each { |f| require f }

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/app/controllers/admin/part_types_controller.rb

@@ -0,0 +1,8 @@
+class Admin::PartTypesController < Admin::ResourceController
+
+  only_allow_access_to :index, :show, :new, :edit, :create, :update, :remove, :destroy,
+    :when => [:admin],
+    :denied_url => { :controller => 'admin/pages', :action => 'index' },
+    :denied_message => 'You must have admin privileges to perform this action.'
+
+end

data/app/controllers/admin/templates_controller.rb

@@ -0,0 +1,38 @@
+class Admin::TemplatesController < ApplicationController
+
+  only_allow_access_to :index, :show, :new, :create, :edit, :update, :remove, :destroy, :move_higher, :move_lower, :move_to_top, :move_to_bottom,
+    :when => [:designer, :admin],
+    :denied_url => { :controller => 'admin/pages', :action => 'index' },
+    :denied_message => 'You must have designer privileges to perform this action.'
+
+  make_resourceful do
+    actions :index, :show, :new, :create, :edit, :update, :remove, :destroy
+
+    response_for(:show) do
+      redirect_to edit_admin_template_url
+    end
+
+    response_for(:create, :update) do
+      redirect_to params[:continue] ? edit_admin_template_url(current_object) : objects_path
+    end
+
+    response_for(:destroy, :destroy_fails) do
+      redirect_to objects_path
+    end
+  end
+
+  # Ordering actions
+  %w{move_higher move_lower move_to_top move_to_bottom}.each do |action|
+    define_method action do
+      load_object
+      Template.reordering do
+        current_object.send(action)
+      end
+      request.env["HTTP_REFERER"] ? redirect_to(:back) : redirect_to(objects_path)
+    end
+  end
+
+  def instance_variable_name
+    'content_templates'
+  end
+end

data/app/helpers/admin/part_types_helper.rb

@@ -0,0 +1,26 @@
+module Admin::PartTypesHelper
+
+  def updated_stamp(model)
+    unless model.new_record?
+      updated_by = (model.updated_by || model.created_by) if model.respond_to?(:updated_by)
+      login = updated_by ? updated_by.login : nil
+      time = (model.updated_at || model.created_at)
+      # promoted_at = model.draft_promoted_at if model.respond_to?(:draft_promoted_at)
+      html = %{<p style="clear: left"><small>}
+      if login or time
+        html << 'Last updated ' 
+        html << %{by #{login} } if login
+        html << %{at #{ timestamp(time) }} if time
+        html << '. '
+      end
+      # if promoted_at
+      #   html << %{Last promoted at #{ timestamp(promoted_at) }.}
+      # end
+      html << %{</small></p>}
+      html
+    else
+      %{<p class="clear">&nbsp;</p>}
+    end
+  end
+
+end

data/app/helpers/admin/templates_helper.rb

@@ -0,0 +1,108 @@
+module Admin::TemplatesHelper
+  
+  def template_edit_javascripts
+    <<-JS
+      var template_parts_index = 0;
+      var template_part_partial = new Template(#{blank_template_part});
+      function new_template_part(){
+        var parts = $('parts');
+        if(parts.down('.template_part')){
+          var id = parts.select('.template_part').last().id;
+          template_parts_index = parseInt(id.split("_").last());
+        }
+        template_parts_index += 1;
+        new Insertion.Bottom('parts', template_part_partial.evaluate({index: template_parts_index}));
+      }
+      
+      function zeroPad(num,count){
+        var numZeropad = num + '';
+        while(numZeropad.length < count) {
+          numZeropad = "0" + numZeropad;
+        }
+        return numZeropad;
+      }
+      
+      function fix_template_part_indexes(){
+        var parts = $('parts');
+        var new_index = 0;
+        parts.select(".template_part").each(function(row){
+          new_index += 1;
+          row.select("input, select, textarea").each(function(input){
+            input.name = input.name.sub(/\\d+/, zeroPad(new_index,2));
+          });
+        });
+      }
+      
+      function reorder_template_part(element, direction){
+        var parts = $('parts');
+        var template_part = $(element).up('.template_part');
+        switch(direction){
+          case 'up':
+            if(template_part.previous())
+              template_part.previous().insert({ before: template_part });
+            break;
+          case 'down':
+            if(template_part.next())
+              template_part.next().insert({ after: template_part });
+            break;
+          case 'top':
+            parts.insert({ top: template_part });
+            break;
+          case 'bottom':
+            parts.insert({ bottom: template_part });
+            break;
+          default:
+            break;
+        }
+        fix_template_part_indexes();
+      }
+    JS
+  end
+  
+  def filter_options
+    [['none', '']] + TextFilter.descendants.map { |f| f.filter_name }.sort
+  end
+  
+  def part_type_options
+    PartType.find(:all, :order => "name ASC").map {|t| [t.name, t.id]}
+  end
+  
+  def blank_template_part
+    ostruct = OpenStruct.new(:index => '#{index}')
+    @blank_template_part ||= (render :partial => "template_part", :object => ostruct).to_json
+  end
+  
+  def order_links(template)
+    returning String.new do |output|
+      %w{move_to_top move_higher move_lower move_to_bottom}.each do |action|
+        output << link_to(image("#{action}.png", :alt => action.humanize), 
+                          url_for(:action => action, :id => template), 
+                          :method => :post)
+      end
+    end
+  end
+
+  def updated_stamp(model)
+    unless model.new_record?
+      updated_by = (model.updated_by || model.created_by) if model.respond_to?(:updated_by)
+      login = updated_by ? updated_by.login : nil
+      time = (model.updated_at || model.created_at)
+      # promoted_at = model.draft_promoted_at if model.respond_to?(:draft_promoted_at)
+      html = %{<p style="clear: left"><small>}
+      if login or time
+        html << 'Last updated '
+        html << %{by #{login} } if login
+        html << %{at #{ timestamp(time) }} if time
+        html << '. '
+      end
+      # if promoted_at
+      #   html << %{Last promoted at #{ timestamp(promoted_at) }.}
+      # end
+      html << %{</small></p>}
+      html
+    else
+      %{<p class="clear">&nbsp;</p>}
+    end
+  end
+
+end