Class: Middleman::Sitemap::Store

Inherits:
Object
  • Object
show all
Defined in:
middleman-core/lib/middleman-core/sitemap/store.rb

Overview

The Store class

The Store manages a collection of Resource objects, which represent individual items in the sitemap. Resources are indexed by "source path", which is the path relative to the source directory, minus any template extensions. All "path" parameters used in this class are source paths.

Instance Attribute Summary (collapse)

Instance Method Summary (collapse)

Constructor Details

- (Store) initialize(app)

Initialize with parent app

Parameters:



22
23
24
25
26
27
28
29
30
31
32
33
34
 
# File 'middleman-core/lib/middleman-core/sitemap/store.rb', line 22

def initialize(app)
  @app   = app
  @resources = []
  @_cached_metadata = {}
  @_lookup_cache = { :path => {}, :destination_path => {} }
  @resource_list_manipulators = []

  # Register classes which can manipulate the main site map list
  register_resource_list_manipulator(:on_disk, Middleman::Sitemap::Extensions::OnDisk.new(self),  false)

  # Proxies
  register_resource_list_manipulator(:proxies, @app.proxy_manager, false)
end

Instance Attribute Details

- (Middleman::Application) app

Returns:



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

def app
  @app
end

Instance Method Details

- (String) extensionless_path(file)

Get a path without templating extensions

Parameters:

  • file (String)

Returns:

  • (String) 


183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'middleman-core/lib/middleman-core/sitemap/store.rb', line 183

def extensionless_path(file)
  path = file.dup

  end_of_the_line = false
  while !end_of_the_line
    if !::Tilt[path].nil?
      path = path.sub(File.extname(path), "")
    else
      end_of_the_line = true
    end
  end

  # If there is no extension, look for one
  if File.extname(path).empty?
    input_ext = File.extname(file)

    if !input_ext.empty?
      input_ext = input_ext.split(".").last.to_sym
      if @app.template_extensions.has_key?(input_ext)
        path << ".#{@app.template_extensions[input_ext]}"
      end
    end
  end

  path
end

- (String) file_to_path(file)

Get the URL path for an on-disk file

Parameters:

  • file (String)

Returns:

  • (String) 


170
171
172
173
174
175
176
177
178
 
# File 'middleman-core/lib/middleman-core/sitemap/store.rb', line 170

def file_to_path(file)
  file = File.expand_path(file, @app.root)
  
  prefix = @app.source_dir.sub(/\/$/, "") + "/"
  return false unless file.include?(prefix)
  
  path = file.sub(prefix, "")
  extensionless_path(path)
end

- (Middleman::Sitemap::Resource) find_resource_by_destination_path(request_path)

Find a resource given its destination path

Parameters:

  • request_path (String) —

    The destination (output) path of a resource.

Returns:



72
73
74
75
 
# File 'middleman-core/lib/middleman-core/sitemap/store.rb', line 72

def find_resource_by_destination_path(request_path)
  request_path = ::Middleman::Util.normalize_path(request_path)
  @_lookup_cache[:destination_path][request_path]
end

- (Middleman::Sitemap::Resource) find_resource_by_path(request_path)

Find a resource given its original path

Parameters:

  • request_path (String) —

    The original path of a resource.

Returns:



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

def find_resource_by_path(request_path)
  request_path = ::Middleman::Util.normalize_path(request_path)
  @_lookup_cache[:path][request_path]
end

- (Hash) metadata_for_file(source_file)

Get the metadata for a specific file

Parameters:

  • source_file (String)

Returns:

  • (Hash) 


100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'middleman-core/lib/middleman-core/sitemap/store.rb', line 100

def metadata_for_file(source_file)
  blank_metadata = { :options => {}, :locals => {}, :page => {}, :blocks => [] }

  provides_metadata.inject(blank_metadata) do |result, (callback, matcher)|
    next result if !matcher.nil? && !source_file.match(matcher)
  
    metadata = callback.call(source_file)

    if metadata.has_key?(:blocks)
      result[:blocks] << metadata[:blocks]
      metadata.delete(:blocks)
    end

    result.deep_merge(metadata)
  end
