sitemap_generator 6.2.1 → 7.0.1

data/lib/sitemap_generator/builder/sitemap_index_file.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module SitemapGenerator
   module Builder
     class SitemapIndexFile < SitemapFile
@@ -6,12 +8,12 @@ module SitemapGenerator
       #
       # * <tt>location</tt> - a SitemapGenerator::SitemapIndexLocation instance or a Hash of options
       #   from which a SitemapLocation will be created for you.
-      def initialize(opts={})
+      def initialize(opts = {})
         @location = opts.is_a?(Hash) ? SitemapGenerator::SitemapIndexLocation.new(opts) : opts
         @link_count = 0
         @sitemaps_link_count = 0
-        @xml_content = '' # XML urlset content
-        @xml_wrapper_start = <<-HTML
+        @xml_content = +'' # XML urlset content
+        @xml_wrapper_start = +<<-HTML
           <?xml version="1.0" encoding="UTF-8"?>
             <sitemapindex
               xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
@@ -21,7 +23,7 @@ module SitemapGenerator
             >
         HTML
         @xml_wrapper_start.gsub!(/\s+/, ' ').gsub!(/ *> */, '>').strip!
-        @xml_wrapper_end   = %q[</sitemapindex>]
+        @xml_wrapper_end = '</sitemapindex>'
         @filesize = SitemapGenerator::Utilities.bytesize(@xml_wrapper_start) + SitemapGenerator::Utilities.bytesize(@xml_wrapper_end)
         @written = false
         @reserved_name = nil # holds the name reserved from the namer
@@ -45,7 +47,7 @@ module SitemapGenerator
       # can assume that the index is required (unless create_index is false of course).
       # This seems like the logical thing to do.
       alias_method :super_add, :add
-      def add(link, options={})
+      def add(link, options = {})
         if file = link.is_a?(SitemapFile) && link
           @sitemaps_link_count += file.link_count
           file.finalize! unless file.finalized?
@@ -59,7 +61,7 @@ module SitemapGenerator
           # for there to be an index.
           if @link_count == 0
             @first_sitemap = SitemapGenerator::Builder::LinkHolder.new(file, options)
-            @link_count += 1     # pretend it's added, but don't add it yet
+            @link_count += 1 # pretend it's added, but don't add it yet
           else
             # need an index so make sure name is reserved and first sitemap is written out
             reserve_name unless @location.create_index == false
@@ -94,13 +96,14 @@ module SitemapGenerator
         @sitemaps_link_count
       end
 
-      def stats_summary(opts={})
+      def stats_summary(opts = {})
         str = "Sitemap stats: #{number_with_delimiter(@sitemaps_link_count)} links / #{@link_count} sitemaps"
-        str += " / %dm%02ds" % opts[:time_taken].divmod(60) if opts[:time_taken]
+        str += ' / %dm%02ds' % opts[:time_taken].divmod(60) if opts[:time_taken]
       end
 
       def finalize!
         raise SitemapGenerator::SitemapFinalizedError if finalized?
+
         reserve_name if create_index?
         write_first_sitemap
         @frozen = true
@@ -138,7 +141,7 @@ module SitemapGenerator
         if @first_sitemap
           @first_sitemap.link.write unless @first_sitemap.link.written?
           super_add(SitemapGenerator::Builder::SitemapIndexUrl.new(@first_sitemap.link, @first_sitemap.options))
-          @link_count -= 1   # we already counted it, don't count it twice
+          @link_count -= 1 # we already counted it, don't count it twice
           # Store the URL because if create_index is false, this is the
           # "index" URL
           @first_sitemap_url = @first_sitemap.link.location.url

data/lib/sitemap_generator/builder/sitemap_index_url.rb

@@ -1,12 +1,14 @@
+# frozen_string_literal: true
+
 require 'builder'
 
 module SitemapGenerator
   module Builder
     class SitemapIndexUrl < SitemapUrl
 
