active_seo 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0df087dc5cc450d123820acaa8a97705fd994175
-  data.tar.gz: ed1b0d830696fe6cbe2a737c635581758ac9db4c
+  metadata.gz: b0e5cf1fba10d192d5fed5b93794b6d49830700a
+  data.tar.gz: d8e26d3483fe856f460bdd00ef272324ee5121bd
 SHA512:
-  metadata.gz: 0224c8945cca8a3837f93388d0f0539af3bc089192569a5e8c3cde25c9e4fb8115f4d5223e765357bdda81654ec06a6f25ef676e4fe0dcde5b51dfa8fc5af5db
-  data.tar.gz: e4f71801b885a03a2250dff9875d4606ad3182888fb4da1e12708a39c3d31dacd4441b201a9273d7dc15a83a5e9a49e2ccb6a39ed9e96d55009c415b7909460d
+  metadata.gz: 14f6f75a483f39969e9ffb30af4e7781a4027b88f921ec5981f39551c27909f681f7f40074c5b09ba52f17bb66ebe65751b73fd0c06c4c14251f8ec9faebdf54
+  data.tar.gz: d3dfd528d884af2b7d544af0b5a22a7cd40d6ecd5035b88e94cf3d9e23066deef8c63921a372485798d786b91895afaf0485bcc0be6855a5ee1093c58c596415

data/README.md

@@ -16,49 +16,43 @@ gem 'active_seo'
 
 And then execute:
 
-```console
-$ bundle
-```
+    $ bundle
 
 Or install it yourself as:
 
-```console
-$ gem install active_seo
-```
+    $ gem install active_seo
 
 Then run the generator that will create a migration for the SeoMetum model and an initializer:
 
-```console
-$ rails g active_seo:install
-```
+    $ rails g active_seo:install
 
 And finally run the migrations:
 
-```console
-$ rails db:migrate
-```
+    $ rails db:migrate
 
 ## Usage
 
-To add SEO meta support to an ActiveRecord model include the `ActiveSeo::Meta` Concern:
+To add SEO meta support to an ActiveRecord model include the `ActiveSeo::Meta` Concern or use the `has_seo` class method:
 
 ```ruby
 class Page < ApplicationRecord
+  # Using concern
   include ActiveSeo::Meta
+
+  # Or using `has_seo` class method
+  has_seo
 end
 ```
 
-This way SeoMetum's attributes will be automatically delegated by your model with the `seo` prefix.
-
-E.g. in your the form:
+SeoMetum's attributes will be automatically delegated by your model with the `seo` prefix and you can use them in forms:
 
 ```erb
 <%= form_for @page do |f| %>
   <%= f.text_field :seo_title %>
-  <%= f.text_area :seo_description %>
-  <%= f.text_area :seo_keywords %>
-  <%= f.check_box :seo_noindex %>
-  <%= f.check_box :seo_nofollow %>
+  <%= f.text_area  :seo_description %>
+  <%= f.text_area  :seo_keywords %>
+  <%= f.check_box  :seo_noindex %>
+  <%= f.check_box  :seo_nofollow %>
 <% end %>
 ```
 
@@ -76,7 +70,7 @@ To get all SEO attributes:
 
 ## Configuration
 
-The install generator will create an initializer, which contains the following:
+The install generator will create an initializer:
 
 ```ruby
 ActiveSeo.setup do |config|
@@ -103,35 +97,41 @@ end
 
 You can set global defaults for attribute validations, automatic meta generation, OpenGraph and Twitter meta.
 
-Settings `title_fallback` and `description_fallback` can also accept either a `Symbol` which could be another model attribute or method, or an `Array` of attributes/methods to grab values from in order to autogenerate the title and description attributes.
+Settings `title_fallback` and `description_fallback` can be a `Symbol` or an `Array` of symbols that reference a model attribute/method which will be used to autogenerate the title and description attributes. When using an `Array` the first attribute that returns a value will be used.
 
-This behavior can also be configured on a model level, so in your Page model you could do something like this:
+This behavior can also be configured on a model level:
 
 ```ruby
 class Page < ApplicationRecord
