Adjust to cgit

Author: sudotac

COPYING.txt

@@ -0,0 +1,121 @@
+Creative Commons Legal Code
+
+CC0 1.0 Universal
+
+    CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE
+    LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN
+    ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS
+    INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES
+    REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS
+    PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM
+    THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED
+    HEREUNDER.
+
+Statement of Purpose
+
+The laws of most jurisdictions throughout the world automatically confer
+exclusive Copyright and Related Rights (defined below) upon the creator
+and subsequent owner(s) (each and all, an "owner") of an original work of
+authorship and/or a database (each, a "Work").
+
+Certain owners wish to permanently relinquish those rights to a Work for
+the purpose of contributing to a commons of creative, cultural and
+scientific works ("Commons") that the public can reliably and without fear
+of later claims of infringement build upon, modify, incorporate in other
+works, reuse and redistribute as freely as possible in any form whatsoever
+and for any purposes, including without limitation commercial purposes.
+These owners may contribute to the Commons to promote the ideal of a free
+culture and the further production of creative, cultural and scientific
+works, or to gain reputation or greater distribution for their Work in
+part through the use and efforts of others.
+
+For these and/or other purposes and motivations, and without any
+expectation of additional consideration or compensation, the person
+associating CC0 with a Work (the "Affirmer"), to the extent that he or she
+is an owner of Copyright and Related Rights in the Work, voluntarily
+elects to apply CC0 to the Work and publicly distribute the Work under its
+terms, with knowledge of his or her Copyright and Related Rights in the
+Work and the meaning and intended legal effect of CC0 on those rights.
+
+1. Copyright and Related Rights. A Work made available under CC0 may be
+protected by copyright and related or neighboring rights ("Copyright and
+Related Rights"). Copyright and Related Rights include, but are not
+limited to, the following:
+
+  i. the right to reproduce, adapt, distribute, perform, display,
+     communicate, and translate a Work;
+ ii. moral rights retained by the original author(s) and/or performer(s);
+iii. publicity and privacy rights pertaining to a person's image or
+     likeness depicted in a Work;
+ iv. rights protecting against unfair competition in regards to a Work,
+     subject to the limitations in paragraph 4(a), below;
+  v. rights protecting the extraction, dissemination, use and reuse of data
+     in a Work;
+ vi. database rights (such as those arising under Directive 96/9/EC of the
+     European Parliament and of the Council of 11 March 1996 on the legal
+     protection of databases, and under any national implementation
+     thereof, including any amended or successor version of such
+     directive); and
+vii. other similar, equivalent or corresponding rights throughout the
+     world based on applicable law or treaty, and any national
+     implementations thereof.
+
+2. Waiver. To the greatest extent permitted by, but not in contravention
+of, applicable law, Affirmer hereby overtly, fully, permanently,
+irrevocably and unconditionally waives, abandons, and surrenders all of
+Affirmer's Copyright and Related Rights and associated claims and causes
+of action, whether now known or unknown (including existing as well as
+future claims and causes of action), in the Work (i) in all territories
+worldwide, (ii) for the maximum duration provided by applicable law or
+treaty (including future time extensions), (iii) in any current or future
+medium and for any number of copies, and (iv) for any purpose whatsoever,
+including without limitation commercial, advertising or promotional
+purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each
+member of the public at large and to the detriment of Affirmer's heirs and
+successors, fully intending that such Waiver shall not be subject to
+revocation, rescission, cancellation, termination, or any other legal or
+equitable action to disrupt the quiet enjoyment of the Work by the public
+as contemplated by Affirmer's express Statement of Purpose.
+
+3. Public License Fallback. Should any part of the Waiver for any reason
+be judged legally invalid or ineffective under applicable law, then the
+Waiver shall be preserved to the maximum extent permitted taking into
+account Affirmer's express Statement of Purpose. In addition, to the
+extent the Waiver is so judged Affirmer hereby grants to each affected
+person a royalty-free, non transferable, non sublicensable, non exclusive,
+irrevocable and unconditional license to exercise Affirmer's Copyright and
+Related Rights in the Work (i) in all territories worldwide, (ii) for the
+maximum duration provided by applicable law or treaty (including future
+time extensions), (iii) in any current or future medium and for any number
+of copies, and (iv) for any purpose whatsoever, including without
+limitation commercial, advertising or promotional purposes (the
+"License"). The License shall be deemed effective as of the date CC0 was
+applied by Affirmer to the Work. Should any part of the License for any
+reason be judged legally invalid or ineffective under applicable law, such
+partial invalidity or ineffectiveness shall not invalidate the remainder
+of the License, and in such case Affirmer hereby affirms that he or she
+will not (i) exercise any of his or her remaining Copyright and Related
+Rights in the Work or (ii) assert any associated claims and causes of
+action with respect to the Work, in either case contrary to Affirmer's
+express Statement of Purpose.
+
+4. Limitations and Disclaimers.
+
+ a. No trademark or patent rights held by Affirmer are waived, abandoned,
+    surrendered, licensed or otherwise affected by this document.
+ b. Affirmer offers the Work as-is and makes no representations or
+    warranties of any kind concerning the Work, express, implied,
+    statutory or otherwise, including without limitation warranties of
+    title, merchantability, fitness for a particular purpose, non
+    infringement, or the absence of latent or other defects, accuracy, or
+    the present or absence of errors, whether or not discoverable, all to
+    the greatest extent permissible under applicable law.
+ c. Affirmer disclaims responsibility for clearing rights of other persons
+    that may apply to the Work or any use thereof, including without
+    limitation any person's Copyright and Related Rights in the Work.
+    Further, Affirmer disclaims responsibility for obtaining any necessary
+    consents, permissions or other rights required for any use of the
+    Work.
+ d. Affirmer understands and acknowledges that Creative Commons is not a
+    party to this document and has no duty or obligation with respect to
+    this CC0 or use of the Work.

LICENSE LICENSE.fugitive-gitlabLICENSE renamed to LICENSE.fugitive-gitlab

@@ -1,59 +1,70 @@
-# fugitive-gitlab.vim
+# fugitive-cgit.vim
 
-[![Fugitive GitLab](https://github.com/shumphrey/fugitive-gitlab.vim/actions/workflows/vader.yml/badge.svg?branch=master)](https://github.com/shumphrey/fugitive-gitlab.vim/actions/workflows/vader.yml)
+[![Fugitive cgit](https://github.com/sudotac/fugitive-cgit.vim/actions/workflows/vader.yml/badge.svg?branch=master)](https://github.com/sudotac/fugitive-cgit.vim/actions/workflows/vader.yml)
 
 [fugitive.vim][] is undoubtedly the best Git wrapper of all time.
 
-This plugin allows you to use it with https://gitlab.com or your own
-private GitLab instance.
+This plugin allows you to use it with a cgit instance.
 
-* Enables `:GBrowse` from fugitive.vim to open GitLab URLs
-
-* In commit messages, GitLab issues and users can be omni-completed
-  (`<C-X><C-O>`, see `:help compl-omni`).
+* Enables `:GBrowse` from fugitive.vim to open cgit URLs
 
 ## Installation
 
 Install it as you would install [fugitive.vim][]
 (you will also need [fugitive.vim][] installed)
 
-To use private GitLab instances, add the following to your .vimrc
+To use cgit instances, add the following to your .vimrc
 
-    let g:fugitive_gitlab_domains = ['https://my.gitlab.com']
+    let g:fugitive_cgit_domains = ['https://git.example.com']
 
-If the private GitLab instance uses different URLs, for example, one for SSH
-and another for HTTPS, instead add the following to your .vimrc
+If the cgit instance uses different URLs, for example, one for SSH and another
+for HTTPS, instead add the following to your .vimrc
 
-    let g:fugitive_gitlab_domains = {'ssh://my-ssh.gitlab.com': 'https://my.gitlab.com'}
+    let g:fugitive_cgit_domains = {'ssh://git.example.com': 'https://git.example.com'}
 
-Fugitive command `:GBrowse` will now work with GitLab URLs.
+Fugitive command `:GBrowse` will now work with cgit URLs.
 
-[Curl](http://curl.haxx.se/) is required for features
-that use the GitLab API (i.e., `:GBrowse` doesn't need it).
-[Generate a personal access token](https://gitlab.com/profile/personal_access_tokens)
-with api permissions and add it to your vimrc
+If you need more complicated configuration, please refer to
+`:help fugitive-cgit-config` for more details.
 
-    let g:gitlab_api_keys = {'gitlab.com': 'myaccesstoken'}
+## Requirements
 
-To use omnicompletion with a private GitLab repository
+fugitive-cgit.vim requires a modern [fugitive.vim][].
 
-    let g:gitlab_api_keys = {'gitlab.com': 'mytoken1', 'my.gitlab.private': 'mytoken2' }
+[fugitive.vim]: https://github.com/tpope/vim-fugitive
 
-Omnicompletion functionality is subject to change.
+## Examples
 
-## Requirements
+### Linux kernel git repository
 
-fugitive-gitlab.vim requires a modern [fugitive.vim][].
-API features require a GitLab instance with v4 of the API.
+```vim
+let g:fugitive_cgit_domains = ['https://git.kernel.org']
+```
 
-[fugitive.vim]: https://github.com/tpope/vim-fugitive
+### ZX2C4 Git Repository
 
-## FAQ
+```vim
+let g:fugitive_cgit_domains = {
+    \     'https://git.zx2c4.com': {
+    \         'root': 'https://git.zx2c4.com',
+    \         'remove-git-suffix': v:true
+    \     }
+    \ }
+```
 
-> How do I turn off that preview window that shows the issue body?
+### GNU's Savannah
 
-    set completeopt-=preview
+```vim
+let g:fugitive_cgit_domains = {
+    \     'https://git.savannah.gnu.org': {
+    \         'root': 'https://git.savannah.gnu.org/cgit',
+    \         'prefix': 'git'
+    \     }
+    \ }
+```
+
+## FAQ
 
 > Why doesn't this plugin have a pun name?
 
-I couldn't think of one.
+I couldn't think of one, either.

README.md

@@ -1,5 +1,3 @@
 
-" autoload/gitlab/fugitive.vim - stuff relating to fugitive, e.g. :GBrowse
-" autoload/gitlab/api.vim - stuff relating to gitlab api
-" autoload/gitlab/omnifunc.vim - stuff relating to gitlab omnifunc
-" autoload/gitlab/utils.vim - shared utilities
+" autoload/cgit/fugitive.vim - stuff relating to fugitive, e.g. :GBrowse
+" autoload/cgit/utils.vim - shared utilities

autoload/README

@@ -0,0 +1,104 @@
+if exists('g:autoloaded_fugitive_cgit_fugitive')
+    finish
+endif
+let g:autoloaded_fugitive_cgit_fugitive = 1
+
+function! cgit#fugitive#handler(opts, ...)
+    let path   = substitute(get(a:opts, 'path', ''), '^/', '', '')
+    let commit = get(a:opts, 'commit')
+    let type   = get(a:opts, 'type')
+    let line1  = get(a:opts, 'line1')
+    let line2  = get(a:opts, 'line2')
+    let remote = get(a:opts, 'remote')
+
+    let root = cgit#fugitive#homepage_for_remote(remote)
+    if empty(root)
+        return ''
+    endif
+
+    " work out what branch/commit/tag/etc we're on
+    " if file is a git/ref, we can go to a /commit cgit url
+    " If the branch/tag doesn't exist upstream, the URL won't be valid
+    " Could check upstream refs?
+    if path =~# '^\.git/refs/heads/'
+        return root . '/log/' . path[16:-1]
+    elseif path =~# '^\.git/refs/tags/'
+        return root . '/tag/?h=' . path[15:-1]
+    elseif path =~# '^\.git/refs/.'
+        return root . '/commit/' . path[10:-1]
+    elseif path =~# '^\.git\>'
+        return root
+    endif
+
+    " check if 'commit' is actually commit-id or not.
+    " FIXME: cannot handle the branch name which consists of 40 character hex string.
+    " It's technically possible, though I haven't seen such a branch name...
+    if commit =~# '^\x\{40\}'
+        let key = 'id'
+    else
+        let key = 'h'
+    endif
+
+    if type ==# 'tree' || path =~# '/$'
+        let path = substitute(path, '/$', '', '')
+        let dir = 'tree'
+    elseif type ==# 'blob' || path =~# '[^/]$'
+        let dir = 'tree'
+    else
+        let dir = 'commit'
+    endif
+
+    " NOTE: Range selection is not supported in cgit
+    return root.'/'.dir.'/'.path.'?'.key.'='.commit.(line2 ? '#n'.line1 : '')
+endfunction
+
+function! cgit#fugitive#homepage_for_remote(url) abort
+    let domains = cgit#utils#parse_cgit_domains()
+
+    " https://git-scm.com/book/en/v2/Git-on-the-Server-The-Protocols
+    " [full_url, scheme, host_with_port, host, path]
+    " NOTE: In cgit, '.git' suffix should be preserved as-is.
+    if a:url =~# '://'
+        let match = matchlist(a:url, '^\(https\=://\|git://\|ssh://\)\%([^@/]\+@\)\=\(\([^/:]\+\)\%(:\d\+\)\=\)\(.\{-\}\%(\.git\)\=\)/\=$')
+    else
+        let match = matchlist(a:url, '^\([^@/]\+@\)\=\(\([^:/]\+\)\):\(.\{-\}\%(\.git\)\=\)/\=$')
+        if empty(match)
+            return ''
+        endif
+        let match[1] = 'ssh://'
+    endif
+
+    if empty(match)
+        return ''
+    elseif has_key(domains, match[1] . match[2])
+        let key = match[1] . match[2]
+    elseif has_key(domains, match[1] . match[3])
+        let key = match[1] . match[3]
+    elseif has_key(domains, match[2])
+        let key = match[2]
+    elseif has_key(domains, match[3])
+        let key = match[3]
+    else
+        return ''
+    endif
+
+    let root = get(domains[key], 'root')
+    if empty(root)
+        return ''
+    elseif root !~# '://'
+        let root = (match[1] =~# '^http://' ? 'http://' : 'https://') . root
+    endif
+
+    let path = match[4]
+    if get(domains[key], 'remove-git-suffix')
+        let path = substitute(path, '\.git$', '', '')
+    endif
+
+    let prefix = get(domains[key], 'prefix')
+    if type(prefix) == type('') && !empty(prefix) && strpart(path, 0, strlen(prefix)) == prefix
+        let path = strpart(path, strlen(prefix))
+    endif
+    return substitute(root, '/\+$', '', '') . '/' . substitute(path, '^/\+', '', '')
+endfunction
+
+" vim: set ts=4 sw=4 et foldmethod=indent foldnestmax=1 :

autoload/cgit/fugitive.vim

@@ -0,0 +1,37 @@
+if exists('g:autoloaded_fugitive_cgit_utils')
+    finish
+endif
+let g:autoloaded_fugitive_cgit_utils = 1
+
+function! cgit#utils#throw(string) abort
+    let v:errmsg = 'cgit: '.a:string
+    throw v:errmsg
+endfunction
+
+function! cgit#utils#parse_cgit_domains() abort
+    let dict_or_list = get(g:, 'fugitive_cgit_domains', {})
+    let domains = {} " no pre-defined domains
+
+    if type(dict_or_list) == type([])
+        for domain in dict_or_list
+            let lhs = substitute(substitute(domain, '^.\{-\}://', '', ''), '/.*', '', '')
+            let domains[lhs] = {'root': domain}
+        endfor
+    elseif type(dict_or_list) == type({})
+        for [key, val] in items(dict_or_list)
+            if type(val) == type('')
+                let domains[key] = {'root': val}
+            elseif type(val) == type({})
+                if !has_key(val, 'root')
+                    call cgit#utils#throw($"g:fugitive_cgit_domains['{key}']['root'] is required")
+                endif
+                let domains[key] = val
+            else
+                call cgit#utils#throw($"g:fugitive_cgit_domains['{key}'] should be a string or a dictionary")
+            endif
+        endfor
+    endif
+    return domains
+endfunction
+
+" vim: set ts=4 sw=4 et foldmethod=indent foldnestmax=1 :