module Jekyll - jekyll-sanity-1.6.0 Documentation

cache_dir() click to toggle source

A quick Pathutil (joinable) into the cache dir, and as

agreed to in https://goo.gl/TdzJWV we will default to
`.jekyll-cache` unless you define `cache_dir` key.

@return [Pathutil] the path.

# File lib/jekyll/sanity.rb, line 109
def self.cache_dir
  @cache_dir ||= begin
    backup = source_dir.join('.jekyll-cache')
    dir = Pathutil.new(config.fetch('cache_dir', backup))
    dir.expand_path
  end
end

config() click to toggle source

Reads the Jekyll configuration, this is necessary

because some of our stuff loads well before Jekyll
to setup, so we need to see the config before
Jekyll even sees it's own config.

@return [Hash] the config.

# File lib/jekyll/sanity.rb, line 17
def self.config
  old_e = nil
  old_o = nil

  @config ||= begin
    old_o, old_e = $stdout, $stderr
    $stdout, $stderr = StringIO.new, StringIO.new
    file = Pathutil.pwd.join('_config.yml')
    config = file.read_yaml(safe: true)
    source = config['source']
    defs = {
      'source' => Pathutil.pwd.to_s
    }

    config = config.merge(defs)
    configuration(config).update({
      'source' => source || Configuration::DEFAULTS[
        'source'
      ]
    })
  end
ensure
  $stdout = old_o if old_o
  $stderr = old_e if old_e
end

dev?() click to toggle source

Whether or not we are inside of development

environment, this is where most people work
but you should set it yourself.

@return [true,false] truth.

# File lib/jekyll/sanity.rb, line 59
def self.dev?
  @dev ||= begin
    Jekyll.env == 'dev' || Jekyll.env == 'development'
  end
end

plugins_dir() click to toggle source

@note this simply uses the default set by Jekyll A quick `Pathutil` (joinable) into the plugins dir. @return [Pathutil] the path.

# File lib/jekyll/sanity.rb, line 96
def self.plugins_dir
  @plugins_dir ||= begin
    dir = Pathutil.new(config.fetch('plugins_dir'))
    dir.expand_path
  end
end

production?() click to toggle source

Whether or not we are inside of production

this is what you should set yourself to if
you are building a deployment.

@return [true,false] truth.

# File lib/jekyll/sanity.rb, line 71
def self.production?
  @production ||= begin
    Jekyll.env == 'production' || Jekyll.env == 'prod'
  end
end

reload_config() click to toggle source

Reloads the configuration file for you, this only

affects `self.config` and doesn't really affect the
site instance at all, Jekyll is weird.

# File lib/jekyll/sanity.rb, line 48
def self.reload_config
  instance_variable_set(:@config, nil)
  config
end

site_dir() click to toggle source

@note this simply uses the default set by Jekyll A quick `Pathutil` (joinable) into the site dir. @return [Pathutil] the path.

# File lib/jekyll/sanity.rb, line 122
def self.site_dir
  @site_dir ||= begin
    dir = Pathutil.new(config.fetch('destination'))
    dir.expand_path
  end
end

source_dir() click to toggle source

A quick Pathutil (joinable) into the source dir, this

hopefully follows the spec of Jekyll by allowing you to
set the source dir (with `source`) and then if it's
not set, defaulting to the current path.

@return [Pathutil] the path.

# File lib/jekyll/sanity.rb, line 84
def self.source_dir
  @source_dir ||= begin
    dir = Pathutil.new(config.fetch('source'))
    dir.expand_path
  end
end