RubyGems - title_estuary - Versions diffs - 1.0.0 - Mend

title_estuary 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (19) hide show

data/MIT-LICENSE +20 -0
data/README.rdoc +104 -0
data/Rakefile +9 -0
data/VERSION +1 -0
data/lib/title_estuary/inherited_resources_support.rb +29 -0
data/lib/title_estuary.rb +114 -0
data/tasks/doc.task +28 -0
data/tasks/gem.task +39 -0
data/tasks/test.task +23 -0
data/test/default_titles_test.rb +110 -0
data/test/dynamic_page_title_test.rb +48 -0
data/test/inherited_resources_integration_test.rb +107 -0
data/test/interpolated_page_titles_test.rb +58 -0
data/test/rails_integration_test.rb +29 -0
data/test/shoulda_macros/page_title_macros.rb +32 -0
data/test/simple_custom_titles_test.rb +34 -0
data/test/test_helper.rb +26 -0
data/test/village_model_and_controller.rb +22 -0
metadata +76 -0

data/MIT-LICENSE ADDED Viewed

@@ -0,0 +1,20 @@
+Copyright (c) 2009 James Rosen
+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.

data/README.rdoc ADDED Viewed

@@ -0,0 +1,104 @@
+Title Estuary is a gem/plugin that makes it easy to set page titles.
+It it built with internationalization in mind. It requires
+ActiveSupport's I18N, but should be usable with frameworks other
+than Rails.
+=== How-To
+==== 1: tell Rails about the gem:
+  # in RAILS_ROOT/config/environment.rb:
+  config.gem 'title_estuary', :source => 'http://gemcutter.org'
+==== 2: have Rails install the gem:
+  [sudo] rake gems:install
+==== 3: set up your layout:
+  # in RAILS_ROOT/app/views/layouts/application.html.erb:
+  <html ...>
+    <head ...>
+      <title><%= page_title %></title>
+      ...
+    </head>
+    <body>
+      <h1><%= page_title %></h1>
+      ...
+    </body>
+  </html>
+==== 4. customize your titles:
+Use the format "page.title.controller_name.action_name"
+  # in RAILS_ROOT/config/locales/en.yml:
+  en:
+    page:
+      title:
+        accounts:
+          new:    "Sign Up"
+        sessions:
+          new:    "Sign In"
+        projects:
+          index:  "Your projects"
+          new:    "Start a new project"
+If you want to use any interpolated strings, make sure
+you define an <tt>#interpolation_options</tt> method in
+your controller:
+  # in RAILS_ROOT/config/locales/en.yml:
+  en:
+    page:
+      title:
+        projects:
+          index:  "All {{number_of_projects}} of your projects"
+          show:   "Project {{project_name}}"
+          edit:   "Edit project {{project_name}}"
+  # An example controller (that would be defined
+  # in RAILS_ROOT/app/controllers/projects_controller.rb).
+  class ProjectsController < ActionController::Base
+    # An example definition of <tt>#interpolation_options</tt>
+    # that sets certain project-related values as applicable.
+    #
+    # @return [Hash] a hash of interpolation values
+    def interpolation_options
+      returning({}) do |result|
+        result[:number_of_projects] = @projects.size if @projects.present?
+        result[:project_name] = @project.name if @project.present?
+        result[:project_id] = params[:id]
+      end
+    end
+    hide_action :interpolation_options
+  end
+If you need more dynamic titles than simple interpolation affords,
+set the title manually in an action:
+  # in RAILS_ROOT/app/controllers/projects_controller.rb:
+  class ProjectsController < ActionController::Base
+    def show
+      @project = Project.find(params[:id])
+      self.page_title = "A title based on #{@project.some_complex_string}"
+    end
+  end
+or in a filter:
+  # in RAILS_ROOT/app/controllers/projects_controller.rb:
+  class ProjectsController < ActionController::Base
+    before_filter :set_title
+    private
+    def set_title
+      self.page_title = "Some complex title"
+    end
+  end
+or from a view:
+  # in RAILS_ROOT/app/view/projects/index.html.erb:
+  <% content_for :page_title do %>
+    Some complex page title
+  <% end %>

