cmor_seo 0.0.40.pre → 0.0.41.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d14674edcb340d664685cc909baa19d3b9f293a30e523313db1a8301ccaa399
-  data.tar.gz: c439227c67f60c0a1bd00bc8112c2833bb9c25a1989e7a7711d79128740e2502
+  metadata.gz: 741876db721459dc1b41e53f4003490f09ab7a6867fd5e884e47b0159d70f0b9
+  data.tar.gz: 348b5a9df79a5f8859c6fde7074da9b35348bf046d6a9c836af6c6ca01186e0a
 SHA512:
-  metadata.gz: d6ae095b0bbd0f97da5007c3c2d85f2baaa5f13e86dd15eed44e26c308350571dab80cdff7ced567fb9153300a5002ea0bdc27b708f36e0286295ef39d230296
-  data.tar.gz: d0b665cdba946f12eb977df296b45e989e424965da472fcd1aaa1fd7bbb62fffe82cf3e0a2ec61cb76e7fdc989b204875d5ae21b6e6e0b703d9ff5885aa3adda
+  metadata.gz: 30cca6ea589a8a3fcfa8115c42eb5559d54a9f27ddec1f11a50389cb4d339de8d38952695003677827f36852116aa18c3f5cd2ba07d1a5f3937c5dae05c7d180
+  data.tar.gz: 68b8926bc9e51250f06abaf257b377b2d193eab5751f06951de5c7e2396d4f22cf3226e73517f9be053458848a258bdda9bc6ba16945cb63061f2096571767ee

data/Rakefile

@@ -1,19 +1,21 @@
+# frozen_string_literal: true
+
 begin
-  require 'bundler/setup'
+  require "bundler/setup"
 rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+  puts "You must `gem install bundler` and `bundle install` to run rake tasks"
 end
 
-require 'rdoc/task'
+require "rdoc/task"
 
 RDoc::Task.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title    = 'Cmor::Seo'
-  rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.md')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+  rdoc.rdoc_dir = "rdoc"
+  rdoc.title    = "Cmor::Seo"
+  rdoc.options << "--line-numbers"
+  rdoc.rdoc_files.include("README.md")
+  rdoc.rdoc_files.include("lib/**/*.rb")
 end
 
 Bundler::GemHelper.install_tasks
 
-require 'rails/dummy/tasks'
+require "rails/dummy/tasks"

data/app/concerns/cmor/seo/models/seoable_concern.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Cmor
+  module Seo
+    module Models
+      module SeoableConcern
+        extend ActiveSupport::Concern
+
+        included do
+          has_one :seo_item, class_name: "Cmor::Seo::Item", as: :resource, dependent: :destroy
+
+          after_save :generate_seo_meta_tags
+        end
+
+        def generate_seo_meta_tags
+          Cmor::Seo::GenerateMetaTagsService.call_later!(resources: [self])
+        rescue => e
+          ::Cmor::Seo::Configuration.handle_seoable_after_save_exception.call(e)
+        end
+      end
+    end
+  end
+end

data/app/controllers/cmor/seo/application_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Cmor::Seo
   class ApplicationController < ActionController::Base
     protect_from_forgery with: :exception

data/app/controllers/cmor/seo/home_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Cmor::Seo
   class HomeController < Cmor::Core::Backend::HomeController::Base
   end

data/app/controllers/cmor/seo/items_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Cmor::Seo
   class ItemsController < Cmor::Core::Backend::ResourcesController::Base
     include Rao::ResourcesController::ActsAsPublishedConcern
@@ -11,8 +13,7 @@ module Cmor::Seo
 
       def autocomplete_resource
         resource_class_name = params[:resource_class_name]
-        term                = params[:term] || ''
-        resource_class      = resource_class_name.constantize
+        term                = params[:term] || ""
 
         autocomplete_options = autocomplete_options_for(resource_class_name)
 
@@ -34,22 +35,20 @@ module Cmor::Seo
       end
 
       private
-
-      def autocomplete_options_for(resource_class_name)
-        Cmor::Seo::Configuration.items_resource_autocomplete_options[resource_class_name]
-      end
+        def autocomplete_options_for(resource_class_name)
+          Cmor::Seo::Configuration.resources_autocomplete_options[resource_class_name][:autocomplete_options]
+        end
     end
 
     include AutocompleteConcern
 
     private
