Class: Hash

Inherits:

Object

• Object
• Hash

Includes:

ForceArray

Defined in:

lib/liquidoc.rb

Instance Method Summary

• #argify(options = {}) ⇒ Object
• #to_array(op = nil) ⇒ Object

Methods included from ForceArray

#force_array, #force_array!

Instance Method Details

#argify(options = {}) ⇒ Object

# File 'lib/liquidoc.rb', line 1358

def argify options = {}
  # Converts a hash of key-value pairs to command-line option/argument listings
  # Can be called with optional arguments:
  # template :: Liquid-formatted parsing template string
  #          Accepts:
  #
  #            'hyph'            :: -<key> <value>
  #            'hyphhyph'        :: --<key> <value> (default)
  #            'hyphchar'        :: -<k> <value>
  #            'dump'            :: <key> <value>
  #            'paramequal'      :: <key>=<value>
  #            'valonly'         :: <value>
  # delim    :: Delimiter -- any ASCII characters that separate the arguments
  #
  # For template-based usage, express the variables:
  #    opt (the keyname) as {{opt}}
  #    arg (the value) as {{arg}}
  # EXAMPLES (my_hash = {"key1"=>"val1", "key2"=>"val2"})
  # my_hash.argify                      #=> key1 val1 key2 val2
  # my_hash.argify('hyphhyph')          #=> --key1 val1 --key2 val2
  # my_hash.argify('paramequal')        #=> key1=val1 key2=val2
  # my_hash.argify('-a {{opt}}={{arg}}')#=> -a key1=val1 -a key2=val2
  # my_hash.argify('valonly', '||')     #=> val1||val2
  # my_hash.argify("{{opt}} `{{arg}}`") #=> key1 `val1` key2 `val2`
  raise "InvalidObject" unless self.is_a? Hash
  template = options.fetch(:template, 'hyphhyph')
  if template.contains_liquid?
    tp = template # use the passed Liquid template
  else
    case template # use a preset Liquid template by name
    when "dump"
      tp = "{{opt}} {{arg | quote_wrap: 'single', '\s|,' }}"
    when "hyph"
      tp = "-{{opt}} {{arg | quote_wrap: 'single', '\s|,' }}"
    when "hyphhyph"
      tp = "--{{opt}} {{arg | quote_wrap: 'single', '\s|,' }}"
    when "paramequal"
      tp = "{{opt}}={{arg | quote_wrap: 'single', '\s|,' }}"
    when "valonly"
      tp = "{{arg | quote_wrap: 'single', '\s|,' }}"
    else
      return "Liquid: Unrecognized argify template name: #{template}"
    end
  end
  begin
    tpl = Liquid::Template.parse(tp)
    first = true
    out = ''
    self.each do |k,v|
      # establish datasource
      v = "<Object>" if v.is_a? Hash
      v = v.join(',') if v.is_a? Array
      input = {"opt" => k.to_s, "arg" => v.to_s }
      if first
        dlm = ""
        first = false
      else
        dlm = options.fetch(:delim, ' ')
      end
      out += dlm + tpl.render(input)
    end
  rescue
    raise "Argify template processing failed"
  end
  return out
end

#to_array(op = nil) ⇒ Object

# File 'lib/liquidoc.rb', line 1348

def to_array op=nil
  # Converts a hash of key-value pairs to a flat array based on the first tier
  out = []
  self.each do |k,v|
    v = "<RemovedObject>" if v.is_a? Enumerable and op == "flatten"
    out << {k => v}
  end
  return out
end