duck_map 0.8.0

data/lib/duck_map/handlers/index.rb

@@ -0,0 +1,140 @@
+require 'active_support/concern'
+
+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
+
+      ##################################################################################
+      def sitemap_new(options = {})
+        return []
+      end
+
+      ##################################################################################
+      def sitemap_edit(options = {})
+        return []
+      end
+
+      ##################################################################################
+      def sitemap_index(options = {})
+        rows = []
+
+        # always start off with default values from config, then, simply overwrite them as we progress.
+        values = sitemap_defaults(options)
+
+        # if the source is meta_data, that means the call to sitemap_index is the result of a user
+        # requesting an index page.  Therefore, there would be no reason to call the index action, because,
+        # it has already been called and any instance variable have been set.
+        # Otherwise, if this is the result of a sitemap request, then, call the index action to simulate
+        # as if it were a user making the request.
+        if options[:source] == :sitemap
+
+          begin
+
+            index
+
+          rescue Exception => e
+            # expect this exception to occur EVERYTIME...
+          end
+
+        end
+
+
+        lastmod = self.sitemap_static_lastmod(options[:controller_name], options[:action_name])
+        unless lastmod.blank?
+          values[:lastmod] = lastmod
+        end
+
+        # first, capture the values from the controller.
+        attributes = self.sitemap_stripped_attributes(options[:action_name])
+        values = values.merge(self.sitemap_capture_attributes(attributes))
+
+        data_rows = []
+
+        if !options[:handler][:block].blank?
+
+          data_rows = options[:handler][:block].call(options)
+
+        elsif !options[:handler][:model].blank?
+
+          data_rows = options[:handler][:model].send(:all)
+
+        else
+
+          # capture values from the first available model unless disabled.
+          model_object = sitemap_first_model(options[:handler])
+          unless model_object.blank?
+            model_attributes = attributes
+            if model_object.is_sitemap_attributes_defined?
+              model_attributes = model_object.sitemap_stripped_attributes(options[:action_name])
+            end
+
+            values = values.merge(model_object.sitemap_capture_attributes(model_attributes))
+          end
+
+        end
+
+        # data_rows may have changed from an Array to a model object.
+        # Make data_rows an Array if it has been switched to an model object.
+        if data_rows.kind_of?(ActiveRecord::Base)
+          data_rows = [data_rows]
+        end
+
+        # only process the first row since we are processing the index action of the controller
+        if data_rows.kind_of?(Array) && data_rows.length > 0
+
+          data_row = data_rows.first
+
+          model_attributes = attributes
+          if data_row.is_sitemap_attributes_defined?
+            model_attributes = data_row.sitemap_stripped_attributes(options[:action_name])
+          end
+
+          values = values.merge(data_row.sitemap_capture_attributes(model_attributes))
+
+        end
+
+        if values[:canonical].blank?
+
+          route = options[:source] == :meta_data ? Rails.application.routes.find_route_via_path(request.path) : options[:route]
+
+          url_options = sitemap_url_options(values)
+
+          # forgive me father for I have hacked...
+          # 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.
+          if !route.name.blank? && route.name.eql?("root")
+            url_options.delete(:format)
+            values[:canonical] = root_url(url_options)
+          else
+            values[:canonical] = self.send("#{route.name}_url", url_options)
+          end
+
+          values[:loc] = values[:canonical]
+        else
+          values[:loc] = values[:canonical]
+        end
+
+        rows.push(values)
+
+        self.sitemap_meta_data = values
+
+        return rows
+      end
+
+    end
+
+  end
+end

data/lib/duck_map/handlers/show.rb

