oasis 0.1.1 → 0.2.0

data/README.rdoc

@@ -1,6 +1,6 @@
 = oasis
 
-Description goes here.
+Oasis is a collection of enhancements that were written by Derek Perez and Chris Eppstein to make the Rails Engines platform work better for micro application design.
 
 == Note on Patches/Pull Requests
  

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0

data/lib/oasis.rb

@@ -1,3 +1,6 @@
 path = File.dirname(__FILE__)
 require "#{path}/oasis/debug"
-require "#{path}/oasis/routes"
+
+# extend the routing system, if its loaded.
+require "#{path}/oasis/routes" if defined? ActionController::Routing
+require "#{path}/oasis/layout" if defined? ActionController::Layout

data/lib/oasis/layout.rb

@@ -0,0 +1,61 @@
+module Oasis
+  # This module makes it easier for developers to centralize
+  # the process they use for defining engine, and engine action
+  # specific layouts. Primarily, this strategy works really nicely
+  # with class/controller re-opening in the master Rails application.
+  module Layout
+    
+    def self.extended(base)
+      base.send :include, InstanceMethods
+    end
+    
+    module InstanceMethods
+      
+      def layouts
+        self.class.read_inheritable_attribute(:layouts)
+      end
+      
+      # this method runs for every action, once #layout_for has been
+      # defined in a controller, once. There are a series of item
+      # types we support, defined below.
+      def compute_oasis_layouts
+        context = layouts[@action_name.to_sym]
+        case 
+          when context.is_a?(String); return context
+          when context.is_a?(Symbol); return send(context)
+          when context.is_a?(FalseClass); return false
+          when context.is_a?(Proc); return context.call(request)
+          else; return layouts[:default]
+        end
+      end
+    end
+    
+    ## CLASS METHODS FOR AC::Base
+    
+    # this is the public api endpoint for controller definitions.
+    # layout_path should be either a String, Symbol, or false.
+    # optionally, you can pass a proc to this method and it will evaluate
+    # as if it were sent a symbol.
+    def layout_for(name, layout_path = nil, &blk)
+      name = name.to_sym
+      write_inheritable_hash(:layouts, :default => predefined_layout) unless predefined_layout == :compute_oasis_layouts
+      context = block_given? ? blk : layout_path
+      write_inheritable_hash(:layouts, name => context)
+      layout(:compute_oasis_layouts)
+    end
+    
+    # simple accessor to the layouts defined by Oasis/#layout_for
+    def layouts
+      self.read_inheritable_attribute(:layouts)
+    end
+    
+    private
+    
+    # checks whether or not a layout has been assigned via the #layout method.
+    def predefined_layout
+      self.read_inheritable_attribute(:layout)
+    end
+  end
+end
+
+ActionController::Base.extend Oasis::Layout

data/lib/oasis/routes.rb

@@ -20,14 +20,16 @@ module Oasis
     def routing_for(name,*args)
       raise ActionController::RoutingError, "#{name} routing collection has already been used once." if Oasis::Routes.apps[name] == false
       raise ActionController::RoutingError, "app: #{name} not registered" unless Oasis::Routes.apps[name]
-      with_options(args.extract_options!, &Oasis::Routes.apps[name])
+      
+      args = args.extract_options!
+      args[:name_prefix] = "#{name}_"
+      
+      with_options(args, &Oasis::Routes.apps[name])
       Oasis::Routes.apps[name] = false
     end
   end
 end
 
 # mixin, and empty the container.
-Oasis::Routes.apps = {} if Oasis::Routes.apps.nil?
-class ActionController::Routing::RouteSet::Mapper  
-  include Oasis::RouteSet
-end
+Oasis::Routes.reset! if Oasis::Routes.apps.nil?
+ActionController::Routing::RouteSet::Mapper.send :include, Oasis::RouteSet

