scrivito_seo_page_extender 0.92.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 236f034ea0be1c4c4b9341d539f560bb58a5a406
-  data.tar.gz: fb95eb9d63250a9acff9d527cd4be00aed22a925
+  metadata.gz: 123bcb2020a31ab95ef68e0d1e2821533c42a317
+  data.tar.gz: 06eeccd4f549acbd72ba9d67ba01115e5eab6abe
 SHA512:
-  metadata.gz: 0450b9800863e5cde61928482aa0e94109bd6dd235ad2dea9175254fe57c2a9c42288ee7a46edb86b99a8be40927455e5cdd0659d8827db755b9283689a692ab
-  data.tar.gz: e93af5a073eee555d5ad2d76b563dbf3774f5d178501d19e351b4aa1ef44cd17be62a5e9196801fe0282fc64d8e36576bd9523447d0199c217a5108fbf03ada9
+  metadata.gz: 8afab6f73df6dce644d489f112fdba71079b8891bdd1dcf081f13f028f30579e82f7921dda34317a844e5f9c41cf8f9e1f5b064c96b109d48321ed2d7f44d88a
+  data.tar.gz: 832f12345e99094e31b874577ec9ba3877daa80eaafe1a9ade91e86fb5834aa048de9d95e240f001dec48f130c1268f1a0d4d5149fddb9a4f9875fdf629ed777

data/README.md

@@ -145,6 +145,30 @@ class MyObj < Obj
 end
 ```
 
+## Configuration
+
+Add an initializer to activate automatic attribute mapping for titles and descriptions:
+
+```ruby
+ScrivitoSeoPageExtender.configure do |config|
+  config.attribute_mapping = true
+end
+```
+
+You can overwrite the default attribute mapping depending on your app in the obj.rb with:
+
+```ruby
+def self.seo_attribute_mapping(obj)
+  {
+    og_title: obj.my_app_title,
+    og_description: obj.my_app_description
+    ...
+  }
+end
+```
+
+The key is an attribute from meta, open graph or twitter cards modules, the value is app specific. More detailed values like `obj.my_title || obj.title || 'Fallback title'` are possible.
+
 ## Customization
 
 If you use the default details views provided in this gem, we recommend to activate [Scrivito Advanced Editors](https://github.com/Scrivito/scrivito_advanced_editors) to utilize the tabs used by this gem.

data/app/helper/seo_page_extender_helper.rb

@@ -18,7 +18,20 @@ module SeoPageExtenderHelper
     end
   end
 
+  def seo_attribute_fallback(obj, attribute)
+    if seo_attribute_fallback?(obj, attribute)
+      seo_attribute_mapping(obj)[attribute]
+    else
+      obj.send(attribute.to_sym)
+    end
+  end
+
   private
+  def seo_attribute_fallback?(obj, attribute)
+    # config is true && attribute is not set && mapping exists
+    ScrivitoSeoPageExtender.configuration.attribute_mapping && !obj.send(attribute.to_sym).present? && (seo_attribute_mapping(obj)[attribute]).present?
+  end
+
   def get_words_from_page(obj, attribute)
     strip_tags(scrivito_tag(:span, obj, attribute).to_s).split(" ")
   end
@@ -50,4 +63,14 @@ module SeoPageExtenderHelper
       "a,able,about,across,after,all,almost,also,am,among,an,and,any,are,as,at,be,because,been,but,by,can,cannot,could,dear,did,do,does,either,else,ever,every,for,from,get,got,had,has,have,he,her,hers,him,his,how,however,i,if,in,into,is,it,its,just,least,let,like,likely,may,me,might,most,must,my,neither,no,nor,not,of,off,often,on,only,or,other,our,own,rather,said,say,says,she,should,since,so,some,than,that,the,their,them,then,there,these,they,this,tis,to,too,twas,us,wants,was,we,were,what,when,where,which,while,who,whom,why,will,with,would,yet,you,your".split(",")
     end
   end
+
+  def seo_attribute_mapping(obj)
+    return Obj.seo_attribute_mapping(obj) if Obj.respond_to?('seo_attribute_mapping')
+    {
+      og_title: obj.send(:title).presence,
+      og_description: obj.send(:meta_description).presence,
+      tc_title: obj.send(:title).presence,
+      tc_description: obj.send(:meta_description).presence
+    }
+  end
 end

data/app/views/seo_page_extender/_meta_attribute.html.erb

@@ -1,9 +1,9 @@
-<% if @obj.respond_to?(attribute) && !@obj.send(attribute).blank? %>
+<% if @obj.respond_to?(attribute) && seo_attribute_fallback(@obj, attribute.to_sym).present? %>
   <% if name[/image\d?$/] %>
     <meta content="<%= scrivito_path(@obj[attribute]) %>" name="<%= name %>"/>
   <% elsif name == 'audience' || name == 'robots' || name == 'keywords' %>
     <meta content="<%= @obj.send(attribute).join(',') %>" name="<%= name %>"/>
   <% else %>
-    <meta content="<%= @obj.send(attribute) %>" name="<%= name %>"/>
+    <meta content="<%= seo_attribute_fallback(@obj, attribute.to_sym) %>" name="<%= name %>"/>
   <% end %>
 <% end %>

data/lib/scrivito_seo_page_extender.rb

@@ -1,4 +1,20 @@
 require "scrivito_seo_page_extender/engine"
+require "scrivito_seo_page_extender/configuration"
 
 module ScrivitoSeoPageExtender
+  class << self
+    attr_writer :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.reset
+    @configuration = Configuration.new
+  end
+
+  def self.configure
+    yield(configuration)
+  end
 end

data/lib/scrivito_seo_page_extender/configuration.rb

@@ -0,0 +1,8 @@
+module ScrivitoSeoPageExtender
+  class Configuration
+    attr_accessor :attribute_mapping
+    def initialize
+      @attribute_mapping = false
+    end
+  end
+end

data/lib/scrivito_seo_page_extender/version.rb

@@ -1,3 +1,3 @@
 module ScrivitoSeoPageExtender
-  VERSION = "0.92.0"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scrivito_seo_page_extender
 version: !ruby/object:Gem::Version
-  version: 0.92.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Scrivito
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-07 00:00:00.000000000 Z
+date: 2016-11-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: scrivito_sdk
@@ -64,6 +64,7 @@ files:
 - app/views/seo_page_extender/open_graph/_profile.html.erb
 - app/views/seo_page_extender/open_graph/_video.html.erb
 - lib/scrivito_seo_page_extender.rb
+- lib/scrivito_seo_page_extender/configuration.rb
 - lib/scrivito_seo_page_extender/engine.rb
 - lib/scrivito_seo_page_extender/version.rb
 - lib/tasks/scrivito_seo_page_extender_tasks.rake