para-seo_tools 0.2.1

data/lib/para/seo_tools/meta_tags/renderer.rb

@@ -0,0 +1,80 @@
+module Para
+  module SeoTools
+    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,
+            canonical_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', content: description)
+          end
+        end
+
+        def keywords_tag
+          if (keywords = meta_tags.keywords).present?
+            tag(:meta, name: 'keywords', content: keywords)
+          end
+        end
+
+        def canonical_tag
+          if (canonical = meta_tags.canonical).present?
+            tag(:link, rel: 'canonical', href: canonical)
+          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
+  end
+end

data/lib/para/seo_tools/meta_tags/store.rb

@@ -0,0 +1,52 @@
+module Para
+  module SeoTools
+    module MetaTags
+      class Store
+        attr_reader :controller, :defaults
+
+        TAGS = :title, :description, :image, :url, :site_name, :keywords, :type,
+               :site, :card, :charset, :canonical
+
+        attr_writer *TAGS
+
+        def initialize(controller)
+          @controller = controller
+
+          @defaults = if Para::SeoTools.defaults
+            controller.instance_exec(&Para::SeoTools.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
+  end
+end

data/lib/para/seo_tools/meta_tags/tags/base.rb

@@ -0,0 +1,49 @@
+module Para
+  module SeoTools
+    module MetaTags
+      module Tags
+        class Base
+          attr_accessor :controller
+
+          def initialize(controller)
+            @controller = controller
+          end
+
+          # Overriding this method in subclasses allow to process the meta tag
+          # value before it is rendered, e.g. stripping HTML tags
+          #
+          def self.process(value)
+            value
+          end
+
+          protected
+
+          def member_action?
+            controller.params.key?(:id)
+          end
+
+          def action_i18n(label)
+            I18n.t(action_key(label), default: '').presence
+          end
+
+          def action_key(label)
+            key = %w(meta_tags controller)
+            key << controller.params[:controller]
+            key << controller.params[:action]
+            key << label
+            key.join(".")
+          end
+
+          # TODO : Define if we'll still support instance meta tags and refactor
+          #        accordingly
+          def instance
+          end
+
+          def model_name
+            @model_name ||= controller.class.name.gsub(/Controller$/, '').singularize.underscore
+          end
+        end
+      end
+    end
+  end
+end

data/lib/para/seo_tools/meta_tags/tags/description.rb

@@ -0,0 +1,54 @@
+module Para
+  module SeoTools
+    module MetaTags
+      module Tags
+        class Description < Base
+          def value
+            self.class.process(
+              meta_taggable_description || instance_description || action_name
+            )
+          end
+
+          def self.process(value)
+            Processor.new.process(value)
+          end
+
+          private
+
+          def meta_taggable_description
+            instance && instance.meta_tagged? &&
+              instance.meta_tags_list.meta_description.presence
+          end
+
+          def instance_description
+            if instance
+              Para::SeoTools.description_methods.each do |method|
+                if instance.respond_to?(method)
+                  if (description = instance.send(method).presence)
+                    return description
+                  end
+                end
+              end
+
+              return nil
+            end
+          end
+
+          def action_name
+            if (action_name = action_i18n(:description))
+              return action_name
+            end
+          end
+
+          class Processor
+            include ActionView::Helpers::TextHelper
+
+            def process(value)
+              truncate(sanitize(value, tags: []), length: 250)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/para/seo_tools/meta_tags/tags/image.rb

@@ -0,0 +1,46 @@
+module Para
+  module SeoTools
+    module MetaTags
+      module Tags
+        class Image < Base
+          def value
+            self.class.process(instance_image)
+          end
+
+          def self.process(value)
+            url = url_from(value)
+
+            if url.start_with?('http://')
+              url
+            else
+              request = RequestStore.store[:'para.seo_tools.request']
+              URI.join(request.url, url).to_s
+            end
+          end
+
+          private
+
+          def instance_image
+            if member_action?
+              Para::SeoTools.image_methods.each do |method|
+                if instance.respond_to?(method) && instance.send(method)
+                  return instance.send(method).url
+                end
+              end
+
+              nil
+            end
+          end
+
+          def self.url_from(value)
+            if Paperclip::Attachment === value
+              value.url(:thumb)
+            else
+              value.to_s
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/para/seo_tools/meta_tags/tags/keywords.rb

@@ -0,0 +1,20 @@
+module Para
+  module SeoTools
+    module MetaTags
+      module Tags
+        class Keywords < Base
+          def value
+            meta_taggable_keywords
+          end
+
+          private
+
+          def meta_taggable_keywords
+            instance && instance.meta_tagged? &&
+              instance.meta_tags_list.meta_keywords.presence
+          end
+        end
+      end
+    end
+  end
+end

data/lib/para/seo_tools/meta_tags/tags/title.rb

@@ -0,0 +1,48 @@
+module Para
+  module SeoTools
+    module MetaTags
+      module Tags
+        class Title < Base
+          def value
+            meta_taggable_title || instance_title || action_name || model_name_translation
+          end
+
+          private
+
+          def meta_taggable_title
+            instance && instance.meta_tagged? &&
+              instance.meta_tags_list.meta_title.presence
+          end
+
+          def instance_title
+            if instance
+              Para::SeoTools.title_methods.each do |method|
+                if instance.respond_to?(method) && (title = instance.send(method)).presence
+                  return title
+                end
+              end
+              return nil
+            end
+          end
+
+          def action_name
+            if (action_name = action_i18n(:title))
+              return action_name
+            end
+          end
+
+          def model_name_translation
+            return unless model_name
+            model_key = "activerecord.models.#{ model_name }"
+
+            if (translation = I18n.t("#{ model_key }.other", default: "").presence)
+              translation
+            elsif (translation = I18n.t(model_key, default: "").presence)
+              translation.pluralize
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/para/seo_tools/meta_tags/tags/url.rb

@@ -0,0 +1,13 @@
+module Para
+  module SeoTools
+    module MetaTags
+      module Tags
+        class Url < Base
+          def value
+            controller.request.original_url
+          end
+        end
+      end
+    end
+  end
+end

data/lib/para/seo_tools/meta_tags/tags.rb

@@ -0,0 +1,29 @@
+module Para
+  module SeoTools
+    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
+  end
+end

data/lib/para/seo_tools/meta_tags/vendors/base.rb

@@ -0,0 +1,27 @@
+module Para
+  module SeoTools
+    module MetaTags
+      module Vendors
+        class Base
+          include ActionView::Helpers::TagHelper
+
+          attr_reader :template
+
+          def initialize(template)
+            @template = template
+          end
+
+          def render(key, value)
+            tag(:meta, key_name => attribute_name_for(key), content: value)
+          end
+
+          protected
+
+          def attribute_name_for(key)
+            [namespace, key].join(':')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/para/seo_tools/meta_tags/vendors/open_graph.rb

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

data/lib/para/seo_tools/meta_tags/vendors/twitter.rb

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

data/lib/para/seo_tools/meta_tags/vendors.rb

@@ -0,0 +1,17 @@
+module Para
+  module SeoTools
+    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
+  end
+end

data/lib/para/seo_tools/meta_tags.rb

@@ -0,0 +1,12 @@
+module Para
+  module SeoTools
+    module MetaTags
+      extend ActiveSupport::Autoload
+
+      autoload :Renderer
+      autoload :Store
+      autoload :Tags
+      autoload :Vendors
+    end
+  end
+end

data/lib/para/seo_tools/routes.rb

@@ -0,0 +1,15 @@
+module Para
+  module SeoTools
+    class Routes < Para::Plugins::Routes
+      def draw
+        plugin :seo_tools do
+          crud_component :skeleton, scope: ':model' do
+            collection do
+              get :refresh
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/para/seo_tools/sitemap.rb

@@ -0,0 +1,13 @@
+module Para
+  module SeoTools
+    class Sitemap
+      def self.build
+        ::Sitemap::Generator.instance.load :host => Para::SeoTools.host do
+          Para::SeoTools::Skeleton.site.pages.each do |page|
+            literal page.path, page.sitemap_options
+          end
+        end
+      end
+    end
+  end
+end

data/lib/para/seo_tools/skeleton/page.rb

@@ -0,0 +1,71 @@
+module Para
+  module SeoTools
+    module Skeleton
+      class Page
+        include Rails.application.routes.url_helpers
+
+        attr_reader :name, :resource, :options, :locale
+
+        def initialize(name, path: nil, resource: nil, **options)
+          @name = name
+          @path = path
+          @resource = resource
+          @options = options
+
+          # Fetch locale on page build to allow calling the `page` skeleton
+          # method inside a `I18n.with_locale` block
+          #
+          @locale = options.fetch(:locale, I18n.locale)
+        end
+
+        def identifier
+          @identifier ||= [name, resource.try(:id)].compact.join(':')
+        end
+
+        def display_name
+          @display_name ||= [name, resource.try(:id)].compact.join(' #').humanize
+        end
+
+        def path
+          @path ||= find_route
+        end
+
+        def model
+          @model ||= self.class.model_for(identifier).tap do |page|
+            # Override path (i.e.: slug changed)
+            page.path = path if path.to_s != page.path
+            page.locale = locale
+            # Do not override meta tags if already present
+            page.defaults = options[:defaults] || {}
+          end
+        end
+
+        def sitemap_options
+          [:priority, :change_frequency].each_with_object({}) do |param, hash|
+            hash[param] = options[param] if options.key?(param)
+          end
+        end
+
+        private
+
+        # Find a route matching the name of the page, passing the resource
+        # for member routes to work out of the box
+        def find_route
+          if respond_to?(:"#{ name }_path")
+            send(:"#{ name }_path", resource)
+          end
+        end
+
+        def self.model_for(identifier)
+          models[identifier] ||= ::Para::SeoTools::Page.new(identifier: identifier)
+        end
+
+        def self.models
+          @models ||= Para::SeoTools::Page.all.each_with_object({}) do |page, hash|
+            hash[page.identifier] = page
+          end
+        end
+      end
+    end
+  end
+end

data/lib/para/seo_tools/skeleton/site.rb

@@ -0,0 +1,18 @@
+module Para
+  module SeoTools
+    module Skeleton
+      class Site
+        include Rails.application.routes.url_helpers
+
+        def page(name, options = {} , &block)
+          page = Skeleton::Page.new(name, options)
+          pages << page
+        end
+
+        def pages
+          @pages ||= []
+        end
+      end
+    end
+  end
+end

data/lib/para/seo_tools/skeleton/worker.rb

@@ -0,0 +1,11 @@
+module Para
+  module SeoTools
+    module Skeleton
+      class Worker
+        def self.perform
+          Para::SeoTools::Skeleton.build
+        end
+      end
+    end
+  end
+end