Module: ShellHelpers::Export

Extended by:
Export
Included in:
ShellHelpers, Export
Defined in:
lib/shell_helpers/export.rb

Constant Summary collapse

ImportError = 
Class.new(StandardError)
ExportError = 
Class.new(StandardError)

Instance Method Summary collapse

Instance Method Details

#escape_name(name, prefix: "", upcase: true) ⇒ Object 



48
49
50
51
52
 
# File 'lib/shell_helpers/export.rb', line 48

def escape_name(name, prefix:"", upcase: true)
  name=name.to_s
  name=name.upcase if upcase
  (prefix+name).gsub('/','_')
end

#export_parse(hash, s) ⇒ Object

export_parse(hash,"name:value") will output name=$(hash[value]) special cases: when value = '/' we return the full hash when value ends by /, we return the splitted hash (and name serves as a prefix) Ex: Numenor ~ $ ./mine/00COMPUTERS.rb --export=// HOSTNAME=Numenor; HOSTTYPE=perso; HOMEPATH=/home/dams;... Numenor ~ $ ./mine/00COMPUTERS.rb --export=syst/ LAPTOP=true; ARCH=i686;... Remark: in name:value, we don't put name in uppercase But in split hash mode, we put the keys in uppercase (to prevent collisions)



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/shell_helpers/export.rb', line 110

def export_parse(hash,s)
  r=""
  args=DR::SimpleParser.parse_string(s.to_s)
  args[:values].each do |k,v|
    if v
      name=k.to_s
    else
      #no name given
      v=k.to_s
      if v !='/' && v[-1]=='/'
        #in split mode we don't need the name
        name="" 
      else
        #else since no name was given we reuse the variable
        name=v
        name="all" if v=="/"
      end
    end
    if v != '/' && v[-1]=='/'
      all=true
      v=v[0...-1]
    end
    value=hash.keyed_value(v)
    opts=args[:opts][k]
    if all
      r+=export_variables(value, prefix: name, **opts)
    else
      r+=export_variable(name,value, **opts)
    end
  end
  return r
end

#export_value(v) ⇒ Object

export a value for SHELL consumption



11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
 
# File 'lib/shell_helpers/export.rb', line 11

def export_value(v)
  case v
    when String
      return v.shellescape
    when Array
      return "(#{v.map {|i| i.to_s.shellescape}.join(' ')})"
    when Hash
      return "(#{v.map {|k,v| k.to_s.shellescape+" "+v.to_s.shellescape}.join(' ')})"
    when nil
      return ""
    when ->(x){x.respond_to?(:to_a)}
      return export_value(v.to_a)
    when ->(x){x.respond_to?(:to_h)}
      return export_value(v.to_h)
    else
      return v.to_s.shellescape
  end
end

#export_variable(name, value, local: false, export: false, prefix: "", upcase: true) ⇒ Object

export_variable("ploum","plam") yields ploum="plam"



55
56
57
58
59
60
61
62
63
 
# File 'lib/shell_helpers/export.rb', line 55

def export_variable(name, value, local: false, export: false, prefix:"",upcase:true)
  r=""
  name=escape_name(name,prefix:prefix,upcase:upcase)
  r+="local #{name}\n" if local
  r+="typeset -A #{name}\n" if Hash === value
  r+="#{name}=#{export_value(value)}\n"
  r+="export #{name}\n" if export
  return r
end

#export_variables(hash, inline: false, local: false, export: false, prefix: "", upcase: true) ⇒ Object

from plim return something like PLOUM=plim that can be evaluated by the shell



85
86
87
88
89
90
91
92
93
94
 
# File 'lib/shell_helpers/export.rb', line 85

def export_variables(hash, inline: false, local: false, export: false, prefix:"",upcase:true)
  names=hash.keys.map {|s| escape_name(s,prefix:prefix,upcase:upcase)}
  r=""
  r+="local #{names.join(" ")}\n" if local
  r+=hash.map do |k,v|
    export_variable(k,v,prefix:prefix,upcase:upcase).chomp
  end.join(inline ? " " : "\n") + (inline ? "" : "\n")
  r+="export #{names.join(" ")}\n" if export
  return r
end

#import_parse(s, split_on: :auto, var_separator: '/', inline: false) ⇒ Object 



143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/shell_helpers/export.rb', line 143

def import_parse(s, split_on: :auto, var_separator:'/', inline: false)
  r={}
  if split_on == :auto
    split_on=","
    split_on="\n" if s =~ /\n/
  end
  if s.is_a?(Enumerable)
    instructions=s
  else
    instructions=s.split(split_on)
  end
  instructions.each do |namevalue|
    if inline
      name,value=DR::SimpleParser.parse_namevalue(optvalue,sep:'=')
    else
      name,value=import_variable(namevalue)
    end
    if name
      r.set_keyed_value(name,value, sep: var_separator)
    else
      raise ImportError.new("Cannot parse #{s}")
    end
  end
  r
end

#import_value(v, type: String, unquote: true) ⇒ Object 



29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/shell_helpers/export.rb', line 29

def import_value(v, type: String, unquote: true)
  #String === String => false
  case type.to_s
  when "String"
    v.gsub!(/\A['"]+|['"]+\Z/, "") if unquote
    v.to_s
  when "Integer"
    v.to_i
  when "Symbol"
    v.to_sym
  when "Array"
    #v is of the form (ploum plam)
    #TODO: handle quotes in the array
    eval "%w#{v}"
  when "Hash"
    import_value(v, type: Array).each_slice(2).to_h
  end
end

#import_variable(namevalue, downcase: true, type: :auto) ⇒ Object 



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/shell_helpers/export.rb', line 65

def import_variable(namevalue, downcase:true, type: :auto)
  namevalue.match(/(local|export)?\s*(\S*)=(.*)$/) do |m|
    _match,_type,name,value=m.to_a
    name=name.downcase if downcase
    if type == :auto
      if value=~/^\(.*\)$/
        value=import_value(value, type: Array)
      else
        value=import_value(value)
      end
    else
      value=import_value(value, type: type)
    end
    return name, value
  end
end