happy-titles 1.1.0 → 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e55eb24dd98e18091d559700c94b1f7f783e1cd6
+  data.tar.gz: c3bcccda638ac02278d45a779ff738342d6c9528
+SHA512:
+  metadata.gz: 530e81bf21dbbfc1fc32e0e5e267ea55d1037418b1220d5c83b5d5b5ac2023d0403ee84133bb77ba50a149676ea000e384d9fccd4c92406eac82cee11be71ff5
+  data.tar.gz: fdc55cd7ee3c33cc35979c876d47a7b1a1b237509eba57699478ea1a0137596e5e7abd3c7a3fb0706cfc72bac27ad7c3a932ba83207d423e2de9715cc966bd6d

data/.gitignore

@@ -0,0 +1,4 @@
+.DS_Store
+pkg
+
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,56 @@
+AllCops:
+  TargetRubyVersion: 2.3
+
+  # Output settings
+  DisplayCopNames: true
+  DisplayStyleGuide: true
+
+# Don't enforce comments classes
+Documentation:
+  Enabled: false
+
+# More flexible array alignment
+Style/IndentArray:
+  EnforcedStyle: consistent
+
+# More flexible hash alignment
+Style/IndentHash:
+  EnforcedStyle: consistent
+
+Metrics/AbcSize:
+  Exclude:
+    - 'spec/**/*'
+
+# Disable class length check for tests
+Metrics/ClassLength:
+  Exclude:
+    - 'spec/**/*'
+
+# Disable method length check for tests
+Metrics/MethodLength:
+  Exclude:
+    - 'spec/**/*'
+
+# 120 character width
+Metrics/LineLength:
+  Max: 120
+  Exclude:
+    - 'spec/**/*'
+
+# Allow method names starting with 'get_'
+Style/AccessorMethodName:
+  Enabled: false
+
+# Allow non-ascii characters in comments - e.g. the 'em' dash
+Style/AsciiComments:
+  Enabled: false
+
+# Prefer double quotes
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+# Ignore incorrectly named file
+# It's too much work to rename the gem now :(
+Style/FileName:
+  Exclude:
+    - 'lib/happy-titles.rb'

data/.ruby-version

@@ -0,0 +1 @@
+2.3.0

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in happy-titles.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,110 @@
+PATH
+  remote: .
+  specs:
+    happy-titles (2.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (4.2.5.2)
+      actionview (= 4.2.5.2)
+      activesupport (= 4.2.5.2)
+      rack (~> 1.6)
+      rack-test (~> 0.6.2)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (4.2.5.2)
+      activesupport (= 4.2.5.2)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    activesupport (4.2.5.2)
+      i18n (~> 0.7)
+      json (~> 1.7, >= 1.7.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    ast (2.2.0)
+    builder (3.2.2)
+    diff-lcs (1.2.5)
+    erubis (2.7.0)
+    i18n (0.7.0)
+    json (1.8.3)
+    loofah (2.0.3)
+      nokogiri (>= 1.5.9)
+    mini_portile2 (2.0.0)
+    minitest (5.8.4)
+    nokogiri (1.6.7.2)
+      mini_portile2 (~> 2.0.0.rc2)
+    parser (2.3.0.7)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    rack (1.6.4)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.7)
+      activesupport (>= 4.2.0.beta, < 5.0)
+      nokogiri (~> 1.6.0)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.3)
+      loofah (~> 2.0)
+    railties (4.2.5.2)
+      actionpack (= 4.2.5.2)
+      activesupport (= 4.2.5.2)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rainbow (2.1.0)
+    rake (10.5.0)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.3)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-html-matchers (0.7.1)
+      nokogiri (~> 1)
+      rspec (>= 3.0.0.a, < 4)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-rails (3.4.2)
+      actionpack (>= 3.0, < 4.3)
+      activesupport (>= 3.0, < 4.3)
+      railties (>= 3.0, < 4.3)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    rubocop (0.38.0)
+      parser (>= 2.3.0.6, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.7.5)
+    thor (0.19.1)
+    thread_safe (0.3.5)
+    tzinfo (1.2.2)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.0.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.11)
+  happy-titles!
+  rake (~> 10.5)
+  rspec-html-matchers (~> 0.7)
+  rspec-rails (~> 3.4)
+  rubocop (~> 0.38.0)
+
+BUNDLED WITH
+   1.11.2

