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

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Contracts

#Contract

Constructor Details

#initialize(app) ⇒ Store

Initialize with parent app

Parameters:



56
57
58
59
60
61
62
63
64
65
66
67
68
69
# File 'middleman-core/lib/middleman-core/sitemap/store.rb', line 56

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

  # TODO: Should this be a set or hash?
  @resource_list_manipulators = []
  @needs_sitemap_rebuild = true

  @lock = Monitor.new
  reset_lookup_cache!

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

Instance Attribute Details

#appMiddleman::Application (readonly)



50
51
52
# File 'middleman-core/lib/middleman-core/sitemap/store.rb', line 50

def app
  @app
end

#update_countObject (readonly)

Returns the value of attribute update_count



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

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!



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
# File 'middleman-core/lib/middleman-core/sitemap/store.rb', line 173

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, (_, manipulator, _)|
      newres = manipulator.manipulate_resource_list(result)

      # Reset lookup cache
      reset_lookup_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



165
166
167
168
# File 'middleman-core/lib/middleman-core/sitemap/store.rb', line 165

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

#file_to_path(file) ⇒ Object



150
151
152
153
154
155
156
157
158
159
# File 'middleman-core/lib/middleman-core/sitemap/store.rb', line 150

def file_to_path(file)
  relative_path = 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



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

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



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

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.



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

def invalidate_resources_not_ignored_cache!
  @resources_not_ignored = nil
end

#rebuild_resource_list!(_ = nil)

This method returns an undefined value.

Rebuild the list of resources from scratch, using registed manipulators



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

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

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



79
80
81
82
83
84
85
86
87
88
89
90
91
# File 'middleman-core/lib/middleman-core/sitemap/store.rb', line 79

def register_resource_list_manipulator(name, manipulator, priority=50)
  # The third argument used to be a boolean - handle those who still pass one
  priority = 50 unless priority.is_a? Numeric
  @resource_list_manipulators << [name, manipulator, priority]
  # 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[2], n]
  end
  rebuild_resource_list!(:registered_new)
end

#resources(include_ignored = false) ⇒ Object



129
130
131
132
133
134
135
136
137
138
# File 'middleman-core/lib/middleman-core/sitemap/store.rb', line 129

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.

Parameters:

  • name (Symbol)

    Name of the manipulator for debugging

  • manipulator (#manipulate_resource_list)

    Resource list manipulator

  • priority (Numeric)

    Sets the order of this resource list manipulator relative to the rest. By default this is 50, and manipulators run in the order they are registered, but if a priority is provided then this will run ahead of or behind other manipulators.



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

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