Class: Middleman::Sitemap::Resource

Inherits:
Object
  • Object
show all
Includes:
Contracts, Extensions::Traversal
Defined in:
middleman-core/lib/middleman-core/sitemap/resource.rb,
middleman-core/lib/middleman-core/sitemap/extensions/proxies.rb

Overview

Sitemap Resource class

Constant Summary collapse

METADATA_HASH =
{ options: Maybe[Hash], locals: Maybe[Hash], page: Maybe[Hash] }.freeze

Constants included from Contracts

Contracts::PATH_MATCHER, Contracts::ResourceList, Contracts::VectorOf

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Extensions::Traversal

#children, #directory_index?, #eponymous_directory?, #eponymous_directory_path, #parent, #parent_helper, #siblings, #traversal_root

Methods included from Contracts

#Contract

Constructor Details

#initialize(store, path, source = nil) ⇒ Resource

Returns a new instance of Resource



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
# File 'middleman-core/lib/middleman-core/sitemap/resource.rb', line 48

def initialize(store, path, source = nil)
  @store       = store
  @app         = @store.app
  @path        = path
  @ignored     = false

  source = Pathname(source) if source&.is_a?(String)

  @file_descriptor = if source&.is_a?(Pathname)
                       ::Middleman::SourceFile.new(source.relative_path_from(@app.source_dir), source, @app.source_dir, Set.new([:source]), 0)
                     else
                       source
                     end

  @destination_path = @path

  # Options are generally rendering/sitemap options
  # Locals are local variables for rendering this resource's template
  # Page are data that is exposed through this resource's data member.
  # Note: It is named 'page' for backwards compatibility with older MM.
  @metadata = { options: {}, locals: {}, page: {} }

  @page_data = nil
end

Instance Attribute Details

#destination_pathString Also known as: request_path

The output path in the build directory for this resource

Returns:



22
23
24
# File 'middleman-core/lib/middleman-core/sitemap/resource.rb', line 22

def destination_path
  @destination_path
end

#file_descriptorObject (readonly)

Returns the value of attribute file_descriptor



27
28
29
# File 'middleman-core/lib/middleman-core/sitemap/resource.rb', line 27

def file_descriptor
  @file_descriptor
end

#ignoredObject

Returns the value of attribute ignored



41
42
43
# File 'middleman-core/lib/middleman-core/sitemap/resource.rb', line 41

def ignored
  @ignored
end

#metadataObject (readonly)

Returns the value of attribute metadata



39
40
41
# File 'middleman-core/lib/middleman-core/sitemap/resource.rb', line 39

def 
  @metadata
end

#pathString (readonly)

The source path of this resource (relative to the source directory, without template extensions)

Returns:



18
19
20
# File 'middleman-core/lib/middleman-core/sitemap/resource.rb', line 18

def path
  @path
end

Instance Method Details

#add_metadata(meta = {}, reverse = false) ⇒ Object



101
102
103
104
105
106
107
108
109
# File 'middleman-core/lib/middleman-core/sitemap/resource.rb', line 101

def (meta = {}, reverse = false)
  @page_data = nil

  @metadata = if reverse
                meta.deep_merge(@metadata)
              else
                @metadata.deep_merge(meta)
              end
end

#Any

This method returns an undefined value.

Ignore a resource directly, without going through the whole ignore filter stuff.



182
# File 'middleman-core/lib/middleman-core/sitemap/resource.rb', line 182

Contract Any

#binary?Boolean

Returns:

  • (Boolean)


175
176
177
# File 'middleman-core/lib/middleman-core/sitemap/resource.rb', line 175

def binary?
  !file_descriptor.nil? && (file_descriptor[:types].include?(:binary) || ::Middleman::Util.binary?(file_descriptor[:full_path].to_s))
end

#BoolBoolean

Whether the Resource is ignored

Returns:

  • (Boolean)


75
# File 'middleman-core/lib/middleman-core/sitemap/resource.rb', line 75

Contract Bool

#content_typeObject



197
198
199
# File 'middleman-core/lib/middleman-core/sitemap/resource.rb', line 197

def content_type
  options[:content_type] || ::Rack::Mime.mime_type(ext, nil)
end

#dataObject



114
115
116
# File 'middleman-core/lib/middleman-core/sitemap/resource.rb', line 114

def data
  @page_data ||= ::Middleman::Util.recursively_enhance([:page])
