Module: J1::Utils

Extended by:
Utils
Included in:
Utils
Defined in:
lib/j1/utils.rb,
lib/j1/utils/ansi.rb,
lib/j1/utils/exec1.rb,
lib/j1/utils/exec2.rb,
lib/j1/utils/win_tz.rb,
lib/j1/utils/platforms.rb

Defined Under Namespace

Modules: Ansi, Exec1, Exec2, Platforms, WinTZ Classes: GracefulQuit

Constant Summary collapse

SLUGIFY_MODES =

Constants to be used in #slugify

%w(raw default pretty ascii).freeze
SLUGIFY_RAW_REGEXP = 
Regexp.new('\\s+').freeze
SLUGIFY_DEFAULT_REGEXP = 
Regexp.new("[^[:alnum:]]+").freeze
SLUGIFY_PRETTY_REGEXP = 
Regexp.new("[^[:alnum:]._~!$&'()+,;=@]+").freeze
SLUGIFY_ASCII_REGEXP = 
Regexp.new("[^[A-Za-z0-9]]+").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



319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/j1/utils.rb', line 319

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.



99
100
101
 
# File 'lib/j1/utils.rb', line 99

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.



112
113
114
115
116
117
118
 
# File 'lib/j1/utils.rb', line 112

def deep_merge_hashes!(target, overwrite)
  merge_values(target, overwrite)
  merge_default_proc(target, overwrite)
  duplicate_frozen_values(target)

  target
end

#duplicable?(obj) ⇒ Boolean

Returns:

  • (Boolean) 


124
125
126
127
128
129
130
131
 
# File 'lib/j1/utils.rb', line 124

def duplicable?(obj)
  case obj
  when nil, false, true, Symbol, Numeric
    false
  else
    true
  end
end

#has_yaml_header?(file) ⇒ Boolean

Determines whether a given file has

Returns true if the YAML front matter is present. rubocop: disable PredicateName

Returns:

  • (Boolean) 


208
209
210
211
212
 
# File 'lib/j1/utils.rb', line 208

def has_yaml_header?(file)
  !!(File.open(file, "rb", &:readline) =~ %r!\A---\s*\r?\n!)
rescue EOFError
  false
end

#is_project? ⇒ Boolean

Returns:

  • (Boolean) 


44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 
# File 'lib/j1/utils.rb', line 44

def is_project?
  path = File.expand_path(Dir.pwd)
  timestamp = Time.now.strftime("%Y-%m-%d %H:%M:%S")
  puts "#{timestamp} - PREFLIGHT: check consistency of the J1 project folder .."
  if File.exist?(path + '/package.json') && File.exist?(path + '/_config.yml')
    puts "#{timestamp} - PREFLIGHT: consistency checks successful .."
    puts "#{timestamp} - PREFLIGHT: consistency checks done."
    return true
  else
    puts "#{timestamp} - PREFLIGHT: consistency checks failed .."
    puts "#{timestamp} - PREFLIGHT: project on path #{path} seems not a valid project folder .."
    puts "#{timestamp} - PREFLIGHT: consistency checks done."
    return false
  end
end

#is_project_setup? ⇒ Boolean

Returns:

  • (Boolean) 


60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/j1/utils.rb', line 60

def is_project_setup?
  path = File.expand_path(Dir.pwd)
  timestamp = Time.now.strftime("%Y-%m-%d %H:%M:%S")
  puts "#{timestamp} - PREFLIGHT: check setup state of the J1 project .."
  if File.exist?(path + '/package-lock.json') && File.exist?(path + '/Gemfile.lock')
    puts "#{timestamp} - PREFLIGHT: setup checks successful .."
    puts "#{timestamp} - PREFLIGHT: setup checks done."
    puts " "
    return true
  else
    puts "#{timestamp} - PREFLIGHT: setup checks failed .."
    puts "#{timestamp} - PREFLIGHT: project in path #{path} seems not initialized .."
    puts "#{timestamp} - PREFLIGHT: consider to run 'j1 setup' first in order to prepare the project for first use .."
    puts "#{timestamp} - PREFLIGHT: setup checks done."
    puts " "
    return false
  end
end

#is_windows? ⇒ Boolean

Returns:

  • (Boolean) 


79
80
81
82
 
