Class: BinScript
- Inherits:
-
Object
- Object
- BinScript
- Includes:
- ClassLevelInheritableAttributes
- Defined in:
- lib/bin_script/bin_script.rb,
lib/bin_script/version.rb
Overview
require ‘active_support/core_ext/class/attribute.rb’
Constant Summary collapse
- VERSION =
"0.1.8"
- PARAMETER_TYPES =
Allowed parameter types. Equivalence aliases with GetoptLong constants.
{ :noarg => GetoptLong::NO_ARGUMENT, :optional => GetoptLong::OPTIONAL_ARGUMENT, :required => GetoptLong::REQUIRED_ARGUMENT }
Instance Attribute Summary collapse
-
#exit_status ⇒ Object
Place for store exit status.
-
#logger ⇒ Object
Place for logger object.
Class Method Summary collapse
- .bin_name ⇒ Object
-
.calculate_script_class_filename(parts) ⇒ Object
Prepare class name from filename parts.
-
.calculate_script_class_name(parts) ⇒ Object
Prepare class name from filename parts.
-
.get_argv_values ⇒ Object
Prepare ARGV parameters as hash.
-
.get_parameter(key) ⇒ Object
Get parameter by key.
-
.parse_script_file_name(filename) ⇒ Object
Parse script filename.
-
.remove_parameter(key) ⇒ Object
Remove parameter.
-
.run_script(filename = $0) ⇒ Object
Run script detected by the filename of source script file.
-
.script_name ⇒ Object
Prepare readable script name.
-
.usage(message = nil) ⇒ Object
Prepare usage message.
Instance Method Summary collapse
- #check_required_params ⇒ Object
-
#do! ⇒ Object
Dummy for do! method.
-
#initialize ⇒ BinScript
constructor
Initialize script.
-
#lock_filename ⇒ Object
Prepare filename of log file.
-
#log_filename ⇒ Object
Prepare filename of log file.
-
#override_parameters(args) ⇒ Object
Override one or more parameters for testing purposes.
-
#params(key) ⇒ Object
Return parameter value by key.
- #puts(*arg) ⇒ Object
-
#run! ⇒ Object
Create lock file, call script code and unlock file even if error happend.
-
#usage_exit(message = nil) ⇒ Object
Print usage message and exit.
Methods included from ClassLevelInheritableAttributes
Constructor Details
#initialize ⇒ BinScript
Initialize script
230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 |
# File 'lib/bin_script/bin_script.rb', line 230 def initialize begin @source_argv = ARGV.dup @overrided_parameters = {} @params_values = (RailsStub.env == 'test' ? {} : self.class.get_argv_values) # Create logger if logging enabled if self.class.enable_logging @logger = XLogger.new(:file => log_filename, :dont_touch_rails_logger => (RailsStub.env == 'test')) @logger.level = self.class.log_level end rescue GetoptLong::InvalidOption, GetoptLong::MissingArgument, GetoptLong::NeedlessArgument => e usage_exit e. end end |
Instance Attribute Details
#exit_status ⇒ Object
Place for store exit status.
54 55 56 |
# File 'lib/bin_script/bin_script.rb', line 54 def exit_status @exit_status end |
#logger ⇒ Object
Place for logger object
51 52 53 |
# File 'lib/bin_script/bin_script.rb', line 51 def logger @logger end |
Class Method Details
.bin_name ⇒ Object
89 90 91 |
# File 'lib/bin_script/bin_script.rb', line 89 def bin_name script_name.gsub('_script', '') end |
.calculate_script_class_filename(parts) ⇒ Object
Prepare class name from filename parts
121 122 123 124 125 126 127 128 129 130 131 132 133 134 |
# File 'lib/bin_script/bin_script.rb', line 121 def calculate_script_class_filename(parts) files = [] # Collect from disk, needed class files parts.each do |p| off = "app/{bin,bins,models,script,scripts}/**/#{p}_script.rb" files += Dir[File.join(RailsStub.root, off)] off = "script/**/#{p}_script.rb" files += Dir[File.join(RailsStub.root, off)] end files.reverse end |
.calculate_script_class_name(parts) ⇒ Object
Prepare class name from filename parts
110 111 112 113 114 115 116 117 118 |
# File 'lib/bin_script/bin_script.rb', line 110 def calculate_script_class_name(parts) # Calculate class name and paths from source script filename parts if(parts.length > 1) class_name = parts.map{|p| p.camelize}.join('::') + parts.first.camelize else class_name = parts.first.camelize end class_name += "Script" end |
.get_argv_values ⇒ Object
Prepare ARGV parameters as hash
175 176 177 178 179 180 181 |
# File 'lib/bin_script/bin_script.rb', line 175 def get_argv_values values = {} o = GetoptLong.new(*get_getoptlong_params) o.quiet = true # Don't write arg error to STDERR o.each { |opt, arg| values[opt[1..-1].to_sym] = arg } values end |
.get_parameter(key) ⇒ Object
Get parameter by key
78 79 80 81 82 |
# File 'lib/bin_script/bin_script.rb', line 78 def get_parameter(key) param = @parameters.find{|p| p[:key] == key || (p[:alias].present? && p[:alias].include?(key))} raise "Can't find parameter with key #{key.inspect} for class #{self.inspect}!" if param.nil? param end |
.parse_script_file_name(filename) ⇒ Object
Parse script filename. Extract important path parts
94 95 96 97 98 99 100 101 102 103 104 105 106 107 |
# File 'lib/bin_script/bin_script.rb', line 94 def parse_script_file_name(filename) result = {} # Prepare important parts of source script filename parts = filename.split(File::SEPARATOR) parts = parts[parts.index('bin')+1..-1] parts.map!{|p| File.basename(p).split('.').first} result[:parts] = parts result[:class] = calculate_script_class_name(parts) result[:files] = calculate_script_class_filename(parts) result end |
.remove_parameter(key) ⇒ Object
Remove parameter
168 169 170 171 172 |
# File 'lib/bin_script/bin_script.rb', line 168 def remove_parameter(key) new = [] @parameters.each { |p| new << p if p[:key] != key } @parameters = new end |
.run_script(filename = $0) ⇒ Object
Run script detected by the filename of source script file
137 138 139 140 141 142 143 144 145 146 147 148 |
# File 'lib/bin_script/bin_script.rb', line 137 def run_script(filename = $0) cfg = parse_script_file_name(Pathname.new(filename).realpath.to_s) cfg[:files].each { |f| require f } # Create instance and call run! for script class klass = cfg[:class].constantize script = klass.new script.run! # Exit with specified exit status exit script.exit_status || 0 end |
.script_name ⇒ Object
Prepare readable script name
85 86 87 |
# File 'lib/bin_script/bin_script.rb', line 85 def script_name self.to_s.underscore.gsub('/','__') end |
.usage(message = nil) ⇒ Object
Prepare usage message
184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 |
# File 'lib/bin_script/bin_script.rb', line 184 def usage( = nil) usage_msg = '' usage_msg += "Error: #{}\n\n" unless .nil? usage_msg += "Use: ./bin/#{bin_name}.rb [OPTIONS]\n\n" usage_msg += "\"#{self.description}\"\n\n" if .nil? && self.description.present? usage_msg += "Availible options:\n\n" @parameters.each do |param| arg = case param[:type] when :required then " v " when :optional then "[v]" when :noarg then " " end usage_msg += " #{prefix_key param[:key]}#{arg} #{param[:description]}\n" end usage_msg += "\n" usage_msg end |
Instance Method Details
#check_required_params ⇒ Object
247 248 249 250 251 252 253 254 255 256 |
# File 'lib/bin_script/bin_script.rb', line 247 def check_required_params self.class.parameters.each do |param| if param[:type] == :required && @params_values.has_key?(param[:key]) if @params_values[param[:key]].nil? error "Param #{param[:key]} require value, but not present" usage_exit end end end end |
#do! ⇒ Object
Dummy for do! method
332 |
# File 'lib/bin_script/bin_script.rb', line 332 def do!; end |
#lock_filename ⇒ Object
Prepare filename of log file
364 365 366 |
# File 'lib/bin_script/bin_script.rb', line 364 def lock_filename params(:L).blank? ? File.join(RailsStub.root, 'locks', "#{self.class.script_name}.lock") : params(:L) end |
#log_filename ⇒ Object
Prepare filename of log file
369 370 371 |
# File 'lib/bin_script/bin_script.rb', line 369 def log_filename params(:l).blank? ? File.join(RailsStub.root, 'log', "#{self.class.script_name}#{log_filename_time_part}.log") : params(:l) end |
#override_parameters(args) ⇒ Object
Override one or more parameters for testing purposes
335 336 337 338 339 340 341 342 343 |
# File 'lib/bin_script/bin_script.rb', line 335 def override_parameters(args) if args.is_a?(Symbol) override_parameter(self.class.get_parameter(args)) elsif args.is_a?(Hash) args.each{|key, value| override_parameter(self.class.get_parameter(key), value)} else raise "Parameter should be Symbol or Hash" end end |
#params(key) ⇒ Object
Return parameter value by key
346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 |
# File 'lib/bin_script/bin_script.rb', line 346 def params(key) param = self.class.get_parameter(key) # Use dafault key (if call by alias) key = param[:key] case param[:type] when :noarg return (@overrided_parameters.has_key?(key) && @overrided_parameters[key]) || !@params_values[key].nil? when :optional return @overrided_parameters[key] || @params_values[key] || param[:default] when :required value = @overrided_parameters[key] || @params_values[key] || param[:default] return value end end |
#puts(*arg) ⇒ Object
224 225 226 227 |
# File 'lib/bin_script/bin_script.rb', line 224 def puts(*arg) return if self.class.disable_puts_for_tests && RailsStub.env == 'test' Kernel.puts(*arg) end |
#run! ⇒ Object
Create lock file, call script code and unlock file even if error happend.
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 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 |
# File 'lib/bin_script/bin_script.rb', line 259 def run! # Print usage and exit if asked usage_exit if params(:h) check_required_params # Create and check lock file if enabled if self.class.enable_locking @lock = LockFile.new(lock_filename) @lock.quiet = true # Don't write errors to STDERR if(@lock.lock) msg = "--- Try start. Buy lock file '#{@lock.path}' already open in exclusive mode. Exit! ---" # puts msg # puts is not good idea, because cron will mail it, but this is not error warn msg exit end end begin # Log important info and call script job info "" log_params = {:env => RailsStub.env, :log_level => (self.class.enable_logging ? @logger.level : nil), :lock_file => (self.class.enable_locking ? @lock.path : nil)} info "> Script #{self.class.script_name} started! (#{log_params.inspect})" info "- Parameters: #{@params_values.inspect}" start = Time.now # Инкрементируем счетчик запусков этого скрипта inc_counter("#{self.class.script_name}_times") do! duration = Time.now - start info "< Script #{self.class.script_name} finished! (#{"%.4f" % duration.to_f} sec)" info "Exit status: #{@exit_status}" if @exit_status # Инкрементируем время работы э inc_counter("#{self.class.script_name}_long", duration) # Log benchmarker info if it's not empty log_benchmarker_data rescue Exception => e # Print error info if it's not test env or exit exit_mes = (e.class == SystemExit) || (e.class == Interrupt) || (e.class == SignalException) || (RailsStub.env == 'test') unless exit_mes msg = self.class.(e) puts "\n" + msg fatal msg notify_about_error(e) else error "Get exit message! #{e.}" end # Инкрементируем счетчик ошибок этого скрипта inc_counter("#{self.class.script_name}_raised") ensure # Unlock lock file @lock.unlock if self.class.enable_locking && @lock end end |
#usage_exit(message = nil) ⇒ Object
Print usage message and exit
325 326 327 328 329 |
# File 'lib/bin_script/bin_script.rb', line 325 def usage_exit( = nil) error "Exit with error message: #{}" if .present? Kernel.puts(self.class.usage()) exit end |