data/Rakefile ADDED Viewed

@@ -0,0 +1,9 @@
+desc "Default: run all tests, including features"
+task :default => [ 'test' ]
+TITLE_ESTUARY_PROJECT_ROOT = File.expand_path(File.dirname(__FILE__))
+LOAD_TITLE_ESTUARY_BUILD_TASKS = true
+Dir.glob('tasks/*.task').each do |taskfile|
+  load File.expand_path("./#{taskfile}")
+end

data/VERSION ADDED Viewed

	@@ -0,0 +1 @@
1	+ 1.0.0

data/lib/title_estuary/inherited_resources_support.rb ADDED Viewed

@@ -0,0 +1,29 @@
+module TitleEstuary
+  module InheritedResourcesSupport
+    private
+    # @return [#to_s] the requested_resource as loaded by
+    #                 InheritedResources.
+    def page_title_resource
+      # it should be loaded by now, but if not, don't
+      # make a special request on our behalf:
+      get_resource_ivar
+    end
+    # @return [String] an improved guess for the name of the requested resource.
+    def page_title_singular_resource_name
+      resource_name = if resource_class
+        if resource_class.respond_to?(:human_name)
+          resource_class.human_name
+        else
+          resource_class.name.humanize
+        end
+      else
+        params[:controller].to_s.singularize
+      end
+    end
+  end
+end

data/lib/title_estuary.rb ADDED Viewed

@@ -0,0 +1,114 @@
+# @author James Rosen
+module TitleEstuary
+  # When TitleEstuary is included by a controller,
+  # this hook prevents ActionPack from using
+  # <tt>#page_title</tt> as an action and makes that
+  # method available to helpers and views; it also
+  # auto-includes TitleEstuary::InheritedResourcesSupport
+  # if applicable.
+  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
+      base.send :include, TitleEstuary::InheritedResourcesSupport
+    end
+  end
+  module InstanceMethods
+    # Get the page title. First checks for a dynamically-set
+    # title (set via <tt>#page_title=</tt> or via
+    # <tt>content_for :page_title</tt>); if none has been set,
+    # uses a version from I18n under the key
+    # 'page.title.<controller>.<action>'; if no such value exists,
+    # tries to generate a reasonable sane default.
+    #
+    # @return [String] the page title
+    def page_title
+      return @content_for_page_title if @content_for_page_title.present?
+      self.page_title = look_up_or_generate_page_title
+    end
+    protected
+    # Sets the page title.
+    #
+    # Available to views both as a helper method:
+    #
+    #   <% self.page_title = '...' -%>
+    #
+    # and via <tt>:content_for :page_title</tt>:
+    #
+    #   <% content_for :page_title do %>
+    #     ...
+    #   <% end %>
+    def page_title=(title)
+      @content_for_page_title = title
+    end
+    private
+    # @return [String] the I18n version of the page
+    # title, defaulting to the generated version.
+    #
+    # @see #page_title_i18n_key
+    # @see #default_page_title_from_controller_and_action
+    def look_up_or_generate_page_title
+      given_options = if self.respond_to?(:interpolation_options)
+        interpolation_options
+      else
+        {}
+      end
+      default = default_page_title_from_controller_and_action
+      options = given_options.merge(:default => default)
+      I18n.t page_title_i18n_key, options
+    end
+    # @return [Symbol] the I18n key for the page title for
+    #         this controller/action pair.
+    def page_title_i18n_key
+      "page.title.#{params[:controller]}.#{params[:action]}".to_sym
+    end
+    # @return [String] a reasonably sane default title for
+    #                  this controller/action pair.
+    def default_page_title_from_controller_and_action
+      action = params[:action].to_s
+      resource_name = page_title_singular_resource_name
+      resource = page_title_resource
+      case action
+      when 'index'
+        "All #{resource_name.pluralize.titleize}"
+      when 'new', 'create'
+        "New #{resource_name.singularize.titleize}"
+      when 'show'
+        "#{resource_name.singularize.titleize} #{resource}"
+      when 'edit', 'update'
+        "Edit #{resource_name.singularize.titleize} #{resource}"
+      else
+        if resource.present?
+          "#{action.titleize} #{resource_name.singularize.titleize} #{resource}"
+        else
+          "#{action.titleize} #{resource_name.pluralize.titleize}"
+        end
+      end
+    end
+    # @return [#to_s] an instance variable representing the requested
+    #                 resource if it's in an obvious location.
+    def page_title_resource
+      if params[:id]
+        instance_variable_get(:"@#{page_title_singular_resource_name}") || params[:id]
+      end
+    end
+    # @return [String] a guess for the name of the requested resource.
+    def page_title_singular_resource_name
+      params[:controller].singularize
+    end
+  end
+end

