layout_options 0.2 → 0.2.1

data/README.textile

@@ -14,16 +14,19 @@ h3. Example
 
 Adding layout_options to your Gemfile:
 
-  gem 'layout_options', '~> 0.1'
+@gem 'layout_options', '~> 0.1'@
 
 Install @layout_options@:
 
-  rails generate layout_options:install
+@rails generate layout_options:install@
 
 Define your layouts in your controllers:
 
+<pre><code>
   class UsersController < ApplicationController
     layout_options :overlay => [:new, :edit], :none => :destroy
+    # use :none for your hash key if you don't want any layout to be used
   end
+</code></pre>
 
 Thats it!

data/layout_options.gemspec

@@ -9,15 +9,11 @@ Gem::Specification.new do |s|
   s.email       = ['dane.harrigan@gmail.com']
   s.homepage    = "http://rubygems.org/gems/layout_options"
   s.summary     = 'A single place for setting all of your layouts in a controller'
-  s.description = 'The layout_options gem provides a single place to set all of your ' <<
-  'layouts in your controller. This gem really shines when multiple layouts are needed ' <<
-  'when using inherited_resources.'
-
+  s.description = 'Need an easy way to manage multiple layouts? Done.'
   s.required_rubygems_version = ">= 1.3.6"
   s.rubyforge_project         = "layout_options"
 
   s.add_dependency 'rails', '~> 3.0.1'
-  #s.add_dependency 'actionpack','~> 3.0.1'
 
   s.add_development_dependency "bundler", ">= 1.0.0.rc.6"
   s.add_development_dependency "rspec", "~> 2.1.0"

data/lib/generators/layout_options/{install/install_generator.rb → install_generator.rb}

@@ -2,12 +2,17 @@ module LayoutOptions
   module Generators
     class InstallGenerator < Rails::Generators::Base
       desc 'prep the application to use layout_options'
+      source_root File.expand_path('../templates', __FILE__)
 
       def application_controller_injection # :nodoc:
         inject_into_class 'app/controllers/application_controller.rb', ApplicationController do
          "  include LayoutOptions\n"
         end
       end
+
+      def copy_initializer # :nodoc
+        copy_file 'layout_options.rb', 'config/initializers/layout_options.rb'
+      end
     end
   end
 end

data/lib/generators/layout_options/templates/layout_options.rb

@@ -0,0 +1,11 @@
+LayoutOptions.setup do |config|
+  # layout_options assumes the default layout to use is the 'applicaiton' layout.
+  # If this isn't the case just change the value here.
+  #
+  # "Why would I ever want a different default layout?"
+  # Creating a stock rails app gives you an 'application.html.erb' layout file.
+  # If you make a Rails engine and try to use an 'application' layout it will
+  # pull the auto-generated one from the rails root. Setting your default layout
+  # to something different, like the name of your engine, will fix the conflict.
+  config.default_layout = :application
+end

data/lib/layout_options/layout_options.rb

@@ -1,10 +1,27 @@
 module LayoutOptions
+  mattr_accessor :default_layout
+  @@default_layout = 'application'
+
   def self.included(controller) # :nodoc:
     controller.send(:include, LayoutOptions::InstanceMethods)
     controller.send(:extend, LayoutOptions::ClassMethods)
     controller.send(:layout, :layout_options_selector)
   end
 
+  # setup - This method allows you to configure the layout_options gem. You can find the setup
+  # block in the config/initializers/layout_options.rb file.
+  #
+  #  # layout_options assumes the default layout for all of your views is 'application'. If you
+  #  # want to deviate from this assumption you can set a 'default_layout' value.
+  #
+  #  LayoutOptions.setup do |config|
+  #    config.default_layout = :custom_layout
+  #  end
+  def self.setup
+    yield(self)
+  end
+
+
   module ClassMethods
     # layout_options - This method is available at the class level of your ApplicationController
     # and any controller that inherits from it.
@@ -55,7 +72,7 @@ module LayoutOptions
       end
 
       no_layout.map! { |value| value.to_sym }
-      return no_layout.include?(action) ? false : 'application'
+      return no_layout.include?(action) ? false : LayoutOptions.default_layout.to_s
     end
   end
 end

data/lib/layout_options/version.rb

@@ -1,7 +1,3 @@
 module LayoutOptions
-  module VERSION
-    def self.to_s # :nodoc:
-      '0.2'
-    end
-  end
+  VERSION = '0.2.1'
 end

