para-seo_tools 0.4.2 → 0.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 724bd64d9cc63d30dd64a7c34f5ac844e2a4aa58
-  data.tar.gz: 2cddf86252810fc4f146f2e458e126d9a33b45f1
+  metadata.gz: 6e220801b91af4f208d0699b1ad222e6da70a14a
+  data.tar.gz: 038f5d4d193c3dc4cf4b28d4952075e814e2c83c
 SHA512:
-  metadata.gz: af089b88e4d1fd13ed69e23a853adca81ee3829c976dde442876adcf2de804ccaa1a41c7ab34c6adda4ec2225fe275d84e27ccffb4d5b48f7b9b266cfae8d667
-  data.tar.gz: 956ba99b6bcd1ca62cd691efbdad934e0f71ccba101467c701c653b24c3f296b190803fc0a02c8d5f6fb7e968081e60ab57b5693ef1decc9a0be9087d7b252f1
+  metadata.gz: e5eae100d8ef70eb4cf1527b523a2390f0b0c797ba4c6a311dbcb20d12a592ea2f636148cc2913a6025aeca2633da888e43f926a0576a1ef461232850e96e38a
+  data.tar.gz: 2b4f5c397b6638653c7ddc7526aed32ff9b01b723540093fbcddc49d0abcad40024d65359f07aa5764af95afc72de32a17d24663f3b64e63dcbc7aa2f36ab726

data/README.md

@@ -196,6 +196,27 @@ Para::SeoTools::Skeleton.draw(scope: :locale) do
 By using `I18n.with_locale`, we force the current locale in the block, and
 SeoTools automatically assigns the locale to the page resource.
 
+#### Scoping page fetching in request
+
+When you add arbitrary scope your pages, you may want Seo Tools to use these
+scopes when retrieving the page to fetch meta tags, at request time.
+
+> **Note**:  The following scopes are included in default page retrieval scoping
+and need not to be overriden : `:locale`, `:subdomain` and `:domain`.
+
+Override the `#seo_tools_scope_for(request)` method in the controllers that need
+to apply these scope rules. This will be the ApplicationController in most
+cases. The method should return a hash.
+
+```
+def seo_tools_scope_for(request)
+  super.tap do |hash|
+    # use `hash[:my_scope_name] = ...` here to fill or update the default scope
+  end
+end
+```
+
+
 #### Lazy skeleton building.
 
 On large applications, building the skeleton with all its pages at application

data/lib/para/seo_tools/controller.rb

@@ -39,12 +39,8 @@ module Para
       end
 
       def fetch_meta_tags_page
-        page_conditions = Para::SeoTools::Page.where(path: request.path)
-        page_conditions = page_conditions.with_subdomain(request.subdomain) if Para::SeoTools.handle_subdomain
-        page_conditions = page_conditions.with_domain(request.domain) if Para::SeoTools.handle_domain
-
-        if (page = page_conditions.first)
-          set_meta_tags_from_page(page)
+        if current_seo_tools_page
+          set_meta_tags_from_page(current_seo_tools_page)
         end
       end
 

data/lib/para/seo_tools/engine.rb

@@ -8,12 +8,13 @@ module Para
       initializer 'para.seo_tools.include_controller_mixin' do
         ActiveSupport.on_load(:action_controller) do
           include Para::SeoTools::Controller
+          include Para::SeoTools::Helpers::PageHelper
         end
       end
 
       initializer "para.seo_tools.include_view_helpers" do
         ActiveSupport.on_load(:action_view) do
-          include Para::SeoTools::ViewHelpers
+          include Para::SeoTools::Helpers::ViewHelper
         end
       end
     end

data/lib/para/seo_tools/helpers/page_helper.rb

