Module: Mkalias

Defined in:
lib/mkalias.rb,
lib/mkalias/version.rb

Constant Summary collapse

SIGNAL_NAME = 
'USR1'
BASHRC_PATH = 
"#{File.expand_path('~')}/.bashrc"
VERSION = 
"1.0.4"

Class Method Summary collapse

Class Method Details

.add_signal(file_path = BASHRC_PATH) ⇒ Object 



67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/mkalias.rb', line 67

def self.add_signal(file_path=BASHRC_PATH)
  return false if Mkalias.has_signal?(file_path)

  trap_command = "trap 'source #{file_path}' #{SIGNAL_NAME}"
  open(file_path, 'a') do |file|
    file.puts("\n")
    file.puts(trap_command)
  end

  return true
end

.get_alias_command(alias_name, file_path = BASHRC_PATH) ⇒ Object 



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'lib/mkalias.rb', line 95

def self.get_alias_command(alias_name, file_path=BASHRC_PATH)
  alias_names = Mkalias.list_alias(file_path)
  return nil unless alias_names.include?(alias_name)

  alias_regex = /\bmkalias_#{alias_name}[(]/
  command_regex = /[{](.*)[;]/

  alias_commands = File.foreach(file_path).grep(alias_regex)

  alias_commands.each do |command|
    result = command.match(command_regex)
      return result.captures.first.split(';').each{ |c| c.strip! } if result
  end

  return nil
end

.has_signal?(file_path = BASHRC_PATH) ⇒ Boolean

Returns:

  • (Boolean) 


90
91
92
93
 
# File 'lib/mkalias.rb', line 90

def self.has_signal?(file_path=BASHRC_PATH)
  trap_regex = /\btrap\s'source\s(.*)\sUSR1/
  !File.foreach(file_path).grep(trap_regex).empty?
end

.list_alias(file_path = BASHRC_PATH) ⇒ Object 



28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/mkalias.rb', line 28

def self.list_alias(file_path=BASHRC_PATH)
  alias_names = Set.new

  alias_regex = /\bmkalias_(.*)[(]/

  alias_functions = File.foreach(file_path).grep(alias_regex)
  alias_functions.each do |function|
    result = function.match(alias_regex)
    alias_names << result.captures.first if result
  end

  alias_names.to_a
end

.new_alias(alias_name, commands, file_path = BASHRC_PATH) ⇒ Object 



9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
 
# File 'lib/mkalias.rb', line 9

def self.new_alias(alias_name, commands, file_path=BASHRC_PATH)
  alias_names = Mkalias.list_alias(file_path)
  return false if alias_names.include?(alias_name)

  commands = Mkalias.prepare_commands(commands)

  function_name = "mkalias_#{alias_name}"
  bash_function = "function #{function_name}(){ #{commands}; }"
  bash_alias = "alias #{alias_name}='#{function_name}'"

  open(file_path, 'a') do |file|
    file.puts("\n")
    file.puts(bash_alias)
    file.puts(bash_function)
  end

  return true
end

.prepare_commands(commands) ⇒ Object 



125
126
127
128
129
130
131
132
133
 
# File 'lib/mkalias.rb', line 125

def self.prepare_commands(commands)
  commands = commands.join('; ') if commands.kind_of?(Array)
  unless commands.include?(';') or commands.include?('#')
      commands = "#{commands} $@"
  end
  commands = commands.tr('#', '$')

  commands
end

.remove_alias(alias_names, file_path = BASHRC_PATH) ⇒ Object 



55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/mkalias.rb', line 55

def self.remove_alias(alias_names, file_path=BASHRC_PATH)
  alias_names = [alias_names] unless alias_names.kind_of?(Array)

  removed_alias = []
  alias_names.each do |alias_name|
    removed = Mkalias.remove_one_alias(alias_name, file_path)
    removed_alias << alias_name if removed
  end

  removed_alias
end

.remove_one_alias(alias_name, file_path = BASHRC_PATH) ⇒ Object 



112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/mkalias.rb', line 112

def self.remove_one_alias(alias_name, file_path=BASHRC_PATH)
  alias_names = Mkalias.list_alias(file_path)
  return false unless alias_names.include?(alias_name)

  alias_regex = /\bmkalias_#{alias_name}[(']/

  lines = File.readlines(file_path).reject{ |line| line =~ alias_regex }

  File.open(file_path, "w"){ |f| lines.each { |line| f.puts line } }

  return true
end

.remove_signal(file_path = BASHRC_PATH) ⇒ Object 



79
80
81
82
83
84
85
86
87
88
 
# File 'lib/mkalias.rb', line 79

def self.remove_signal(file_path=BASHRC_PATH)
  return false unless has_signal?(file_path)

  trap_regex = /\btrap\s'source\s(.*)\sUSR1/

  lines = File.readlines(file_path).reject{ |line| line =~ trap_regex }
  File.open(file_path, "w"){ |f| lines.each { |line| f.puts line } }

  return true
end

.show_alias(alias_names, file_path = BASHRC_PATH) ⇒ Object 



42
43
44
45
46
47
48
49
50
51
52
53
 
# File 'lib/mkalias.rb', line 42

def self.show_alias(alias_names, file_path=BASHRC_PATH)
  alias_names = [alias_names] unless alias_names.kind_of?(Array)

  alias_commands = {}
  alias_names.each do |alias_name|
    alias_commands[alias_name] = Mkalias.get_alias_command(alias_name,
                                                             file_path)
  end

  alias_commands.select!{ |_, value| !value.nil? }
  alias_commands
end