radiant-templates-extension 1.0.0

data/spec/datasets/part_types_dataset.rb

@@ -0,0 +1,15 @@
+class PartTypesDataset < Dataset::Base
+  def load
+    create_part_type "One-line", :field_type => "text_field", :field_class => "text", :field_styles => "width: 500px"
+    create_part_type "Plaintext", :field_type => "text_area", :field_class => "plain"
+    create_part_type "WYSIWYG", :field_type => "text_area", :field_class => "textarea", :field_styles => "width: 100%"
+    create_part_type "Boolean", :field_type => "radio_button"
+    create_part_type "Asset", :field_type => "hidden", :field_class => "asset"
+  end
+  
+  helpers do
+    def create_part_type(name, attributes={})
+      create_model PartType, name.symbolize, attributes.merge(:name => name)
+    end
+  end
+end

data/spec/datasets/templates_dataset.rb

@@ -0,0 +1,34 @@
+class TemplatesDataset < Dataset::Base
+  uses :part_types, :layouts
+  
+  def load
+    create_template "Sample" do
+      create_template_part "Part 1", :part_type_id => part_type_id(:wysiwyg)
+      create_template_part "extended", :part_type_id => part_type_id(:plaintext)
+      create_template_part "featured?", :part_type_id => part_type_id(:boolean)
+      create_template_part "Feature image", :part_type_id => part_type_id(:asset)
+      create_template_part "Tagline", :part_type_id => part_type_id(:one_line)
+    end
+    create_template "Another", :page_class_name => "FileNotFoundPage"
+  end
+  
+  helpers do
+    def create_template(name, attributes={})
+      @current_template = create_model Template, name.symbolize, template_params(attributes.reverse_merge(:name => name))
+      yield if block_given?
+      @current_template = nil
+    end
+    
+    def template_params(attributes={})
+      {
+        :content => "Content for #{attributes[:name]}.",
+        :page_class_name => nil,
+        :layout_id => layout_id(:main),
+      }.merge(attributes.symbolize_keys)
+    end
+    
+    def create_template_part(name, attributes={})
+      create_model TemplatePart, name.symbolize, attributes.reverse_merge(:name => name, :template_id => (@current_template ? @current_template.id : nil))
+    end
+  end
+end

data/spec/helpers/templates_helper_spec.rb

@@ -0,0 +1,56 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Templates::Helper do
+  dataset :pages, :templates
+
+  before :each do
+    @page = pages(:home)
+    helper.instance_variable_set(:@page, @page)
+  end
+
+  describe "template_part_field" do
+    it "should output a text area from a template part with part-type of text_area" do
+      helper.should_receive(:text_area_tag).and_return('text_area')
+      helper.template_part_field(template_parts(:extended), 0).should == 'text_area'
+    end
+
+    it "should output a text field from a template part with part-type of text_field" do
+      helper.should_receive(:text_field_tag).and_return('text_field')
+      helper.template_part_field(template_parts(:tagline), 0).should == 'text_field'
+    end
+
+    it "should output a radio_button field from a template part with part-type of radio_button" do
+      helper.should_receive(:radio_button_tag).twice.and_return('radio_button')
+      helper.template_part_field(template_parts(:featured), 0).should include("radio_button")
+    end
+
+    it "should output a hidden field from a template part with part-type hidden" do
+      helper.should_receive(:hidden_field_tag).and_return('hidden')
+      helper.template_part_field(template_parts(:feature_image), 0).should == 'hidden'
+    end
+
+    it "should determine the field name from the given index" do
+      helper.should_receive(:hidden_field_tag).with("#{helper.page_part_name(1)}[content]", '', :class => 'asset', :id => 'page_parts_1_content')
+      helper.template_part_field(template_parts(:feature_image), 1)
+    end
+
+    it "should put blank content in the field if the part doesn't already exist" do
+      @page.part('Tagline').should be_nil
+      helper.should_receive(:text_field_tag).with("#{helper.page_part_name(1)}[content]", '', :class => 'text', :style => "width: 500px", :id => 'page_parts_1_content')
+      helper.template_part_field(template_parts(:tagline), 1)
+    end
+
+    it "should put content from the existing part in the field" do
+      helper.should_receive(:text_area_tag).with("#{helper.page_part_name(1)}[content]", 'Just a test.', :class => 'plain', :id => 'page_parts_1_content')
+      helper.template_part_field(template_parts(:extended), 1)
+    end
+
+    if defined?(ConcurrentDraftExtension)
+      it "should output the draft content and hidden live content if concurrent_draft is enabled" do
+        helper.should_receive(:hidden_field_tag).with("#{helper.page_part_name(1)}[content]", 'Just a test.', :id => 'page_parts_1_content')
+        helper.should_receive(:text_area_tag).with("#{helper.page_part_name(1)}[draft_content]", '', :class => 'plain', :id => 'page_parts_1_draft_content')
+        helper.template_part_field(template_parts(:extended), 1, true)
+      end
+    end
+  end
+end

