radiant-layouts-extension 0.9.1 → 1.0.0

data/MIT-LICENSE

@@ -1,9 +1,16 @@
-http://github.com/moklett/radiant-nested-layouts-extension/
+# Layouts Extension
 
-The following licence applies to the files:
-lib/nested_layouts.rb
-lib/nested_layouts/tags.rb
+Is a collaboration of many parties that solves some common shortcomings with standard Radiant layouts
 
+http://github.com/squaretalent/radiant-layouts-extension/
+
+## Nested Layouts
+
+    lib/nested_layouts/core.rb
+    
+    spec/lib/nested_layouts/nested_layouts_extension_spec.rb
+    spec/lib/nested_layouts/tags/core_spec.rb
+    
 == MIT License
 
 Copyright (c) 2008 Michael O. Klett.
@@ -18,6 +25,70 @@ furnished to do so, subject to the following conditions:
 The above copyright notice and this permission notice shall be included in all
 copies or substantial portions of the Software.
 
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+## Shared Layouts
+
+    lib/share_layouts/controllers/action_controller.rb
+    lib/share_layouts/helpers/action_view.rb
+    app/models/rails_page/action_view.rb
+    
+    spec/controllers/share_controller_spec.rb
+    spec/lib/share_layouts/share_layouts_extension_spec.rb
+    spec/lib/share_layouts/controllers/action_controller_spec.rb
+    spec/lib/share_layouts/helpers/action_view_spec.rb
+
+== MIT Licence
+
+Copyright (c) 2010 Radiant - Jim Gay, William Ross
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+## HAML Layouts
+
+    lib/haml_layouts/models/layout.rb
+    lib/haml_layouts/models/page.rb
+    
+    spec/lib/haml_layouts/haml_layouts_extension_spec.rb
+    spec/lib/haml_layouts/models/layout_spec.rb
+    spec/lib/haml_layouts/models/layout_spec.rb
+
+== MIT Licence
+
+Copyright (c) 2010 The Frontier Group Pty. Ltd - Dirk Kelly, Tony Issakov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

data/README.md

@@ -78,4 +78,51 @@ This would render the following if Page Layout was called
 ### Acknowledgments
 
 * Merged into radiant-layouts-extension, Dirk Kelly, August 2010