end

#extObject



136
137
138
# File 'middleman-core/lib/middleman-core/sitemap/resource.rb', line 136

def ext
  File.extname(path)
end

#HashString

Render this resource

Returns:



121
# File 'middleman-core/lib/middleman-core/sitemap/resource.rb', line 121

Contract Hash

#ignore!Object



183
184
185
# File 'middleman-core/lib/middleman-core/sitemap/resource.rb', line 183

def ignore!
  @ignored = true
end

#ignored?Boolean

Returns:

  • (Boolean)


190
191
192
# File 'middleman-core/lib/middleman-core/sitemap/resource.rb', line 190

def ignored?
  @ignored
end

#indifferent_access?Hash

Data about this resource, populated from frontmatter or extensions.

Returns:



113
# File 'middleman-core/lib/middleman-core/sitemap/resource.rb', line 113

Contract RespondTo[:indifferent_access?]

#localsObject



129
130
131
# File 'middleman-core/lib/middleman-core/sitemap/resource.rb', line 129

def locals
  [:locals]
end

#METADATA_HASHHash

The metadata for this resource

Returns:



38
# File 'middleman-core/lib/middleman-core/sitemap/resource.rb', line 38

Contract METADATA_HASH

#normalized_pathString

The normalized source path of this resource (relative to the source directory, without template extensions)

Returns:



204
205
206
# File 'middleman-core/lib/middleman-core/sitemap/resource.rb', line 204

def normalized_path
  @normalized_path ||= ::Middleman::Util.normalize_path @path
end

#optionsObject



122
123
124
# File 'middleman-core/lib/middleman-core/sitemap/resource.rb', line 122

def options
  [:options]
end

#page_idObject



90
91
92
# File 'middleman-core/lib/middleman-core/sitemap/resource.rb', line 90

def page_id
  [:page][:id] || make_implicit_page_id(destination_path)
end

#proxy_to(_path) ⇒ Object



60
61
62
# File 'middleman-core/lib/middleman-core/sitemap/extensions/proxies.rb', line 60

def proxy_to(_path)
  throw 'Resource#proxy_to has been removed. Use ProxyResource class instead.'
end

#render(opts = {}, locs = {}) ⇒ Object



143
144
145
146
147
148
149
150
151
152
153
154
155
156
# File 'middleman-core/lib/middleman-core/sitemap/resource.rb', line 143

def render(opts = {}, locs = {})
  return ::Middleman::FileRenderer.new(@app, file_descriptor[:full_path].to_s).template_data_for_file unless template?

  md   = 
  opts = md[:options].deep_merge(opts)
  locs = md[:locals].deep_merge(locs)
  locs[:current_path] ||= destination_path

  # Certain output file types don't use layouts
  opts[:layout] = false if !opts.key?(:layout) && !@app.config.extensions_with_layout.include?(ext)

  renderer = ::Middleman::TemplateRenderer.new(@app, file_descriptor[:full_path].to_s)
  renderer.render(locs, opts)
end

#source_fileObject



85
86
87
# File 'middleman-core/lib/middleman-core/sitemap/resource.rb', line 85

def source_file
  file_descriptor && file_descriptor[:full_path].to_s
end

#StringString

A path without the directory index - so foo/index.html becomes just foo. Best for linking.

Returns:



135
# File 'middleman-core/lib/middleman-core/sitemap/resource.rb', line 135

Contract String

#template?Boolean

Returns:

  • (Boolean)


76
77
78
79
80
# File 'middleman-core/lib/middleman-core/sitemap/resource.rb', line 76

def template?
  return false if file_descriptor.nil?

  !::Middleman::Util.tilt_class(file_descriptor[:full_path].to_s).nil?
end

#to_sObject Also known as: inspect



208
209
210
# File 'middleman-core/lib/middleman-core/sitemap/resource.rb', line 208

def to_s
  "#<#{self.class} path=#{@path}>"
end

#urlObject



162
163
164
165
166
167
168
169
# File 'middleman-core/lib/middleman-core/sitemap/resource.rb', line 162

def url
  url_path = destination_path
  if @app.config[:strip_index_file]
    url_path = url_path.sub(/(^|\/)#{Regexp.escape(@app.config[:index_file])}$/,
                            @app.config[:trailing_slash] ? '/' : '')
  end
  File.join(@app.config[:http_prefix], url_path)
end