Class: SitemapGenerator::SitemapLocation

Inherits:
Hash
  • Object
show all
Includes:
Helpers::NumberHelper
Defined in:
lib/sitemap_generator/sitemap_location.rb

Overview

A class for determining the exact location at which to write sitemap data. Handles reserving filenames from namers, constructing paths and sending data to the adapter to be written out.

Direct Known Subclasses

SitemapIndexLocation

Constant Summary collapse

PATH_OUTPUT_WIDTH =

Character width of the path in the summary lines

47

Constants included from Helpers::NumberHelper

Helpers::NumberHelper::DECIMAL_UNITS, Helpers::NumberHelper::STORAGE_UNITS

Instance Method Summary collapse

Methods included from Helpers::NumberHelper

#number_to_human_size, #number_with_delimiter, #number_with_precision

Constructor Details

#initialize(opts = {}) ⇒ SitemapLocation

If no filename or namer is provided, the default namer is used, which generates names like sitemap.xml.gz, sitemap1.xml.gz, sitemap2.xml.gz and so on.

Options

  • :adapter - SitemapGenerator::Adapter subclass

  • :filename - full name of the file e.g. <tt>‘sitemap1.xml.gz’<tt>

  • :host - host name for URLs. The full URL to the file is then constructed from the host, sitemaps_path and filename

  • :namer - a SitemapGenerator::SimpleNamer instance for generating file names. Should be passed if no filename is provided.

  • :public_path - path to the “public” directory, or the directory you want to write sitemaps in. Default is a directory public/ in the current working directory, or relative to the Rails root directory if running under Rails.

  • :sitemaps_path - gives the path relative to the public_path in which to write sitemaps e.g. sitemaps/.

  • :verbose - whether to output summary into to STDOUT. Default false.

  • :create_index - whether to create a sitemap index. Default ‘:auto`. See LinkSet::create_index= for possible values. Only applies to the SitemapIndexLocation object.

  • compress - The LinkSet compress setting. Default: true. If ‘false` any `.gz` extension is stripped from the filename. If `:all_but_first`, only the `.gz` extension of the first filename is stripped off. If `true` the extensions are left unchanged.

  • max_sitemap_links - The maximum number of links to put in each sitemap.



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/sitemap_generator/sitemap_location.rb', line 51

def initialize(opts = {})
  SitemapGenerator::Utilities.assert_valid_keys(opts, [
    :adapter,
    :public_path,
    :sitemaps_path,
    :host,
    :filename,
    :namer,
    :verbose,
    :create_index,
    :compress,
    :max_sitemap_links
  ])
  opts[:adapter] ||= SitemapGenerator::FileAdapter.new
  opts[:public_path] ||= SitemapGenerator.app.root + 'public/'
  # This is a bit of a hack to make the SimpleNamer act like the old SitemapNamer.
  # It doesn't really make sense to create a default namer like this because the
  # namer instance should be shared by the location objects of the sitemaps and
  # sitemap index files.  However, this greatly eases testing, so I'm leaving it in
  # for now.
  if !opts[:filename] && !opts[:namer]
    opts[:namer] = SitemapGenerator::SimpleNamer.new(:sitemap, start: 2, zero: 1)
  end
  opts[:verbose] = !!opts[:verbose]
  self.merge!(opts)
end

Instance Method Details

#[]=(key, value, opts = {}) ⇒ Object

If you set the filename, clear the namer and vice versa.



155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/sitemap_generator/sitemap_location.rb', line 155

def []=(key, value, opts = {})
  if !opts[:super]
    case key
    when :namer
      super(:filename, nil)
    when :filename
      super(:namer, nil)
    end
  end
  super(key, value)
end

#directory ⇒ Object

Full path to the directory of the file.



84
85
86
 
# File 'lib/sitemap_generator/sitemap_location.rb', line 84

def directory
  (public_path + sitemaps_path).expand_path.to_s
end

#filename ⇒ Object