+      def load_collection_scope
+        super.eager_load(:meta_tags)
+      end
 
-    def load_collection_scope
-      super.eager_load(:meta_tags)
-    end
-
-    def permitted_params
-      params.require(:item).permit(:resource_type, :resource_id, :path, :published, meta_tags_attributes: [:id, :name, :content, :published, :_destroy])
-    end
+      def permitted_params
+        params.require(:item).permit(:resource_type, :resource_id, :path, :published, meta_tags_attributes: [:id, :name, :content, :published, :_destroy])
+      end
   end
-end
+end

data/app/controllers/cmor/seo/meta_tags_controller.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Cmor::Seo
   class MetaTagsController < Cmor::Core::Backend::ResourcesController::Base
     include Rao::ResourcesController::ActsAsListConcern
@@ -8,17 +10,16 @@ module Cmor::Seo
     end
 
     private
+      def load_collection_scope
+        super.includes(:item)
+      end
 
-    def load_collection_scope
-      super.includes(:item)
-    end
+      def after_reposition_location
+        last_location
+      end
 
-    def after_reposition_location
-      last_location
-    end
-
-    def permitted_params
-      params.require(:meta_tag).permit(:item_id, :name, :content, :published)
-    end
+      def permitted_params
+        params.require(:meta_tag).permit(:item_id, :name, :content, :published)
+      end
   end
-end
+end

data/app/models/cmor/seo/item.rb

@@ -1,23 +1,27 @@
+# frozen_string_literal: true
+
 module Cmor::Seo
   class Item < ApplicationRecord
     include ActsAsPublished::ActiveRecord
 
-    class OrValidator < ActiveModel::EachValidator
-      def validate_each(record, attribute, value)
-        values = options[:others].map{ |o| record.send(o) } + [value]
-        attribute_names = [attribute] + options[:others]
-
-        if options[:exclusive]
-          if values.count { |x| x.present? } != 1
-            record.errors[attribute] << (options[:message] || "exactly one of #{attribute_names.to_sentence} may be present.")
-          end
-        else
-          if values.all? { |x| x.blank? }
-            record.errors[attribute] << (options[:message] || "at least one of #{attribute_names.to_sentence} must be present.")
-          end
-        end
-      end
-    end
+    # class OrValidator < ActiveModel::EachValidator
+    #   def validate_each(record, attribute, value)
+    #     values = options[:others].map{ |o| record.send(o) } + [value]
+    #     attribute_names = [attribute] + options[:others]
+
+    #     if options[:exclusive]
+    #       if values.count { |x| x.present? } != 1
+    #         record.errors.add(attribute, options[:message] || :or)
+    #         # record.errors[attribute] << (options[:message] || "exactly one of #{attribute_names.to_sentence} may be present.")
+    #       end
+    #     else
+    #       if values.all? { |x| x.blank? }
+    #         record.errors.add(attribute, options[:message] || :or)
+    #         # record.errors[attribute] << (options[:message] || "at least one of #{attribute_names.to_sentence} must be present.")
+    #       end
+    #     end
+    #   end
+    # end
 
     belongs_to :resource, polymorphic: true, optional: true
     has_many :meta_tags, -> { order(position: :asc) }, inverse_of: :item
@@ -44,9 +48,8 @@ module Cmor::Seo
     end
 
     private
-
-    def resource_label
-      resource.try(:human).presence || resource.try(:email).presence || resource.try(:name) || resource.try(:identifier).presence || resource.to_s
-    end
+      def resource_label
+        resource.try(:human).presence || resource.try(:email).presence || resource.try(:name) || resource.try(:identifier).presence || resource.to_s
+      end
   end
 end

data/app/models/cmor/seo/meta_tag.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module Cmor::Seo
   class MetaTag < ApplicationRecord
     include ActsAsPublished::ActiveRecord
-    
+
     belongs_to :item
 
     acts_as_list scope: :item

