Class: Bridgetown::Configuration

Inherits:
HashWithDotAccess::Hash show all
Defined in:
bridgetown-core/lib/bridgetown-core/configuration.rb,
bridgetown-core/lib/bridgetown-core/configuration/configuration_dsl.rb

Overview

The primary configuration object for a Bridgetown project

Defined Under Namespace

Classes: ConfigurationDSL, Initializer, Preflight, SourceManifest

Constant Summary collapse

REQUIRE_DENYLIST =

rubocop:disable Style/MutableConstant

%i(parse_routes ssr)
DEFAULTS =

Default options. Overridden by values in bridgetown.config.yml or initializers. Strings rather than symbols are used for compatibility with YAML.

{
  # Where things are
  "root_dir"                   => Dir.pwd,
  "plugins_dir"                => "plugins",
  "source"                     => "src",
  "destination"                => "output",
  "collections_dir"            => "",
  "cache_dir"                  => ".bridgetown-cache",
  "layouts_dir"                => "_layouts",
  "components_dir"             => "_components",
  "islands_dir"                => "_islands",
  "partials_dir"               => "_partials",
  "collections"                => {},
  "taxonomies"                 => {
    category: { key: "categories", title: "Category" }, tag: { key: "tags", title: "Tag" },
  },
  "autoload_paths"             => [],
  "inflector"                  => nil,
  "eager_load_paths"           => [],
  "autoloader_collapsed_paths" => [],
  "additional_watch_paths"     => [],

  # Handling Reading
  "include"                    => [".htaccess", "_redirects", ".well-known"],
  "exclude"                    => [],
  "keep_files"                 => [".git", ".svn", "_bridgetown"],
  "encoding"                   => "utf-8",
  "markdown_ext"               => "markdown,mkdown,mkdn,mkd,md",
  "strict_front_matter"        => false,
  "slugify_mode"               => "pretty",

  # Filtering Content
  "future"                     => false,
  "unpublished"                => false,
  "ruby_in_front_matter"       => true,

  # Conversion
  "content_engine"             => "resource",
  "markdown"                   => "kramdown",
  "highlighter"                => "rouge",

  # Serving
  "port"                       => "4000",
  "host"                       => "127.0.0.1",
  "base_path"                  => "/",
  "show_dir_listing"           => false,

  # Output Configuration
  "available_locales"          => [:en],
  "default_locale"             => :en,
  "prefix_default_locale"      => false,
  "permalink"                  => nil, # default is set according to content engine
  "timezone"                   => nil, # use the local timezone

  "quiet"                      => false,
  "verbose"                    => false,
  "defaults"                   => [],

  "liquid"                     => {
    "error_mode"       => "warn",
    "strict_filters"   => false,
    "strict_variables" => false,
  },

  "kramdown"                   => {
    "auto_ids"                => true,
    "toc_levels"              => (1..6).to_a,
    "entity_output"           => "as_char",
    "smart_quotes"            => "lsquo,rsquo,ldquo,rdquo",
    "input"                   => "GFM",
    "hard_wrap"               => false,
    "guess_lang"              => true,
    "footnote_nr"             => 1,
    "show_warnings"           => false,
    "include_extraction_tags" => false,
    "mark_highlighting"       => true,
  },

  "development"                => {
    "fast_refresh" => true,
  },
}.each_with_object(Configuration.new) { |(k, v), hsh| hsh[k] = v.freeze }.freeze
CONFIG_FILE_PREFIXES =

TODO: Deprecated. Remove support for _config as well as toml in the next release.

%w(bridgetown.config _config).freeze
CONFIG_FILE_EXTS = 
%w(yml yaml toml).freeze
DEFAULT_EXCLUDES = 
%w(
  .sass-cache .bridgetown-cache
  gemfiles Gemfile Gemfile.lock gems.rb gems.locked
  node_modules
  vendor/bundle/ vendor/cache/ vendor/gems/ vendor/ruby/
).freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from HashWithDotAccess::Hash

#to_liquid

Instance Attribute Details

#initializers ⇒ Hash<Symbol, Initializer>

Returns:



115
116
117
 
# File 'bridgetown-core/lib/bridgetown-core/configuration.rb', line 115

def initializers
  @initializers
end

#roda_initializers ⇒ Array<Proc>

Returns:

  • (Array<Proc>) 


169
170
171
 
