page_title 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1b31f68b4a317190bae0c5ddd9f12d6952bbcfdf
+  data.tar.gz: 6abe236198afc5ec21516fe2aaed2b146e956d78
+SHA512:
+  metadata.gz: 607f015ff61a8f3bae0fa9b77b8e022728de7fdd5fa2e4cf39e47eea277df3b00d5c909dc899bb2e28cb61860152e0d6e1e70e0c2b086075c0d27fc0d8934ec8
+  data.tar.gz: 0d85dc430bd5016a616cbcfd0a9d90288e6561da9a08154f8006f497d286e1195ded1ef54dc2040bc90bb631d6e73bbee95b1c4152bbe4b611375186a299a92b

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/.rspec

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Nando Vieira
+
+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,77 @@
+# page_title
+
+Set the page title on Rails apps.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem "page_title"
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install page_title
+
+## Usage
+
+You can use this on your layout file to display the page title:
+
+```erb
+<%= page_title %>
+```
+
+The page title will be inferred from the controller and action names. For an action `SiteController#index` you'll the following translate scope:
+
+```yaml
+en:
+  titles:
+    base: "%{title} • MyCompany"
+    site:
+      index: "Welcome to our site"
+```
+
+The `titles.base` scope is required and will be used to set a general title information, like your company's name.
+
+You can also set the page title for namespaced controllers. For an action `Admin::Site#index` you'll need the following translate scope:
+
+```yaml
+en:
+  titles:
+    base: "%{title} • MyCompany"
+    admin:
+      site:
+        index: "Welcome to our site"
+```
+
+Sometimes you need to render some dynamic value. In this case, you can use the I18n placeholders.
+
+```yaml
+en:
+  titles:
+    base: "%{title} • MyCompany"
+    workshops:
+      show: "%{name}"
+```
+
+You can set dynamic values using the `PageSite::Base#[]=`.
+
+```ruby
+class WorkshopsController < ApplicationController
+  def show
+    @workshop = Workshop.find_by_permalink!(params[:permalink])
+    page_title[:name] = @workshop.name
+  end
+end
+```
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/page_title.rb

@@ -0,0 +1,48 @@
+require "i18n"
+require "forwardable"
+require "page_title/engine"
+require "page_title/helpers"
+require "page_title/version"
+
+module PageTitle
+  class Base
+    # Set the controller instance. It must implement
+    # the methods controller_name and action_name.
+    attr_reader :controller
+
+    # Set the main translation options.
+    attr_reader :options
+
+    extend Forwardable
+    def_delegators :options, :[], :[]=, :merge!
+
+    def initialize(controller)
+      @controller = controller
+      @options = {}
+    end
+
+    def to_s
+      base_translation
+    end
+
+    private
+    def title_translation
+      I18n.t(
+        title_scope,
+        options.merge(scope: "titles")
+      )
+    end
+
+    def base_translation
+      I18n.t("titles.base", title: title_translation)
+    end
+
+    def normalized_controller_name
+      controller.controller_name.gsub(%r[/], ".")
+    end
+
+    def title_scope
+      [normalized_controller_name, controller.action_name].join(".")
+    end
+  end
+end

data/lib/page_title/engine.rb

@@ -0,0 +1,8 @@
+module PageTitle
+  class Engine < Rails::Engine
+    config.to_prepare do
+      ApplicationController.send :include, Helpers
+      ApplicationController.helper_method :page_title
+    end
+  end
+end

data/lib/page_title/helpers.rb

@@ -0,0 +1,8 @@
+module PageTitle
+  module Helpers
+    private
+    def page_title
+      @page_title ||= PageTitle::Base.new(self)
+    end
+  end
+end

data/lib/page_title/version.rb

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

data/page_title.gemspec

@@ -0,0 +1,25 @@
+require "./lib/page_title/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "page_title"
+  spec.version       = PageTitle::VERSION
+  spec.authors       = ["Nando Vieira"]
+  spec.email         = ["fnando.vieira@gmail.com"]
+  spec.description   = "Set the page title on Rails apps"
+  spec.summary       = spec.description
+  spec.homepage      = "http://github.com/fnando/page_title"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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 "rails"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rspec-rails"
+  spec.add_development_dependency "pry-meta"
+end

data/spec/controllers/application_controller_spec.rb

@@ -0,0 +1,85 @@
+require "spec_helper"
+
+describe ApplicationController do
+  context "simple controller name" do
+    set_translations  "titles.base" => "%{title} - SITE",
+                      "titles.site.index" => "TITLE"
+
+    controller do
+      def controller_name
+        "site"
+      end
+
+      def index
+        render text: page_title
+      end
+    end
+
+    it do
+      get :index
+      expect(response.body).to eql("TITLE - SITE")
+    end
+  end
+
+  context "namespaced controller name" do
+    set_translations  "titles.base" => "%{title} - SITE",
+                      "titles.admin.site.index" => "TITLE"
+
+    controller do
+      def controller_name
+        "admin/site"
+      end
+
+      def index
+        render text: page_title
+      end
+    end
+
+    it do
+      get :index
+      expect(response.body).to eql("TITLE - SITE")
+    end
+  end
+
+  context "using placeholders" do
+    set_translations  "titles.base" => "%{title} - SITE",
+                      "titles.site.index" => "%{name}"
+
+    controller do
+      def controller_name
+        "site"
+      end
+
+      def index
+        page_title[:name] = "NAME"
+        render text: page_title
+      end
+    end
+
+    it do
+      get :index
+      expect(response.body).to eql("NAME - SITE")
+    end
+  end
+
+  context "rendering template" do
+    render_views
+
+    set_translations  "titles.base" => "%{title} - SITE",
+                      "titles.site.index" => "TITLE"
+
+    controller do
+      def controller_name
+        "site"
+      end
+
+      def index
+      end
+    end
+
+    it do
+      get :index
+      expect(response.body).to match(%r[<title>TITLE - SITE</title>])
+    end
+  end
+end

data/spec/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/spec/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/spec/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,13 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require_self
+ *= require_tree .
+ */

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title><%= page_title %></title>
+  <%= stylesheet_link_tag    "application", media: "all", "data-turbolinks-track" => true %>
+  <%= javascript_include_tag "application", "data-turbolinks-track" => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>