@@ -0,0 +1,72 @@
+module Para
+  module SeoTools
+    module Helpers
+      module PageHelper
+        extend ActiveSupport::Concern
+
+        included do
+          # Allow module methods to be called from the view when the PageHelper
+          # module is included in a controller
+          if respond_to?(:helper_method)
+            helper_method :current_seo_tools_page,
+                          :seo_tools_page_for,
+                          :seo_tools_pages_for,
+                          :seo_tools_scoped_sibling_for,
+                          :seo_tools_scoped_siblings_for
+          end
+        end
+
+        def current_seo_tools_page
+          RequestStore.store['para.seo_tools.current_seo_tools_page'] ||=
+            seo_tools_page_for({ path: request.path }.merge(seo_tools_scope_for(request)))
+        end
+
+        # Retrieve the first page that matches the given scope conditions
+        #
+        def seo_tools_page_for(scope_hash = {})
+          seo_tools_pages_for(scope_hash).first
+        end
+
+        # Find all the pages with the given scope conditions, merged with the
+        # current page ones.
+        #
+        def seo_tools_pages_for(scope_hash = {})
+          Para::SeoTools::Page.scope_with(scope_hash)
+        end
+
+        def seo_tools_scoped_sibling_for(*args)
+          seo_tools_scoped_siblings_for(*args).first
+        end
+
+        def seo_tools_scoped_siblings_for(path, scope_hash = {})
+          source_page = if Hash === path
+            scope_hash = path
+            current_seo_tools_page
+          else
+            Para::SeoTools::Page.find_by_path(path)
+          end
+
+          return Para::SeoTools::Page.none unless source_page
+
+          scope_hash = scope_hash.merge(seo_tools_scope_for(request))
+          source_page.siblings.scope_with(scope_hash)
+        end
+
+        protected
+
+        # Return a simple scopes hash, letting the Page.scope_with method handle
+        # column and JSON field backed attributes
+        #
+        # This method is meant to be overriden in app controllers to scope
+        #
+        def seo_tools_scope_for(request)
+          {}.tap do |hash|
+            hash[:subdomain] = request.subdomain if Para::SeoTools.handle_subdomain
+            hash[:domain] = request.domain if Para::SeoTools.handle_domain
+            hash[:locale] = I18n.locale if I18n.available_locales.length > 1
+          end
+        end
+      end
+    end
+  end
+end

data/lib/para/seo_tools/helpers/view_helper.rb

@@ -0,0 +1,11 @@
+module Para
+  module SeoTools
+    module Helpers
+      module ViewHelper
+        def meta_tags(options = {})
+          MetaTags::Renderer.new(self, options).render
+        end
+      end
+    end
+  end
+end

data/lib/para/seo_tools/helpers.rb

@@ -0,0 +1,10 @@
+module Para
+  module SeoTools
+    module Helpers
+      extend ActiveSupport::Autoload
+
+      autoload :PageHelper
+      autoload :ViewHelper
+    end
+  end
+end

data/lib/para/seo_tools/sitemap_pinger.rb

@@ -4,12 +4,6 @@ module Para
       def perform
         Para::SeoTools::Sitemap.ping_search_engines
       end
-
-      private
-
-      def progress_total
-        nil
-      end
     end
   end
 end

data/lib/para/seo_tools/skeleton/job.rb

@@ -6,12 +6,6 @@ module Para
           Para::SeoTools::Skeleton.build(load_skeleton: true)
           Para::SeoTools::Sitemap.generate!
         end
-
-        private
-
-        def progress_total
-          nil
-        end
       end
     end
   end

data/lib/para/seo_tools/version.rb

@@ -1,5 +1,5 @@
 module Para
   module SeoTools
-    VERSION = "0.4.2"
+    VERSION = "0.4.3"
   end
 end

data/lib/para/seo_tools.rb

@@ -17,7 +17,7 @@ module Para
 
     autoload :MetaTaggable
     autoload :MetaTaggableMacro
-    autoload :ViewHelpers
+    autoload :Helpers
 
     mattr_writer :host
     @@host = nil

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: para-seo_tools
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.4.3
 platform: ruby
 authors:
 - Valentin Ballestrino
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-06 00:00:00.000000000 Z
+date: 2016-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -126,6 +126,9 @@ files:
 - lib/para/seo_tools.rb
 - lib/para/seo_tools/controller.rb
 - lib/para/seo_tools/engine.rb
+- lib/para/seo_tools/helpers.rb
+- lib/para/seo_tools/helpers/page_helper.rb
+- lib/para/seo_tools/helpers/view_helper.rb
 - lib/para/seo_tools/meta_tags.rb
 - lib/para/seo_tools/meta_tags/renderer.rb
 - lib/para/seo_tools/meta_tags/store.rb
@@ -149,7 +152,6 @@ files:
 - lib/para/seo_tools/skeleton/page_builder.rb
 - lib/para/seo_tools/skeleton/site.rb
 - lib/para/seo_tools/version.rb
-- lib/para/seo_tools/view_helpers.rb
 - lib/tasks/migration.rake
 - lib/tasks/para_seo_tools_tasks.rake
 - para-seo_tools.gemspec

data/lib/para/seo_tools/view_helpers.rb

@@ -1,9 +0,0 @@
-module Para
-  module SeoTools
-    module ViewHelpers
-      def meta_tags(options = {})
-        MetaTags::Renderer.new(self, options).render
-      end
-    end
-  end
-end