radiant-layouts-extension 0.9.1

data/lib/share_layouts/radiant_layouts.rb

@@ -0,0 +1,21 @@
+module ShareLayouts::RadiantLayouts
+  
+  def self.included(base)
+    base.extend ClassMethods
+  end
+  
+  module ClassMethods
+    def radiant_layout(name=nil, options={}, &block)
+      raise ArgumentError, "A layout name or block is required!" unless name || block
+      write_inheritable_attribute 'radiant_layout', name || block
+      before_filter :set_radiant_layout
+      layout 'radiant', options
+    end
+  end
+  
+  def set_radiant_layout
+    @radiant_layout = self.class.read_inheritable_attribute 'radiant_layout'
+    @radiant_layout = @radiant_layout.call(self) if @radiant_layout.is_a? Proc
+  end
+  
+end

data/lib/tasks/layouts_extension_tasks.rake

@@ -0,0 +1,34 @@
+namespace :radiant do
+  namespace :extensions do
+    namespace :layouts do
+      
+      desc "Runs the migration of the Shop Products extension and its dependancies"
+      task :migrate => :environment do
+        puts "radiant:layouts:migrate - Nohing to do"
+      end
+      
+      desc "Copies public assets of the Shop Products to the instance public/ directory."
+      task :update => :environment do
+        puts "radiant:layouts:update - Nohing to do"
+      end
+      
+      desc "Syncs all available translations for this ext to the English ext master"
+      task :sync => :environment do
+        # The main translation root, basically where English is kept
+        language_root = LayoutsExtension.root + "/config/locales"
+        words = TranslationSupport.get_translation_keys(language_root)
+        
+        Dir["#{language_root}/*.yml"].each do |filename|
+          next if filename.match('_available_tags')
+          basename = File.basename(filename, '.yml')
+          puts "Syncing #{basename}"
+          (comments, other) = TranslationSupport.read_file(filename, basename)
+          words.each { |k,v| other[k] ||= words[k] }  # Initializing hash variable as empty if it does not exist
+          other.delete_if { |k,v| !words[k] }         # Remove if not defined in en.yml
+          TranslationSupport.write_file(filename, basename, comments, other)
+        end
+      end
+      
+    end
+  end
+end

data/radiant-layouts-extension.gemspec

