duck_map 0.8.1 → 0.8.2

data/lib/duck_map/handlers/index.rb

@@ -4,15 +4,6 @@ module DuckMap
   module Handlers
 
     ##################################################################################
-# get default values and assign to local variable containing all values from a single url node
-# and meta tag values for the index action.  the local variable is referred to as "values".
-# - user can override method and manipulate the default values...
-# index action is called.
-# - uses existing values generated via the index method
-# - gives the developer a chance to set instance values to handle special cases
-# lastmod is obtained from locale and merged with "values".
-# call sitemap_capture_attributes on the controller to capture values of the current state and merge them with "values".
-# 
     module Index
       extend ActiveSupport::Concern
 
@@ -27,6 +18,40 @@ module DuckMap
       end
 
       ##################################################################################
+      # Default handler method for index actions.
+      #
+      # The source of a request for data can be from two sources.
+      # - sitemap requesting url nodes for a given route.
+      # - meta tag requesting data for HEAD section meta tags.
+      #
+      # This method will return an Array of Hashes that represent url nodes of a sitemap.  Also,
+      # sitemap_meta_data is populated with a single Hash for meta tags.  So, this is considered
+      # a shared method.
+      #
+      # The basic procedure is as follows:
+      #
+      # - default values are obtained from {DuckMap::Config} and stored in a return Hash.
+      # - if request source is :sitemap, then, the index method of the controller is called.
+      #   This will allow you to set instance variables, etc. within the index method of a controller.
+      # - static last-modified date is obtained from config/locales/sitemap.yml
+      # - sitemap_capture_attributes is called directly on the controller.  Any values are merged with the return Hash.
+      # - process some type of model in the following order of precedence depending on configuration.
+      #   - process block
+      #     if the controller was configured with a block, then, execute the block and use the return value
+      #     as the data source for values.
+      #   - process model configured via the handler
+      #     if a model class was assigned to the handler, then, execute "all" method on the model and use the return value
+      #     as the data source for values.
+      #   - first model object automagically found on the controller
+      #     unless "first_model" has been set to false, find the first instance of a model object on the controller
+      #     and use it as the data source for values.
+      # - once a data source object has been established, call sitemap_capture_attributes to obtain values and merge
+      #   them with the return Hash.
+      # - unless a canonical url has been obtained during any of the preceding steps, build the canonical url
+      #   based on the route and data source object found during preceding steps. 
+      # - add the return Hash to the return Array and set the meta tag instance variable.
+      # - done.
+      # @return [Array]
       def sitemap_index(options = {})
         rows = []
 
@@ -50,7 +75,6 @@ module DuckMap
 
         end
 
-
         lastmod = self.sitemap_static_lastmod(options[:controller_name], options[:action_name])
         unless lastmod.blank?
           values[:lastmod] = lastmod
@@ -115,6 +139,7 @@ module DuckMap
           # i'm really being lazy here, but, if the current route is
           # the root, then, reassign the url to eliminate ?format=html, etc.
           # from the url.
+          # index actions do not require segment keys, therefore, no need to process them.
           if !route.name.blank? && route.name.eql?("root")
             url_options.delete(:format)
             values[:canonical] = root_url(url_options)
@@ -127,6 +152,7 @@ module DuckMap
           values[:loc] = values[:canonical]
         end
 
+        # push the merged hash and set the instance variable for the meta tag
         rows.push(values)
 
         self.sitemap_meta_data = values

data/lib/duck_map/handlers/show.rb

@@ -8,6 +8,60 @@ module DuckMap
       extend ActiveSupport::Concern
 
       ##################################################################################
