titlezilla 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4bb897c70e2c0289ff7978c420b95a9656ef1472
+  data.tar.gz: 87bb55a741c35528769cb38c5cae2cb984141035
+SHA512:
+  metadata.gz: 41c15998a6d8bc290254e72db117471feb931171be73cbf8babb4d11b910cacfb39a452fde362dd8fcd0427c78f6e30f0ff61a3248b3ab2de30d7ee4f5b75335
+  data.tar.gz: f303535e0bae066c0fa43a75b21a285c3ebf2e4c16bdf37ea13d40379bd5158d69be6517c09b1b889d30b340b3ad99c93df6645b555436fcef479017356d0476

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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Evgeny Likholetov <bsboris@gmail.com>
+
+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,120 @@
+# Titlezilla
+
+Ultimate solution for dealing with titles in Rails.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'titlezilla'
+
+And then execute:
+
+    $ bundle
+
+Run the generator:
+
+    rails generate titlezilla:install
+
+## Usage
+
+### Basics
+
+Put your titles in generated .yml file:
+
+    en:
+      titles:
+        application: My Application
+        welcome:
+          index: Welcome page title
+        users:
+          show: User: %{user}
+
+Use convinient methods in your helpers:
+
+    # Assuming you are on welcome#index page:
+    application_title # => My Application
+    title # => Welcome page title
+    meta_title # => Welcome page title | My Application
+    title_tag # => <title>Welcome page title | My Application</title>
+
+### Passing variables to translations
+
+All defined instance variables passed to translations.
+
+YAML:
+
+    en:
+      titles:
+        users:
+          show: User: %{user}
+
+Model:
+
+    class User < ActiveRecord::Base
+      def to_s
+        user.full_name
+      end
+    end
+
+Controller:
+
+    def show
+      @user = User.find(params[:id])
+
+View:
+
+    title # => User: John Doe
+
+### Namespacing
+
+Namespaced controllers/views are supported, so you can have separate set of titles for different parts of your application.
+
+YAML:
+
+    en:
+      titles:
+        application: My Application
+        ...
+        admin:
+          application: Admin Panel
+          dashboard:
+            index: Dashboard
+
+View:
+
+    # Assuming you are on admin/welcome#index page:
+    application_title # => Admin Panel
+    title # => Dashboard
+    meta_title # => Dashboard | Admin Panel
+
+### Action aliasing (:create and :update)
+
+Titleziila uses name of the current action for resolving titles, so when you submit a form and it fails to save, your rendered `new` template inside the `create` action. To avoid setting duplicated titles for both `new` and `create` (and `edit` and `update`), this actions is mapped in gem configuration.
+If your application have similar non-RESTful pair of actions, your can add them to mapping:
+
+config/initializers/titlezilla.rb:
+
+    Titlezilla.configure do |config|
+      config.action_map.merge!({perform_parse: :parse})
+    end
+
+Now you can define title only for `parse` action, `perform_parse` whil use it automagically.
+
+### Custom meta title separator
+
+If you want your title tag content to look like this: `My Application > My cool page`, tell Titlezilla to use custom separator.
+
+config/initializers/titlezilla.rb:
+
+    Titlezilla.configure do |config|
+      config.separator = ' > '
+    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,7 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = 'test/*_test.rb'
+end

data/lib/generators/titlezilla/install_generator.rb

@@ -0,0 +1,12 @@
+module Titlezilla
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc "Copy Titlezilla default files"
+      source_root File.expand_path('../templates', __FILE__)
+
+      def copy_config
+        directory 'config/locales'
+      end
+    end
+  end
+end

data/lib/generators/titlezilla/templates/config/locales/titles.en.yml

@@ -0,0 +1,7 @@
+en:
+  titles:
+    application: My Application
+    main:
+      index: Main index
+    users:
+      show: 'User: %{user}'

data/lib/titlezilla/helpers/title.rb

@@ -0,0 +1,29 @@
+require 'titlezilla/translator'
+
+module Titlezilla
+  module Helpers
+    module Title
+      def title
+        translator.title
+      end
+
+      def application_title
+        translator.application_title
+      end
+
+      def meta_title
+        translator.meta_title
+      end
+
+      def title_tag
+        content_tag :title, meta_title
+      end
+
+      private
+
+      def translator
+        @translator ||= Translator.new(controller_path, action_name, controller.view_assigns.symbolize_keys)
+      end
+    end
+  end
+end

data/lib/titlezilla/helpers.rb

@@ -0,0 +1,10 @@
+require 'action_view'
+require 'titlezilla/helpers/title'
+
+module Titlezilla
+  module Helpers
+    include Title
+  end
+end
+
+ActionView::Base.send :include, Titlezilla::Helpers

data/lib/titlezilla/translator.rb