@@ -0,0 +1,231 @@
+require 'active_support/concern'
+
+module DuckMap
+  module Handlers
+
+    ##################################################################################
+    module Show
+      extend ActiveSupport::Concern
+
+      ##################################################################################
+      def sitemap_show(options = {})
+        rows = []
+puts YAML.dump(options)
+
+        # always start off with default values from config, then, simply overwrite them as we progress.
+        values = sitemap_defaults(options)
+
+        # show action never needs to call the existing show action.
+
+        lastmod = self.sitemap_static_lastmod(options[:controller_name], options[:action_name])
+        unless lastmod.blank?
+          values[:lastmod] = lastmod
+        end
+
+        # first, capture the values from the controller.
+        attributes = self.sitemap_stripped_attributes(options[:action_name])
+puts "............................ attributes"
+puts YAML.dump(attributes)
+
+        values = values.merge(self.sitemap_capture_attributes(attributes))
+puts "---------------------------------==== values"
+puts YAML.dump(values)
+
+        if options[:source] == :meta_data
+puts " !!!!!!!!!!!!! going for it..."
+          # capture values from the first available model unless disabled.
+          model_object = sitemap_first_model(options[:handler])
+puts "###########################3 model_object: #{model_object}"
+          unless model_object.blank?
+            model_attributes = attributes
+            if model_object.is_sitemap_attributes_defined?
+              model_attributes = model_object.sitemap_stripped_attributes(options[:action_name])
+            end
+puts "**********************************************==== model_attributes"
+puts YAML.dump(model_attributes)
+
+puts "wtf wtf wtf wtf wtf wtf wtf wtf wtf wtf wtf wtf wtf wtf wtf wtf wtf wtf wtf wtf "
+puts YAML.dump(model_object.sitemap_capture_attributes(model_attributes))
+
+            values = values.merge(model_object.sitemap_capture_attributes(model_attributes))
+puts "---------------------------------==== values again"
+puts YAML.dump(values)
+          end
+
+          if values[:canonical].blank?
+            route = Rails.application.routes.find_route_via_path(request.path)
+            url_options = sitemap_url_options(values)
+            values[:canonical] = self.send("#{route.name}_url", url_options)
+            values[:loc] = values[:canonical]
+          else
+            values[:loc] = values[:canonical]
+          end
+puts "............................ values"
+puts YAML.dump(values)
+
+          rows.push(values)
+
+          self.sitemap_meta_data = values
+
+        else
+
+          data_rows = []
+
+          if !options[:handler][:block].blank?
+
+            data_rows = options[:handler][:block].call(options)
+
+          elsif !options[:handler][:model].blank?
+
+            data_rows = options[:handler][:model].send(:all)
+
+          elsif !options[:model].blank?
+
+            # this model is not set by developer
+            # it is set in code in sitemap_build using get_model_class
+            data_rows = options[:model].send(:all)
+
+          end
+
+          # data_rows may have changed from an Array to a model object.
+          # Make data_rows an Array if it has been switched to an model object.
+          if data_rows.kind_of?(ActiveRecord::Base)
+            data_rows = [data_rows]
+          end
+
+          # only process the first row since we are processing the index action of the controller
+          if data_rows.kind_of?(Array) && data_rows.length > 0
+
+            data_rows.each do |data_row|
+
+              # this is how we are overriding attributes defined on the controller with attributes
+              # defined on the model.  The model attributes win!
+              # same thing for segments below.
+              model_attributes = attributes
+              if data_row.is_sitemap_attributes_defined?
+                model_attributes = data_row.sitemap_stripped_attributes(options[:action_name])
+              end
+
+              row_values = values.merge(data_row.sitemap_capture_attributes(model_attributes))
+
+              url_options = sitemap_url_options(row_values)
+
+              if row_values[:canonical].blank?
+
+                segments = data_row.sitemap_capture_segments(model_attributes, options[:route].segments)
+                row_values[:canonical] = self.send("#{options[:route].name}_url", url_options.merge(segments))
+                row_values[:loc] = row_values[:canonical]
+
+              else
+                row_values[:loc] = row_values[:canonical]
+              end
+
+              rows.push(row_values)
+
+            end
+
+          end
+
+        end
+
+        return sitemap_url_limit(rows, options[:handler])
+      end
+
+      ###################################################################################
+      #def sitemap_show(options = {})
+        #rows = []
+
+        ## always start off with default values from config, then, simply overwrite them as we progress.
+        #values = sitemap_defaults
+
+        #if options[:source] == :meta_data
+
+          ## if the source is meta_data, that means this method call is the result of a user
+          ## requesting an index page.  Therefore, the controller action_name variable should be set.
+          ## so, go ahead and use it.
+
+          #lastmod = self.sitemap_static_lastmod(controller_name, action_name)
+          #unless lastmod.blank?
+            #values[:lastmod] = lastmod
+          #end
+
+          ## first, capture the values from the controller.
+          #attributes = self.sitemap_stripped_attributes(action_name)
+          #values = values.merge(self.sitemap_capture_attributes(attributes))
+
+          #if options[:handler][:first_model]
+            #model_object = sitemap_first_model(options[:handler])
+            #unless model_object.blank?
+              #values = values.merge(model_object.sitemap_capture_attributes(attributes))
+            #end
+          #end
+
+          #route = Rails.application.routes.find_route_via_path(request.path)
+          #values[:loc] = self.send("#{route.name}_url", params.merge({format: values[:url_format]}))
+          #values[:canonical] = values[:loc]
+
+          #rows.push(values)
+
+          #self.sitemap_meta_data = values
+
+        #elsif options[:source] == :sitemap
+
+          #begin
+
+            #route = options[:route]
+
+            #lastmod = self.sitemap_static_lastmod(route.controller_name, route.action_name)
+            #unless lastmod.blank?
+              #values[:lastmod] = lastmod
+            #end
+
+            #attributes = self.sitemap_stripped_attributes(options[:action_name])
+            #values = values.merge(self.sitemap_capture_attributes(attributes))
+
+            #data_rows = []
+
+            #if !options[:handler][:block].blank?
+
+              #data_rows = options[:handler][:block].call(options)
+
+            #elsif !options[:handler][:model].blank?
+
+              #data_rows = options[:handler][:model].send(:all)
+
+            #elsif !options[:model].blank?
+
+              #data_rows = options[:model].send(:all)
+
+            #end
+
+            #unless data_rows.kind_of?(Array)
+              #if data_rows.kind_of?(ActiveRecord::Base)
+                #data_rows = [data_rows]
+              #end
+            #end
+
+            #data_rows.each do |data_row|
+
+              #row_values = values.merge(data_row.sitemap_capture_attributes(attributes))
+
+              #segments = data_row.sitemap_capture_segments(attributes, route.segments)
+
+              #row_values[:canonical] = self.send("#{route.name}_url", {format: row_values[:url_format]}.merge(segments))
+              #row_values[:loc] = row_values[:canonical]
+              #rows.push(row_values)
+
+            #end
+
+          #rescue Exception => e
+            #DuckMap.logger.exception(e)
+          #end
+
+        #end
+
+        #return sitemap_url_limit(rows, values)
+      #end
+
+    end
+
+  end
+end

