Module: Jekyll::Utils

Extended by:
Utils
Included in:
Utils
Defined in:
lib/jekyll/utils.rb,
lib/jekyll/utils/platforms.rb

Defined Under Namespace

Modules: Platforms

Constant Summary collapse

SLUGIFY_MODES =

Constants for use in #slugify

%w{raw default pretty}
SLUGIFY_RAW_REGEXP = 
Regexp.new('\\s+').freeze
SLUGIFY_DEFAULT_REGEXP = 
Regexp.new('[^[:alnum:]]+').freeze
SLUGIFY_PRETTY_REGEXP = 
Regexp.new("[^[:alnum:]._~!$&'()+,;=@]+").freeze

Instance Method Summary collapse

Instance Method Details

Add an appropriate suffix to template so that it matches the specified permalink style.

template - permalink template without trailing slash or file extension permalink_style - permalink style, either built-in or custom

The returned permalink template will use the same ending style as specified in permalink_style. For example, if permalink_style contains a trailing slash (or is :pretty, which indirectly has a trailing slash), then so will the returned template. If permalink_style has a trailing “:output_ext” (or is :none, :date, or :ordinal) then so will the returned template. Otherwise, template will be returned without modification.

Examples:

add_permalink_suffix("/:basename", :pretty)
# => "/:basename/"

add_permalink_suffix("/:basename", :date)
# => "/:basename:output_ext"

add_permalink_suffix("/:basename", "/:year/:month/:title/")
# => "/:basename/"

add_permalink_suffix("/:basename", "/:year/:month/:title")
# => "/:basename"

Returns the updated permalink template



208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/jekyll/utils.rb', line 208

def add_permalink_suffix(template, permalink_style)
  case permalink_style
  when :pretty
    template << "/"
  when :date, :ordinal, :none
    template << ":output_ext"
  else
    template << "/" if permalink_style.to_s.end_with?("/")
    template << ":output_ext" if permalink_style.to_s.end_with?(":output_ext")
  end
  template
end

#deep_merge_hashes(master_hash, other_hash) ⇒ Object

Non-destructive version of deep_merge_hashes! See that method.

Returns the merged hashes.



14
15
16
 
# File 'lib/jekyll/utils.rb', line 14

def deep_merge_hashes(master_hash, other_hash)
  deep_merge_hashes!(master_hash.dup, other_hash)
end

#deep_merge_hashes!(target, overwrite) ⇒ Object

Merges a master hash with another hash, recursively.

master_hash - the “parent” hash whose values will be overridden other_hash - the other hash whose values will be persisted after the merge

This code was lovingly stolen from some random gem: gemjack.com/gems/tartan-0.1.1/classes/Hash.html

Thanks to whoever made it.



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/jekyll/utils.rb', line 27

def deep_merge_hashes!(target, overwrite)
  overwrite.each_key do |key|
    if overwrite[key].is_a? Hash and target[key].is_a? Hash
      target[key] = Utils.deep_merge_hashes(target[key], overwrite[key])
      next
    end

    target[key] = overwrite[key]
  end

  if target.default_proc.nil?
    target.default_proc = overwrite.default_proc
  end

  target
end

#has_yaml_header?(file) ⇒ Boolean

Determines whether a given file has

Returns true if the YAML front matter is present.

Returns:

  • (Boolean) 


116
117
118
 
# File 'lib/jekyll/utils.rb', line 116

def has_yaml_header?(file)
  !!(File.open(file, 'rb') { |f| f.read(5) } =~ /\A---\r?\n/)
end

#parse_date(input, msg = "Input could not be parsed.") ⇒ Object

Parse a date/time and throw an error if invalid

input - the date/time to parse msg - (optional) the error message to show the user

Returns the parsed date if successful, throws a FatalException if not



107
108
109
110
111
 
# File 'lib/jekyll/utils.rb', line 107

def parse_date(input, msg = "Input could not be parsed.")
  Time.parse(input).localtime