Return the filename. Raises an exception if no filename or namer is set. If using a namer once the filename has been retrieved from the namer its value is locked so that it is unaffected by further changes to the namer.

Raises:



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/sitemap_generator/sitemap_location.rb', line 111

def filename
  raise SitemapGenerator::SitemapError, 'No filename or namer set' unless self[:filename] || self[:namer]

  unless self[:filename]
    self.send(:[]=, :filename, +self[:namer].to_s, super: true)

    # Post-process the filename for our compression settings.
    # Strip the `.gz` from the extension if we aren't compressing this file.
    # If you're setting the filename manually, :all_but_first won't work as
    # expected.  Ultimately I should force using a namer in all circumstances.
    # Changing the filename here will affect how the FileAdapter writes out the file.
    if self[:compress] == false ||
       (self[:namer] && self[:namer].start? && self[:compress] == :all_but_first)
      self[:filename].gsub!(/\.gz$/, '')
    end
  end
  self[:filename]
end

#filesize ⇒ Object

Return the size of the file at path



104
105
106
 
# File 'lib/sitemap_generator/sitemap_location.rb', line 104

def filesize
  File.size?(path)
end

#namer ⇒ Object 



146
147
148
 
# File 'lib/sitemap_generator/sitemap_location.rb', line 146

def namer
  self[:namer]
end

#path ⇒ Object

Full path of the file including the filename.



89
90
91
 
# File 'lib/sitemap_generator/sitemap_location.rb', line 89

def path
  (public_path + sitemaps_path + filename).expand_path.to_s
end

#path_in_public ⇒ Object

Relative path of the file (including the filename) relative to public_path



94
95
96
 
# File 'lib/sitemap_generator/sitemap_location.rb', line 94

def path_in_public
  (sitemaps_path + filename).to_s
end

#reserve_name ⇒ Object

If a namer is set, reserve the filename and increment the namer. Returns the reserved name.



132
133
134
135
136
137
138
 
# File 'lib/sitemap_generator/sitemap_location.rb', line 132

def reserve_name
  if self[:namer]
    filename
    self[:namer].next
  end
  self[:filename]
end

#reserved_name? ⇒ Boolean

Return true if this location has a fixed filename. If no name has been reserved from the namer, for instance, returns false.

Returns:

  • (Boolean) 


142
143
144
 
# File 'lib/sitemap_generator/sitemap_location.rb', line 142

def reserved_name?
  !!self[:filename]
end

#summary(link_count) ⇒ Object

Return a summary string



175
176
177
178
179
180
 
# File 'lib/sitemap_generator/sitemap_location.rb', line 175

def summary(link_count)
  filesize = number_to_human_size(self.filesize)
  width = self.class::PATH_OUTPUT_WIDTH
  path = SitemapGenerator::Utilities.ellipsis(self.path_in_public, width)
  "+ #{('%-' + width.to_s + 's') % path} #{'%10s' % link_count} links / #{'%10s' % filesize}"
end

#url ⇒ Object

Full URL of the file.



99
100
101
 
# File 'lib/sitemap_generator/sitemap_location.rb', line 99

def url
  URI.join(host, sitemaps_path.to_s, filename.to_s).to_s
end

#verbose? ⇒ Boolean

Returns:

  • (Boolean) 


150
151
152
 
# File 'lib/sitemap_generator/sitemap_location.rb', line 150

def verbose?
  self[:verbose]
end

#with(opts = {}) ⇒ Object

Return a new Location instance with the given options merged in



79
80
81
 
# File 'lib/sitemap_generator/sitemap_location.rb', line 79

def with(opts = {})
  self.merge(opts)
end

#write(data, link_count) ⇒ Object

Write ‘data` out to a file. Output a summary line if verbose is true.



169
170
171
172
 
# File 'lib/sitemap_generator/sitemap_location.rb', line 169

def write(data, link_count)
  adapter.write(self, data)
  puts summary(link_count) if verbose?
end