Class: Middleman::Sitemap::Resource
- Inherits:
-
Object
- Object
- Middleman::Sitemap::Resource
- Includes:
- Extensions::ContentType, Extensions::Traversal
- Defined in:
- lib/middleman-core/sitemap/resource.rb
Overview
Sitemap Resource class
Direct Known Subclasses
Extensions::Redirects::RedirectResource, Extensions::RequestEndpoints::EndpointResource
Instance Attribute Summary collapse
- #app ⇒ Middleman::Application readonly
-
#destination_path ⇒ String
The output/preview URL for this resource.
-
#path ⇒ String
readonly
The source path of this resource (relative to the source directory, without template extensions).
- #store ⇒ Middleman::Sitemap::Store readonly
Instance Method Summary collapse
-
#add_metadata(metadata = {}, &block) ⇒ Object
Merge in new metadata specific to this resource.
-
#binary? ⇒ Boolean
Whether the source file is binary.
-
#ext ⇒ String
Extension of the path (i.e. ‘.js’).
-
#initialize(store, path, source_file = nil) ⇒ Resource
constructor
Initialize resource with parent store and URL.
-
#metadata ⇒ Hash
Get the metadata for both the current source_file and the current path.
-
#render(opts = {}, locs = {}, &block) ⇒ String
Render this resource.
- #request_path ⇒ Object
-
#source_file ⇒ String
Set the on-disk source file for this resource attr_reader :source_file.
-
#template? ⇒ Boolean
Whether this resource has a template file.
-
#url ⇒ String
A path without the directory index - so foo/index.html becomes just foo.
Methods included from Extensions::ContentType
Methods included from Extensions::Traversal
#children, #directory_index?, #eponymous_directory?, #eponymous_directory_path, #parent, #siblings
Constructor Details
#initialize(store, path, source_file = nil) ⇒ Resource
Initialize resource with parent store and URL
42 43 44 45 46 47 48 49 50 |
# File 'lib/middleman-core/sitemap/resource.rb', line 42 def initialize(store, path, source_file=nil) @store = store @app = @store.app @path = path.gsub(' ', '%20') # handle spaces in filenames @source_file = source_file @destination_path = @path @local_metadata = { :options => {}, :locals => {}, :page => {}, :blocks => [] } end |
Instance Attribute Details
#app ⇒ Middleman::Application (readonly)
15 16 17 |
# File 'lib/middleman-core/sitemap/resource.rb', line 15 def app @app end |
#destination_path ⇒ String
The output/preview URL for this resource
28 29 30 |
# File 'lib/middleman-core/sitemap/resource.rb', line 28 def destination_path @destination_path end |
#path ⇒ String (readonly)
The source path of this resource (relative to the source directory, without template extensions)
24 25 26 |
# File 'lib/middleman-core/sitemap/resource.rb', line 24 def path @path end |
#store ⇒ Middleman::Sitemap::Store (readonly)
19 20 21 |
# File 'lib/middleman-core/sitemap/resource.rb', line 19 def store @store end |
Instance Method Details
#add_metadata(metadata = {}, &block) ⇒ Object
Merge in new metadata specific to this resource.
82 83 84 85 86 87 88 89 |
# File 'lib/middleman-core/sitemap/resource.rb', line 82 def (={}, &block) = .dup if .has_key?(:blocks) @local_metadata[:blocks] += .delete(:blocks) end @local_metadata.deep_merge!() @local_metadata[:blocks] += [ block ] if block_given? end |
#binary? ⇒ Boolean
Whether the source file is binary.
162 163 164 |
# File 'lib/middleman-core/sitemap/resource.rb', line 162 def binary? ::Middleman::Util.binary?(source_file) end |
#ext ⇒ String
Extension of the path (i.e. ‘.js’)
97 98 99 |
# File 'lib/middleman-core/sitemap/resource.rb', line 97 def ext File.extname(path) end |
#metadata ⇒ Hash
Get the metadata for both the current source_file and the current path
61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 |
# File 'lib/middleman-core/sitemap/resource.rb', line 61 def result = store.(path).dup = store.(source_file).dup if .has_key?(:blocks) result[:blocks] += .delete(:blocks) end result.deep_merge!() = @local_metadata.dup if .has_key?(:blocks) result[:blocks] += .delete(:blocks) end result.deep_merge!() result[:blocks] = result[:blocks].flatten.compact result end |
#render(opts = {}, locs = {}, &block) ⇒ String
Render this resource
107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 |
# File 'lib/middleman-core/sitemap/resource.rb', line 107 def render(opts={}, locs={}, &block) if !template? return app.template_data_for_file(source_file) end relative_source = Pathname(source_file).relative_path_from(Pathname(app.root)) instrument 'render.resource', :path => relative_source, :destination_path => destination_path do md = .dup opts = md[:options].deep_merge(opts) # Pass "renderer_options" hash from frontmatter along to renderer if md[:page]['renderer_options'] opts[:renderer_options] = {} md[:page]['renderer_options'].each do |k, v| opts[:renderer_options][k.to_sym] = v end end locs = md[:locals].deep_merge(locs) # Forward remaining data to helpers if md.has_key?(:page) app.data.store('page', md[:page]) end blocks = Array(md[:blocks]).dup blocks << block if block_given? app.current_path ||= self.destination_path # Certain output file types don't use layouts if !opts.has_key?(:layout) opts[:layout] = false if %w(.js .json .css .txt).include?(self.ext) end app.render_template(source_file, locs, opts, blocks) end end |
#request_path ⇒ Object
101 102 103 |
# File 'lib/middleman-core/sitemap/resource.rb', line 101 def request_path self.destination_path end |
#source_file ⇒ String
Set the on-disk source file for this resource attr_reader :source_file
34 35 36 |
# File 'lib/middleman-core/sitemap/resource.rb', line 34 def source_file @source_file || get_source_file end |
#template? ⇒ Boolean
Whether this resource has a template file
54 55 56 57 |
# File 'lib/middleman-core/sitemap/resource.rb', line 54 def template? return false if source_file.nil? !::Tilt[source_file].nil? end |
#url ⇒ String
A path without the directory index - so foo/index.html becomes just foo. Best for linking.
150 151 152 153 154 155 156 157 |
# File 'lib/middleman-core/sitemap/resource.rb', line 150 def url url_path = destination_path if app.strip_index_file url_path = url_path.sub(/(^|\/)#{Regexp.escape(app.index_file)}$/, app.trailing_slash ? '/' : '') end File.join(app.respond_to?(:http_prefix) ? app.http_prefix : '/', url_path) end |