happy-titles 1.1.0 → 2.0.0

data/lib/happy-titles.rb

@@ -1,79 +1,19 @@
-require File.join(File.dirname(__FILE__), *%w[happy-titles railtie]) if defined?(::Rails::Railtie)
+# frozen_string_literal: true
+require "happy-titles/railtie" if defined?(::Rails::Railtie)
+
+require "happy-titles/config"
+require "happy-titles/helpers"
+require "happy-titles/template"
+require "happy-titles/template_set"
 
 module HappyTitles
-  
-  attr_accessor :page_title
-  
-  @@happy_title_settings = {
-    :site => 'My Site',
-    :tagline => 'My short, descriptive and witty tagline',
-    :templates => {
-      :default => [':site | :title', ':title | :site']
-    }
-  }
-  
-  def happy_title(template_key = :default)
-    content_tag(:title, render_title_template(template_key))
-  end
-  
-  def title(page_title = nil, settings = {})
+  class TemplateNotFound < StandardError; end
 
-    if page_title && page_title.is_a?(Hash)
-      settings = page_title
-      page_title = settings[:title] ? settings[:title] : nil
-    end
-    
-    @happy_title_settings = settings
-    if page_title
-      @page_title = h(page_title.gsub(/<\/?[^>]*>/, '')) if page_title
-    else
-      @page_title || ''
-    end
-    
+  def self.config
+    @config ||= Config.new
   end
-  
-  def self.included(base)
-    base.class_eval do
-      
-      cattr_accessor :happy_title_settings
-
-      def self.happy_title_template(template_key, format, additional_format = nil)
-        template = [format]
-        template << additional_format if additional_format
-        @@happy_title_settings[:templates][template_key] = template
-      end
 
-      def self.happy_title_setting(key, value)
-        @@happy_title_settings[key] = value
-      end
-      
-    end
+  def self.configure
+    yield config
   end
-  
-  private
-    
-    def render_title_template(template_key)
-      key = (@page_title && @@happy_title_settings[:templates][template_key][1]) ? 1 : 0
-      template = read_happy_title_setting(:template) ? read_happy_title_setting(:template) : @@happy_title_settings[:templates][template_key][key]
-      substitute_placeholders(template)
-    end
-    
-    def substitute_placeholders(template)
-      title = template
-      title = title.gsub(':title', title_text)
-      title = title.gsub(':site', read_happy_title_setting(:site))
-      title = title.gsub(':tagline', read_happy_title_setting(:tagline))
-    end
-    
-    def read_happy_title_setting(key)
-      setting = @@happy_title_settings[key]
-      setting = @happy_title_settings[key] if @happy_title_settings && !@happy_title_settings[key].blank?
-      setting = setting.call if setting.is_a?(Proc)
-      setting
-    end
-    
-    def title_text
-      (@page_title) ? @page_title : read_happy_title_setting(:tagline)
-    end
-    
-end
+end

data/lib/happy-titles/config.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+module HappyTitles
+  class Config
+    attr_accessor :site, :tagline
+
+    def initialize
+      @site = DEFAULT_SITE
+      @tagline = DEFAULT_TAGLINE
+      @template_set = HappyTitles::TemplateSet.new(default_template)
+    end
+
+    def template(key = :default)
+      template_set.get(key)
+    end
+
+    def templates(&block)
+      template_set.instance_eval(&block)
+    end
+
+    private
+
+    DEFAULT_SITE = "My site"
+    DEFAULT_TAGLINE = "My short, descriptive and witty tagline"
+
+    DEFAULT_TEMPLATE_OPTIONS = {
+      name: :default,
+      with_title: ":title | :site",
+      without_title: ":site | :tagline"
+    }.freeze
+
+    attr_reader :template_set
+
+    def default_template
+      HappyTitles::Template.new(**DEFAULT_TEMPLATE_OPTIONS)
+    end
+  end
+end

