mirror of
https://github.com/kataras/iris.git
synced 2026-01-10 05:25:58 +00:00
Start of the internal cmd
gen website examples is the first command that I should finish soon because we need it for the website's "Recipe" page. Two more html query-relative dependencies added. Former-commit-id: 04b7f8bb968cbc3c441e2a09a4aa525b10cd4aca
This commit is contained in:
kataras
133
internal/cmd/gen/website/examples/README.md
Normal file
133
internal/cmd/gen/website/examples/README.md
Normal file
@@ -0,0 +1,133 @@
|
||||
# Examples generate command
|
||||
|
||||
## Running methods
|
||||
|
||||
### Build and run each time
|
||||
```sh
|
||||
$ cd $GOPATH/src/github.com/kataras/iris/internal/cmd
|
||||
$ go run main.go gen website examples >> recipe_content.html
|
||||
```
|
||||
|
||||
### Using an executable
|
||||
```sh
|
||||
$ cd $GOPATH/src/github.com/kataras/iris/internal/cmd
|
||||
$ go build
|
||||
# rename the binary, executable file, to something like "iris" or "iris.exe" for win
|
||||
# copy it to your systems folder or to the $GOPATH/bin
|
||||
```
|
||||
And use that command instead:
|
||||
```sh
|
||||
$ iris gen website examples >> recipe_content.html
|
||||
```
|
||||
> That executable can be copied and used anywhere.
|
||||
|
||||
## Action
|
||||
|
||||
This command should write to the argument output `>>` or print to the `os.Stdout` something like this:
|
||||
```html
|
||||
<h2 id="Beginner"><a href="#Beginner" class="headerlink" title="Beginner"></a>Beginner</h2>
|
||||
<h3 id="Hello-World"><a href="#Hello-World" class="headerlink" title="Hello World"></a>Hello World</h3>
|
||||
<pre data-src="https://raw.githubusercontent.com/kataras/iris/master/_examples/beginner/hello-world/main.go" data-visible="true" class ="line-numbers codepre"></pre>
|
||||
|
||||
<h3 id="Overview"><a href="#Overview" class="headerlink" title="Overview"></a>Overview</h3>
|
||||
<pre data-src="https://raw.githubusercontent.com/kataras/iris/master/_examples/beginner/overview/main.go" data-visible="true" class ="line-numbers codepre"></pre>
|
||||
|
||||
<h3 id="Internal-Application-File-Logger"><a href="#Internal-Application-File-Logger" class="headerlink" title="Internal Application File Logger"></a>Internal
|
||||
Application File Logger</h3>
|
||||
<pre data-src="https://raw.githubusercontent.com/kataras/iris/master/_examples/beginner/file-logger/main.go" class ="line-numbers codepre"></pre>
|
||||
|
||||
<h3 id="Write-JSON"><a href="#Write-JSON" class="headerlink" title="Write JSON"></a>Write JSON</h3>
|
||||
<pre data-src="https://raw.githubusercontent.com/kataras/iris/master/_examples/beginner/write-json/main.go" class ="line-numbers codepre"></pre>
|
||||
|
||||
<h3 id="Read-JSON"><a href="#Read-JSON" class="headerlink" title="Read JSON"></a>Read JSON</h3>
|
||||
<pre data-src="https://raw.githubusercontent.com/kataras/iris/master/_examples/beginner/read-json/main.go" class ="line-numbers codepre"></pre>
|
||||
|
||||
<h3 id="Read-Form"><a href="#Read-Form" class="headerlink" title="Read Form"></a>Read Form</h3>
|
||||
<pre data-src="https://raw.githubusercontent.com/kataras/iris/master/_examples/beginner/read-form/main.go" class ="line-numbers codepre"></pre>
|
||||
|
||||
<h3 id="Favicon"><a href="#Favicon" class="headerlink" title="Favicon"></a>Favicon</h3>
|
||||
<pre data-src="https://raw.githubusercontent.com/kataras/iris/master/_examples/beginner/favicon/main.go" class ="line-numbers codepre"></pre>
|
||||
|
||||
<h3 id="File-Server"><a href="#File-Server" class="headerlink" title="File Server"></a>File Server</h3>
|
||||
<pre data-src="https://raw.githubusercontent.com/kataras/iris/master/_examples/beginner/file-server/main.go" class ="line-numbers codepre"></pre>
|
||||
|
||||
<h3 id="Send-Files"><a href="#Send-Files" class="headerlink" title="Send Files"></a>Send Files</h3>
|
||||
<pre data-src="https://raw.githubusercontent.com/kataras/iris/master/_examples/beginner/send-files/main.go" class ="line-numbers codepre"></pre>
|
||||
|
||||
<h3 id="Stream-Writer"><a href="#Stream-Writer" class="headerlink" title="Stream Writer"></a>Stream Writer</h3>
|
||||
<pre data-src="https://raw.githubusercontent.com/kataras/iris/master/_examples/beginner/stream-writer/main.go" class ="line-numbers codepre"></pre>
|
||||
|
||||
<h3 id="Listen-UNIX-Socket"><a href="#Listen-UNIX-Socket" class="headerlink" title="Listen UNIX Socket"></a>Listen UNIX Socket</h3>
|
||||
<pre data-src="https://raw.githubusercontent.com/kataras/iris/master/_examples/beginner/listen-unix/main.go" class ="line-numbers codepre"></pre>
|
||||
|
||||
<h3 id="Listen-TLS"><a href="#Listen-TLS" class="headerlink" title="Listen TLS"></a>Listen TLS</h3>
|
||||
<pre data-src="https://raw.githubusercontent.com/kataras/iris/master/_examples/beginner/listen-tls/main.go" class ="line-numbers codepre"></pre>
|
||||
|
||||
<h3 id="Listen-Letsencrypt-Automatic-Certifications"><a href="#Listen-Letsencrypt-Automatic-Certifications" class="headerlink" title="Listen Letsencrypt (Automatic Certifications)"></a>Listen
|
||||
Letsencrypt (Automatic Certifications)</h3>
|
||||
<pre data-src="https://raw.githubusercontent.com/kataras/iris/master/_examples/beginner/listen-letsencrypt/main.go" class ="line-numbers codepre"></pre>
|
||||
|
||||
<h2 id="Intermediate"><a href="#Intermediate" class="headerlink" title="Intermediate"></a>Intermediate</h2>
|
||||
<h3 id="Send-an-email"><a href="#Send-an-email" class="headerlink" title="Send an email"></a>Send an email</h3>
|
||||
<pre data-src="https://raw.githubusercontent.com/kataras/iris/master/_examples/intermediate/e-mail/main.go" class ="line-numbers codepre"></pre>
|
||||
|
||||
<h3 id="Upload-Read-Files"><a href="#Upload-Read-Files" class="headerlink" title="Upload/Read Files"></a>Upload/Read Files</h3>
|
||||
<pre data-src="https://raw.githubusercontent.com/kataras/iris/master/_examples/intermediate/upload-files/main.go" class ="line-numbers codepre"></pre>
|
||||
|
||||
<h3 id="Request-Logger"><a href="#Request-Logger" class="headerlink" title="Request Logger"></a>Request Logger</h3>
|
||||
<pre data-src="https://raw.githubusercontent.com/kataras/iris/master/_examples/intermediate/request-logger/main.go" class ="line-numbers codepre"></pre>
|
||||
|
||||
<h3 id="Profiling-pprof"><a href="#Profiling-pprof" class="headerlink" title="Profiling (pprof)"></a>Profiling (pprof)</h3>
|
||||
<pre data-src="https://raw.githubusercontent.com/kataras/iris/master/_examples/intermediate/pprof/main.go" class ="line-numbers codepre"></pre>
|
||||
|
||||
<h3 id="Basic-Authentication"><a href="#Basic-Authentication" class="headerlink" title="Basic Authentication"></a>Basic Authentication</h3>
|
||||
<pre data-src="https://raw.githubusercontent.com/kataras/iris/master/_examples/intermediate/basicauth/main.go" class ="line-numbers codepre"></pre>
|
||||
|
||||
<h3 id="HTTP-Access-Control"><a href="#HTTP-Access-Control" class="headerlink" title="HTTP Access Control"></a>HTTP Access Control</h3>
|
||||
<pre data-src="https://raw.githubusercontent.com/kataras/iris/master/_examples/intermediate/cors/main.go" class ="line-numbers codepre"></pre>
|
||||
|
||||
<h3 id="Cache-Markdown"><a href="#Cache-Markdown" class="headerlink" title="Cache Markdown"></a>Cache Markdown</h3>
|
||||
<pre data-src="https://raw.githubusercontent.com/kataras/iris/master/_examples/intermediate/cache-markdown/main.go" class ="line-numbers codepre"></pre>
|
||||
|
||||
<h3 id="Localization-and-Internationalization"><a href="#Localization-and-Internationalization" class="headerlink" title="Localization and Internationalization"></a>Localization
|
||||
and Internationalization</h3>
|
||||
<pre data-src="https://raw.githubusercontent.com/kataras/iris/master/_examples/intermediate/i18n/main.go" class ="line-numbers codepre"></pre>
|
||||
|
||||
<h3 id="Recovery"><a href="#Recovery" class="headerlink" title="Recovery"></a>Recovery</h3>
|
||||
<pre data-src="https://raw.githubusercontent.com/kataras/iris/master/_examples/intermediate/recover/main.go" class ="line-numbers codepre"></pre>
|
||||
|
||||
<h3 id="Graceful-Shutdown"><a href="#Graceful-Shutdown" class="headerlink" title="Graceful Shutdown"></a>Graceful Shutdown</h3>
|
||||
<pre data-src="https://raw.githubusercontent.com/kataras/iris/master/_examples/intermediate/graceful-shutdown/main.go" class ="line-numbers codepre"></pre>
|
||||
|
||||
<h3 id="Custom-TCP-Listener"><a href="#Custom-TCP-Listener" class="headerlink" title="Custom TCP Listener"></a>Custom TCP Listener</h3>
|
||||
<pre data-src="https://raw.githubusercontent.com/kataras/iris/master/_examples/intermediate/custom-listener/main.go" class ="line-numbers codepre"></pre>
|
||||
|
||||
<h3 id="Custom-HTTP-Server"><a href="#Custom-HTTP-Server" class="headerlink" title="Custom HTTP Server"></a>Custom HTTP Server</h3>
|
||||
<pre data-src="https://raw.githubusercontent.com/kataras/iris/master/_examples/intermediate/custom-httpserver/main.go" class ="line-numbers codepre"></pre>
|
||||
|
||||
<h3 id="Password-Hashing"><a href="#Password-Hashing" class="headerlink" title="Password Hashing"></a>Password Hashing</h3>
|
||||
<pre data-src="https://raw.githubusercontent.com/kataras/iris/master/_examples/intermediate/password-hashing/main.go" class ="line-numbers codepre"></pre>
|
||||
|
||||
<h3 id="Flash-Messages"><a href="#Flash-Messages" class="headerlink" title="Flash Messages"></a>Flash Messages</h3>
|
||||
<pre data-src="https://raw.githubusercontent.com/kataras/iris/master/_examples/intermediate/flash-messages/main.go" class ="line-numbers codepre"></pre>
|
||||
|
||||
<h2 id="Advance"><a href="#Advance" class="headerlink" title="Advance"></a>Advance</h2>
|
||||
<h3 id="Transactions"><a href="#Transactions" class="headerlink" title="Transactions"></a>Transactions</h3>
|
||||
<pre data-src="https://raw.githubusercontent.com/kataras/iris/master/_examples/advanced/transactions/main.go" class ="line-numbers codepre"></pre>
|
||||
|
||||
<h3 id="HTTP-Testing"><a href="#HTTP-Testing" class="headerlink" title="HTTP Testing"></a>HTTP Testing</h3>
|
||||
<pre data-src="https://raw.githubusercontent.com/kataras/iris/master/_examples/advanced/httptest/main_test.go" class ="line-numbers codepre"></pre>
|
||||
|
||||
<h3 id="Watch-amp-Compile-Typescript-source-files"><a href="#Watch-amp-Compile-Typescript-source-files" class="headerlink" title="Watch & Compile Typescript source files"></a>Watch
|
||||
& Compile Typescript source files</h3>
|
||||
<pre data-src="https://raw.githubusercontent.com/kataras/iris/master/_examples/advanced/typescript/main.go" class ="line-numbers codepre"></pre>
|
||||
|
||||
<h3 id="Cloud-Editor"><a href="#Cloud-Editor" class="headerlink" title="Cloud Editor"></a>Cloud Editor</h3>
|
||||
<pre data-src="https://raw.githubusercontent.com/kataras/iris/master/_examples/advanced/cloud-editor/main.go" class ="line-numbers codepre"></pre>
|
||||
|
||||
<h3 id="Online-Visitors"><a href="#Online-Visitors" class="headerlink" title="Online Visitors"></a>Online Visitors</h3>
|
||||
<pre data-src="https://raw.githubusercontent.com/kataras/iris/master/_examples/advanced/online-visitors/main.go" class ="line-numbers codepre"></pre>
|
||||
|
||||
<h3 id="URL-Shortener-using-BoltDB"><a href="#URL-Shortener-using-BoltDB" class="headerlink" title="URL Shortener using BoltDB"></a>URL Shortener using BoltDB</h3>
|
||||
<pre data-src="https://raw.githubusercontent.com/kataras/iris/master/_examples/advanced/url-shortener/main.go" class ="line-numbers codepre"></pre>
|
||||
```
|
||||
13
internal/cmd/gen/website/examples/example.go
Normal file
13
internal/cmd/gen/website/examples/example.go
Normal file
@@ -0,0 +1,13 @@
|
||||
package examples
|
||||
|
||||
// Category defines the category of which will contain examples.
|
||||
type Category struct {
|
||||
Name string // i.e "Beginner", "Intermediate", "Advanced", first upper.
|
||||
Examples []Example
|
||||
}
|
||||
|
||||
// Example defines the example link.
|
||||
type Example struct {
|
||||
Name string // i.e: Hello World
|
||||
DataSource string // i.e: https://raw.githubusercontent.com/kataras/iris/master/_examples/beginner/hello-world.go
|
||||
}
|
||||
123
internal/cmd/gen/website/examples/parser.go
Normal file
123
internal/cmd/gen/website/examples/parser.go
Normal file
@@ -0,0 +1,123 @@
|
||||
package examples
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"io"
|
||||
"io/ioutil"
|
||||
"net/http"
|
||||
|
||||
"github.com/PuerkitoBio/goquery"
|
||||
"github.com/kataras/iris/core/errors"
|
||||
"github.com/microcosm-cc/bluemonday"
|
||||
"github.com/russross/blackfriday"
|
||||
)
|
||||
|
||||
// we could directly query and parse the github page for _examples and take
|
||||
// the examples from its folders, without even the need of a readme to be exist. But I will not do that
|
||||
// because github may change its structure to these folders, so its safer to just:
|
||||
// convert the raw readme.md to the html
|
||||
// query the new html and parse its ul and li tags,
|
||||
// markdown syntax for these things will (never) change, so I assume it will work for a lot of years.
|
||||
const (
|
||||
branch = "master"
|
||||
// rootURL = "https://github.com/kataras/iris/tree/" + branch + "/_examples"
|
||||
// rawRootURL = "https://raw.githubusercontent.com/kataras/iris/"+branch"/_examples/"
|
||||
contentsURL = "https://raw.githubusercontent.com/kataras/iris/" + branch + "/_examples/README.md"
|
||||
tableOfContents = "Table of contents"
|
||||
sanitizeMarkdown = true
|
||||
)
|
||||
|
||||
// WriteExamplesTo will write all examples to the "w"
|
||||
func WriteExamplesTo(w io.Writer) (categories []Category, err error) {
|
||||
// if len(categoryName) == 0 {
|
||||
// return nil, errors.New("category is empty")
|
||||
// }
|
||||
// categoryName = strings.ToTitle(categoryName) // i.e Category Name
|
||||
|
||||
// category := Category{
|
||||
// Name: categoryName,
|
||||
// }
|
||||
|
||||
// get the raw markdown
|
||||
res, err := http.Get(contentsURL)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
markdownContents, err := ioutil.ReadAll(res.Body)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
// convert it to html
|
||||
htmlContents := &bytes.Buffer{}
|
||||
htmlContentsFromMarkdown := blackfriday.MarkdownCommon(markdownContents)
|
||||
|
||||
if len(htmlContentsFromMarkdown) == 0 {
|
||||
return nil, errors.New("empty html")
|
||||
}
|
||||
|
||||
if sanitizeMarkdown {
|
||||
markdownContents = bluemonday.UGCPolicy().SanitizeBytes(markdownContents)
|
||||
}
|
||||
|
||||
htmlContents.Write(htmlContentsFromMarkdown)
|
||||
// println("html contents: " + htmlContents.String())
|
||||
// get the document from the html
|
||||
readme, err := goquery.NewDocumentFromReader(htmlContents)
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
// or with just one line (but may break if we add another h2, so I will do it with the hard and un-readable way for now)
|
||||
// readme.Find("h2").First().NextAllFiltered("ul").Children().Text()
|
||||
|
||||
// find the header of Table Of Contents, we will need it to take its
|
||||
// next ul, which should be the examples list.
|
||||
var tableOfContentsHeader *goquery.Selection
|
||||
readme.Find("h2").EachWithBreak(func(_ int, n *goquery.Selection) bool {
|
||||
if nodeContents := n.Text(); nodeContents == tableOfContents {
|
||||
tableOfContentsHeader = n
|
||||
return false // break
|
||||
}
|
||||
return true
|
||||
})
|
||||
|
||||
// println(tableOfContentsHeader.Text())
|
||||
|
||||
if tableOfContentsHeader == nil {
|
||||
return nil, errors.New("table of contents not found using: " + tableOfContents)
|
||||
}
|
||||
|
||||
// get the list of the examples
|
||||
tableOfContentsUL := tableOfContentsHeader.NextAllFiltered("ul")
|
||||
if tableOfContentsUL == nil {
|
||||
return nil, errors.New("table of contents list not found")
|
||||
}
|
||||
|
||||
// iterate over categories example's <a href ...>...</a>
|
||||
tableOfContentsUL.Children().EachWithBreak(func(_ int, li *goquery.Selection) bool {
|
||||
exampleHrefLink := li.Children().First()
|
||||
if exampleHrefLink == nil {
|
||||
err = errors.New("example link href is nil, source: " + li.Text())
|
||||
return false // break on first failure
|
||||
}
|
||||
|
||||
categoryName := exampleHrefLink.Text()
|
||||
|
||||
println(categoryName)
|
||||
|
||||
category := Category{
|
||||
Name: categoryName,
|
||||
}
|
||||
|
||||
_ = category
|
||||
|
||||
li.Find("ul").Children().Each(func(_ int, liExample *goquery.Selection) {
|
||||
println(liExample.Text())
|
||||
})
|
||||
|
||||
return true
|
||||
})
|
||||
|
||||
return nil, err
|
||||
}
|
||||
Reference in New Issue
Block a user