data/lib/duck_map/last_mod.rb

@@ -0,0 +1,45 @@
+# DONE
+module DuckMap
+
+  ##################################################################################
+  # LastMod is a Date/Time parsing class.
+  class LastMod
+
+    ##################################################################################
+    # Parses a DateTime represented as a String into a DateTime value.  If value is String, then, it is parsed
+    # and returns a DateTime Object if valid.  Otherwise, it returns nil.  If the value passed is a Date, Time, or DateTime, then,
+    # it is returned as is.
+    # @param [String] A DateTime represented as a String to parse or can be a Date, Time, or DateTime value.
+    # @return [DateTime] DateTime value.
+    def self.to_date(value)
+      date_value = nil
+
+      if value.kind_of?(String)
+
+        formats = ["%m/%d/%Y %H:%M:%S", "%m-%d-%Y %H:%M:%S", "%Y-%m-%d %H:%M:%S", "%m/%d/%Y", "%m-%d-%Y", "%Y-%m-%d"]
+        Time::DATE_FORMATS.each_value { |x| formats.push(x)}
+
+        formats.each do |format|
+
+          begin
+
+            date_value = Time.strptime(value, format)
+            break
+
+          rescue Exception => e
+            date_value = nil
+          end
+          
+        end
+
+      elsif value.kind_of?(Date) || value.kind_of?(Time) || value.kind_of?(DateTime)
+        date_value = value
+        
+      end        
+
+      return date_value
+    end
+
+  end
+
+end