data/app/services/cmor/seo/generate_meta_tags_service.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+module Cmor
+  module Seo
+    class GenerateMetaTagsService < Rao::Service::Base
+      class Result < Rao::Service::Result::Base
+        attr_accessor :resources, :meta_tags
+      end
+
+      attr_accessor :resources, :meta_tags
+
+      # delegate :url_helpers, to: 'Rails.application.routes'
+      # alias_method :main_app, :url_helpers
+
+      module RoutingConcern
+        extend ActiveSupport::Concern
+
+        class LocalRouter
+          attr_accessor :default_url_options
+
+          def initialize(default_url_options: nil)
+            @default_url_options = default_url_options
+          end
+        end
+
+        included do
+          Rails.application.routes.named_routes.send(:routes).each do |mountpoint, route|
+            next unless route.app.app.respond_to?(:ancestors)
+            next unless route.app.app.ancestors.include?(Rails::Engine)
+            define_method(mountpoint) do
+              router_klass = Class.new(LocalRouter)
+              router_klass.send(:include, route.app.app.routes.url_helpers)
+              router_klass.new(default_url_options: default_url_options)
+            end
+          end
+        end
+
+        def main_app
+          router_klass = Class.new(LocalRouter)
+          router_klass.send(:include, Rails.application.routes.url_helpers)
+          router_klass.new(default_url_options: default_url_options)
+        end
+
+        def method_missing(m, *args, &block)
+          return main_app.send(m, *args, &block) if main_app.respond_to?(m)
+          super
+        end
+
+        def default_url_options
+          @default_url_options ||= (Rails.application.config.action_controller.default_url_options || Rails.application.config.action_mailer.default_url_options || { host: "http://localhost:3000" })
+        end
+      end
+
+      include RoutingConcern
+
+      private
+        def _perform
+          @meta_tags = generate_meta_tags!
+
+          @result.meta_tags = @meta_tags
+        end
+
+        def generate_meta_tags!
+          say "Generating meta tags for #{resources.count} resources" do
+            resources.collect do |resource|
+              build_or_update_meta_tags_for(resource)
+            end.flatten
+          end
+        end
+
+        def save
+          ActiveRecord::Base.transaction do
+            @meta_tags.map(&:save!)
+          end
+        end
+
+        def build_or_update_meta_tags_for(resource)
+          say "Building/Updating meta tags for #<#{resource.class} id:#{resource.id}>" do
+            item = find_or_initialize_item_for(resource)
+            meta_tag_configuration_for(resource).call.collect do |name, options_proc|
+              options = instance_exec(resource, &options_proc)
+              initialize_or_update_meta_tag(item, name, options)
+            end
+          end
+        end
+
+        def find_or_initialize_item_for(resource)
+          (resource.seo_item || resource.build_seo_item).tap do |item|
+            item.published = true if item.new_record?
+            item
+          end
+        end
+
+        def meta_tag_configuration_for(resource)
+          ::Cmor::Seo::Configuration.resources[resource.class.name][:meta_tags]
+        end
+
+        def initialize_or_update_meta_tag(item, name, options)
+          ::Cmor::Seo::MetaTag.where(item_id: item.id, name: name).first_or_initialize.tap do |mt|
+            say "Processing #{mt.new_record? ? 'new' : 'existing'} #<MetaTag name: #{name}>" do
+              mt.item = item
+              mt.content = options.delete(:content)
+              mt.published = true if mt.new_record?
+            end
+          end
+        end
+    end
+  end
+end

data/app/view_helpers/cmor/seo/application_view_helper.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 module Cmor::Seo
   class ApplicationViewHelper < Rao::ViewHelper::Base
   end
-end
+end

data/app/views/cmor/seo/items/_form.html.haml

@@ -1,4 +1,4 @@
-= form.input :resource, as: :polymorphic_association, classes: Cmor::Seo::Configuration.items_resource_autocomplete_options.each_with_object({}) { |(k, v), m| m[k.constantize] = url_for(action: :autocomplete_resource, resource_class_name: k) }
+= form.input :resource, as: :polymorphic_association, classes: Cmor::Seo::Configuration.resources_autocomplete_options.each_with_object({}) { |(k, v), m| m[k.constantize] = url_for(action: :autocomplete_resource, resource_class_name: k) }
 = form.input :path
 = form.input :published, as: :boolean
 

data/config/initializers/inject_seoable_concern_into_models.rb

@@ -0,0 +1,6 @@
+Rails.configuration.to_prepare do
+  Cmor::Seo::Configuration.resources.keys.each do |resource_class|
+    puts "[Cmor::Seo] Including Models::SeoableConcern in #{resource_class}"
+    resource_class.constantize.send(:include, Cmor::Seo::Models::SeoableConcern)
+  end
+end