data/lib/happy-titles/helpers.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+module HappyTitles
+  module Helpers
+    def title(title = nil)
+      if title
+        @happy_titles_page_title = title
+      else
+        @happy_titles_page_title
+      end
+    end
+
+    def page_title(key = nil)
+      content_tag(:title, render_happy_titles_template(key))
+    end
+
+    private
+
+    def render_happy_titles_template(key)
+      templete = key ? HappyTitles.config.template(key) : HappyTitles.config.template
+
+      templete.render(
+        title: @happy_titles_page_title,
+        site: HappyTitles.config.site,
+        tagline: HappyTitles.config.tagline
+      )
+    end
+  end
+end

data/lib/happy-titles/railtie.rb

@@ -1,10 +1,11 @@
-require 'happy-titles'
-require 'rails'
+# frozen_string_literal: true
+require "happy-titles"
+require "rails"
 
 module HappyTitles
   class Railtie < Rails::Railtie
-    initializer 'happy-titles.initialize', :after => :after_initialize do
-      ActionView::Base.send :include, HappyTitles
+    initializer "happy-titles.initialize" do
+      ActionView::Base.send :include, HappyTitles::Helpers
     end
   end
-end
+end

data/lib/happy-titles/template.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+module HappyTitles
+  class Template
+    attr_reader :name
+
+    def initialize(name:, without_title:, with_title:)
+      @name = name.to_sym
+      @with_title = with_title
+      @without_title = without_title
+    end
+
+    def render(title:, tagline:, site:)
+      template = (title && with_title) ? with_title : without_title
+      substitute_placeholders(
+        template,
+        title: title || tagline,
+        tagline: tagline,
+        site: site
+      )
+    end
+
+    private
+
+    attr_reader :with_title, :without_title
+
+    def substitute_placeholders(template, options)
+      options.each do |key, value|
+        template = template.gsub(":#{key}", value.to_s)
+      end
+      template
+    end
+  end
+end

data/lib/happy-titles/template_set.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+module HappyTitles
+  class TemplateSet
+    def initialize(*templates)
+      @templates = templates
+    end
+
+    def get(key)
+      find_template(key) || raise_template_not_found(key)
+    end
+
+    private
+
+    attr_accessor :templates
+
+    def method_missing(*args)
+      delete_template(args[0])
+      templates << HappyTitles::Template.new(
+        name: args[0],
+        without_title: args[1],
+        with_title: args[2]
+      )
+    end
+
+    def find_template(key)
+      templates.find do |template|
+        template.name == key.to_sym
+      end
+    end
+
+    def delete_template(key)
+      templates.reject! do |template|
+        template.name == key.to_sym
+      end
+    end
+
+    def raise_template_not_found(key)
+      raise(
+        HappyTitles::TemplateNotFound,
+        "A template called \"#{key}\" could not be found. Templates that exist are: #{template_names}"
+      )
+    end
+
+    def template_names
+      @templates.collect(&:name).join(", ")
+    end
+  end
+end

data/lib/happy-titles/version.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+module HappyTitles
+  VERSION = "2.0.0"
+end

data/spec/fake_app.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+module FakeApp
+  class Application < Rails::Application
+    config.secret_key_base = "test"
+    config.eager_load = false
+  end
+end

data/spec/lib/config_spec.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+describe HappyTitles::Config do
+  subject { described_class.new }
+
+  describe "#site" do
+    it "returns the default" do
+      expect(subject.site).to eq("My site")
+    end
+
+    context "When the default has been changed" do
+      before { subject.site = "Custom site" }
+
+      it "returns the new value" do
+        expect(subject.site).to eq("Custom site")
+      end
+    end
+  end
+
+  describe "#tagline" do
+    it "returns the default" do
+      expect(subject.tagline).to eq("My short, descriptive and witty tagline")
+    end
+
+    context "When the default has been changed" do
+      before { subject.tagline = "Custom tagline" }
+
+      it "returns the new value" do
+        expect(subject.tagline).to eq("Custom tagline")
+      end
+    end
+  end
+
+  describe "#template" do
+    it "returns the default template" do
+      expect(subject.template.name).to eq(:default)
+    end
+
+    it "returns a template based on the key" do
+      expect(subject.template(:default).name).to eq(:default)
+    end
+  end
+end

