seorel 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9be1f063d4b6922248d3215633a98028d3f7cce1
-  data.tar.gz: 1494c970b2bc4ad181e78eab57928bd30694c9c7
+  metadata.gz: 1c479f1d7dfaa791665b2a20d1a5ef1c2baa7f63
+  data.tar.gz: 2380c00e8e501060c1d35f989032d55e3bd6d381
 SHA512:
-  metadata.gz: ea6d3f1b88a10a0597364535d69a3507a00ee8366e2b6a44e7e8f2ad8b657ef52318e3edd630edbb04b1d0ba0679d6d66b416ecdde772d29b1c54050f58b3221
-  data.tar.gz: 9619a225614c03a932bf1ac28d9f70fa9e85165b5790d74747a74d78b18e7c946299664174f673d68d646e779ba544fd7e9e41516c619c8b62dfad192bdcb8ec
+  metadata.gz: f4dbcdcfb0364e06169211ca40126399386aba10ad4b873d8d9eacf781a1d3c11c64a23ee20116afe81200bd2c4bbc130f92b4a055a08fa7c212b93e8ce1ca82
+  data.tar.gz: d4aee49ecda37866939270ad873c169f44c94eeebfabe20abbf97614d5f4b5856f5a42b22f6a21d17183a91d3be53c3f2145611724e11b18bbe84fb56ed13133

data/README.md

@@ -41,6 +41,8 @@ Seorel.configure do |config|
   # config.default_prepend_description = nil
   # config.default_append_description  = nil
 
+  config.default_keywords = 'RUBY ON RAILS,SEO,METATAGS'
+
   config.default_image = 'http://www.example.com/share_image.png'
 
   # config.store_seorel_if = :empty # Available values :empty | :changed

data/lib/generators/seorel/install_generator.rb

@@ -1,5 +1,5 @@
 require 'rails/generators'
-require "rails/generators/active_record"
+require 'rails/generators/active_record'
 
 module Seorel
   # This generator adds a migration and aa configuration initializer
@@ -9,13 +9,21 @@ module Seorel
 
     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"
+    class_option :globalize, 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
+    def create_main_migration
       return if options['skip-migration']
-      migration_template 'migration.rb', 'db/migrate/create_seorel_seorels.rb'
+      migration_template 'migration.rb', 'db/migrate/create_seorel.rb'
+    end
+
+    def create_globalize_migration
+      if options['globalize']
+        migration_template 'globalize_migration.rb',
+                           'db/migrate/create_seorel_translations.rb'
+      end
     end
 
     def create_initializer
@@ -23,7 +31,7 @@ module Seorel
       copy_file 'initializer.rb', 'config/initializers/seorel.rb'
     end
 
-    def cpoy_sample_locale
+    def create_locale_file
       copy_file 'seorel.en.yml', 'config/locales/seorel.en.yml'
     end
   end

data/lib/generators/seorel/templates/globalize_migration.rb

@@ -0,0 +1,13 @@
+class CreateSeorelTranslations < ActiveRecord::Migration
+  def up
+    Seorel::Seorel.create_translation_table!({
+                                               title: :string,
+                                               description: :string,
+                                               image: :string
+                                             }, migrate_data: true)
+  end
+
+  def down
+    Seorel::Seorel.drop_translation_table!
+  end
+end

data/lib/generators/seorel/templates/initializer.rb

@@ -1,21 +1,49 @@
-# encoding: utf-8
+# Decomment this line if you want to use Globalize to magage seo translations
+# require 'seorel/globalize'
+
+# Seorel configurations:
 Seorel.configure do |config|
+  ###
+  # Title meta tag configurations:
+  #
   # config.default_prepend_title = nil
   # config.default_title = nil
   # config.default_append_title  = nil
+
+  ###
+  # Description meta tag configurations:
   #
   # config.default_prepend_description = nil
   # config.default_description = nil
   # config.default_append_description  = nil
+
+  ###
+  # Configure a default meta keywords:
+  #
+  # config.default_keywords = 'Ruby on Rails,Seorel,SEO'
+
+  ###
+  # Configure a default share image:
   #
   # config.default_image = nil
