github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/x/docs/docs.go (about)

     1  // Copyright (c) 2018 Uber Technologies, Inc.
     2  //
     3  // Permission is hereby granted, free of charge, to any person obtaining a copy
     4  // of this software and associated documentation files (the "Software"), to deal
     5  // in the Software without restriction, including without limitation the rights
     6  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     7  // copies of the Software, and to permit persons to whom the Software is
     8  // furnished to do so, subject to the following conditions:
     9  //
    10  // The above copyright notice and this permission notice shall be included in
    11  // all copies or substantial portions of the Software.
    12  //
    13  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    14  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    15  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    16  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    17  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    18  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    19  // THE SOFTWARE.
    20  
    21  package docs
    22  
    23  import (
    24  	"fmt"
    25  	"regexp"
    26  )
    27  
    28  var (
    29  	// repoPathURLRegexp provides a regular expression that returns true/false
    30  	// whether a URL is a repository path URL.
    31  	// It uses capture groups to help us extract the relative repository path
    32  	// that the URL points to.
    33  	repoPathURLRegexp = regexp.MustCompile(
    34  		`^https://github.com/m3db/.*/blob/[a-zA-Z0-9]+/([-_.a-zA-Z0-9/]+)(#?.*)(\??.*)$`)
    35  )
    36  
    37  const (
    38  	// repoPathURLPathIndex is the capture group for the asset path in the URL.
    39  	repoPathURLPathIndex = 1
    40  )
    41  
    42  // Path returns the url to the given section of documentation.
    43  func Path(section string) string {
    44  	return fmt.Sprintf("https://docs.m3db.io/%s", section)
    45  }
    46  
    47  // RepoPathURL is a URL that points to a path in the repository, helpful
    48  // for identifying links that link to assets in the repository from our
    49  // documentation.
    50  type RepoPathURL struct {
    51  	// RepoPath is the relative path to an asset in the repository.
    52  	RepoPath string
    53  }
    54  
    55  // ParseRepoPathURL will return true and the details of the repository path
    56  // URL if the URL is a URL that points to an asset in the repository, or
    57  // false otherwise.
    58  func ParseRepoPathURL(url string) (RepoPathURL, bool) {
    59  	if !repoPathURLRegexp.MatchString(url) {
    60  		return RepoPathURL{}, false
    61  	}
    62  
    63  	matches := repoPathURLRegexp.FindStringSubmatch(url)
    64  	path := matches[repoPathURLPathIndex]
    65  	return RepoPathURL{RepoPath: path}, true
    66  }