+      # Default handler method for show actions.
+      #
+      # The source of a request for data can be from two sources.
+      # - sitemap requesting url nodes for a given route.
+      # - meta tag requesting data for HEAD section meta tags.
+      #
+      # This method will return an Array of Hashes that represent url nodes of a sitemap.  Also,
+      # sitemap_meta_data is populated with a single Hash for meta tags.  So, this is considered
+      # a shared method.
+      #
+      # The basic procedure is as follows:
+      #
+      # - default values are obtained from {DuckMap::Config} and stored in a return Hash.
+      # - the controller "show" action method is never called as it is not needed.
+      #   - if the request is a meta tag, then, the show method has already been called.
+      #   - if the request is a sitemap, then, we would looking for a list of rows instead of just one
+      #     row, because, a show route would always be pointing to a single item and the sitemap would want to show
+      #     all of those items or at least a defined list of them.
+      # - static last-modified date is obtained from config/locales/sitemap.yml
+      # - sitemap_capture_attributes is called directly on the controller.  Any values are merged with the return Hash.
+      # - now, the processing splits based on the type of request.
+      # - if meta tag
+      #   - first model object automagically found on the controller
+      #     unless "first_model" has been set to false, find the first instance of a model object on the controller
+      #     and use it as the data source for values.
+      #   - unless a canonical url has been obtained during any of the preceding steps, build the canonical url
+      #     based on the route and data source object found during preceding steps.  the segment keys are NOT processed
+      #     as the values should be automagically part of the url building since this is being called as part of an
+      #     HTTP request.  The segment key should simply already be there.
+      #   - add the return Hash to the return Array and set the meta tag instance variable.
+      # - otherwise, assume sitemap
+      #   - process some type of model in the following order of precedence depending on configuration.
+      #     - process block
+      #       if the controller was configured with a block, then, execute the block and use the return value
+      #       as the data source for values.
+      #     - process model configured via the handler
+      #       if a model class was assigned to the handler, then, execute "all" method on the model and use the return value
+      #       as the data source for values.
+      #     - model object automagically found by the sitemap_build method.
+      #       the "all" method is called on the model object.
+      #     - first model object is never processed for the show method when the request is via a sitemap.
+      #       the reason is the show method is never called, therefore, an instance of a model would not exist on the controller.
+      #   - the goal is ALWAYS to work with a list of model objects.  once a list has been established,
+      #     process all of the model objects in the list.
+      #     - for each object
+      #       - build a row Hash based copied from all of the values captured thus far.
+      #       - call sitemap_capture_attributes on the model to obtain values and merge them with the row Hash.
+      #       - unless a canonical url has been obtained during any of the preceding steps, build the canonical url
+      #         based on the route and data source object found during preceding steps.  segment keys are build via a call
+      #         to sitemap_capture_segments on the model.
+      #       - add the row Hash to the return Array
+      #       - do nothing to the meta tag instance variable.
+      # - done.
+      # @return [Array]
       def sitemap_show(options = {})
         rows = []
 

data/lib/duck_map/mapper.rb

@@ -125,13 +125,11 @@ module DuckMap
         # this is where the actual filtering of routes occurs and is based on the current sitemap filter settings.
         # if the route passes the criteria, then, it is "marked" as part of the sitemap.
         # no need to evaluate it every time a sitemap is requested.  evaluate it now and mark it.
-
-        if !@set.routes.routes[index].blank? && @set.routes.routes[index].sitemap_route_name.blank?
-          if @set.include_route?(@set.routes.routes[index]) && !sitemap_route_name.blank?
+        unless @set.routes.routes[index].blank?
+          if @set.routes.routes[index].sitemap_route_name.blank?
             @set.routes.routes[index].sitemap_route_name = sitemap_route_name
-            total += 1
-          else
-            @set.routes.routes[index].sitemap_route_name = "do_not_use"
+            @set.routes.routes[index].available = @set.include_route?(@set.routes.routes[index])
+            total += @set.routes.routes[index].is_available? ? 1 : 0
           end
         end
 

data/lib/duck_map/route.rb

@@ -16,260 +16,281 @@ module DuckMap
     extend ActiveSupport::Concern
     include DuckMap::ArrayHelper
 
