active_seo 0.1.4 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 525080ce2aac2173b8502c54a0462e1107aa33ffbc7fd44ed1272c625bf914f2
-  data.tar.gz: 98c4e96bca074d4b703c85245440dd07969a5ddaaac6b5497d738b1465dce9ba
+  metadata.gz: ccfaa6d6d06e56e1069ce9f772cdad765292afca2d5096e8660d7d3536ef7dab
+  data.tar.gz: 9eb42348cfc1cc48f4e4e714aef318bcb4b4000bbc27cac1250febc05bca4460
 SHA512:
-  metadata.gz: 65fca055c8fb103c030efef90a2bd2c829eb4e094517bea8ef0773959d76b5b669ed7871fe7092f3433227a4c7254d92929639eb8bd99ed1d1d59e67e781dfeb
-  data.tar.gz: 03b6ee51caade17b43ad8d3eff962a84dea0b9dcfa193d79026345fc446db7fd95c6d95a71822c780e245beaf6c43272d63c4aa4b95b7279a6734a0f95af5722
+  metadata.gz: 4bf0b1f6c3edd79892149b1b9593d85c85c836c106a8c8b6b5d0272a32987009421d2b3a0f9fd347983b5085d1241e0cb8c86ca8e771c2f08d9e5dae3e7de0b1
+  data.tar.gz: b9f80ca87e6e46870dc3822de98534a4120297234b9401aa7d1f662c622b198858327bfb2eba0bbc6173b18c6d1d0516dc571ae044d0cddb4375371880c35494

data/Gemfile.lock