# File 'bridgetown-core/lib/bridgetown-core/configuration.rb', line 169

def roda_initializers
  @roda_initializers ||= []
end

#source_manifests ⇒ Set<SourceManifest>

Returns:



164
165
166
 
# File 'bridgetown-core/lib/bridgetown-core/configuration.rb', line 164

def source_manifests
  @source_manifests ||= Set.new
end

Class Method Details

.from(user_config, starting_defaults = DEFAULTS) ⇒ Object

Static: Produce a Configuration ready for use in a Site. It takes the input, fills in the defaults where values do not exist.

user_config - a Hash or Configuration of overrides.

Returns a Configuration filled with defaults.



126
127
128
129
130
131
132
133
134
 
# File 'bridgetown-core/lib/bridgetown-core/configuration.rb', line 126

def from(user_config, starting_defaults = DEFAULTS)
  Utils.deep_merge_hashes(starting_defaults.deep_dup, Configuration.new(user_config))
    .merge_environment_specific_options!
    .setup_load_paths!
    .setup_locales
    .add_default_collections
    .add_default_excludes
    .check_include_exclude
end

Instance Method Details

#add_default_collections ⇒ Object

rubocop:todo all



380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
 
# File 'bridgetown-core/lib/bridgetown-core/configuration.rb', line 380

def add_default_collections # rubocop:todo all
  # It defaults to `{}`, so this is only if someone sets it to null manually.
  return self if self[:collections].nil?

  # Ensure we have a hash.
  if self[:collections].is_a?(Array)
    self[:collections] = self[:collections].each_with_object({}) do |collection, hash|
      hash[collection] = {}
    end
  end

  # Setup default collections
  self[:collections][:posts] = {} unless self[:collections][:posts]
  self[:collections][:posts][:output] = true
  self[:collections][:posts][:sort_direction] ||= "descending"

  self[:permalink] = "pretty" if self[:permalink].blank?
  self[:collections][:pages] = {} unless self[:collections][:pages]
  self[:collections][:pages][:output] = true
  self[:collections][:pages][:permalink] ||= "/:locale/:path/"

  self[:collections][:data] = {} unless self[:collections][:data]
  self[:collections][:data][:output] = false

  unless self[:collections][:posts][:permalink]
    self[:collections][:posts][:permalink] = self[:permalink]
  end

  self
end

#add_default_excludes ⇒ Object 



418
419
420
421
422
423
 
# File 'bridgetown-core/lib/bridgetown-core/configuration.rb', line 418

def add_default_excludes
  return self if self["exclude"].nil?

  self["exclude"].concat(DEFAULT_EXCLUDES).uniq!
  self
end

#check_include_exclude ⇒ Object 



430
431
432
433
434
435
436
437
438
439
440
 
# File 'bridgetown-core/lib/bridgetown-core/configuration.rb', line 430

def check_include_exclude
  %w(include exclude).each do |option|
    next unless key?(option)
    next if self[option].is_a?(Array)

    raise Bridgetown::Errors::InvalidConfigurationError,
          "'#{option}' should be set as an array, but was: #{self[option].inspect}."
  end

  self
end

#config_files(override) ⇒ Object

Public: Generate list of configuration files from the override

override - the command-line options hash

Returns an Array of config files



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'bridgetown-core/lib/bridgetown-core/configuration.rb', line 247

def config_files(override)
  # Adjust verbosity quickly
  Bridgetown.logger.adjust_verbosity(
    quiet: quiet?(override),
    verbose: verbose?(override)
  )

  # Get configuration from <root_dir>/<matching_default_config>
  # or <root_dir>/<config_file> if there's a command line override.
  # By default only the first matching config file will be loaded, but
  # multiple configs can be specified via command line.
  config_files = override["config"]
  if config_files.to_s.empty?
    file_lookups = CONFIG_FILE_PREFIXES.map do |prefix|
      CONFIG_FILE_EXTS.map do |ext|
        Bridgetown.sanitized_path(root_dir(override), "#{prefix}.#{ext}")
      end
    end.flatten.freeze

    found_file = file_lookups.find do |path|
      File.exist?(path)
    end

    config_files = found_file || file_lookups.first
    @default_config_file = true
  end
  Array(config_files)
end

#get_config_value_with_override(config_key, override) ⇒ Object 



179
180
181
 
# File 'bridgetown-core/lib/bridgetown-core/configuration.rb', line 179