data/tasks/doc.task ADDED Viewed

@@ -0,0 +1,28 @@
+# don't load these tasks if this project is used as a Rails plugin:
+if Object.const_defined?(:LOAD_TITLE_ESTUARY_BUILD_TASKS) && LOAD_TITLE_ESTUARY_BUILD_TASKS
+  require 'yard'
+  require 'yard/rake/yardoc_task'
+  desc "Generate RDoc"
+  task :doc => ['doc:generate']
+  namespace :doc do
+    doc_dir = "#{TITLE_ESTUARY_PROJECT_ROOT}/doc/rdoc"
+    readme  = "#{TITLE_ESTUARY_PROJECT_ROOT}/README.rdoc"
+    YARD::Rake::YardocTask.new(:generate) do |yt|
+      yt.files   = FileList[
+        "#{TITLE_ESTUARY_PROJECT_ROOT}/lib/**/*.rb",
+        "#{TITLE_ESTUARY_PROJECT_ROOT}/README.rdoc"
+      ]
+      yt.options = ['--output-dir', doc_dir, '--readme', readme]
+    end
+    desc "Remove generated documenation"
+    task :clean do
+      rm_r doc_dir if File.exists?(doc_dir)
+    end
+  end
+end

data/tasks/gem.task ADDED Viewed

@@ -0,0 +1,39 @@
+# don't load these tasks if this project is used as a Rails plugin:
+if Object.const_defined?(:LOAD_TITLE_ESTUARY_BUILD_TASKS) && LOAD_TITLE_ESTUARY_BUILD_TASKS
+  gem_files = FileList[
+    "[A-Z]*",
+    "{lib,tasks}/**/*"
+  ]
+  #raise gem_files.to_a.inspect
+  begin
+    require 'jeweler'
+    Jeweler::Tasks.new do |s|
+      s.name = "title_estuary"
+      s.summary = 'Easy, internationalized page titles'
+      s.email = 'james.a.rosen@gmail.com'
+      s.homepage = "http://github.com/gcnovus/title_estuary"
+      s.description = 'Title Estuary speeds up development by giving you good default titles and simple customizability, including internationalization.'
+      s.authors = ['James Rosen']
+      s.files = gem_files
+      s.require_paths = ['lib']
+      s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Title Estuary: RDoc", "--charset", "utf-8"]
+    end
+  rescue LoadError
+    puts "Jeweler, or one of its dependencies, is not available. Install it with: sudo gem install jeweler -s http://gemcutter.org"
+  end
+  namespace :pkg do
+    pkg_dir = File.join(TITLE_ESTUARY_PROJECT_ROOT, 'pkg')
+    desc "Remove the pkg/ directory and all built gems"
+    task :clean do
+      rm_r pkg_dir if File.exists?(pkg_dir)
+    end
+  end
+end

