RubyGems - seorel - Versions diffs - 0.2.3 → 0.3.0 - Mend

seorel 0.2.3 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (19) hide show

checksums.yaml +4 -4
data/README.md +30 -22
data/lib/generators/seorel/install_generator.rb +30 -0
data/lib/{seorel → generators/seorel/templates}/initializer.rb +8 -0
data/lib/{seorel → generators/seorel/templates}/migration.rb +0 -2
data/lib/generators/seorel/templates/seorel.en.yml +21 -0
data/lib/seorel.rb +1 -2
data/lib/seorel/{config.rb → configuration.rb} +34 -24
data/lib/seorel/controller/params.rb +44 -34
data/lib/seorel/engine.rb +1 -0
data/lib/seorel/helper.rb +5 -33
data/lib/seorel/helper/base.rb +54 -0
data/lib/seorel/helper/generic.rb +23 -0
data/lib/seorel/helper/manager.rb +37 -0
data/lib/seorel/helper/open_graph.rb +50 -0
data/lib/seorel/helper/twitter.rb +45 -0
data/lib/seorel/version.rb +1 -1
metadata +13 -7
data/lib/generators/seorel_generator.rb +0 -25

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6585b1d055ca9a4ac74f5fa13af45fa4a2ba6ae9
-  data.tar.gz: 736e21c5bd0c12627d957d5e44b2fd424de8026e
+  metadata.gz: 9be1f063d4b6922248d3215633a98028d3f7cce1
+  data.tar.gz: 1494c970b2bc4ad181e78eab57928bd30694c9c7
 SHA512:
-  metadata.gz: d5e9e395e3919ecae1258b3d3631b940b4d765264e99142cdc00dba63a223183598ac7d696633f86fd7cc4d4caa5203ff6b0c4ee3d5ed388d1f44672edf7e1e6
-  data.tar.gz: 9230156832dde269a8822224d136f70e29bfaa6afaf79f134438daf2cff76732c2a2e5ea8cd24a2d43fbcb7567769b4195b0b94bc2b447efc06cac885281d3ce
+  metadata.gz: ea6d3f1b88a10a0597364535d69a3507a00ee8366e2b6a44e7e8f2ad8b657ef52318e3edd630edbb04b1d0ba0679d6d66b416ecdde772d29b1c54050f58b3221
+  data.tar.gz: 9619a225614c03a932bf1ac28d9f70fa9e85165b5790d74747a74d78b18e7c946299664174f673d68d646e779ba544fd7e9e41516c619c8b62dfad192bdcb8ec

data/README.md CHANGED Viewed

@@ -2,8 +2,8 @@
 Ruby on Rails SEO Metatags plugins for ActiveRecord models