data/oasis.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{oasis}
-  s.version = "0.1.1"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Derek Perez", "Chris Eppstein"]
-  s.date = %q{2009-12-19}
+  s.date = %q{2009-12-21}
   s.description = %q{a collection of enhancements for rails engines. Designed to work with Rails 2.3.}
   s.email = %q{derek@derekperez.com}
   s.extra_rdoc_files = [
@@ -25,9 +25,18 @@ Gem::Specification.new do |s|
      "VERSION",
      "lib/oasis.rb",
      "lib/oasis/debug.rb",
+     "lib/oasis/layout.rb",
      "lib/oasis/routes.rb",
      "oasis.gemspec",
+     "test/fixtures/layout_tests/views/layouts/default_layout.html.erb",
+     "test/fixtures/layout_tests/views/layouts/fancy_products.html.erb",
+     "test/fixtures/layout_tests/views/products/cart.html.erb",
+     "test/fixtures/layout_tests/views/products/on_hold.html.erb",
+     "test/fixtures/layout_tests/views/products/registry.html.erb",
+     "test/fixtures/layout_tests/views/products/supported.html.erb",
+     "test/fixtures/layout_tests/views/products/wish_list.html.erb",
      "test/helper.rb",
+     "test/test_oasis_layouts.rb",
      "test/test_oasis_routing.rb"
   ]
   s.homepage = %q{http://github.com/perezd/oasis}
@@ -37,6 +46,7 @@ Gem::Specification.new do |s|
   s.summary = %q{a collection of enhancements for rails engines.}
   s.test_files = [
     "test/helper.rb",
+     "test/test_oasis_layouts.rb",
      "test/test_oasis_routing.rb"
   ]
 

data/test/fixtures/layout_tests/views/layouts/default_layout.html.erb

@@ -0,0 +1 @@
+default: <%= yield %>

data/test/fixtures/layout_tests/views/layouts/fancy_products.html.erb

@@ -0,0 +1 @@
+Fancy Products: <%= yield %>

data/test/fixtures/layout_tests/views/products/cart.html.erb

@@ -0,0 +1 @@
+my cart.

data/test/fixtures/layout_tests/views/products/on_hold.html.erb

@@ -0,0 +1 @@
+on hold.

data/test/fixtures/layout_tests/views/products/registry.html.erb

@@ -0,0 +1 @@
+my registry.

data/test/fixtures/layout_tests/views/products/supported.html.erb

@@ -0,0 +1 @@
+my supported products.

data/test/fixtures/layout_tests/views/products/wish_list.html.erb

@@ -0,0 +1 @@
+my wish list.

data/test/test_oasis_layouts.rb

@@ -0,0 +1,80 @@
+require 'helper'
+
+## SETUP
+
+# The view_paths array must be set on Base and not LayoutTest so that LayoutTest's inherited
+# method has access to the view_paths array when looking for a layout to automatically assign.
+old_load_paths = ActionController::Base.view_paths
+
+ActionView::Template::register_template_handler :mab,
+  lambda { |template| template.source.inspect }
+
+ActionController::Base.view_paths = [ File.dirname(__FILE__) + '/fixtures/layout_tests/views/' ]
+ActionController::Routing::Routes.draw do |map|
+  map.connect ':controller/:action/:id'
+end
+
+class LayoutTest < ActionController::Base
+  self.view_paths = ActionController::Base.view_paths.dup
+end
+
+# Restore view_paths to previous value
+ActionController::Base.view_paths = old_load_paths
+
+class ProductsController < LayoutTest
+  
+  layout "default_layout"
+  layout_for :cart, "fancy_products"
+  layout_for :supported, :calculate_my_layout
+  layout_for :wish_list, false
+  layout_for :on_hold do |request|
+    "fancy_products"
+  end
+  
+  protected
+  
+  def calculate_my_layout
+    "fancy_products"
+  end
+  
+end
+
+## TEST CASES
+
+class TestOasisLayouts < ActionController::TestCase
+  
+  def setup
+    @request.host = "www.caring.com"
+  end
+  
+  should "define a string based path to a layout file" do
+    @controller = ProductsController.new
+    get :cart
+    assert_equal "layouts/fancy_products", @response.layout
+  end
+  
+  should "remove the layout explicitly" do
+    @controller = ProductsController.new
+    get :wish_list
+    assert_nil @response.layout
+  end
+  
+  should "define layout from method in controller" do
+    @controller = ProductsController.new
+    get :supported
+    assert_equal "layouts/fancy_products", @response.layout
+  end
+  
+  should "define layout from proc" do
+    @controller = ProductsController.new
+    get :on_hold
+    assert_equal "layouts/fancy_products", @response.layout
+  end
+  
+  should "fallback to default layout" do
+    @controller = ProductsController.new
+    get :registry
+    assert_equal "layouts/default_layout", @response.layout
+  end
+  
+end

data/test/test_oasis_routing.rb

@@ -38,6 +38,7 @@ class TestOasisRouting < Test::Unit::TestCase
     
     assert set.recognize_path "/foobar/customers"
     assert set.recognize_path "/foobar/cool-stuff"
+    assert Oasis::Routes.apps[:customers] == false
   end
   
   should "fail if named routing set does not exist" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: oasis
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors: 
 - Derek Perez
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-19 00:00:00 -08:00
+date: 2009-12-21 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -41,9 +41,18 @@ files:
 - VERSION
 - lib/oasis.rb
 - lib/oasis/debug.rb
+- lib/oasis/layout.rb
 - lib/oasis/routes.rb
 - oasis.gemspec
+- test/fixtures/layout_tests/views/layouts/default_layout.html.erb
+- test/fixtures/layout_tests/views/layouts/fancy_products.html.erb
+- test/fixtures/layout_tests/views/products/cart.html.erb
+- test/fixtures/layout_tests/views/products/on_hold.html.erb
+- test/fixtures/layout_tests/views/products/registry.html.erb
+- test/fixtures/layout_tests/views/products/supported.html.erb
+- test/fixtures/layout_tests/views/products/wish_list.html.erb
 - test/helper.rb
+- test/test_oasis_layouts.rb
 - test/test_oasis_routing.rb
 has_rdoc: true
 homepage: http://github.com/perezd/oasis
@@ -75,4 +84,5 @@ specification_version: 3
 summary: a collection of enhancements for rails engines.
 test_files: 
 - test/helper.rb
+- test/test_oasis_layouts.rb
 - test/test_oasis_routing.rb