data/tasks/test.task ADDED Viewed

@@ -0,0 +1,23 @@
+# don't load these tasks if this project is used as a Rails plugin:
+if Object.const_defined?(:LOAD_TITLE_ESTUARY_BUILD_TASKS) && LOAD_TITLE_ESTUARY_BUILD_TASKS
+  require 'rake/testtask'
+  LIB_DIRECTORIES = FileList.new do |fl|
+    fl.include "#{TITLE_ESTUARY_PROJECT_ROOT}/lib"
+    fl.include "#{TITLE_ESTUARY_PROJECT_ROOT}/test/lib"
+  end
+  TEST_FILES = FileList.new do |fl|
+    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"
+  end
+  Rake::TestTask.new(:test) do |t|
+    t.libs = LIB_DIRECTORIES
+    t.test_files = TEST_FILES
+    t.verbose = true
+  end
+end

data/test/default_titles_test.rb ADDED Viewed

@@ -0,0 +1,110 @@
+require File.dirname(__FILE__) + '/test_helper'
+require File.dirname(__FILE__) + '/village_model_and_controller'
+class DefaultTitlesTest < ActionController::TestCase
+  include PageTitleMacros
+  tests VillagesController
+  context 'a RESTful, titleize controller' do
+    context 'with no custom page titles set up' do
+      setup { clear_translations! }
+      context 'on a GET to :index' do
+        setup { get :index }
+        should_set_the_page_title_to 'All Villages'
+        should 'not generate the title twice' do
+          @controller.page_title
+          @controller.stubs :look_up_or_generate_page_title
+          @controller.page_title
+          assert_received @controller, :look_up_or_generate_page_title do |expect|
+            expect.never
+          end
+        end
+      end
+      context 'on a GET to :new' do
+        setup { get :new }
+        should_set_the_page_title_to 'New Village'
+      end
+      context 'on a POST to :create that fails' do
+        setup { post :create }
+        should_set_the_page_title_to 'New Village'
+      end
+      context 'on a GET to :show for a resource that exists' do
+        setup do
+          Village.stubs(:find).returns(Village.new('Bostonburgh'))
+          get :show, :id => 'anything'
+        end
+        should_set_the_page_title_to "Village Bostonburgh"
+      end
+      context 'on a GET to :show for a resource that does not exist (or is not set to an obvious instance variable)' do
+        setup do
+          Village.stubs(:find).returns(nil)
+          get :show, :id => '2'
+        end
+        should_set_the_page_title_to "Village 2"
+      end
+      context 'on a GET to :edit for a resource that exists' do
+        setup do
+          Village.stubs(:find).returns(Village.new('Gloucestershire'))
+          get :edit, :id => 'something'
+        end
+        should_set_the_page_title_to "Edit Village Gloucestershire"
+      end
+      context 'on a GET to :edit for a resource that does not exist (or is not set to an obvious instance variable)' do
+        setup do
+          Village.stubs(:find).returns(nil)
+          get :edit, :id => '3'
+        end
+        should_set_the_page_title_to "Edit Village 3"
+      end
+      context 'on a PUT to :update for a resource that exists' do
+        setup do
+          Village.stubs(:find).returns(Village.new('East Umbridge'))
+          put :update, :id => 'seven'
+        end
+        should_set_the_page_title_to "Edit Village East Umbridge"
+      end
+      context 'on a PUT to :update for a resource that does not exist (or is not set to an obvious instance variable)' do
+        setup do
+          Village.stubs(:find).returns(nil)
+          put :update, :id => '100'
+        end
+        should_set_the_page_title_to "Edit Village 100"
+      end
+      context 'on a GET to a custom collection action' do
+        setup { get :burninated }
+        should_set_the_page_title_to "Burninated Villages"
+      end
+      context 'on a GET on a custom member action for a resource that exists' do
+        setup do
+          Village.stubs(:find).returns(Village.new('Parrotshire'))
+          get :burninate, :id => '14'
+        end
+        should_set_the_page_title_to "Burninate Village Parrotshire"
+      end
+      context 'on a GET to a custom member action for a resource that does not exist (or is not set to an obvious instance variable)' do
+        setup do
+          Village.stubs(:find).returns(nil)
+          get :burninate, :id => '9'
+        end
+        should_set_the_page_title_to "Burninate Village 9"
+      end
+    end
+  end
+end