@@ -0,0 +1,45 @@
+require 'active_support/core_ext/hash/reverse_merge'
+
+module Titlezilla
+  class Translator
+    attr_reader :namespace, :controller_name, :action_name, :context
+
+    def initialize(controller_path, action_name, context = {})
+      @namespace, @controller_name = parse_namespace_and_controller_name(controller_path)
+      @action_name = action_name.to_s.freeze
+      @context = context
+    end
+
+    def title
+      lookup(controller_name, map(action_name))
+    end
+
+    def application_title
+      lookup('application')
+    end
+
+    def meta_title
+      [title, application_title].compact.join(::Titlezilla.configuration.separator)
+    end
+
+    private
+
+    def parse_namespace_and_controller_name(controller_path)
+      parts = controller_path.to_s.split('/')
+      parts.size > 1 ? parts.map(&:to_s).map(&:freeze) : [nil, parts[0].to_s.freeze]
+    end
+
+    def lookup(*key)
+      t_key = [:titles, namespace, key].flatten.compact.join('.')
+      i18n_set?(t_key) ? I18n.t(t_key, context) : nil
+    end
+
+    def map(action_name)
+      (::Titlezilla.configuration.action_map[action_name.to_sym] || action_name).to_s.freeze
+    end
+
+    def i18n_set?(key)
+      I18n.t(key, raise: true) rescue false
+    end
+  end
+end

data/lib/titlezilla/version.rb

@@ -0,0 +1,3 @@
+module Titlezilla
+  VERSION = '0.1.0'.freeze
+end

data/lib/titlezilla.rb

@@ -0,0 +1,25 @@
+require 'titlezilla/version'
+require 'titlezilla/helpers'
+
+module Titlezilla
+  def self.configure
+    yield(configuration) if block_given?
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.reset_configuration
+    @configuration = Configuration.new
+  end
+
+  class Configuration
+    attr_accessor :action_map, :separator
+
+    def initialize
+      @action_map = { create: :new, update: :edit }
+      @separator = ' | '
+    end
+  end
+end

data/test/generator_test.rb

@@ -0,0 +1,15 @@
+require 'test_helper'
+require 'rails/generators/test_case'
+require 'generators/titlezilla/install_generator'
+
+class GeneratorTest < Rails::Generators::TestCase
+  tests Titlezilla::Generators::InstallGenerator
+  destination File.expand_path('../../tmp', __FILE__)
+  setup :prepare_destination
+  teardown { rm_rf(destination_root) }
+
+  test 'generates example locale file' do
+    run_generator
+    assert_file 'config/locales/titles.en.yml'
+  end
+end

data/test/helpers/title_test.rb

@@ -0,0 +1,79 @@
+require 'test_helper'
+
+class ActionView::TestCase; include Titlezilla::Helpers::Title; end
+
+module Titlezilla
+  module Helpers
+    describe Title do
+      describe 'integration' do
+        before do
+          load_translations({ application: 'App', main: { new: 'New', edit: 'Edit' } })
+        end
+
+        it '#title' do
+          @controller.controller_path = :main
+          @controller.action_name = :new
+          title.must_equal 'New'
+        end
+
+        it '#title using view assigns' do
+          load_translations({ main: { new: 'New: %{name}' } })
+          @controller.controller_path = :main
+          @controller.action_name = :new
+          @controller.view_assigns = { name: 'John' }
+          title.must_equal 'New: John'
+        end
+
+        it '#application_title' do
+          @controller.controller_path = :main
+          @controller.action_name = :new
+          application_title.must_equal 'App'
+        end
+
+        it '#meta_title' do
+          @controller.controller_path = :main
+          @controller.action_name = :new
+          meta_title.must_equal 'New | App'
+        end
+
+        it 'should render title tag' do
+          @controller.controller_path = :main
+          @controller.action_name = :new
+          title_tag.must_equal '<title>New | App</title>'
+        end
+      end
+
+      describe 'configurable' do
+        describe 'defaults' do
+          before do
+            load_translations({ main: { new: 'New', edit: 'Edit' } })
+            @controller.controller_path = :main
+          end
+
+          it '#new' do
+            @controller.action_name = :create
+            title.must_equal 'New'
+          end
+
+          it '#create' do
+            @controller.action_name = :update
+            title.must_equal 'Edit'
+          end
+        end
+
+        describe 'custom' do
+          before do
+            ::Titlezilla.configure { |c| c.action_map.merge!({ do_parse: :parse }) }
+            load_translations({ main: { parse: 'Parse' } })
+            @controller.controller_path = :main
+          end
+
+          it '#parse' do
+            @controller.action_name = :do_parse
+            title.must_equal 'Parse'
+          end
+        end
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,45 @@
+require 'minitest/autorun'
+require 'minitest/spec'
+require 'i18n'
+require 'active_support/test_case'
+require 'action_view/test_case'
+require 'titlezilla'
+
+class ActiveSupport::TestCase
+  class << self
+    remove_method :describe
+  end if self.respond_to? :describe
+
+  extend MiniTest::Spec::DSL
+end
+
+class MockController < Struct.new(:action_name, :controller_path)
+  attr_accessor :view_assigns
+
+  def initialize
+    @view_assigns = {}
+  end
+end
+
+class ActionView::TestCase
+  register_spec_type(/Helper( ?Test)?\z/i, self)
+
+  setup :set_controller
+
+  def set_controller
+    @controller = MockController.new
+  end
+end
+
+I18n.enforce_available_locales = false
+
+def load_translations(titles)
+  I18n.backend.store_translations(:en, { titles: titles })
+end
+
+class Minitest::Spec
+  after do
+    ::Titlezilla.reset_configuration
+    I18n.reload!
+  end
+end