@@ -0,0 +1,94 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{radiant-layouts-extension}
+  s.version = "0.9.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Dirk Kelly"]
+  s.date = %q{2010-08-30}
+  s.description = %q{Provides extensions to standard layouts, including nesting of layouts within each other and sharing radiant layouts with rails controllers}
+  s.email = %q{dk@squaretalent.com}
+  s.extra_rdoc_files = [
+    "README.md"
+  ]
+  s.files = [
+    ".gitignore",
+     "MIT-LICENSE",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "app/models/rails_page.rb",
+     "app/views/layouts/radiant.html.haml",
+     "layouts_extension.rb",
+     "lib/nested_layouts.rb",
+     "lib/nested_layouts/tags.rb",
+     "lib/share_layouts.rb",
+     "lib/share_layouts/helper.rb",
+     "lib/share_layouts/radiant_layouts.rb",
+     "lib/tasks/layouts_extension_tasks.rake",
+     "radiant-layouts-extension.gemspec",
+     "spec/controllers/nested_layouts_spec.rb",
+     "spec/controllers/share_layouts_spec.rb",
+     "spec/datasets/nested_layouts_dataset.rb",
+     "spec/datasets/share_layouts_dataset.rb",
+     "spec/helpers/share_layouts_helper_spec.rb",
+     "spec/lib/nested_layouts/tags_spec.rb",
+     "spec/lib/share_layouts_extension_spec.rb",
+     "spec/models/rails_page_spec.rb",
+     "spec/rcov.opts",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/squaretalent/radiant-layouts-extension}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Provides extensions to standard layouts, including nesting and sharing}
+  s.test_files = [
+    "spec/controllers/nested_layouts_spec.rb",
+     "spec/controllers/share_layouts_spec.rb",
+     "spec/datasets/nested_layouts_dataset.rb",
+     "spec/datasets/share_layouts_dataset.rb",
+     "spec/helpers/share_layouts_helper_spec.rb",
+     "spec/lib/nested_layouts/tags_spec.rb",
+     "spec/lib/share_layouts_extension_spec.rb",
+     "spec/models/rails_page_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.3.0"])
+      s.add_development_dependency(%q<rspec-rails>, [">= 1.3.2"])
+      s.add_development_dependency(%q<cucumber>, [">= 0.8.5"])
+      s.add_development_dependency(%q<cucumber-rails>, [">= 0.3.2"])
+      s.add_development_dependency(%q<database_cleaner>, [">= 0.4.3"])
+      s.add_development_dependency(%q<ruby-debug>, [">= 0.10.3"])
+      s.add_development_dependency(%q<webrat>, [">= 0.10.3"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.3.0"])
+      s.add_dependency(%q<rspec-rails>, [">= 1.3.2"])
+      s.add_dependency(%q<cucumber>, [">= 0.8.5"])
+      s.add_dependency(%q<cucumber-rails>, [">= 0.3.2"])
+      s.add_dependency(%q<database_cleaner>, [">= 0.4.3"])
+      s.add_dependency(%q<ruby-debug>, [">= 0.10.3"])
+      s.add_dependency(%q<webrat>, [">= 0.10.3"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.3.0"])
+    s.add_dependency(%q<rspec-rails>, [">= 1.3.2"])
+    s.add_dependency(%q<cucumber>, [">= 0.8.5"])
+    s.add_dependency(%q<cucumber-rails>, [">= 0.3.2"])
+    s.add_dependency(%q<database_cleaner>, [">= 0.4.3"])
+    s.add_dependency(%q<ruby-debug>, [">= 0.10.3"])
+    s.add_dependency(%q<webrat>, [">= 0.10.3"])
+  end
+end
+

data/spec/controllers/nested_layouts_spec.rb

@@ -0,0 +1,45 @@
+require 'spec/spec_helper'
+
+class ControllerWithRadiantLayout < ApplicationController
+  radiant_layout 'main'
+end
+
+class ControllerWithRadiantLayoutBlock < ApplicationController
+  radiant_layout {|c| c.action_name == "index" ? "main" : "utf8"}
+end
+  
+describe ControllerWithRadiantLayout do  
+  dataset :layouts
+  
+  before(:each) do
+    #layouts(:radiant)
+    layouts(:main)
+  end
+    
+  it "should have radiant layout attribute" do
+    ControllerWithRadiantLayout.read_inheritable_attribute('radiant_layout').should == 'main'
+    # This doesn't seem to work anymore, but calling "active_layout" on an instance still correctly returns "layouts/radiant.rhtml"
+    #ControllerWithRadiantLayout.read_inheritable_attribute('layout').should == 'radiant'
+  end
+  
+  it "should return 'radiant' when read_inheritable_attribute('layout') is called"
+  
+end
+  
+describe ControllerWithRadiantLayoutBlock do  
+  dataset :layouts
+  
+  before(:each) do
+    layouts(:main)
+  end
+  
+  it "should have radiant layout block" do
+    ControllerWithRadiantLayoutBlock.read_inheritable_attribute('radiant_layout').should be_kind_of(Proc)
+    # This doesn't seem to work anymore, but calling "active_layout" on an instance still correctly returns "layouts/radiant.rhtml"
+    #ControllerWithRadiantLayoutBlock.read_inheritable_attribute('layout').should == 'radiant'
+  end
+  
+  it "should return 'radiant' when read_inheritable_attribute('layout') is called"
+  
+end
+

data/spec/controllers/share_layouts_spec.rb

@@ -0,0 +1,119 @@
+require 'spec/spec_helper'
+
+module TestShareLayoutsTags
+  include Radiant::Taggable
+
+  desc 'some tag'
+  tag 'test_has_request' do |tag|
+    tag.locals.page.request.class
+  end
+
+  desc 'some tag'
+  tag 'test_has_response' do |tag|
+    tag.locals.page.response.class
+  end
+
+end
+
+Page.send(:include, TestShareLayoutsTags)
+
+class ShareController < ApplicationController
+  radiant_layout 'Default'
+  
+  no_login_required
+
+  def normal_erb_in_radiant_layout
+    @name = 'Chester McTester'
+    render :inline => 'Hello there, <%= @name %>', :layout => true
+  end
+
+  def normal_erb_with_no_layout
+    @name = 'Chester McTester'
+    render :inline => 'Hello there, <%= @name %>', :layout => false
+  end
+
+  def normal_erb_with_different_radiant_layout
+    @radiant_layout = 'Different'
+
+    @name = 'Chester McTester'
+    render :inline => 'Hello there, <%= @name %>', :layout => true
+  end
+
+  def normal_erb_with_different_erb_layout
+    @name = 'Chester McTester'
+    render :inline => 'Hello there, <%= @name %>', :layout => 'application'
+  end
+
+  def with_request_layout
+    @radiant_layout = 'Test Request'
+
+    render :inline => '', :layout => true
+  end
+
+  def with_response_layout
+    @radiant_layout = 'Test Response'
+
+    render :inline => '', :layout => true
+  end
+end
+
+describe ShareController do
+  dataset :layouts
+
+  before(:each) do
+    @controller = ShareController.new
+    @request = ActionController::TestRequest.new
+    @response = ActionController::TestResponse.new
+
+    @erb_content = "Hello there, Chester McTester"
+
+    layout = "Content: <r:content />"
+    Layout.create!(:name => 'Default', :content => layout)
+
+    layout = "Different: <r:content />"
+    Layout.create!(:name => 'Different', :content => layout)
+
+    layout = "Request: <r:test_has_request />\nContent: <r:content />"
+    Layout.create!(:name => 'Test Request', :content => layout)
+
+    layout = "Response: <r:test_has_response />\nContent: <r:content />"
+    Layout.create!(:name => 'Test Response', :content => layout)
+  end
+
+  it "should render normal erb in radiant layout" do
+    get :normal_erb_in_radiant_layout
+    response.should be_success
+    @response.body.strip.should == "Content: #{@erb_content}"
+  end
+
+  it "should normal_erb_with_no_layout" do
+    get :normal_erb_with_no_layout
+    response.should be_success
+    @response.body.strip.should == @erb_content
+  end
+
+  it "should normal_erb_with_different_radiant_layout" do
+    get :normal_erb_with_different_radiant_layout
+    response.should be_success
+    @response.body.strip.should == "Different: #{@erb_content}"
+  end
+
+  it "should normal_erb_with_different_erb_layout" do
+    get :normal_erb_with_different_erb_layout
+    response.should be_success
+    @response.body.should =~ /#{@erb_content}/
+  end
+
+  it "should should_assign_request" do
+    get :with_request_layout
+    response.should be_success
+    @response.body.should =~ /Request: .*Request$/
+  end
+
+  it "should should_assign_response" do
+    get :with_response_layout
+    response.should be_success
+    @response.body.should =~ /Response: .*Response$/
+  end
+
+end

data/spec/datasets/nested_layouts_dataset.rb

@@ -0,0 +1,38 @@
+class NestedLayoutsDataset < Dataset::Base
+  def load
+    create_record :layout, :parent, 
+      :name       => 'parent',
+      :content    => <<-CONTENT
+<html>
+  <body class="<r:layout />">
+    <r:content_for_layout />
+  </body>
+</html>
+CONTENT
+    
+    create_record :layout, :child,
+      :name       => 'child',
+      :content    => <<-CONTENT
+<r:inside_layout name='parent'>
+  <h1>child</h1>
+</r:inside_layout>
+CONTENT
+    
+    create_record :page, :parent_layout,
+      :title      => 'child layout',
+      :layout_id  => layouts(:parent).id,
+      :breadcrumb => 'Homepage',
+      :slug => '/',
+      :status_id => 100,
+      :published_at => '2008-01-01 08:00:00'
+    
+    create_record :page, :child_layout,
+      :title      => 'child layout',
+      :layout_id  => layouts(:child).id,
+      :breadcrumb => 'Homepage',
+      :slug => '/',
+      :status_id => 100,
+      :published_at => '2008-01-01 08:00:00'
+    
+  end
+end

data/spec/datasets/share_layouts_dataset.rb

@@ -0,0 +1,38 @@
+class ShareLayoutsDataset < Dataset::Base
+  def load
+    create_record :page, :homepage, :id => 1, 
+      :title => 'Homepage',
+      :breadcrumb => 'Homepage',
+      :slug => '/',
+      :status_id => 100,
+      :published_at => '2008-01-01 08:00:00'
+
+    create_record :page, :rails_page,
+      :id => 2,
+      :title => 'App page',
+      :breadcrumb => 'App page',
+      :slug => 'app',
+      :class_name => 'RailsPage',
+      :status_id => 100,
+      :parent_id => 1,
+      :published_at => '2008-01-01 08:00:00'
+
+    create_record :page, :rails_page_child,
+      :id => 3,
+      :title => 'Child',
+      :breadcrumb => 'Child',
+      :slug => 'child-page',
+      :status_id => 100,
+      :parent_id => 2,
+      :published_at => '2008-01-01 08:00:00'
+
+    create_record :page, :other,
+      :id => 4,
+      :title => 'Other',
+      :breadcrumb => 'Other',
+      :slug => 'other',
+      :status_id => 100,
+      :parent_id => 1,
+      :published_at => '2008-01-01 08:00:00'
+  end
+end

data/spec/helpers/share_layouts_helper_spec.rb

@@ -0,0 +1,168 @@
+require 'spec/spec_helper'
+
+describe ShareLayouts::Helper do
+  include ShareLayouts::Helper
+  dataset :layouts, :pages, :share_layouts
+  test_helper :page
+  attr_accessor :request, :response
+  
+MAIN_RESULT = <<-TEXT
+<html>
+  <head>
+    <title>My Title</title>
+  </head>
+  <body>
+    something
+  </body>
+</html>
+TEXT
+
+  before(:each) do
+    @page = RailsPage.new(page_params(:class_name => "RailsPage"))
+    @content_for_layout = "something"
+    @radiant_layout = layouts(:main).name
+    @request = OpenStruct.new(:path => "/some/page/")
+  end
+  
+  it "should extract_content_captures_as_hash" do
+    extract_captures.should == {:body => "something"}
+    @content_for_sidebar = "sidebar"
+    extract_captures.should == {:body => "something", :sidebar => "sidebar"}
+  end
+  
+  # testing assignment of layout
+  it "should assign_layout_of_page" do
+    assign_attributes!(@page)
+    @page.layout.should == layouts(:main)
+  end
+  
+  it "should assign_layout_of_page_when_missing" do
+    previous_layout = @page.layout
+    @radiant_layout = ''
+    assign_attributes!(@page)
+    previous_layout.should == @page.layout
+  end
+  
+  # testing assignment of page.title
+  it "should assign_page_title_from_instance_var" do
+    @title = "My title"
+    assign_attributes!(@page)
+    @page.title.should == "My title"
+  end
+  
+  it "should assign_page_title_from_capture" do
+    @content_for_title = "My title"
+    assign_attributes!(@page)
+    @page.title.should == "My title"
+  end
+  
+  it "should assign_title_from_existing_page_title_when_not_specified" do
+    assign_attributes!(@page)
+    @page.title.should =~ /Page \d+$/ # was 'New Page' before. I assume this changed in Radiant 0.8
+  end
+
+  it "should assign_empty_title_if_missing" do
+    @page.title = nil
+    @title.should be_nil
+    @content_for_title.should be_nil
+    @page.title.should be_nil
+    assign_attributes!(@page)
+    @page.title.should == ''
+  end
+  
+  #testing assignment of page.breadcrumb
+  it "should assign_page_breadcrumb_from_instance_var" do
+    @breadcrumb = "My breadcrumb"
+    assign_attributes!(@page)
+    @page.breadcrumb.should == "My breadcrumb"
+  end
+  
+  it "should assign_page_breadcrumb_from_capture" do
+    @content_for_breadcrumb = "My breadcrumb"
+    assign_attributes!(@page)
+    @page.breadcrumb.should == "My breadcrumb"
+  end
+  
+  it "should assign_breadcrumb_from_existing_breadcrumb_when_not_specified" do
+    @page.breadcrumb = "existing breadcrumb"
+    assign_attributes!(@page)
+    @page.breadcrumb.should == 'existing breadcrumb'
+  end
+
+  it "should assign_breadcrumb_from_title_if_missing" do
+    @page.title = "Title into BC"
+    @page.breadcrumb = nil
+    @breadcrumb.should be_nil
+    @content_for_breadcrumb.should be_nil
+    @page.breadcrumb.should be_nil
+    assign_attributes!(@page)
+    @page.breadcrumb.should == 'Title into BC'
+  end
+  
+  it "should assign_empty_breadcrumb_if_title_missing_too" do
+    @page.title = nil
+    @title.should be_nil
+    @content_for_title.should be_nil
+    @page.title.should be_nil
+    @page.breadcrumb = nil
+    @breadcrumb.should be_nil
+    @content_for_breadcrumb.should be_nil
+    @page.breadcrumb.should be_nil
+    assign_attributes!(@page)
+    @page.breadcrumb.should == ''
+  end
+  
+  # testing assignment of page.breadcrumbs
+  it "should assign_breadcrumbs_from_instance_var" do
+    @breadcrumbs = "bc"
+    assign_attributes!(@page)
+    @page.breadcrumbs.should == 'bc'
+  end    
+  
+  it "should assign_breadcrumbs_from_capture" do
+    @content_for_breadcrumbs = "bc"
+    assign_attributes!(@page)
+    @page.breadcrumbs.should == 'bc'
+  end    
+
+  it "should leave_breadcrumbs_nil_if_missing" do
+    @page.breadcrumbs = nil
+    @breadcrumbs.should be_nil
+    @content_for_breadcrumbs.should be_nil
+    @page.breadcrumbs.should be_nil
+    assign_attributes!(@page)
+    @page.breadcrumbs.should be_nil
+  end
+
+  # testing assigment of page.url
+  it "should assign_url_from_request_path" do
+    assign_attributes!(@page)
+    @page.url.should == '/some/page/'
+  end
+  
+  # testing assigment of page.slug
+  it "should assign_slug_from_request_path" do
+    assign_attributes!(@page)
+    @page.slug.should == 'page'
+  end
+  
+  # testing assignment of page.published_at
+  it "should assign_published_at" do
+    assign_attributes!(@page)
+    @page.published_at.should_not be_nil
+  end
+  
+  it "should render_page" do
+    @title = "My Title"
+    radiant_layout.strip.should == MAIN_RESULT.strip
+  end
+  
+  it "should find_page" do
+    @request.path = "/app/something/"
+    find_page.should == pages(:rails_page)
+    find_page.should be_a_kind_of(RailsPage)
+    @request.path = "/some-other/url/"
+    find_page.should_not == pages(:rails_page)
+    find_page.should be_a_kind_of(RailsPage)
+  end
+end