data/test/dynamic_page_title_test.rb ADDED Viewed

@@ -0,0 +1,48 @@
+require File.dirname(__FILE__) + '/test_helper'
+require File.dirname(__FILE__) + '/village_model_and_controller'
+VillagesController.class_eval do
+  def index_with_dynamic_title
+    self.page_title = 'A Custom Title'
+    index_without_dynamic_title
+  end
+  alias_method :index_without_dynamic_title, :index
+end
+class DynamicPageTitle < ActionController::TestCase
+  include PageTitleMacros
+  tests VillagesController
+  context 'a RESTful, titleize controller' do
+    context 'that sets a page title dynamically' do
+      setup do
+        clear_translations!
+        VillagesController.class_eval do
+          alias_method :index, :index_with_dynamic_title
+        end
+      end
+      teardown do
+        VillagesController.class_eval do
+          alias_method :index, :index_without_dynamic_title
+        end
+      end
+      should 'use the dynamic title instead of the default' do
+        get :index
+        assert_page_title_is 'A Custom Title'
+      end
+      should 'use the dynamic title instead of a custom one from the I18n framework' do
+        define_translation 'page.title.villages.index', 'something else'
+        get :index
+        assert_page_title_is 'A Custom Title'
+      end
+    end
+  end
+end

data/test/inherited_resources_integration_test.rb ADDED Viewed

@@ -0,0 +1,107 @@
+require File.dirname(__FILE__) + '/test_helper'
+require 'inherited_resources'
+require 'inherited_resources/actions'
+require 'inherited_resources/base_helpers'
+require 'inherited_resources/class_methods'
+require 'inherited_resources/url_helpers'
+require 'inherited_resources/base'
+class Pizza
+  def initialize(name); @name = name.to_s; end
+  def to_s; @name; end
+  def to_param; '1'; end
+  def method_missing(*args, &block); self; end
+end
+class DeliciousThingsController < InheritedResources::Base
+  self.resource_class = Pizza
+  include TitleEstuary
+  def cheesey; index; end
+  def add_topping; show; end
+  def pizza_url(*args); delicious_thing_url(*args); end
+end
+ActionController::Routing::Routes.draw do |map|
+  map.resources :delicious_things, :collection => { :cheesey     => :get },
+                                   :member     => { :add_topping => :get }
+end
+class InheritedResourcesIntegrationTest < ActionController::TestCase
+  include PageTitleMacros
+  tests DeliciousThingsController
+  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 inherited-resources support installed' do
+        assert DeliciousThingsController < TitleEstuary::InheritedResourcesSupport
+      end
+      context 'on a GET to :index' do
+        setup do
+          Pizza.stubs(:find).returns([])
+          get :index
+        end
+        should_set_the_page_title_to 'All Pizzas'
+      end
+      context 'on a GET to :new' do
+        setup { get :new }
+        should_set_the_page_title_to 'New Pizza'
+      end
+      context 'on a POST to :create that fails' do
+        setup { post :create }
+        should_set_the_page_title_to 'New Pizza'
+      end
+      context 'on a GET to :show' do
+        setup do
+          Pizza.stubs(:find).returns(Pizza.new('Vegetarian Special'))
+          get :show, :id => 'anything'
+        end
+        should_set_the_page_title_to "Pizza Vegetarian Special"
+      end
+      context 'on a GET to :edit' do
+        setup do
+          Pizza.stubs(:find).returns(Pizza.new('NY Thin Crust'))
+          get :edit, :id => 'something'
+        end
+        should_set_the_page_title_to "Edit Pizza NY Thin Crust"
+      end
+      context 'on a PUT to :update' do
+        setup do
+          Pizza.stubs(:find).returns(Pizza.new('Neapolitan'))
+          put :update, :id => 'seven'
+        end
+        should_set_the_page_title_to "Edit Pizza Neapolitan"
+      end
+      context 'on a GET to a custom collection action' do
+        setup do
+          Pizza.stubs(:find).returns([])
+          get :cheesey
+        end
+        should_set_the_page_title_to "Cheesey Pizzas"
+      end
+      context 'on a GET on a custom member action for a resource that exists' do
+        setup do
+          Pizza.stubs(:find).returns(Pizza.new('Margherita'))
+          get :add_topping, :id => '14'
+        end
+        should_set_the_page_title_to "Add Topping Pizza Margherita"
+      end
+    end
+  end
+end

