title_estuary 1.0.0 → 1.1.1

data/README.rdoc

@@ -101,4 +101,49 @@ or from a view:
   # in RAILS_ROOT/app/view/projects/index.html.erb:
   <% content_for :page_title do %>
     Some complex page title
-  <% end %>
+  <% end %>
+
+=== Integration with Inherited Resources
+
+When included in a controller class that inherits
+from <tt>InheritedResources::Base</tt>, Title Estuary
+uses <tt>:resource_class</tt> when building default
+page names.
+
+@see TitleEstuary::InheritedResourcesSupport
+@see http://github.com/josevalim/inherites_resources 
+
+=== Integration with High Voltage
+
+When included in a controller class that inherits
+from <tt>HighVoltage::PagesController</tt>,
+Title Estuary uses the page title as the default title.
+It also changes the i18n key scheme to
+"page.title.<controller>.<page_name>" to let you
+define different titles for each page.  For example:
+
+  en:
+    page:
+      title:
+        pages:
+          faq: "Frequently Asked Questions"
+
+*Nota Bene*: if you include +TitleEstuary+ in
+your +ApplicationController+, you'll need to
+re-include it in the +PagesController+. If you're using
+High Voltage's default controller, you can do so in an
+initializer:
+
+  # in RAILS_ROOT/config/initializers/page_titles_for_high_voltage:
+  HighVoltage::PagesController.class_eval do
+    include TitleEstuary
+  end
+  
+If, on the other hand, you're defining your own
++PagesController+, you can include it there:
+
+  # in RAILS_ROOT/app/controllers/pages_controller.rb:
+  # An example custom PagesController.
+  class PagesController < HighVoltage::PagesController
+    include TitleEstuary
+  end

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.1.1

data/lib/title_estuary/high_voltage_support.rb

@@ -0,0 +1,17 @@
+module TitleEstuary
+  
+  module HighVoltageSupport
+    
+    private
+    
+    def default_page_title_from_controller_and_action
+      params[:action] == 'show' ? params[:id].titleize : super
+    end
+    
+    def page_title_i18n_key
+      "page.title.pages.#{params[:id]}"
+    end
+    
+  end
+  
+end

data/lib/title_estuary.rb

@@ -6,14 +6,24 @@ module TitleEstuary
   # <tt>#page_title</tt> as an action and makes that
   # method available to helpers and views; it also
   # auto-includes TitleEstuary::InheritedResourcesSupport
+  # and TitleEstuary::HighVoltageSupport
   # if applicable.
+  #
+  # @see http://github.com/josevalim/inherited_resources/
+  # @see http://github.com/thoughtbot/high_voltage
   def self.included(base)
     base.send :include, TitleEstuary::InstanceMethods
     base.hide_action(:page_title) if base.respond_to?(:hide_action)
     base.helper_method(:page_title, :page_title=) if base.respond_to?(:helper_method)
-    if Object.const_defined?(:InheritedResources) && base < ::InheritedResources::Base
+    if Object.const_defined?(:InheritedResources) &&
+         base <= ::InheritedResources::Base
       base.send :include, TitleEstuary::InheritedResourcesSupport
     end
+    if Object.const_defined?(:HighVoltage) && 
+         HighVoltage.const_defined?(:PagesController) && 
+         base <= ::HighVoltage::PagesController
+      base.send :include, TitleEstuary::HighVoltageSupport
+    end
   end
   
   module InstanceMethods

data/tasks/test.task

@@ -12,6 +12,7 @@ if Object.const_defined?(:LOAD_TITLE_ESTUARY_BUILD_TASKS) && LOAD_TITLE_ESTUARY_
     fl.include "#{TITLE_ESTUARY_PROJECT_ROOT}/test/**/*_test.rb"
     fl.exclude "#{TITLE_ESTUARY_PROJECT_ROOT}/test/test_helper.rb"
     fl.exclude "#{TITLE_ESTUARY_PROJECT_ROOT}/test/lib/**/*.rb"
+    fl.exclude "#{TITLE_ESTUARY_PROJECT_ROOT}/test/vendor/**/*.rb"
   end
 
   Rake::TestTask.new(:test) do |t|

