Class: Gollum::Wiki
- Inherits:
-
Object
- Object
- Gollum::Wiki
- Includes:
- Pagination
- Defined in:
- lib/gollum-lib/wiki.rb
Class Attribute Summary collapse
-
.default_committer_email ⇒ Object
Sets the default email for commits.
-
.default_committer_name ⇒ Object
Sets the default name for commits.
-
.default_options ⇒ Object
Hash for setting different default wiki options These defaults can be overridden by options passed directly to initialize().
-
.default_ref ⇒ Object
Sets the default ref for the wiki.
-
.default_ws_subs ⇒ Object
Array of chars to substitute whitespace for when trying to locate file in git repo.
-
.file_class ⇒ Object
Gets the file class used by all instances of this Wiki.
-
.history_sanitization ⇒ Object
Gets the default sanitization options for older page revisions used by instances of this Wiki.
-
.markup_classes ⇒ Object
Gets the markup class used by all instances of this Wiki.
-
.page_class ⇒ Object
Gets the page class used by all instances of this Wiki.
-
.sanitization ⇒ Object
Gets the default sanitization options for current pages used by instances of this Wiki.
Instance Attribute Summary collapse
-
#allow_uploads ⇒ Object
readonly
Toggles file upload functionality.
-
#bar_side ⇒ Object
readonly
Gets side on which the sidebar should be shown.
-
#base_path ⇒ Object
readonly
The String base path to prefix to internal links.
-
#collapse_tree ⇒ Object
readonly
Start with collapsed file view.
-
#css ⇒ Object
readonly
Injects custom css from custom.css in root repo.
-
#file_class ⇒ Object
readonly
Gets the file class used by all instances of this Wiki.
-
#h1_title ⇒ Object
readonly
Sets page title to value of first h1 Defaults to false.
-
#history_sanitization ⇒ Object
readonly
Gets the sanitization options for older page revisions used by this Wiki.
-
#index_page ⇒ Object
readonly
Gets the custom index page for / and subdirs (e.g. foo/).
-
#live_preview ⇒ Object
readonly
Gets the boolean live preview value.
-
#markup_classes ⇒ Object
readonly
Gets the markup class used by all instances of this Wiki.
-
#mathjax ⇒ Object
readonly
Toggles mathjax.
-
#page_class ⇒ Object
readonly
Gets the page class used by all instances of this Wiki.
-
#page_file_dir ⇒ Object
readonly
Gets the String directory in which all page files reside.
-
#path ⇒ Object
readonly
The String path to the Git repository that holds the Gollum site.
-
#ref ⇒ Object
readonly
Gets the String ref in which all page files reside.
-
#repo ⇒ Object
readonly
The Grit::Repo associated with the wiki.
-
#sanitization ⇒ Object
readonly
Gets the sanitization options for current pages used by this Wiki.
-
#show_all ⇒ Object
readonly
Toggles showing all files in files view.
-
#universal_toc ⇒ Object
readonly
Toggles display of universal table of contents.
-
#user_icons ⇒ Object
readonly
Toggles user icons.
-
#ws_subs ⇒ Object
readonly
Gets the Array of chars to sub for ws in filenames.
Class Method Summary collapse
-
.markup_class(language = :default) ⇒ Object
(also: default_markup_class)
Gets the default markup class used by all instances of this Wiki.
-
.markup_class=(default) ⇒ Object
(also: default_markup_class=)
Sets the default markup class used by all instances of this Wiki.
Instance Method Summary collapse
-
#clear_cache ⇒ Object
Public: Refreshes just the cached Git reference data.
-
#commit_for(ref) ⇒ Object
Gets the commit object for the given ref or sha.
-
#default_committer_email ⇒ Object
Gets the default email for commits.
-
#default_committer_name ⇒ Object
Gets the default name for commits.
-
#delete_page(page, commit) ⇒ Object
Public: Delete a page.
-
#exist? ⇒ Boolean
Public: check whether the wiki’s git repo exists on the filesystem.
-
#file(name, version = @ref, try_on_disk = false) ⇒ Object
Public: Get the static file for a given name.
-
#file_list(ref) ⇒ Object
Fill an array with a list of files.
-
#files(treeish = nil) ⇒ Object
Public: Lists all non-page files for this wiki.
-
#full_reverse_diff(sha1, sha2 = nil) ⇒ Object
Creates a reverse diff for the given SHAs.
-
#full_reverse_diff_for(page, sha1, sha2 = nil) ⇒ Object
Creates a reverse diff for the given SHAs on the given Gollum::Page.
-
#history_sanitizer ⇒ Object
Public: Creates a Sanitize instance using the Wiki’s history sanitization options.
-
#initialize(path, options = {}) ⇒ Wiki
constructor
Public: Initialize a new Gollum Repo.
- #inspect ⇒ Object
-
#log(options = {}) ⇒ Object
Public: All of the versions that have touched the Page.
-
#normalize(data) ⇒ Object
Normalize the data.
-
#page(name, version = @ref, dir = nil, exact = false) ⇒ Object
Public: Get the formatted page for a given page name, version, and dir.
-
#page_file_name(name, format) ⇒ Object
Assemble a Page’s filename from its name and format.
-
#paged(name, dir = nil, exact = false, version = @ref) ⇒ Object
Public: Convenience method instead of calling page(name, nil, dir).
-
#pages(treeish = nil) ⇒ Object
Public: Lists all pages for this wiki.
-
#preview_page(name, data, format) ⇒ Object
Public: Create an in-memory Page with the given data and format.
-
#rename_page(page, rename, commit = {}) ⇒ Object
Public: Rename an existing page without altering content.
-
#revert_commit(sha1, sha2 = nil, commit = {}) ⇒ Object
Public: Applies a reverse diff to the repo.
-
#revert_page(page, sha1, sha2 = nil, commit = {}) ⇒ Object
Public: Applies a reverse diff for a given page.
-
#sanitizer ⇒ Object
Public: Creates a Sanitize instance using the Wiki’s sanitization options.
-
#search(query) ⇒ Object
Public: Search all pages for this wiki.
-
#size(ref = nil) ⇒ Object
Public: Returns the number of pages accessible from a commit.
-
#tree_list(ref) ⇒ Object
Fill an array with a list of pages.
-
#tree_map_for(ref, ignore_page_file_dir = false) ⇒ Object
Finds a full listing of files and their blob SHA for a given ref.
-
#update_page(page, name, format, data, commit = {}) ⇒ Object
Public: Update an existing page with new content.
-
#write_page(name, format, data, commit = {}, dir = '') ⇒ Object
Public: Write a new version of a page to the Gollum repo root.
Methods included from Pagination
included, #log_pagination_options, #page_to_skip
Constructor Details
#initialize(path, options = {}) ⇒ Wiki
Public: Initialize a new Gollum Repo.
path - The String path to the Git repository that holds the Gollum
site.
options - Optional Hash:
:universal_toc - Table of contents on all pages. Default: false
:live_preview - Livepreview editing for markdown files. Default: true
:base_path - String base path for all Wiki links.
Default: "/"
:page_class - The page Class. Default: Gollum::Page
:file_class - The file Class. Default: Gollum::File
:markup_classes - A hash containing the markup Classes for each
document type. Default: { Gollum::Markup }
:sanitization - An instance of Sanitization.
:page_file_dir - String the directory in which all page files reside
:ref - String the repository ref to retrieve pages from
:ws_subs - Array of chars to sub for ws in filenames.
:mathjax - Set to false to disable mathjax.
:user_icons - Enable user icons on the history page. [gravatar, identicon, none].
Default: none
:show_all - Show all files in file view, not just valid pages.
Default: false
:collapse_tree - Start with collapsed file view. Default: false
:css - Include the custom.css file from the repo.
:h1_title - Concatenate all h1's on a page to form the
page title.
:index_page - The default page to retrieve or create if the
a directory is accessed.
:bar_side - Where the sidebar should be displayed, may be:
- :left
- :right
:allow_uploads - Set to true to allow file uploads.
Returns a fresh Gollum::Repo.
188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 |
# File 'lib/gollum-lib/wiki.rb', line 188 def initialize(path, = {}) = self.class..merge() if path.is_a?(GitAccess) [:access] = path path = path.path end # Use .fetch instead of || # # o = { :a => false } # o[:a] || true # => true # o.fetch :a, true # => false @path = path @repo_is_bare = .fetch :repo_is_bare, nil @page_file_dir = .fetch :page_file_dir, nil @access = .fetch :access, GitAccess.new(path, @page_file_dir, @repo_is_bare) @base_path = .fetch :base_path, "/" @page_class = .fetch :page_class, self.class.page_class @file_class = .fetch :file_class, self.class.file_class @markup_classes = .fetch :markup_classes, self.class.markup_classes @repo = @access.repo @ref = .fetch :ref, self.class.default_ref @sanitization = .fetch :sanitization, self.class.sanitization @ws_subs = .fetch :ws_subs, self.class.default_ws_subs @history_sanitization = .fetch :history_sanitization, self.class.history_sanitization @live_preview = .fetch :live_preview, true @universal_toc = .fetch :universal_toc, false @mathjax = .fetch :mathjax, false @show_all = .fetch :show_all, false @collapse_tree = .fetch :collapse_tree, false @css = .fetch :css, false @h1_title = .fetch :h1_title, false @index_page = .fetch :index_page, 'Home' @bar_side = .fetch :sidebar, :right @user_icons = ['gravatar', 'identicon'].include?( [:user_icons] ) ? [:user_icons] : 'none' @allow_uploads = .fetch :allow_uploads, false end |
Class Attribute Details
.default_committer_email ⇒ Object
Sets the default email for commits.
23 24 25 |
# File 'lib/gollum-lib/wiki.rb', line 23 def default_committer_email @default_committer_email end |
.default_committer_name ⇒ Object
Sets the default name for commits.
20 21 22 |
# File 'lib/gollum-lib/wiki.rb', line 20 def default_committer_name @default_committer_name end |
.default_options ⇒ Object
Hash for setting different default wiki options These defaults can be overridden by options passed directly to initialize()
38 39 40 |
# File 'lib/gollum-lib/wiki.rb', line 38 def @default_options end |
.default_ref ⇒ Object
Sets the default ref for the wiki.
17 18 19 |
# File 'lib/gollum-lib/wiki.rb', line 17 def default_ref @default_ref end |
.default_ws_subs ⇒ Object
Array of chars to substitute whitespace for when trying to locate file in git repo.
26 27 28 |
# File 'lib/gollum-lib/wiki.rb', line 26 def default_ws_subs @default_ws_subs end |
.file_class ⇒ Object
Gets the file class used by all instances of this Wiki. Default: Gollum::File.
53 54 55 56 57 58 59 60 |
# File 'lib/gollum-lib/wiki.rb', line 53 def file_class @file_class || if superclass.respond_to?(:file_class) superclass.file_class else ::Gollum::File end end |
.history_sanitization ⇒ Object
Gets the default sanitization options for older page revisions used by instances of this Wiki.
100 101 102 103 104 105 106 107 |
# File 'lib/gollum-lib/wiki.rb', line 100 def history_sanitization if @history_sanitization.nil? @history_sanitization = sanitization ? sanitization.history_sanitization : false end @history_sanitization end |
.markup_classes ⇒ Object
Gets the markup class used by all instances of this Wiki. Default: Gollum::Markup
64 65 66 67 68 69 70 71 |
# File 'lib/gollum-lib/wiki.rb', line 64 def markup_classes @markup_classes ||= if superclass.respond_to?(:markup_classes) superclass.markup_classes else Hash.new(::Gollum::Markup) end end |
.page_class ⇒ Object
Gets the page class used by all instances of this Wiki. Default: Gollum::Page.
42 43 44 45 46 47 48 49 |
# File 'lib/gollum-lib/wiki.rb', line 42 def page_class @page_class || if superclass.respond_to?(:page_class) superclass.page_class else ::Gollum::Page end end |
.sanitization ⇒ Object
Gets the default sanitization options for current pages used by instances of this Wiki.
91 92 93 94 95 96 |
# File 'lib/gollum-lib/wiki.rb', line 91 def sanitization if @sanitization.nil? @sanitization = Sanitization.new end @sanitization end |
Instance Attribute Details
#allow_uploads ⇒ Object (readonly)
Toggles file upload functionality.
688 689 690 |
# File 'lib/gollum-lib/wiki.rb', line 688 def allow_uploads @allow_uploads end |
#bar_side ⇒ Object (readonly)
Gets side on which the sidebar should be shown
152 153 154 |
# File 'lib/gollum-lib/wiki.rb', line 152 def @bar_side end |
#base_path ⇒ Object (readonly)
The String base path to prefix to internal links. For example, when set to “/wiki”, the page “Hobbit” will be linked as “/wiki/Hobbit”. Defaults to “/”.
120 121 122 |
# File 'lib/gollum-lib/wiki.rb', line 120 def base_path @base_path end |
#collapse_tree ⇒ Object (readonly)
Start with collapsed file view. Default: false
685 686 687 |
# File 'lib/gollum-lib/wiki.rb', line 685 def collapse_tree @collapse_tree end |
#css ⇒ Object (readonly)
Injects custom css from custom.css in root repo. Defaults to false
142 143 144 |
# File 'lib/gollum-lib/wiki.rb', line 142 def css @css end |
#file_class ⇒ Object (readonly)
Gets the file class used by all instances of this Wiki.
666 667 668 |
# File 'lib/gollum-lib/wiki.rb', line 666 def file_class @file_class end |
#h1_title ⇒ Object (readonly)
Sets page title to value of first h1 Defaults to false
146 147 148 |
# File 'lib/gollum-lib/wiki.rb', line 146 def h1_title @h1_title end |
#history_sanitization ⇒ Object (readonly)
Gets the sanitization options for older page revisions used by this Wiki.
126 127 128 |
# File 'lib/gollum-lib/wiki.rb', line 126 def history_sanitization @history_sanitization end |
#index_page ⇒ Object (readonly)
Gets the custom index page for / and subdirs (e.g. foo/)
149 150 151 |
# File 'lib/gollum-lib/wiki.rb', line 149 def index_page @index_page end |
#live_preview ⇒ Object (readonly)
Gets the boolean live preview value.
138 139 140 |
# File 'lib/gollum-lib/wiki.rb', line 138 def live_preview @live_preview end |
#markup_classes ⇒ Object (readonly)
Gets the markup class used by all instances of this Wiki.
669 670 671 |
# File 'lib/gollum-lib/wiki.rb', line 669 def markup_classes @markup_classes end |
#mathjax ⇒ Object (readonly)
Toggles mathjax.
675 676 677 |
# File 'lib/gollum-lib/wiki.rb', line 675 def mathjax @mathjax end |
#page_class ⇒ Object (readonly)
Gets the page class used by all instances of this Wiki.
663 664 665 |
# File 'lib/gollum-lib/wiki.rb', line 663 def page_class @page_class end |
#page_file_dir ⇒ Object (readonly)
Gets the String directory in which all page files reside.
132 133 134 |
# File 'lib/gollum-lib/wiki.rb', line 132 def page_file_dir @page_file_dir end |
#path ⇒ Object (readonly)
The String path to the Git repository that holds the Gollum site.
Returns the String path.
660 661 662 |
# File 'lib/gollum-lib/wiki.rb', line 660 def path @path end |
#ref ⇒ Object (readonly)
Gets the String ref in which all page files reside.
129 130 131 |
# File 'lib/gollum-lib/wiki.rb', line 129 def ref @ref end |
#repo ⇒ Object (readonly)
The Grit::Repo associated with the wiki.
Returns the Grit::Repo.
655 656 657 |
# File 'lib/gollum-lib/wiki.rb', line 655 def repo @repo end |
#sanitization ⇒ Object (readonly)
Gets the sanitization options for current pages used by this Wiki.
123 124 125 |
# File 'lib/gollum-lib/wiki.rb', line 123 def sanitization @sanitization end |
#show_all ⇒ Object (readonly)
Toggles showing all files in files view. Default is false. When false, only valid pages in the git repo are displayed.
682 683 684 |
# File 'lib/gollum-lib/wiki.rb', line 682 def show_all @show_all end |
#universal_toc ⇒ Object (readonly)
Toggles display of universal table of contents
672 673 674 |
# File 'lib/gollum-lib/wiki.rb', line 672 def universal_toc @universal_toc end |
#user_icons ⇒ Object (readonly)
Toggles user icons. Default: ‘none’
678 679 680 |
# File 'lib/gollum-lib/wiki.rb', line 678 def user_icons @user_icons end |
#ws_subs ⇒ Object (readonly)
Gets the Array of chars to sub for ws in filenames.
135 136 137 |
# File 'lib/gollum-lib/wiki.rb', line 135 def ws_subs @ws_subs end |
Class Method Details
.markup_class(language = :default) ⇒ Object Also known as: default_markup_class
Gets the default markup class used by all instances of this Wiki. Kept for backwards compatibility until Gollum v2.x
75 76 77 |
# File 'lib/gollum-lib/wiki.rb', line 75 def markup_class(language=:default) markup_classes[language] end |
.markup_class=(default) ⇒ Object Also known as: default_markup_class=
Sets the default markup class used by all instances of this Wiki. Kept for backwards compatibility until Gollum v2.x
81 82 83 84 |
# File 'lib/gollum-lib/wiki.rb', line 81 def markup_class=(default) @markup_classes = Hash.new(default).update(markup_classes) default end |
Instance Method Details
#clear_cache ⇒ Object
Public: Refreshes just the cached Git reference data. This should be called after every Gollum update.
Returns nothing.
622 623 624 |
# File 'lib/gollum-lib/wiki.rb', line 622 def clear_cache @access.refresh end |
#commit_for(ref) ⇒ Object
Gets the commit object for the given ref or sha.
ref - A string ref or SHA pointing to a valid commit.
Returns a Grit::Commit instance.
793 794 795 796 |
# File 'lib/gollum-lib/wiki.rb', line 793 def commit_for(ref) @access.commit(ref) rescue Grit::GitRuby::Repository::NoSuchShaFound end |
#default_committer_email ⇒ Object
Gets the default email for commits.
Returns the String email address.
783 784 785 786 |
# File 'lib/gollum-lib/wiki.rb', line 783 def default_committer_email @default_committer_email ||= \ @repo.config['user.email'] || self.class.default_committer_email end |
#default_committer_name ⇒ Object
Gets the default name for commits.
Returns the String name.
775 776 777 778 |
# File 'lib/gollum-lib/wiki.rb', line 775 def default_committer_name @default_committer_name ||= \ @repo.config['user.name'] || self.class.default_committer_name end |
#delete_page(page, commit) ⇒ Object
Public: Delete a page.
page - The Gollum::Page to delete. commit - 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 String SHA1 of the newly written version, or the Gollum::Committer instance if this is part of a batch update.
446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 |
# File 'lib/gollum-lib/wiki.rb', line 446 def delete_page(page, commit) multi_commit = !!commit[:committer] committer = multi_commit ? commit[:committer] : Committer.new(self, commit) committer.delete(page.path) committer.after_commit do |index, sha| dir = ::File.dirname(page.path) dir = '' if dir == '.' @access.refresh index.update_working_dir(dir, page.filename_stripped, page.format) end multi_commit ? committer : committer.commit end |
#exist? ⇒ Boolean
Public: check whether the wiki’s git repo exists on the filesystem.
Returns true if the repo exists, and false if it does not.
231 232 233 |
# File 'lib/gollum-lib/wiki.rb', line 231 def exist? @access.exist? end |
#file(name, version = @ref, try_on_disk = false) ⇒ Object
Public: Get the static file for a given name.
name - The full String pathname to the file. version - The String version ID to find (default: @ref). try_on_disk - If true, try to return just a reference to a file
that exists on the disk.
Returns a Gollum::File or nil if no matching file was found. Note that if you specify try_on_disk=true, you may or may not get a file for which on_disk? is actually true.
268 269 270 |
# File 'lib/gollum-lib/wiki.rb', line 268 def file(name, version = @ref, try_on_disk = false) @file_class.new(self).find(name, version, try_on_disk) end |
#file_list(ref) ⇒ Object
Fill an array with a list of files.
ref - A String ref that is either a commit SHA or references one.
Returns a flat Array of Gollum::File instances.
731 732 733 734 735 736 737 738 739 740 741 742 |
# File 'lib/gollum-lib/wiki.rb', line 731 def file_list(ref) if sha = @access.ref_to_sha(ref) commit = @access.commit(sha) tree_map_for(sha).inject([]) do |list, entry| next list if entry.name.start_with?('_') next list if @page_class.valid_page_name?(entry.name) list << entry.file(self, commit) end else [] end end |
#files(treeish = nil) ⇒ Object
Public: Lists all non-page files for this wiki.
treeish - The String commit ID or ref to find (default: @ref)
Returns an Array of Gollum::File instances.
553 554 555 |
# File 'lib/gollum-lib/wiki.rb', line 553 def files(treeish = nil) file_list(treeish || @ref) end |
#full_reverse_diff(sha1, sha2 = nil) ⇒ Object
Creates a reverse diff for the given SHAs.
sha1 - String SHA1 of the earlier parent if two SHAs are given,
or the child.
sha2 - Optional String SHA1 of the child.
Returns a String of the reverse Diff to apply.
768 769 770 |
# File 'lib/gollum-lib/wiki.rb', line 768 def full_reverse_diff(sha1, sha2 = nil) full_reverse_diff_for(nil, sha1, sha2) end |
#full_reverse_diff_for(page, sha1, sha2 = nil) ⇒ Object
Creates a reverse diff for the given SHAs on the given Gollum::Page.
page - The Gollum::Page to scope the patch to, or a String Path. sha1 - String SHA1 of the earlier parent if two SHAs are given,
or the child.
sha2 - Optional String SHA1 of the child.
Returns a String of the reverse Diff to apply.
752 753 754 755 756 757 758 759 |
# File 'lib/gollum-lib/wiki.rb', line 752 def full_reverse_diff_for(page, sha1, sha2 = nil) sha1, sha2 = "#{sha1}^", sha1 if sha2.nil? args = [{:R => true}, sha1, sha2] if page args << '--' << (page.respond_to?(:path) ? page.path : page.to_s) end repo.git.native(:diff, *args) end |
#history_sanitizer ⇒ Object
Public: Creates a Sanitize instance using the Wiki’s history sanitization options.
Returns a Sanitize instance.
640 641 642 643 644 |
# File 'lib/gollum-lib/wiki.rb', line 640 def history_sanitizer if = history_sanitization @history_sanitizer ||= .to_sanitize end end |
#inspect ⇒ Object
816 817 818 |
# File 'lib/gollum-lib/wiki.rb', line 816 def inspect %(#<#{self.class.name}:#{object_id} #{@repo.path}>) end |
#log(options = {}) ⇒ Object
Public: All of the versions that have touched the Page.
options - The options Hash:
:page - The Integer page number (default: 1).
:per_page - The Integer max count of items to return.
Returns an Array of Grit::Commit.
614 615 616 |
# File 'lib/gollum-lib/wiki.rb', line 614 def log( = {}) @repo.log(@ref, nil, ()) end |
#normalize(data) ⇒ Object
Normalize the data.
data - The String data to be normalized.
Returns the normalized data String.
695 696 697 |
# File 'lib/gollum-lib/wiki.rb', line 695 def normalize(data) data.gsub(/\r/, '') end |
#page(name, version = @ref, dir = nil, exact = false) ⇒ Object
Public: Get the formatted page for a given page name, version, and dir.
name - The human or canonical String page name of the wiki page. version - The String version ID to find (default: @ref). dir - The directory String relative to the repo.
Returns a Gollum::Page or nil if no matching page was found.
242 243 244 245 |
# File 'lib/gollum-lib/wiki.rb', line 242 def page(name, version = @ref, dir = nil, exact = false) version = @ref if version.nil? @page_class.new(self).find(name, version, dir, exact) end |
#page_file_name(name, format) ⇒ Object
Assemble a Page’s filename from its name and format.
name - The String name of the page (should be pre-canonicalized). format - The Symbol format of the page.
Returns the String filename.
705 706 707 |
# File 'lib/gollum-lib/wiki.rb', line 705 def page_file_name(name, format) name + '.' + @page_class.format_to_ext(format) end |
#paged(name, dir = nil, exact = false, version = @ref) ⇒ Object
Public: Convenience method instead of calling page(name, nil, dir).
name - The human or canonical String page name of the wiki page. version - The String version ID to find (default: @ref). dir - The directory String relative to the repo.
Returns a Gollum::Page or nil if no matching page was found.
254 255 256 |
# File 'lib/gollum-lib/wiki.rb', line 254 def paged(name, dir = nil, exact = false, version = @ref) page(name, version, dir, exact) end |
#pages(treeish = nil) ⇒ Object
Public: Lists all pages for this wiki.
treeish - The String commit ID or ref to find (default: @ref)
Returns an Array of Gollum::Page instances.
544 545 546 |
# File 'lib/gollum-lib/wiki.rb', line 544 def pages(treeish = nil) tree_list(treeish || @ref) end |
#preview_page(name, data, format) ⇒ Object
Public: Create an in-memory Page with the given data and format. This is useful for previewing what content will look like before committing it to the repository.
name - The String name of the page. format - The Symbol format of the page. data - The new String contents of the page.
Returns the in-memory Gollum::Page.
281 282 283 284 285 286 287 288 289 |
# File 'lib/gollum-lib/wiki.rb', line 281 def preview_page(name, data, format) page = @page_class.new(self) ext = @page_class.format_to_ext(format.to_sym) name = @page_class.cname(name) + '.' + ext blob = OpenStruct.new(:name => name, :data => data, :is_symlink => false) page.populate(blob) page.version = @access.commit('master') page end |
#rename_page(page, rename, commit = {}) ⇒ Object
Public: Rename an existing page without altering content.
page - The Gollum::Page to update. rename - The String extension-less full path of the page (leading ‘/’ is ignored). commit - 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 String SHA1 of the newly written version, or the Gollum::Committer instance if this is part of a batch update. Returns false if the operation is a NOOP.
348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 |
# File 'lib/gollum-lib/wiki.rb', line 348 def rename_page(page, rename, commit = {}) return false if page.nil? return false if rename.nil? or rename.empty? (target_dir, target_name) = ::File.split(rename) (source_dir, source_name) = ::File.split(page.path) source_name = page.filename_stripped # File.split gives us relative paths with ".", commiter.add_to_index doesn't like that. target_dir = '' if target_dir == '.' source_dir = '' if source_dir == '.' target_dir = target_dir.gsub(/^\//, '') # if the rename is a NOOP, abort if source_dir == target_dir and source_name == target_name return false end multi_commit = !!commit[:committer] committer = multi_commit ? commit[:committer] : Committer.new(self, commit) committer.delete(page.path) committer.add_to_index(target_dir, target_name, page.format, page.raw_data, :allow_same_ext) committer.after_commit do |index, sha| @access.refresh index.update_working_dir(source_dir, source_name, page.format) index.update_working_dir(target_dir, target_name, page.format) end multi_commit ? committer : committer.commit end |
#revert_commit(sha1, sha2 = nil, commit = {}) ⇒ Object
Public: Applies a reverse diff to the repo. If only 1 SHA is given, the reverse diff will be taken from its parent (^SHA…SHA). If two SHAs are given, the reverse diff is taken from SHA1…SHA2.
sha1 - String SHA1 of the earlier parent if two SHAs are given,
or the child.
sha2 - Optional String SHA1 of the child. commit - The commit Hash details:
:message - The String commit message.
:name - The String author full name.
:email - The String email address.
Returns a String SHA1 of the new commit, or nil if the reverse diff does not apply.
535 536 537 |
# File 'lib/gollum-lib/wiki.rb', line 535 def revert_commit(sha1, sha2 = nil, commit = {}) revert_page(nil, sha1, sha2, commit) end |
#revert_page(page, sha1, sha2 = nil, commit = {}) ⇒ Object
Public: Applies a reverse diff for a given page. If only 1 SHA is given, the reverse diff will be taken from its parent (^SHA…SHA). If two SHAs are given, the reverse diff is taken from SHA1…SHA2.
page - The Gollum::Page to delete. sha1 - String SHA1 of the earlier parent if two SHAs are given,
or the child.
sha2 - Optional String SHA1 of the child. commit - 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.
Returns a String SHA1 of the new commit, or nil if the reverse diff does not apply.
480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 |
# File 'lib/gollum-lib/wiki.rb', line 480 def revert_page(page, sha1, sha2 = nil, commit = {}) if sha2.is_a?(Hash) commit = sha2 sha2 = nil end patch = full_reverse_diff_for(page, sha1, sha2) committer = Committer.new(self, commit) parent = committer.parents[0] committer.[:tree] = @repo.git.apply_patch(parent.sha, patch) return false unless committer.[:tree] committer.after_commit do |index, sha| @access.refresh files = [] if page files << [page.path, page.filename_stripped, page.format] else # Grit::Diff can't parse reverse diffs.... yet patch.each_line do |line| if line =~ %r{^diff --git b/.+? a/(.+)$} path = $1 ext = ::File.extname(path) name = ::File.basename(path, ext) if format = ::Gollum::Page.format_for(ext) files << [path, name, format] end end end end files.each do |(path, name, format)| dir = ::File.dirname(path) dir = '' if dir == '.' index.update_working_dir(dir, name, format) end end committer.commit end |
#sanitizer ⇒ Object
Public: Creates a Sanitize instance using the Wiki’s sanitization options.
Returns a Sanitize instance.
630 631 632 633 634 |
# File 'lib/gollum-lib/wiki.rb', line 630 def sanitizer if = sanitization @sanitizer ||= .to_sanitize end end |
#search(query) ⇒ Object
Public: Search all pages for this wiki.
query - The string to search for
Returns an Array with Objects of page name and count of matches
575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 |
# File 'lib/gollum-lib/wiki.rb', line 575 def search(query) args = [{}, '-i', '-c', query, @ref, '--'] args << '--' << @page_file_dir if @page_file_dir results = {} @repo.git.grep(*args).split("\n").each do |line| result = line.split(':') result_1 = result[1] # Remove ext only from known extensions. # test.pdf => test.pdf, test.md => test file_name = Page::valid_page_name?(result_1) ? result_1.chomp(::File.extname(result_1)) : result_1 results[file_name] = result[2].to_i end # Use git ls-files '*query*' to search for file names. Grep only searches file content. # Spaces are converted to dashes when saving pages to disk. @repo.git.ls_files({}, "*#{ query.gsub(' ', '-') }*").split("\n").each do |line| # Remove ext only from known extensions. file_name = Page::valid_page_name?(line) ? line.chomp(::File.extname(line)) : line # If there's not already a result for file_name then # the value is nil and nil.to_i is 0. results[file_name] = results[file_name].to_i + 1; end results.map do |key,val| { :count => val, :name => key } end end |
#size(ref = nil) ⇒ Object
Public: Returns the number of pages accessible from a commit
ref - A String ref that is either a commit SHA or references one.
Returns a Fixnum
562 563 564 565 566 567 568 |
# File 'lib/gollum-lib/wiki.rb', line 562 def size(ref = nil) tree_map_for(ref || @ref).inject(0) do |num, entry| num + (@page_class.valid_page_name?(entry.name) ? 1 : 0) end rescue Grit::GitRuby::Repository::NoSuchShaFound 0 end |
#tree_list(ref) ⇒ Object
Fill an array with a list of pages.
ref - A String ref that is either a commit SHA or references one.
Returns a flat Array of Gollum::Page instances.
714 715 716 717 718 719 720 721 722 723 724 |
# File 'lib/gollum-lib/wiki.rb', line 714 def tree_list(ref) if sha = @access.ref_to_sha(ref) commit = @access.commit(sha) tree_map_for(sha).inject([]) do |list, entry| next list unless @page_class.valid_page_name?(entry.name) list << entry.page(self, commit) end else [] end end |
#tree_map_for(ref, ignore_page_file_dir = false) ⇒ Object
Finds a full listing of files and their blob SHA for a given ref. Each listing is cached based on its actual commit SHA.
ref - A String ref that is either a commit SHA or references one. ignore_page_file_dir - Boolean, if true, searches all files within the git repo, regardless of dir/subdir
Returns an Array of BlobEntry instances.
805 806 807 808 809 810 811 812 813 814 |
# File 'lib/gollum-lib/wiki.rb', line 805 def tree_map_for(ref, ignore_page_file_dir=false) if ignore_page_file_dir && !@page_file_dir.nil? @root_access ||= GitAccess.new(path, nil, @repo_is_bare) @root_access.tree(ref) else @access.tree(ref) end rescue Grit::GitRuby::Repository::NoSuchShaFound [] end |
#update_page(page, name, format, data, commit = {}) ⇒ Object
Public: Update an existing page with new content. The location of the page inside the repository will not change. If the given format is different than the current format of the page, the filename will be changed to reflect the new format.
page - The Gollum::Page to update. name - The String extension-less name of the page. format - The Symbol format of the page. data - The new String contents of the page. commit - 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 String SHA1 of the newly written version, or the Gollum::Committer instance if this is part of a batch update.
403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 |
# File 'lib/gollum-lib/wiki.rb', line 403 def update_page(page, name, format, data, commit = {}) name ||= page.name format ||= page.format dir = ::File.dirname(page.path) dir = '' if dir == '.' filename = (rename = page.name != name) ? Gollum::Page.cname(name) : page.filename_stripped multi_commit = !!commit[:committer] committer = multi_commit ? commit[:committer] : Committer.new(self, commit) if !rename && page.format == format committer.add(page.path, normalize(data)) else committer.delete(page.path) committer.add_to_index(dir, filename, format, data, :allow_same_ext) end committer.after_commit do |index, sha| @access.refresh index.update_working_dir(dir, page.filename_stripped, page.format) index.update_working_dir(dir, filename, format) end multi_commit ? committer : committer.commit end |
#write_page(name, format, data, commit = {}, dir = '') ⇒ Object
Public: Write a new version of a page to the Gollum repo root.
name - The String name of the page. format - The Symbol format of the page. data - The new String contents of the page. commit - 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.
dir - The String subdirectory of the Gollum::Page without any
prefix or suffix slashes (e.g. "foo/bar").
Returns the String SHA1 of the newly written version, or the Gollum::Committer instance if this is part of a batch update.
310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 |
# File 'lib/gollum-lib/wiki.rb', line 310 def write_page(name, format, data, commit = {}, dir = '') # spaces must be dashes name.gsub!(' ', '-') dir.gsub!(' ', '-') multi_commit = !!commit[:committer] committer = multi_commit ? commit[:committer] : Committer.new(self, commit) filename = Gollum::Page.cname(name) committer.add_to_index(dir, filename, format, data) committer.after_commit do |index, sha| @access.refresh index.update_working_dir(dir, filename, format) end multi_commit ? committer : committer.commit end |