-    ##################################################################################
-    #module InstanceMethods
-
-      # Identifies the current routes as being a sitemap route.
-      attr_accessor :is_sitemap
+    # Identifies the current routes as being a sitemap route.
+    attr_accessor :is_sitemap
 
-      # The route name of the sitemap which the current route is assigned.
-      attr_accessor :sitemap_route_name
+    # The route name of the sitemap which the current route is assigned.
+    attr_accessor :sitemap_route_name
 
-      # The route name of the sitemap without the namespace.
-      attr_accessor :sitemap_raw_route_name
+    # The route name of the sitemap without the namespace.
+    attr_accessor :sitemap_raw_route_name
 
-      # Identifies that the current sitemap route was defined with a block.
-      attr_accessor :sitemap_with_block
+    # Identifies that the current sitemap route was defined with a block.
+    attr_accessor :sitemap_with_block
 
-      # Total amount of URL nodes allowed in the sitemap.
-      attr_accessor :url_limit
+    # Total amount of URL nodes allowed in the sitemap.
+    attr_accessor :url_limit
 
-      ##################################################################################
-      # Identifies the current routes as being a sitemap route.
-      # @return [Boolean]  True if the route is a sitemap route, otherwise, false.
-      def is_sitemap?
-        @is_sitemap = @is_sitemap.nil? ? false : @is_sitemap
+    ##################################################################################
+    # Returns a boolean indicating if the route is available for use.
+    # @return [FalseClass, TrueClass]
+    def available
+      unless defined?(@available)
+        @available = true
       end
+      return @available
+    end
 
-      ##################################################################################
-      # @return [String] Namespace prefix used when creating the route.
-      def namespace_prefix
-        value = nil
-
-        unless self.sitemap_raw_route_name.blank?
-          value = self.sitemap_route_name.gsub(self.sitemap_raw_route_name, "")
-        end
+    ##################################################################################
+    # Sets a boolean indicating if the route is available for use.
+    # @param [FalseClass, TrueClass] value Boolean indicating if the route is available for use.
+    # @return [FalseClass, TrueClass]
+    def available=(value)
+      @available = value
+    end
 
-        return value
-      end
+    ##################################################################################
+    # Returns a boolean indicating if the route is available for use.
+    # @return [FalseClass, TrueClass]
+    def is_available?
+      return self.available
+    end
 
-      ##################################################################################
-      def namespace_prefix_underscores
-        value = 0
+    ##################################################################################
+    # Identifies the current routes as being a sitemap route.
+    # @return [Boolean]  True if the route is a sitemap route, otherwise, false.
+    def is_sitemap?
+      @is_sitemap = @is_sitemap.nil? ? false : @is_sitemap
+    end
 
-        buffer = self.namespace_prefix
-        unless buffer.blank?
-          value = buffer.split("_").length
-        end
+    ##################################################################################
+    # @return [String] Namespace prefix used when creating the route.
+    def namespace_prefix
+      value = nil
 
-        return value
+      unless self.sitemap_raw_route_name.blank?
+        value = self.sitemap_route_name.gsub(self.sitemap_raw_route_name, "")
       end
 
-      ##################################################################################
-      # Identifies that the current sitemap route was defined with a block.
-      # @return [Boolean]  True if the route was defined with a block, otherwise, false.
-      def sitemap_with_block?
-        @sitemap_with_block = @sitemap_with_block.nil? ? false : @sitemap_with_block
-      end
+      return value
+    end
 
-      ##################################################################################
-      # Conveience method to return the name assigned to the route.  There is no need for nil
-      # checking the return value of this method.  It will simply return an empty String.
-      # @return [String] Name assigned to the route.
-      def route_name
-        return "#{self.name}"
-      end
+    ##################################################################################
+    def namespace_prefix_underscores
+      value = 0
 
-      ##################################################################################
-      # Returns the controller_name assigned to the route.
-      # @return [String] Controller_name name assigned to the route.
-      def controller_name
-        return self.requirements[:controller].blank? ? "" : self.requirements[:controller].to_s
+      buffer = self.namespace_prefix
+      unless buffer.blank?
+        value = buffer.split("_").length
       end
 
