From 05c1ee2acd7290e3210a6665ee477661e6e8e13b Mon Sep 17 00:00:00 2001 From: yanosea Date: Fri, 16 Aug 2024 09:15:28 +0900 Subject: [PATCH] =?UTF-8?q?=E2=9C=A8feat:=20add=20spinner=20when=20downloa?= =?UTF-8?q?ding=20wnjpn=20db=20file?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CREDITS | 213 +++++++++++++++++++++++++++++++++++++++++++ constant/download.go | 1 + go.mod | 2 + go.sum | 4 + logic/downloader.go | 13 +++ test/cover.html | 16 +++- test/cover.out | 54 +++++------ 7 files changed, 275 insertions(+), 28 deletions(-) diff --git a/CREDITS b/CREDITS index 472cf213..3fd60e60 100644 --- a/CREDITS +++ b/CREDITS @@ -31,6 +31,186 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ================================================================ +github.com/briandowns/spinner +https://github.com/briandowns/spinner +---------------------------------------------------------------- + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + +================================================================ + github.com/dustin/go-humanize https://github.com/dustin/go-humanize ---------------------------------------------------------------- @@ -1525,6 +1705,39 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. ================================================================ +golang.org/x/term +https://golang.org/x/term +---------------------------------------------------------------- +Copyright (c) 2009 The Go Authors. All rights reserved. + +Redistribution and use in source and binary forms, with or without +modification, are permitted provided that the following conditions are +met: + + * Redistributions of source code must retain the above copyright +notice, this list of conditions and the following disclaimer. + * Redistributions in binary form must reproduce the above +copyright notice, this list of conditions and the following disclaimer +in the documentation and/or other materials provided with the +distribution. + * Neither the name of Google Inc. nor the names of its +contributors may be used to endorse or promote products derived from +this software without specific prior written permission. + +THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + +================================================================ + golang.org/x/tools https://golang.org/x/tools ---------------------------------------------------------------- diff --git a/constant/download.go b/constant/download.go index 3a29fcf6..117850d3 100644 --- a/constant/download.go +++ b/constant/download.go @@ -27,6 +27,7 @@ jrp will download archive file from the official site and decompress it to the d You can set the directory of the database file to the environment variable "JRP_WORDNETJP_DIR". The default directory is "$XDG_DATA_HOME/jrp". ` + DOWNLOAD_MESSAGE_DOWNLOADING = " Download Japanese Wordnet sqlite3 database file from the official site..." DOWNLOAD_MESSAGE_SUCCEEDED = "✅ Downloaded successfully! Now, you are ready to use jrp!" DOWNLOAD_MESSAGE_ALREADY_DOWNLOADED = "✅ You are already ready to use jrp!" ) diff --git a/go.mod b/go.mod index 9dc4d204..27635f66 100644 --- a/go.mod +++ b/go.mod @@ -10,6 +10,7 @@ require ( ) require ( + github.com/briandowns/spinner v1.23.1 // indirect github.com/dustin/go-humanize v1.0.1 // indirect github.com/google/uuid v1.6.0 // indirect github.com/hashicorp/golang-lru/v2 v2.0.7 // indirect @@ -20,6 +21,7 @@ require ( github.com/remyoudompheng/bigfft v0.0.0-20230129092748-24d4a6f8daec // indirect github.com/spf13/pflag v1.0.5 // indirect golang.org/x/sys v0.22.0 // indirect + golang.org/x/term v0.1.0 // indirect modernc.org/gc/v3 v3.0.0-20240107210532-573471604cb6 // indirect modernc.org/libc v1.55.3 // indirect modernc.org/mathutil v1.6.0 // indirect diff --git a/go.sum b/go.sum index c58b1989..c0c80bdf 100644 --- a/go.sum +++ b/go.sum @@ -1,3 +1,5 @@ +github.com/briandowns/spinner v1.23.1 h1:t5fDPmScwUjozhDj4FA46p5acZWIPXYE30qW2Ptu650= +github.com/briandowns/spinner v1.23.1/go.mod h1:LaZeM4wm2Ywy6vO571mvhQNRcWfRUnXOs0RcKV0wYKM= github.com/cpuguy83/go-md2man/v2 v2.0.4/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o= github.com/dustin/go-humanize v1.0.1 h1:GzkhY7T5VNhEkwH0PVJgjz+fX1rhBrR7pRT3mDkpeCY= github.com/dustin/go-humanize v1.0.1/go.mod h1:Mu1zIs6XwVuF/gI1OepvI0qD18qycQx+mFykh5fBlto= @@ -32,6 +34,8 @@ golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBc golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.22.0 h1:RI27ohtqKCnwULzJLqkv897zojh5/DwS/ENaMzUOaWI= golang.org/x/sys v0.22.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA= +golang.org/x/term v0.1.0 h1:g6Z6vPFA9dYBAF7DWcH6sCcOntplXsDKcliusYijMlw= +golang.org/x/term v0.1.0/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8= golang.org/x/tools v0.19.0 h1:tfGCXNR1OsFG+sVdLAitlpjAvD/I6dHDKnYrpEZUHkw= gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= diff --git a/logic/downloader.go b/logic/downloader.go index 8355924b..8c1cd74e 100644 --- a/logic/downloader.go +++ b/logic/downloader.go @@ -5,7 +5,9 @@ import ( "io" "os" "path/filepath" + "time" + "github.com/briandowns/spinner" "github.com/fatih/color" "github.com/yanosea/jrp/constant" @@ -59,6 +61,14 @@ func (d *DBFileDownloader) Download() error { // if db file does not exist, download it dbFilePath := filepath.Join(dbFileDirPath, constant.WNJPN_DB_FILE_NAME) if _, err := os.Stat(dbFilePath); os.IsNotExist(err) { + // spinner settings + s := spinner.New(spinner.CharSets[11], 100*time.Millisecond) + s.Reverse() + s.Color("yellow") + s.Suffix = color.YellowString(constant.DOWNLOAD_MESSAGE_DOWNLOADING) + // start spinner + s.Start() + // download db archive file resp, err := d.HttpClient.Get(constant.WNJPN_DB_ARCHIVE_FILE_URL) if err != nil { @@ -100,6 +110,9 @@ func (d *DBFileDownloader) Download() error { return err } + // stop spinner + s.Stop() + // if db file is downloaded successfully, print message fmt.Println(color.GreenString(constant.DOWNLOAD_MESSAGE_SUCCEEDED)) } else { diff --git a/test/cover.html b/test/cover.html index cb4cf6b0..3e5a8361 100644 --- a/test/cover.html +++ b/test/cover.html @@ -573,6 +573,7 @@ You can set the directory of the database file to the environment variable "JRP_WORDNETJP_DIR". The default directory is "$XDG_DATA_HOME/jrp". ` + DOWNLOAD_MESSAGE_DOWNLOADING = " Download Japanese Wordnet sqlite3 database file from the official site..." DOWNLOAD_MESSAGE_SUCCEEDED = "✅ Downloaded successfully! Now, you are ready to use jrp!" DOWNLOAD_MESSAGE_ALREADY_DOWNLOADED = "✅ You are already ready to use jrp!" ) @@ -901,7 +902,9 @@ "io" "os" "path/filepath" + "time" + "github.com/briandowns/spinner" "github.com/fatih/color" "github.com/yanosea/jrp/constant" @@ -955,6 +958,14 @@ // if db file does not exist, download it dbFilePath := filepath.Join(dbFileDirPath, constant.WNJPN_DB_FILE_NAME) if _, err := os.Stat(dbFilePath); os.IsNotExist(err) { + // spinner settings + s := spinner.New(spinner.CharSets[11], 100*time.Millisecond) + s.Reverse() + s.Color("yellow") + s.Suffix = color.YellowString(constant.DOWNLOAD_MESSAGE_DOWNLOADING) + // start spinner + s.Start() + // download db archive file resp, err := d.HttpClient.Get(constant.WNJPN_DB_ARCHIVE_FILE_URL) if err != nil { @@ -996,8 +1007,11 @@ return err } + // stop spinner + s.Stop() + // if db file is downloaded successfully, print message - fmt.Println(color.GreenString(constant.DOWNLOAD_MESSAGE_SUCCEEDED)) + fmt.Println(color.GreenString(constant.DOWNLOAD_MESSAGE_SUCCEEDED)) } else { // if db file already exists, print message fmt.Println(color.GreenString(constant.DOWNLOAD_MESSAGE_ALREADY_DOWNLOADED)) diff --git a/test/cover.out b/test/cover.out index b7e2f906..619480ae 100644 --- a/test/cover.out +++ b/test/cover.out @@ -85,7 +85,7 @@ github.com/yanosea/jrp/internal/gzip/gzip_handler.go:14.73,16.2 1 1 github.com/yanosea/jrp/internal/httpclient/http_client.go:13.66,15.2 1 1 github.com/yanosea/jrp/internal/iomanager/io_helper.go:13.74,15.2 1 1 github.com/yanosea/jrp/internal/usermanager/user_provider.go:13.53,15.2 1 1 -github.com/yanosea/jrp/constant/download.go:34.36,36.2 1 1 +github.com/yanosea/jrp/constant/download.go:35.36,37.2 1 1 github.com/yanosea/jrp/constant/generate.go:36.36,38.2 1 1 github.com/yanosea/jrp/internal/buffer/buffer.go:17.61,19.2 1 0 github.com/yanosea/jrp/internal/buffer/buffer.go:21.41,23.2 1 0 @@ -127,32 +127,32 @@ github.com/yanosea/jrp/logic/db_file_dir_path_getter.go:28.16,30.3 1 1 github.com/yanosea/jrp/logic/db_file_dir_path_getter.go:32.2,35.28 3 1 github.com/yanosea/jrp/logic/db_file_dir_path_getter.go:35.28,37.3 1 1 github.com/yanosea/jrp/logic/db_file_dir_path_getter.go:39.2,39.27 1 1 -github.com/yanosea/jrp/logic/downloader.go:32.87,40.2 1 1 -github.com/yanosea/jrp/logic/downloader.go:42.45,48.16 3 1 -github.com/yanosea/jrp/logic/downloader.go:48.16,50.3 1 1 -github.com/yanosea/jrp/logic/downloader.go:53.2,53.58 1 1 -github.com/yanosea/jrp/logic/downloader.go:53.58,54.81 1 1 -github.com/yanosea/jrp/logic/downloader.go:54.81,56.4 1 1 -github.com/yanosea/jrp/logic/downloader.go:60.2,61.55 2 1 -github.com/yanosea/jrp/logic/downloader.go:61.55,64.17 2 1 -github.com/yanosea/jrp/logic/downloader.go:64.17,66.4 1 1 -github.com/yanosea/jrp/logic/downloader.go:67.3,72.17 4 1 -github.com/yanosea/jrp/logic/downloader.go:72.17,74.4 1 1 -github.com/yanosea/jrp/logic/downloader.go:75.3,76.54 2 1 -github.com/yanosea/jrp/logic/downloader.go:76.54,78.4 1 1 -github.com/yanosea/jrp/logic/downloader.go:79.3,79.54 1 1 -github.com/yanosea/jrp/logic/downloader.go:79.54,81.4 1 1 -github.com/yanosea/jrp/logic/downloader.go:84.3,85.17 2 1 -github.com/yanosea/jrp/logic/downloader.go:85.17,87.4 1 1 -github.com/yanosea/jrp/logic/downloader.go:88.3,90.17 3 1 -github.com/yanosea/jrp/logic/downloader.go:90.17,92.4 1 1 -github.com/yanosea/jrp/logic/downloader.go:93.3,94.45 2 1 -github.com/yanosea/jrp/logic/downloader.go:94.45,96.4 1 1 -github.com/yanosea/jrp/logic/downloader.go:99.3,99.62 1 1 -github.com/yanosea/jrp/logic/downloader.go:99.62,101.4 1 1 -github.com/yanosea/jrp/logic/downloader.go:104.3,104.70 1 1 -github.com/yanosea/jrp/logic/downloader.go:105.8,108.3 1 1 -github.com/yanosea/jrp/logic/downloader.go:110.2,110.12 1 1 +github.com/yanosea/jrp/logic/downloader.go:34.87,42.2 1 1 +github.com/yanosea/jrp/logic/downloader.go:44.45,50.16 3 1 +github.com/yanosea/jrp/logic/downloader.go:50.16,52.3 1 1 +github.com/yanosea/jrp/logic/downloader.go:55.2,55.58 1 1 +github.com/yanosea/jrp/logic/downloader.go:55.58,56.81 1 1 +github.com/yanosea/jrp/logic/downloader.go:56.81,58.4 1 1 +github.com/yanosea/jrp/logic/downloader.go:62.2,63.55 2 1 +github.com/yanosea/jrp/logic/downloader.go:63.55,74.17 7 1 +github.com/yanosea/jrp/logic/downloader.go:74.17,76.4 1 1 +github.com/yanosea/jrp/logic/downloader.go:77.3,82.17 4 1 +github.com/yanosea/jrp/logic/downloader.go:82.17,84.4 1 1 +github.com/yanosea/jrp/logic/downloader.go:85.3,86.54 2 1 +github.com/yanosea/jrp/logic/downloader.go:86.54,88.4 1 1 +github.com/yanosea/jrp/logic/downloader.go:89.3,89.54 1 1 +github.com/yanosea/jrp/logic/downloader.go:89.54,91.4 1 1 +github.com/yanosea/jrp/logic/downloader.go:94.3,95.17 2 1 +github.com/yanosea/jrp/logic/downloader.go:95.17,97.4 1 1 +github.com/yanosea/jrp/logic/downloader.go:98.3,100.17 3 1 +github.com/yanosea/jrp/logic/downloader.go:100.17,102.4 1 1 +github.com/yanosea/jrp/logic/downloader.go:103.3,104.45 2 1 +github.com/yanosea/jrp/logic/downloader.go:104.45,106.4 1 1 +github.com/yanosea/jrp/logic/downloader.go:109.3,109.62 1 1 +github.com/yanosea/jrp/logic/downloader.go:109.62,111.4 1 1 +github.com/yanosea/jrp/logic/downloader.go:114.3,117.70 2 1 +github.com/yanosea/jrp/logic/downloader.go:118.8,121.3 1 1 +github.com/yanosea/jrp/logic/downloader.go:123.2,123.12 1 1 github.com/yanosea/jrp/logic/generator.go:28.145,34.2 1 1 github.com/yanosea/jrp/logic/generator.go:36.47,37.14 1 1 github.com/yanosea/jrp/logic/generator.go:37.14,39.3 1 1