Class: Gollum::Committer

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

Overview

Responsible for handling the commit process for a Wiki. It sets up the Git index, provides methods for modifying the tree, and stores callbacks to be fired after the commit has been made. This is specifically designed to handle multiple updated pages in a single commit.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(wiki, options = {}) ⇒ Committer

Initializes the Committer.

wiki - The Gollum::Wiki instance that is being updated. options - The commit Hash details:

:message   - The String commit message.
:name      - The String author full name.
:email     - The String email address.
:parent    - Optional Grit::Commit parent to this update.
:tree      - Optional String SHA of the tree to create the
             index from.
:committer - Optional Gollum::Committer instance.  If provided,
             assume that this operation is part of batch of
             updates and the commit happens later.

Returns the Committer instance.



28
29
30
31
32
 
# File 'lib/gollum/committer.rb', line 28

def initialize(wiki, options = {})
  @wiki      = wiki
  @options   = options
  @callbacks = []
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(name, *args) ⇒ Object

Proxies methods t



214
215
216
 
# File 'lib/gollum/committer.rb', line 214

def method_missing(name, *args)
  index.send(name, *args)
end

Instance Attribute Details

#options ⇒ Object (readonly)

Gets a Hash of commit options.



11
12
13
 
# File 'lib/gollum/committer.rb', line 11

def options
  @options
end

#wiki ⇒ Object (readonly)

Gets the instance of the Gollum::Wiki that is being updated.



8
9
10
 
# File 'lib/gollum/committer.rb', line 8

def wiki
  @wiki
end

Instance Method Details

#actor ⇒ Object

Public: The committer for this commit.

Returns a Grit::Actor.



52
53
54
55
56
57
58
 
# File 'lib/gollum/committer.rb', line 52

def actor
  @actor ||= begin
    @options[:name]  = @wiki.default_committer_name  if @options[:name].to_s.empty?
    @options[:email] = @wiki.default_committer_email if @options[:email].to_s.empty?
    Grit::Actor.new(@options[:name], @options[:email])
  end
end

#add_to_index(dir, name, format, data, allow_same_ext = false) ⇒ Object

Adds a page to the given Index.

dir - The String subdirectory of the Gollum::Page without any

prefix or suffix slashes (e.g. "foo/bar").

name - The String Gollum::Page filename_stripped. format - The Symbol Gollum::Page format. data - The String wiki data to store in the tree map. allow_same_ext - A Boolean determining if the tree map allows the same

filename with the same extension.

Raises Gollum::DuplicatePageError if a matching filename already exists. This way, pages are not inadvertently overwritten.

Returns nothing (modifies the Index in place).



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/gollum/committer.rb', line 86

def add_to_index(dir, name, format, data, allow_same_ext = false)
  path = @wiki.page_file_name(name, format)

  dir = '/' if dir.strip.empty?

  fullpath = ::File.join(*[@wiki.page_file_dir, dir, path].compact)
  fullpath = fullpath[1..-1] if fullpath =~ /^\//

  if index.current_tree && tree = index.current_tree / dir
    downpath = path.downcase.sub(/\.\w+$/, '')

    tree.blobs.each do |blob|
      next if page_path_scheduled_for_deletion?(index.tree, fullpath)
      file = blob.name.downcase.sub(/\.\w+$/, '')
      file_ext = ::File.extname(blob.name).sub(/^\./, '')
      if downpath == file && !(allow_same_ext && file_ext == ext)
        raise DuplicatePageError.new(dir, blob.name, path)
      end
    end
  end

  index.add(fullpath, @wiki.normalize(data))
end

#after_commit(&block) ⇒ Object

Adds a callback to be fired after a commit.

block - A block that expects this Committer instance and the created

commit's SHA1 as the arguments.

Returns nothing.



159
160
161
 
# File 'lib/gollum/committer.rb', line 159

def after_commit(&block)
  @callbacks << block
end