@@ -0,0 +1,67 @@
+PATH
+  remote: .
+  specs:
+    active_seo (0.1.4)
+      actionview (~> 5.0)
+      active_delegate (~> 1.0)
+      activerecord (~> 5.0)
+      hashie (~> 3.5)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionview (5.2.2)
+      activesupport (= 5.2.2)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    active_delegate (1.0.2)
+      activerecord (~> 5.0)
+    activemodel (5.2.2)
+      activesupport (= 5.2.2)
+    activerecord (5.2.2)
+      activemodel (= 5.2.2)
+      activesupport (= 5.2.2)
+      arel (>= 9.0)
+    activesupport (5.2.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
+    builder (3.2.3)
+    concurrent-ruby (1.1.4)
+    crass (1.0.4)
+    erubi (1.8.0)
+    hashie (3.6.0)
+    i18n (1.4.0)
+      concurrent-ruby (~> 1.0)
+    loofah (2.2.3)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mini_portile2 (2.4.0)
+    minitest (5.11.3)
+    nokogiri (1.10.0)
+      mini_portile2 (~> 2.4.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    rake (10.5.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  active_seo!
+  bundler (~> 1.14)
+  minitest (~> 5.0)
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.17.3

data/README.md

@@ -170,12 +170,8 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/hardpixel/active-seo. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/hardpixel/active-seo.
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-
-## Code of Conduct
-
-Everyone interacting in the ActiveSeo project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/hardpixel/active-seo/blob/master/CODE_OF_CONDUCT.md).

data/lib/active_seo.rb

@@ -1,5 +1,5 @@
 require 'active_support'
-require 'action_view'
+require 'stringex'
 require 'hashie'
 require 'active_delegate'
 require 'active_seo/version'
@@ -7,7 +7,6 @@ require 'active_seo/version'
 module ActiveSeo
   extend ActiveSupport::Concern
 
-  # Autoload modules
   autoload :Config,         'active_seo/config'
   autoload :Helpers,        'active_seo/helpers'
   autoload :Contextualize,  'active_seo/contextualize'
@@ -17,13 +16,10 @@ module ActiveSeo
   autoload :SeoMetum,       'active_seo/seo_metum'
   autoload :Loader,         'active_seo/loader'
 
-  # Set attr accessors
   mattr_accessor :config
 
-  # Set config options
   @@config = Config.new
 
-  # Setup module config
   def self.setup
     yield config
   end

data/lib/active_seo/config.rb

@@ -1,6 +1,15 @@
 module ActiveSeo
+  class OpenGraphConfig < Hashie::Mash
+    self.disable_warnings
+  end
+
+  class TwitterCardConfig < Hashie::Mash
+    self.disable_warnings
+  end
+
   class Config < Hashie::Dash
-    # Set properties and defaults
+    property :class_name,           default: 'ActiveSeo::SeoMetum'
+    property :locale_accessors,     default: false
     property :title_limit,          default: 70
     property :description_limit,    default: 160
     property :keywords_limit,       default: 255
@@ -11,12 +20,12 @@ module ActiveSeo
     property :twitter,              default: {}
 
     def opengraph_setup(&block)
-      self.opengraph = Hashie::Mash.new
+      self.opengraph = OpenGraphConfig.new
       yield self.opengraph
     end
 
     def twitter_setup(&block)
-      self.twitter = Hashie::Mash.new
+      self.twitter = TwitterCardConfig.new
       yield self.twitter
     end
   end

data/lib/active_seo/contextualize.rb

@@ -5,7 +5,6 @@ module ActiveSeo
     included do
       attr_accessor :record, :config, :opengraph, :twitter
 
-      # Set class attributes
       class_attribute :model_og_meta
       class_attribute :model_twitter_meta
 

data/lib/active_seo/contextualizer.rb

@@ -19,41 +19,41 @@ module ActiveSeo
 
     private
 
-      def parse_meta(options)
-        meta = {}
-
-        if options.is_a? Hash
-          options.each do |key, value|
-            meta[key] = parse_values(key, value)
-          end
-        else
+    def parse_meta(options)
+      meta = {}
+
+      if options.is_a? Hash
+        options.each do |key, value|
           meta[key] = parse_values(key, value)
         end
-
-        meta
+      else
+        meta[key] = parse_values(key, value)
       end
 
-      def parse_values(key, value)
-        data = nil
+      meta
+    end
 
-        case value
-        when Symbol
-          data = get_record_value value
-        when Proc
-          data = call_record_proc value
-        else
-          data = value
-        end
+    def parse_values(key, value)
+      data = nil
 
-        data
+      case value
+      when Symbol
+        data = get_record_value value
+      when Proc
+        data = call_record_proc value
+      else
+        data = value
       end
 
-      def get_record_value(attribute)
-        try(attribute) || record.try(attribute)
-      end
+      data
+    end
 
-      def call_record_proc(proc_method)
-        proc_method.call record
-      end
+    def get_record_value(attribute)
+      try(attribute) || record.try(attribute)
+    end
+
+    def call_record_proc(proc_method)
+      proc_method.call record
+    end
   end
 end

data/lib/active_seo/helpers.rb

@@ -1,9 +1,6 @@
 module ActiveSeo
   module Helpers
-    include ActionView::Helpers::SanitizeHelper
-
     class << self
-      # Generate an array of keywords
       def generate_keywords(text)
         return [] unless text
 
@@ -20,9 +17,8 @@ module ActiveSeo
         text.scan(/\w+/).join(' ').downcase
       end
 
-      # Strip tags
       def strip_tags(html)
-        full_sanitizer.sanitize(html)
+        html.strip_html_tags.squish
       end
     end
   end

data/lib/active_seo/loader.rb

@@ -3,7 +3,6 @@ module ActiveSeo
     extend ActiveSupport::Concern
 
     class_methods do
-      # Helper to include ActiveSeo::Meta
       def has_seo(options={})
         include ActiveSeo::Meta
 

data/lib/active_seo/meta.rb

@@ -3,26 +3,19 @@ module ActiveSeo
     extend ActiveSupport::Concern
 
     included do
-      # Include modules
       include ActiveDelegate
 
-      # Set class attributes
       class_attribute :seo_config, instance_predicate: false
       class_attribute :seo_context, instance_predicate: false
 
-      # Set class attibute defaults
       self.seo_config = ActiveSeo.config
 
-      # Has associations
-      has_one :seo_metum, as: :seoable, class_name: 'ActiveSeo::SeoMetum', autosave: true, dependent: :destroy
+      has_one :seo_metum, as: :seoable, class_name: seo_class_name, autosave: true, dependent: :destroy
+      delegate_attributes to: :seo_metum, prefix: 'seo', allow_nil: true, localized: seo_locale_accessors?
 
-      # Delegate attributes
-      delegate_attributes to: :seo_metum, prefix: 'seo', allow_nil: true
-
-      # Add validations
       define_seo_validations
+      define_seo_locale_accessors
 
-      # Action callbacks
       before_validation do
         ActiveSeo::Helpers.sanitize_keywords(seo_keywords) if seo_keywords?
       end
@@ -41,23 +34,41 @@ module ActiveSeo
     end
 
     class_methods do
-      # Setup seo
+      def seo_class_name
+        @seo_class_name ||= ActiveSeo.config.class_name
+      end
+
+      def seo_locale_accessors?
+        @seo_locale_accessors ||= ActiveSeo.config.locale_accessors
+      end
+
       def seo_setup(options={})
         self.seo_config = ActiveSeo::Config.new(options.reverse_merge(seo_config))
         define_seo_validations
       end
 
-      # Set meta contextualizer
       def seo_contextualizer(name)
         self.seo_context = name
       end
 
-      # Set validations
       def define_seo_validations
         validates :seo_title, length: { maximum: seo_config.title_limit }, allow_blank: true
         validates :seo_description, length: { maximum: seo_config.description_limit }, allow_blank: true
         validates :seo_keywords, length: { maximum: seo_config.keywords_limit }, allow_blank: true
       end
+
+      def define_seo_locale_accessors
+        return unless seo_locale_accessors?
+
+        I18n.available_locales.each do |locale|
+          attr_name = "seo_meta_#{locale.to_s.downcase.tr('-', '_')}"
+
+          define_method attr_name do
+            instance_variable_get("@#{attr_name}") ||
+            instance_variable_set("@#{attr_name}", ActiveSeo::SeoMeta.new(self, locale).result)
+          end
+        end
+      end
     end
 
     def seo_meta

data/lib/active_seo/seo_meta.rb

@@ -1,36 +1,35 @@
 module ActiveSeo
   class SeoMeta
-    attr_accessor :record, :config, :context
+    attr_accessor :record, :config, :context, :locale
 
-    # Initializer method
-    def initialize(record)
+    def initialize(record, locale=I18n.locale)
       @record  = record
+      @locale  = locale
       @config  = record.class.seo_config
       @context = contextualizer.new(record)
     end
 
-    # Set base seo meta
     def result
       data = [:title, :description, :keywords, :noindex, :nofollow, :og, :twitter]
       Hash[data.map { |i| [i, send(i)] }]
     end
 
     def title
-      attribute = :seo_title
-      defaults  = [:title, :name]
+      attribute = localized_attribute(:seo_title)
+      defaults  = localized_attributes(:title, :name)
 
       attribute_fallbacks_for(attribute, defaults, config.title_fallback)
     end
 
     def description
-      attribute = :seo_description
-      defaults  = [:content, :description, :excerpt, :body]
+      attribute = localized_attribute(:seo_description)
+      defaults  = localized_attributes(:content, :description, :excerpt, :body)
 
       attribute_fallbacks_for(attribute, defaults, config.description_fallback)
     end
 
     def keywords
-      text = record.try :seo_keywords
+      text = record.try localized_attribute(:seo_keywords)
       text = "#{title} #{description}" if generate_keywords?(text)
 
       helpers.generate_keywords(text)
@@ -54,38 +53,56 @@ module ActiveSeo
 
     private
 
-      def contextualizer
-        "#{record.class.seo_context}".safe_constantize ||
-        "#{record.class.name}Contextualizer".safe_constantize ||
-        'ActiveSeo::Contextualizer'.constantize
-      end
+    def contextualizer
+      "#{record.class.seo_context}".safe_constantize ||
+      "#{record.class.name}Contextualizer".safe_constantize ||
+      'ActiveSeo::Contextualizer'.constantize
+    end
 
-      def helpers
-        ActiveSeo::Helpers
-      end
+    def helpers
+      ActiveSeo::Helpers
+    end
 
-      def generate_keywords?(text=nil)
-        config.generate_keywords and text.blank?
-      end
+    def localized?
+      record.class.seo_locale_accessors?
+    end
+
+    def generate_keywords?(text=nil)
+      config.generate_keywords and text.blank?
+    end
 
-      def attribute_fallbacks_for(attribute, defaults, fallback)
-        candidates = [attribute]
+    def localized_attribute(attr_name)
+      localized_name = "#{attr_name}_#{locale}"
+      localized? && record.respond_to?(localized_name) ? localized_name : attr_name
+    end
+
+    def localized_attributes(*attr_names)
+      localized? ? attr_names.map { |a| localized_attribute(a) } : attr_names
+    end
 
-        case fallback
-        when TrueClass
-          candidates.concat(defaults)
-        when Symbol
-          candidates << fallback
-        when Array
-          candidates.concat(fallback)
-        end
+    def attribute_fallbacks_for(attribute, defaults, fallback)
+      candidates = [attribute]
 
-        attribute_fallbacks(candidates)
+      case fallback
+      when TrueClass
+        candidates.concat(defaults)
+      when Symbol
+        candidates << fallback
+      when Array
+        candidates.concat(fallback)
       end
 
-      def attribute_fallbacks(candidates)
-        method = candidates.find { |item| record.try(item).present? }
-        helpers.strip_tags(record.try(method).to_s) unless method.nil?
-      end
+      name = attribute.to_s.remove(/^seo_/, /_#{locale}$/)
+      size = config[:"#{name}_limit"]
+      text = attribute_fallbacks(candidates)
+      text = text.truncate(size, separator: ' ') if text && size
+
+      text
+    end
+
+    def attribute_fallbacks(candidates)
+      method = candidates.find { |item| record.try(item).present? }
+      helpers.strip_tags(record.try(method).to_s) unless method.nil?
+    end
   end
 end

data/lib/active_seo/seo_metum.rb

@@ -1,13 +1,10 @@
 module ActiveSeo
   class SeoMetum < ActiveRecord::Base
-    # Set table name
     self.table_name = 'seo_meta'
 
-    # Set attributes
     attribute :noindex,  :boolean, default: false
     attribute :nofollow, :boolean, default: false
 
-    # Belongs associations
     belongs_to :seoable, polymorphic: true, optional: true
   end
 end

data/lib/active_seo/version.rb

@@ -1,3 +1,3 @@
 module ActiveSeo
-  VERSION = '0.1.4'
+  VERSION = '0.2.0'
 end

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

@@ -1,4 +1,6 @@
 ActiveSeo.setup do |config|
+  # config.class_name           = 'ActiveSeo::SeoMetum'
+  # config.locale_accessors     = false
   # config.title_limit          = 70
   # config.description_limit    = 160
   # config.keywords_limit       = 255

metadata

@@ -1,57 +1,63 @@
 --- !ruby/object:Gem::Specification
 name: active_seo
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.2.0
 platform: ruby
 authors:
 - Olibia Tsati
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
-date: 2018-04-13 00:00:00.000000000 Z
+date: 2019-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7.0'
 - !ruby/object:Gem::Dependency
-  name: actionview
+  name: active_delegate
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: active_delegate
+  name: stringex
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +78,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -116,8 +122,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -153,8 +159,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.6
 signing_key: 
 specification_version: 4
 summary: Add SEO meta to ActiveRecord models

data/CODE_OF_CONDUCT.md

@@ -1,74 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at olibia@hardpixel.eu. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [http://contributor-covenant.org/version/1/4][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/