data/config/locales/de.yml

@@ -44,3 +44,4 @@ de:
           remove_association: 'Meta Tag löschen'
   routes:
     cmor-seo-engine: seo
+

data/config/locales/en.yml

@@ -44,3 +44,4 @@ en:
           remove_association: 'Delete Meta Tag'
   routes:
     cmor-seo-engine: seo
+

data/lib/cmor/seo/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Cmor::Seo
   module Configuration
     def configure
@@ -5,23 +7,41 @@ module Cmor::Seo
     end
 
     mattr_accessor :resources_controllers do
-      -> {[]}
+      -> { [] }
     end
 
     mattr_accessor :resource_controllers do
-      -> {[]}
+      -> { [] }
     end
 
     mattr_accessor :service_controllers do
-      -> {[]}
+      -> { [] }
     end
 
     mattr_accessor :sidebar_controllers do
-      -> {[]}
+      -> { [] }
     end
 
-    mattr_accessor :items_resource_autocomplete_options do
+    mattr_accessor :resources do
       {}
     end
+
+    mattr_accessor :handle_seoable_after_save_exception do
+      ->(exception) { raise exception }
+    end
+
+    def self.resources_autocomplete_options
+      resources.each_with_object({}) { |(k, v), m| m[k] = v.fetch(:autocomplete_options) { {} } }
+    end
+
+    def add_resource(class_name, options = {})
+      @@resources[class_name] = options
+    end
+
+    def remove_resource(*class_names)
+      class_names.each do |class_name|
+        @resources.delete(class_name)
+      end
+    end
   end
 end

data/lib/cmor/seo/engine.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Cmor::Seo
   class Engine < ::Rails::Engine
     isolate_namespace Cmor::Seo

data/lib/cmor/seo/version.rb

@@ -1,4 +1,6 @@
-require 'cmor/version'
+# frozen_string_literal: true
+
+require "cmor/version"
 
 module Cmor
   module Seo

data/lib/cmor_seo.rb

@@ -1,9 +1,13 @@
+# frozen_string_literal: true
+
 require "cmor_core"
 require "cmor_core_backend"
 require "acts_as_list"
 require "acts_as_published"
 require "simple_form-polymorphic_associations"
 require "cocoon"
+require "rao-service"
+require "rao-or_validator"
 
 require "cmor/seo/version"
 require "cmor/seo/configuration"

data/lib/generators/cmor/seo/install/install_generator.rb

@@ -1,25 +1,26 @@
+# frozen_string_literal: true
+
 module Cmor::Seo
   module Generators
     class InstallGenerator < Rails::Generators::Base
-      desc 'Generates the initializer'
+      desc "Generates the initializer"
 
-      source_root File.expand_path('../templates', __FILE__)
+      source_root File.expand_path("../templates", __FILE__)
 
       attr_reader :base_controller_class_name
 
       def initialize(*args)
         super
-        @base_controller_class_name = ENV.fetch('BASE_CONTROLLER_CLASS_NAME') { '::ApplicationController' }
+        @base_controller_class_name = ENV.fetch("BASE_CONTROLLER_CLASS_NAME") { "::ApplicationController" }
       end
 
       def generate_initializer
-        template 'initializer.rb', 'config/initializers/cmor_seo.rb'
+        template "initializer.rb", "config/initializers/cmor_seo.rb"
       end
 
       def generate_routes
-        route File.read(File.join(File.expand_path('../templates', __FILE__), 'routes.source'))
+        route File.read(File.join(File.expand_path("../templates", __FILE__), "routes.source"))
       end
     end
   end
 end
-

data/lib/generators/cmor/seo/install/templates/initializer.rb

@@ -26,28 +26,44 @@ Cmor::Seo.configure do |config|
   # Set the sidebars, that will be shown in the backend menu.
   # 
   # Default: config.sidebar_controllers = -> {[]}
-  # 
   config.sidebar_controllers = -> {[]}
 
