RubyGems - title_helper - Versions diffs - 0.4.0 - Mend

title_helper 0.4.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 (11) hide show

data/MIT-LICENSE ADDED

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Jan De Poorter
+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

@@ -0,0 +1,20 @@
+TitleHelper
+===========
+TitleHelper allows you to keep your <title> attributes synced with your <h1> attributes, which is more SEO friendly. This is 100% done in the view, which is different from some other plugins, who work with a title-method in the controllers.
+Example
+=======
+This method should be used in your layout and your actions.
+In your action:
+  <%= title "Edit user #{@user.name}" %>
+  # => <h1>Edit user Jan De Poorter</h1>
+In your layout:
+  <head>
+    <title><%= title :site_name => 'Foobar' %></title>
+    # => <title>Edit user Jan De Poorter - Foobar</title>
+Copyright (c) 2008 Jan De Poorter, released under the MIT license

data/Rakefile ADDED

@@ -0,0 +1,13 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "title_helper"
+    gemspec.summary = "TitleHelper allows you to keep your <title> attributes synced with your <h1> attributes, which is more SEO friendly."
+    gemspec.description = "TitleHelper allows you to keep your <title> attributes synced with your <h1> attributes, which is more SEO friendly. This is 100% done in the view, which is different from some other plugins, who work with a title-method in the controllers."
+    gemspec.email = "jan@defv.be"
+    gemspec.homepage = "http://github.com/defv/title_helper"
+    gemspec.authors = ["Jan De Poorter"]
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: gem install jeweler"
+end

data/VERSION ADDED

	@@ -0,0 +1 @@
1	+ 0.4.0

data/init.rb ADDED

	@@ -0,0 +1 @@
1	+ require 'rails/init.rb'

data/lib/title_helper.rb ADDED

@@ -0,0 +1,37 @@
+require 'title_helper/railtie' if defined?(::Rails::Railtie)
+module DefV
+  module TitleHelper
+    # This method should be used in your layout and your actions.
+    #
+    # In your action:
+    #   <%= title "Edit user #{@user.name}" %>
+    # => <h1>Edit user Jan De Poorter</h1>
+    #
+    # In your layout:
+    #   <head>
+    #     <title><%= title :site_name => 'Foobar' %></title>
+    #     ...
+    # => <title>Edit user Jan De Poorter - Foobar</title>
+    #
+    def title arguments, options = {}
+      case arguments
+      when String
+        @title = arguments
+        options[:class] = [options[:class], 'error'].compact.join(' ') if options[:error]
+        title = [options[:header], @title, options[:trailer]].compact.join(' ')
+        title = title.html_safe if title.respond_to?(:html_safe)
+        return content_tag(:h1, title, options.except(:error, :header, :trailer))
+      when Hash
+        sitename = arguments[:site_name]
+        if @title
+          return "#{strip_tags(@title)} - #{sitename}"
+        else
+          return "#{sitename}"
+        end
+      end
+    end
+  end
+end

data/lib/title_helper/railtie.rb ADDED

@@ -0,0 +1,9 @@
+module Defv
+  module TitleHelper
+    class Railtie < Rails::Railtie
+      initializer 'title_helper.action_view' do
+        ActionView::Base.send(:include, DefV::TitleHelper)
+      end
+    end
+  end
+end

data/rails/init.rb ADDED

@@ -0,0 +1,3 @@
+require 'title_helper'
+ActionView::Base.send(:include, DefV::TitleHelper)

data/test/title_helper_test.rb ADDED