data/spec/models/page_extensions_spec.rb

@@ -0,0 +1,9 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Page, "extended with templates" do
+  it "should be associated to its template" do
+    Page.included_modules.should include(Templates::Associations)
+    Page.new.should respond_to(:template)
+    Page.new.should respond_to(:template=)
+  end
+end

data/spec/models/part_type_spec.rb

@@ -0,0 +1,28 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe PartType do
+  before :each do
+    @part_type = PartType.new :name => "Test type", :field_type => 'text_area'
+  end
+
+  it "should require a name" do
+    @part_type.name = nil
+    @part_type.should_not be_valid
+    @part_type.should have(1).error_on(:name)
+  end
+
+  it "should require a valid field type" do
+    @part_type.field_type = 'foobar'
+    @part_type.should_not be_valid
+    @part_type.should have(1).error_on(:field_type)
+  end
+
+  it "should be valid with correct parameters" do
+    @part_type.should be_valid
+  end
+
+  it "should not allow creation of a new part type with a duplicate name" do
+    @new_part_type = PartType.create :name => @part_type.name
+    @new_part_type.id.should be_nil
+  end
+end

data/spec/models/tags_spec.rb

@@ -0,0 +1,44 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe "Templates::Tags" do
+  dataset :pages
+  before :each do
+    @page = pages(:home)
+    @page.parts.build(:name => "False", :content => 'false')
+    @page.parts.build(:name => "True", :content => 'true')
+  end
+  
+  describe "<r:boolean_part>" do
+    it "should expand its contents" do
+      @page.should render('<r:boolean_part>true</r:boolean_part>').as('true')
+    end
+  end
+  
+  describe "<r:boolean_part:if>" do
+    it "should expand its contents if the selected part evaluates to true" do
+      @page.should render('<r:boolean_part:if part="True">yes!</r:boolean_part:if>').as('yes!')
+    end
+    
+    it "should not expand its contents if the selected part does not evaluate to true" do
+      @page.should render('<r:boolean_part:if part="False">yes!</r:boolean_part:if>').as('')
+    end
+    
+    it "should raise an error if the part attribute is missing" do
+      @page.should render('<r:boolean_part:if>yes!</r:boolean_part:if>').with_error("`boolean_part:if' tag requires a 'part' attribute")
+    end
+  end
+  
+  describe "<r:boolean_part:unless>" do
+    it "should not expand its contents if the selected part evaluates to true" do
+      @page.should render('<r:boolean_part:unless part="True">yes!</r:boolean_part:unless>').as('')
+    end
+    
+    it "should expand its contents if the selected part does not evaluate to true" do
+      @page.should render('<r:boolean_part:unless part="False">yes!</r:boolean_part:unless>').as('yes!')
+    end
+    
+    it "should raise an error if the part attribute is missing" do
+      @page.should render('<r:boolean_part:unless>yes!</r:boolean_part:unless>').with_error("`boolean_part:unless' tag requires a 'part' attribute")
+    end
+  end
+end

data/spec/models/template_part_spec.rb