data/README.md

@@ -0,0 +1,190 @@
+# happy-titles
+
+A simple (and cheerful) way to handle page titles in your layouts.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'happy-titles'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install happy-titles
+
+
+## Usage
+
+### Setting up default values
+
+Create a new file in `config/initializers` called `happy_titles.rb` or something else which makes sense!
+
+In this new file, add the following lines to set the default site and tagline.
+
+```ruby
+HappyTitles.configure do |config|
+  config.site = "Your Site"
+  config.tagline = "Your witty but informative tagline"
+end
+```
+
+
+### Update your layout
+
+In the layout where you want to display your title add the following call to the Happy Titles helper method.
+
+```
+<%= page_title %>
+```
+
+The header element of your layout might end up looking something like:
+
+```html
+<head>
+  <meta http-equiv="Content-type" content="text/html; charset=utf-8" />
+  <%= page_title %>
+</head>
+```
+
+Notice you don't need to wrap the helper in a `<title>` element, this is done for you.
+
+
+### Set the title in your views
+
+In each of your views call the `title` method to set the title for that page.
+
+```
+<% title 'Your very first Happy Title!' %>
+```
+
+### See your titles!
+
+Given the above settings, let's have a look at the output you will receive when you call the `page_title` method in your layouts.
+
+On pages where the title has not been set you will see...
+
+```html
+<title>Your Site | Your witty but informative tagline</title>
+```
+
+...and on pages where the title _has_ been set you will see...
+
+```html
+<title>Your very first Happy Title! | Your Site</title>
+```
+
+That really is all there is to setting up and using Happy Titles!
+
+
+## Customising the Title Templates
+
+### Intro
+
+You have already seen how to set up and use Happy Titles, now let's take a look at how to customise the individual title templates.
+
+In all of the following examples I am going to assume the same defaults that are set up in the Set the Defaults section of this README.
+
+Before we have a look at that, let's have a look at the **placeholders** you can use. These placeholders will be replaced with the real content when the title is rendered.
+
+| Placeholder | Example                                                                                   |
+|:------------|:------------------------------------------------------------------------------------------|
+| :site       | "Your Site"                                                                               |
+| :tagline    | "Your witty but informative tagline"                                                      |
+| :title      | Will become "Your very first Happy Title!" or `:tagline` if a page title has not been set |
+
+Now let's have a look at the default templates.
+
+| Template            | Description                                                                               |
+|:--------------------|:------------------------------------------------------------------------------------------|
+| :site &#124; :title | Is used when there is no title set: "Your Site &#124; Your witty but informative tagline" |
+| :title &#124; :site | Is used when there *is* a title set: "Your very first Happy Title! &#124; Your Site"      |
+
+You can change the default templates by using the following setting in `config/initializers/happy_titles.rb`
+
+```ruby
+HappyTitles.configure do |config|
+  config.templates do
+    # The second param is the template to use when there is no title set
+    # The third param is the template to use when there is a title set
+    default "[:site]", "[:site] :title"
+  end
+end
+```
+
+Then when you render your titles you will see the following
+
+```html
+<title>[Your Site]</title> <!-- when there is no title -->
+<title>[Your Site] Your very first Happy Title!</title> <!-- when the title is set -->
+```
+
+
+### Adding Additional Templates
+
+As well as changing the default template, you can also add new templates and then use those when you need a different title format in a different layout.
+
+In `config/initializers/happy_titles.rb`:
+
+```ruby
+HappyTitles.configure do |config|
+  config.templates do
+    extra "++ :site ++", "++ :site ++ :title ++"
+  end
+end
+```
+
+Then in your layout, you can use the following to call the extra template.
+
+```
+<%= page_title :extra %>
+```
+
+And you will get the following output, as you probably would've guessed by now!
+
+```html
+<title>++ Your Site ++</title> <!-- when there is no title -->
+<title>++ Your Site ++ Your very first Happy Title! ++</title> <!-- when the title is set -->
+```
+
+You can add as many additional title templates as you need!
+
+One final thing to mention, you can create templates that just have one format. So...
+
+In `config/initializers/happy_titles.rb`:
+
+```ruby
+HappyTitles.configure do |config|
+  config.templates do
+    single ":site (:title)"
+  end
+end
+```
+
+In your layout:
+
+```
+<%= page_title :single %>
+```
+
+The output:
+
+```html
+<title>Your Site (Your witty but informative tagline)</title> <!-- when there is no title -->
+<title>Your Site (Your very first Happy Title!)</title> <!-- when the title is set -->
+```
+
+
+## Contributing
+
+1. Fork it ( https://github.com/andypearson/happy-titles/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/RELEASE.md

@@ -0,0 +1,11 @@
+# Releasing
+
+These are steps for the maintainer to take to release a new version of this gem. Copied without mercy from [JacobEvelyn/friends](https://github.com/JacobEvelyn/friends).
+
+1. On the `master` branch, update the `VERSION` constant in
+`lib/happy-titles/version.rb`.
+2. Commit the change (`git add -A && git commit -m 'Bump to vX.X.X'`).
+3. Add a tag (`git tag -am "vX.X.X" vX.X.X`).
+4. `git push && git push --tags`
+5. `gem build happy-titles.gemspec && gem push *.gem && rm *.gem`
+6. Celebrate!

data/Rakefile

@@ -1,23 +1,2 @@
-require 'rubygems'
-require 'rake'
-require 'rspec/core/rake_task'
-
-desc 'Test the happy-titles plugin.'
-RSpec::Core::RakeTask.new('spec') do |t|
-  t.pattern = FileList['spec/*_spec.rb']
-  t.rspec_opts = ['-c']
-end
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gemspec|
-    gemspec.name = "happy-titles"
-    gemspec.summary = "A simple way to handle page titles in your layouts."
-    gemspec.email = "andy@andy-pearson.com"
-    gemspec.homepage = "http://github.com/andypearson/happy-titles"
-    gemspec.authors = ["Andy Pearson"]
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler not available. Install it with: gem install jeweler"
-end
+# frozen_string_literal: true
+require "bundler/gem_tasks"

data/TODO.md

@@ -0,0 +1,3 @@
+# TODO
+
+- [x] Setup Rubocop

data/happy-titles.gemspec

@@ -1,50 +1,27 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
-# -*- encoding: utf-8 -*-
+# coding: utf-8
+# frozen_string_literal: true
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "happy-titles/version"
 
-Gem::Specification.new do |s|
-  s.name = %q{happy-titles}
-  s.version = "1.1.0"
+Gem::Specification.new do |spec|
+  spec.name          = "happy-titles"
+  spec.version       = HappyTitles::VERSION
+  spec.authors       = ["Andy Pearson"]
+  spec.email         = ["andy@andy-pearson.com"]
+  spec.summary       = "A simple way to handle page titles in your layouts."
+  spec.description   = "A simple way to handle page titles in your layouts."
+  spec.homepage      = "https://github.com/andypearson/happy-titles"
+  spec.license       = "MIT"
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Andy Pearson"]
-  s.date = %q{2011-05-07}
-  s.email = %q{andy@andy-pearson.com}
-  s.extra_rdoc_files = [
-    "README.markdown"
-  ]
-  s.files = [
-    ".git_ignore",
-    "MIT-LICENCE",
-    "README.markdown",
-    "Rakefile",
-    "VERSION",
-    "happy-titles.gemspec",
-    "init.rb",
-    "lib/happy-titles.rb",
-    "lib/happy-titles/railtie.rb",
-    "rails/init.rb",
-    "spec/happy_titles_spec.rb",
-    "spec/spec_helper.rb"
-  ]
-  s.homepage = %q{http://github.com/andypearson/happy-titles}
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
-  s.summary = %q{A simple way to handle page titles in your layouts.}
-  s.test_files = [
-    "spec/happy_titles_spec.rb",
-    "spec/spec_helper.rb"
-  ]
+  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"]
 
-  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
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.5"
+  spec.add_development_dependency "rspec-html-matchers", "~> 0.7"
+  spec.add_development_dependency "rspec-rails", "~> 3.4"
+  spec.add_development_dependency "rubocop", "~> 0.38.0"
 end
-