data/test/interpolated_page_titles_test.rb ADDED Viewed

@@ -0,0 +1,58 @@
+require File.dirname(__FILE__) + '/test_helper'
+require File.dirname(__FILE__) + '/village_model_and_controller'
+class InterpolatedPageTitlesTest < ActionController::TestCase
+  include PageTitleMacros
+  tests VillagesController
+  context 'a RESTful, titleize controller' do
+    context 'with custom page titles that involve interpolation' do
+      setup { clear_translations! }
+      setup do
+        self.class.controller_class.class_eval do
+          def interpolation_options
+            {
+              :villages_count => 12,
+              :village_name   => 'Rhinoceros Town'
+            }
+          end
+        end
+      end
+      context 'on a GET to :index' do
+        setup do
+          define_translation 'page.title.villages.index', '{{villages_count}} Villages'
+          get :index
+        end
+        should_set_the_page_title_to '12 Villages'
+      end
+      context 'on a GET to :show' do
+        setup do
+          Village.stubs(:find).returns(Village.new('anything'))
+          define_translation 'page.title.villages.show', '{{village_name}}'
+          get :show, :id => 29291
+        end
+        should_set_the_page_title_to 'Rhinoceros Town'
+      end
+      context 'that fails to provide a necessary interpolation string' do
+        setup do
+          define_translation 'page.title.villages.new', '{{not_specified_by_the_controller}}'
+          get :new
+        end
+        should "raise a translation error" do
+          assert_raises I18n::MissingInterpolationArgument do
+            @controller.page_title
+          end
+        end
+      end
+    end
+  end
+end

data/test/rails_integration_test.rb ADDED Viewed

@@ -0,0 +1,29 @@
+require File.dirname(__FILE__) + '/test_helper'
+require File.dirname(__FILE__) + '/village_model_and_controller'
+require 'action_view/test_case'
+class RailsIntegrationTest < ActionController::TestCase
+  include PageTitleMacros
+  tests VillagesController
+  def self.should_expose_as_helper(method)
+    should "expose :#{method} to views as a helper" do
+      helper = Object.new
+      helper.extend VillagesController.master_helper_module
+      assert helper.respond_to?(method)
+    end
+  end
+  context 'a RESTful, titleized controller' do
+    should "not have a :page_title action" do
+      assert !VillagesController.action_methods.map { |a| a.to_sym }.include?(:page_title)
+    end
+    should_expose_as_helper :page_title
+    should_expose_as_helper :page_title=
+  end
+end

data/test/shoulda_macros/page_title_macros.rb ADDED Viewed