@@ -0,0 +1,37 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe TemplatePart do
+  dataset :part_types
+  
+  before :each do
+    @template_part = TemplatePart.new :template_id => 1, :name => "extended", 
+                                    :filter_id => nil, :part_type_id => 1
+  end
+  
+  it "should be valid with correct parameters" do
+    @template_part.should be_valid
+  end
+  
+  it "should require a name" do
+    @template_part.name = nil
+    @template_part.should_not be_valid
+    @template_part.should have(1).error_on(:name)
+  end
+  
+  it "should require a part type" do
+    @template_part.part_type_id = nil
+    @template_part.should_not be_valid
+    @template_part.should have(1).error_on(:part_type_id)
+  end
+  
+  it "should disallow 'body' for name" do
+    @template_part.name = 'body'
+    @template_part.should_not be_valid
+    @template_part.should have(1).error_on(:name)
+  end
+  
+  it "should assign a part type by name" do
+    @template_part.part_type_name = "Boolean"
+    @template_part.part_type.should == part_types(:boolean)
+  end
+end

data/spec/models/template_spec.rb

@@ -0,0 +1,88 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe ::Template do
+  dataset :templates, :pages
+
+  before :each do
+    @template = Template.new :name => "Article", :layout_id => layout_id(:main)
+  end
+
+  it "should be valid with correct parameters" do
+    @template.should be_valid
+  end
+
+  it "should require a name" do
+    @template.name = nil
+    @template.should_not be_valid
+    @template.should have(1).error_on(:name)
+  end
+
+  it "should require a layout" do
+    @template.layout = nil
+    @template.should_not be_valid
+    @template.should have(1).error_on(:layout_id)
+  end
+
+  it "should require a valid or empty page class name" do
+    @template.page_class_name = nil
+    @template.should be_valid
+
+    @template.page_class_name = "blah"
+    @template.should_not be_valid
+
+    @template.page_class_name = "FileNotFoundPage"
+    @template.should be_valid
+  end
+
+  it "should create template parts from a hash" do
+    @template.template_parts = {'1' => {:name => "extended", :filter_id => nil, :part_type_id => 1}, '2' => {:name => "more", :filter_id => "Textile", :part_type_id => 3}}
+    @template.should be_valid
+    @template.should have(2).template_parts
+  end
+
+  describe "updating associated pages after update" do
+    before :each do
+      @template = templates(:sample)
+      @page = pages(:home)
+      @template.should_receive(:pages).and_return([@page])
+      @template.update_attributes!(:layout_id => layout_id(:utf8), :page_class_name => "FileNotFoundPage")
+      @page.reload
+      @page.parts.reload
+    end
+
+    it "should update the layout" do
+      @page.layout_id.should == layout_id(:utf8)
+    end
+
+    it "should delete page parts that do not match the template parts" do
+      @page.part(:sidebar).should be_nil
+      @page.part(:titles).should be_nil
+    end
+
+    it "should update the class name" do
+      @page.class_name.should == 'FileNotFoundPage'
+    end
+
+    it "should update the content of the body part" do
+      @page.part(:body).content.should == 'Content for Sample.'
+    end
+    
+    if defined?(ConcurrentDraftExtension)
+      it "should update the draft_content of the body part" do
+        @page.part(:body).draft_content.should == 'Content for Sample.'
+      end
+    end
+  end
+
+  it "should return templates in default order by position" do
+    Template.find(:all, :order => :position).should == Template.find(:all)
+  end
+
+  it "should not update associated pages when reordering" do
+    @template = templates(:sample)
+    Template.reordering do
+      @template.should_not_receive(:pages)
+      @template.move_to_bottom
+    end
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,6 @@
+--colour
+--format
+progress
+--loadby
+mtime
+--reverse

data/spec/spec_helper.rb

@@ -0,0 +1,39 @@
+unless defined? RADIANT_ROOT
+  ENV["RAILS_ENV"] = "test"
+  case
+  when ENV["RADIANT_ENV_FILE"]
+    require ENV["RADIANT_ENV_FILE"]
+  when File.dirname(__FILE__) =~ %r{vendor/radiant/vendor/extensions}
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../../../../")}/config/environment"
+  else
+    require "#{File.expand_path(File.dirname(__FILE__) + "/../../../../")}/config/environment"
+  end
+end
+require "#{RADIANT_ROOT}/spec/spec_helper"
+
+# if File.directory?(File.dirname(__FILE__) + "/scenarios")
+#   Scenario.load_paths.unshift File.dirname(__FILE__) + "/scenarios"
+# end
+Dataset::Resolver.default << (File.dirname(__FILE__) + "/datasets")
+
+if File.directory?(File.dirname(__FILE__) + "/matchers")
+  Dir[File.dirname(__FILE__) + "/matchers/*.rb"].each {|file| require file }
+end
+
+Spec::Runner.configure do |config|
+  # config.use_transactional_fixtures = true
+  # config.use_instantiated_fixtures  = false
+  # config.fixture_path = RAILS_ROOT + '/spec/fixtures'
+
+  # You can declare fixtures for each behaviour like this:
+  #   describe "...." do
+  #     fixtures :table_a, :table_b
+  #
+  # Alternatively, if you prefer to declare them only once, you can
+  # do so here, like so ...
+  #
+  #   config.global_fixtures = :table_a, :table_b
+  #
+  # If you declare global fixtures, be aware that they will be declared
+  # for all of your examples, even those that don't use them.
+end

