smart_titles 0.2.1 → 0.3.0

data/Gemfile

@@ -2,3 +2,7 @@ source "http://rubygems.org"
 
 # Specify your gem's dependencies in smart_titles.gemspec
 gemspec
+
+group :guards do
+  gem 'guard-minitest'
+end

data/Gemfile.lock

@@ -1,66 +1,58 @@
 PATH
   remote: .
   specs:
-    smart_titles (0.2.1)
+    smart_titles (0.3.0)
       actionpack
       activesupport
 
 GEM
   remote: http://rubygems.org/
   specs:
-    actionpack (3.1.0)
-      activemodel (= 3.1.0)
-      activesupport (= 3.1.0)
+    actionpack (3.1.3)
+      activemodel (= 3.1.3)
+      activesupport (= 3.1.3)
       builder (~> 3.0.0)
       erubis (~> 2.7.0)
       i18n (~> 0.6)
-      rack (~> 1.3.2)
-      rack-cache (~> 1.0.3)
+      rack (~> 1.3.5)
+      rack-cache (~> 1.1)
       rack-mount (~> 0.8.2)
       rack-test (~> 0.6.1)
-      sprockets (~> 2.0.0)
-    activemodel (3.1.0)
-      activesupport (= 3.1.0)
-      bcrypt-ruby (~> 3.0.0)
+      sprockets (~> 2.0.3)
+    activemodel (3.1.3)
+      activesupport (= 3.1.3)
       builder (~> 3.0.0)
       i18n (~> 0.6)
-    activesupport (3.1.0)
+    activesupport (3.1.3)
       multi_json (~> 1.0)
-    bcrypt-ruby (3.0.0)
     builder (3.0.0)
-    diff-lcs (1.1.3)
     erubis (2.7.0)
+    guard (0.8.8)
+      thor (~> 0.14.6)
+    guard-minitest (0.4.0)
+      guard (~> 0.4)
     hike (1.2.1)
     i18n (0.6.0)
-    mocha (0.9.12)
-    multi_json (1.0.3)
-    rack (1.3.2)
-    rack-cache (1.0.3)
+    multi_json (1.0.4)
+    rack (1.3.5)
+    rack-cache (1.1)
       rack (>= 0.4)
     rack-mount (0.8.3)
       rack (>= 1.0.0)
     rack-test (0.6.1)
       rack (>= 1.0)
-    rake (0.9.2)
-    rspec (2.6.0)
-      rspec-core (~> 2.6.0)
-      rspec-expectations (~> 2.6.0)
-      rspec-mocks (~> 2.6.0)
-    rspec-core (2.6.4)
-    rspec-expectations (2.6.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.6.0)
-    sprockets (2.0.0)
+    rake (0.9.2.2)
+    sprockets (2.0.3)
       hike (~> 1.2)
       rack (~> 1.0)
-      tilt (!= 1.3.0, ~> 1.1)
+      tilt (~> 1.1, != 1.3.0)
+    thor (0.14.6)
     tilt (1.3.3)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  mocha
+  guard-minitest
   rake
-  rspec
   smart_titles!

data/Guardfile

@@ -0,0 +1,14 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'minitest' do
+  # with Minitest::Unit
+  watch(%r|^test/(.*)_test\.rb|)
+  watch(%r|^lib/(.*)\.rb|)     { |m| "test/#{m[1]}_test.rb" }
+  watch(%r|^test/test_helper\.rb|)    { "test" }
+
+  # with Minitest::Spec
+  # watch(%r|^spec/(.*)_spec\.rb|)
+  # watch(%r|^lib/(.*)\.rb|)            { |m| "spec/#{m[1]}_spec.rb" }
+  # watch(%r|^spec/spec_helper\.rb|)    { "spec" }
+end

data/README.md

@@ -46,7 +46,7 @@ And then you should just call `title` without any arguments.
 
     <%= title %>
 
-Note that you don't have to call it if you don't output it.
+Note that you _have to call it_ even if you don't output it.
 
     <% title %>
 
@@ -73,6 +73,15 @@ And now products#index page will have "Products from the Coolest Store" browser'
 
 Changelog
 ---