-      ##################################################################################
-      # Returns the action assigned to the route.
-      # @return [String] Action name assigned to the route.
-      def action_name
-        return self.requirements[:action].blank? ? "" : self.requirements[:action].to_s
-      end
+      return value
+    end
 
-      ##################################################################################
-      # The class name (as a String) of a model to be used as the source of rows for a route
-      # when generating sitemap content.
-      # @return [String]
-      def model
-        return self.defaults[:model]
-      end
+    ##################################################################################
+    # Identifies that the current sitemap route was defined with a block.
+    # @return [Boolean]  True if the route was defined with a block, otherwise, false.
+    def sitemap_with_block?
+      @sitemap_with_block = @sitemap_with_block.nil? ? false : @sitemap_with_block
+    end
 
-      ##################################################################################
-      # Setting changefreq directly on the route will override values set within a controller and model.
-      # This value will be used when generating a sitemap for the specific route.
-      #
-      #    MyApp::Application.routes.draw do
-      #
-      #      resources :trucks, :changefreq => "daily"
-      #
-      #    end
-      #
-      # produces url's like the following:
-      #
-      #    <url>
-      #      <loc>http://localhost:3000/trucks/1.html</loc>
-      #      <lastmod>2011-10-13T06:16:24+00:00</lastmod>
-      #      <changefreq>daily</changefreq>
-      #      <priority>0.5</priority>
-      #    </url>
-      #
-      # @return [String] Current value of changefreq.
-      def changefreq
-        return self.defaults[:changefreq]
-      end
+    ##################################################################################
+    # Conveience method to return the name assigned to the route.  There is no need for nil
+    # checking the return value of this method.  It will simply return an empty String.
+    # @return [String] Name assigned to the route.
+    def route_name
+      return "#{self.name}"
+    end
 
-      ##################################################################################
-      # Setting priority directly on the route will override values set within a controller and model.
-      # This value will be used when generating a sitemap for the specific route.
-      #
-      #    MyApp::Application.routes.draw do
-      #
-      #      resources :trucks, :priority => "0.4"
-      #
-      #    end
-      #
-      # produces url's like the following:
-      #
-      #    <url>
-      #      <loc>http://localhost:3000/trucks/1.html</loc>
-      #      <lastmod>2011-10-13T06:16:24+00:00</lastmod>
-      #      <changefreq>monthly</changefreq>
-      #      <priority>0.4</priority>
-      #    </url>
-      #
-      # @return [String] Current value of priority.
-      def priority
-        return self.defaults[:priority]
-      end
+    ##################################################################################
+    # Returns the controller_name assigned to the route.
+    # @return [String] Controller_name name assigned to the route.
+    def controller_name
+      return self.requirements[:controller].blank? ? "" : self.requirements[:controller].to_s
+    end
 
-      ##################################################################################
-      # Specifies the extension that should be used when generating a url for the route within a sitemap.
-      #
-      #    MyApp::Application.routes.draw do
-      #
-      #      resources :trucks, :url_format => "xml"
-      #
-      #    end
-      #
-      # produces url's like the following:
-      #
-      #    <loc>http://localhost:3000/trucks/1.xml</loc>
-      #    <loc>http://localhost:3000/trucks/2.xml</loc>
-      #
-      # @return [String]
-      def url_format
-        # a quick hack to default the extension for the root url to :none
-        return self.defaults[:url_format].blank? && self.route_name.eql?("root") ? :none : self.defaults[:url_format]
-      end
+    ##################################################################################
+    # Returns the action assigned to the route.
+    # @return [String] Action name assigned to the route.
+    def action_name
+      return self.requirements[:action].blank? ? "" : self.requirements[:action].to_s
+    end
 
