Class: AbstractCommand

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

Overview

Shell Command Abstraction.

Hides away all the details to generate a command. And privides an easy interface to interact with shell commands as if they were objects.

This is good for the following reasons:

  1. Stadardization.

  2. Simplicity of code.

  3. Reduces smells in methods that interpolate values.

  4. Provides an elegant way to interact shell objects.

  5. Secure ensures that shell commands are executed safely.

Constant Summary collapse

VARIABLE_REGEX =

‘%<name>s’.scan(/(%<)(w+)(>)/)

> [[“%<”, “name”, “>”]]

/(%<)(\w+)(>)/

Instance Method Summary collapse

Constructor Details

#initialize(properties = {}) ⇒ AbstractCommand

Returns a new instance of AbstractCommand.



34
35
36
37
38
39
40
41
42
 
# File 'lib/abstract_command.rb', line 34

def initialize(properties = {})
  variables.each do |variable|
    self.class.send(:attr_accessor, variable.to_sym)
  end
  properties.each do |key, value|
    setter = (key.to_s + '=').to_sym
    send(setter, value)
  end
end

Instance Method Details

#backtick ⇒ Object 



57
58
59
 
# File 'lib/abstract_command.rb', line 57

def backtick
  `#{to_s}`
end

#system ⇒ Object 



53
54
55
 
# File 'lib/abstract_command.rb', line 53

def system
  Kernel.system(to_s)
end

#template ⇒ Object 



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

def template
  raise 'must implement'
end

#to_s ⇒ Object 



44
45
46
47
48
49
50
51
 
# File 'lib/abstract_command.rb', line 44

def to_s
  bindings = {}
  variables.each do |variable|
    value = instance_variable_get("@#{variable}")
    bindings[variable.to_sym] = "#{value}".shellescape
  end
  format(template % bindings)
end

#variables ⇒ Object 



26
27
28
29
30
31
32
 
# File 'lib/abstract_command.rb', line 26

def variables
  result = []
  template.scan(VARIABLE_REGEX).each do |variable|
    result.push(variable[1])
  end
  result
end