def get_config_value_with_override(config_key, override)
  override[config_key] || self[config_key] || DEFAULTS[config_key]
end

#initialize_roda_app(app) ⇒ Object 



173
174
175
176
177
 
# File 'bridgetown-core/lib/bridgetown-core/configuration.rb', line 173

def initialize_roda_app(app)
  roda_initializers.each do |initializer|
    initializer.(app)
  end
end

#merge_environment_specific_options! ⇒ Object

Merge in environment-specific options, if present



328
329
330
331
332
333
334
335
 
# File 'bridgetown-core/lib/bridgetown-core/configuration.rb', line 328

def merge_environment_specific_options!
  self[Bridgetown.environment]&.each_key do |k|
    self[k] = self[Bridgetown.environment][k]
  end
  delete(Bridgetown.environment)

  self
end

#quiet(override = {}) ⇒ Object Also known as: quiet? 



201
202
203
 
# File 'bridgetown-core/lib/bridgetown-core/configuration.rb', line 201

def quiet(override = {})
  get_config_value_with_override("quiet", override)
end

#read_config_file(file) ⇒ Object

Public: Read configuration and return merged Hash

file - the path to the YAML file to be read in

Returns this configuration, overridden by the values in the file



306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
 
# File 'bridgetown-core/lib/bridgetown-core/configuration.rb', line 306

def read_config_file(file)
  file = File.expand_path(file)
  next_config = safe_load_file(file)

  unless next_config.is_a?(Hash)
    raise ArgumentError, "Configuration file: (INVALID) #{file}".yellow
  end

  Bridgetown.logger.debug "Configuration file:", file
  next_config
rescue SystemCallError
  if @default_config_file ||= nil
    initializers_file = File.join(root_dir, "config", "initializers.rb")
    Bridgetown.logger.warn "Configuration file:", "none" unless File.file?(initializers_file)
    {}
  else
    Bridgetown.logger.error "Fatal:", "The configuration file '#{file}' could not be found."
    raise LoadError, "The Configuration file '#{file}' could not be found."
  end
end

#read_config_files(files) ⇒ Object

Public: Read in a list of configuration files and merge with this hash

files - the list of configuration file paths

Returns the full configuration, with the defaults overridden by the values in the configuration files



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'bridgetown-core/lib/bridgetown-core/configuration.rb', line 282

def read_config_files(files)
  config = self

  begin
    files.each do |config_file|
      next if config_file.nil? || config_file.empty?

      new_config = read_config_file(config_file)
      config = Utils.deep_merge_hashes(self, new_config)
    end
  rescue ArgumentError => e
    Bridgetown.logger.warn "WARNING:", "Error reading configuration. Using defaults " \
                                       "(and options)."
    warn e
  end

  config
end

#root_dir(override = {}) ⇒ String

Directory of the top-level root where config files are located

Parameters:

  • override (Hash) (defaults to: {}) —

    options hash which will override value if key is present

Returns:

  • (String) —

    path to the Bridgetown root directory



188
189
190
 
# File 'bridgetown-core/lib/bridgetown-core/configuration.rb', line 188

def root_dir(override = {})
  get_config_value_with_override("root_dir", override)
end

#run_initializers!(context:) ⇒ Object

rubocop:todo Metrics/AbcSize, Metrics/CyclomaticComplexity



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'bridgetown-core/lib/bridgetown-core/configuration.rb', line 137

def run_initializers!(context:) # rubocop:todo Metrics/AbcSize, Metrics/CyclomaticComplexity
  initializers_file = File.join(root_dir, "config", "initializers.rb")
  return unless File.file?(initializers_file)

  load initializers_file

  return unless initializers # no initializers have been set up

  init_init = initializers[:init]
  return unless init_init && !init_init.completed

  Bridgetown.logger.debug "Initializing:", "Running initializers with `#{context}' context in:"
  Bridgetown.logger.debug "", initializers_file
  self.init_params = {}
  cached_url = url&.include?("//localhost") ? url : nil
  dsl = ConfigurationDSL.new(scope: self, data: self)
  dsl.instance_variable_set(:@context, context)
  dsl.instance_exec(dsl, &init_init.block)
  dsl._run_builtins!
  self.url = cached_url if cached_url # restore local development URL if need be

  setup_load_paths! appending: true

  self
end

#safe_load_file(filename) ⇒ Object

