happy-titles 1.1.0 → 2.0.0

data/spec/lib/template_spec.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+describe HappyTitles::Template do
+  subject do
+    described_class.new(
+      name: name,
+      with_title: with_title,
+      without_title: without_title
+    )
+  end
+
+  let(:name) { :my_template }
+  let(:with_title) { ":title | :site" }
+  let(:without_title) { ":site | :tagline" }
+
+  it "has a name" do
+    expect(subject.name).to eq(:my_template)
+  end
+
+  context "When name is a string" do
+    let(:name) { "my_template" }
+
+    it "changes the name to a symbol" do
+      expect(subject.name).to eq(:my_template)
+    end
+  end
+
+  describe "Rendering the template" do
+    let(:render) { subject.render(**options) }
+
+    let(:title) { nil }
+    let(:options) do
+      {
+        title: title,
+        site: "My site",
+        tagline: "My tagline"
+      }
+    end
+
+    it "renders without a title" do
+      expect(render).to eq("My site | My tagline")
+    end
+
+    context "When the title is set" do
+      let(:title) { "My title" }
+
+      it "renders with a title" do
+        expect(render).to eq("My title | My site")
+      end
+    end
+
+    context "when the template only has a single format" do
+      let(:with_title) { nil }
+      let(:without_title) { ":site (:title)" }
+
+      it "renders with a title" do
+        expect(render).to eq("My site (My tagline)")
+      end
+
+      context "When the title is set" do
+        let(:title) { "My title" }
+
+        it "renders with a title" do
+          expect(render).to eq("My site (My title)")
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,25 +1,72 @@
-# coding: utf-8
-require 'rubygems'
+# frozen_string_literal: true
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 
-gem 'activesupport', '~> 3.0'
-gem 'actionpack', '~> 3.0'
-require 'active_support'
-require 'action_pack'
-require 'action_view'
-require 'action_controller'
+require "rubygems"
+require "bundler/setup"
 
-gem 'rspec', '~> 2.5'
-gem 'rspec-rails', '~> 2.5'
-gem 'hpricot', '>= 0.6.1'
-gem 'rspec_tag_matchers', '>= 1.0.0'
-require 'rspec_tag_matchers'
+require "rails/all"
+require "rspec/rails"
+require "rspec-html-matchers"
+require "fake_app"
 
-require File.join(File.dirname(__FILE__), "../lib/happy-titles")
+require "happy-titles"
+
+FakeApp::Application.initialize!
 
 RSpec.configure do |config|
-  config.include(RspecTagMatchers)
-end
+  config.include(RSpecHtmlMatchers)
+
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
 
-ActionView::Base.class_eval do
-  include HappyTitles
-end
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  config.after(:each) do
+    reset_config
+  end
+
+  def reset_config
+    HappyTitles.remove_instance_variable(:@config) if HappyTitles.instance_variable_defined?(:@config)
+  end
+end

metadata

@@ -1,79 +1,148 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: happy-titles
-version: !ruby/object:Gem::Version 
-  hash: 19
-  prerelease: false
-  segments: 
-  - 1
-  - 1
-  - 0
-  version: 1.1.0
+version: !ruby/object:Gem::Version
+  version: 2.0.0
 platform: ruby
-authors: 
+authors:
 - Andy Pearson
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-05-07 00:00:00 +01:00
-default_executable: 
-dependencies: []
-
-description: 
-email: andy@andy-pearson.com
+date: 2016-03-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.5'
+- !ruby/object:Gem::Dependency
+  name: rspec-html-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.38.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.38.0
+description: A simple way to handle page titles in your layouts.
+email:
+- andy@andy-pearson.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- README.markdown
-files: 
-- .git_ignore
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
 - MIT-LICENCE
-- README.markdown
+- README.md
+- RELEASE.md
 - Rakefile
-- VERSION
+- TODO.md
 - happy-titles.gemspec
-- init.rb
 - lib/happy-titles.rb
+- lib/happy-titles/config.rb
+- lib/happy-titles/helpers.rb
 - lib/happy-titles/railtie.rb
-- rails/init.rb
-- spec/happy_titles_spec.rb
+- lib/happy-titles/template.rb
+- lib/happy-titles/template_set.rb
+- lib/happy-titles/version.rb
+- spec/fake_app.rb
+- spec/lib/config_spec.rb
+- spec/lib/happy_titles_spec.rb
+- spec/lib/helpers_spec.rb
+- spec/lib/template_set_spec.rb
+- spec/lib/template_spec.rb
 - spec/spec_helper.rb