+
+  ###
+  # Choose when to save seorel meta tags:
+  # - `:empty` Store values only if title o description are empty
+  # - `:changed` Store values on every record save
   #
   # config.store_seorel_if = :empty # Available values :empty | :changed
 
+  ###
+  # Add custom Open Graph meta tags:
+  #
   # config.default_og_metas = {
   #   type: 'website'
   # }
 
+  ###
+  # Add custom Twitter card meta tags:
+  #
   # config.default_twitter_metas = {
   #   card: 'summary_large_image'
   # }

data/lib/generators/seorel/templates/migration.rb

@@ -1,4 +1,4 @@
-class CreateSeorelSeorels < ActiveRecord::Migration
+class CreateSeorel < ActiveRecord::Migration[4.2]
   def self.up
     create_table :seorel_seorels do |t|
       t.string :title
@@ -9,7 +9,7 @@ class CreateSeorelSeorels < ActiveRecord::Migration
       t.timestamps
     end
 
-    add_index :seorel_seorels, [:seorelable_id, :seorelable_type]
+    add_index :seorel_seorels, %i[seorelable_id seorelable_type]
   end
 
   def self.down

data/lib/seorel.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Seorel
 end
 

data/lib/seorel/configuration.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 require 'active_support/configurable'
 
 module Seorel
@@ -11,6 +13,7 @@ module Seorel
     config_accessor :default_prepend_description
     config_accessor :default_description
     config_accessor :default_append_description
+    config_accessor :default_keywords
     config_accessor :default_image
     config_accessor :store_seorel_if
     config_accessor :default_og_metas
@@ -21,17 +24,19 @@ module Seorel
     end
 
     # define param_name writer (copied from AS::Configurable)
-    writer, line = 'def param_name=(value); config.param_name = value; end', __LINE__
+    writer = 'def param_name=(value); config.param_name = value; end'
+    line = __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_append_title = nil
       self.default_prepend_description = nil
       self.default_description = nil
-      self.default_append_description  = nil
+      self.default_append_description = nil
+      self.default_keywords = {}
       self.default_image = nil
       self.store_seorel_if = :empty
       self.default_og_metas = {}
@@ -41,16 +46,14 @@ module Seorel
 
   # Global settings for Seorel
   def self.config
-    @config ||= ::Seorel::Configuration.new.tap do |conf|
-      conf.initialize_defaults
-    end
+    @config ||= ::Seorel::Configuration.new.tap(&:initialize_defaults)
   end
 
   # Configures global settings for Seorel
   #   Seorel.configure do |config|
   #     config.default_default_title = 'Default website title'
   #   end
-  def self.configure(&block)
+  def self.configure
     yield(config)
   end
 

data/lib/seorel/controller/class_methods.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Seorel
   module Controller
     module ClassMethods
       def add_seorel_meta(values = {})
-        class_name = self.name
+        class_name = name
 
         before_filter options do |controller|
           controller.send :add_meta, values

data/lib/seorel/controller/instance_methods.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Seorel
   module Controller
     module InstanceMethods
@@ -8,7 +10,7 @@ module Seorel
         elsif obj.respond_to? :seorel
           add_seorel_model obj
         else
-          raise "Seorel `add_seorel_meta` invalid argument"
+          raise 'Seorel `add_seorel_meta` invalid argument'
         end
       end
 

data/lib/seorel/controller/params.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 require 'active_support/configurable'
 
 module Seorel
@@ -16,20 +18,24 @@ module Seorel
 
       def title
         [
-          self.lookup_prepend_title,
-          self.base_title,
-          self.lookup_append_title
+          lookup_prepend_title,
+          base_title,
+          lookup_append_title
         ].compact.join.html_safe
       end
 
       def description
         [
-          self.lookup_prepend_description,
-          self.base_description,
-          self.lookup_append_description
+          lookup_prepend_description,
+          base_description,
+          lookup_append_description
         ].compact.join.html_safe
       end
 
