middleman-title 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8890ac07e237420852ff05324a82f3b437eb00f4
+  data.tar.gz: ca350f34ed2c92bfaaaf26118b9c9d79d438fd18
+SHA512:
+  metadata.gz: cafb5818c7b23d812ae006102612d9a2822f587924b65c2505d908d3dda7b7ba7189be29917850c69a262ad94a9d246f337404de0d2dda9e5f9b5ed02ff368f9
+  data.tar.gz: d09d8e9543b8a1b56fe0f353bf8c4c518f026f21ea2b7d1d4297c76ee52440dd885a505ed56c9ad841de3432d529137eaead0e5879aec0046216920624ec2a46

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.travis.yml

@@ -0,0 +1,6 @@
+rvm:
+- 1.9.3
+- 2.0.0
+- 2.1.0
+
+script: 'bundle exec rspec'

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,76 @@
+PATH
+  remote: .
+  specs:
+    middleman-title (0.0.1)
+      middleman-core (~> 3.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.0.5)
+      i18n (~> 0.6, >= 0.6.9)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    diff-lcs (1.2.5)
+    erubis (2.7.0)
+    ffi (1.9.3)
+    hooks (0.4.0)
+      uber (~> 0.0.4)
+    i18n (0.6.9)
+    listen (1.3.1)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+      rb-kqueue (>= 0.2)
+    middleman-core (3.3.2)
+      activesupport (~> 4.0.1)
+      bundler (~> 1.1)
+      erubis
+      hooks (~> 0.3)
+      i18n (~> 0.6.9)
+      listen (~> 1.1)
+      padrino-helpers (~> 0.12.1)
+      rack (>= 1.4.5, < 2.0)
+      rack-test (~> 0.6.2)
+      thor (>= 0.15.2, < 2.0)
+      tilt (~> 1.4.1, < 2.0)
+    minitest (4.7.5)
+    multi_json (1.10.0)
+    padrino-helpers (0.12.2)
+      i18n (~> 0.6, >= 0.6.7)
+      padrino-support (= 0.12.2)
+      tilt (~> 1.4.1)
+    padrino-support (0.12.2)
+      activesupport (>= 3.1)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rake (10.3.1)
+    rb-fsevent (0.9.4)
+    rb-inotify (0.9.4)
+      ffi (>= 0.5.0)
+    rb-kqueue (0.2.2)
+      ffi (>= 0.5.0)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.8)
+    rspec-expectations (2.14.5)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.6)
+    thor (0.19.1)
+    thread_safe (0.3.3)
+    tilt (1.4.1)
+    tzinfo (0.3.39)
+    uber (0.0.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.6)
+  middleman-title!
+  rake (~> 10.3, >= 10.3.1)
+  rspec (~> 2.14, >= 2.14.1)

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Justin Cypret
+
+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,82 @@
+
+# Middleman Title
+[![Build Status](https://travis-ci.org/jcypret/middleman-title.svg?branch=master)](https://travis-ci.org/jcypret/middleman-title)
+
+This Middleman extension allows you to easily set page titles for your website.
+
+## Setup
+Add the following line to `Gemfile`, then run `bundle install`:
+
+    gem 'middleman-title'
+
+After installation, activate the extension in `config.rb`:
+
+    activate :title, site: 'Your Website Name', separator: ' — '
+
+*The separator is optional and will default to a dash.*
+
+
+## Setting Title and Adding to Layout
+
+In your layout file, you can use the `page_title` helper to output the current page title:
+
+    <title><%= page_title %></title>
+
+Then, add a page `title` to the Frontmatter any page:
+
+    ---
+    title: The title of this page goes here
+    ---
+
+This would output:
+
+    The title of this page goes here — Your Website Name
+
+
+## Outputting Website Name First
+
+Sometimes it is desirable to put the website name first, such as on the home page. This can be done by setting `title_reverse` to `true` in the frontmatter of the page.
+
+    ---
+    title: The title of this page goes here
+    title_reverse: true
+    ---
+
+This would output:
+
+    Your Website Name — The title of this page goes here
+
+You can also put the website name first on every page by setting it when you activate the extension:
+
+    activate :title, site: 'Your Website Name', reverse: true
+
+Then on any page where you want the website name to come last, you can set `title_reverse` to false in the Frontmatter:
+
+    ---
+    title: The title of this page goes here
+    title_reverse: false
+    ---
+
+
+## Multi-level Page Titles
+
+When your website has heirachy, it is sometimes desirable to have multiple parts to the title. This can be done by passing an array in the Frontmatter:
+
+    ---
+    title:
+    - John Doe
+    - Staff
+    ---
+
+This would output:
+
+    John Doe — Staff — Your Website Name
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/middleman-title/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler/gem_tasks'
+

data/lib/middleman-title.rb

@@ -0,0 +1,6 @@
+require 'middleman-core'
+
+::Middleman::Extensions.register(:title) do
+  require 'middleman-title/extension'
+  ::Middleman::Title
+end

data/lib/middleman-title/extension.rb

@@ -0,0 +1,18 @@
+require 'middleman-title/helpers'
+
+module Middleman
+  module Title
+    class << self
+
+      def registered(app, options_hash = {}, &block)
+        app.helpers Helpers
+        @@options = options_hash
+      end
+
+      def options
+        @@options
+      end
+
+    end
+  end
+end

data/lib/middleman-title/helpers.rb

@@ -0,0 +1,67 @@
+module Middleman
+  module Title
+    module Helpers
+
+      def page_title
+        title = []
+        title = add_page_name_to_title(title)
+        title = add_website_name_to_title(title)
+        title.compact.join(title_separator)
+      end
+
+      private
+        def options
+          Title.options
+        end
+
+        def website_name
+          current_page.data.title_site || options[:site]
+        end
+
+        def title_separator
+          options[:separator] || ' — '
+        end
+
+        def title_reverse
+          if current_page.data.title_reverse == false
+            false
+          else
+            current_page.data.title_reverse || options[:reverse]
+          end
+        end
+
+        def page_name
+          page_name = current_page.data.title
+
+          if page_name.is_a? Array
+            page_name = page_name.join(title_separator)
+          end
+
+          page_name
+        end
+
+        def add_website_name_to_title(title)
+          if current_page.data.title_site == false || website_name.nil?
+            title
+          elsif website_name_first?
+            title.unshift(website_name)
+          else
+            title << website_name
+          end
+        end
+
+        def add_page_name_to_title(title)
+          title << page_name
+        end
+
+        def website_name_first?
+          title_reverse
+        end
+
+        def hide_website_name?
+          current_page.data.title_site == false
+        end
+
+    end
+  end
+end

data/lib/middleman-title/version.rb

@@ -0,0 +1,5 @@
+module Middleman
+  module Title
+    VERSION = '0.0.1'
+  end
+end

data/lib/middleman_extension.rb

@@ -0,0 +1 @@
+require 'middleman-title'

data/middleman-title.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'middleman-title/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'middleman-title'
+  spec.version       = Middleman::Title::VERSION
+  spec.authors       = ['Justin Cypret']
+  spec.email         = ['jcypret@gmail.com']
+  spec.summary       = 'A Middleman extension for setting the page title'
+  spec.description   = 'A Middleman extension for setting the page title'
+  spec.homepage      = 'https://github.com/jcypret/middleman-title'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'middleman-core', '~> 3.2'
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake', '~> 10.3', '>= 10.3.1'
+  spec.add_development_dependency 'rspec', '~> 2.14', '>= 2.14.1'
+end

data/spec/extension_spec.rb

@@ -0,0 +1,93 @@
+require 'spec_helper'
+
+describe Middleman::Title::Helpers do
+  let(:h) { Class.new { extend Middleman::Title::Helpers } }
+
+  describe '#page_title' do
+    before(:each) do
+      h.stub_chain(:current_page, :data, :title).and_return(nil)
+      h.stub_chain(:current_page, :data, :title_site).and_return(nil)
+      h.stub_chain(:current_page, :data, :title_reverse).and_return(nil)
+    end
+
+    context 'website name is set' do
+      before(:each) { h.stub(:options) { { site: 'Website Name' } } }
+
+      context 'page name is set' do
+        before(:each) { h.stub_chain(:current_page, :data, :title).and_return('How to Say Hello to the World') }
+
+        it 'puts website name last by default' do
+          expect(h.page_title).to eq 'How to Say Hello to the World — Website Name'
+        end
+
+        it 'puts website name first when frontmatter title_reverse is true' do
+          h.stub_chain(:current_page, :data, :title_reverse).and_return(true)
+          expect(h.page_title).to eq 'Website Name — How to Say Hello to the World'
+        end
+
+        it 'puts website name last when frontmatter title_reverse is false' do
+          h.stub_chain(:current_page, :data, :title_reverse).and_return(false)
+          expect(h.page_title).to eq 'How to Say Hello to the World — Website Name'
+        end
+
+        it 'puts website name first when activate reverse is true' do
+          h.stub(:options) { { site: 'Website Name', reverse: true } }
+          expect(h.page_title).to eq 'Website Name — How to Say Hello to the World'
+        end
+
+        it 'puts website name last when activate reverse is true but frontmatter is false' do
+          h.stub(:options) { { site: 'Website Name', reverse: true } }
+          h.stub_chain(:current_page, :data, :title_reverse).and_return(false)
+          expect(h.page_title).to eq 'How to Say Hello to the World — Website Name'
+        end
+
+        context 'separator is set' do
+          it 'to a vertical bar' do
+            h.stub(:options) { { site: 'Website Name', separator: ' | ' } }
+            expect(h.page_title).to eq 'How to Say Hello to the World | Website Name'
+          end
+        end
+
+        context 'but website name set to false in frontmatter' do
+          it 'returns only page name' do
+            h.stub_chain(:current_page, :data, :title_site).and_return(false)
+            expect(h.page_title).to eq 'How to Say Hello to the World'
+          end
+        end
+
+        context 'page name is an array' do
+          it 'joins page name with separator' do
+            h.stub_chain(:current_page, :data, :title).and_return(['John Doe', 'Staff'])
+            expect(h.page_title).to eq 'John Doe — Staff — Website Name'
+          end
+        end
+      end
+
+      context 'page name is not set' do
+        it 'returns only the website name' do
+          expect(h.page_title).to eq 'Website Name'
+        end
+      end
+    end
+
+    context 'website name is not set' do
+      before(:each) { h.stub(:options) { {} } }
+
+      context 'page name is set' do
+        before(:each) { h.stub_chain(:current_page, :data, :title).and_return('How to Say Hello to the World') }
+
+        it 'returns only the page name' do
+          expect(h.page_title).to eq 'How to Say Hello to the World'
+        end
+      end
+
+      context 'page name is not set' do
+        it 'returns an empty string' do
+          expect(h.page_title).to eq ''
+        end
+      end
+
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'middleman-title/extension'
+
+RSpec.configure do |config|
+  # some (optional) config here
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: middleman-title
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Justin Cypret
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: middleman-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.3.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.3.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+description: A Middleman extension for setting the page title
+email:
+- jcypret@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- Rakefile
+- lib/middleman-title.rb
+- lib/middleman-title/extension.rb
+- lib/middleman-title/helpers.rb
+- lib/middleman-title/version.rb
+- lib/middleman_extension.rb
+- middleman-title.gemspec
+- spec/extension_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/jcypret/middleman-title
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A Middleman extension for setting the page title
+test_files:
+- spec/extension_spec.rb
+- spec/spec_helper.rb