Class: Middleman::CoreExtensions::Data::DataExtension

Inherits:
Extension
  • Object
show all
Defined in:
middleman-core/lib/middleman-core/core_extensions/data.rb

Overview

The data extension parses YAML and JSON files in the data/ directory and makes them available to config.rb, templates and extensions

Constant Summary collapse

DATA_FILE_MATCHER =

The regex which tells Middleman which files are for data

/^(.*?)[\w-]+\.(yml|yaml|json)$/.freeze

Constants included from Contracts

Contracts::ImmutableSetOf, Contracts::ImmutableSortedSetOf, Contracts::OldResourceList, Contracts::PATH_MATCHER, Contracts::ResourceList, Contracts::VectorOf

Instance Attribute Summary collapse

Attributes inherited from Extension

#app, #options

Instance Method Summary collapse

Methods inherited from Extension

activated_extension, #add_exposed_to_context, #after_build, after_extension_activated, #after_extension_activated, #before_build, #before_configuration, clear_after_extension_callbacks, config, define_setting, expose_to_application, expose_to_config, expose_to_template, global_config, helpers, #manipulate_resource_list, option, #ready, resources

Methods included from Contracts

#Contract

Constructor Details

#initialize(app, options_hash = ::Middleman::EMPTY_HASH, &block) ⇒ DataExtension

Returns a new instance of DataExtension


25
26
27
28
29
30
31
# File 'middleman-core/lib/middleman-core/core_extensions/data.rb', line 25

def initialize(app, options_hash = ::Middleman::EMPTY_HASH, &block)
  super

  @data_store = DataStoreController.new(app, app.config[:track_data_access])

  start_watching(app.config[:data_dir])
end

Instance Attribute Details

#data_storeObject (readonly)

Returns the value of attribute data_store


10
11
12
# File 'middleman-core/lib/middleman-core/core_extensions/data.rb', line 10

def data_store
  @data_store
end

Instance Method Details

#after_configurationObject


48
49
50
51
52
# File 'middleman-core/lib/middleman-core/core_extensions/data.rb', line 48

def after_configuration
  return unless @original_data_dir != app.config[:data_dir]

  @watcher.update_path(app.config[:data_dir])
end

#start_watching(dir) ⇒ Object


34
35
36
37
38
39
40
41
42
43
44
45
# File 'middleman-core/lib/middleman-core/core_extensions/data.rb', line 34

def start_watching(dir)
  @original_data_dir = dir

  # Tell the file watcher to observe the :data_dir
  @watcher = app.files.watch :data,
                             path: File.expand_path(dir, app.root),
                             only: DATA_FILE_MATCHER

  # Setup data files before anything else so they are available when
  # parsing config.rb
  app.files.on_change(:data, &@data_store.method(:update_files))
end