RubyGems - headliner - Versions diffs - 0.1.1 - Mend

headliner 0.1.1

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 (9) hide show

data/LICENSE ADDED Viewed

@@ -0,0 +1,19 @@
+Copyright (c) 2007 Patrick Crowley, the.railsi.st
+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.markdown ADDED Viewed

@@ -0,0 +1,119 @@
+Headliner
+=========
+Headliner is a Rails plugin that makes it easier to assign and format page titles from your views.
+Background
+==========
+Normally, if your Rails application has lots of actions and a shared layout, you might find yourself setting custom page title names in your controllers.
+Here's an example:
+    class PagesController < ApplicationController
+      def about
+        @title = "About us"
+      end
+    end
+Then, in your main layout, you might have something like this:
+    <head>
+    <title>My website<% if @title %>: <%= @title %><% end %></title>
+    </head
+This works okay... but page titles don't really belong in controllers, do they?
+So, by moving these titles into your views, we can DRY things up a bit and reinforce the MVC design pattern that's so fundamental to Ruby on Rails.
+Install
+=======
+To install, just add Headliner to your `vendor/plugins` directory:
+    script/plugin install git://github.com/mokolabs/headliner.git
+Usage
+=====
+First, add this code to your main layout:
+    <head>
+    <%= title :site => "My website" %>
+    </head>
+Then, to set the page title, add this to each of your views:
+    <h1><%= title "My page title" %></h1>
+When views are rendered, the page title will be included in the right
+spots:
+    <head>
+    <title>My website | My page title</title>
+    </head>
+    <body>
+    <h1>My page title</h1>
+    </body>
+Options
+=======
+Use these options to customize the title format:
+    :prefix (text between site name and separator)
+    :separator (text used to separate website name from page title)
+    :suffix (text between separator and page title)
+    :lowercase (when true, the page name will be lowercase)
+    :reverse (when true, the page and site names will be reversed)
+    :default (default title to use when title is blank)
+And here are a few examples to give you ideas.
+    <%= title :separator => "&mdash;" %>
+    <%= title :prefix => false, :separator => ":" %>
+    <%= title :lowercase => true %>
+    <%= title :reverse => true, :prefix => false %>
+    <%= title :default => "The ultimate site for Rails" %>
+Dealing with special pages
+==========================
+How do you set the page title without showing it in the view?
+    <% title "My page title" %>
+What if your view headline is different from your page title?
+    <%= title "My page title", "My headline" %>
+Mr. T says, ‘Use my method, fool!’
+==================================
+Just like ERB's HTML safe method, you can invoke Headliner with a single letter alias.
+    <h1><%= pt "My page title" %></h1>
+How does it work?
+=================
+Ruby on Rails renders actions *before* inserting them into layouts. So, if you set a variable in your view, it will be accessible in your layout. But, at first glance, it looks like you're using a variable (in the head) before it's been assigned a value (in the body). Cool, huh?
+Contributors
+============
+Special thanks to James Chan, Nick Zadrozny, and Jordan Fowler.
+Feedback
+========
+Comments and patches welcome at [http://github.com/mokolabs/headliner/](http://github.com/mokolabs/headliner/).

data/Rakefile ADDED Viewed

@@ -0,0 +1,38 @@
+require 'rake'
+require 'rdoc/task'
+require File.join(File.dirname(__FILE__), 'lib', 'headliner')
+require 'rspec/core'
+require 'rspec/core/rake_task'
+desc 'Default: run unit tests.'
+task :default => :spec
+desc 'Test plugin'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/*_spec.rb']
+end
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Headliner'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "headliner"
+    gemspec.version = Headliner::VERSION
+    gemspec.summary = "Assign and format page titles from your views."
+    gemspec.description = "Assign and format page titles from your views"
+    gemspec.email = "shura.71@gmail.com"
+    gemspec.homepage = "http://github.com/shura71/headliner"
+    gemspec.authors = ["Alexander Shcherban"]
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install jeweler -s http://gemcutter.org"
+end

data/headliner.gemspec ADDED Viewed

@@ -0,0 +1,43 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+Gem::Specification.new do |s|
+  s.name = "headliner"
+  s.version = "0.1.1"
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Alexander Shcherban"]
+  s.date = "2012-01-24"
+  s.description = "Assign and format page titles from your views"
+  s.email = "shura.71@gmail.com"
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.markdown"
+  ]
+  s.files = [
+    "LICENSE",
+    "README.markdown",
+    "Rakefile",
+    "headliner.gemspec",
+    "init.rb",
+    "lib/headliner.rb",
+    "spec/headliner_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "http://github.com/shura71/headliner"
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.15"
+  s.summary = "Assign and format page titles from your views."
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/init.rb ADDED Viewed

	@@ -0,0 +1,2 @@
1	+ require 'headliner'
2	+ ActionView::Base.send :include, Headliner

data/lib/headliner.rb ADDED Viewed

@@ -0,0 +1,71 @@
+module Headliner
+  VERSION = "0.1.1".freeze
+  def title(options, headline='')
+    if options.is_a? String
+      save_title(options, headline)
+    else
+      display_title(options)
+    end
+  end
+  def save_title(title, headline)
+    @title = title.gsub(/<\/?[^>]*>/, '')
+    headline.blank? ? title : headline
+  end
+  def display_title(options)
+    # Prefix (leading space)
+    if options[:prefix]
+      prefix = options[:prefix]
+    elsif options[:prefix] == false
+      prefix = ''
+    else
+      prefix = ' '
+    end
+    # Separator
+    unless options[:separator].blank?
+      separator = options[:separator]
+    else
+      separator = '|'
+    end
+    # Suffix (trailing space)
+    if options[:suffix]
+      suffix = options[:suffix]
+    elsif options[:suffix] == false
+      suffix = ''
+    else
+      suffix = ' '
+    end
+    # Lowercase title?
+    if options[:lowercase] == true
+      @title = @title.downcase unless @title.blank?
+    end
+    # Default page title
+    if @title.blank? && options[:default]
+      @title = options[:default]
+    end
+    # Set website/page order
+    unless @title.blank?
+      if options[:reverse] == true
+        # Reverse order => "Page : Website"
+        return content_tag(:title, @title + prefix + separator + suffix + options[:site])
+      else
+        # Standard order => "Website : Page"
+        return content_tag(:title, options[:site] + prefix + separator + suffix + @title)
+      end
+    end
+    # If title is blank, return only website name
+    content_tag :title, options[:site]
+  end
+  # Mr. T says, "Use my method, fool!"
+  alias pt title
+end

data/spec/headliner_spec.rb ADDED Viewed

@@ -0,0 +1,105 @@
+require File.dirname(__FILE__) + '/spec_helper'
+describe "Headliner" do
+  before(:each) do
+    @view = ActionView::Base.new
+  end
+  describe "loading plugin" do
+    it "should be mixed into ActionView::Base" do
+      ActionView::Base.included_modules.include?(Headliner).should be_true
+    end
+    it "should respond to 'title' helper" do
+      @view.should respond_to(:title)
+    end
+    it "should respond to 'title' helper alias" do
+      @view.should respond_to(:t)
+    end
+  end
+  describe "saving title" do
+    it "should save title" do
+      @view.title("iPhone").should eql("iPhone")
+    end
+    it "should save headline if present" do
+      @view.title("iPhone", "iPhone 3G is now on sale!").should eql("iPhone 3G is now on sale!")
+    end
+  end
+  describe "displaying title" do
+    it "should use website name if title is empty" do
+      @view.title(:site => "Apple").should eql("<title>Apple</title>")
+    end
+    it "should use website before page by default" do
+      save_basic_title
+      @view.title(:site => "Apple").should eql("<title>Apple | iPhone</title>")
+    end
+    it "should only use markup in titles in the view" do
+      save_basic_title("<b>iPhone</b>").should eql("<b>iPhone</b>")
+      @view.title(:site => "Apple").should eql("<title>Apple | iPhone</title>")
+    end
+    it "should use page before website if :reverse" do
+      save_basic_title
+      @view.title(:site => "Apple", :reverse => true).should eql("<title>iPhone | Apple</title>")
+    end
+    it "should be lowercase if :lowercase" do
+      save_basic_title
+      @view.title(:site => "apple", :lowercase => true).should eql("<title>apple | iphone</title>")
+    end
+    it "should use custom separator if :separator" do
+      save_basic_title
+      @view.title(:site => "Apple", :separator => "-").should eql("<title>Apple - iPhone</title>")
+      @view.title(:site => "Apple", :separator => ":").should eql("<title>Apple : iPhone</title>")
+    end
+    it "should use custom prefix and suffix if available" do
+      save_basic_title
+      @view.title(:site => "Apple", :prefix => " |", :suffix => "| ").should eql("<title>Apple ||| iPhone</title>")
+    end
+    it "should collapse prefix if false" do
+      save_basic_title
+      @view.title(:site => "Apple", :prefix => false, :separator => ":").should eql("<title>Apple: iPhone</title>")
+    end
+    it "should collapse suffix if false" do
+      save_basic_title
+      @view.title(:site => "Apple", :suffix => false, :separator => "~").should eql("<title>Apple ~iPhone</title>")
+    end
+    it "should use all custom options if available" do
+      save_basic_title
+      @view.title(:site => "apple",
+                  :prefix => " ",
+                  :suffix => " ",
+                  :separator => "-",
+                  :lowercase => true,
+                  :reverse => true).should eql("<title>iphone - apple</title>")
+    end
+    it "should use default one if title is not present or blank" do
+      save_basic_title("")
+      @view.title(:site => "Apple", :default => "New MacBook").should eql("<title>Apple | New MacBook</title>")
+    end
+  end
+  def save_basic_title(title='iPhone')
+    @view.title(title)
+  end
+end

data/spec/spec_helper.rb ADDED Viewed

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'action_controller'
+require 'action_view'
+require File.join(File.dirname(__FILE__), "../lib/headliner")
+ActionView::Base.class_eval do
+  include Headliner
+end

metadata ADDED Viewed

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: headliner
+version: !ruby/object:Gem::Version
+  hash: 25
+  prerelease:
+  segments:
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors:
+- Alexander Shcherban
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2012-01-24 00:00:00 Z
+dependencies: []
+description: Assign and format page titles from your views
+email: shura.71@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.markdown
+files:
+- LICENSE
+- README.markdown
+- Rakefile
+- headliner.gemspec
+- init.rb
+- lib/headliner.rb
+- spec/headliner_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/shura71/headliner
+licenses: []
+post_install_message:
+rdoc_options: []
+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.8.15
+signing_key:
+specification_version: 3
+summary: Assign and format page titles from your views.
+test_files: []