heading_with_title 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in heading_with_title.gemspec
+gemspec

data/MIT-LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 tanraya
+
+MIT License
+
+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.md

@@ -0,0 +1,59 @@
+# HeadingWithTitle - A set of helpers for Rails
+
+Setting the page heading (e.g H1) at the same time with a page title (inside `<title>` tag).
+
+## Installation
+
+First, put this line in your `Gemfile`:
+
+```ruby
+gem 'heading_with_title'
+```
+
+Then run `bundle install` to update your application's bundle.# 
+
+## Usage
+
+Add `page_title` call within `<title>` tag:
+
+```erb
+<title><%= page_title %></title>
+```
+
+And then in the views you just call `heading_with_title` helper to set page title with
+heading, or you call `page_title('Something')` to set page title without heading.
+
+## Examples:
+```erb
+# Set both title and heading
+<%= heading_with_title 'Users' %>
+
+# It also respects a block
+<%= heading_with_title 'Users' do |heading| %>
+  <span><%= heading %></span>
+<% end %>
+
+# Or you might want to set only page title
+<% page_title 'Users' %>
+```
+## Configuration
+
+Create initializer file, `config/initializers/heading_with_title.rb` and put some
+configuration settings into it:
+```ruby
+HeadingWithTitle.configure do |config|
+  # Set page title delimeter
+  # Example: Page Title / AwesomeApp
+  config.title_delimeter = ' / '
+
+  # Title suffix that shown at the end of page title
+  # Accepts String or Proc
+  config.title_suffix = ->{ Rails.application.name }
+
+  # Default heading size (h1 by default)
+  config.default_heading_size = :h1
+end
+```
+## License
+
+[The MIT License](https://github.com/tanraya/heading_with_title/blob/master/MIT-LICENSE)

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/heading_with_title.gemspec

@@ -0,0 +1,23 @@
+# encoding: utf-8
+$:.push File.expand_path("../lib", __FILE__)
+require "heading_with_title/version"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name          = "heading_with_title"
+  s.version       = HeadingWithTitle::VERSION
+  s.authors       = ["Andrew Kozloff"]
+  s.email         = ["demerest@gmail.com"]
+  s.homepage      = "https://github.com/rocsci/heading_with_title"
+  s.summary       = "A set of helpers for Rails"
+  s.description   = "Setting the page heading at the same time with a page title"
+  s.license       = "MIT"
+  s.files         = `git ls-files`.split($/)
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ["lib"]
+
+  s.add_dependency "rails"
+  s.add_development_dependency "bundler", "~> 1.3"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec"
+end

data/lib/heading_with_title/helpers.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+module HeadingWithTitle
+  module Helpers #:nodoc:
+    # Set page title. Use this method in your views
+    def page_title(title = nil)
+      if title.present?
+        @hwt_title = title
+        nil
+      else
+        suffix = HeadingWithTitle.title_suffix
+        suffix = suffix.call if suffix.is_a?(Proc)
+        raw ([@hwt_title, suffix].compact.join(HeadingWithTitle.title_delimeter))
+      end
+    end
+
+    def heading_with_title(heading, &block)
+      page_title(heading)
+      heading = raw(block.call(heading)) if block_given?
+      content_tag(HeadingWithTitle.default_heading_size, heading)
+    end
+  end
+end

data/lib/heading_with_title/railtie.rb

@@ -0,0 +1,10 @@
+# encoding: utf-8
+require 'heading_with_title/helpers'
+
+module HeadingWithTitle #:nodoc:
+  class Railtie < Rails::Railtie
+    initializer 'heading_with_title.helpers' do |app|
+      ActionView::Base.send :include, HeadingWithTitle::Helpers
+    end
+  end
+end

data/lib/heading_with_title/version.rb

@@ -0,0 +1,3 @@
+module HeadingWithTitle
+  VERSION = "0.0.1"
+end

data/lib/heading_with_title.rb

@@ -0,0 +1,66 @@
+# encoding: utf-8
+require "heading_with_title/version"
+require "rails"
+require "action_view"
+
+# = HeadingWithTitle - A set of helpers for Rails
+#
+# Setting the page heading (e.g H1) at the same time with a page title (inside `<title>` tag).
+#
+# Add `page_title` call within `<title>` tag:
+#
+#  <title><%= page_title %></title>
+#
+# And then in the views you just call `heading_with_title` helper to set page title with
+# heading, or you call `page_title('Something')` to set page title without heading.
+#
+# == Examples:
+#
+#  # Set both title and heading
+#  <%= heading_with_title 'Users' %>
+#
+#  # It also respects a block
+#  <%= heading_with_title 'Users' do |heading| %>
+#    <span><%= heading %></span>
+#  <% end %>
+#
+#  Or you might want to set only page title
+#  <% page_title 'Users' %>
+#
+# == Configuration
+# Create initializer file, `config/initializers/heading_with_title.rb` and put some
+# configuration settings into it:
+#
+#  HeadingWithTitle.configure do |config|
+#    # Set page title delimeter
+#    # Example: Page Title / AwesomeApp
+#    config.title_delimeter = ' / '
+#
+#    # Title suffix that shown at the end of page title
+#    # Accepts String or Proc
+#    config.title_suffix = ->{ Rails.application.name }
+#
+#    # Default heading size (h1 by default)
+#    config.default_heading_size = :h1
+#  end
+#
+module HeadingWithTitle
+  # Set page title delimeter
+  # Example: Page Title / AwesomeApp
+  mattr_accessor :title_delimeter
+  @@title_delimeter = ' / '
+
+  # Title suffix that shown at the end of page title
+  mattr_accessor :title_suffix
+  @@title_suffix = ->{ Rails.application.name }
+
+  # Default heading size (h1 by default)
+  mattr_accessor :default_heading_size
+  @@default_heading_size = :h1
+
+  def self.configure
+    yield self
+  end
+
+  require 'heading_with_title/railtie' if defined?(Rails)
+end

data/spec/heading_with_title/helpers_spec.rb

@@ -0,0 +1,52 @@
+# encoding: utf-8
+require "heading_with_title"
+
+describe HeadingWithTitle::Helpers do
+  include ActionView::Helpers
+  include HeadingWithTitle::Helpers
+
+  before { Rails.stub_chain(:application, :name).and_return('AwesomeApp') }
+
+  describe '.page_title' do
+    it 'sets a page title' do
+      page_title('Something')
+      page_title.should == 'Something / AwesomeApp'
+    end
+
+    it 'respects delimeter' do
+      HeadingWithTitle.title_delimeter = ' - '
+      page_title('Something')
+      page_title.should == 'Something - AwesomeApp'
+    end
+
+    it 'returns nil when set an page title' do
+      page_title('Something').should be_nil
+    end
+  end
+
+  describe '.heading_with_title' do
+    before { HeadingWithTitle.title_delimeter = ' / ' }
+
+    it 'renders default h1 heading' do
+      heading_with_title('Users').should == '<h1>Users</h1>'
+    end
+
+    it 'sets an page title' do
+      heading_with_title('Users')
+      page_title.should == 'Users / AwesomeApp'
+    end
+
+    it 'applies block' do
+      result = heading_with_title 'Users' do |heading|
+        "<span>" + heading + "</span>"
+      end
+
+      result.should == '<h1><span>Users</span></h1>'
+    end
+
+    it 'respects heading size' do
+      HeadingWithTitle.default_heading_size = :h2
+      heading_with_title('Users').should == '<h2>Users</h2>'
+    end
+  end
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: heading_with_title
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Andrew Kozloff
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Setting the page heading at the same time with a page title
+email:
+- demerest@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- MIT-LICENSE.txt
+- README.md
+- Rakefile
+- heading_with_title.gemspec
+- lib/heading_with_title.rb
+- lib/heading_with_title/helpers.rb
+- lib/heading_with_title/railtie.rb
+- lib/heading_with_title/version.rb
+- spec/heading_with_title/helpers_spec.rb
+homepage: https://github.com/rocsci/heading_with_title
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A set of helpers for Rails
+test_files:
+- spec/heading_with_title/helpers_spec.rb