module Jekyll

Convertible provides methods for converting a pagelike item from a certain type of markup into actual content

Requires

self.site -> Jekyll::Site
self.content
self.content=
self.data=
self.ext=
self.output=
self.name
self.path
self.type -> :page, :post or :draft

Public: Methods that generate a URL for a resource such as a Post or a Page.

Examples

URL.new({
  :template => /:categories/:title.html",
  :placeholders => {:categories => "ruby", :title => "something"}
}).to_s

Constants

Generator
VERSION

Public Class Methods

configuration(override = {}) click to toggle source

Public: Generate a Jekyll 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 Jekyll::Configuration::DEFAULTS for a
list of option names and their defaults.

Returns the final configuration Hash.

# File lib/jekyll.rb, line 111
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 Jekyll 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/jekyll.rb, line 98
def env
  ENV["JEKYLL_ENV"] || "development"
end

logger() click to toggle source

Public: Fetch the logger instance for this Jekyll process.

Returns the LogAdapter instance.

# File lib/jekyll.rb, line 142
def logger
  @logger ||= LogAdapter.new(Stevenson.new, (ENV["JEKYLL_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/jekyll.rb, line 153
def logger=(writer)
  @logger = LogAdapter.new(writer, (ENV["JEKYLL_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/jekyll.rb, line 171
def sanitized_path(base_directory, questionable_path)
  return base_directory if base_directory.eql?(questionable_path)

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

  return clean_path if clean_path.eql?(base_directory)

  # remove any remaining extra leading slashes not stripped away by calling
  # `File.expand_path` above.
  clean_path.squeeze!("/")

  if clean_path.start_with?(base_directory.sub(%r!\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 Naming/AccessorMethodName

# File lib/jekyll.rb, line 130
def set_timezone(timezone)
  ENV["TZ"] = if Utils::Platforms.really_windows?
                Utils::WinTZ.calculate(timezone)
              else
                timezone
              end
end

sites() click to toggle source

Public: An array of sites

Returns the Jekyll sites created.

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

Public Instance Methods

glob_include?(enumerator, entry) click to toggle source

Check if an entry matches a specific pattern. Returns true if path matches against any glob pattern, else false.

# File lib/jekyll/entry_filter.rb, line 92
def glob_include?(enumerator, entry)
  entry_with_source = PathManager.join(site.source, entry)

  enumerator.any? do |pattern|
    case pattern
    when String
      pattern_with_source = PathManager.join(site.source, pattern)

      File.fnmatch?(pattern_with_source, entry_with_source) ||
        entry_with_source.start_with?(pattern_with_source)
    when Regexp
      pattern.match?(entry_with_source)
    else
      false
    end
  end
end

symlink?(entry) click to toggle source

– Check if a file is a symlink. NOTE: This can be converted to allowing even in safe,

since we use Pathutil#in_path? now.

–

# File lib/jekyll/entry_filter.rb, line 75
def symlink?(entry)
  site.safe && File.symlink?(entry) && symlink_outside_site_source?(entry)
end

symlink_outside_site_source?(entry) click to toggle source

– NOTE: Pathutil#in_path? gets the realpath. @param [<Anything>] entry the entry you want to validate. Check if a path is outside of our given root. –

# File lib/jekyll/entry_filter.rb, line 84
def symlink_outside_site_source?(entry)
  !Pathutil.new(entry).in_path?(
    site.in_source_dir
  )
end