meta_tags 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7d7c3be2f90a4bf1e3a4fd71868bf3f70206077f
+  data.tar.gz: e8f7122e74b90b721931040e293afdafcc39a815
+SHA512:
+  metadata.gz: 6eb4ae7f68556a5f7ad40b90571b9d2308a5851428f9aa7bce7609e937da80f1f1ac3c26814b83bce09a7a7083ab39f87869af0717ed4e2b089aa35dbdb2e45f
+  data.tar.gz: 1e0534967227d8cdca13a676d582864011fbd4b8f4927516dde521d798bc95022e03082fb59b57127f975c977c9d2bfd9980b3f6f9b65c700ba015ca920bd928

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+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,102 @@
+# Meta_tags
+
+Meta tags allows a Rails application to include meta tags in HTML, depending on the action. Content can be set by I18n locales, Models or defined in ApplicationController.
+
+## Installing
+
+1. Add this line to your Gemfile
+```ruby
+gem 'meta_tags', git: "git://github.com/vala/meta_tags.git"
+```
+
+2. Generate config file :
+```bash
+rails generate meta_tags:config
+```
+
+## Defining default values
+### In your ApplicationController
+```ruby
+  meta_tags_defaults(
+    title: "My title",
+    description: "My description",
+    keywords: Keywords,
+    image: "/assets/illustration.jpg"
+    # Facebook
+    site_name: 'Mysite',
+    type: 'website',
+    # Twitter
+    site: '@Mysite',
+    card: 'summary, photo, gallery, product, app, player'
+  )
+```
+
+### In your locales
+```yaml
+en:
+  meta_tags:
+    controller:
+      posts:
+        index:
+          title: Test
+          description: Test description
+```
+
+### In a Controller
+You can use the helper meta_tags_from to use data from the associated model
+<tt>app/controllers/posts_controller.rb</tt>
+```ruby
+class PostsController < ApplicationController
+  meta_tags_from :post
+
+  def index
+    @posts = Post.all
+  end
+
+  def show
+    @post = Post.find(params[:id])
+  end
+end
+```
+
+<tt>app/models/post.rb</tt>
+```ruby
+class Post < ActiveRecord::Base
+  attr_accessible :description, :title, :image
+  has_attached_file :image
+end
+```
+
+Used methods can be defined in the initializer <tt>config/initializers/meta_tags.rb</tt>
+```ruby
+MetaTags.config do |config|
+
+  # Default title methods to be checked for title
+  # config.title_methods = %w(title name)
+
+  # Default decsription methods to be checked for description
+  # config.description_methods = %w(description desc)
+
+  # Default description methods to be checked for image
+  # config.image_methods = %w(image picture avatar)
+end
+```
+
+
+### Overwrite in a controller
+```ruby
+class HomeController < ApplicationController
+  def index
+    set_meta_tag(:title, "Accueil")
+  end
+end
+```
+
+## View helper
+```haml
+!!!
+%html
+  %head
+    = stylesheet_link_tag "application"
+    = meta_tags :open_graph, :twitter
+```

data/Rakefile

@@ -0,0 +1,38 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'MetaTags'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/app/models/meta_tags/list.rb

@@ -0,0 +1,14 @@
+module MetaTags
+  class List < ActiveRecord::Base
+    if respond_to?(:protected_attributes)
+      attr_accessible :name, :identifier, :meta_taggable_id,
+        :meta_taggable_type, :meta_title, :meta_description, :meta_keywords
+    end
+
+    belongs_to :meta_taggable, polymorphic: true
+
+    validates_presence_of :name, :identifier, unless: :meta_taggable
+
+    scope :without_meta_taggable, -> { where(meta_taggable_id: nil)  }
+  end
+end

data/db/migrate/20140114154410_create_meta_tags_list.rb

@@ -0,0 +1,14 @@
+class CreateMetaTagsList < ActiveRecord::Migration
+  def change
+    create_table :meta_tags_lists do |t|
+      t.string :name
+      t.string :identifier
+      t.belongs_to :meta_taggable, polymorphic: true
+      t.string :meta_title
+      t.text :meta_description
+      t.text :meta_keywords
+
+      t.timestamps
+    end
+  end
+end

