yeray/gobyexample
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add isDir() checks for measure.go and generate.go in tools

Browse Source 
Signed-off-by: peterzhu1992 <peterzhu1992@gmail.com>
This commit is contained in:
peterzhu1992 2022-05-24 00:08:09 -04:00
parent 40ac3bff37
commit 1d932995f6
No known key found for this signature in database
GPG Key ID: AE1C56C7D03DDA1C
11 changed files with 99 additions and 82 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
examples/embed-directive/embed-directive.go
View File

@ -27,13 +27,13 @@ var folder_FS embed.FS
func main() { func main() {
// Print out the content of `example_single_file.txt` as `string`. // Print out content of `example_single_file.txt` as `string`.
print(single_file_string) print(single_file_string)
// Now handle `[]byte`.` // Now handle `[]byte`.
print(string(single_file_byte)) print(string(single_file_byte))
// Retrieve the file(s) matching `*.hash` pattern by reading from `folder_FS` first, // Retrieve file(s) matching `*.hash` pattern by reading from variable `folder_FS` first,
// then print out. // then print out.
hash_file1 := "example_folder/multi_file1.hash" hash_file1 := "example_folder/multi_file1.hash"
hash_file2 := "example_folder/multi_file2.hash" hash_file2 := "example_folder/multi_file2.hash"

4
examples/embed-directive/embed-directive.hash
View File

@ -1,2 +1,2 @@
33356517e565ff2d1f9d7f935012a326e8f5b3ea e996755d889f01c99c353616fb2bdeac6c3be6e6
yTsQsPe9jth -EXJc75EbN-

7
examples/embed-directive/embed-directive.sh
View File

@ -1,7 +1,6 @@
# Use these commands to run the example # Use these commands to run the example.
# Note: due to limitation on go playground # (Note: due to limitation on go playground,
# This example can only be run on your local machine # this example can only be run on your local machine.)
$ mkdir -p example_folder $ mkdir -p example_folder
$ echo "hello go" > example_folder/single_file.txt $ echo "hello go" > example_folder/single_file.txt
$ echo "123" > example_folder/multi_file1.hash $ echo "123" > example_folder/multi_file1.hash

102
public/embed-directive generated
View File

@ -9,12 +9,12 @@
onkeydown = (e) => { onkeydown = (e) => {
if (e.key == "ArrowLeft") { if (e.key == "ArrowLeft") {
window.location.href = 'struct-embedding'; window.location.href = 'temporary-files-and-directories';
} }
if (e.key == "ArrowRight") { if (e.key == "ArrowRight") {
window.location.href = 'generics'; window.location.href = 'testing-and-benchmarking';
} }
} }
@ -27,26 +27,13 @@
<tr> <tr>
<td class="docs"> <td class="docs">
<p>Starting in Go version 1.16+, Go supports use of <code>//go:embed</code> <p><code>//go:embed</code> is a compiler directive that allows programs to include arbitrary
which is a directive to embed files and folders into files/folders in the binary. Read more about go directive
the application binary by the compiler.</p> <a href="https://dave.cheney.net/2018/01/08/gos-hidden-pragmas">here</a>.</p>
</td>
<td class="code empty leading">
</td>
</tr>
<tr>
<td class="docs">
<p>Since Go does not have preprocessor or macros like C type of languages,
<code>pragmas/directives</code> are implemented by the compiler as comments <code>//</code>.
Using <code>//go:embed</code> tells the compiler to include arbitrary files/folders in binary.</p>
</td> </td>
<td class="code leading"> <td class="code leading">
<a href="http://play.golang.org/p/gk3Zh5Sx8rV"><img title="Run code" src="play.png" class="run" /></a><img title="Copy code" src="clipboard.png" class="copy" /> <a href="http://play.golang.org/p/-EXJc75EbN-"><img title="Run code" src="play.png" class="run" /></a><img title="Copy code" src="clipboard.png" class="copy" />
<pre class="chroma"> <pre class="chroma">
<span class="kn">package</span> <span class="nx">main</span> <span class="kn">package</span> <span class="nx">main</span>
</pre> </pre>
@ -55,17 +42,17 @@ Using <code>//go:embed</code> tells the compiler to include arbitrary files/fold
<tr> <tr>
<td class="docs"> <td class="docs">
<p>If you are not using any exported identifiers from <code>embed</code> package directly, <p>If no exported identifiers is directly used from <code>embed</code> package,
you can add an underscore <code>_</code> before the package name, ask Go to import <code>embed</code> you can add an underscore <code>_</code> before the package name. In this example, we simply
without directly using it, like this: <code>_ &quot;embed&quot;</code>. In this example, we remove the import it as we need to use the <code>embed.FS</code> type from the package.</p>
underscore as we need to use the <code>embed.FS</code> type from the package.</p>
</td> </td>
<td class="code leading"> <td class="code leading">
<pre class="chroma"> <pre class="chroma">
<span class="kn">import</span> <span class="p">(</span> <span class="kn">import</span> <span class="p">(</span>
<span class="s">&#34;embed&#34;</span> <span class="c1">//_ &#34;embed&#34;
</span><span class="c1"></span> <span class="s">&#34;embed&#34;</span>
<span class="p">)</span> <span class="p">)</span>
</pre> </pre>
</td> </td>
@ -80,7 +67,7 @@ this single file, followed by variable <code>single_file_string</code> to access
<td class="code leading"> <td class="code leading">
<pre class="chroma"> <pre class="chroma">
<span class="c1">//go:embed embed-directive.sh <span class="c1">//go:embed example_folder/single_file.txt
</span><span class="c1"></span><span class="kd">var</span> <span class="nx">single_file_string</span> <span class="kt">string</span> </span><span class="c1"></span><span class="kd">var</span> <span class="nx">single_file_string</span> <span class="kt">string</span>
</pre> </pre>
</td> </td>
@ -88,15 +75,13 @@ this single file, followed by variable <code>single_file_string</code> to access
<tr> <tr>
<td class="docs"> <td class="docs">
<p>Here is a similar example but include single file as <code>[]byte</code>. <p>Here is a similar example but include single file as <code>[]byte</code>.</p>
Note that <code>//go:embed</code> can only be used in package level,
define it in any function will result in error.</p>
</td> </td>
<td class="code leading"> <td class="code leading">
<pre class="chroma"> <pre class="chroma">
<span class="c1">//go:embed embed-directive.sh <span class="c1">//go:embed example_folder/single_file.txt
</span><span class="c1"></span><span class="kd">var</span> <span class="nx">single_file_byte</span> <span class="p">[]</span><span class="kt">byte</span> </span><span class="c1"></span><span class="kd">var</span> <span class="nx">single_file_byte</span> <span class="p">[]</span><span class="kt">byte</span>
</pre> </pre>
</td> </td>
@ -104,17 +89,14 @@ define it in any function will result in error.</p>
<tr> <tr>
<td class="docs"> <td class="docs">
<p>We can also embed multiple files or even folders with wildcard. <p>We can also embed multiple files or even folders with wildcard.</p>
Since Go resolves these files and folders during compile time, we have to use the files in
current working directory as examples. In practice, you can embed files with <code>&quot;//go:embed /path/to/folder&quot;</code>
or with another example <code>&quot;//go:embed /path/to/folder/*&quot;</code>. You can add multiple <code>//go:embed</code> before defining a variable.</p>
</td> </td>
<td class="code leading"> <td class="code leading">
<pre class="chroma"> <pre class="chroma">
<span class="c1">//go:embed *.hash <span class="c1">//go:embed example_folder/single_file.txt
</span><span class="c1">//go:embed embed-directive.sh </span><span class="c1">//go:embed example_folder/*.hash
</span><span class="c1"></span><span class="kd">var</span> <span class="nx">folder_FS</span> <span class="nx">embed</span><span class="p">.</span><span class="nx">FS</span> </span><span class="c1"></span><span class="kd">var</span> <span class="nx">folder_FS</span> <span class="nx">embed</span><span class="p">.</span><span class="nx">FS</span>
</pre> </pre>
</td> </td>
@ -133,42 +115,45 @@ or with another example <code>&quot;//go:embed /path/to/folder/*&quot;</code>. Y
<tr> <tr>
<td class="docs"> <td class="docs">
<p>Print out the content of <code>embed-directive.sh</code> as <code>string</code>.</p> <p>Print out content of <code>example_single_file.txt</code> as <code>string</code>.</p>
</td> </td>
<td class="code leading"> <td class="code leading">
<pre class="chroma"> <pre class="chroma">
<span class="nb">println</span><span class="p">(</span><span class="nx">single_file_string</span><span class="p">)</span> <span class="nb">print</span><span class="p">(</span><span class="nx">single_file_string</span><span class="p">)</span>
</pre> </pre>
</td> </td>
</tr> </tr>
<tr> <tr>
<td class="docs"> <td class="docs">
<p>Print out the content of <code>embed-directive.sh</code> as <code>[]byte</code>.</p> <p>Now handle <code>[]byte</code>.</p>
</td> </td>
<td class="code leading"> <td class="code leading">
<pre class="chroma"> <pre class="chroma">
<span class="nb">println</span><span class="p">(</span><span class="nb">string</span><span class="p">(</span><span class="nx">single_file_byte</span><span class="p">))</span> <span class="nb">print</span><span class="p">(</span><span class="nb">string</span><span class="p">(</span><span class="nx">single_file_byte</span><span class="p">))</span>
</pre> </pre>
</td> </td>
</tr> </tr>
<tr> <tr>
<td class="docs"> <td class="docs">
<p>Print out the content of <code>embed-directive.hash</code> by reading the file from <code>folder_FS</code> first, <p>Retrieve file(s) matching <code>*.hash</code> pattern by reading from variable <code>folder_FS</code> first,
then print out the content.</p> then print out.</p>
</td> </td>
<td class="code leading"> <td class="code leading">
<pre class="chroma"> <pre class="chroma">
<span class="nx">hash_file</span> <span class="o">:=</span> <span class="s">&#34;embed-directive.hash&#34;</span> <span class="nx">hash_file1</span> <span class="o">:=</span> <span class="s">&#34;example_folder/multi_file1.hash&#34;</span>
<span class="nx">hash_content</span><span class="p">,</span> <span class="nx">_</span> <span class="o">:=</span> <span class="nx">folder_FS</span><span class="p">.</span><span class="nf">ReadFile</span><span class="p">(</span><span class="nx">hash_file</span><span class="p">)</span> <span class="nx">hash_file2</span> <span class="o">:=</span> <span class="s">&#34;example_folder/multi_file2.hash&#34;</span>
<span class="nb">println</span><span class="p">(</span><span class="nb">string</span><span class="p">(</span><span class="nx">hash_content</span><span class="p">))</span> <span class="nx">hash_content1</span><span class="p">,</span> <span class="nx">_</span> <span class="o">:=</span> <span class="nx">folder_FS</span><span class="p">.</span><span class="nf">ReadFile</span><span class="p">(</span><span class="nx">hash_file1</span><span class="p">)</span>
<span class="nx">hash_content2</span><span class="p">,</span> <span class="nx">_</span> <span class="o">:=</span> <span class="nx">folder_FS</span><span class="p">.</span><span class="nf">ReadFile</span><span class="p">(</span><span class="nx">hash_file2</span><span class="p">)</span>
<span class="nb">print</span><span class="p">(</span><span class="nb">string</span><span class="p">(</span><span class="nx">hash_content1</span><span class="p">))</span>
<span class="nb">print</span><span class="p">(</span><span class="nb">string</span><span class="p">(</span><span class="nx">hash_content2</span><span class="p">))</span>
</pre> </pre>
</td> </td>
</tr> </tr>
@ -190,13 +175,32 @@ then print out the content.</p>
<tr> <tr>
<td class="docs"> <td class="docs">
<p>Use these commands to run the example</p> <p>Use these commands to run the example.
(Note: due to limitation on go playground,
this example can only be run on your local machine.)</p>
</td>
<td class="code leading">
<pre class="chroma">
<span class="gp">$</span> mkdir -p example_folder
<span class="gp">$</span> echo &#34;hello go&#34; &gt; example_folder/single_file.txt
<span class="gp">$</span> echo &#34;123&#34; &gt; example_folder/multi_file1.hash
<span class="gp">$</span> echo &#34;456&#34; &gt; example_folder/multi_file2.hash</pre>
</td>
</tr>
<tr>
<td class="docs">
</td> </td>
<td class="code"> <td class="code">
<pre class="chroma"> <pre class="chroma"><span class="gp">$</span> go run embed-directive.go
<span class="gp">$</span> go run embed-directive.go</pre> <span class="go">hello go
</span><span class="go">hello go
</span><span class="go">123
</span><span class="go">456</span></pre>
</td> </td>
</tr> </tr>
@ -204,7 +208,7 @@ then print out the content.</p>
<p class="next"> <p class="next">
Next example: <a href="generics">Generics</a>. Next example: <a href="testing-and-benchmarking">Testing and Benchmarking</a>.
</p> </p>
@ -215,7 +219,7 @@ then print out the content.</p>
</div> </div>
<script> <script>
var codeLines = []; var codeLines = [];
codeLines.push('');codeLines.push('package main\u000A');codeLines.push('import (\u000A \"embed\"\u000A)\u000A');codeLines.push('//go:embed embed-directive.sh\u000Avar single_file_string string\u000A');codeLines.push('//go:embed embed-directive.sh\u000Avar single_file_byte []byte\u000A');codeLines.push('//go:embed *.hash\u000A//go:embed embed-directive.sh\u000Avar folder_FS embed.FS\u000A');codeLines.push('func main() {\u000A');codeLines.push(' println(single_file_string)\u000A');codeLines.push(' println(string(single_file_byte))\u000A');codeLines.push(' hash_file :\u003D \"embed-directive.hash\"\u000A hash_content, _ :\u003D folder_FS.ReadFile(hash_file)\u000A println(string(hash_content))\u000A');codeLines.push('}\u000A');codeLines.push(''); codeLines.push('package main\u000A');codeLines.push('import (\u000A //_ \"embed\"\u000A \"embed\"\u000A)\u000A');codeLines.push('//go:embed example_folder/single_file.txt\u000Avar single_file_string string\u000A');codeLines.push('//go:embed example_folder/single_file.txt\u000Avar single_file_byte []byte\u000A');codeLines.push('//go:embed example_folder/single_file.txt\u000A//go:embed example_folder/*.hash\u000Avar folder_FS embed.FS\u000A');codeLines.push('func main() {\u000A');codeLines.push(' print(single_file_string)\u000A');codeLines.push(' print(string(single_file_byte))\u000A');codeLines.push(' hash_file1 :\u003D \"example_folder/multi_file1.hash\"\u000A hash_file2 :\u003D \"example_folder/multi_file2.hash\"\u000A hash_content1, _ :\u003D folder_FS.ReadFile(hash_file1)\u000A hash_content2, _ :\u003D folder_FS.ReadFile(hash_file2)\u000A print(string(hash_content1))\u000A print(string(hash_content2))\u000A');codeLines.push('}\u000A');codeLines.push('');codeLines.push('');
</script> </script>
<script src="site.js" async></script> <script src="site.js" async></script>
</body> </body>

2
public/generics generated
View File

@ -9,7 +9,7 @@
onkeydown = (e) => { onkeydown = (e) => {
if (e.key == "ArrowLeft") { if (e.key == "ArrowLeft") {
window.location.href = 'embed-directive'; window.location.href = 'struct-embedding';
} }

4
public/index.html generated
View File

@ -71,8 +71,6 @@
<li><a href="struct-embedding">Struct Embedding</a></li> <li><a href="struct-embedding">Struct Embedding</a></li>
<li><a href="embed-directive">Embed Directive</a></li>
<li><a href="generics">Generics</a></li> <li><a href="generics">Generics</a></li>
<li><a href="errors">Errors</a></li> <li><a href="errors">Errors</a></li>
@ -163,6 +161,8 @@
<li><a href="temporary-files-and-directories">Temporary Files and Directories</a></li> <li><a href="temporary-files-and-directories">Temporary Files and Directories</a></li>
<li><a href="embed-directive">Embed Directive</a></li>
<li><a href="testing-and-benchmarking">Testing and Benchmarking</a></li> <li><a href="testing-and-benchmarking">Testing and Benchmarking</a></li>
<li><a href="command-line-arguments">Command-Line Arguments</a></li> <li><a href="command-line-arguments">Command-Line Arguments</a></li>

4
public/struct-embedding generated
View File

@ -14,7 +14,7 @@
if (e.key == "ArrowRight") { if (e.key == "ArrowRight") {
window.location.href = 'embed-directive'; window.location.href = 'generics';
} }
} }
@ -233,7 +233,7 @@ we see that a <code>container</code> now implements the
<p class="next"> <p class="next">
Next example: <a href="embed-directive">Embed Directive</a>. Next example: <a href="generics">Generics</a>.
</p> </p>

4
public/temporary-files-and-directories generated
View File

@ -14,7 +14,7 @@
if (e.key == "ArrowRight") { if (e.key == "ArrowRight") {
window.location.href = 'testing-and-benchmarking'; window.location.href = 'embed-directive';
} }
} }
@ -225,7 +225,7 @@ prefixing them with our temporary directory.</p>
<p class="next"> <p class="next">
Next example: <a href="testing-and-benchmarking">Testing and Benchmarking</a>. Next example: <a href="embed-directive">Embed Directive</a>.
</p> </p>