+      def keywords
+        default_options.default_keywords
+      end
+
       def image
         config.image || default_options.default_image
       end
@@ -44,63 +50,63 @@ module Seorel
 
       protected
 
-        attr_reader :controller
+      attr_reader :controller
 
-        def base_title
-          (config.title || self.lookup_title).html_safe
-        end
+      def base_title
+        (config.title || lookup_title).html_safe
+      end
 
-        def base_description
-          (config.description || self.lookup_description).html_safe
-        end
+      def base_description
+        (config.description || lookup_description).html_safe
+      end
 
-        def default_options
-          ::Seorel.config
-        end
+      def default_options
+        ::Seorel.config
+      end
 
-        def lookup_i18n(key, default = nil)
-          I18n.t i18n_path(key), default: (default || '')
-        end
+      def lookup_i18n(key, default = nil)
+        I18n.t i18n_path(key), default: (default || '')
+      end
 
-        def lookup_prepend_title
-          lookup_i18n :prepend_title, default_options.default_prepend_title
-        end
+      def lookup_prepend_title
+        lookup_i18n :prepend_title, default_options.default_prepend_title
+      end
 
-        def lookup_title
-          lookup_i18n :title, default_options.default_title
-        end
+      def lookup_title
+        lookup_i18n :title, default_options.default_title
+      end
 
-        def lookup_append_title
-          lookup_i18n :append_title, default_options.default_append_title
-        end
+      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_prepend_description
+        lookup_i18n :prepend_description, default_options.default_prepend_description
+      end
 
-        def lookup_description
-          lookup_i18n :description, default_options.default_description
-        end
+      def lookup_description
+        lookup_i18n :description, default_options.default_description
+      end
 
-        def lookup_append_description
-          lookup_i18n :append_description, default_options.default_append_description
-        end
+      def lookup_append_description
+        lookup_i18n :append_description, default_options.default_append_description
+      end
 
-        def controller_name
-          if controller
-            controller.class.name.underscore.gsub(/_controller$/, '')
-          else
-            'undefined'
-          end
+      def controller_name
+        if controller
+          controller.class.name.underscore.gsub(/_controller$/, '')
+        else
+          'undefined'
         end
+      end
 
-        def action_name
-          controller ? controller.action_name : 'undefined'
-        end
+      def action_name
+        controller ? controller.action_name : 'undefined'
+      end
 
-        def i18n_path(key)
-          ['seorel', self.controller_name, self.action_name, key].join('.')
-        end
+      def i18n_path(key)
+        ['seorel', controller_name, action_name, key].join('.')
+      end
     end
   end
 end

data/lib/seorel/engine.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails'
 require 'rails/engine'
 

data/lib/seorel/globalize.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'globalize'
+require 'seorel/seorel'
+require 'active_support/concern'
+
+module Seorel
+  module Globalize
+    extend ActiveSupport::Concern
+
+    included do
+      translates :title, :description, :image
+    end
+  end
+end
+
+Seorel::Seorel.include Seorel::Globalize

data/lib/seorel/helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'seorel/helper/manager'
 
 module Seorel

data/lib/seorel/helper/base.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 # require 'action_view/helpers/tag_helper/capture_helper'
 # require 'action_view/helpers/tag_helper'
 
-# encoding: utf-8
 module Seorel
   module Helper
     class Base
@@ -20,10 +22,10 @@ module Seorel
         ActionController::Base.helpers
       end
 
-      alias_method :h, :helpers
+      alias h helpers
 
-      # def h.content_tag(*args)
-      #   ActionView::Helpers::TagHelper.h.content_tag(*args)
+      # def h.tag(*args)
+      #   ActionView::Helpers::TagHelper.h.tag(*args)
       # end
 
       def locale

data/lib/seorel/helper/generic.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 require 'seorel/helper/base'
 
-# encoding: utf-8
 module Seorel
   module Helper
     class Generic < Base
@@ -9,13 +11,19 @@ module Seorel
       end
 
       def description_tag