-      def initialize(path, options={})
+      def initialize(path, options = {})
         if index = path.is_a?(SitemapGenerator::Builder::SitemapIndexFile) && path
-          options = SitemapGenerator::Utilities.reverse_merge(options, :host => index.location.host, :lastmod => Time.now, :priority => 1.0)
+          options = SitemapGenerator::Utilities.reverse_merge(options, host: index.location.host, lastmod: Time.now, priority: 1.0)
           path = index.location.path_in_public
           super(path, options)
         else
@@ -15,11 +17,11 @@ module SitemapGenerator
       end
 
       # Return the URL as XML
-      def to_xml(builder=nil)
+      def to_xml(builder = nil)
         builder = ::Builder::XmlMarkup.new if builder.nil?
         builder.sitemap do
           builder.loc        self[:loc]
-          builder.lastmod    w3c_date(self[:lastmod])   if self[:lastmod]
+          builder.lastmod    w3c_date(self[:lastmod]) if self[:lastmod]
         end
         builder << '' # force to string
       end

data/lib/sitemap_generator/builder/sitemap_url.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'builder'
 require 'uri'
 require 'time'
@@ -29,13 +31,13 @@ module SitemapGenerator
       # * +mobile+
       # * +alternate+/+alternates+
       # * +pagemap+
-      def initialize(path, options={})
+      def initialize(path, options = {})
         options = SitemapGenerator::Utilities.symbolize_keys(options)
         if sitemap = path.is_a?(SitemapGenerator::Builder::SitemapFile) && path
           SitemapGenerator::Utilities.reverse_merge!(
             options,
-            :host => sitemap.location.host,
-            :lastmod => sitemap.lastmod
+            host: sitemap.location.host,
+            lastmod: sitemap.lastmod
           )
           path = sitemap.location.path_in_public
         end
@@ -46,16 +48,16 @@ module SitemapGenerator
         )
         SitemapGenerator::Utilities.reverse_merge!(
           options,
-          :priority => 0.5,
-          :changefreq => 'weekly',
-          :lastmod => Time.now,
-          :images => [],
-          :news => {},
-          :videos => [],
-          :mobile => false,
-          :alternates => []
+          priority: 0.5,
+          changefreq: 'weekly',
+          lastmod: Time.now,
+          images: [],
+          news: {},
+          videos: [],
+          mobile: false,
+          alternates: []
         )
-        raise "Cannot generate a url without a host" unless SitemapGenerator::Utilities.present?(options[:host])
+        raise 'Cannot generate a url without a host' unless SitemapGenerator::Utilities.present?(options[:host])
 
         if video = options.delete(:video)
           options[:videos] = video.is_a?(Array) ? options[:videos].concat(video) : options[:videos] << video