end

- (Hash) metadata_for_path(request_path)

Get the metadata for a specific URL

Parameters:

  • request_path (String)

Returns:

  • (Hash) 


143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'middleman-core/lib/middleman-core/sitemap/store.rb', line 143

def metadata_for_path(request_path)
  return @_cached_metadata[request_path] if @_cached_metadata[request_path]

  blank_metadata = { :options => {}, :locals => {}, :page => {}, :blocks => [] }

  @_cached_metadata[request_path] = provides_metadata_for_path.inject(blank_metadata) do |result, (callback, matcher)|
    case matcher
    when Regexp
      next result unless request_path.match(matcher)
    when String
      next result unless File.fnmatch("/" + matcher.sub(%r{^/}, ''), "/#{request_path}")
    end
  
    metadata = callback.call(request_path)
  
    if metadata.has_key?(:blocks)
      result[:blocks] << metadata[:blocks]
      metadata.delete(:blocks)
    end

    result.deep_merge(metadata)
  end
end

- (Array<Array<Proc, Regexp>>) provides_metadata(matcher = nil, &block)

Register a handler to provide metadata on a file path

Parameters:

  • matcher (Regexp) (defaults to: nil)

Returns:

  • (Array<Array<Proc, Regexp>>) 


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

def provides_metadata(matcher=nil, &block)
  @_provides_metadata ||= []
  @_provides_metadata << [block, matcher] if block_given?
  @_provides_metadata
end

- (Array<Array<Proc, Regexp>>) provides_metadata_for_path(matcher = nil, origin = nil, &block)

Register a handler to provide metadata on a url path

Parameters:

  • matcher (Regexp) (defaults to: nil)
  • origin (Symbol) (defaults to: nil) —

    an indicator of where this metadata came from - only one block per [matcher, origin] pair may exist.

Returns:

  • (Array<Array<Proc, Regexp>>) 


122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'middleman-core/lib/middleman-core/sitemap/store.rb', line 122

def provides_metadata_for_path(matcher=nil, origin=nil, &block)
  @_provides_metadata_for_path ||= []
  if block_given?
    if origin
      existing_provider = @_provides_metadata_for_path.find {|b,m,o| o == origin && m == matcher}
    end

    if existing_provider
      existing_provider[0] = block
    else
      @_provides_metadata_for_path << [block, matcher, origin]
    end

    @_cached_metadata = {}
  end
  @_provides_metadata_for_path
end

- (void) rebuild_resource_list!(reason = nil)

This method returns an undefined value.

Rebuild the list of resources from scratch, using registed manipulators



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

def rebuild_resource_list!(reason=nil)
  @resources = @resource_list_manipulators.inject([]) do |result, (_, inst)|
    inst.manipulate_resource_list(result)
  end

  # Reset lookup cache
  @_lookup_cache = { :path => {}, :destination_path => {} }
  @resources.each do |resource|
    @_lookup_cache[:path][resource.path] = resource
    @_lookup_cache[:destination_path][resource.destination_path] = resource
  end
end

- (void) register_resource_list_manipulator(name, inst, immediately_rebuild = true)

This method returns an undefined value.

Register a klass which can manipulate the main site map list

Parameters:

  • name (Symbol) —

    Name of the manipulator for debugging

  • inst (Class, Module) —

    Abstract namespace which can update the resource list

  • immediately_rebuild (Boolean) (defaults to: true) —

    Whether the resource list should be immediately recalculated



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

def register_resource_list_manipulator(name, inst, immediately_rebuild=true)
  @resource_list_manipulators << [name, inst]
  rebuild_resource_list!(:registered_new) if immediately_rebuild
end

- (Array<Middleman::Sitemap::Resource>) resources(include_ignored = false)

Get the array of all resources

Parameters:

  • include_ignored (Boolean) (defaults to: false) —

    Whether to include ignored resources

Returns:



80
81
82
83
84
85
86
 
# File 'middleman-core/lib/middleman-core/sitemap/store.rb', line 80

def resources(include_ignored=false)
  if include_ignored
    @resources
  else
    @resources.reject(&:ignored?)
  end
end