data/spec/rails_root/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: /Users/Dane/Projects/layout_options
   specs:
-    layout_options (0.1.1)
+    layout_options (0.2)
       rails (~> 3.0.1)
 
 GEM

data/spec/rails_root/app/controllers/cux_controller.rb

@@ -0,0 +1,3 @@
+class CuxController < ApplicationController
+  def index; end
+end

data/spec/rails_root/config/initializers/layout_options.rb

@@ -0,0 +1,9 @@
+LayoutOptions.setup do |config|
+  # layout_options assumes the default layout to use is the 'applicaiton' layout.
+  # If this isn't the case just change the value here.
+  #
+  # When wouldn't you want the default layout to be 'application?' If you make a
+  # rails engine and assume the 'application' layout, your views will conflict with
+  # the 'application.html.erb' layout that gets generated with a rails install.
+  config.default_layout = :application
+end

data/spec/rails_root/config/routes.rb

@@ -1,4 +1,5 @@
 RailsRoot::Application.routes.draw do
+  resources :cux
   resources :foo
   resources :bar do
     resources :baz

data/spec/rails_root/spec/controllers/cux_controller_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe CuxController do
+  describe '#index' do
+    before(:each) do
+      LayoutOptions.setup do |config|
+        config.default_layout = :custom_default
+      end
+    end
+
+    after(:each) do
+      LayoutOptions.setup do |config|
+        config.default_layout = :application
+      end
+    end
+
+    it 'uses a different default layout' do
+      get :index
+      response.should render_template('layouts/custom_default')
+    end
+  end
+end

metadata

@@ -5,7 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  version: "0.2"
+  - 1
+  version: 0.2.1
 platform: ruby
 authors: 
 - Dane Harrigan
@@ -13,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-01 00:00:00 -05:00
+date: 2011-01-26 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -108,7 +109,7 @@ dependencies:
         version: 1.1.2
   type: :development
   version_requirements: *id006
-description: The layout_options gem provides a single place to set all of your layouts in your controller. This gem really shines when multiple layouts are needed when using inherited_resources.
+description: Need an easy way to manage multiple layouts? Done.
 email: 
 - dane.harrigan@gmail.com
 executables: []
@@ -120,12 +121,12 @@ extra_rdoc_files: []
 files: 
 - .gitignore
 - Gemfile
-- Gemfile.lock
 - README.textile
 - Rakefile
 - init.rb
 - layout_options.gemspec
-- lib/generators/layout_options/install/install_generator.rb
+- lib/generators/layout_options/install_generator.rb
+- lib/generators/layout_options/templates/layout_options.rb
 - lib/layout_options.rb
 - lib/layout_options/layout_options.rb
 - lib/layout_options/storage.rb
@@ -139,6 +140,7 @@ files:
 - spec/rails_root/app/controllers/application_controller.rb
 - spec/rails_root/app/controllers/bar_controller.rb
 - spec/rails_root/app/controllers/baz_controller.rb
+- spec/rails_root/app/controllers/cux_controller.rb
 - spec/rails_root/app/controllers/foo_controller.rb
 - spec/rails_root/app/views/bar/create.html.erb
 - spec/rails_root/app/views/bar/new.html.erb
@@ -146,10 +148,12 @@ files:
 - spec/rails_root/app/views/baz/create.html.erb
 - spec/rails_root/app/views/baz/new.html.erb
 - spec/rails_root/app/views/baz/show.html.erb
+- spec/rails_root/app/views/cux/index.html.erb
 - spec/rails_root/app/views/foo/create.html.erb
 - spec/rails_root/app/views/foo/new.html.erb
 - spec/rails_root/app/views/foo/show.html.erb
 - spec/rails_root/app/views/layouts/application.html.erb
+- spec/rails_root/app/views/layouts/custom_default.html.erb
 - spec/rails_root/app/views/layouts/overlay.html.erb
 - spec/rails_root/config.ru
 - spec/rails_root/config/application.rb
@@ -161,6 +165,7 @@ files:
 - spec/rails_root/config/environments/test.rb
 - spec/rails_root/config/initializers/backtrace_silencers.rb
 - spec/rails_root/config/initializers/inflections.rb
+- spec/rails_root/config/initializers/layout_options.rb
 - spec/rails_root/config/initializers/mime_types.rb
 - spec/rails_root/config/initializers/secret_token.rb
 - spec/rails_root/config/initializers/session_store.rb