+  # Using concern
   include ActiveSeo::Meta
 
-  # Set SEO config
+  # With `seo_setup` method
   seo_setup title_fallback: :name, description_fallback: [:content, :excerpt]
+
+  # Or using `has_seo` class method
+  has_seo title_fallback: :name, description_fallback: [:content, :excerpt]
 end
 ```
 
-## OpenGraph and Twitter meta
-
-If you want to define non-global OpenGraph and Twitter configurations you can create a custom meta contextualizer.
+## OpenGraph and Twitter
 
-ActiveSeo will look for a class defined in the model e.g.:
+If you want to define non-global OpenGraph and Twitter configurations you can create a custom meta contextualizer. ActiveSeo will look for a class defined in the model:
 
 ```ruby
 class Page < ApplicationRecord
+  # Using concern
   include ActiveSeo::Meta
 
-  # Set meta contextualizer
+  # With `seo_contextualizer` method
   seo_contextualizer 'CustomContextualizer'
+
+  # Or using `has_seo` class method
+  has_seo contextualizer: 'CustomContextualizer'
 end
 ```
 
-or for a class located at `app/contextualizers` with a name like `PageContextualizer`.
+Or for a class located in `app/contextualizers` with a name like `ModelContextualizer`.
 
 ```ruby
 class PageContextualizer < ActiveSeo::Contextualizer