rescue ArgumentError
  raise Errors::FatalException.new("Invalid date '#{input}': " + msg)
end

#pluralized_array_from_hash(hash, singular_key, plural_key) ⇒ Object

Read array from the supplied hash favouring the singular key and then the plural key, and handling any nil entries.

hash - the hash to read from singular_key - the singular key plural_key - the plural key

Returns an array



52
53
54
55
56
 
# File 'lib/jekyll/utils.rb', line 52

def pluralized_array_from_hash(hash, singular_key, plural_key)
  [].tap do |array|
    array << (value_from_singular_key(hash, singular_key) || value_from_plural_key(hash, plural_key))
  end.flatten.compact
end

#slugify(string, mode: nil, cased: false) ⇒ Object

Slugify a filename or title.

string - the filename or title to slugify mode - how string is slugified cased - whether to replace all uppercase letters with their lowercase counterparts

When mode is “none”, return the given string.

When mode is “raw”, return the given string, with every sequence of spaces characters replaced with a hyphen.

When mode is “default” or nil, non-alphabetic characters are replaced with a hyphen too.

When mode is “pretty”, some non-alphabetic characters (._~!$&‘()+,;=@) are not replaced with hyphen.

If cased is true, all uppercase letters in the result string are replaced with their lowercase counterparts.

Examples:

slugify("The _config.yml file")
# => "the-config-yml-file"

slugify("The _config.yml file", "pretty")
# => "the-_config.yml-file"

slugify("The _config.yml file", "pretty", true)
# => "The-_config.yml file"

Returns the slugified string.



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/jekyll/utils.rb', line 152

def slugify(string, mode: nil, cased: false)
  mode ||= 'default'
  return nil if string.nil?

  unless SLUGIFY_MODES.include?(mode)
    return cased ? string : string.downcase
  end

  # Replace each character sequence with a hyphen
  re = case mode
  when 'raw'
    SLUGIFY_RAW_REGEXP
  when 'default'
    SLUGIFY_DEFAULT_REGEXP
  when 'pretty'
    # "._~!$&'()+,;=@" is human readable (not URI-escaped) in URL
    # and is allowed in both extN and NTFS.
    SLUGIFY_PRETTY_REGEXP
  end

  slug = string.
    # Strip according to the mode
    gsub(re, '-').
    # Remove leading/trailing hyphen
    gsub(/^\-|\-$/i, '')

  cased ? slug : slug.downcase
end

#stringify_hash_keys(hash) ⇒ Object

Apply #to_s to all keys in the Hash

hash - the hash to which to apply this transformation

Returns a new hash with stringified keys



96
97
98
 
# File 'lib/jekyll/utils.rb', line 96

def stringify_hash_keys(hash)
  transform_keys(hash) { |key| key.to_s rescue key }
end

#symbolize_hash_keys(hash) ⇒ Object

Apply #to_sym to all keys in the hash

hash - the hash to which to apply this transformation

Returns a new hash with symbolized keys



87
88
89
 
# File 'lib/jekyll/utils.rb', line 87

def symbolize_hash_keys(hash)
  transform_keys(hash) { |key| key.to_sym rescue key }
end

#transform_keys(hash) ⇒ Object 



74
75
76
77
78
79
80
 
# File 'lib/jekyll/utils.rb', line 74

def transform_keys(hash)
  result = {}
  hash.each_key do |key|
    result[yield(key)] = hash[key]
  end
  result
end

#value_from_plural_key(hash, key) ⇒ Object 



62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/jekyll/utils.rb', line 62

def value_from_plural_key(hash, key)
  if hash.key?(key) || (hash.default_proc && hash[key])
    val = hash[key]
    case val
    when String
      val.split
    when Array
      val.compact
    end
  end
end

#value_from_singular_key(hash, key) ⇒ Object 



58
59
60
 
# File 'lib/jekyll/utils.rb', line 58

def value_from_singular_key(hash, key)
  hash[key] if (hash.key?(key) || (hash.default_proc && hash[key]))
end