-        h.content_tag :meta, nil, name: 'description', content: params.description
+        h.tag :meta, name: 'description', content: params.description
+      end
+
+      def keywords_tag
+        return if params.keywords.blank?
+        h.tag :meta, name: 'keywords', content: params.keywords
       end
 
       def all
         [
           title_tag,
-          description_tag
+          description_tag,
+          keywords_tag
         ].compact
       end
     end

data/lib/seorel/helper/manager.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 require 'seorel/helper/generic'
 require 'seorel/helper/open_graph'
 require 'seorel/helper/twitter'
 
-# encoding: utf-8
 module Seorel
   module Helper
     class Manager

data/lib/seorel/helper/open_graph.rb

@@ -1,27 +1,29 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 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
+        h.tag :meta, property: 'og:title', content: title
       end
 
       def description_tag
-        h.content_tag :meta, nil, property: 'og:description', content: description
+        h.tag :meta, property: 'og:description', content: description
       end
 
       def locale_tag
-        h.content_tag(:meta, nil, property: 'og:locale', content: locale)
+        h.tag(:meta, property: 'og:locale', content: locale)
       end
 
       def image_tag
-        h.content_tag(:meta, nil, property: 'og:image', content: image_url) if image
+        h.tag(:meta, property: 'og:image', content: image_url) if image
       end
 
       def url_tag
-        h.content_tag(:meta, nil, property: 'og:url', content: request.url)
+        h.tag(:meta, property: 'og:url', content: request.url)
       end
 
       def custom_tags
@@ -43,7 +45,7 @@ module Seorel
       protected
 
       def custum_tag(key, value)
-        h.content_tag(:meta, nil, property: "og:#{key}", content: value)
+        h.tag(:meta, property: "og:#{key}", content: value)
       end
     end
   end

data/lib/seorel/helper/twitter.rb

@@ -1,23 +1,25 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
 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
+        h.tag :meta, name: 'twitter:title', content: title
       end
 
       def description_tag
-        h.content_tag :meta, nil, name: 'twitter:description', content: description
+        h.tag :meta, name: 'twitter:description', content: description
       end
 
       def image_tag
-        h.content_tag(:meta, nil, name: 'twitter:image', content: image_url) if image
+        h.tag(:meta, name: 'twitter:image', content: image_url) if image
       end
 
       def url_tag
-        h.content_tag(:meta, nil, name: 'twitter:url', content: request.url)
+        h.tag(:meta, name: 'twitter:url', content: request.url)
       end
 
       def custom_tags
@@ -38,7 +40,7 @@ module Seorel
       protected
 
       def custum_tag(key, value)
-        h.content_tag(:meta, nil, name: "twitter:#{key}", content: value)
+        h.tag(:meta, name: "twitter:#{key}", content: value)
       end
     end
   end

data/lib/seorel/model/base.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Seorel
   module Model
     module Base
@@ -18,11 +20,16 @@ module Seorel
           class_variable_set '@@seorel_image_field',       args[2]
         end
 
-        has_one :seorel, as: :seorelable, dependent: :destroy, class_name: 'Seorel::Seorel'
+        has_one :seorel, as: :seorelable,
+                         dependent: :destroy,
+                         class_name: 'Seorel::Seorel',
+                         autosave: true,
+                         inverse_of: :seorelable
+
         accepts_nested_attributes_for :seorel, allow_destroy: true
 
         delegate :title, :title?, :description, :description?, :image, :image?,
-          to: :seorel, prefix: :seo, allow_nil: true
+                 to: :seorel, prefix: :seo, allow_nil: true
 
         before_save :set_seorel
       end

data/lib/seorel/model/class_methods.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Seorel
   module Model
     module ClassMethods

data/lib/seorel/model/instance_methods.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Seorel
   module Model
     module InstanceMethods
       def seorel?
-        self.try(:seorel).present?
+        try(:seorel).present?
       end
 
       def seorel_changed_mode?
@@ -11,37 +13,37 @@ module Seorel
       end
 
       def should_update_seo_title?
