Class: Megam::Birr

Inherits:
Object
  • Object
show all
Defined in:
lib/megam/birr.rb

Overview

Main entry for the command line, after validating the class, run the install_file

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Birr

Create a new instance of the current class configured for the given arguments and options



37
38
 
# File 'lib/megam/birr.rb', line 37

def initialize()
end

Instance Attribute Details

#config ⇒ Object

Returns the value of attribute config.



23
24
25
 
# File 'lib/megam/birr.rb', line 23

def config
  @config
end

#text ⇒ Object

Returns the value of attribute text.



22
23
24
 
# File 'lib/megam/birr.rb', line 22

def text
  @text
end

Class Method Details

.msg(msg = "") ⇒ Object

I don’t think we need this method. Will remove it later. We need to just call text.msg



31
32
33
 
# File 'lib/megam/birr.rb', line 31

def self.msg(msg="")
  text.msg(msg)
end

.text ⇒ Object

text is used to print stuff in the terminal (message, log, info, warn etc.)



25
26
27
 
# File 'lib/megam/birr.rb', line 25

def self.text
  @text ||= Megam::Text.new(STDOUT, STDERR, STDIN, {})
end

Instance Method Details

#apply_computed_config ⇒ Object

Catch-all method that does any massaging needed for various config components, such as expanding file paths and converting verbosity level into log level.



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/megam/birr.rb', line 88

def apply_computed_config

  case config[:verbosity]
  when 0, nil
    config[:log_level] = :error
  when 1
    config[:log_level] = :info
  else
  config[:log_level] = :debug
  end

  Mixlib::Log::Formatter.show_time = false
  Megam::Log.init(config[:log_location] || STDOUT)
  Megam::Log.level(config[:log_level] || :error)
  
  config.each do |key, val| 
    Megam::Config[key] = val
  end
  
end

#configure_birr ⇒ Object

configure meggy, to startwith locate the config file under .meggy/Birr.rb Once located, read the Birr.rb config file. parse them, and report any ruby syntax errors. if not merge then inside Meggy::Config object.



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/megam/birr.rb', line 56

def configure_birr
  # look for a .birr/birr.rb for configuration. Not used currently.
  unless config[:install_file]
    locate_install_file
  end
  
  # Now load the installation file provided as input {-i} parm.
  if config[:install_file]
    @text.info "Using #{config[:install_file]}"
    apply_computed_config
    read_config_file(config[:install_file])
  else
    text.warn("No birr configuration file found")
  end

end

#highlight_config_error(file, line) ⇒ Object

ERROR: You have invalid ruby syntax in your config file /home/ram/.meggy/Birr.rb /home/ram/.meggy/Birr.rb:9: syntax error, unexpected ‘=’ Birr > = “admin”

^

# /home/ram/.meggy/Birr.rb

8: meggy_server_url          'http://localhost:6167'
9: Birr[:username] > = "admin"

10: Birr = “team4dog” Line 9 is marked in red, and the 3rd line where the error is show is highlighted in red. This is in case of a ruby parse error.



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

def highlight_config_error(file, line)
  config_file_lines = []

  # A file line is split into the line number (index) and the line content.
  # The line number is converted to string (to_s), right justified 3 characters with a colon, and its trimmed (chomp)

  IO.readlines(file).each_with_index {|l, i| config_file_lines << "#{(i + 1).to_s.rjust(3)}: #{l.chomp}"}
  # mark the appropriate line with a red color, if its just one line, then mark the zeroth line.
  # if not get the range (deducting 2), and mark the second line.
  if line == 1
    lines = config_file_lines[0..3]
    lines[0] = text.color(lines[0], :red)
  else
    lines = config_file_lines[Range.new(line - 2, line)]
    lines[1] = text.color(lines[1], :red)
  end
  text.msg ""
  # print the name of the file in white
  text.msg text.color(" # #{file}", :white)
  # print the rest of the line.
  lines.each {|l| text.msg(l)}
  text.msg ""
end

#locate_install_file ⇒ Object 



73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/megam/birr.rb', line 73

def locate_install_file
  # Look for $HOME/.meggy/birr.rb, this aint' supported currently
  # the idea is to allow configuration of the options used here.
  if ENV['HOME']
    user_config_file =  File.expand_path(File.join(ENV['HOME'], '.birr', 'birr.rb'))
  end

  if File.exist?(user_config_file)
    config[:install_file] = user_config_file
  end
end

#read_config_file(file) ⇒ Object

load the content as provided in -i installation_file ruby errors get reported or else the file is executed.



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/megam/birr.rb', line 111

def read_config_file(file)
self.instance_eval(IO.read(file), file, 1)
  rescue SyntaxError => e
@text.error "You have invalid ruby syntax in your config file #{file}"
@text.info(text.color(e.message, :red))
if file_line = e.message[/#{Regexp.escape(file)}:[\d]+/]
  line = file_line[/:([\d]+)$/, 1].to_i
  highlight_config_error(file, line)
end
exit 1
  rescue Exception => e
@text.error "You have an error in your config file #{file}"
@text.info "#{e.class.name}: #{e.message}"
filtered_trace = e.backtrace.grep(/#{Regexp.escape(file)}/)
filtered_trace.each {|line| text.msg(" " + text.color(line, :red))}
if !filtered_trace.empty?
  line_nr = filtered_trace.first[/#{Regexp.escape(file)}:([\d]+)/, 1]
  highlight_config_error(file, line_nr.to_i)
end

exit 1
end

#run(args = [], config = {}) ⇒ Object

Run Birr for the given args (ARGV), adding options to the list of CLI options that the subcommand knows how to handle.

Arguments

args:

usually ARGV

options:

A Mixlib::CLI option parser hash. These options are how

subcommands know about global Birr CLI options



46
47
48
49
50
51
 
# File 'lib/megam/birr.rb', line 46

def run(args=[], config={})
  @config = config.dup
  @text ||= Megam::Text.new(STDOUT, STDERR, STDIN, config)
  # configure your Birr.
  configure_birr
end