2
public/testing-and-benchmarking generated
View File

@ -9,7 +9,7 @@
onkeydown = (e) => { onkeydown = (e) => {
if (e.key == "ArrowLeft") { if (e.key == "ArrowLeft") {
window.location.href = 'temporary-files-and-directories'; window.location.href = 'embed-directive';
} }

21
tools/generate.go
View File

@ -36,6 +36,11 @@ func check(err error) {
} }
} }
func isDir(path string) bool {
fileStat, _ := os.Stat(path)
return fileStat.IsDir()
}
func ensureDir(dir string) { func ensureDir(dir string) {
err := os.MkdirAll(dir, 0755) err := os.MkdirAll(dir, 0755)
check(err) check(err)
@ -275,14 +280,16 @@ func parseExamples() []*Example {
example.Segs = make([][]*Seg, 0) example.Segs = make([][]*Seg, 0)
sourcePaths := mustGlob("examples/" + exampleID + "/*") sourcePaths := mustGlob("examples/" + exampleID + "/*")
for _, sourcePath := range sourcePaths { for _, sourcePath := range sourcePaths {
if strings.HasSuffix(sourcePath, ".hash") { if ! isDir(sourcePath) {
example.GoCodeHash, example.URLHash = parseHashFile(sourcePath) if strings.HasSuffix(sourcePath, ".hash") {
} else { example.GoCodeHash, example.URLHash = parseHashFile(sourcePath)
sourceSegs, filecontents := parseAndRenderSegs(sourcePath) } else {
if filecontents != "" { sourceSegs, filecontents := parseAndRenderSegs(sourcePath)
example.GoCode = filecontents if filecontents != "" {
example.GoCode = filecontents
}
example.Segs = append(example.Segs, sourceSegs)
} }
example.Segs = append(example.Segs, sourceSegs)
} }
} }
newCodeHash := sha1Sum(example.GoCode) newCodeHash := sha1Sum(example.GoCode)

25
tools/measure.go
View File

@ -21,6 +21,11 @@ func readLines(path string) []string {
return strings.Split(string(srcBytes), "\n") return strings.Split(string(srcBytes), "\n")
} }
func isDir(path string) bool {
fileStat, _ := os.Stat(path)
return fileStat.IsDir()
}
var commentPat = regexp.MustCompile("\\s*\\/\\/") var commentPat = regexp.MustCompile("\\s*\\/\\/")
func main() { func main() {
@ -29,15 +34,17 @@ func main() {
foundLongFile := false foundLongFile := false
for _, sourcePath := range sourcePaths { for _, sourcePath := range sourcePaths {
foundLongLine := false foundLongLine := false
lines := readLines(sourcePath) if ! isDir(sourcePath) {
for i, line := range lines { lines := readLines(sourcePath)
// Convert tabs to spaces before measuring, so we get an accurate measure for i, line := range lines {
// of how long the output will end up being. // Convert tabs to spaces before measuring, so we get an accurate measure
line := strings.Replace(line, "\t", " ", -1) // of how long the output will end up being.
if !foundLongLine && !commentPat.MatchString(line) && (utf8.RuneCountInString(line) > 58) { line := strings.Replace(line, "\t", " ", -1)
fmt.Printf("measure: %s:%d\n", sourcePath, i+1) if !foundLongLine && !commentPat.MatchString(line) && (utf8.RuneCountInString(line) > 58) {
foundLongLine = true fmt.Printf("measure: %s:%d\n", sourcePath, i+1)
foundLongFile = true foundLongLine = true
foundLongFile = true
}
} }
} }
} }