data/spec/lib/happy_titles_spec.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+describe HappyTitles do
+  subject { described_class }
+
+  describe ".config" do
+    it "returns a config object" do
+      expect(subject.config).to be_a(subject::Config)
+    end
+
+    it "always returns the same config object" do
+      expect(subject.config).to equal(subject.config)
+    end
+  end
+
+  describe ".configure" do
+    it "yields the config object" do
+      expect { |b| subject.configure(&b) }.to yield_with_args(subject.config)
+    end
+  end
+end

data/spec/lib/helpers_spec.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+describe "HappyTitle Helpers" do
+  let(:view) { ActionView::Base.new }
+  let(:page_title) { view.page_title }
+
+  before do
+    HappyTitles.configure do |config|
+      config.site = "Custom site"
+      config.tagline = "Custom tagline"
+    end
+  end
+
+  it "renders the page title" do
+    expect(page_title).to eq("<title>Custom site | Custom tagline</title>")
+  end
+
+  context "when the title is set" do
+    before do
+      view.title "Custom title"
+    end
+
+    it "returns the title" do
+      expect(view.title).to eq("Custom title")
+    end
+
+    it "renders the page title" do
+      expect(page_title).to eq("<title>Custom title | Custom site</title>")
+    end
+
+    context "setting the title again" do
+      before do
+        view.title "Another title"
+      end
+
+      it "should overwrite the previously set title" do
+        expect(view.title).to eq("Another title")
+      end
+    end
+  end
+
+  context "when the title contains special entities" do
+    before do
+      view.title "This & That"
+    end
+
+    it "should escape special entities" do
+      expect(page_title).to eq("<title>This &amp; That | Custom site</title>")
+    end
+  end
+
+  context "when there is a custom template" do
+    let(:page_title) { view.page_title(:custom) }
+
+    before do
+      HappyTitles.configure do |config|
+        config.templates do
+          custom "++ :site ++", "++ :site ++ :title ++"
+        end
+      end
+    end
+
+    it "renders the page title" do
+      expect(page_title).to eq("<title>++ Custom site ++</title>")
+    end
+
+    context "when the title is set" do
+      before do
+        view.title "Custom title"
+      end
+
+      it "renders the page title" do
+        expect(page_title).to eq("<title>++ Custom site ++ Custom title ++</title>")
+      end
+    end
+  end
+end

data/spec/lib/template_set_spec.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+describe HappyTitles::TemplateSet do
+  subject do
+    described_class.new(template)
+  end
+
+  let(:template) { instance_double(HappyTitles::Template, name: :custom) }
+
+  describe "#get" do
+    it "gets the template" do
+      expect(subject.get(:custom)).to eq(template)
+    end
+
+    it "converts string arguments to a symbol" do
+      expect(subject.get("custom")).to eq(template)
+    end
+
+    it "raises an error if a template cannot be found" do
+      expect { subject.get(:unknown) }.to raise_error(
+        HappyTitles::TemplateNotFound,
+        'A template called "unknown" could not be found. Templates that exist are: custom'
+      )
+    end
+  end
+
+  describe "Adding a new template" do
+    let(:new_template) { subject.get(:additional) }
+
+    before do
+      subject.additional("without_title", "with_title")
+    end
+
+    it "adds a template" do
+      expect(new_template).to be_a(HappyTitles::Template)
+    end
+
+    it "sets the template name" do
+      expect(new_template.name).to eq(:additional)
+    end
+  end
+
+  describe "Adding a template with only one format" do
+    let(:new_template) { subject.get(:single_format) }
+
+    before do
+      subject.single_format("without_title")
+    end
+
+    it "adds a template" do
+      expect(new_template).to be_a(HappyTitles::Template)
+    end
+  end
+
+  describe "Overwriting an existing template" do
+    before do
+      subject.custom("without_title", "with_title")
+    end
+
+    it "overwrites the old template" do
+      expect(subject.get(:custom)).not_to eq(template)
+    end
+  end
+end