@@ -67,23 +69,23 @@ module SitemapGenerator
         path = path.to_s.sub(/^\//, '')
         loc  = path.empty? ? options[:host] : (options[:host].to_s.sub(/\/$/, '') + '/' + path)
         self.merge!(
-          :priority   => options[:priority],
-          :changefreq => options[:changefreq],
-          :lastmod    => options[:lastmod],
-          :expires    => options[:expires],
-          :host       => options[:host],
-          :loc        => loc,
-          :images     => prepare_images(options[:images], options[:host]),
-          :news       => prepare_news(options[:news]),
-          :videos     => options[:videos],
-          :mobile     => options[:mobile],
-          :alternates => options[:alternates],
-          :pagemap    => options[:pagemap]
+          priority: options[:priority],
+          changefreq: options[:changefreq],
+          lastmod: options[:lastmod],
+          expires: options[:expires],
+          host: options[:host],
+          loc: loc,
+          images: prepare_images(options[:images], options[:host]),
+          news: prepare_news(options[:news]),
+          videos: options[:videos],
+          mobile: options[:mobile],
+          alternates: options[:alternates],
+          pagemap: options[:pagemap]
         )
       end
 
       # Return the URL as XML
-      def to_xml(builder=nil)
+      def to_xml(builder = nil)
         builder = ::Builder::XmlMarkup.new if builder.nil?
         builder.url do
           builder.loc        self[:loc]
@@ -94,8 +96,8 @@ module SitemapGenerator
 
           unless SitemapGenerator::Utilities.blank?(self[:news])
             news_data = self[:news]
-            builder.news:news do
-              builder.news:publication do
+            builder.news :news do
+              builder.news :publication do
                 builder.news :name, news_data[:publication_name].to_s if news_data[:publication_name]
                 builder.news :language, news_data[:publication_language].to_s if news_data[:publication_language]
               end
@@ -110,7 +112,7 @@ module SitemapGenerator
           end
 
           self[:images].each do |image|
-            builder.image:image do
+            builder.image :image do
               builder.image :loc, image[:loc]
               builder.image :caption, image[:caption].to_s             if image[:caption]
               builder.image :geo_location, image[:geo_location].to_s   if image[:geo_location]
@@ -124,25 +126,25 @@ module SitemapGenerator
               builder.video :thumbnail_loc, video[:thumbnail_loc].to_s
               builder.video :title, video[:title].to_s
               builder.video :description, video[:description].to_s
-              builder.video :content_loc, video[:content_loc].to_s           if video[:content_loc]
+              builder.video :content_loc, video[:content_loc].to_s if video[:content_loc]
               if video[:player_loc]
-                loc_attributes = { :allow_embed => yes_or_no_with_default(video[:allow_embed], true) }
+                loc_attributes = { allow_embed: yes_or_no_with_default(video[:allow_embed], true) }
                 loc_attributes[:autoplay] = video[:autoplay].to_s if SitemapGenerator::Utilities.present?(video[:autoplay])
                 builder.video :player_loc, video[:player_loc].to_s, loc_attributes
               end
-              builder.video :duration, video[:duration].to_s                 if video[:duration]
-              builder.video :expiration_date,  w3c_date(video[:expiration_date])  if video[:expiration_date]
-              builder.video :rating, format_float(video[:rating])       if video[:rating]
-              builder.video :view_count, video[:view_count].to_s             if video[:view_count]
+              builder.video :duration, video[:duration].to_s if video[:duration]
+              builder.video :expiration_date, w3c_date(video[:expiration_date]) if video[:expiration_date]
+              builder.video :rating, format_float(video[:rating]) if video[:rating]
+              builder.video :view_count, video[:view_count].to_s if video[:view_count]
               builder.video :publication_date, w3c_date(video[:publication_date]) if video[:publication_date]
-              video[:tags].each {|tag| builder.video :tag, tag.to_s }        if video[:tags]
+              video[:tags].each { |tag| builder.video :tag, tag.to_s }       if video[:tags]
               builder.video :tag, video[:tag].to_s                           if video[:tag]
               builder.video :category, video[:category].to_s                 if video[:category]
-              builder.video :family_friendly,  yes_or_no_with_default(video[:family_friendly], true) if video.has_key?(:family_friendly)
-              builder.video :gallery_loc, video[:gallery_loc].to_s, :title => video[:gallery_title].to_s if video[:gallery_loc]
+              builder.video :family_friendly, yes_or_no_with_default(video[:family_friendly], true) if video.has_key?(:family_friendly)
+              builder.video :gallery_loc, video[:gallery_loc].to_s, title: video[:gallery_title].to_s if video[:gallery_loc]
               builder.video :price, video[:price].to_s, prepare_video_price_attribs(video) if SitemapGenerator::Utilities.present?(video[:price])
               if video[:uploader]
-                builder.video :uploader, video[:uploader].to_s, video[:uploader_info] ? { :info => video[:uploader_info].to_s } : {}
+                builder.video :uploader, video[:uploader].to_s, video[:uploader_info] ? { info: video[:uploader_info].to_s } : {}
               end
               builder.video :live, yes_or_no_with_default(video[:live], true) if video.has_key?(:live)
               builder.video :requires_subscription, yes_or_no_with_default(video[:requires_subscription], true) if video.has_key?(:requires_subscription)
@@ -151,7 +153,7 @@ module SitemapGenerator
 
           self[:alternates].each do |alternate|
             rel = alternate[:nofollow] ? 'alternate nofollow' : 'alternate'
-            attributes = { :rel => rel, :href => alternate[:href].to_s }
+            attributes = { rel: rel, href: alternate[:href].to_s }
             attributes[:hreflang] = alternate[:lang].to_s if SitemapGenerator::Utilities.present?(alternate[:lang])
             attributes[:media] = alternate[:media].to_s if SitemapGenerator::Utilities.present?(alternate[:media])
             builder.xhtml :link, attributes
@@ -164,9 +166,9 @@ module SitemapGenerator
           unless SitemapGenerator::Utilities.blank?(self[:pagemap])
             builder.pagemap :PageMap do
               SitemapGenerator::Utilities.as_array(self[:pagemap][:dataobjects]).each do |dataobject|
-                builder.pagemap :DataObject, :type => dataobject[:type].to_s, :id => dataobject[:id].to_s do
+                builder.pagemap :DataObject, type: dataobject[:type].to_s, id: dataobject[:id].to_s do
                   SitemapGenerator::Utilities.as_array(dataobject[:attributes]).each do |attribute|
-                    builder.pagemap :Attribute, attribute[:value].to_s, :name => attribute[:name].to_s
+                    builder.pagemap :Attribute, attribute[:value].to_s, name: attribute[:name].to_s
                   end
                 end
               end
@@ -197,12 +199,12 @@ module SitemapGenerator
 
       # Return an Array of image option Hashes suitable to be parsed by SitemapGenerator::Builder::SitemapFile
       def prepare_images(images, host)
-        images.delete_if { |key,value| key[:loc] == nil }
+        images.delete_if { |key, value| key[:loc] == nil }
         images.each do |r|
           SitemapGenerator::Utilities.assert_valid_keys(r, :loc, :caption, :geo_location, :title, :license)
           r[:loc] = URI.join(host, r[:loc]).to_s
         end
-        images[0..(SitemapGenerator::MAX_SITEMAP_IMAGES-1)]
+        images[0..(SitemapGenerator::MAX_SITEMAP_IMAGES - 1)]
       end
 
       def w3c_date(date)
@@ -211,23 +213,24 @@ module SitemapGenerator
         elsif date.respond_to?(:iso8601)
           date.iso8601.sub(/Z$/i, '+00:00')
         elsif date.is_a?(Date) && !date.is_a?(DateTime)
-          date.strftime("%Y-%m-%d")
+          date.strftime('%Y-%m-%d')
         else
-          zulutime = if date.is_a?(DateTime)
-            date.new_offset(0)
-          elsif date.respond_to?(:utc)
-            date.utc
-          elsif date.is_a?(Integer)
-            Time.at(date).utc
-          else
-            nil
-          end
+          zulutime =
+            if date.is_a?(DateTime)
+              date.new_offset(0)
+            elsif date.respond_to?(:utc)
+              date.utc
+            elsif date.is_a?(Integer)
+              Time.at(date).utc
+            else
+              nil
+            end
 
           if zulutime
-            zulutime.strftime("%Y-%m-%dT%H:%M:%S+00:00")
+            zulutime.strftime('%Y-%m-%dT%H:%M:%S+00:00')
           else
             zone = date.strftime('%z').insert(-3, ':')
-            date.strftime("%Y-%m-%dT%H:%M:%S") + zone
+            date.strftime('%Y-%m-%dT%H:%M:%S') + zone
           end
         end
       end
@@ -237,6 +240,7 @@ module SitemapGenerator
       def yes_or_no(value)
         if value.is_a?(String)
           raise ArgumentError.new("Unrecognized value for yes/no field: #{value.inspect}") unless value =~ /^(yes|no)$/i
+
           value.downcase
         else
           value ? 'yes' : 'no'

data/lib/sitemap_generator/builder.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'sitemap_generator/builder/sitemap_file'
 require 'sitemap_generator/builder/sitemap_index_file'
 require 'sitemap_generator/builder/sitemap_url'
@@ -5,4 +7,4 @@ require 'sitemap_generator/builder/sitemap_index_url'
 
 module SitemapGenerator::Builder
   LinkHolder = Struct.new(:link, :options)
-end
+end

data/lib/sitemap_generator/core_ext/big_decimal.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bigdecimal'
 
 begin

data/lib/sitemap_generator/core_ext/numeric.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 class SitemapGenerator::Numeric
   KILOBYTE = 1024
   MEGABYTE = KILOBYTE * 1024

data/lib/sitemap_generator/core_ext.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Dir["#{File.dirname(__FILE__)}/core_ext/**/*.rb"].sort.each do |path|
   require path
 end

data/lib/sitemap_generator/helpers/number_helper.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 # require "sitemap_generator/core_ext/big_decimal/conversions"
-require "sitemap_generator/utilities"
+require 'sitemap_generator/utilities'
 
 module SitemapGenerator
   # = SitemapGenerator Number Helpers
-  module Helpers #:nodoc:
+  module Helpers # :nodoc:
 
     # Provides methods for converting numbers into formatted strings.
     # Methods are provided for precision, positional notation and file size
@@ -52,11 +54,11 @@ module SitemapGenerator
         end
 
         defaults = {
-          :separator => ".",
-          :delimiter => ",",
-          :precision => 3,
-          :significant => false,
-          :strip_insignificant_zeros => false
+          separator: '.',
+          delimiter: ',',
+          precision: 3,
+          significant: false,
+          strip_insignificant_zeros: false
         }
         options = SitemapGenerator::Utilities.reverse_merge(options, defaults)
 
@@ -105,18 +107,18 @@ module SitemapGenerator
         end
 
         defaults = {
-          :separator => ".",
-          :delimiter => ",",
-          :precision => 3,
-          :significant => false,
-          :strip_insignificant_zeros => false
+          separator: '.',
+          delimiter: ',',
+          precision: 3,
+          significant: false,
+          strip_insignificant_zeros: false
         }
         precision_defaults = {
-          :delimiter => ""
+          delimiter: ''
         }
         defaults = defaults.merge(precision_defaults)
 
-        options = SitemapGenerator::Utilities.reverse_merge(options, defaults)  # Allow the user to unset default values: Eg.: :significant => false
+        options = SitemapGenerator::Utilities.reverse_merge(options, defaults) # Allow the user to unset default values: Eg.: :significant => false
         precision = options.delete :precision
         significant = options.delete :significant
         strip_insignificant_zeros = options.delete :strip_insignificant_zeros
@@ -126,11 +128,11 @@ module SitemapGenerator
             digits, rounded_number = 1, 0
           else
             digits = (Math.log10(number.abs) + 1).floor
-            rounded_number = (SitemapGenerator::BigDecimal.new(number.to_s) / SitemapGenerator::BigDecimal.new((10 ** (digits - precision)).to_f.to_s)).round.to_f * 10 ** (digits - precision)
+            rounded_number = (SitemapGenerator::BigDecimal.new(number.to_s) / SitemapGenerator::BigDecimal.new((10**(digits - precision)).to_f.to_s)).round.to_f * 10**(digits - precision)
             digits = (Math.log10(rounded_number.abs) + 1).floor # After rounding, the number of digits may have changed
           end
           precision = precision - digits
-          precision = precision > 0 ? precision : 0  #don't let it be negative
+          precision = precision > 0 ? precision : 0 # don't let it be negative
         else
           rounded_number = SitemapGenerator::Utilities.round(SitemapGenerator::BigDecimal.new(number.to_s), precision).to_f
         end
@@ -191,24 +193,24 @@ module SitemapGenerator
         end
 
         defaults = {
-          :separator => ".",
-          :delimiter => ",",
-          :precision => 3,
-          :significant => false,
-          :strip_insignificant_zeros => false
+          separator: '.',
+          delimiter: ',',
+          precision: 3,
+          significant: false,
+          strip_insignificant_zeros: false
         }
         human = {
-          :delimiter => "",
-          :precision => 3,
-          :significant => true,
-          :strip_insignificant_zeros => true
+          delimiter: '',
+          precision: 3,
+          significant: true,
+          strip_insignificant_zeros: true
         }
         defaults = defaults.merge(human)
         options = SitemapGenerator::Utilities.reverse_merge(options, defaults)
-        #for backwards compatibility with those that didn't add strip_insignificant_zeros to their locale files
+        # for backwards compatibility with those that didn't add strip_insignificant_zeros to their locale files
         options[:strip_insignificant_zeros] = true if not options.key?(:strip_insignificant_zeros)
 
-        storage_units_format = "%n %u"
+        storage_units_format = '%n %u'
 
         if number.to_i < 1024
           unit = number.to_i > 1 || number.to_i == 0 ? 'Bytes' : 'Byte'
@@ -217,15 +219,15 @@ module SitemapGenerator
           max_exp  = STORAGE_UNITS.size - 1
           exponent = (Math.log(number) / Math.log(1024)).to_i # Convert to base 1024
           exponent = max_exp if exponent > max_exp # we need this to avoid overflow for the highest unit
-          number  /= 1024 ** exponent
+          number  /= 1024**exponent
 
           unit_key = STORAGE_UNITS[exponent]
           units = {
-            :byte => "Bytes",
-            :kb => "KB",
-            :mb => "MB",
-            :gb => "GB",
-            :tb => "TB"
+            byte: 'Bytes',
+            kb: 'KB',
+            mb: 'MB',
+            gb: 'GB',
+            tb: 'TB'
           }
           unit = units[unit_key]
           formatted_number = number_with_precision(number, options)

data/lib/sitemap_generator/interpreter.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'sitemap_generator'
 
 module SitemapGenerator
@@ -22,8 +24,8 @@ module SitemapGenerator
     # * <tt>link_set</tt> - a LinkSet instance to use.  Default is SitemapGenerator::Sitemap.
     #
     # All other options are passed to the LinkSet by setting them using accessor methods.
-    def initialize(opts={}, &block)
-      opts = SitemapGenerator::Utilities.reverse_merge(opts, :link_set => SitemapGenerator::Sitemap)
+    def initialize(opts = {}, &block)
+      opts = SitemapGenerator::Utilities.reverse_merge(opts, link_set: SitemapGenerator::Sitemap)
       @linkset = opts.delete :link_set
       @linkset.send(:set_options, opts)
       eval(&block) if block_given?
@@ -53,7 +55,7 @@ module SitemapGenerator
 
     # Evaluate the block in the interpreter.  Pass :yield_sitemap => true to
     # yield the Interpreter instance to the block...for old-style calling.
-    def eval(opts={}, &block)
+    def eval(opts = {}, &block)
       if block_given?
         if opts[:yield_sitemap]
           yield @linkset
@@ -70,7 +72,7 @@ module SitemapGenerator
     # * <tt>:config_file</tt> - full path to the config file to evaluate.
     #   Default is config/sitemap.rb in your application's root directory.
     # All other options are passed to +new+.
-    def self.run(opts={}, &block)
+    def self.run(opts = {}, &block)
       opts = opts.dup
       config_file = opts.delete(:config_file)
       config_file ||= SitemapGenerator.app.root + 'config/sitemap.rb'