Class: Middleman::Sitemap::Resource

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

Overview

Sitemap Resource class

Instance Attribute Summary (collapse)

Instance Method Summary (collapse)

Methods included from Extensions::Traversal

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

Constructor Details

- (Resource) initialize(store, path, source_file = nil)

Initialize resource with parent store and URL

Parameters:



35
36
37
38
39
40
41
42
43
44
 
# File 'middleman-core/lib/middleman-core/sitemap/resource.rb', line 35

def initialize(store, path, source_file=nil)
  @store       = store
  @app         = @store.app
  @path        = path
  @source_file = source_file

  @destination_paths = [@path]

  @local_metadata = { :options => {}, :locals => {}, :page => {}, :blocks => [] }
end

Instance Attribute Details

- (Middleman::Application) app (readonly)

Returns:



13
14
15
 
# File 'middleman-core/lib/middleman-core/sitemap/resource.rb', line 13

def app
  @app
end

- (String) path (readonly)

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

Returns:

  • (String) 


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

def path
  @path
end

- (Middleman::Sitemap::Store) store (readonly)

Returns:



16
17
18
 
# File 'middleman-core/lib/middleman-core/sitemap/resource.rb', line 16

def store
  @store
end

Instance Method Details

- (Object) add_metadata(metadata = {}, &block)

Merge in new metadata specific to this resource.

Parameters:

  • metadata (Hash) (defaults to: {}) —

    A metadata block like provides_metadata_for_path takes



77
78
79
80
81
82
83
84
 
# File 'middleman-core/lib/middleman-core/sitemap/resource.rb', line 77

def add_metadata(metadata={}, &block)
  if metadata.has_key?(:blocks)
    @local_metadata[:blocks] << metadata[:blocks]
    metadata.delete(:blocks)
  end
  @local_metadata.deep_merge!(metadata)
  @local_metadata[:blocks] << block if block_given?
end

- (String) destination_path

Get the output/preview URL for this resource

Returns:

  • (String) 


88
89
90
 
# File 'middleman-core/lib/middleman-core/sitemap/resource.rb', line 88

def destination_path
  @destination_paths.last
end

- (void) destination_path=(path)

This method returns an undefined value.

Set the output/preview URL for this resource

Parameters:

  • path (String) 


95
96
97
 
# File 'middleman-core/lib/middleman-core/sitemap/resource.rb', line 95

def destination_path=(path)
  @destination_paths << path
end

- (String) ext

Extension of the path (i.e. '.js')

Returns:

  • (String) 


101
102
103
 
# File 'middleman-core/lib/middleman-core/sitemap/resource.rb', line 101

def ext
  File.extname(path)
end

- (Hash) metadata

Get the metadata for both the current source_file and the current path

Returns:

  • (Hash) 


55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'middleman-core/lib/middleman-core/sitemap/resource.rb', line 55

def metadata
  result = store.metadata_for_file(source_file).dup

  path_meta = store.metadata_for_path(path).dup
  if path_meta.has_key?(:blocks)
    result[:blocks] << path_meta[:blocks]
    path_meta.delete(:blocks)
  end
  result.deep_merge!(path_meta)

  local_meta = @local_metadata.dup
  if local_meta.has_key?(:blocks)
    result[:blocks] << local_meta[:blocks]
    local_meta.delete(:blocks)
  end
  result.deep_merge!(local_meta)

  result
end

- (String) mime_type

Mime type of the path

Returns:

  • (String) 


107
108
109
 
# File 'middleman-core/lib/middleman-core/sitemap/resource.rb', line 107

def mime_type
  app.mime_type ext
end

- (String) render(opts = {}, locs = {}, &block)

Render this resource

Returns:

  • (String) 


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
 
# File 'middleman-core/lib/middleman-core/sitemap/resource.rb', line 113

def render(opts={}, locs={}, &block)
  return File.open(source_file).read unless template?

  start_time = Time.now
  puts "== Render Start: #{source_file}" if app.logging?

  md   = metadata.dup
  opts = md[:options].deep_merge(opts)
  locs = md[:locals].deep_merge(locs)

  # Forward remaining data to helpers
  if md.has_key?(:page)
    app.data.store("page", md[:page])
  end

  md[:blocks].flatten.compact.each do |block|
    app.instance_eval(&block)
  end

  app.instance_eval(&block) if block_given?
  result = app.render_template(source_file, locs, opts)

  puts "== Render End: #{source_file} (#{(Time.now - start_time).round(2)}s)" if app.logging?
  result
end

- (String) source_file

Set the on-disk source file for this resource attr_reader :source_file

Returns:

  • (String) 


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

def source_file
  @source_file || get_source_file
end

- (Boolean) template?

Whether this resource has a template file

Returns:

  • (Boolean) 


48
49
50
51
 
# File 'middleman-core/lib/middleman-core/sitemap/resource.rb', line 48

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

- (String) url

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

Returns:

  • (String) 


142
143
144
 
# File 'middleman-core/lib/middleman-core/sitemap/resource.rb', line 142

def url
  '/' + destination_path.sub(/#{Regexp.escape(app.index_file)}$/, '')
end