-      ##################################################################################
-      def exclude_actions
-        return self.duckmap_defaults(:exclude_actions)
-      end
+    ##################################################################################
+    # The class name (as a String) of a model to be used as the source of rows for a route
+    # when generating sitemap content.
+    # @return [String]
+    def model
+      return self.defaults[:model]
+    end
 
-      ##################################################################################
-      def exclude_controllers
-        return self.duckmap_defaults(:exclude_controllers)
-      end
+    ##################################################################################
+    # Setting changefreq directly on the route will override values set within a controller and model.
+    # This value will be used when generating a sitemap for the specific route.
+    #
+    #    MyApp::Application.routes.draw do
+    #
+    #      resources :trucks, :changefreq => "daily"
+    #
+    #    end
+    #
+    # produces url's like the following:
+    #
+    #    <url>
+    #      <loc>http://localhost:3000/trucks/1.html</loc>
+    #      <lastmod>2011-10-13T06:16:24+00:00</lastmod>
+    #      <changefreq>daily</changefreq>
+    #      <priority>0.5</priority>
+    #    </url>
+    #
+    # @return [String] Current value of changefreq.
+    def changefreq
+      return self.defaults[:changefreq]
+    end
 
-      ##################################################################################
-      def exclude_names
-        return self.duckmap_defaults(:exclude_names)
-      end
+    ##################################################################################
+    # Setting priority directly on the route will override values set within a controller and model.
+    # This value will be used when generating a sitemap for the specific route.
+    #
+    #    MyApp::Application.routes.draw do
+    #
+    #      resources :trucks, :priority => "0.4"
+    #
+    #    end
+    #
+    # produces url's like the following:
+    #
+    #    <url>
+    #      <loc>http://localhost:3000/trucks/1.html</loc>
+    #      <lastmod>2011-10-13T06:16:24+00:00</lastmod>
+    #      <changefreq>monthly</changefreq>
+    #      <priority>0.4</priority>
+    #    </url>
+    #
+    # @return [String] Current value of priority.
+    def priority
+      return self.defaults[:priority]
+    end
 
-      ##################################################################################
-      def exclude_verbs
-        return self.duckmap_defaults(:exclude_verbs)
-      end
+    ##################################################################################
+    # Specifies the extension that should be used when generating a url for the route within a sitemap.
+    #
+    #    MyApp::Application.routes.draw do
+    #
+    #      resources :trucks, :url_format => "xml"
+    #
+    #    end
+    #
+    # produces url's like the following:
+    #
+    #    <loc>http://localhost:3000/trucks/1.xml</loc>
+    #    <loc>http://localhost:3000/trucks/2.xml</loc>
+    #
+    # @return [String]
+    def url_format
+      # a quick hack to default the extension for the root url to :none
+      return self.defaults[:url_format].blank? && self.route_name.eql?("root") ? :none : self.defaults[:url_format]
+    end
 
-      ##################################################################################
-      def include_actions
-        return self.duckmap_defaults(:include_actions)
-      end
+    ##################################################################################
+    def exclude_actions
+      return self.duckmap_defaults(:exclude_actions)
+    end
 
-      ##################################################################################
-      def include_controllers
-        return self.duckmap_defaults(:include_controllers)
-      end
+    ##################################################################################
+    def exclude_controllers
+      return self.duckmap_defaults(:exclude_controllers)
+    end
 
-      ##################################################################################
-      def include_names
-        return self.convert_to(self.duckmap_defaults(:include_names), :string)
-      end
+    ##################################################################################
+    def exclude_names
+      return self.duckmap_defaults(:exclude_names)
+    end
 
-      ##################################################################################
-      def include_verbs
-        return self.duckmap_defaults(:include_verbs)
-      end
+    ##################################################################################
+    def exclude_verbs
+      return self.duckmap_defaults(:exclude_verbs)
+    end
 
-      ##################################################################################
-      def verb_symbol
-        value = nil
-          unless self.verb.blank?
-            buffer = self.verb.to_s.downcase
-            if buffer.include?("delete")
-              value = :delete
+    ##################################################################################
+    def include_actions
+      return self.duckmap_defaults(:include_actions)
+    end
 