data/lib/generators/meta_tags/config/config_generator.rb

@@ -0,0 +1,22 @@
+module MetaTags
+  class ConfigGenerator < Rails::Generators::Base
+    # Copied files come from templates folder
+    source_root File.expand_path('../templates', __FILE__)
+
+    # Generator desc
+    desc "Meta-tags config generator"
+
+    def welcome
+      say "Configuring Meta-tags dependencies and files !"
+    end
+
+    def copy_initializer_file
+      say "Installing default initializer template"
+      copy_file "initializer.rb", "config/initializers/meta_tags.rb"
+    end
+
+    def copy_migrations
+      rake "meta_tags_railtie:install:migrations"
+    end
+  end
+end

data/lib/generators/meta_tags/config/templates/initializer.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+MetaTags.config do |config|
+
+  # Default title methods to be checked for title
+  #
+  # config.title_methods = %w(title name)
+
+  # Default decsription methods to be checked for description
+  #
+  # config.description_methods = %w(description desc)
+
+  # Default image methods to be checked for image
+  #
+  # config.image_methods = %w(image picture avatar)
+
+  # When setting a title, keep original title after :
+  #
+  # Example : If you set the default title to "My Shop" and, on the home page
+  #   set the title to "Home", you'll end up with a title of : "Home - My Shop"
+  #
+  # Defaults to true
+  #
+  # config.keep_default_title_present = false
+end

data/lib/meta_tags/container.rb

@@ -0,0 +1,67 @@
+require "sanitize"
+
+module MetaTags
+  class Container
+    attr_accessor :default_title,
+                  :default_description,
+                  :default_image,
+                  :default_url,
+                  :default_site_name,
+                  :default_keywords,
+                  :default_type,
+                  :default_site,
+                  :default_card,
+                  :title_changed,
+                  :description_changed,
+                  :image_changed,
+                  :url_changed,
+                  :site_name_changed,
+                  :keywords_changed,
+                  :type_changed,
+                  :site_changed,
+                  :card_changed
+
+    TAGS_LIST = %w(
+      title description image url site_name keywords type site card
+    )
+
+    TAGS_LIST.each do |label|
+      define_method(label) do
+        Sanitize.clean(
+          instance_variable_get(:"@#{ label }") || send(:"default_#{ label }")
+        )
+      end
+
+      define_method(:"#{ label }=") do |value|
+        instance_variable_set(:"@#{ label }_changed", true)
+        instance_variable_set(:"@#{ label }", value)
+      end
+
+      define_method(:"#{ label }_changed?") do
+        !!instance_variable_get(:"@#{ label }_changed")
+      end
+    end
+
+    def initialize options
+      options.each do |label, value|
+        self.send(:"default_#{ label }=", value)
+      end
+    end
+
+    def title=(value)
+      @title_changed = true
+      if default_title == value || !MetaTags.keep_default_title_present
+        @title = value
+      elsif MetaTags.keep_default_title_present
+        @title = "#{ value } - #{ default_title }"
+      end
+    end
+
+
+    def reset_changed_status
+      TAGS_LIST.each do |label|
+        self.send(:"#{ label }_changed=", false)
+      end
+    end
+  end
+end

data/lib/meta_tags/controller.rb