-* Original Source: http://github.com/moklett/radiant-nested-layouts-extension
+* Original Source: http://github.com/moklett/radiant-nested-layouts-extension
+
+## Haml Layouts
+
+[http://haml-lang.com/](http://haml-lang.com/)
+
+### Introduction
+
+Write your layouts and radius tags in haml, with support for nested layouts
+
+    // Parent Layout
+    %div{:id=>"parent"}
+      %r:content_for_layout
+      
+    // Child Layout
+    %r:inside_layout{:name=>"Parent"}
+      %h2
+        %:title
+        
+Note: Within Layouts you must set the content type to `haml` or the Layout name to end in `.haml`
+        
+Integrates the work of [SaturnFlyer](http://github.com/saturnflyer) creating a haml_filter on pages and snippets. Additional task involved
+changing the order which objects with this type are renders. The content is turned into html before the 
+radius tags are passed.
+
+### Caveats 
+
+You can't yet put a radiant tag inside an attribute of a haml element. ie:
+
+    %div.product{:id=>"<r:id />"} // Will not work
+    
+    %div.product{:id=>"%r:id"} // Will not work
+    
+    %div.product{:id=><r:id />} // Will not work
+
+In the mean time use a plain filter whilst we come up with something awesome
+
+    %body
+      #primary
+        :plain
+          <div id="<r:id />" class="product">
+            <r:snippet name='product' />
+
+### Acknowledgments
+
+* [SaturnFlyer](http://github.com/saturnflyer) [@SaturnFlyer](http://twitter.com/saturnflyer) (Jim Gay)  | Original idea http://github.com/saturnflyer/radiant-haml_filter-extension
+* [Tissak](http://github.com/tissak) [@Tissak](http://twitter.com/tissak) (Tony Issakov)  | Insisted that this was possible, and then wrote up an implementation in 10 minutes
+* [DirkKelly](http://github.com/dirkkelly) [@DirkKelly](http://twitter.com/dirkkelly) (Dirk Kelly) | Merged into radiant-layouts-extension and hooked page parse_object to support snippets and content haml radius tags

data/Rakefile

@@ -25,11 +25,11 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "radiant-layouts-extension"
-    gem.summary = %Q{Provides extensions to standard layouts, including nesting and sharing}
-    gem.description = %Q{Provides extensions to standard layouts, including nesting of layouts within each other and sharing radiant layouts with rails controllers}
-    gem.email = "dk@squaretalent.com"
+    gem.summary = %Q{Extends Radiant Layouts to support nesting, sharing with Rails Controllers and rendering HAML}
+    gem.description = %Q{Extends Radiant Layouts to support nesting, sharing with Rails Controllers and rendering HAML}
+    gem.email = "dk@dirkkelly.com"
     gem.homepage = "http://github.com/squaretalent/radiant-layouts-extension"
-    gem.authors = ["Dirk Kelly"]
+    gem.authors = ["Michael Klett", "Jim Gay", "William Ross", "Tony Issakov", "Dirk Kelly"]
     gem.add_development_dependency 'rspec',           '>= 1.3.0'
     gem.add_development_dependency 'rspec-rails',     '>= 1.3.2'
     gem.add_development_dependency 'cucumber',        '>= 0.8.5'
@@ -40,13 +40,35 @@ begin
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+  puts "Jeweler (or a dependency) not available. This is only required if you plan to package layouts as a gem."
 end
 
+# 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'
+require 'cucumber'
+require 'cucumber/rake/task'
 
 # Cleanup the RADIANT_ROOT constant so specs will load the environment
 Object.send(:remove_const, :RADIANT_ROOT)
@@ -62,6 +84,8 @@ Spec::Rake::SpecTask.new(:spec) do |t|
   t.spec_files = FileList['spec/**/*_spec.rb']
 end
 
+task :features => 'spec:integration'
+
 namespace :spec do
   desc "Run all specs in spec directory with RCov"
   Spec::Rake::SpecTask.new(:rcov) do |t|
@@ -70,7 +94,7 @@ namespace :spec do
     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"]
@@ -84,14 +108,14 @@ namespace :spec do
       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
+
+  desc "Run the Cucumber features"
+  Cucumber::Rake::Task.new(:integration) do |t|
+    t.fork = true
+    t.cucumber_opts = ['--format', (ENV['CUCUMBER_FORMAT'] || 'pretty')]
+    # t.feature_pattern = "#{extension_root}/features/**/*.feature"
+    t.profile = "default"
+  end
 
   # Setup specs for stats
   task :statsetup do
@@ -121,5 +145,22 @@ namespace :spec do
   end
 end
 
+desc 'Generate documentation for the layouts extension.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'LayoutsExtension'
+  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 Layout 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

@@ -1 +1 @@
-0.9.1
+1.0.0

data/app/models/haml_filter.rb

@@ -0,0 +1,5 @@
+class HamlFilter < TextFilter
+  def filter(text)
+    Haml::Engine.new(text).render
+  end
+end

data/app/views/layouts/radiant.html.haml

@@ -1 +1 @@
-= radiant_layout
+= radiant_layout

data/config/routes.rb

@@ -0,0 +1,5 @@
+if ENV["RAILS_ENV"] == "test"
+  ActionController::Routing::Routes.draw do |map|
+    map.connect ':controller/:action/:id'
+  end
+end

data/layouts_extension.rb

@@ -2,15 +2,23 @@
 require_dependency 'application_controller'
 
 class LayoutsExtension < Radiant::Extension
-  version "0.3.1"
-  description "Allows Radiant layouts to be used as layouts for standard Rails actions. Includes http://github.com/moklett/radiant-nested-layouts-extension"
+  version "0.4.0"
+  description "A set of useful extensions to standard Layouts."
   url "http://github.com/squaretalent/radiant-layouts-extension"
   
   def activate
+    # Shared Layouts
     RailsPage
-    ActionController::Base.send :include, ShareLayouts::RadiantLayouts
-    ActionView::Base.send :include, ShareLayouts::Helper
-    Page.send :include, NestedLayouts::Tags
+    ActionController::Base.send :include, ShareLayouts::Controllers::ActionController
+    ActionView::Base.send :include, ShareLayouts::Helpers::ActionView
+    
+    # Nested Layouts
+    Page.send   :include, NestedLayouts::Tags::Core
+    
+    # HAML Layouts
+    Layout.send  :include, HamlLayouts::Models::Layout
+    Page.send    :include, HamlLayouts::Models::Page
+    HamlFilter
   end
   
 end

data/lib/haml_layouts/models/layout.rb

@@ -0,0 +1,34 @@
+module HamlLayouts
+  module Models
+    module Layout
+      
+      def self.included(base)
+        base.class_eval do
+          
+          def content
+            if is_haml?
+              Haml::Engine.new(self[:content]).render 
+            else
+              self[:content]
+            end
+          end
+          
+          # Overwrites the standard Radiant Render and pumps out haml if necessary
+          def is_haml?
+            result = false
+            
+            if File.extname(name) == '.haml'
+              result = true
+            elsif content_type == 'haml'
+              result = true
+            end
+            
+            result
+          end
+          
+        end
+      end
+      
+    end
+  end
+end

data/lib/haml_layouts/models/page.rb

@@ -0,0 +1,31 @@
+module HamlLayouts
+  module Models
+    module Page
+      
+      def self.included(base)
+        base.class_eval do
+          
+          def parse_object(object)
+            text = object.content
+            if object.respond_to? :filter_id
+              if object.filter_id === 'Haml'
+                # We want to render the tags as html/radius before passing them
+                text = object.filter.filter(text)
+                text = parse(text)
+              else
+                text = parse(text)
+                text = object.filter.filter(text)
+              end
+            else
+              text = parse(text)
+            end
+            text
+          end
+          
+        end
+      end
+      
+    end
+  end
+end
+

data/lib/nested_layouts/tags/core.rb

@@ -0,0 +1,141 @@
+module NestedLayouts
+  module Tags
+    module Core
+      
+      include Radiant::Taggable
+  
+      class TagError < StandardError; end
+
+      desc %{
+        Renders the contents of the tag inside of a "parent" layout, which is selected via the +name+
+        attribute.  The contents of this tag are placed at a corresponding <r:content_for_layout/> tag
+        within the parent layout.  This tag is intended to be used within your layouts, and should
+        only appear once per layout.
+    
+        *Usage:*
+
+        <r:inside_layout name="master">
+          <div id="main-column">
+            <r:content_for_layout/>
+          </div>
+        </r:inside_layout>
+      }
+      tag 'inside_layout' do |tag|
+        if name = tag.attr['name']
+          # Prepare the stacks
+          tag.globals.nested_layouts_content_stack ||= []
+          tag.globals.nested_layouts_layout_stack ||= []
+
+          # Remember the original layout to support the +layout+ tag
+          tag.globals.page_original_layout ||= tag.globals.page.layout # Remember the original layout
+      
+          # Find the layout
+          name.strip!
+          if layout = Layout.find_by_name(name)
+            # Track this layout on the stack
+            tag.globals.nested_layouts_layout_stack << name
+        
+            # Save contents of inside_layout for later insertion
+            tag.globals.nested_layouts_content_stack << tag.expand
+        
+            # Set the page layout that Radiant should use for rendering, which is different than the actual
+            # page's layout when layouts are nested.  The final/highest +inside_layout+ tag will set or 
+            # overwrite this value for the last time.
+            tag.globals.page.layout = layout
+            tag.globals.page.render
+          else
+            raise TagError.new(%{Error (nested_layouts): Parent layout "#{name.strip}" not found for "inside_layout" tag})
+          end
+        else
+          raise TagError.new(%{Error (nested_layouts): "inside_layout" tag must contain a "name" attribute})
+        end
+      end
+    
+      desc %{
+        Allows nested layouts to target this layout.  The contents of <r:inside_layout> tag blocks in another
+        layout will have their contents inserted at the location given by this tag (if they target this
+        layout).  This tag also behaves like a standard <r:content/> tag if this layout is specified directly
+        by a page.
+      
+        This tag is intended to be used inside layouts.
+      
+        *Usage:*
+      
+        <html>
+          <body>
+            <r:content_for_layout/>
+          </body>
+        </html>
+    
+      }
+      tag 'content_for_layout' do |tag|
+        tag.globals.nested_layouts_content_stack ||= []
+    
+        # return the saved content if any, or mimic a default +<r:content/>+ tag (render the body part)
+        tag.globals.nested_layouts_content_stack.pop || tag.globals.page.render_snippet(tag.locals.page.part('body'))
+      end
+    
+      desc %{
+        Return the layout name of the current page.
+      
+        *Usage:*
+      
+        <html>
+          <body id="<r:layout/>"
+            My body tag has an id corresponding to the layout I use.  Sweet!
+          </body>
+        </html>
+      }
+      tag 'layout' do |tag|
+        current_layout_name(tag)
+      end
+    
+      desc %{ output the contents of tag if layout equals name }
+      tag 'if_layout' do |tag|
+        if name = tag.attr['name']
+          if layout = tag.globals.page_original_layout
+            tag.expand if layout.name == name
+          elsif layout = tag.globals.page.layout
+            tag.expand if layout.name == name
+          end
+        else
+          raise TagError.new(%{Error (nested_layouts): "if_layout" tag must contain a "name" attribute})
+        end
+      end
+    
+      desc %{ output the contents of tag unless layout equals name }
+      tag 'unless_layout' do |tag|
+        if name = tag.attr['name']
+          if layout = tag.globals.page_original_layout
+            tag.expand if layout.name != name
+          elsif layout = tag.globals.page.layout
+            tag.expand if layout.name != name
+          else
+            tag.expand
+          end
+        else
+          raise TagError.new(%{Error (nested_layouts): "if_layout" tag must contain a "name" attribute})
+        end
+      end
+      
+      tag 'body' do  |tag|
+        %{<body class="#{tag.attr['class']} #{current_layout_name(tag)}">#{tag.expand}</body>}
+      end
+      
+      protected
+      
+      def current_layout_name(tag)
+        result = ''
+        
+        if layout = tag.globals.page_original_layout
+          result = layout.name
+        elsif layout = tag.globals.page.layout
+          result = layout.name
+        end
+        
+        result
+      end
+      
+    end
+  end
+end