-            elsif buffer.include?("get")
-              value = :get
+    ##################################################################################
+    def include_controllers
+      return self.duckmap_defaults(:include_controllers)
+    end
 
-            elsif buffer.include?("post")
-              value = :post
+    ##################################################################################
+    def include_names
+      return self.convert_to(self.duckmap_defaults(:include_names), :string)
+    end
 
-            elsif buffer.include?("put")
-              value = :put
+    ##################################################################################
+    def include_verbs
+      return self.duckmap_defaults(:include_verbs)
+    end
 
-            end
+    ##################################################################################
+    def verb_symbol
+      value = nil
+        unless self.verb.blank?
+          buffer = self.verb.to_s.downcase
+          if buffer.include?("delete")
+            value = :delete
 
-          end
-        return value
-      end
+          elsif buffer.include?("get")
+            value = :get
 
-      ##################################################################################
-      # Indicates if the current route requirements segments keys to generate a url.
-      # @return [Boolean] True if keys are required to generate a url, otherwise, false.
-      def keys_required?
-        keys = self.segment_keys.dup
-        keys.delete(:format)
-        return keys.length > 0 ? true : false
-      end
+          elsif buffer.include?("post")
+            value = :post
 
-      ##################################################################################
-      # Looks for a key within ActionDispatch::Routing::Route.defaults.
-      # If found:
-      #   - determine the type of value:
-      #     - If Array, return the array.
-      #     - If String, create an array, add the String to it, and return the array.
-      #     - If Symbol, create an array, add the Symbol to it, and return the array.
-      # If nothing found, return an empty array.
-      # returns [Array]
-      def duckmap_defaults(key)
-        values = []
+          elsif buffer.include?("put")
+            value = :put
 
-        if self.defaults && self.defaults[key]
-          if self.defaults[key].kind_of?(Array)
-            values = self.defaults[key]
+          end
 
-          elsif self.defaults[key].kind_of?(String)
-            values.push(self.defaults[key])
+        end
+      return value
+    end
 
-          elsif self.defaults[key].kind_of?(Symbol)
-            values.push(self.defaults[key])
+    ##################################################################################
+    # Indicates if the current route requirements segments keys to generate a url.
+    # @return [Boolean] True if keys are required to generate a url, otherwise, false.
+    def keys_required?
+      keys = self.segment_keys.dup
+      keys.delete(:format)
+      return keys.length > 0 ? true : false
+    end
 
-          end
-        end
+    ##################################################################################
+    # Looks for a key within ActionDispatch::Routing::Route.defaults.
+    # If found:
+    #   - determine the type of value:
+    #     - If Array, return the array.
+    #     - If String, create an array, add the String to it, and return the array.
+    #     - If Symbol, create an array, add the Symbol to it, and return the array.
+    # If nothing found, return an empty array.
+    # returns [Array]
+    def duckmap_defaults(key)
+      values = []
+
+      if self.defaults && self.defaults[key]
+        if self.defaults[key].kind_of?(Array)
+          values = self.defaults[key]
+
+        elsif self.defaults[key].kind_of?(String)
+          values.push(self.defaults[key])
+
+        elsif self.defaults[key].kind_of?(Symbol)
+          values.push(self.defaults[key])
 
-        return values
+        end
       end
-    #end
+
+      return values
+    end
 
   end
 end

data/lib/duck_map/route_set.rb

@@ -106,6 +106,7 @@ module DuckMap
       end
 
       list.reject! {|route| route.path.spec =~ %r{/rails/info/properties|^/assets}}
+      list.reject! {|route| !route.is_available?}
 
       return list
     end

data/lib/duck_map/version.rb

@@ -1,3 +1,3 @@
 module DuckMap
-  VERSION = "0.8.1"
+  VERSION = "0.8.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: duck_map
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.8.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-20 00:00:00.000000000 Z
+date: 2013-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: highline