+### 0.3.0
+* Important change in the documentation: you have to call `title` with no arguments when you want to use translated title.
+* Fixed bug when `head_title` returned default title even if there was a custom title in locale.
+* Added actual Railtie class for reliable integration. This fixes a problem when sometimes helper wasn't included for some reason.
+* Internal changes that you probably don't care about.
+  * There are now only 2 public helper methods: `title` and `head_title`.
+  * All helper methods are documented.
+  * Missing translation is now detected more safely.
+
 ### 0.2.0
 * `page_title` renamed to `head_title`.
 * Added support for :title_template translation

data/Rakefile

@@ -1,2 +1,11 @@
 require 'bundler'
 Bundler::GemHelper.install_tasks
+
+require "rake/testtask"
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = Dir['test/**/*_test.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/lib/smart_titles/helper.rb

@@ -1,37 +1,49 @@
 module SmartTitles
-  module Helper
-    MISSING_TRANSLATION = 0
-
-    def head_title(*args)
-      options = args.extract_options!
-      options[:template] = true if options[:template].nil?
-      custom_default_title = args.first
+  MISSING_TRANSLATION = Object.new
 
-      if options[:template] && title = page_title
+  module Helper
+    # <title><%= head_title %></title>
+    # Will return title if it was set for the current page.
+    # Otherwise will return :title translation.
+    #
+    # <title><%= head_title "My Blog" %></title>
+    # The default title will be "My Blog" instead of :title translation.
+    #
+    # Example usage with title template:
+    #     en:
+    #       title: The Coolest Store
+    #       title_template: %{title} from the Coolest Store
+    #
+    #     head_title     # => The Coolest Store
+    #     title "Drinks" # => <h1>Drinks</h1>
+    #     head_title     # => Drinks from the Coolest Store
+    def head_title(default_title = t(:title))
+      if title = page_title
         t(:title_template, title: title, default: title)
       else
-        page_title || custom_default_title || default_title
+        default_title
       end
     end
 
-    attr_writer :page_title
-
-    def page_title
-      @page_title || default_page_title
-    end
-
-    def title(new_title = nil)
-      self.page_title = new_title if new_title
+    # Convinient helper method that will:
+    # * Set custom title for the current page if it is passed. Otherwise the title will be automatically set 
+    # * Return the title passed or looked up from locale wrapped into h1 tag
+    def title(custom_title = nil)
+      provide(:page_title, custom_title || page_title)
       content_tag(:h1, page_title) if page_title
     end
 
-    def default_page_title
-      translation = t('.title', default: MISSING_TRANSLATION)
-      translation unless translation == MISSING_TRANSLATION
-    end
+  private
 
-    def default_title
-      t(:title)
+    # This is a page title that was set by the #title helper method
+    # It defaults to ".title" translation
+    def page_title
+      if content_for?(:page_title)
+        content_for(:page_title)
+      else
+        translation = t('.title', default: MISSING_TRANSLATION)
+        translation unless translation.equal? MISSING_TRANSLATION
+      end
     end
   end
 end

data/lib/smart_titles/railtie.rb

@@ -1 +1,11 @@
-ActionView::Helpers.send :include, SmartTitles::Helper
+module SmartTitles
+  class Railtie < Rails::Railtie
+
+    initializer "smart_titles.helper" do
+      ActiveSupport.on_load :action_view do
+        include SmartTitles::Helper
+      end
+    end
+
+  end
+end

data/lib/smart_titles/version.rb

@@ -1,3 +1,3 @@
 module SmartTitles
-  VERSION = "0.2.1"
+  VERSION = "0.3.0"
 end

data/lib/smart_titles.rb

@@ -1,2 +1,2 @@
 require "smart_titles/helper"
-require "smart_titles/railtie"
+require "smart_titles/railtie" if defined?(Rails)

data/smart_titles.gemspec

@@ -10,13 +10,11 @@ Gem::Specification.new do |s|
   s.email       = "sema@sema.in"
   s.homepage    = "http://github.com/semaperepelitsa/smart_titles"
   s.license     = "MIT"
-  s.summary     = %q{Really convenient way to set up page titles in Rails application.}
+  s.summary     = %q{Really convenient way to set up page titles in a Rails application.}
 
   s.add_dependency 'activesupport'
   s.add_dependency 'actionpack'
-  s.add_development_dependency 'rspec'
   s.add_development_dependency 'rake'
-  s.add_development_dependency 'mocha'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

data/test/smart_titles/helper_test.rb

@@ -0,0 +1,136 @@
+require "test_helper"
+
+class SmartTitlesHelperTest < ActionView::TestCase
+  include SmartTitles::Helper
+
+  def setup
+    super
+    @av = ActionView::Base.new
+    @view_flow = ActionView::OutputFlow.new
+  end
+
+  def inside_view
+    @virtual_path = 'posts/new'
+  end
+
+  def inside_layout
+    @virtual_path = 'layouts/application'
+  end
+
+  def title(*args)
+    inside_view
+    super
+  end
+
+  def head_title(*args)
+    inside_layout
+    super
+  end
+
+  def teardown
+    I18n.backend.reload!
+  end
+
+
+  def test_custom_title
+    store_global_title
+    store_page_title
+    assert_equal "<h1>Hi</h1>", title("Hi")
+  end
+
+  def test_translated_title
+    store_global_title
+    store_page_title
+    assert_equal "<h1>New post</h1>", title
+  end
+
+  def test_no_page_title
+    store_global_title
+    assert_nil title
+  end
+
+  def test_no_title
+    assert_nil title
+  end
+
+
+  def test_head_title_with_custom_title
+    store_global_title
+    store_page_title
+    title("Hi")
+    assert_equal "Hi", head_title
+  end
+
+  def test_head_title_with_translated_title
+    store_global_title
+    store_page_title
+    title
+    assert_equal "New post", head_title
+  end
+
+  def test_head_title_with_translated_global_title
+    store_global_title
+    assert_equal "My Website", head_title
+  end
+
+  def test_head_title_with_no_title
+    assert_includes head_title, "translation missing: en.title"
+  end
+
+
+  def test_head_title_with_custom_global_title
+    assert_equal "Default", head_title("Default")
+  end
+
+  def test_head_title_with_custom_global_title_and_custom_title
+    title("Hi")
+    assert_equal "Hi", head_title("Default")
+  end
+
+
+  def test_head_title_with_template_and_translated_titles
+    store_global_title
+    store_page_title
+    store_title_template
+    title
+    assert_equal "d New post b", head_title
+  end
+
+  def test_head_title_with_template_and_custom_title
+    store_global_title
+    store_page_title
+    store_title_template
+    title("Hi")
+    assert_equal "d Hi b", head_title
+  end
+
+  def test_head_title_with_template_and_translated_title
+    store_global_title
+    store_title_template
+    assert_equal "My Website", head_title
+  end
+
+private
+
+  def store_translations(*args)
+    I18n.backend.store_translations(:en, *args)
+  end
+
+  def store_page_title
+    store_translations posts: { new: { title: "New post" } }
+  end
+
+  def store_titles
+    store_global_title
+    store_page_title
+  end
+
+  def store_global_title
+    store_translations title: "My Website"
+  end
+
+  def store_title_template
+    store_translations title_template: "d %{title} b"
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,8 @@
+require "bundler/setup"
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'minitest/autorun'
+require 'active_support/all'
+require 'action_view'
+require 'smart_titles'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: smart_titles
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-03 00:00:00.000000000Z
+date: 2011-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70107579604720 !ruby/object:Gem::Requirement
+  requirement: &70340769140560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70107579604720
+  version_requirements: *70340769140560
 - !ruby/object:Gem::Dependency
   name: actionpack
-  requirement: &70107579603980 !ruby/object:Gem::Requirement
+  requirement: &70340769124440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,32 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70107579603980
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: &70107579603080 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *70107579603080
+  version_requirements: *70340769124440
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70107579602360 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: *70107579602360
-- !ruby/object:Gem::Dependency
-  name: mocha
-  requirement: &70107579601760 !ruby/object:Gem::Requirement
+  requirement: &70340769123460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,7 +43,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70107579601760
+  version_requirements: *70340769123460
 description: 
 email: sema@sema.in
 executables: []
@@ -77,6 +55,7 @@ files:
 - .rspec
 - Gemfile
 - Gemfile.lock
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -86,8 +65,8 @@ files:
 - lib/smart_titles/railtie.rb
 - lib/smart_titles/version.rb
 - smart_titles.gemspec
-- spec/smart_titles_helper_spec.rb
-- spec/spec_helper.rb
+- test/smart_titles/helper_test.rb
+- test/test_helper.rb
 homepage: http://github.com/semaperepelitsa/smart_titles
 licenses:
 - MIT
@@ -101,24 +80,19 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -4104704374070627387
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -4104704374070627387
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
-summary: Really convenient way to set up page titles in Rails application.
+summary: Really convenient way to set up page titles in a Rails application.
 test_files:
-- spec/smart_titles_helper_spec.rb
-- spec/spec_helper.rb
+- test/smart_titles/helper_test.rb
+- test/test_helper.rb
+has_rdoc: 

data/spec/smart_titles_helper_spec.rb

@@ -1,138 +0,0 @@
-require File.expand_path('spec_helper', File.dirname(__FILE__))
-
-describe SmartTitles::Helper do
-  include ActionView::Helpers
-
-  before do
-    @virtual_path = 'posts/new'
-    I18n.backend.reload!
-  end
-
-  def store_translations(*args)
-    I18n.backend.store_translations(:en, *args)
-  end
-
-  describe 'no i18n' do
-    describe '#title' do
-      it "sets #page_title" do
-        title("Hi")
-        page_title.should == "Hi"
-      end
-
-      it "returns h1-wrapped title" do
-        title("Hi").should == "<h1>Hi</h1>"
-      end
-    end
-
-    describe '#page_title' do
-      it "returns nil if no title was set" do
-        page_title.should == nil
-      end
-    end
-
-    describe '#head_title' do
-      it 'returns #page_title if it was set' do
-        title("Hi")
-        head_title.should == "Hi"
-      end
-
-      it "returns missing translation if no title was set" do
-        head_title.should include("translation missing: en.title")
-      end
-
-      it "returns title passed if no title was set" do
-        head_title("Default").should == "Default"
-      end
-
-      describe 'with :title_template' do
-        it "used for page_title" do
-          store_translations title_template: "d %{title} b"
-          title("New post")
-          head_title.should == "d New post b"
-        end
-
-        it "is skipped for custom title" do
-          store_translations title_template: "d %{title} b"
-          head_title("Default").should == "Default"
-        end
-
-        it "is skipped if template: false" do
-          store_translations title_template: "d %{title} b"
-          title("New post")
-          head_title("Default", template: false).should == "New post"
-        end
-      end
-    end
-  end
-
-  describe 'i18n' do
-    describe '#title' do
-      it "returns .title wrapped in h1 tag if there are :title and .title" do
-        store_translations title: "My Website", posts: { new: { title: "New post" } }
-        title.should == "<h1>New post</h1>"
-      end
-
-      it "returns .title wrapped in h1 tag if there is only .title" do
-        store_translations posts: { new: { title: "New post" } }
-        title.should == "<h1>New post</h1>"
-      end
-
-      it "returns nothing if there is no .title" do
-        store_translations title: "My Website"
-        title.should == nil
-      end
-
-      it "returns nothing if there are no translations" do
-        title.should == nil
-      end
-    end
-
-    describe '#head_title' do
-      it "returns .title if there are :title and .title" do
-        store_translations title: "My Website", posts: { new: { title: "New post" } }
-        head_title.should == "New post"
-      end
-
-      it "returns .title if there is only .title" do
-        store_translations posts: { new: { title: "New post" } }
-        head_title.should == "New post"
-      end
-
-      it "returns :title if there is no .title" do
-        store_translations title: "My Website"
-        head_title.should == "My Website"
-      end
-
-      it "returns missing translation if there are no tranlations" do
-        head_title.should include("translation missing: en.title")
-      end
-
-      it "returns custom title" do
-        store_translations title: "My Website"
-        head_title("Custom").should == "Custom"
-      end
-
-      it "returns .title even if custom default title is passed" do
-        store_translations posts: { new: { title: "New post" } }
-        head_title("Custom").should == "New post"
-      end
-
-      describe 'with :title_template' do
-        it "used for page_title" do
-          store_translations title_template: "d %{title} b", posts: { new: { title: "New post" } }
-          head_title.should == "d New post b"
-        end
-
-        it "is skipped for default title" do
-          store_translations title: "My Website", title_template: "d %{title} b"
-          head_title.should == "My Website"
-        end
-
-        it "is skipped if template: false" do
-          store_translations title_template: "d %{title} b", posts: { new: { title: "New post" } }
-          head_title(template: false).should == "New post"
-        end
-      end
-    end
-  end
-end

data/spec/spec_helper.rb

@@ -1,13 +0,0 @@
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'active_support/all'
-require 'action_view'
-require 'smart_titles'
-
-# Requires supporting files with custom matchers and macros, etc,
-# in ./support/ and its subdirectories.
-Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
-
-RSpec.configure do |config|
-  config.mock_with :mocha
-end