@@ -0,0 +1,32 @@
+module PageTitleMacros
+  def self.included(base)
+    base.extend PageTitleMacros::ControllerMacros
+  end
+  def clear_translations!
+    I18n.reload!
+  end
+  def define_translation(key, value)
+    hash = key.to_s.split('.').reverse.inject(value) do |value, key_part|
+      { key_part.to_sym => value }
+    end
+    I18n.backend.send :merge_translations, I18n.locale, hash
+  end
+  def assert_page_title_is(title)
+    assert_equal title, @controller.page_title
+  end
+  module ControllerMacros
+    def should_set_the_page_title_to(title)
+      should "set the page title to #{title}" do
+        assert_page_title_is title
+      end
+    end
+  end
+end

data/test/simple_custom_titles_test.rb ADDED Viewed

@@ -0,0 +1,34 @@
+require File.dirname(__FILE__) + '/test_helper'
+require File.dirname(__FILE__) + '/village_model_and_controller'
+class SimpleCustomTitlesTest < ActionController::TestCase
+  include PageTitleMacros
+  tests VillagesController
+  context 'a RESTful, titleize controller' do
+    context 'with custom page titles set up' do
+      setup { clear_translations! }
+      context 'on a GET to :index' do
+        setup do
+          define_translation 'page.title.villages.index', 'Some Villages'
+          get :index
+        end
+        should_set_the_page_title_to 'Some Villages'
+      end
+      context 'on a GET to :new' do
+        setup do
+          define_translation 'page.title.villages.new', 'Add a Village'
+          get :new
+        end
+        should_set_the_page_title_to "Add a Village"
+      end
+    end
+  end
+end

data/test/test_helper.rb ADDED Viewed

@@ -0,0 +1,26 @@
+test_dir = File.dirname(__FILE__)
+# testing support:
+  require 'test/unit'
+  require 'test/unit/testcase'
+  require 'rubygems'
+  require 'shoulda'
+  gem 'jferris-mocha'
+  require 'mocha'
+  require 'redgreen'
+# set up Rails:
+  ENV["RAILS_ENV"] ||= "test"
+  RAILS_ROOT = "anywhere"
+  require 'active_support'
+  require 'action_controller'
+  require 'action_controller/test_case'
+  require 'action_controller/test_process'
+  I18n.reload!
+  ActionController::Base.view_paths = File.join(File.dirname(__FILE__), '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, '..')

data/test/village_model_and_controller.rb ADDED Viewed

@@ -0,0 +1,22 @@
+class Village
+  def initialize(name); @name = name; end
+  def to_s; @name.to_s; end
+end
+class VillagesController < ActionController::Base
+  include TitleEstuary
+  def index; render :nothing => true; end
+  def burninated; index; end
+  def new; index; end
+  def create; index; end
+  def show; @village = Village.find; index; end
+  def burninate; show; end
+  def edit; show; end
+  def update; show; end
+  def destroy; show; end
+end
+ActionController::Routing::Routes.draw do |map|
+  map.resources :villages, :collection => { :burninated => :get },
+                           :member     => { :burninate  => :get }
+end

metadata ADDED Viewed

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: title_estuary
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- James Rosen
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2009-09-02 00:00:00 -04:00
+default_executable:
+dependencies: []
+description: Title Estuary speeds up development by giving you good default titles and simple customizability, including internationalization.
+email: james.a.rosen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+files:
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/title_estuary.rb
+- lib/title_estuary/inherited_resources_support.rb
+- tasks/doc.task
+- tasks/gem.task
+- tasks/test.task
+has_rdoc: true
+homepage: http://github.com/gcnovus/title_estuary
+licenses: []
+post_install_message:
+rdoc_options:
+- --line-numbers
+- --inline-source
+- --title
+- "Title Estuary: RDoc"
+- --charset
+- utf-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: "0"
+  version:
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: "0"
+  version:
+requirements: []
+rubyforge_project:
+rubygems_version: 1.3.3
+signing_key:
+specification_version: 3
+summary: Easy, internationalized page titles
+test_files:
+- test/default_titles_test.rb
+- test/dynamic_page_title_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/village_model_and_controller.rb