@@ -0,0 +1,45 @@
+require 'test/unit'
+require File.dirname(__FILE__) + '/../../../../config/boot.rb'
+require File.dirname(__FILE__) + '/../../../../config/environment.rb'
+class TitleHelperTest < Test::Unit::TestCase
+  def setup
+    @helper = ActionView::Base.new
+  end
+  # Replace this with your real tests.
+  def test_title_method_with_no_title_set
+    assert_equal "foobar", @helper.title(:site_name => 'foobar')
+  end
+  def test_title_method_with_a_title_set
+    assert_equal "<h1>HomePage</h1>", @helper.title("HomePage")
+    assert_equal "HomePage - foobar", @helper.title(:site_name => 'foobar')
+  end
+  def test_strip_tags
+    assert_equal "<h1>This is <strong>GREAT</strong></h1>", @helper.title("This is <strong>GREAT</strong>")
+    assert_equal "This is GREAT - foobar", @helper.title(:site_name => 'foobar')
+  end
+  def test_error_on_h1
+    assert_equal "<h1 class=\"error\">This is wrong</h1>", @helper.title("This is wrong", :error => true)
+  end
+  def test_class_on_h1
+    assert_equal "<h1 class=\"my-class\">Header with class</h1>", @helper.title("Header with class", :class => 'my-class')
+  end
+  def test_id_on_h1
+    assert_equal "<h1 id=\"my-id\">Header with id</h1>", @helper.title("Header with id", :id => 'my-id')
+  end
+  def test_class_and_id_on_h1
+    assert_equal "<h1 class=\"my-class\" id=\"my-id\">Header with class and id</h1>", @helper.title("Header with class and id", :class => 'my-class', :id => 'my-id')
+  end
+  def test_class_and_error_on_h1
+    assert_equal "<h1 class=\"my-class error\">Header with error and class</h1>", @helper.title("Header with error and class", :class => 'my-class', :error => true)
+  end
+end

data/title_helper.gemspec ADDED

@@ -0,0 +1,49 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+Gem::Specification.new do |s|
+  s.name = %q{title_helper}
+  s.version = "0.4.0"
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jan De Poorter"]
+  s.date = %q{2010-08-20}
+  s.description = %q{TitleHelper allows you to keep your <title> attributes synced with your <h1> attributes, which is more SEO friendly. This is 100% done in the view, which is different from some other plugins, who work with a title-method in the controllers.}
+  s.email = %q{jan@defv.be}
+  s.extra_rdoc_files = [
+    "README.rdoc"
+  ]
+  s.files = [
+    "MIT-LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "init.rb",
+     "lib/title_helper.rb",
+     "lib/title_helper/railtie.rb",
+     "rails/init.rb",
+     "test/title_helper_test.rb",
+     "title_helper.gemspec"
+  ]
+  s.homepage = %q{http://github.com/defv/title_helper}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{TitleHelper allows you to keep your <title> attributes synced with your <h1> attributes, which is more SEO friendly.}
+  s.test_files = [
+    "test/title_helper_test.rb"
+  ]
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

metadata ADDED

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: title_helper
+version: !ruby/object:Gem::Version
+  hash: 15
+  prerelease: false
+  segments:
+  - 0
+  - 4
+  - 0
+  version: 0.4.0
+platform: ruby
+authors:
+- Jan De Poorter
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2010-08-20 00:00:00 +02:00
+default_executable:
+dependencies: []
+description: TitleHelper allows you to keep your <title> attributes synced with your <h1> attributes, which is more SEO friendly. This is 100% done in the view, which is different from some other plugins, who work with a title-method in the controllers.
+email: jan@defv.be
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.rdoc
+files:
+- MIT-LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- init.rb
+- lib/title_helper.rb
+- lib/title_helper/railtie.rb
+- rails/init.rb
+- test/title_helper_test.rb
+- title_helper.gemspec
+has_rdoc: true
+homepage: http://github.com/defv/title_helper
+licenses: []
+post_install_message:
+rdoc_options:
+- --charset=UTF-8
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      hash: 3
+      segments:
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      hash: 3
+      segments:
+      - 0
+      version: "0"
+requirements: []
+rubyforge_project:
+rubygems_version: 1.3.7
+signing_key:
+specification_version: 3
+summary: TitleHelper allows you to keep your <title> attributes synced with your <h1> attributes, which is more SEO friendly.
+test_files:
+- test/title_helper_test.rb