data/templates_extension.rb

@@ -0,0 +1,83 @@
+# Uncomment this if you reference any of your controllers in activate
+require_dependency 'application_controller'
+
+class TemplatesExtension < Radiant::Extension
+  version "#{File.read(File.expand_path(File.dirname(__FILE__)) + '/VERSION')}"
+  description "Imposes structure on pages via content templates"
+  url "https://github.com/avonderluft/radiant-templates-extension/tree/master"
+
+  def activate
+    begin
+      FileSystem::MODELS << "PartType" << "Template"
+    rescue NameError, LoadError
+    end
+    Page.class_eval do
+      include Templates::Associations
+      include Templates::Tags
+      include Templates::PageExtensions
+    end
+    Admin::PagesController.class_eval do
+      include Templates::ControllerExtensions 
+      helper Templates::Helper
+    end
+    tab "Design" do
+      add_item "Templates", "/admin/templates", :before => "Layouts"
+      add_item "Template Part Types", "/admin/part_types", :after => "Templates"
+    end
+    # Admin UI customization
+    admin.page.index.add :node, 'template_column', :after => 'title_column'
+    admin.page.index.add :sitemap_head, 'template_column_header', :after => 'title_column_header'
+    admin.page.edit.add :extended_metadata, 'switch_templates', :after => 'breadcrumb'
+    admin.page.edit.add :form, 'edit_template', :before => 'edit_page_parts'
+    admin.page.edit.form.delete 'edit_page_parts'
+    admin.page.edit.parts_bottom.delete 'edit_layout_and_type'
+
+    Radiant::AdminUI.class_eval do
+      attr_accessor :template
+      attr_accessor :part_type
+      alias_method "templates", :template
+      alias_method "part_types", :part_type
+    end
+    admin.template = load_default_template_regions
+    admin.part_type = load_default_part_type_regions
+  end
+
+  def load_default_template_regions
+    returning OpenStruct.new do |template|
+      template.edit = Radiant::AdminUI::RegionSet.new do |edit|
+        edit.main.concat %w{edit_header edit_form}
+        edit.form.concat %w{edit_title edit_content}
+        edit.layout.concat %w{edit_layout edit_type}
+        edit.form_bottom.concat %w{edit_buttons edit_timestamp}
+        edit.bottom.concat %w{parts_button}
+      end
+      template.index = Radiant::AdminUI::RegionSet.new do |index|
+        index.top.concat %w{}
+        index.thead.concat %w{title_header parts_header actions_header order_header}
+        index.tbody.concat %w{title_cell parts_cell actions_cell order_cell}
+        index.bottom.concat %w{new_button}
+      end
+      template.new = template.edit
+    end
+  end
+
+  def load_default_part_type_regions
+    returning OpenStruct.new do |part_type|
+      part_type.edit = Radiant::AdminUI::RegionSet.new do |edit|
+        edit.main.concat %w{edit_header edit_form}
+        edit.form.concat %w{edit_title edit_content}
+        edit.layout.concat %w{edit_layout edit_type}
+        edit.form_bottom.concat %w{edit_buttons edit_timestamp}
+        edit.bottom.concat %w{parts_button}
+      end
+      part_type.index = Radiant::AdminUI::RegionSet.new do |index|
+        index.top.concat %w{}
+        index.thead.concat %w{title_header type_header class_header styles_header actions_header}
+        index.tbody.concat %w{title_cell type_cell class_cell styles_cell actions_cell}
+        index.bottom.concat %w{new_button}
+      end
+      part_type.new = part_type.edit
+    end
+  end
+
+end