data/test/high_voltage_integration_test.rb

@@ -0,0 +1,50 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class PagesController < HighVoltage::PagesController
+  include TitleEstuary
+end
+
+ActionController::Routing::Routes.draw do |map|
+  map.resources :pages, :only => [:show]
+end
+
+class HighVoltageIntegrationTest < ActionController::TestCase
+  include PageTitleMacros
+  tests PagesController
+  
+  context 'a RESTful controller using both Title Estuary and Inherited Resources' do
+    
+    context 'with custom page titles that involve interpolation' do
+      
+      setup do
+        clear_translations!
+      end
+      
+      should 'have high-voltage support installed' do
+        assert ::PagesController < TitleEstuary::HighVoltageSupport
+      end
+      
+      context 'on a GET to :show for a page with no i18n title set' do
+        setup do
+          get :show, :id => 'info'
+        end
+        should 'set the page title to the requested page name, titleized' do
+          assert_page_title_is 'Info'
+        end
+      end
+      
+      context 'on a GET to :show for a page with an i18n title set' do
+        setup do
+          define_translation 'page.title.pages.faq', "FAQ"
+          get :show, :id => 'faq'
+        end
+        should 'use the requested page name as the action in the key' do
+          assert_page_title_is 'FAQ'
+        end
+      end
+      
+    end
+    
+  end
+  
+end

data/test/test_helper.rb

@@ -17,10 +17,20 @@ test_dir = File.dirname(__FILE__)
   require 'action_controller/test_case'
   require 'action_controller/test_process'
   I18n.reload!
-  ActionController::Base.view_paths = File.join(File.dirname(__FILE__), 'views')
+  ActionController::Base.view_paths = File.join(test_dir, 'views')
   class ApplicationController < ActionController::Base; end
 
 # load title_estuary:  
   ActiveSupport::Dependencies.load_paths << File.expand_path(File.join(test_dir, '..', 'lib'))
   require_dependency 'title_estuary'
-  Shoulda.autoload_macros File.join(test_dir, '..')
+  Shoulda.autoload_macros File.join(test_dir, '..')
+  
+# load external libraries vendored for testing:  
+  Dir.glob("#{test_dir}/vendor/*/app/*").each do |vendor_rails_app_dir|
+    ActiveSupport::Dependencies.load_paths << vendor_rails_app_dir
+    $LOAD_PATH << vendor_rails_app_dir
+  end
+  Dir.glob("#{test_dir}/vendor/*/lib").each do |vendor_lib_dir|
+    ActiveSupport::Dependencies.load_paths << vendor_lib_dir
+    $LOAD_PATH << vendor_lib_dir
+  end

data/test/vendor/high_voltage/app/controllers/high_voltage/pages_controller.rb

@@ -0,0 +1,26 @@
+class HighVoltage::PagesController < ApplicationController
+  unloadable
+  before_filter :ensure_valid
+
+  def show
+    render :template => current_page
+  end
+
+  protected
+
+  def ensure_valid
+    unless template_exists?(current_page)
+      render :nothing => true, :status => 404 and return false
+    end
+  end
+
+  def current_page
+    "pages/#{params[:id].to_s.downcase}"
+  end
+
+  def template_exists?(path)
+    view_paths.find_template(path, response.template.template_format)
+  rescue ActionView::MissingTemplate
+    false
+  end
+end

data/test/vendor/high_voltage/config/high_voltage_routes.rb

@@ -0,0 +1,5 @@
+ActionController::Routing::Routes.draw do |map|
+  map.resources :pages,
+    :controller => 'high_voltage/pages',
+    :only       => [:show]
+end

data/test/vendor/high_voltage/init.rb

@@ -0,0 +1,2 @@
+require 'high_voltage'
+

data/test/vendor/high_voltage/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/test/vendor/high_voltage/lib/high_voltage/extensions/routes.rb

