Class: Gollum::Committer

Inherits:
Object
  • Object
show all
Defined in:
lib/gollum-lib/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.
:note      - Optional String containing info about the commit. Not used, but can be accessed from inside the :post_commit Hook.
:parent    - Optional Gollum::Git::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.



30
31
32
33
34
 
# File 'lib/gollum-lib/committer.rb', line 30

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



197
198
199
 
# File 'lib/gollum-lib/committer.rb', line 197

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

Instance Attribute Details

#options ⇒ Object (readonly)

Gets a Hash of commit options.



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

def options
  @options
end

#wiki ⇒ Object (readonly)

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



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

def wiki
  @wiki
end

Instance Method Details

#actor ⇒ Object

Public: The committer for this commit.

Returns a Gollum::Git::Actor.



54
55
56
57
58
59
60
 
# File 'lib/gollum-lib/committer.rb', line 54

def actor
  @actor ||= begin
    @options[:name]  = @wiki.default_committer_name if @options[:name].nil?
    @options[:email] = @wiki.default_committer_email if @options[:email].nil?
    Gollum::Git::Actor.new(@options[:name], @options[:email], @options[:time])
  end
end

#add_to_index(path, data, options = {}, force_overwrite = false) ⇒ Object

Adds a path to the Index.

path - The String path to be added data - The String wiki data to store in the tree map.

Raises Gollum::DuplicatePageError if a matching filename already exists, unless force_overwrite is explicitly enabled. This way, pages are not inadvertently overwritten.

Returns nothing (modifies the Index in place).



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/gollum-lib/committer.rb', line 83

def add_to_index(path, data, options = {}, force_overwrite = false)
  if tree = index.current_tree
    unless page_path_scheduled_for_deletion?(index.tree, path) || force_overwrite
      raise DuplicatePageError.new(path) if tree / path
    end
  end

  unless options[:normalize] == false
    begin
      data = @wiki.normalize(data)
    rescue ArgumentError => err
      # Swallow errors that arise from data being binary
      raise err unless err.message.include?('invalid byte sequence')
    end
  end
  index.add(path, 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.



143
144
145
 
# File 'lib/gollum-lib/committer.rb', line 143

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.



127
128
129
130
131
132
133
134
135
 
# File 'lib/gollum-lib/committer.rb', line 127

def commit
  sha1 = index.commit(@options[:message], parents, actor, nil, @wiki.ref)
  @callbacks.each do |cb|
    cb.call(self, sha1)
  end
  @wiki.repo.commit(sha1).note=@options[:note] if @options[:note]
  Hook.execute(:post_commit, self, sha1)
  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) 


181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/gollum-lib/committer.rb', line 181

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 Gollum::Git::Index.



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

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) 


157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/gollum-lib/committer.rb', line 157

def page_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])
      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 Gollum::Git::Commit instances.



65
66
67
68
69
70
71
72
 
# File 'lib/gollum-lib/committer.rb', line 65

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

#update_working_dir(path) ⇒ Object

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

path - The String path to update

Returns nothing.



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/gollum-lib/committer.rb', line 107

def update_working_dir(path)
  unless @wiki.repo.bare
    if @wiki.page_file_dir && !path.start_with?(@wiki.page_file_dir)
      # Skip the path if it is not under the wiki's page file dir
      return nil
    end

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