+  # This proc will handle any exception that happens in the after_save callback
+  # that creates items and meta tags.
+  #
+  # Default: config.handle_seoable_after_save_exception = ->(exception) { raise exception }
+  #
+  config.handle_seoable_after_save_exception = ->(exception) { raise exception }
+
   # Set the resources that will be available as seo targets when creating new
   # Cmor::Seo::Items.
   #
-  # Example:
+  # Examples:
   #
-  # config.items_resource_autocomplete_options = {
-  #   'Cmor::Blog::Post' => {
+  # config.add_resource(
+  #   'Cmor::Blog::Post',
+  #   meta_tags: -> {{
+  #     'description' => ->(resource) { { content: resource.title } },
+  #     'og:title'    => ->(resource) { { content: resource.title } },
+  #     'og:url'      => ->(resource) { { content: cmor_blog.url_for(resource) } },
+  #   }},
+  #   autocomplete_options: {
   #     scope: ->(term) { Cmor::Blog::Post.where("LOWER(title) LIKE :term", term: "%#{term.downcase}%") },
   #     id_method: :id,
   #     text_method: :title
-  #   },
-  #   'Cmor::Cms::Page' => {
+  #   }
+  # )
+  #
+  # config.add_resource(
+  #   'Cmor::Cms::Page',
+  #   meta_tags: -> {{
+  #     'description' => ->(resource) { { content: resource.meta_description } },
+  #     'og:title'    => ->(resource) { { content: resource.title } },
+  #   }},
+  #   autocomplete_options: {
   #     scope: ->(term) { Cmor::Cms::Page.where("LOWER(title) LIKE :term", term: "%#{term.downcase}%") },
   #     id_method: :id,
   #     text_method: :title
   #   }
-  # }
-  #
-  # Default: config.items_resource_autocomplete_options = {}
-  #
-  config.items_resource_autocomplete_options = {}
+  # )
 end

data/lib/tasks/cmor/seo_tasks.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # namespace :cmor_seo do
 #   desc "Explaining what the task does"
 #   task :example do

data/spec/dummy/app/assets/javascripts/pages.coffee

@@ -0,0 +1,3 @@
+# Place all the behaviors and hooks related to the matching controller here.
+# All this logic will automatically be available in application.js.
+# You can use CoffeeScript in this file: http://coffeescript.org/

data/spec/dummy/app/assets/javascripts/posts.coffee

@@ -0,0 +1,3 @@
+# Place all the behaviors and hooks related to the matching controller here.
+# All this logic will automatically be available in application.js.
+# You can use CoffeeScript in this file: http://coffeescript.org/

data/spec/dummy/app/assets/stylesheets/pages.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/spec/dummy/app/assets/stylesheets/posts.css

@@ -0,0 +1,4 @@
+/*
+  Place all the styles related to the matching controller here.
+  They will automatically be included in application.css.
+*/

data/spec/dummy/app/assets/stylesheets/scaffold.css

@@ -0,0 +1,80 @@
+body {
+  background-color: #fff;
+  color: #333;
+  margin: 33px;
+}
+
+body, p, ol, ul, td {
+  font-family: verdana, arial, helvetica, sans-serif;
+  font-size: 13px;
+  line-height: 18px;
+}
+
+pre {
+  background-color: #eee;
+  padding: 10px;
+  font-size: 11px;
+}
+
+a {
+  color: #000;
+}
+
+a:visited {
+  color: #666;
+}
+
+a:hover {
+  color: #fff;
+  background-color: #000;
+}
+
+th {
+  padding-bottom: 5px;
+}
+
+td {
+  padding: 0 5px 7px;
+}
+
+div.field,
+div.actions {
+  margin-bottom: 10px;
+}
+
+#notice {
+  color: green;
+}
+
+.field_with_errors {
+  padding: 2px;
+  background-color: red;
+  display: table;
+}
+
+#error_explanation {
+  width: 450px;
+  border: 2px solid red;
+  padding: 7px 7px 0;
+  margin-bottom: 20px;
+  background-color: #f0f0f0;
+}
+
+#error_explanation h2 {
+  text-align: left;
+  font-weight: bold;
+  padding: 5px 5px 5px 15px;
+  font-size: 12px;
+  margin: -7px -7px 0;
+  background-color: #c00;
+  color: #fff;
+}
+
+#error_explanation ul li {
+  font-size: 12px;
+  list-style: square;
+}
+
+label {
+  display: block;
+}