data/lib/duck_map/list.rb

@@ -0,0 +1,82 @@
+module DuckMap
+
+  ##################################################################################
+  # Lists all of the sitemaps defined in config/routes.rb
+  class List
+
+    ##################################################################################
+    def build(options = {})
+
+      key = options[:key].blank? ? :all : options[:key].to_s.downcase.to_sym
+
+      contents = options.has_key?(:contents) ? true : false
+
+      contents = key.eql?(:all) ? contents : true
+
+      puts "Searching for route: #{key}"
+
+      routes = []
+      if key.eql?(:all)
+
+        routes = Rails.application.routes.sitemap_routes_only
+
+      else
+
+        route = Rails.application.routes.find_route_via_name("#{key}_sitemap")
+        if route.blank?
+          puts "Unable to find route: #{key}"
+        else
+          routes.push(route)
+        end
+
+      end
+
+      if routes.length > 0
+
+        puts "\r\n\r\nSitemap routes"
+        puts %(#{"route name".ljust(40)} controller_name#action_name)
+        puts %(#{"".ljust(40)} path)
+        puts "---------------------------------------------------------------------------------------------------------------"
+
+        routes.each do |route|
+
+          default_route = !route.name.blank? && route.name.to_sym.eql?(:sitemap_sitemap) ? " (DEFAULT)" : ""
+
+          puts %(\r\n#{(route.name.blank? ? "".ljust(40) : "#{route.name}#{default_route}".ljust(40))} #{route.controller_name}##{route.action_name})
+
+          puts %(#{"".ljust(40)} #{route.path.spec})
+
+          if contents
+
+            sitemap_routes = Rails.application.routes.sitemap_routes(route)
+            if sitemap_routes.length > 0
+              #puts %(\r\n#{"".ljust(5)} route name                         controller_name#action_name)
+              #puts %(#{"".ljust(5)}                                    path)
+              puts %(#{"".ljust(5)} --------------------------------------------------------------)
+
+              sitemap_routes.each do |sitemap_route|
+
+                puts %(#{"".ljust(5)} #{(sitemap_route.name.blank? ? "".ljust(34) : "#{sitemap_route.name}".ljust(34))} #{sitemap_route.controller_name}##{sitemap_route.action_name})
+
+                puts %(#{"".ljust(40)} #{sitemap_route.path.spec})
+
+              end
+
+            else
+              puts %(#{"".ljust(10)} No routes)
+              puts %(#{"".ljust(10)} ----------------------------------------------)
+            end
+
+          end
+
+        end
+
+      else
+        puts "Sorry, no routes found..."
+      end
+
+    end
+
+  end
+
+end

data/lib/duck_map/logger.rb

@@ -0,0 +1,193 @@
+# DONE
+module DuckMap
+
+  # Logger class generates logging information in log/duckmap.log
+  class Logger < ::Logger
+
+    CLEAR   = "\e[0m"
+    BOLD    = "\e[1m"
+
+    # Colors
+    BLACK   = "\e[30m"
+    RED     = "\e[31m"
+    GREEN   = "\e[32m"
+    YELLOW  = "\e[33m"
+    BLUE    = "\e[34m"
+    MAGENTA = "\e[35m"
+    CYAN    = "\e[36m"
+    WHITE   = "\e[37m"
+
+    ##################################################################################
+    # Instance of DuckMap::Logger
+    def self.logger
+      dir = defined?(Rails) ? Rails.root : "."
+      return @@logger ||= self.new("#{dir}/log/duckmap.log", INFO)
+    end
+    
+    ##################################################################################
+    # Converts a Symbol to a valid log level and vise versa.
+    # @return [Object] The return value is based on the argument :key.
+    #                    - If you pass a Symbol, you get a log level.
+    #                    - If you pass a log level, you get a Symbol.
+    def self.to_severity(key)
+      key = key.kind_of?(Fixnum) || key.kind_of?(Symbol) ? key : :badkey
+      values = {debug: DEBUG, info: INFO, warn: WARN, error: ERROR, fatal: FATAL, unknown: UNKNOWN}
+      value = values.map.find {|value| value[key.kind_of?(Symbol) ? 0 : 1].eql?(key)}
+      return value.blank? ? nil : value[key.kind_of?(Symbol) ? 1 : 0]
+    end
+
+    def to_severity(key)
+      return self.class.to_severity(key)
+    end
+
+    ##################################################################################
+    # Sets the logging level.
+    # @param [Symbol, Number] key A value representing the desired logging level.
+    #                             Valid values: :debug, :info, :warn, :error, :fatal, :unknown
+    #                             DEBUG, INFO, WARN, ERROR, FATAL, UNKNOWN
+    # @return [Number]
+    def self.log_level=(key)
+      value = self.to_severity(key)
+
+      unless value.blank?
+        @@log_level = value
+        self.logger.level = value
+      end
+      return self.logger.level
+    end
+
+    def log_level=(key)
+      self.class.log_level = key
+    end
+
+    ##################################################################################
+    # Gets the current logging level.
+    # @return [Number]
+    def self.log_level
+      @@log_level ||= self.logger.level
+      return @@log_level
+    end
+
+    def log_level
+      return self.class.log_level
+    end
+
+    ##################################################################################
+    def self.full_exception=(value)
+      @@full_exception = value
+      return @@full_exception
+    end
+
+    def full_exception=(value)
+      self.class.full_exception = value
+    end
+
+    ##################################################################################
+    def self.full_exception
+      unless defined?(@@full_exception)
+        @@full_exception = false
+      end
+      return @@full_exception
+    end
+
+    def full_exception
+      return self.class.full_exception
+    end
+
+    ##################################################################################
+    def console(msg = nil, progname = nil, &block)
+      if self.is_show_console?
+        STDOUT.puts msg
+      end
+      info(msg, progname, &block)
+      return nil
+    end
+
+    ##################################################################################
+    def self.show_console
+      unless defined?(@@show_console)
+        @@show_console = true
+      end
+      return @@show_console
+    end
+
+    def self.show_console=(value)
+      @@show_console = value
+    end
+
+    def self.is_show_console?
+      return self.show_console
+    end
+
+    def show_console
+      return self.class.show_console
+    end
+
+    def show_console=(value)
+      self.class.show_console = value
+    end
+
+    def is_show_console?
+      return self.class.is_show_console?
+    end
+
+    ##################################################################################
+    def exception(exception, progname = nil, &block)
+
+      self.error(exception.message, progname, &block)
+
+      base_dir = Rails.root.to_s
+      exception.backtrace.each do |x|
+        if x.include?(base_dir) || self.full_exception
+          self.error(x, progname, &block)
+        end
+      end
+
+      return nil
+    end
+
+    ##################################################################################
+    def debug(msg = nil, progname = nil, &block)
+      add(DEBUG, color("#{msg}", CYAN), progname, &block)
+      return nil
+    end
+
+    ##################################################################################
+    def error(msg = nil, progname = nil, &block)
+      add(ERROR, color("#{msg}", RED), progname, &block)
+      return nil
+    end
+
+    ##################################################################################
+    def fatal(msg = nil, progname = nil, &block)
+      add(FATAL, color("#{msg}", RED), progname, &block)
+      return nil
+    end
+
+    ##################################################################################
+    def info(msg = nil, progname = nil, &block)
+      add(INFO, "#{msg}", progname, &block)
+      return nil
+    end
+
+    ##################################################################################
+    def warn(msg = nil, progname = nil, &block)
+      add(WARN, color("#{msg}", YELLOW), progname, &block)
+      return nil
+    end
+
+    ##################################################################################
+    def unknown(msg = nil, progname = nil, &block)
+      add(INFO, color("#{msg}", WHITE), progname, &block)
+      return nil
+    end
+
+    #############################################################################################
+    def color(text, color, bold=false)
+      color = self.class.const_get(color.to_s.upcase) if color.is_a?(Symbol)
+      bold  = bold ? BOLD : ""
+      return "#{bold}#{color}#{text}#{CLEAR}"
+    end
+
+  end
+end