Module: Mkalias

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

Overview

Module to manage alias

Constant Summary collapse

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

Class Method Summary collapse

Class Method Details

.add_signal(file_path = BASHRC_PATH) ⇒ Object 



62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/mkalias.rb', line 62

def add_signal(file_path = BASHRC_PATH)
  return false if Mkalias.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

  true
end

.get_alias_command(alias_name, file_path = BASHRC_PATH) ⇒ Object 



90
91
92
93
94
95
96
97
98
99
100
101
 
# File 'lib/mkalias.rb', line 90

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

  command_regex = /mkalias_#{alias_name}\(\)[{](.+)[;]/

  file_text = File.open(file_path, &:read)
  commands = file_text.scan(command_regex).flatten.first
  commands = commands.split(';').each(&:strip!) if commands

  commands
end

.list_alias(file_path = BASHRC_PATH) ⇒ Object 



28
29
30
31
32
33
34
35
 
# File 'lib/mkalias.rb', line 28

def list_alias(file_path = BASHRC_PATH)
  alias_regex = /mkalias_(.*?)\(/

  file_text = File.open(file_path, &:read)
  alias_names = file_text.scan(alias_regex).flatten

  alias_names
end

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



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

def 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#{bash_alias}\n#{bash_function}")
  end

  true
end

.prepare_commands(commands) ⇒ Object 



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

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

  commands
end

.remove_alias(alias_names, file_path = BASHRC_PATH) ⇒ Object 



50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/mkalias.rb', line 50

def remove_alias(alias_names, file_path = BASHRC_PATH)
  alias_names = [alias_names] unless alias_names.is_a?(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 



103
104
105
106
107
108
109
110
111
112
 
# File 'lib/mkalias.rb', line 103

def 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 } }
end

.remove_signal(file_path = BASHRC_PATH) ⇒ Object 



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

def remove_signal(file_path = BASHRC_PATH)
  return false unless 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 } }

  true
end

.show_alias(alias_names, file_path = BASHRC_PATH) ⇒ Object 



37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/mkalias.rb', line 37

def show_alias(alias_names, file_path = BASHRC_PATH)
  alias_names = [alias_names] unless alias_names.is_a?(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

.signal?(file_path = BASHRC_PATH) ⇒ Boolean

Returns:

  • (Boolean) 


85
86
87
88
 
# File 'lib/mkalias.rb', line 85

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