RubyGems - entitlement - Versions diffs - 0.0.1 → 0.0.2 - Mend

entitlement 0.0.1 → 0.0.2

Files changed (8) hide show

data/README.md +121 -0
data/entitlement.gemspec +7 -9
data/lib/entitlement/railtie.rb +9 -0
data/lib/entitlement/version.rb +1 -1
data/lib/entitlement/view_helpers.rb +35 -0
data/lib/entitlement.rb +2 -5
data/test/view_helpers_test.rb +143 -0
metadata +23 -7

data/README.md ADDED Viewed

@@ -0,0 +1,121 @@
+# Entitlement
+Entitlement lets you set your page titles in a simple, DRY way.
+Often you want a page's title to match its heading.  Although this is simple to arrange, adding Entitlement to your Gemfile instead is a one-liner.  And I'm sure you don't want to write tests for your page titles.
+## Getting started
+To write out your page title, use `title`:
+```html+erb
+<head>
+  <title><%= title %></title>
+</head>
+```
+To set your page title, use `tee` in your page's header.  This will write it out on the spot too.
+```html+erb
+<h1><%= tee 'My page' %></h1>
+```
+`tee` is easy to remember because:
+* it's a phonetic alias for `t` (for title), and
+* it acts like Unix's `tee`.
+Or you can just use `title` again:
+```html+erb
+<h1><%= title 'My page' %></h1>
+```
+## Include your site's name
+Use `:site`:
+```html+erb
+<head>
+  <title><%= title :site => 'My site' %></title>
+</head>
+```
+This will output, for example:
+```html
+<head>
+  <title>My page - My site</title>
+</head>
+```
+## Reverse the title's order
+Use `:big_endian`:
+```html+erb
+<head>
+  <title><%= title :site => 'My site', :big_endian => true %></title>
+</head>
+```
+Which will produce:
+```html
+<head>
+  <title>My site - My page</title>
+</head>
+```
+## Change the separator
+Use `:separator`:
+```html+erb
+<head>
+  <title><%= title :site => 'My site', :separator => ': ' %></title>
+</head>
+```
+Which will produce:
+```html
+<head>
+  <title>My page: My site</title>
+</head>
+```
+## Have a breadcrumb-like hierarchy
+Pass the levels to `tee` (or `title`).  Go from small to large whether or not you're using `:big_endian` in the site's title.
+```html+erb
+<h1><%= tee 'Some article', 'Europe', 'News' %></h1>
+```
+Which will produce:
+```
+<h1>Some article</h1>
+```
+And:
+```
+<title>Some article - Europe - News</title>
+```
+## Inspiration
+[Headliner](https://github.com/mokolabs/headliner)
+## Intellectual Property
+Copyright 2012 Andy Stewart (boss@airbladesoftware.com).
+Released under the MIT licence.

data/entitlement.gemspec CHANGED Viewed

@@ -3,22 +3,20 @@ $:.push File.expand_path("../lib", __FILE__)
 require "entitlement/version"
 Gem::Specification.new do |s|
-  s.name        = "entitlement"
+  s.name        = 'entitlement'
   s.version     = Entitlement::VERSION
-  s.authors     = ["Andy Stewart"]
-  s.email       = ["boss@airbladesoftware.com"]
-  s.homepage    = ""
-  s.summary     = 'Easy page titles in Rails 3.'
+  s.authors     = ['Andy Stewart']
+  s.email       = ['boss@airbladesoftware.com']
+  s.homepage    = 'https://github.com/airblade/entitlement'
+  s.summary     = 'Simple page titles in Rails 3.'
   s.description = s.summary
-  s.rubyforge_project = "entitlement"
+  s.rubyforge_project = 'entitlement'
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
-  # specify any dependencies here; for example:
-  # s.add_development_dependency "rspec"
-  # s.add_runtime_dependency "rest-client"
+  s.add_runtime_dependency 'rails', '~> 3'
 end

data/lib/entitlement/railtie.rb ADDED Viewed

@@ -0,0 +1,9 @@
+require 'entitlement/view_helpers'
+module Entitlement
+  class Railtie < Rails::Railtie
+    initializer 'entitlement.view_helpers' do
+      ActionView::Base.send :include, ViewHelpers
+    end
+  end
+end

data/lib/entitlement/version.rb CHANGED Viewed

@@ -1,3 +1,3 @@
 module Entitlement
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/entitlement/view_helpers.rb ADDED Viewed

@@ -0,0 +1,35 @@
+module Entitlement
+  module ViewHelpers
+    def title(*args)
+      if args.empty?
+        render_title
+      elsif args.first.is_a?(Hash)
+        render_title args.first
+      else
+        tee *args
+      end
+    end
+    def tee(*args)
+      @page_title = args
+      args.first.html_safe
+    end
+    private
+    def render_title(options = {})
+      defaults = {
+        :separator => ' - ',
+        :big_endian => false
+      }
+      options = defaults.merge options
+      @page_title ||= []
+      @page_title << options[:site] if options[:site]
+      @page_title.reverse! if options[:big_endian]
+      @page_title.join(options[:separator]).html_safe
+    end
+  end
+end

data/lib/entitlement.rb CHANGED Viewed

@@ -1,5 +1,2 @@
-require "entitlement/version"
-module Entitlement
-  # Your code goes here...
-end
+require 'entitlement/railtie' if defined?(Rails)
+require 'entitlement/version'

data/test/view_helpers_test.rb ADDED Viewed

@@ -0,0 +1,143 @@
+require 'test/unit'
+require 'action_view'
+require 'entitlement/view_helpers'
+class View
+  include Entitlement::ViewHelpers
+end
+class ViewHelpersTest < Test::Unit::TestCase
+  def setup
+    @view = View.new
+  end
+  #
+  # tee
+  #
+  def test_tee_with_one_argument
+    out = @view.tee 'My page'
+    assert_equal 'My page', out
+  end
+  def test_tee_with_two_arguments
+    out = @view.tee 'My page', 'Some section'
+    assert_equal 'My page', out
+  end
+  def test_tee_is_html_safe
+    out = @view.tee 'My page'
+    assert out.html_safe?
+  end
+  #
+  # title as tee
+  #
+  def test_title_as_tee_alias_with_one_argument
+    out = @view.title 'My page'
+    assert_equal out, 'My page'
+  end
+  def test_title_as_tee_alias_with_two_arguments
+    out = @view.title 'My page', 'Some section'
+    assert_equal 'My page', out
+  end
+  def test_title_as_tee_alias_is_html_safe
+    out = @view.title 'My page'
+    assert out.html_safe?
+  end
+  #
+  # title rendering
+  #
+  def test_title_without_arguments
+    @view.tee 'My page'
+    out = @view.title
+    assert_equal 'My page', out
+  end
+  def test_title_without_arguments_via_title
+    @view.title 'My page'
+    out = @view.title
+    assert_equal 'My page', out
+  end
+  def test_title_with_site
+    @view.tee 'My page'
+    out = @view.title :site => 'My site'
+    assert_equal 'My page - My site', out
+  end
+  def test_title_with_site_via_title
+    @view.title 'My page'
+    out = @view.title :site => 'My site'
+    assert_equal 'My page - My site', out
+  end
+  def test_title_with_sections
+    @view.tee 'My page', 'Some section'
+    out = @view.title
+    assert_equal 'My page - Some section', out
+  end
+  def test_title_with_sections_via_title
+    @view.title 'My page', 'Some section'
+    out = @view.title
+    assert_equal 'My page - Some section', out
+  end
+  def test_title_with_site_and_sections
+    @view.tee 'My page', 'Some section'
+    out = @view.title :site => 'My site'
+    assert_equal 'My page - Some section - My site', out
+  end
+  def test_title_with_site_and_sections_via_title
+    @view.title 'My page', 'Some section'
+    out = @view.title :site => 'My site'
+    assert_equal 'My page - Some section - My site', out
+  end
+  def test_title_with_custom_separator
+    @view.tee 'My page'
+    out = @view.title :site => 'My site', :separator => ': '
+    assert_equal 'My page: My site', out
+  end
+  def test_title_with_custom_separator_via_title
+    @view.title 'My page'
+    out = @view.title :site => 'My site', :separator => ': '
+    assert_equal 'My page: My site', out
+  end
+  def test_title_big_endian
+    @view.tee 'My page', 'Some section'
+    out = @view.title :site => 'My site', :big_endian => true
+    assert_equal 'My site - Some section - My page', out
+  end
+  def test_title_big_endian_via_title
+    @view.title 'My page', 'Some section'
+    out = @view.title :site => 'My site', :big_endian => true
+    assert_equal 'My site - Some section - My page', out
+  end
+  def test_title_is_html_safe
+    @view.tee 'My page'
+    out = @view.title
+    assert out.html_safe?
+  end
+  def test_title_is_html_safe_via_title
+    @view.title 'My page'
+    out = @view.title
+    assert out.html_safe?
+  end
+end

metadata CHANGED Viewed

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: entitlement
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease:
 platform: ruby
 authors:
@@ -9,9 +9,20 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2012-02-10 00:00:00.000000000 Z
-dependencies: []
-description: Easy page titles in Rails 3.
+date: 2012-02-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: &2154720800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2154720800
+description: Simple page titles in Rails 3.
 email:
 - boss@airbladesoftware.com
 executables: []
@@ -20,11 +31,15 @@ extra_rdoc_files: []
 files:
 - .gitignore
 - Gemfile
+- README.md
 - Rakefile
 - entitlement.gemspec
 - lib/entitlement.rb
+- lib/entitlement/railtie.rb
 - lib/entitlement/version.rb
-homepage: ''
+- lib/entitlement/view_helpers.rb
+- test/view_helpers_test.rb
+homepage: https://github.com/airblade/entitlement
 licenses: []
 post_install_message:
 rdoc_options: []
@@ -47,5 +62,6 @@ rubyforge_project: entitlement
 rubygems_version: 1.8.11
 signing_key:
 specification_version: 3
-summary: Easy page titles in Rails 3.
-test_files: []
+summary: Simple page titles in Rails 3.
+test_files:
+- test/view_helpers_test.rb