# File 'lib/j1/utils.rb', line 79

def is_windows?
  #noinspection RubyResolve
  RbConfig::CONFIG["host_os"] =~ %r!mswin|mingw|cygwin!i
end

#mergable?(value) ⇒ Boolean

Returns:

  • (Boolean) 


120
121
122
 
# File 'lib/j1/utils.rb', line 120

def mergable?(value)
  value.is_a?(Hash) || value.is_a?(Drops::Drop)
end

#merged_file_read_opts(site, opts) ⇒ Object

Returns merged option hash for File.read of self.site (if exists) and a given param



368
369
370
371
372
373
374
 
# File 'lib/j1/utils.rb', line 368

def merged_file_read_opts(site, opts)
  merged = (site ? site.file_read_opts : {}).merge(opts)
  if merged["encoding"] && !merged["encoding"].start_with?("bom|")
    merged["encoding"].insert(0, "bom|")
  end
  merged
end

#parse_date(input, msg = "input could not 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



198
199
200
201
202
 
# File 'lib/j1/utils.rb', line 198

def parse_date(input, msg = "input could not parsed.")
  Time.parse(input).localtime
rescue ArgumentError
  raise Errors::InvalidDateError, "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



141
142
143
144
145
146
147
 
# File 'lib/j1/utils.rb', line 141

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

#safe_glob(dir, patterns, flags = 0) ⇒ Object

Work the same way as Dir.glob but seperating the input into two parts (‘dir’ + ‘/’ + ‘pattern’) to make sure the first part(‘dir’) does not act as a pattern.

For example, Dir.glob(“path[/*”) always returns an empty array, because the method fails to find the closing pattern to ‘[’ which is ‘]’

Examples:

safe_glob("path[", "*")
# => ["path[/file1", "path[/file2"]

safe_glob("path", "*", File::FNM_DOTMATCH)
# => ["path/.", "path/..", "path/file1"]

safe_glob("path", ["**", "*"])
# => ["path[/file1", "path[/folder/file2"]

dir - the dir where glob will be executed under

(the dir will be included to each result)

patterns - the patterns (or the pattern) which will be applied under the dir flags - the flags which will be applied to the pattern

Returns matched pathes



356
357
358
359
360
361
362
363
 
# File 'lib/j1/utils.rb', line 356

def safe_glob(dir, patterns, flags = 0)
  return [] unless Dir.exist?(dir)
  pattern = File.join(Array(patterns))
  return [dir] if pattern.empty?
  Dir.chdir(dir) do
    Dir.glob(pattern, flags).map { |f| File.join(dir, f) }
  end
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.

When mode is “ascii”, some everything else except ASCII characters a-z (lowercase), A-Z (uppercase) and 0-9 (numbers) 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"

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

Returns the slugified string



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/j1/utils.rb', line 254

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
    when "ascii"
      # For web servers not being able to handle Unicode, the safe
      # method is to ditch anything else but latin letters and numeric
      # digits.
      SLUGIFY_ASCII_REGEXP
    end

  # Strip according to the mode
  slug = string.gsub(re, "-")

  # Remove leading/trailing hyphen
  slug.gsub!(%r!^\-|\-$!i, "")

  slug.downcase! unless cased
  slug
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



187
188
189
 
# File 'lib/j1/utils.rb', line 187

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

#strip_heredoc(str) ⇒ Object

Takes an indented string and removes the preceding spaces on each line



86
87
88
 
# File 'lib/j1/utils.rb', line 86

def strip_heredoc(str)
  str.gsub(%r!^[ \t]{#{(str.scan(%r!^[ \t]*(?=\S)!).min || "").size}}!, "")
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



178
179
180
 
# File 'lib/j1/utils.rb', line 178

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

#titleize_slug(slug) ⇒ Object

Takes a slug and turns it into a simple title.



92
93
94
 
# File 'lib/j1/utils.rb', line 92

def titleize_slug(slug)
  slug.split("-").map!(&:capitalize).join(" ")
end

#transform_keys(hash) ⇒ Object 



165
166
167
168
169
170
171
 
# File 'lib/j1/utils.rb', line 165

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 



153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/j1/utils.rb', line 153

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 



149
150
151
 
# File 'lib/j1/utils.rb', line 149

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