@@ -152,8 +152,6 @@ class PageContextualizer < ActiveSeo::Contextualizer
 end
 ```
 
-#### Notes
-
 Inside the contextualizer you can define values using a `Proc` which gives you access to the record, a `Symbol` which will look for an attibute or method first inside the contextualizer and then in the model, or a `String` for a static value.
 
 ## Printing SEO meta
@@ -168,9 +166,7 @@ So, if you're using Meta Tags you can do the following:
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment. To install this gem onto your local machine, run `bundle exec rake install`.
 
 ## Contributing
 

data/Rakefile

@@ -1,10 +1,10 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
+require 'bundler/gem_tasks'
+require 'rake/testtask'
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
 end
 
 task :default => :test

data/lib/active_seo/config.rb

@@ -0,0 +1,23 @@
+module ActiveSeo
+  class Config < Hashie::Dash
+    # Set properties and defaults
+    property :title_limit,          default: 70
+    property :description_limit,    default: 160
+    property :keywords_limit,       default: 255
+    property :title_fallback,       default: true
+    property :description_fallback, default: true
+    property :generate_keywords,    default: true
+    property :opengraph,            default: {}
+    property :twitter,              default: {}
+
+    def opengraph_setup(&block)
+      self.opengraph = Hashie::Mash.new
+      yield self.opengraph
+    end
+
+    def twitter_setup(&block)
+      self.twitter = Hashie::Mash.new
+      yield self.twitter
+    end
+  end
+end

data/lib/active_seo/loader.rb

@@ -0,0 +1,20 @@
+module ActiveSeo
+  module Loader
+    extend ActiveSupport::Concern
+
+    class_methods do
+      # Helper to include ActiveSeo::Meta
+      def has_seo(options={})
+        include ActiveSeo::Meta
+
+        if options.present?
+          seo_setup options.except(:contextualizer)
+        end
+
+        if options[:contextualizer].present?
+          seo_contextualizer options[:contextualizer]
+        end
+      end
+    end
+  end
+end

data/lib/active_seo/meta.rb

@@ -14,14 +14,30 @@ module ActiveSeo
       self.seo_config = ActiveSeo.config
 
       # Has associations
-      has_one :active_seo_metum, as: :seoable, class_name: 'ActiveSeo::SeoMetum', autosave: true, dependent: :destroy
+      has_one :seo_metum, as: :seoable, class_name: 'ActiveSeo::SeoMetum', autosave: true, dependent: :destroy
 
       # Delegate attributes
-      delegate_attributes to: :active_seo_metum, prefix: 'seo', allow_nil: true
+      delegate_attributes to: :seo_metum, prefix: 'seo', allow_nil: true
 
       # Add validations
       define_seo_validations
-      before_validation { ActiveSeo::Helpers.sanitize_keywords(seo_keywords) if seo_keywords? }
+
+      # Action callbacks
+      before_validation do
+        ActiveSeo::Helpers.sanitize_keywords(seo_keywords) if seo_keywords?
+      end
+
+      before_save do
+        seo_foreign = self.class.seo_meta_attribute_names.map(&:to_s)
+        seo_current = seo_foreign.map { |n| send(n) }
+        seo_foreign = seo_foreign.map { |a| a.sub('seo_', '') }
+        seo_default = ActiveSeo::SeoMetum.column_defaults.select { |n, _d| seo_foreign.include?(n) }.values
+        seo_changes = (seo_current - seo_default).reject { |v| (v.is_a?(String) && v.blank?) || v.nil? }
+
+        if seo_changes.empty?
+          self.seo_metum = nil
+        end
+      end
     end
 
     class_methods do

data/lib/active_seo/seo_metum.rb

@@ -3,6 +3,10 @@ module ActiveSeo
     # 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

data/lib/active_seo/version.rb

@@ -1,3 +1,3 @@
 module ActiveSeo
-  VERSION = "0.1.1"
+  VERSION = '0.1.2'
 end

data/lib/active_seo.rb

@@ -2,37 +2,20 @@ require 'active_support'
 require 'action_view'
 require 'hashie'
 require 'active_delegate'
-require 'active_seo/helpers'
-require 'active_seo/contextualize'
-require 'active_seo/contextualizer'
-require 'active_seo/meta'
-require 'active_seo/seo_metum'
-require 'active_seo/seo_meta'
 require 'active_seo/version'
 
 module ActiveSeo
-  # Config class
-  class Config < Hashie::Dash
-    # Set properties and defaults
-    property :title_limit,          default: 70
-    property :description_limit,    default: 160
-    property :keywords_limit,       default: 255
-    property :title_fallback,       default: true
-    property :description_fallback, default: true
-    property :generate_keywords,    default: true
-    property :opengraph,            default: {}
-    property :twitter,              default: {}
+  extend ActiveSupport::Concern
 
-    def opengraph_setup(&block)
-      self.opengraph = Hashie::Mash.new
-      yield self.opengraph
-    end
-
-    def twitter_setup(&block)
-      self.twitter = Hashie::Mash.new
-      yield self.twitter
-    end
-  end
+  # Autoload modules
+  autoload :Config,         'active_seo/config'
+  autoload :Helpers,        'active_seo/helpers'
+  autoload :Contextualize,  'active_seo/contextualize'
+  autoload :Contextualizer, 'active_seo/contextualizer'
+  autoload :Meta,           'active_seo/meta'
+  autoload :SeoMeta,        'active_seo/seo_meta'
+  autoload :SeoMetum,       'active_seo/seo_metum'
+  autoload :Loader,         'active_seo/loader'
 
   # Set attr accessors
   mattr_accessor :config
@@ -45,3 +28,7 @@ module ActiveSeo
     yield config
   end
 end
+
+ActiveSupport.on_load(:active_record) do
+  include ActiveSeo::Loader
+end

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

@@ -4,8 +4,8 @@ class CreateSeoMeta < ActiveRecord::Migration[5.0]
       t.string  :title
       t.text    :description
       t.text    :keywords
-      t.boolean :noindex
-      t.boolean :nofollow
+      t.boolean :noindex,      default: false
+      t.boolean :nofollow,     default: false
       t.integer :seoable_id,   null: false
       t.string  :seoable_type, null: false
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_seo
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Olibia Tsati
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-07 00:00:00.000000000 Z
+date: 2017-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -122,9 +122,11 @@ files:
 - README.md
 - Rakefile
 - lib/active_seo.rb
+- lib/active_seo/config.rb
 - lib/active_seo/contextualize.rb
 - lib/active_seo/contextualizer.rb
 - lib/active_seo/helpers.rb
+- lib/active_seo/loader.rb
 - lib/active_seo/meta.rb
 - lib/active_seo/seo_meta.rb
 - lib/active_seo/seo_metum.rb