module J1

Copyright: 2015 Jekyll - MIT License Encoding: utf-8

Constants

VERSION

Public Class Methods

configuration(override = {}) click to toggle source

Public: Generate a J1 configuration Hash by merging the default options with anything in _config.yml, and adding the given options on top.

override - A Hash of config directives that override any options in both

the defaults and the config file.
See J1::Configuration::DEFAULTS for a
list of option names and their defaults.

Returns the final configuration Hash.

# File lib/j1.rb, line 56
def configuration(override = {})
  config = Configuration.new
  override = Configuration[override].stringify_keys
  unless override.delete('skip_config_files')
    config = config.read_config_files(config.config_files(override))
  end

  # Merge DEFAULTS < _config.yml < override
  Configuration.from(Utils.deep_merge_hashes(config, override)).tap do |obj|
    set_timezone(obj['timezone']) if obj['timezone']
  end
end
env() click to toggle source

Public: Tells you which J1 environment you are building in so you can skip tasks if you need to. This is useful when doing expensive compression tasks on css and images and allows you to skip that when working in development.

# File lib/j1.rb, line 43
def env
  ENV['JEKYLL_ENV'] || 'development'
end
logger() click to toggle source

Public: Fetch the logger instance for this J1 process.

Returns the LogAdapter instance.

# File lib/j1.rb, line 83
def logger
  @logger ||= LogAdapter.new(LogHelper.new, (ENV['J1_LOG_LEVEL'] || :info).to_sym)
end
logger=(writer) click to toggle source

Public: Set the log writer.

New log writer must respond to the same methods
as Ruby's interal Logger.

writer - the new Logger-compatible log transport

Returns the new logger.

# File lib/j1.rb, line 94
def logger=(writer)
  @logger = LogAdapter.new(writer, (ENV['J1_LOG_LEVEL'] || :info).to_sym)
end
sanitized_path(base_directory, questionable_path) click to toggle source

Public: Ensures the questionable path is prefixed with the base directory

and prepends the questionable path with the base directory if false.

base_directory - the directory with which to prefix the questionable path questionable_path - the path we're unsure about, and want prefixed

Returns the sanitized path.

# File lib/j1.rb, line 112
def sanitized_path(base_directory, questionable_path)
  return base_directory if base_directory.eql?(questionable_path)

  questionable_path.insert(0, '/') if questionable_path.start_with?('~')
  clean_path = File.expand_path(questionable_path, '/')

  return clean_path if clean_path.eql?(base_directory)

  if clean_path.start_with?(base_directory.sub(/\z/, '/'))
    clean_path
  else
    clean_path.sub!(%r{\A\w:/}, '/')
    File.join(base_directory, clean_path)
  end
end
set_timezone(timezone) click to toggle source

Public: Set the TZ environment variable to use the timezone specified

timezone - the IANA Time Zone

Returns nothing rubocop:disable Style/AccessorMethodName

# File lib/j1.rb, line 75
def set_timezone(timezone)
  ENV['TZ'] = timezone
end
sites() click to toggle source

Public: An array of sites

Returns the J1 sites created.

# File lib/j1.rb, line 101
def sites
  @sites ||= []
end