meta_tags 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7d7c3be2f90a4bf1e3a4fd71868bf3f70206077f
-  data.tar.gz: e8f7122e74b90b721931040e293afdafcc39a815
+  metadata.gz: 09a5a32f00942761acacbede938e26c47a3e1ccf
+  data.tar.gz: 85cd2cc73a51304adaf9cc9b9a5454643a3903db
 SHA512:
-  metadata.gz: 6eb4ae7f68556a5f7ad40b90571b9d2308a5851428f9aa7bce7609e937da80f1f1ac3c26814b83bce09a7a7083ab39f87869af0717ed4e2b089aa35dbdb2e45f
-  data.tar.gz: 1e0534967227d8cdca13a676d582864011fbd4b8f4927516dde521d798bc95022e03082fb59b57127f975c977c9d2bfd9980b3f6f9b65c700ba015ca920bd928
+  metadata.gz: a4f64085f847531a73a741a278b7ae4ceb5dcedad58e1bec53f468a51fce5ec9c57dab0fb82b9ed72a4ba7a2940c5c52ea89809e9bed515abbe4e2bc6ce408aa
+  data.tar.gz: 060ac92075fe6d8885c79060d3b8d1acd175be1b4667fbe6ca22564825b26135f07479a7a9febbee1a24e6cd35b0e5d181378a15ce2b85a1b8f169a84f274cbb

data/lib/generators/meta_tags/{config/config_generator.rb → install/install_generator.rb}

@@ -1,17 +1,12 @@
 module MetaTags
-  class ConfigGenerator < Rails::Generators::Base
+  class InstallGenerator < 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
+    desc "Meta-tags install generator"
 
     def copy_initializer_file
-      say "Installing default initializer template"
       copy_file "initializer.rb", "config/initializers/meta_tags.rb"
     end
 
@@ -19,4 +14,4 @@ module MetaTags
       rake "meta_tags_railtie:install:migrations"
     end
   end
-end
+end

data/lib/generators/meta_tags/{config → install}/templates/initializer.rb

@@ -1,7 +1,4 @@
-# encoding: utf-8
-
 MetaTags.config do |config|
-
   # Default title methods to be checked for title
   #
   # config.title_methods = %w(title name)
@@ -22,4 +19,4 @@ MetaTags.config do |config|
   # Defaults to true
   #
   # config.keep_default_title_present = false
-end
+end

data/lib/meta_tags.rb

@@ -1,6 +1,17 @@
 require "meta_tags/engine"
 
 module MetaTags
+  extend ActiveSupport::Autoload
+
+  autoload :Controller
+  autoload :MetaTaggable
+  autoload :MetaTaggableMacro
+  autoload :Renderer
+  autoload :Store
+  autoload :Tags
+  autoload :Vendors
+  autoload :ViewHelpers
+
   mattr_accessor :title_methods
   @@title_methods = %w(title name)
 
@@ -10,8 +21,8 @@ module MetaTags
   mattr_accessor :image_methods
   @@image_methods = %w(image picture avatar)
 
-  mattr_accessor :keep_default_title_present
-  @@keep_default_title_present = true
+  mattr_accessor :defaults
+  @@defaults = nil
 
   class << self
     def config

data/lib/meta_tags/controller.rb

@@ -1,130 +1,31 @@
 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
+      helper_method :meta_tags_store
     end
 
-    attr_reader :instance
-
-    def meta_tags_container
-      @_meta_tags_container ||= ::ApplicationController.meta_tags.dup
+    def meta_tags_store
+      @meta_tags_store ||= MetaTags::Store.new(self)
     end
 
-    def meta_tags_data
-      process_meta_tags
-      meta_tags_container
-    end
+    protected
 
     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)
