Class: Lolcommits::Installation

Inherits:
Object
  • Object
show all
Defined in:
lib/lolcommits/installation.rb,
lib/lolcommits/init.rb

Overview

Methods to handle enabling and disabling of lolcommits

Constant Summary collapse

HOOK_PATH = 
File.join '.git', 'hooks', 'post-commit'
HOOK_DIR = 
File.join '.git', 'hooks'

Class Method Summary collapse

Class Method Details

.do_disable ⇒ Object

IF –DISABLE, DO DISABLE



57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/lolcommits/installation.rb', line 57

def self.do_disable
  if lolcommits_hook_exists?
    remove_existing_hook!
    info "uninstalled lolcommits hook (from #{HOOK_PATH})"
  elsif File.exist?(HOOK_PATH)
    info "couldn't find an lolcommits hook (at #{HOOK_PATH})"
    if File.read(HOOK_PATH) =~ /lolcommit/
      info "warning: an older-style lolcommit hook may still exist, edit #{HOOK_PATH} to remove it manually"
    end
  else
    info "no post commit hook found (at #{HOOK_PATH}), so there is nothing to uninstall"
  end
end

.do_enable ⇒ Object

IF –ENABLE, DO ENABLE



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/lolcommits/installation.rb', line 13

def self.do_enable
  unless File.directory?('.git')
    fatal "You don't appear to be in the base directory of a git project."
    exit 1
  end

  # its possible a hooks dir doesnt exist, so create it if so
  Dir.mkdir(HOOK_DIR) unless File.directory?(HOOK_DIR)

  # should add a shebang (or not) adding will rewrite hook file
  add_shebang = false
  if hook_file_exists?
    # clear away any existing lolcommits hook
    remove_existing_hook! if lolcommits_hook_exists?

    # if file is empty we should add a shebang (and rewrite hook)
    if File.read(HOOK_PATH).strip.empty?
      add_shebang = true
    elsif !good_shebang?
      # look for good shebang in existing hook, abort if none found
      warn "the existing hook (at #{HOOK_PATH}) doesn't start with a good shebang; like #!/bin/sh"
      exit 1
    end
  else
    add_shebang = true
  end

  File.open(HOOK_PATH, add_shebang ? 'w' : 'a') do |f|
    f.write("#!/bin/sh\n") if add_shebang
    f.write(hook_script)
  end

  FileUtils.chmod 0755, HOOK_PATH

  info 'installed lolcommit hook to:'
  info "  -> #{File.expand_path(HOOK_PATH)}"
  info '(to remove later, you can use: lolcommits --disable)'
  # we dont symlink, but rather install a small stub that calls the one from path
  # that way, as gem version changes, script updates even if new file thus breaking symlink
end

.good_shebang? ⇒ Boolean

does the git hook file have a good shebang?

Returns:

  • (Boolean) 


108
109
110
 
# File 'lib/lolcommits/installation.rb', line 108

def self.good_shebang?
  File.read(HOOK_PATH).lines.first =~ %r{^\#\!\/bin\/.*sh}
end

.hook_file_exists? ⇒ Boolean

does a git hook exist at all?

Returns:

  • (Boolean) 


97
98
99
 
# File 'lib/lolcommits/installation.rb', line 97

def self.hook_file_exists?
  File.exist?(HOOK_PATH)
end

.hook_script ⇒ Object 



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/lolcommits/installation.rb', line 71

def self.hook_script
  ruby_path     = Lolcommits::Platform.command_which('ruby', true)
  imagick_path  = Lolcommits::Platform.command_which('identify', true)

  if Lolcommits::Platform.platform_windows?
    hook_export = "set path \"#{ruby_path};#{imagick_path};%PATH%\"\n"
  else
    locale_export = "export LANG=\"#{ENV['LANG']}\"\n"
    hook_export   = "export PATH=\"#{ruby_path}:#{imagick_path}:$PATH\"\n"
  end

  capture_cmd   = 'lolcommits --capture'
  capture_args  = ' '
  capture_args  += "#{ARGV[1..-1].join(' ')} " if ARGV.length > 1
  capture_args  += ENV['LOLCOMMITS_INIT_PARAMS'].to_s

  <<-EOS
### lolcommits hook (begin) ###
if [ ! -d "$GIT_DIR/rebase-merge" ]; then
#{locale_export}#{hook_export}#{capture_cmd}#{capture_args}
fi
###  lolcommits hook (end)  ###
EOS
end

.info(_str) ⇒ Object 



118
119
 
# File 'lib/lolcommits/init.rb', line 118

def self.info(_str)
end

.lolcommits_hook_exists? ⇒ Boolean

does a git hook exist with lolcommits commands?

Returns:

  • (Boolean) 


102
103
104
105
 
# File 'lib/lolcommits/installation.rb', line 102

def self.lolcommits_hook_exists?
  hook_file_exists? &&
    File.read(HOOK_PATH).to_s =~ /lolcommits.*\(begin\)(.*\n)*.*lolcommits.*\(end\)/
end

.remove_existing_hook! ⇒ Object 



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/lolcommits/installation.rb', line 112

def self.remove_existing_hook!
  hook = File.read(HOOK_PATH)
  out  = File.open(HOOK_PATH, 'w')
  skip = false

  hook.lines.each do |line|
    skip = true if !skip && (line =~ /lolcommits.*\(begin\)/)

    out << line unless skip

    skip = false if skip && (line =~ /lolcommits.*\(end\)/)
  end

  out.close
end