rubocop:todo Metrics



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'bridgetown-core/lib/bridgetown-core/configuration.rb', line 211

def safe_load_file(filename) # rubocop:todo Metrics
  case File.extname(filename)
  when %r!\.toml!i
    Deprecator.deprecation_message(
      "TOML configurations will no longer be supported in the next version of Bridgetown." \
      "Use initializers or a .yaml config instead."
    )
    Bridgetown::Utils::RequireGems.require_with_graceful_fail("tomlrb") unless defined?(Tomlrb)
    Tomlrb.load_file(filename)
  when %r!\.ya?ml!i
    if File.basename(filename, ".*") == "_config"
      Deprecator.deprecation_message(
        "YAML configurations named `_config.y(a)ml' will no longer be supported in the next " \
        "version of Bridgetown. Rename to `bridgetown.config.yml' instead."
      )
    end
    if File.extname(filename) == ".yaml"
      Deprecator.deprecation_message(
        "YAML configurations ending in `.yaml' will no longer be supported in the next " \
        "version of Bridgetown. Rename to use `.yml' extension instead."
      )
    end
    YAMLParser.load_file(filename) || {}
  else
    raise ArgumentError,
          "No parser for '#{filename}' is available. Use a .y(a)ml file instead."
  end
rescue Psych::DisallowedClass => e
  raise "Unable to parse `#{File.basename(filename)}'. #{e.message}"
end

#setup_load_paths!(appending: false) ⇒ Object

rubocop:todo Metrics



337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'bridgetown-core/lib/bridgetown-core/configuration.rb', line 337

def setup_load_paths!(appending: false) # rubocop:todo Metrics
  unless appending
    self[:root_dir] = File.expand_path(self[:root_dir])
    self[:source] = File.expand_path(self[:source], self[:root_dir])
    self[:destination] = File.expand_path(self[:destination], self[:root_dir])

    autoload_paths.unshift({
      path: self[:plugins_dir],
      eager: true,
    })
    autoload_paths.unshift({
      path: File.expand_path(self[:islands_dir], self[:source]),
      eager: true,
    })
  end

  autoload_paths.map! do |load_path|
    if load_path.is_a?(Hash)
      expanded = File.expand_path(load_path[:path], self[:root_dir])
      self[:eager_load_paths] << expanded if load_path[:eager]
      next expanded
    end

    File.expand_path(load_path, self[:root_dir])
  end

  autoloader_collapsed_paths.map! do |collapsed_path|
    File.expand_path(collapsed_path, self[:root_dir])
  end

  additional_watch_paths.map! do |collapsed_path|
    File.expand_path(collapsed_path, self[:root_dir])
  end

  self
end

#setup_locales ⇒ Object 



374
375
376
377
378
 
# File 'bridgetown-core/lib/bridgetown-core/configuration.rb', line 374

def setup_locales
  self.default_locale = default_locale.to_sym
  available_locales.map!(&:to_sym)
  self
end

#should_execute_inline_ruby? ⇒ Boolean

Returns:

  • (Boolean) 


425
426
427
428
 
# File 'bridgetown-core/lib/bridgetown-core/configuration.rb', line 425

def should_execute_inline_ruby?
  ENV["BRIDGETOWN_RUBY_IN_FRONT_MATTER"] != "false" &&
    self["ruby_in_front_matter"]
end

#source(override = {}) ⇒ String

Public: Directory of the Bridgetown source folder

Parameters:

  • override (Hash) (defaults to: {}) —

    options hash which will override value if key is present

Returns:

  • (String) —

    path to the Bridgetown source directory



197
198
199
 
# File 'bridgetown-core/lib/bridgetown-core/configuration.rb', line 197

def source(override = {})
  get_config_value_with_override("source", override)
end

#uses_postcss? ⇒ Boolean

Whether or not PostCSS is being used to process stylesheets.

Returns:

  • (Boolean) —

    true if postcss.config.js exists, false if not



445
446
447
 
# File 'bridgetown-core/lib/bridgetown-core/configuration.rb', line 445

def uses_postcss?
  File.exist?(Bridgetown.sanitized_path(root_dir, "postcss.config.js"))
end

#verbose(override = {}) ⇒ Object Also known as: verbose? 



206
207
208
 
# File 'bridgetown-core/lib/bridgetown-core/configuration.rb', line 206

def verbose(override = {})
  get_config_value_with_override("verbose", override)
end