#commit ⇒ Object

Writes the commit to Git and runs the after_commit callbacks.

Returns the String SHA1 of the new commit.



145
146
147
148
149
150
151
 
# File 'lib/gollum/committer.rb', line 145

def commit
  sha1 = index.commit(@options[:message], parents, actor, nil, @wiki.ref)
  @callbacks.each do |cb|
    cb.call(self, sha1)
  end
  sha1
end

#file_path_scheduled_for_deletion?(map, path) ⇒ Boolean

Determine if a given file is scheduled to be deleted in the next commit for the given Index.

map - The Hash map:

key - The String directory or filename.
val - The Hash submap or the String contents of the file.

path - The String path of the file including extension.

Returns the Boolean response.

Returns:

  • (Boolean) 


198
199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/gollum/committer.rb', line 198

def file_path_scheduled_for_deletion?(map, path)
  parts = path.split('/')
  if parts.size == 1
    deletions = map.keys.select { |k| !map[k] }
    deletions.any? { |d| d == parts.first }
  else
    part = parts.shift
    if rest = map[part]
      file_path_scheduled_for_deletion?(rest, parts.join('/'))
    else
      false
    end
  end
end

#index ⇒ Object

Public: References the Git index for this commit.

Returns a Grit::Index.



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

def index
  @index ||= begin
    idx = @wiki.repo.index
    if tree   = options[:tree]
      idx.read_tree(tree)
    elsif parent = parents.first
      idx.read_tree(parent.tree.id)
    end
    idx
  end
end

#page_path_scheduled_for_deletion?(map, path) ⇒ Boolean

Determine if a given page (regardless of format) is scheduled to be deleted in the next commit for the given Index.

map - The Hash map:

key - The String directory or filename.
val - The Hash submap or the String contents of the file.

path - The String path of the page file. This may include the format

extension in which case it will be ignored.

Returns the Boolean response.

Returns:

  • (Boolean) 


173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/gollum/committer.rb', line 173

def page_path_scheduled_for_deletion?(map, path)
  parts = path.split('/')
  if parts.size == 1
    deletions = map.keys.select { |k| !map[k] }
    downfile = parts.first.downcase.sub(/\.\w+$/, '')
    deletions.any? { |d| d.downcase.sub(/\.\w+$/, '') == downfile }
  else
    part = parts.shift
    if rest = map[part]
      page_path_scheduled_for_deletion?(rest, parts.join('/'))
    else
      false
    end
  end
end

#parents ⇒ Object

Public: The parent commits to this pending commit.

Returns an array of Grit::Commit instances.



63
64
65
66
67
68
69
70
 
# File 'lib/gollum/committer.rb', line 63

def parents
  @parents ||= begin
    arr = [@options[:parent] || @wiki.repo.commit(@wiki.ref)]
    arr.flatten!
    arr.compact!
    arr
  end
end

#update_working_dir(dir, name, format) ⇒ Object

Update the given file in the repository’s working directory if there is a working directory present.

dir - The String directory in which the file lives. name - The String name of the page or the stripped filename

(should be pre-canonicalized if required).

format - The Symbol format of the page.

Returns nothing.



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/gollum/committer.rb', line 119

def update_working_dir(dir, name, format)
  unless @wiki.repo.bare
    if @wiki.page_file_dir
      dir = dir.size.zero? ? @wiki.page_file_dir : ::File.join(dir, @wiki.page_file_dir)
    end

    path =
      if dir == ''
        @wiki.page_file_name(name, format)
      else
        ::File.join(dir, @wiki.page_file_name(name, format))
      end

    Dir.chdir(::File.join(@wiki.repo.path, '..')) do
      if file_path_scheduled_for_deletion?(index.tree, path)
        @wiki.repo.git.rm({'f' => true}, '--', path)
      else
        @wiki.repo.git.checkout({}, 'HEAD', '--', path)
      end
    end
  end
end