-[![Gem Version](https://badge.fury.io/rb/seorel.png)](http://badge.fury.io/rb/seorel)
-[![Code Climate](https://codeclimate.com/github/dalpo/seorel.png)](https://codeclimate.com/github/dalpo/seorel)
+[![Gem Version](https://badge.fury.io/rb/seorel.svg)](https://badge.fury.io/rb/seorel)
+[![Code Climate](https://codeclimate.com/github/dalpo/seorel/badges/gpa.svg)](https://codeclimate.com/github/dalpo/seorel)
 [![Build Status](https://travis-ci.org/dalpo/seorel.svg?branch=master)](https://travis-ci.org/dalpo/seorel)
 ## Rails Setup
@@ -12,7 +12,7 @@ Ruby on Rails SEO Metatags plugins for ActiveRecord models
 `Gemfile.rb`:
 ```ruby
-gem 'seorel', '~> 0.2.3'
+gem 'seorel', '~> 0.3.0'
 # the edge version can be had using:
 # gem 'seorel', github: 'dalpo/seorel'
@@ -21,40 +21,46 @@ gem 'seorel', '~> 0.2.3'
 `Console`:
 ```bash
 $ bundle install
-$ bundle exec rails generate seorel
+$ bundle exec rails generate seorel:install
 $ bundle exec rake db:migrate
 ```
-## Generate configuration initializer for the default options
+It will generate the `seorel.rb` initializer and a new migration.
-```bash
-% rails generate seorel:config
-```
+### Configurations
-Will generate the `seorel_config.rb` initializer to customize the default values:
+You could change default meta tags values into the seorel initializer:
 ```ruby
 Seorel.configure do |config|
+  config.default_title = 'My default page title goes here'
   # config.default_prepend_title = nil
-  # config.default_title = nil
-  # config.default_append_title  = nil
-  #
+  config.default_append_title  = ' / Every title will be appended with this string'
+  config.default_description = 'Lorem ipsum sit dolor...'
   # config.default_prepend_description = nil
-  # config.default_description = nil
   # config.default_append_description  = nil
-  #
-  # config.default_image = nil
-  #
+  config.default_image = 'http://www.example.com/share_image.png'
   # config.store_seorel_if = :empty # Available values :empty | :changed
+  config.default_og_metas = {
+    type: 'website'
+  }
+  config.default_twitter_metas = {
+    card: 'summary_large_image'
+  }
 end
 ```
 ## Usage
-### Sample model
+### Usage with an active record model
+Given a sample model Post:
-For instance generate a post model:
 ```ruby
 rails generate model post title:string description:text, publish_date:date
 ```
@@ -63,7 +69,9 @@ Edit `app/models/post.rb`:
 ```ruby
 class Post < ActiveRecord::Base
   extend Seorelify
-  seorelify(title: :customized_title, description: :description, image: :share_image)
+  seorelify title: :customized_title, description: :description, image: :share_image
+  # Or more simply:
+  # seorelify :customized_title, :description, :share_image
   def customized_title
     "THE BLOG: #{self.title}"
@@ -147,7 +155,7 @@ In your layout &lt;head&gt;&lt;/head&gt; section just call the `render_meta_tags
 ```html
 <head>
-  <%=render_meta_tags %>
+  <%= render_meta_tags %>
   ...
 </head>
 ```
@@ -168,7 +176,7 @@ Submitting a Pull Request:
 ## This project rocks and uses MIT-LICENSE.
-Copyright 2014 Andrea Dal Ponte
+Copyright 2016 Andrea Dal Ponte
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/lib/generators/seorel/install_generator.rb ADDED Viewed

@@ -0,0 +1,30 @@
+require 'rails/generators'
+require "rails/generators/active_record"
+module Seorel
+  # This generator adds a migration and aa configuration initializer
+  class InstallGenerator < ActiveRecord::Generators::Base
+    # ActiveRecord::Generators::Base inherits from Rails::Generators::NamedBase which requires a NAME parameter for the
+    argument :name, type: :string, default: 'random_name'
+    class_option :'skip-migration',   type: :boolean, desc: "Don't generate a migration for the seorel table"
+    class_option :'skip-initializer', type: :boolean, desc: "Don't generate an initializer"
+    source_root File.expand_path('../templates', __FILE__)
+    # Copies the migration template to db/migrate.
+    def copy_files
+      return if options['skip-migration']
+      migration_template 'migration.rb', 'db/migrate/create_seorel_seorels.rb'
+    end
+    def create_initializer
+      return if options['skip-initializer']
+      copy_file 'initializer.rb', 'config/initializers/seorel.rb'
+    end
+    def cpoy_sample_locale
+      copy_file 'seorel.en.yml', 'config/locales/seorel.en.yml'
+    end
+  end
+end

data/lib/{seorel → generators/seorel/templates}/initializer.rb RENAMED Viewed

@@ -11,4 +11,12 @@ Seorel.configure do |config|
   # config.default_image = nil
   #
   # config.store_seorel_if = :empty # Available values :empty | :changed
+  # config.default_og_metas = {
+  #   type: 'website'
+  # }
+  # config.default_twitter_metas = {
+  #   card: 'summary_large_image'
+  # }
 end

data/lib/{seorel → generators/seorel/templates}/migration.rb RENAMED Viewed

@@ -9,8 +9,6 @@ class CreateSeorelSeorels < ActiveRecord::Migration
       t.timestamps
     end
-    add_index :seorel_seorels, :seorelable_id
-    add_index :seorel_seorels, :seorelable_type
     add_index :seorel_seorels, [:seorelable_id, :seorelable_type]
   end

data/lib/generators/seorel/templates/seorel.en.yml ADDED Viewed

@@ -0,0 +1,21 @@
+en:
+  seorel:
+    # Available keys:
+    #
+    # controller_name:
+    #   action_name:
+    #     prepend_title: '...'
+    #     title: '...'
+    #     append_title: '...'
+    #
+    #     prepend_description: '...'
+    #     description: '...'
+    #     append_description: '...'
+    #
+    #
+    # Example for a PostsController:
+    #
+    # posts:
+    #   index:
+    #     title: 'My title tag content for posts#index goes here'
+    #     description: 'My description meta tag content for posts#index goes here'

data/lib/seorel.rb CHANGED Viewed

@@ -3,7 +3,7 @@ end
 ###
 # Load Seorel components
-require 'seorel/config'
+require 'seorel/configuration'
 require 'seorel/engine'
 require 'seorel/seorel'
 require 'seorel/model/base'
@@ -14,4 +14,3 @@ require 'seorel/controller/class_methods'
 require 'seorel/controller/params'
 require 'seorel/seorelify'
 require 'seorel/helper'

data/lib/seorel/{config.rb → configuration.rb} RENAMED Viewed

@@ -2,21 +2,7 @@
 require 'active_support/configurable'
 module Seorel
-  # Configures global settings for Seorel
-  #   Seorel.configure do |config|
-  #     config.default_default_title = 10
-  #   end
-  def self.configure(&block)
-    yield @config ||= Seorel::Configuration.new
-  end
-  # Global settings for Seorel
-  def self.config
-    @config
-  end
-  # need a Class for 3.0
-  class Configuration #:nodoc:
+  class Configuration
     include ActiveSupport::Configurable
     config_accessor :default_prepend_title
@@ -27,6 +13,8 @@ module Seorel
     config_accessor :default_append_description
     config_accessor :default_image
     config_accessor :store_seorel_if
+    config_accessor :default_og_metas
+    config_accessor :default_twitter_metas
     def param_name
       config.param_name.respond_to?(:call) ? config.param_name.call : config.param_name
@@ -36,16 +24,38 @@ module Seorel
     writer, line = 'def param_name=(value); config.param_name = value; end', __LINE__
     singleton_class.class_eval writer, __FILE__, line
     class_eval writer, __FILE__, line
+    def initialize_defaults
+      self.default_prepend_title = nil
+      self.default_title = nil
+      self.default_append_title  = nil
+      self.default_prepend_description = nil
+      self.default_description = nil
+      self.default_append_description  = nil
+      self.default_image = nil
+      self.store_seorel_if = :empty
+      self.default_og_metas = {}
+      self.default_twitter_metas = {}
+    end
+  end
+  # Global settings for Seorel
+  def self.config
+    @config ||= ::Seorel::Configuration.new.tap do |conf|
+      conf.initialize_defaults
+    end
+  end
+  # Configures global settings for Seorel
+  #   Seorel.configure do |config|
+  #     config.default_default_title = 'Default website title'
+  #   end
+  def self.configure(&block)
+    yield(config)
   end
-  configure do |config|
-    config.default_prepend_title = nil
-    config.default_title = nil
-    config.default_append_title  = nil
-    config.default_prepend_description = nil
-    config.default_description = nil
-    config.default_append_description  = nil
-    config.default_image = nil
-    config.store_seorel_if = :empty
+  # Reset global settings for Seorel
+  def self.reset!
+    @config = nil
   end
 end

data/lib/seorel/controller/params.rb CHANGED Viewed

@@ -10,7 +10,7 @@ module Seorel
       config_accessor :description
       config_accessor :image
-      def initialize(controller)
+      def initialize(controller = nil)
         @controller = controller
       end
@@ -34,58 +34,68 @@ module Seorel
         config.image || default_options.default_image
       end
-      def base_title
-        (config.title || self.lookup_title).html_safe
+      def open_graph_extras
+        default_options.default_og_metas
       end
-      def base_description
-        (config.description || self.lookup_description).html_safe
+      def twitter_extras
+        default_options.default_twitter_metas
       end
-      def default_options
-        ::Seorel.config
-      end
+      protected
-      def lookup_i18n(key, default = nil)
-        I18n.t i18n_path(key), default: (default || '')
-      end
+        attr_reader :controller
-      def lookup_prepend_title
-        lookup_i18n :prepend_title, default_options.default_prepend_title
-      end
+        def base_title
+          (config.title || self.lookup_title).html_safe
+        end
-      def lookup_title
-        lookup_i18n :title, default_options.default_title
-      end
+        def base_description
+          (config.description || self.lookup_description).html_safe
+        end
-      def lookup_append_title
-        lookup_i18n :append_title, default_options.default_append_title
-      end
+        def default_options
+          ::Seorel.config
+        end
-      def lookup_prepend_description
-        lookup_i18n :prepend_description, default_options.default_prepend_description
-      end
+        def lookup_i18n(key, default = nil)
+          I18n.t i18n_path(key), default: (default || '')
+        end
-      def lookup_description
-        lookup_i18n :description, default_options.default_description
-      end
+        def lookup_prepend_title
+          lookup_i18n :prepend_title, default_options.default_prepend_title
+        end
-      def lookup_append_description
-        lookup_i18n :append_description, default_options.default_append_description
-      end
+        def lookup_title
+          lookup_i18n :title, default_options.default_title
+        end
-      protected
+        def lookup_append_title
+          lookup_i18n :append_title, default_options.default_append_title
+        end
+        def lookup_prepend_description
+          lookup_i18n :prepend_description, default_options.default_prepend_description
+        end
+        def lookup_description
+          lookup_i18n :description, default_options.default_description
+        end
-        def controller
-          @controller
+        def lookup_append_description
+          lookup_i18n :append_description, default_options.default_append_description
         end
         def controller_name
-          controller.class.name.underscore.gsub(/_controller$/, '')
+          if controller
+            controller.class.name.underscore.gsub(/_controller$/, '')
+          else
+            'undefined'
+          end
         end
         def action_name
-          controller.action_name
+          controller ? controller.action_name : 'undefined'
         end
         def i18n_path(key)

data/lib/seorel/engine.rb CHANGED Viewed

@@ -1,3 +1,4 @@
+require 'rails'
 require 'rails/engine'
 module Seorel

data/lib/seorel/helper.rb CHANGED Viewed

@@ -1,41 +1,13 @@
+require 'seorel/helper/manager'
 module Seorel
   module Helper
-    def seorel_locale
-      locale = (I18n.locale.to_s.size == 2) ? "#{I18n.locale}_#{I18n.locale}" : I18n.locale.to_s
-      "#{locale[0..1].downcase}_#{locale[3..4].upcase}"
+    def seorel_manager
+      @seorel_manager ||= ::Seorel::Helper::Manager.new(request, seorel_params)
     end
     def render_meta_tags
-      [render_title, render_description, render_open_graph, render_twitter_cards].join("\n").html_safe
-    end
-    def render_title
-      content_tag :title, seorel_params.title
-    end
-    def render_description
-      content_tag :meta, nil, name: 'description', content: seorel_params.description
-    end
-    def render_open_graph
-      [
-        content_tag(:meta, nil, property: 'og:type', content: 'website'),
-        content_tag(:meta, nil, property: 'og:url', content: request.url),
-        content_tag(:meta, nil, property: 'og:title', content: seorel_params.title),
-        content_tag(:meta, nil, property: 'og:description', content: seorel_params.description),
-        content_tag(:meta, nil, property: 'og:image', content: seorel_params.image),
-        content_tag(:meta, nil, property: 'og:locale', content: seorel_locale)
-      ].join("\n").html_safe
-    end
-    def render_twitter_cards
-      [
-        content_tag(:meta, nil, name: 'twitter:card', content: 'summary_large_image'),
-        content_tag(:meta, nil, name: 'twitter:url', content: request.url),
-        content_tag(:meta, nil, name: 'twitter:title', content: seorel_params.title),
-        content_tag(:meta, nil, name: 'twitter:description', content: seorel_params.description),
-        content_tag(:meta, nil, name: 'twitter:image', content: seorel_params.image)
-      ].join("\n").html_safe
+      seorel_manager.render
     end
   end
 end

data/lib/seorel/helper/base.rb ADDED Viewed

@@ -0,0 +1,54 @@
+# require 'action_view/helpers/tag_helper/capture_helper'
+# require 'action_view/helpers/tag_helper'
+# encoding: utf-8
+module Seorel
+  module Helper
+    class Base
+      # include ActionView::Helpers::TagHelper
+      attr_reader :request, :params
+      delegate :title, :description, :image, to: :params
+      def initialize(request, params)
+        @request = request
+        @params = params
+      end
+      def helpers
+        ActionController::Base.helpers
+      end
+      alias_method :h, :helpers
+      # def h.content_tag(*args)
+      #   ActionView::Helpers::TagHelper.h.content_tag(*args)
+      # end
+      def locale
+        if I18n.locale.to_s.size == 2
+          "#{I18n.locale}_#{I18n.locale.to_s.upcase}"
+        else
+          I18n.locale
+        end
+      end
+      def image_url
+        if /^(http|https|\/\/)/.match(image)
+          image
+        else
+          "#{request.protocol}#{request.host_with_port}#{image}"
+        end
+      end
+      def all
+        []
+      end
+      def render
+        all.join.html_safe
+      end
+    end
+  end
+end

data/lib/seorel/helper/generic.rb ADDED Viewed

@@ -0,0 +1,23 @@
+require 'seorel/helper/base'
+# encoding: utf-8
+module Seorel
+  module Helper
+    class Generic < Base
+      def title_tag
+        h.content_tag :title, title
+      end
+      def description_tag
+        h.content_tag :meta, nil, name: 'description', content: params.description
+      end
+      def all
+        [
+          title_tag,
+          description_tag
+        ].compact
+      end
+    end
+  end
+end

data/lib/seorel/helper/manager.rb ADDED Viewed

@@ -0,0 +1,37 @@
+require 'seorel/helper/generic'
+require 'seorel/helper/open_graph'
+require 'seorel/helper/twitter'
+# encoding: utf-8
+module Seorel
+  module Helper
+    class Manager
+      attr_reader :request, :params
+      def initialize(request, params)
+        @request = request
+        @params = params
+      end
+      def generic
+        @generic ||= ::Seorel::Helper::Generic.new(request, params)
+      end
+      def open_graph
+        @open_graph ||= ::Seorel::Helper::OpenGraph.new(request, params)
+      end
+      def twitter
+        @twitter ||= ::Seorel::Helper::Twitter.new(request, params)
+      end
+      def all
+        (generic.all + open_graph.all + twitter.all)
+      end
+      def render
+        all.join.html_safe
+      end
+    end
+  end
+end

data/lib/seorel/helper/open_graph.rb ADDED Viewed

@@ -0,0 +1,50 @@
+require 'seorel/helper/base'
+# encoding: utf-8
+module Seorel
+  module Helper
+    class OpenGraph < Base
+      def title_tag
+        h.content_tag :meta, nil, property: 'og:title', content: title
+      end
+      def description_tag
+        h.content_tag :meta, nil, property: 'og:description', content: description
+      end
+      def locale_tag
+        h.content_tag(:meta, nil, property: 'og:locale', content: locale)
+      end
+      def image_tag
+        h.content_tag(:meta, nil, property: 'og:image', content: image_url) if image
+      end
+      def url_tag
+        h.content_tag(:meta, nil, property: 'og:url', content: request.url)
+      end
+      def custom_tags
+        params.open_graph_extras.reduce([]) do |data, (key, value)|
+          data.push custum_tag(key, value)
+        end
+      end
+      def all
+        ([
+          title_tag,
+          description_tag,
+          locale_tag,
+          image_tag,
+          url_tag
+        ] + custom_tags).compact
+      end
+      protected
+      def custum_tag(key, value)
+        h.content_tag(:meta, nil, property: "og:#{key}", content: value)
+      end
+    end
+  end
+end

data/lib/seorel/helper/twitter.rb ADDED Viewed

@@ -0,0 +1,45 @@
+require 'seorel/helper/base'
+# encoding: utf-8
+module Seorel
+  module Helper
+    class Twitter < Base
+      def title_tag
+        h.content_tag :meta, nil, name: 'twitter:title', content: title
+      end
+      def description_tag
+        h.content_tag :meta, nil, name: 'twitter:description', content: description
+      end
+      def image_tag
+        h.content_tag(:meta, nil, name: 'twitter:image', content: image_url) if image
+      end
+      def url_tag
+        h.content_tag(:meta, nil, name: 'twitter:url', content: request.url)
+      end
+      def custom_tags
+        params.twitter_extras.reduce([]) do |data, (key, value)|
+          data.push custum_tag(key, value)
+        end
+      end
+      def all
+        ([
+          title_tag,
+          description_tag,
+          image_tag,
+          url_tag
+        ] + custom_tags).compact
+      end
+      protected
+      def custum_tag(key, value)
+        h.content_tag(:meta, nil, name: "twitter:#{key}", content: value)
+      end
+    end
+  end
+end

data/lib/seorel/version.rb CHANGED Viewed

@@ -1,3 +1,3 @@
 module Seorel
-  VERSION = '0.2.3'
+  VERSION = '0.3.0'
 end

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: seorel
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Andrea Dal Ponte
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-08-31 00:00:00.000000000 Z
+date: 2016-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -106,16 +106,22 @@ files:
 - Rakefile
 - config/locales/en.seorel.yml
 - config/locales/it.seorel.yml
-- lib/generators/seorel_generator.rb
+- lib/generators/seorel/install_generator.rb
+- lib/generators/seorel/templates/initializer.rb
+- lib/generators/seorel/templates/migration.rb
+- lib/generators/seorel/templates/seorel.en.yml
 - lib/seorel.rb
-- lib/seorel/config.rb
+- lib/seorel/configuration.rb
 - lib/seorel/controller/class_methods.rb
 - lib/seorel/controller/instance_methods.rb
 - lib/seorel/controller/params.rb
 - lib/seorel/engine.rb
 - lib/seorel/helper.rb
-- lib/seorel/initializer.rb
-- lib/seorel/migration.rb
+- lib/seorel/helper/base.rb
+- lib/seorel/helper/generic.rb
+- lib/seorel/helper/manager.rb
+- lib/seorel/helper/open_graph.rb
+- lib/seorel/helper/twitter.rb
 - lib/seorel/model/base.rb
 - lib/seorel/model/class_methods.rb
 - lib/seorel/model/instance_methods.rb
@@ -143,7 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project:
-rubygems_version: 2.4.6
+rubygems_version: 2.5.1
 signing_key:
 specification_version: 4
 summary: Ruby on Rails SEO Metatags engine for ActiveRecord models

data/lib/generators/seorel_generator.rb DELETED Viewed

@@ -1,25 +0,0 @@
-require 'rails/generators'
-require 'rails/generators/active_record'
-# This generator adds a migration and aa configuration initializer
-class SeorelGenerator < ActiveRecord::Generators::Base
-  # ActiveRecord::Generators::Base inherits from Rails::Generators::NamedBase which requires a NAME parameter for the
-  # new table name. Our generator always uses 'friendly_id_slugs', so we just set a random name here.
-  # argument :name, type: :string, default: 'random_name'
-  class_option :'skip-migration',   :type => :boolean, :desc => "Don't generate a migration for the seorel table"
-  class_option :'skip-initializer', :type => :boolean, :desc => "Don't generate an initializer"
-  source_root File.expand_path('../../seorel', __FILE__)
-  # Copies the migration template to db/migrate.
-  def copy_files
-    return if options['skip-migration']
-    migration_template 'migration.rb', 'db/migrate/create_seorel_seorels.rb'
-  end
-  def create_initializer
-    return if options['skip-initializer']
-    copy_file 'initializer.rb', 'config/initializers/seorel.rb'
-  end
-end