Class: Middleman::Sitemap::Store

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
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

Constants included from Contracts

Contracts::ImmutableSortedSetOf, Contracts::PATH_MATCHER

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Contracts

#Contract

Constructor Details

#initialize(app) ⇒ Store

Returns a new instance of Store.


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

def initialize(app)
  @app = app
  @resources = ResourceListContainer.new
  @rebuild_reasons = [:first_run]
  @update_count = 0

  @resource_list_manipulators = ::Hamster::Vector.empty
  @needs_sitemap_rebuild = true

  @lock = Monitor.new

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

Instance Attribute Details

#appObject (readonly)

Returns the value of attribute app


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

def app
  @app
end

#resourcesObject (readonly)

Returns the value of attribute resources


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

def resources
  @resources
end

#update_countObject (readonly)

Returns the value of attribute update_count


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

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!


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

def ensure_resource_list_updated!
  return if @app.config[:disable_sitemap]

  @lock.synchronize do
    return unless @needs_sitemap_rebuild

    ::Middleman::Util.instrument 'sitemap.update', reasons: @rebuild_reasons.uniq do
      @needs_sitemap_rebuild = false

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

      @resources.reset!

      @resource_list_manipulators.each do |m|
        ::Middleman::Util.instrument 'sitemap.manipulator', name: m[:name] do
          @app.logger.debug "== Running manipulator: #{m[:name]} (#{m[:priority]})"

          if m[:manipulator].respond_to?(:manipulate_resource_list_container!)
            m[:manipulator].send(:manipulate_resource_list_container!, @resources)
          elsif m[:manipulator].respond_to?(:manipulate_resource_list)
            m[:manipulator].send(:manipulate_resource_list, resources.to_a).tap do |result|
              @resources.reset!(result)
            end
          end
        end
      end

      @update_count += 1

      @rebuild_reasons = []
    end
  end
end

#extensionless_path(file) ⇒ Object


160
161
162
163
# File 'middleman-core/lib/middleman-core/sitemap/store.rb', line 160

def extensionless_path(file)
  path = file.dup
  ::Middleman::Util.remove_templating_extensions(path)
end

#file_to_path(file) ⇒ Object


147
148
149
150
151
152
153
154
# File 'middleman-core/lib/middleman-core/sitemap/store.rb', line 147

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
  relative_path = relative_path.gsub(@app.config[:automatic_directory_matcher], '/') unless @app.config[:automatic_directory_matcher].nil?

  extensionless_path(relative_path)
end

#rebuild_resource_list!(name) ⇒ Object


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

def rebuild_resource_list!(name)
  @lock.synchronize do
    @rebuild_reasons << name
    @app.logger.debug "== Requesting resource list rebuilding: #{name}"
    @needs_sitemap_rebuild = true
  end
end

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


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

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 = @resource_list_manipulators.push(
    ManipulatorDescriptor.new(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[:priority], n]
  end

  rebuild_resource_list!(:"registered_new_manipulator_#{name}")
end

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


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

def register_resource_list_manipulators(name, manipulator, priority = 50)
  Array(priority || 50).each do |p|
    register_resource_list_manipulator(name, manipulator, p)
  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.


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

Contract Symbol, Or[RespondTo[:manipulate_resource_list], RespondTo[:manipulate_resource_list_container!]], Maybe[Num, Bool] => Any