Module: SitemapGenerator
- Defined in:
- lib/sitemap_generator/link_set.rb,
lib/sitemap_generator.rb,
lib/sitemap_generator/railtie.rb,
lib/sitemap_generator/templates.rb,
lib/sitemap_generator/utilities.rb,
lib/sitemap_generator/application.rb,
lib/sitemap_generator/interpreter.rb,
lib/sitemap_generator/sitemap_namer.rb,
lib/sitemap_generator/sitemap_location.rb,
lib/sitemap_generator/adapters/s3_adapter.rb,
lib/sitemap_generator/builder/sitemap_url.rb,
lib/sitemap_generator/builder/sitemap_file.rb,
lib/sitemap_generator/adapters/file_adapter.rb,
lib/sitemap_generator/adapters/wave_adapter.rb,
lib/sitemap_generator/helpers/number_helper.rb,
lib/sitemap_generator/builder/sitemap_index_url.rb,
lib/sitemap_generator/builder/sitemap_index_file.rb
Overview
A LinkSet provisions a bunch of links to sitemap files. It also writes the index file which lists all the sitemap files written.
Defined Under Namespace
Modules: Builder, Helpers, Utilities Classes: Application, BigDecimal, FileAdapter, Interpreter, LinkSet, Numeric, Railtie, S3Adapter, SimpleNamer, SitemapIndexLocation, SitemapIndexNamer, SitemapLocation, SitemapNamer, Templates, WaveAdapter
Constant Summary collapse
- SitemapError =
Class.new(StandardError)
- SitemapFullError =
Class.new(SitemapError)
- SitemapFinalizedError =
Class.new(SitemapError)
Class Attribute Summary collapse
-
.app ⇒ Object
Returns the value of attribute app.
-
.root ⇒ Object
Returns the value of attribute root.
-
.templates ⇒ Object
Returns the value of attribute templates.
-
.verbose ⇒ Object
Global default for the verbose setting.
-
.yield_sitemap ⇒ Object
writeonly
Sets the attribute yield_sitemap.
Class Method Summary collapse
-
.yield_sitemap? ⇒ Boolean
Returns true if we should yield the sitemap instance to the block, false otherwise.
Class Attribute Details
.app ⇒ Object
Returns the value of attribute app.
52 53 54 |
# File 'lib/sitemap_generator.rb', line 52 def app @app end |
.root ⇒ Object
Returns the value of attribute root.
52 53 54 |
# File 'lib/sitemap_generator.rb', line 52 def root @root end |
.templates ⇒ Object
Returns the value of attribute templates.
52 53 54 |
# File 'lib/sitemap_generator.rb', line 52 def templates @templates end |
.verbose ⇒ Object
Global default for the verbose setting.
57 58 59 60 61 62 63 64 65 66 67 68 69 |
# File 'lib/sitemap_generator.rb', line 57 def self.verbose if @verbose.nil? @verbose = if SitemapGenerator::Utilities.truthy?(ENV['VERBOSE']) true elsif SitemapGenerator::Utilities.falsy?(ENV['VERBOSE']) false else nil end else @verbose end end |
.yield_sitemap=(value) ⇒ Object (writeonly)
Sets the attribute yield_sitemap
53 54 55 |
# File 'lib/sitemap_generator.rb', line 53 def yield_sitemap=(value) @yield_sitemap = value end |
Class Method Details
.yield_sitemap? ⇒ Boolean
Returns true if we should yield the sitemap instance to the block, false otherwise.
72 73 74 |
# File 'lib/sitemap_generator.rb', line 72 def self.yield_sitemap? !!@yield_sitemap end |