@@ -169,6 +174,7 @@ files:
 - spec/rails_root/script/rails
 - spec/rails_root/spec/controllers/bar_controller_spec.rb
 - spec/rails_root/spec/controllers/baz_controller_spec.rb
+- spec/rails_root/spec/controllers/cux_controller_spec.rb
 - spec/rails_root/spec/controllers/foo_controller_spec.rb
 - spec/rails_root/spec/spec_helper.rb
 - spec/rails_root/spec/support/shared.rb

data/Gemfile.lock

@@ -1,113 +0,0 @@
-PATH
-  remote: .
-  specs:
-    layout_options (0.1.1)
-      rails (~> 3.0.1)
-
-GEM
-  remote: http://rubygems.org/
-  specs:
-    abstract (1.0.0)
-    actionmailer (3.0.3)
-      actionpack (= 3.0.3)
-      mail (~> 2.2.9)
-    actionpack (3.0.3)
-      activemodel (= 3.0.3)
-      activesupport (= 3.0.3)
-      builder (~> 2.1.2)
-      erubis (~> 2.6.6)
-      i18n (~> 0.4)
-      rack (~> 1.2.1)
-      rack-mount (~> 0.6.13)
-      rack-test (~> 0.5.6)
-      tzinfo (~> 0.3.23)
-    activemodel (3.0.3)
-      activesupport (= 3.0.3)
-      builder (~> 2.1.2)
-      i18n (~> 0.4)
-    activerecord (3.0.3)
-      activemodel (= 3.0.3)
-      activesupport (= 3.0.3)
-      arel (~> 2.0.2)
-      tzinfo (~> 0.3.23)
-    activeresource (3.0.3)
-      activemodel (= 3.0.3)
-      activesupport (= 3.0.3)
-    activesupport (3.0.3)
-    archive-tar-minitar (0.5.2)
-    arel (2.0.4)
-    builder (2.1.2)
-    columnize (0.3.2)
-    diff-lcs (1.1.2)
-    erubis (2.6.6)
-      abstract (>= 1.0.0)
-    has_scope (0.5.0)
-    i18n (0.4.2)
-    inherited_resources (1.1.2)
-      has_scope (~> 0.5.0)
-      responders (~> 0.6.0)
-    linecache19 (0.5.11)
-      ruby_core_source (>= 0.1.4)
-    mail (2.2.10)
-      activesupport (>= 2.3.6)
-      i18n (~> 0.4.1)
-      mime-types (~> 1.16)
-      treetop (~> 1.4.8)
-    mime-types (1.16)
-    polyglot (0.3.1)
-    rack (1.2.1)
-    rack-mount (0.6.13)
-      rack (>= 1.0.0)
-    rack-test (0.5.6)
-      rack (>= 1.0)
-    rails (3.0.3)
-      actionmailer (= 3.0.3)
-      actionpack (= 3.0.3)
-      activerecord (= 3.0.3)
-      activeresource (= 3.0.3)
-      activesupport (= 3.0.3)
-      bundler (~> 1.0)
-      railties (= 3.0.3)
-    railties (3.0.3)
-      actionpack (= 3.0.3)
-      activesupport (= 3.0.3)
-      rake (>= 0.8.7)
-      thor (~> 0.14.4)
-    rake (0.8.7)
-    responders (0.6.2)
-    rspec (2.1.0)
-      rspec-core (~> 2.1.0)
-      rspec-expectations (~> 2.1.0)
-      rspec-mocks (~> 2.1.0)
-    rspec-core (2.1.0)
-    rspec-expectations (2.1.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.1.0)
-    rspec-rails (2.1.0)
-      rspec (~> 2.1.0)
-    ruby-debug-base19 (0.11.24)
-      columnize (>= 0.3.1)
-      linecache19 (>= 0.5.11)
-      ruby_core_source (>= 0.1.4)
-    ruby-debug19 (0.11.6)
-      columnize (>= 0.3.1)
-      linecache19 (>= 0.5.11)
-      ruby-debug-base19 (>= 0.11.19)
-    ruby_core_source (0.1.4)
-      archive-tar-minitar (>= 0.5.2)
-    thor (0.14.6)
-    treetop (1.4.9)
-      polyglot (>= 0.3.1)
-    tzinfo (0.3.23)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (>= 1.0.0.rc.6)
-  inherited_resources (~> 1.1.2)
-  layout_options!
-  rails (~> 3.0.1)
-  rspec (~> 2.1.0)
-  rspec-rails (~> 2.1.0)
-  ruby-debug19 (~> 0.11.6)