+        [:title, :description, :keywords].each do |tag_name|
+          if (value = list.send(:"meta_#{ tag_name }").presence)
+            set_meta_tag(tag_name, 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
+    def set_meta_tag(tag_name, value)
+      meta_tags_store.send(:"#{ tag_name }=", value)
     end
   end
 end

data/lib/meta_tags/engine.rb

@@ -1,21 +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
+    initializer "include controller helpers" do
       ActiveSupport.on_load(:action_controller) do
         include Controller
       end
     end
 
+    initializer "include view helpers" do
+      ActiveSupport.on_load(:action_view) do
+        include ViewHelpers
+      end
+    end
+
     initializer "mix meta_taggable macro in Active Record" do
       ActiveSupport.on_load(:active_record) do
         include MetaTaggableMacro
       end
     end
   end
-end
+end

data/lib/meta_tags/meta_taggable.rb

@@ -17,5 +17,11 @@ module MetaTags
     def meta_tagged?
       meta_tags_list.presence
     end
+
+    module ClassMethods
+      def meta_taggable?
+        true
+      end
+    end
   end
-end
+end

data/lib/meta_tags/meta_taggable_macro.rb

@@ -2,14 +2,18 @@ module MetaTags
   module MetaTaggableMacro
     extend ActiveSupport::Concern
 
+    def meta_tagged?
+      false
+    end
+
     module ClassMethods
       def acts_as_meta_taggable
         include MetaTaggable
       end
-    end
 
-    def meta_tagged?
-      false
+      def meta_taggable?
+        false
+      end
     end
   end
-end
+end

data/lib/meta_tags/renderer.rb

@@ -0,0 +1,69 @@
+module MetaTags
+  class Renderer
+    LINE_SEPARATOR = "\n"
+
+    attr_reader :template, :vendors
+
+    delegate :content_tag, :tag, to: :template
+
+    def initialize(template, vendors: nil)
+      @template = template
+      @vendors = vendors
+    end
+
+    def render
+      [
+        charset_tag,
+        title_tag,
+        description_tag,
+        keywords_tag,
+        vendor_tags
+      ].compact.join(LINE_SEPARATOR).html_safe
+    end
+
+    private
+
+    def title_tag
+      if (title = meta_tags.title).present?
+        content_tag(:title, title)
+      end
+    end
+
+    def charset_tag
+      tag(:meta, charset: meta_tags.charset)
+    end
+
+    def description_tag
+      if (description = meta_tags.description).present?
+        tag(:meta, name: 'description', value: description)
+      end
+    end
+
+    def keywords_tag
+      if (keywords = meta_tags.keywords).present?
+        tag(:meta, name: 'keywords', value: keywords)
+      end
+    end
+
+    def vendor_tags
+      return unless vendors
+
+      vendor_tags = vendors.each_with_object([]) do |vendor_name, tags|
+        vendor_class = MetaTags::Vendors.for(vendor_name)
+        vendor = vendor_class.new(template)
+
+        vendor.tags.each do |tag_name|
+          if (value = meta_tags.send(tag_name)).present?
+            tags << vendor.render(tag_name, value)
+          end
+        end
+      end
+
+      vendor_tags.join(LINE_SEPARATOR)
+    end
+
+    def meta_tags
+      @meta_tags ||= template.controller.meta_tags_store
+    end
+  end
+end

data/lib/meta_tags/store.rb

@@ -0,0 +1,48 @@
+module MetaTags
+  class Store
+    attr_reader :controller, :defaults
+
+    TAGS = :title, :description, :image, :url, :site_name, :keywords, :type,
+           :site, :card, :charset
+
+    attr_writer *TAGS
+
+    def initialize(controller)
+      @controller = controller
+
+      @defaults = if MetaTags.defaults
+        controller.instance_exec(&MetaTags.defaults)
+      else
+        {}
+      end
+    end
+
+    def charset
+      @charset ||= 'utf-8'
+    end
+
+    TAGS.each do |tag_name|
+      define_method(tag_name) do
+        fetch_value_for(tag_name)
+      end unless method_defined?(tag_name)
+    end
+
+    private
+
+    def fetch_value_for(tag_name)
+      ivar_name = :"@#{ tag_name }"
+
+      if (value = instance_variable_get(ivar_name)).present?
+        value
+      else
+        value = if (processor = MetaTags::Tags[tag_name])
+          processor.new(controller).value
+        end
+
+        value = defaults[tag_name] unless value.present?
+
+        instance_variable_set(ivar_name, value) if value
+      end
+    end
+  end
+end

data/lib/meta_tags/tags.rb

@@ -0,0 +1,25 @@
+module MetaTags
+  module Tags
+    extend ActiveSupport::Autoload
+
+    autoload :Base
+    autoload :Title
+    autoload :Description
+    autoload :Keywords
+    autoload :Image
+    autoload :Url
+
+    def self.[](tag_name)
+      processors[tag_name]
+    end
+
+    private
+
+    def self.processors
+      @processors ||= [:title, :description, :keywords, :image, :url].reduce({}) do |hash, tag|
+        hash[tag] = MetaTags::Tags.const_get(tag.to_s.camelize)
+        hash
+      end
+    end
+  end
+end

data/lib/meta_tags/tags/base.rb

@@ -3,7 +3,7 @@ module MetaTags
     class Base
       attr_accessor :controller
 
-      def initialize controller
+      def initialize(controller)
         @controller = controller
       end
 
@@ -13,12 +13,11 @@ module MetaTags
         controller.params.key?(:id)
       end
 
-      def action_i18n label
-        options = modifier_options.merge(default: "")
-        I18n.t(action_key(label), options).presence
+      def action_i18n(label)
+        I18n.t(action_key(label), default: '').presence
       end
 
-      def action_key label
+      def action_key(label)
         key = %w(meta_tags controller)
         key << controller.params[:controller]
         key << controller.params[:action]
@@ -26,24 +25,13 @@ module MetaTags
         key.join(".")
       end
 
+      # TODO : Define if we'll still support instance meta tags and refactor
+      #        accordingly
       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
+        @model_name ||= controller.class.name.gsub(/Controller$/, '').singularize.underscore
       end
     end
   end

data/lib/meta_tags/tags/description.rb

@@ -5,7 +5,7 @@ module MetaTags
     class Description < Base
       include TruncateHtmlHelper
 
-      def process!
+      def value
         meta_taggable_description || instance_description || action_name
       end
 
@@ -37,4 +37,4 @@ module MetaTags
       end
     end
   end
-end
+end

data/lib/meta_tags/tags/image.rb

@@ -1,7 +1,7 @@
 module MetaTags
   module Tags
     class Image < Base
-      def process!
+      def value
         instance_image
       end
 
@@ -20,4 +20,4 @@ module MetaTags
       end
     end
   end
-end
+end

data/lib/meta_tags/tags/keywords.rb

@@ -1,7 +1,7 @@
 module MetaTags
   module Tags
     class Keywords < Base
-      def process!
+      def value
         meta_taggable_keywords
       end
 
@@ -13,4 +13,4 @@ module MetaTags
       end
     end
   end
-end
+end

data/lib/meta_tags/tags/title.rb

@@ -1,7 +1,7 @@
 module MetaTags
   module Tags
     class Title < Base
-      def process!
+      def value
         meta_taggable_title || instance_title || action_name || model_name_translation
       end
 
@@ -41,4 +41,4 @@ module MetaTags
       end
     end
   end
-end
+end

data/lib/meta_tags/tags/url.rb

@@ -1,9 +1,9 @@
 module MetaTags
   module Tags
     class Url < Base
-      def process!
+      def value
         controller.request.original_url
       end
     end
   end
-end
+end

data/lib/meta_tags/vendors.rb

@@ -0,0 +1,13 @@
+module MetaTags
+  module Vendors
+    extend ActiveSupport::Autoload
+
+    autoload :Base
+    autoload :OpenGraph
+    autoload :Twitter
+
+    def self.for(vendor_name)
+      const_get(vendor_name.to_s.camelize)
+    end
+  end
+end

data/lib/meta_tags/vendors/base.rb

@@ -0,0 +1,21 @@
+module MetaTags
+  module Vendors
+    class Base
+      attr_reader :template
+
+      def initialize(template)
+        @template = template
+      end
+
+      def render(key, value)
+        tag(:meta, key_name => attribute_name_for(key), value: value)
+      end
+
+      protected
+
+      def attribute_name_for(key)
+        [namespace, key].join(':')
+      end
+    end
+  end
+end

data/lib/meta_tags/vendors/open_graph.rb

@@ -0,0 +1,19 @@
+module MetaTags
+  module Vendors
+    class OpenGraph
+      def tags
+        [:title, :description, :image, :type, :url, :site_name]
+      end
+
+      protected
+
+      def key_name
+        'property'
+      end
+
+      def namespace
+        'og'
+      end
+    end
+  end
+end

data/lib/meta_tags/vendors/twitter.rb

@@ -0,0 +1,19 @@
+module MetaTags
+  module Vendors
+    class Twitter
+      def tags
+        [:title, :description, :image, :url, :site, :card]
+      end
+
+      protected
+
+      def key_name
+        'name'
+      end
+
+      def namespace
+        'twitter'
+      end
+    end
+  end
+end

data/lib/meta_tags/version.rb

@@ -1,3 +1,3 @@
 module MetaTags
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/meta_tags/view_helpers.rb

@@ -0,0 +1,7 @@
+module MetaTags
+  module ViewHelpers
+    def meta_tags(options = {})
+      MetaTags::Renderer.new(self, options).render
+    end
+  end
+end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: meta_tags
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
-- Valentin Ballestrino, Damien Corticchiato
+- Valentin Ballestrino
+- Damien Corticchiato
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-31 00:00:00.000000000 Z
+date: 2015-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sanitize
@@ -52,7 +53,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 'Simple gem to handle basical title, meta tags and og: tags'
+description: HTML meta tags management for Rails with support for Facebook's OpenGraph
+  tags and Twitter cards
 email:
 - vala@glyph.fr
 executables: []
@@ -64,22 +66,28 @@ files:
 - Rakefile
 - app/models/meta_tags/list.rb
 - db/migrate/20140114154410_create_meta_tags_list.rb
-- lib/generators/meta_tags/config/config_generator.rb
-- lib/generators/meta_tags/config/templates/initializer.rb
+- lib/generators/meta_tags/install/install_generator.rb
+- lib/generators/meta_tags/install/templates/initializer.rb
 - lib/meta_tags.rb
-- lib/meta_tags/container.rb
 - lib/meta_tags/controller.rb
 - lib/meta_tags/engine.rb
 - lib/meta_tags/meta_taggable.rb
 - lib/meta_tags/meta_taggable_macro.rb
-- lib/meta_tags/page_data_helper.rb
+- lib/meta_tags/renderer.rb
+- lib/meta_tags/store.rb
+- lib/meta_tags/tags.rb
 - lib/meta_tags/tags/base.rb
 - lib/meta_tags/tags/description.rb
 - lib/meta_tags/tags/image.rb
 - lib/meta_tags/tags/keywords.rb
 - lib/meta_tags/tags/title.rb
 - lib/meta_tags/tags/url.rb
+- lib/meta_tags/vendors.rb
+- lib/meta_tags/vendors/base.rb
+- lib/meta_tags/vendors/open_graph.rb
+- lib/meta_tags/vendors/twitter.rb
 - lib/meta_tags/version.rb
+- lib/meta_tags/view_helpers.rb
 - lib/tasks/meta_tags_tasks.rake
 - test/dummy/README.rdoc
 - test/dummy/Rakefile
@@ -155,7 +163,7 @@ files:
 - test/dummy/tmp/cache/assets/E10/A50/sprockets%2F3ceec61ba671c1fc8fec279989fb9d1d
 - test/meta_tags_test.rb
 - test/test_helper.rb
-homepage: http://glyph.fr
+homepage: https://github.com/glyph-fr/meta_tags
 licenses: []
 metadata: {}
 post_install_message: 
@@ -177,7 +185,7 @@ rubyforge_project:
 rubygems_version: 2.4.4
 signing_key: 
 specification_version: 4
-summary: 'Simple gem to handle basical title, meta tags and og: tags'
+summary: HTML meta tags management for Rails
 test_files:
 - test/dummy/app/assets/images/illustration.jpg
 - test/dummy/app/assets/javascripts/application.js

data/lib/meta_tags/container.rb

@@ -1,67 +0,0 @@
-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/page_data_helper.rb

@@ -1,23 +0,0 @@
-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