data/test/translator_test.rb

@@ -0,0 +1,90 @@
+require 'test_helper'
+
+module Titlezilla
+  describe Translator do
+    describe '#initialize' do
+      it 'should initialize controller_name' do
+        t = Translator.new('main', 'index')
+        t.controller_name.must_equal 'main'
+      end
+
+      it 'should initialize action_name' do
+        t = Translator.new('main', 'index')
+        t.action_name.must_equal 'index'
+      end
+
+      it 'should initialize namespace' do
+        t = Translator.new('admin/main', 'index')
+        t.namespace.must_equal 'admin'
+      end
+
+      it 'should initialize from symbols' do
+        t = Translator.new(:'admin/main', :index)
+        t.namespace.must_equal 'admin'
+        t.controller_name.must_equal 'main'
+        t.action_name.must_equal 'index'
+      end
+    end
+
+    describe '#title' do
+      it 'should lookup action title' do
+        load_translations({ main: { index: 'Index' } })
+        t = Translator.new(:main, :index)
+        t.title.must_equal 'Index'
+      end
+
+      it 'should lookup action title with namespace' do
+        load_translations({ admin: { main: { index: 'Index' } } })
+        t = Translator.new('admin/main', :index)
+        t.title.must_equal 'Index'
+      end
+
+      it 'should lookup mapped actions title' do
+        load_translations({ main: { new: 'New' } })
+        t = Translator.new(:main, :create)
+        t.title.must_equal 'New'
+      end
+
+      it 'should allow using context' do
+        load_translations({ main: { new: 'New: %{name}' } })
+        t = Translator.new(:main, :create, name: 'John')
+        t.title.must_equal 'New: John'
+      end
+    end
+
+    describe '#application_title' do
+      it 'should lookup application title' do
+        load_translations({ application: 'App' })
+        t = Translator.new(:main, :index)
+        t.application_title.must_equal 'App'
+      end
+
+      it 'should lookup application title when namespace provided' do
+        load_translations({ admin: { application: 'App' } })
+        t = Translator.new('admin/main', :index)
+        t.application_title.must_equal 'App'
+      end
+    end
+
+    describe '#meta_title' do
+      it 'should return app title if action title not provided' do
+        load_translations({ application: 'App' })
+        t = Translator.new(:main, :index)
+        t.meta_title.must_equal 'App'
+      end
+
+      it 'should return joined title' do
+        load_translations({ application: 'App', main: { index: 'Index' } })
+        t = Translator.new(:main, :index)
+        t.meta_title.must_equal 'Index | App'
+      end
+
+      it 'should return joined title with custom separator' do
+        load_translations({ application: 'App', main: { index: 'Index' } })
+        ::Titlezilla.configure { |c| c.separator = ' > ' }
+        t = Translator.new(:main, :index)
+        t.meta_title.must_equal 'Index > App'
+      end
+    end
+  end
+end

data/titlezilla.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'titlezilla/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'titlezilla'
+  spec.version       = Titlezilla::VERSION
+  spec.authors       = ['Evgeny Likholetov']
+  spec.email         = ['bsboris@gmail.com']
+  spec.description   = 'Ultimate solution for dealing with titles in Rails.'
+  spec.summary       = 'Ultimate solution for dealing with titles in Rails.'
+  spec.homepage      = 'https://github.com/bsboris/titlezilla'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.test_files    = spec.files.grep(%r{^(test)/})
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'actionpack', '>= 4.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'minitest', '~> 4.2'
+  spec.add_development_dependency 'railties'
+  spec.add_development_dependency 'rake'
+end

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: titlezilla
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Evgeny Likholetov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ultimate solution for dealing with titles in Rails.
+email:
+- bsboris@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/titlezilla/install_generator.rb
+- lib/generators/titlezilla/templates/config/locales/titles.en.yml
+- lib/titlezilla.rb
+- lib/titlezilla/helpers.rb
+- lib/titlezilla/helpers/title.rb
+- lib/titlezilla/translator.rb
+- lib/titlezilla/version.rb
+- test/generator_test.rb
+- test/helpers/title_test.rb
+- test/test_helper.rb
+- test/translator_test.rb
+- titlezilla.gemspec
+homepage: https://github.com/bsboris/titlezilla
+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.0
+signing_key: 
+specification_version: 4
+summary: Ultimate solution for dealing with titles in Rails.
+test_files:
+- test/generator_test.rb
+- test/helpers/title_test.rb
+- test/test_helper.rb
+- test/translator_test.rb