@@ -0,0 +1,130 @@
+module MetaTags
+  module Controller
+    extend ActiveSupport::Concern
+    include PageDataHelper
+  
+    module ClassMethods
+      attr_accessor :meta_tags, :model_name, :modifier_block
+
+      def meta_tags_defaults(options)
+        @meta_tags = Container.new(options)
+      end
+
+      def meta_tags_from(model_name = nil, &block)
+        @model_name = model_name && model_name.to_s
+        @modifier_block = block_given? ? block : nil
+      end
+    end
+
+    included do
+      helper_method :meta_tags, :meta_tags_container, :set_meta_tag,
+        :meta_tags_data
+
+      after_filter do
+        meta_tags_container.reset_changed_status if meta_tags_container
+      end
+    end
+
+    attr_reader :instance
+
+    def meta_tags_container
+      @_meta_tags_container ||= ::ApplicationController.meta_tags.dup
+    end
+
+    def meta_tags_data
+      process_meta_tags
+      meta_tags_container
+    end
+
+    def meta_tags_for(identifier)
+      if identifier.kind_of?(ActiveRecord::Base)
+        @instance = identifier
+      elsif (list = MetaTags::List.where(identifier: identifier.to_s).first)
+        %w(title description keywords).each do |key|
+          if (value = list.send(:"meta_#{ key }").presence)
+            meta_tags_container.send(:"#{ key }=", value)
+          end
+        end
+      end
+    end
+
+    def meta_tags(*providers)
+      options = providers.pop if providers.last.is_a? Hash
+      charset = options[:encoding] rescue 'utf-8'
+
+      data = meta_tags_data
+
+      # Required meta tags
+      markup = <<-HTML
+        <meta charset="#{ charset }">
+        <title>#{ data.title }</title>
+      HTML
+
+      if data.keywords.presence
+        markup << "<meta name=\"keywords\" content=\"#{ data.keywords }\">"
+      end
+
+      # Default meta tags
+      markup << markup_from_provider(:default)
+
+      # Meta tags by provider
+      providers.each do |provider|
+        str = markup_from_provider provider
+
+        # Prevents same meta tags added twice
+        markup << str if !markup.include?(str)
+      end
+
+      markup.html_safe
+    end
+
+    def markup_from_provider(provider = :default)
+      tags = case provider.to_sym
+      when :open_graph
+        {
+          title: "property=\"og:title\"",
+          description: "property=\"og:description\"",
+          image: "property=\"og:image\"",
+          type: "property=\"og:type\"",
+          url: "property=\"og:url\"",
+          site_name: "property=\"og:site_name\""
+        }
+      when :twitter
+        {
+          title: "name=\"twitter:title\"",
+          description: "name=\"twitter:description\"",
+          image: "name=\"twitter:image\"",
+          url: "name=\"twitter:url\"",
+          site: "name=\"twitter:site\"",
+          card: "name=\"twitter:card\""
+        }
+      else
+        {
+          description: "name=\"description\"",
+        }
+      end
+
+      tags.each_with_object("") do |(key, property_string), buffer|
+        if (content = meta_tags_container.send(key)).presence
+          buffer << "<meta #{ property_string } content=\"#{ content }\">\n"
+        end
+      end
+    end
+
+    def process_meta_tags
+      Container::TAGS_LIST.each do |label|
+        next if meta_tags_container.send(:"#{ label }_changed?")
+
+        if (data = process_meta_tag(label))
+          set_meta_tag(label, data)
+        end
+      end
+    end
+
+    def set_meta_tag(key, value, options = {})
+      if value.presence && !options[:force]
+        meta_tags_container.send("#{ key }=", value)
+      end
+    end
+  end
+end

data/lib/meta_tags/engine.rb

@@ -0,0 +1,21 @@
+require "meta_tags/container"
+require "meta_tags/page_data_helper"
+require "meta_tags/controller"
+require "meta_tags/meta_taggable"
+require "meta_tags/meta_taggable_macro"
+
+module MetaTags
+  class Railtie < Rails::Engine
+    initializer "include controller config" do
+      ActiveSupport.on_load(:action_controller) do
+        include Controller
+      end
+    end
+
+    initializer "mix meta_taggable macro in Active Record" do
+      ActiveSupport.on_load(:active_record) do
+        include MetaTaggableMacro
+      end
+    end
+  end
+end

data/lib/meta_tags/meta_taggable.rb

@@ -0,0 +1,21 @@
+module MetaTags
+  module MetaTaggable
+    extend ActiveSupport::Concern
+
+    included do
+      has_one :meta_tags_list, class_name: "MetaTags::List",
+        as: :meta_taggable, dependent: :destroy
+      accepts_nested_attributes_for :meta_tags_list, allow_destroy: true,
+        reject_if: :all_blank
+
+      # Ensure nested form can be handled for Rails < 4
+      if respond_to?(:protected_attributes)
+        attr_accessible :meta_tags_list_attributes
+      end
+    end
+
+    def meta_tagged?
+      meta_tags_list.presence
+    end
+  end
+end

