titlefy 0.1 → 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e2d959eb9c1ad291b7512726b2ac4278b48c362f
+  data.tar.gz: a5d8503f6e1821ea8e2250852c59cbea2b7f1169
+SHA512:
+  metadata.gz: 18b86637f93e3f96894ce51f62a7e720aa65295e70832b5ea46f29a85c117d6dceaa59e7e19717e06b0fb9c52a01fca16edd3e5b7daaacb4b88b45514690e8e3
+  data.tar.gz: 1ad2278a76780a5ef2cdd2cd7b91218047b5a1408cb3ca327920e0236d198dc7388b8e898354ad13bc414a882cf0a8c8bedcc4b1dced05d7c22f9ace680da17d

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

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

data/README.md

@@ -0,0 +1,112 @@
+# Titlefy
+
+Awesome title tag magic with I18n support, passing variables and default title. 
+No more unnecessary lines in each controller method, no more setting title tags out of a view. 
+Avoid messy code - be slim and dry - kepp just one central place to control all your title tags!
+
+## Usage
+Define your tiltetags within one structured file. Just simply do the following:
+
+```ruby
+gem "titlefy", git: 'git://github.com/krtschmr/titlefy.git'
+```
+
+Using @page_title into your HTML 
+````
+  <title><%=@page_title %></title>
+````
+
+
+
+Create an YML file and add the :title_tags scope. Define what you need
+
+
+#### Default TilteTag
+    en:
+      title_tags:
+        default: My Awesome Webpage
+
+##### TitleTag by route_name
+    en:
+      title_tags:
+        routes:
+          list_items_path: Index of Items
+          order_path: Order at our Webshop
+    
+#### TitleTag by Controller/Action      
+    en:
+      title_tags:
+        files_controller:
+          index: List of all Files
+          new: Create a new File          
+
+#### Titletag by Controller in Namespace        
+For Admin::DashboardController
+
+    en:
+      title_tags:
+        admin: 
+          dashboard_conroller:
+            index: Overview
+            stats: Detailed Stats
+            
+            
+
+#### Using variables in title tag
+
+    en:
+      title_tags:  
+        users_controller:
+          show: Details of user: {{@user.name}}
+          videos:
+            index: Videos of user: {{@user.name}}
+            show: Video "{{@video.name}} from {{@user.name}} posted on {{@video.time}}"
+
+
+It also supports any kind of resource-controller where the object is called "resource"
+
+    en:
+      title_tags:  
+        routes: 
+          dogs_path: "{{resource.funky_dog_name}} - my-petwebsite"
+          cats_path: "{{resource.funky_cat_name}} - my-petwebsite"
+
+**Important!**
+If your title-tag starts with a placeholder its neccessary to **start with quotes** to keep valid YML.
+
+
+            
+Lookup order is Namespace/Controller/Action, Controller/Action, RouteName, Default, RaillsAppName. 
+Simply set the titletag from your controller like this
+````
+  def index
+    set_title("MY special title")
+  end
+````
+
+
+# TODO
+- Multi Namespacing Support
+
+### Changelog
+
+0.3.0 
+ - supports passing of variables
+ - changed lookup path of routes
+ - changed @title to @page_title
+
+0.2.0 rewritten code from 2012
+
+
+
+
+
+
+
+
+###### misc
+This project is licenced under the MIT license.
+
+
+
+thanks to [phillipp](https://github.com/phillipp)

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "titlefy"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/titlefy/version.rb

@@ -0,0 +1,3 @@
+module Titlefy
+  VERSION = "0.3.0"
+end

data/lib/titlefy.rb

@@ -1,45 +1,67 @@
-class Titlefy
-    module ClassMethods
-    
+require "titlefy/version"
+require 'active_support/concern'
+
+module Titlefy
+  extend ActiveSupport::Concern
+
+  def titlefy
+    send :include, InstanceMethods
+  end
+
+  included do
+
     def render(*args)
-      set_title_tag if (!!!@title || @title == "")
+      set_title_tag unless @page_title
       super
     end
-  
+
     def set_title_tag
-      yml = YAML::load(ERB.new((IO.read("#{::Rails.root.to_s}/config/title_tags/#{I18n.locale}.yml"))).result)
-      namespace = ""
-      namespace = self.class.to_s.split("::").first.downcase if self.class.to_s.split("::").size > 1
-      begin
-        if namespace == ""
-          title_tag = yml[controller_name][action_name]
-        else
-          title_tag = yml[namespace][controller_name][action_name]
+      title = I18n.t "title_tags.#{namespace}.#{controller_name}.#{action_name}", default: ""
+      title = I18n.t "title_tags.#{controller_name}.#{action_name}", default: ""                if title.empty?
+      title = I18n.t route_name,  scope: [:title_tags, :routes], default: ""                    if title.empty? and route_name != ""
+      title = default_title if title == ""
+      
+      title.scan(/\{\{.*?\}\}/).each do |replace|
+        #{{@game.name}} => @game.name
+        variable = replace.gsub(/\{|\}/, "")                        
+
+        # catch resource_controller or similar
+        # variable named resource is an AR object
+        # rename to @tempresource so we can handle it        
+        if variable.starts_with? "resource"
+          @tempresource = resource
+          variable.gsub!("resource", "@tempresource")
         end
-        rescue
-      end
-      title_tag = yml["default"] unless title_tag
-      raise "No Title Tag defined" unless title_tag
-      begin
-        @title = eval(title_tag)
-      rescue
-        begin
-          @title = title_tag
-        rescue
-          raise "MISSING TITLE TAG"
+
+        # make "@variable.name" or "@variable" accessable without eval (!)
+        # and replace the {{placeholder}} with @variables value
+        if variable.starts_with?("@")          
+          content = variable.split('.').inject(nil){|clazz, method| clazz.nil? ? instance_variable_get(method) : clazz.send(method)}
+          title.gsub! replace, content
         end
       end
+      set_title( title )
     end
-  
-    def add_title(title)
-      @title = title
+
+    def set_title(title)
+      @page_title = title unless title.empty?
     end
-end
-class Engine < Rails::Engine
-    initializer "including" do |app|
-      ActionController::Base.send :include, Titlefy::ClassMethods
+
+    def namespace
+      self.class.parent.to_s.downcase
+    end
+
+    def default_title
+      I18n.t :default, scope: :title_tags, default: Rails.application.class.parent_name.humanize
+    end
+
+    def route_name
+      Rails.application.routes.router.recognize(request) do |route, _|
+        return route.name.to_s.split("_")[0..1].join("_")
+      end
     end
   end
-  
+
 end
 
+ActionController::Base.include Titlefy

data/titlefy.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'titlefy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "titlefy"
+  spec.version       = Titlefy::VERSION
+  spec.authors       = ["Tim Kretschmer"]
+  spec.email         = ["github@krtschmr.de"]
+
+  spec.summary       = %q{Extract your titletags from I18n backend.}
+  spec.description   = %q{Set your title-tag content based on I18n locales. Just add title_tag key to your YML File and the magic begins. Lookup for Namespace|Controller|ActionName or Controller|Actionname or RouteName or Default. Also supports passing variables into the title tag}
+  spec.homepage      = ""
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    #spec.metadata['allowed_push_host'] = "http://mygemserver.com'"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -1,54 +1,83 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: titlefy
-version: !ruby/object:Gem::Version 
-  prerelease: 
-  version: "0.1"
+version: !ruby/object:Gem::Version
+  version: 0.3.0
 platform: ruby
-authors: 
-- Huan Son
-autorequire: builder
-bindir: bin
+authors:
+- Tim Kretschmer
+autorequire: 
+bindir: exe
 cert_chain: []
-
-date: 2011-11-12 00:00:00 Z
-dependencies: []
-
-description: Simple TitleTag Helper. Reads from Multilingual YML Files.
-email: info@fu-media.de
+date: 2015-08-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Set your title-tag content based on I18n locales. Just add title_tag
+  key to your YML File and the magic begins. Lookup for Namespace|Controller|ActionName
+  or Controller|Actionname or RouteName or Default. Also supports passing variables
+  into the title tag
+email:
+- github@krtschmr.de
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
 - lib/titlefy.rb
-homepage: 
+- lib/titlefy/version.rb
+- titlefy.gemspec
+homepage: ''
 licenses: []
-
+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 
-      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 
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 2.4.8
 signing_key: 
-specification_version: 3
-summary: Multilingual TitleTag Helper. Reads and Set TitleTags from a YML file.
+specification_version: 4
+summary: Extract your titletags from I18n backend.
 test_files: []
-