Class: Middleman::Sitemap::Resource

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

Overview

Sitemap Resource class

Constant Summary

METADATA_HASH =
({ options: Maybe[Hash], locals: Maybe[Hash], page: Maybe[Hash] })

Constants included from Contracts

Contracts::PATH_MATCHER, Contracts::ResourceList

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Extensions::Traversal

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

Methods included from Contracts

#Contract

Constructor Details

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



46
47
48
49
50
51
52
53
54
55
56
57
58
# File 'middleman-core/lib/middleman-core/sitemap/resource.rb', line 46

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

  # 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: {} }
end

Instance Attribute Details

#destination_pathString Also known as: request_path

The output path in the build directory for this resource



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

def destination_path
  @destination_path
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)



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

def path
  @path
end

#source_fileObject (readonly)

Returns the value of attribute source_file



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

def source_file
  @source_file
end

Instance Method Details

#add_metadata(meta = {}) ⇒ Object



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

def (meta={})
  @metadata.deep_merge!(meta)
end

#binary?Boolean



148
149
150
# File 'middleman-core/lib/middleman-core/sitemap/resource.rb', line 148

def binary?
  !source_file.nil? && ::Middleman::Util.binary?(source_file[:full_path].to_s)
end

#content_typeObject



178
179
180
# File 'middleman-core/lib/middleman-core/sitemap/resource.rb', line 178

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

#dataObject



82
83
84
85
# File 'middleman-core/lib/middleman-core/sitemap/resource.rb', line 82

def data
  # TODO: Should this really be a HashWithIndifferentAccess?
  ::Middleman::Util.recursively_enhance([:page])
end

#extObject



105
106
107
# File 'middleman-core/lib/middleman-core/sitemap/resource.rb', line 105

def ext
  File.extname(path)
end

#HashString

Render this resource



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

Contract Hash, Hash => String

#ignore!Object



156
157
158
# File 'middleman-core/lib/middleman-core/sitemap/resource.rb', line 156

def ignore!
  @ignored = true
end

#ignored?Boolean



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

def ignored?
  return true if @ignored
  # Ignore based on the source path (without template extensions)
  return true if @app.sitemap.ignored?(path)
  # This allows files to be ignored by their source file name (with template extensions)
  if !self.is_a?(ProxyResource) && source_file && @app.sitemap.ignored?(source_file[:relative_path].to_s)
    true
  else
    false
  end
end

#localsObject



98
99
100
# File 'middleman-core/lib/middleman-core/sitemap/resource.rb', line 98

def locals
  [:locals]
end

#optionsObject



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

def options
  [:options]
end

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



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
# File 'middleman-core/lib/middleman-core/sitemap/resource.rb', line 112

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

  ::Middleman::Util.instrument 'render.resource', path: source_file[:full_path].to_s, destination_path: destination_path do
    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
    unless opts.key?(:layout)
      opts[:layout] = false if %w(.js .json .css .txt).include?(ext)
    end

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

#template?Boolean



63
64
65
66
# File 'middleman-core/lib/middleman-core/sitemap/resource.rb', line 63

def template?
  return false if source_file.nil?
  !::Tilt[source_file[:full_path].to_s].nil?
end

#to_sObject Also known as: inspect



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

def to_s
  "#<Middleman::Sitemap::Resource path=#{@path}>"
end

#urlObject



135
136
137
138
139
140
141
142
# File 'middleman-core/lib/middleman-core/sitemap/resource.rb', line 135

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