data/lib/meta_tags/meta_taggable_macro.rb

@@ -0,0 +1,15 @@
+module MetaTags
+  module MetaTaggableMacro
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      def acts_as_meta_taggable
+        include MetaTaggable
+      end
+    end
+
+    def meta_tagged?
+      false
+    end
+  end
+end

data/lib/meta_tags/page_data_helper.rb

@@ -0,0 +1,23 @@
+require "meta_tags/tags/base"
+require "meta_tags/tags/title"
+require "meta_tags/tags/description"
+require "meta_tags/tags/keywords"
+require "meta_tags/tags/image"
+require "meta_tags/tags/url"
+
+module MetaTags
+  module PageDataHelper
+    def process_meta_tag tag
+      if (processor = processors[tag])
+        processor.new(self).process!
+      end
+    end
+
+    def processors
+      @processors ||= %w(title description image keywords url).reduce({}) do |hash, tag|
+        hash[tag] = MetaTags::Tags.const_get(tag.camelize)
+        hash
+      end
+    end
+  end
+end

data/lib/meta_tags/tags/base.rb

@@ -0,0 +1,50 @@
+module MetaTags
+  module Tags
+    class Base
+      attr_accessor :controller
+
+      def initialize controller
+        @controller = controller
+      end
+
+      protected
+
+      def member_action?
+        controller.params.key?(:id)
+      end
+
+      def action_i18n label
+        options = modifier_options.merge(default: "")
+        I18n.t(action_key(label), options).presence
+      end
+
+      def action_key label
+        key = %w(meta_tags controller)
+        key << controller.params[:controller]
+        key << controller.params[:action]
+        key << label
+        key.join(".")
+      end
+
+      def instance
+        return controller.instance if controller.instance
+
+        @instance ||= if model_name
+          controller.instance_variable_get(:"@#{ model_name }")
+        end
+      end
+
+      def model_name
+        controller.class.model_name.presence
+      end
+
+      def modifier_options
+        @modifier_options ||= if controller.class.modifier_block
+          instance_eval(&controller.class.modifier_block)
+        else
+          {}
+        end
+      end
+    end
+  end
+end

data/lib/meta_tags/tags/description.rb

@@ -0,0 +1,40 @@
+require "truncate_html"
+
+module MetaTags
+  module Tags
+    class Description < Base
+      include TruncateHtmlHelper
+
+      def process!
+        meta_taggable_description || instance_description || action_name
+      end
+
+      private
+
+      def meta_taggable_description
+        instance && instance.meta_tagged? &&
+          instance.meta_tags_list.meta_description.presence
+      end
+
+      def instance_description
+        if instance
+          MetaTags.description_methods.each do |method|
+            if instance.respond_to?(method)
+              if (description = instance.send(method).presence)
+                return truncate_html(description, length: 250)
+              end
+            end
+          end
+
+          return nil
+        end
+      end
+
+      def action_name
+        if (action_name = action_i18n(:description))
+          return action_name
+        end
+      end
+    end
+  end
+end

data/lib/meta_tags/tags/image.rb

@@ -0,0 +1,23 @@
+module MetaTags
+  module Tags
+    class Image < Base
+      def process!
+        instance_image
+      end
+
+      private
+
+      def instance_image
+        if member_action?
+          MetaTags.image_methods.each do |method|
+            if instance.respond_to?(method) && instance.send(method)
+              return instance.send(method).url
+            end
+          end
+
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/meta_tags/tags/keywords.rb

@@ -0,0 +1,16 @@
+module MetaTags
+  module Tags
+    class Keywords < Base
+      def process!
+        meta_taggable_keywords
+      end
+
+      private
+
+      def meta_taggable_keywords
+        instance && instance.meta_tagged? &&
+          instance.meta_tags_list.meta_keywords.presence
+      end
+    end
+  end
+end