-has_rdoc: true
-homepage: http://github.com/andypearson/happy-titles
-licenses: []
-
+homepage: https://github.com/andypearson/happy-titles
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  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
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 2.5.1
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A simple way to handle page titles in your layouts.
-test_files: 
-- spec/happy_titles_spec.rb
+test_files:
+- spec/fake_app.rb
+- spec/lib/config_spec.rb
+- spec/lib/happy_titles_spec.rb
+- spec/lib/helpers_spec.rb
+- spec/lib/template_set_spec.rb
+- spec/lib/template_spec.rb
 - spec/spec_helper.rb
+has_rdoc: 

data/.git_ignore

@@ -1 +0,0 @@
-.DS_Store

data/README.markdown

@@ -1,153 +0,0 @@
-# Happy Titles!
-
-A simple (and cheerful) way to handle page titles in your layouts.
-
-## Getting Started
-
-### Install the Gem
-
-#### In Rails 3
-
-Add the following to your Gemfile
-    
-    gem 'happy-titles'
-
-#### In Rails 2
-
-Run the following:
-
-	sudo gem install happy-titles
-	
-And add it to your environment.rb configuration as a gem dependency:
-
-	config.gem "happy-titles", :lib => 'happy_titles'
-	
-### Set the Defaults
-
-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.
-
-	ActionView::Base.happy_title_setting(:site, 'Your Site')
-	ActionView::Base.happy_title_setting(:tagline, 'Your witty but informative tagline')
-	
-### Update your Layout
-
-In the layout where you want to display your title add the following call to the Happy Titles helper method.
-
-	<%= happy_title %>
-	
-The header element of your layout might end up looking something like:
-
-	<head>
-		<meta http-equiv="Content-type" content="text/html; charset=utf-8" />
-		<%= happy_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 `happy_title` method in your layouts.
-
-On pages where the title has not been set you will see...
-
-	<title>Your Site | Your witty but informative tagline</title>
-	
-...and on pages where the title _has_ been set you will see...
-
-	<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.
-
-	: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.
-
-	':site | :title'	-> Is used when there is no title set: 'Your Site | Your witty but informative tagline'
-	':title | :site'	-> Is used when there IS a title set: 'Your very first Happy Title! | Your Site'
-	
-You can change the default templates by using the following setting in `config/initializers/happy_titles.rb`
-
-	# The first param sets the name of the template and takes a symbol
-	# 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
-	ActionView::Base.happy_title_template(:default, '[:site]', '[:site] :title')
-
-Then when you render your titles you will see the following
-
-	<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.
-	
-	# config/initializers/happy_titles.rb
-	ActionView::Base.happy_title_template(:extra, '++ :site ++', '++ :site ++ :title ++')
-
-Then in your layout, you can use the following to call the extra template.
-
-	<%= happy_title :extra %>
-	
-And you will get the following output, as you probably would of guessed by now!
-
-	<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...
-
-	# config/initializers/happy_titles.rb
-	ActionView::Base.happy_title_template(:single, ':site (:title)')
-	
-	# In your layout
-	<%= happy_title :single %>
-	
-	# Output
-	<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 -->
-	
-
-## Other Things...
-
-### Why Use Happy Titles?
-
-Happy Titles is a simple way to use multiple title formats in the same app. In my case, the app I was working on at the time required different title formats for public and private pages, and this is the best way I could think of managing that requirement in a suitably DRY fashion.
-
-### Why on earth is it called Happy Titles?
-
-What can I say, I was in a good mood when I started writing the plugin and I couldn't think of anything better to call it!
-
-### Inspiration and Thanks
-
-When it came to actually writing the plugin I studied the [Headliner plugin][hl] to see how that was done and got some ideas on how to set up my specs. I also want to thank [Justin French][jf] for his help when I created some small patches for his [Formtastic][ft] plugin. He made me realise that even though I don't have a lot of experience I can still help out the open source community. Please take a look at [Formtastic][ft] for a great way to make semantic forms really easy in Rails. Thanks also to all the clever chaps working on GitHub, I don't think I would of ever had the oomph to release this if GitHub wasn't here to make it so wonderfully easy and fun!
-
-### Please give me some feedback
-
-This plugin was written as an experiment and a learning experience. I am a relative newcomer to the world of Ruby, Rails and Github so if you have 5 Minutes to skim read the code and maybe suggest something I could do better in the future then please leave a comment and I will be very grateful of the feedback, thanks in advance!
-
-
-[hl]: http://github.com/mokolabs/headliner/tree/master "mokolabs Headliner on GitHub"
-[jf]: http://justinfrench.com/ "Justin French"
-[ft]: http://github.com/justinfrench/formtastic/tree/master "justinfrench Formtastic on GitHub"