Module: Capnotify::CommitLog

Defined in:
lib/capnotify-commit_log.rb,
lib/capnotify-commit_log/version.rb

Constant Summary collapse

PLUGIN_NAME = 
:capnotify_commit_log
DEFAULT_COMMIT_LOG_ENTRY = 
{
  :author  => 'n/a',
  :date    =>  nil,
  :email   => 'n/a',
  :sha     => 'n/a',
  :message => 'Log output not available.'
}
VERSION = 
"0.0.2"

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.load_into(config) ⇒ Object 



19
20
21
22
23
24
25
 
# File 'lib/capnotify-commit_log.rb', line 19

def self.load_into(config)
  config.load do
    on(:load) do
      capnotify.load_plugin(Capnotify::CommitLog)
    end
  end
end

Instance Method Details

#commit_log(first_ref, last_ref) ⇒ Object

git log between first_ref to last_ref memoizes the output so this function can be called multiple times without re-running FIXME: memoization does not account for arguments FIXME: this should probably use the git gem FIXME: this only supports git.

returns an array of 2-element arrays in the form of

ref, log_text 


129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/capnotify-commit_log.rb', line 129

def commit_log(first_ref, last_ref)
  puts "running commit log"
  return @commit_log unless @commit_log.nil?

  git = find_git_repo

  begin
    raise "Ref missing" if first_ref.nil? || last_ref.nil? # jump to rescue block.

    log_results = git.log.between(first_ref, last_ref)

    @commit_log = log_results.map do |log|
      {
        :author  => log.author.name,
        :date    => log.date,
        :email   => log.author.email,
        :sha     => log.sha,
        :message => log.message
      }
    end

  rescue
    [ DEFAULT_COMMIT_LOG_ENTRY ]
  end
end

#find_git_repo(path = nil) ⇒ Object

locate the git repository for the project starting with the local_git_repository_path or current working directory (or path, if specified), traverse the filesystem going up until we hit a git repository. returns nil if one is not found. otherwise returns a Git object



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/capnotify-commit_log.rb', line 103

def find_git_repo(path=nil)
  # use local_git_repository_path or Dir.pwd if path is not specified
  path = fetch(:local_git_repository_path, Dir.pwd) if path.nil?

  # expand the path
  path = File.expand_path(path)

  return nil if path == '/'

  # try to open the current path
  # if fail, go up a directory
  begin
    ::Git.open(path)
  rescue ArgumentError
    find_git_repo(File.join(path, '..'))
  end
end

#init ⇒ Object 



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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/capnotify-commit_log.rb', line 27

def init
  capnotify.components << Capnotify::Component.new(:capnotify_commit_log) do |c|
    c.header = 'Log'

    c.css_class = 'commit-log'
    c.custom_css = <<-CSS
      ul.commit_log {
        list-style: none;
        margin: 0;
        padding: 0;
        clear: both;
      }

      ul.commit_log li {
        clear: both;
        display: block;
        white-space: nowrap;
      }

      ul.commit_log h4.sha {
        font-family: monospace;
        background-color: #eee;
        color: #666;
        float: left;
        padding: 2px 0px;
        margin: 0;
        margin-right: 5px;
        width: 70px;
        text-align: center;
      }

      ul.commit_log .commit_body {
        <!-- float: left; -->
        white-space: normal;

        margin-left: 75px;
      }

      ul.commit_log .commit_body h4 {
        padding: 2px 0px;
        font-weight: bold;
        margin: 0;
      }

      ul.commit_log .commit_body .commit_message {
        white-space: pre-wrap;
        font-family: monospace;
      }

      ul.commit_log a {
        font-weight: bold;
        text-decoration: none;
      }

      ul.commit_log a:hover {
        text-decoration: underline;
      }
    CSS

    c.template_path = File.join( File.dirname(__FILE__), 'templates' )

    c.render_for :html => '_commit_log.html.erb', :txt => '_commit_log.txt.erb'

    c.content = commit_log(fetch(:previous_revision, nil), fetch(:real_revision, nil))
  end
end

#unload ⇒ Object 



94
95
96
 
# File 'lib/capnotify-commit_log.rb', line 94

def unload
  capnotify.delete_component :capnotify_commit_log
end