@@ -0,0 +1,15 @@
+if defined?(ActionController::Routing::RouteSet)
+  class ActionController::Routing::RouteSet
+    def load_routes_with_high_voltage!
+      lib_path = File.dirname(__FILE__)
+      high_voltage_routes = File.join(lib_path, *%w[.. .. .. config high_voltage_routes.rb])
+      unless configuration_files.include?(high_voltage_routes)
+        add_configuration_file(high_voltage_routes)
+      end
+      load_routes_without_high_voltage!
+    end
+
+    alias_method_chain :load_routes!, :high_voltage
+  end
+end
+

data/test/vendor/high_voltage/lib/high_voltage.rb

@@ -0,0 +1,5 @@
+module HighVoltage
+end
+
+require 'high_voltage/extensions/routes'
+

data/test/vendor/high_voltage/test/pages_controller_test.rb

@@ -0,0 +1,44 @@
+require 'test_helper'
+
+class ApplicationController < ActionController::Base
+end
+
+require "high_voltage/pages_controller"
+require File.join(File.dirname(__FILE__), '..', 'config', 'high_voltage_routes')
+
+class HighVoltage::PagesControllerTest < ActionController::TestCase
+
+  HighVoltage::PagesController.view_paths << "/tmp"
+
+  context "on GET to a page that exists" do
+    setup do
+      @filename = '/tmp/pages/exists.html.erb'
+
+      FileUtils.mkdir(File.dirname(@filename))
+      File.open(@filename, 'w') do |file|
+        file << "hello <%= 'world' %>"
+      end
+      assert File.exists?(@filename)
+
+      get :show, :id => 'exists'
+    end
+
+    should_respond_with :success
+    should_render_template 'exists'
+
+    teardown do
+      begin
+        FileUtils.rm(@filename)
+        FileUtils.rmdir(File.dirname(@filename))
+      rescue StandardError => e
+        puts "Error while removing files: #{e}"
+      end
+    end
+  end
+
+  context "on GET to /pages/invalid" do
+    setup { get :show, :id => "invalid" }
+    should_respond_with :missing
+  end
+
+end

data/test/vendor/high_voltage/test/test_helper.rb

@@ -0,0 +1,14 @@
+ENV['RAILS_ENV'] = 'test'
+
+require 'rubygems'
+require 'active_support'
+require 'active_support/test_case'
+require 'action_controller'
+require 'test_help'
+require 'high_voltage'
+
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'app', 'controllers')
+$LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'app', 'models')
+
+require 'shoulda'
+require 'shoulda/rails'

data/test/vendor/high_voltage/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: title_estuary
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.1.1
 platform: ruby
 authors: 
 - James Rosen
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-02 00:00:00 -04:00
+date: 2009-09-03 00:00:00 -04:00
 default_executable: 
 dependencies: []
 
@@ -27,6 +27,7 @@ files:
 - Rakefile
 - VERSION
 - lib/title_estuary.rb
+- lib/title_estuary/high_voltage_support.rb
 - lib/title_estuary/inherited_resources_support.rb
 - tasks/doc.task
 - tasks/gem.task
@@ -67,10 +68,20 @@ summary: Easy, internationalized page titles
 test_files: 
 - test/default_titles_test.rb
 - test/dynamic_page_title_test.rb
+- test/high_voltage_integration_test.rb
 - test/inherited_resources_integration_test.rb
 - test/interpolated_page_titles_test.rb
 - test/rails_integration_test.rb
 - test/shoulda_macros/page_title_macros.rb
 - test/simple_custom_titles_test.rb
 - test/test_helper.rb
+- test/vendor/high_voltage/app/controllers/high_voltage/pages_controller.rb
+- test/vendor/high_voltage/config/high_voltage_routes.rb
+- test/vendor/high_voltage/init.rb
+- test/vendor/high_voltage/install.rb
+- test/vendor/high_voltage/lib/high_voltage/extensions/routes.rb
+- test/vendor/high_voltage/lib/high_voltage.rb
+- test/vendor/high_voltage/test/pages_controller_test.rb
+- test/vendor/high_voltage/test/test_helper.rb
+- test/vendor/high_voltage/uninstall.rb
 - test/village_model_and_controller.rb