-        self.seorel_changed_mode? || !self.seo_title?
+        seorel_changed_mode? || !seo_title?
       end
 
       def should_update_seo_description?
-        self.seorel_changed_mode? || !self.seo_description?
+        seorel_changed_mode? || !seo_description?
       end
 
       def should_update_seo_image?
-        self.seorel_changed_mode? || !self.seo_image?
+        seorel_changed_mode? || !seo_image?
       end
 
       def set_seorel
-        self.build_seorel unless self.seorel?
+        build_seorel unless seorel?
 
-        self.seorel.title       = self.seorel_title_value       if self.should_update_seo_title?
-        self.seorel.description = self.seorel_description_value if self.should_update_seo_description?
-        self.seorel.image       = self.seorel_image_value       if self.should_update_seo_image?
+        seorel.title       = seorel_title_value       if should_update_seo_title?
+        seorel.description = seorel_description_value if should_update_seo_description?
+        seorel.image       = seorel_image_value       if should_update_seo_image?
       end
 
       def seorel_title_value
-        raw_title = self.class.seorel_title_field && self.send(self.class.seorel_title_field)
+        raw_title = self.class.seorel_title_field && send(self.class.seorel_title_field)
         ::ActionController::Base.helpers.strip_tags(raw_title.to_s).first(255)
       end
 
       def seorel_description_value
-        raw_description = self.class.seorel_description_field && self.send(self.class.seorel_description_field)
+        raw_description = self.class.seorel_description_field && send(self.class.seorel_description_field)
         ::ActionController::Base.helpers.strip_tags(raw_description.to_s).first(255)
       end
 
       def seorel_image_value
-        raw_image = self.class.seorel_image_field && self.send(self.class.seorel_image_field)
+        raw_image = self.class.seorel_image_field && send(self.class.seorel_image_field)
         ::ActionController::Base.helpers.strip_tags(raw_image.to_s)
       end
 

data/lib/seorel/seorel.rb

@@ -1,23 +1,25 @@
+# frozen_string_literal: true
+
 require 'active_record'
 
 module Seorel
   class Seorel < ::ActiveRecord::Base
-    belongs_to :seorelable, polymorphic: true, touch: true
+    belongs_to :seorelable, polymorphic: true, touch: true, inverse_of: :seorel
 
     def title?
-      self.title.present?
+      title.present?
     end
 
     def description?
-      self.description.present?
+      description.present?
     end
 
     def image?
-      self.image.present?
+      image.present?
     end
 
     def admin_label
-      I18n.t("seorel.admin.label")
+      I18n.t('seorel.admin.label')
     end
   end
 end

data/lib/seorel/seorelify.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
 # encoding: utf-8
+
 module Seorelify
   def self.extended(model_class)
     return if model_class.respond_to? :seorel

data/lib/seorel/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Seorel
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'.freeze
 end

data/lib/tasks/seorel_tasks.rake

@@ -1,6 +1,6 @@
-# encoding: utf-8
+
 namespace :seorel do
-  desc "Seorel installation"
+  desc 'Seorel installation'
   task install: [:environment] do
     # Task goes here
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: seorel
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Andrea Dal Ponte
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-10 00:00:00.000000000 Z
+date: 2017-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -107,6 +107,7 @@ files:
 - config/locales/en.seorel.yml
 - config/locales/it.seorel.yml
 - lib/generators/seorel/install_generator.rb
+- lib/generators/seorel/templates/globalize_migration.rb
 - lib/generators/seorel/templates/initializer.rb
 - lib/generators/seorel/templates/migration.rb
 - lib/generators/seorel/templates/seorel.en.yml
@@ -116,6 +117,7 @@ files:
 - lib/seorel/controller/instance_methods.rb
 - lib/seorel/controller/params.rb
 - lib/seorel/engine.rb
+- lib/seorel/globalize.rb
 - lib/seorel/helper.rb
 - lib/seorel/helper/base.rb
 - lib/seorel/helper/generic.rb
@@ -149,9 +151,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Ruby on Rails SEO Metatags engine for ActiveRecord models
 test_files: []
-has_rdoc: