Class: Middleman::Sitemap::Store

Inherits:
Object
  • Object
show all
Includes:
Contracts
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.

Constant Summary

Constant Summary

Constants included from Contracts

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Contracts

#Contract

Constructor Details

#initialize(app) ⇒ Store



61
62
63
64
65
66
67
68
69
70
71
72
73
# File 'middleman-core/lib/middleman-core/sitemap/store.rb', line 61

def initialize(app)
  @app = app
  @resources = []
  @update_count = 0

  @resource_list_manipulators = ::Hamster.vector
  @needs_sitemap_rebuild = true

  @lock = Monitor.new
  reset_lookup_cache!

  @app.config_context.class.send :def_delegator, :app, :sitemap
end

Instance Attribute Details

#appObject (readonly)

Returns the value of attribute app



53
54
55
# File 'middleman-core/lib/middleman-core/sitemap/store.rb', line 53

def app
  @app
end

#update_countObject (readonly)

Returns the value of attribute update_count



56
57
58
# File 'middleman-core/lib/middleman-core/sitemap/store.rb', line 56

def update_count
  @update_count
end

Instance Method Details

#ensure_resource_list_updated!Object

Actually update the resource list, assuming anything has called rebuild_resource_list! since the last time it was run. This is very expensive!



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 ensure_resource_list_updated!
  @lock.synchronize do
    return unless @needs_sitemap_rebuild
    @needs_sitemap_rebuild = false

    @app.logger.debug '== Rebuilding resource list'

    @resources = @resource_list_manipulators.reduce([]) do |result, m|
      newres = m[:manipulator].send(m[:custom_name] || :manipulate_resource_list, result)

      # Reset lookup cache
      reset_lookup_cache!

      # Rebuild cache
      newres.each do |resource|
        @_lookup_by_path[resource.path] = resource
        @_lookup_by_destination_path[resource.destination_path] = resource
      end

      newres
    end

    invalidate_resources_not_ignored_cache!
    @update_count += 1
  end
end

#extensionless_path(file) ⇒ Object



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

def extensionless_path(file)
  path = file.dup
  remove_templating_extensions(path)
end

#file_to_path(file) ⇒ Object



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

def file_to_path(file)
  relative_path = file.is_a?(Pathname) ? file.to_s : file[:relative_path].to_s

  # Replace a file name containing automatic_directory_matcher with a folder
  unless @app.config[:automatic_directory_matcher].nil?
    relative_path = relative_path.gsub(@app.config[:automatic_directory_matcher], '/')
  end

  extensionless_path(relative_path)
end

#find_resource_by_destination_path(request_path) ⇒ Object



127
128
129
130
131
132
133
# File 'middleman-core/lib/middleman-core/sitemap/store.rb', line 127

def find_resource_by_destination_path(request_path)
  @lock.synchronize do
    request_path = ::Middleman::Util.normalize_path(request_path)
    ensure_resource_list_updated!
    @_lookup_by_destination_path[request_path]
  end
end

#find_resource_by_path(request_path) ⇒ Object



115
116
117
118
119
120
121
# File 'middleman-core/lib/middleman-core/sitemap/store.rb', line 115

def find_resource_by_path(request_path)
  @lock.synchronize do
    request_path = ::Middleman::Util.normalize_path(request_path)
    ensure_resource_list_updated!
    @_lookup_by_path[request_path]
  end
end

#invalidate_resources_not_ignored_cache!Object

Invalidate our cached view of resource that are not ingnored. If your extension adds ways to ignore files, you should call this to make sure #resources works right.



152
153
154
# File 'middleman-core/lib/middleman-core/sitemap/store.rb', line 152

def invalidate_resources_not_ignored_cache!
  @resources_not_ignored = nil
end

#rebuild_resource_list!(_name = nil) ⇒ Object



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

def rebuild_resource_list!(_name=nil)
  @lock.synchronize do
    @needs_sitemap_rebuild = true
  end
end

#register_resource_list_manipulator(name, manipulator, priority = 50, custom_name = nil) ⇒ Object



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
# File 'middleman-core/lib/middleman-core/sitemap/store.rb', line 84

def register_resource_list_manipulator(name, manipulator, priority=50, custom_name=nil)
  # The third argument used to be a boolean - handle those who still pass one
  priority = 50 unless priority.is_a? Numeric
  @resource_list_manipulators = @resource_list_manipulators.push(
    ManipulatorDescriptor.new(name, manipulator, priority, custom_name)
  )

  # The index trick is used so that the sort is stable - manipulators with the same priority
  # will always be ordered in the same order as they were registered.
  n = 0
  @resource_list_manipulators = @resource_list_manipulators.sort_by do |m|
    n += 1
    [m[:priority], n]
  end

  rebuild_resource_list!(:registered_new)
end

#resources(include_ignored = false) ⇒ Object



139
140
141
142
143
144
145
146
147
148
# File 'middleman-core/lib/middleman-core/sitemap/store.rb', line 139

def resources(include_ignored=false)
  @lock.synchronize do
    ensure_resource_list_updated!
    if include_ignored
      @resources
    else
      @resources_not_ignored ||= @resources.reject(&:ignored?)
    end
  end
end

#Symbol

This method returns an undefined value.

Register an object which can transform the sitemap resource list. Best to register these in a before_configuration or after_configuration hook.



83
# File 'middleman-core/lib/middleman-core/sitemap/store.rb', line 83

Contract Symbol, RespondTo[:manipulate_resource_list], Maybe[Num], Maybe[Symbol] => Any