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/cmd/download.go b/cmd/download.go index bb6f4879..20819360 100644 --- a/cmd/download.go +++ b/cmd/download.go @@ -10,6 +10,7 @@ import ( "github.com/yanosea/jrp/internal/gzip" "github.com/yanosea/jrp/internal/httpclient" "github.com/yanosea/jrp/internal/iomanager" + "github.com/yanosea/jrp/internal/spinnerservice" "github.com/yanosea/jrp/internal/usermanager" "github.com/yanosea/jrp/logic" ) @@ -42,7 +43,14 @@ func NewDownloadCommand(g *GlobalOption) *cobra.Command { } func (o *DownloadOption) DownloadRunE(_ *cobra.Command, _ []string) error { - o.Downloader = logic.NewDBFileDownloader(usermanager.OSUserProvider{}, fs.OsFileManager{}, httpclient.DefaultHTTPClient{}, iomanager.DefaultIOHelper{}, gzip.DefaultGzipHandler{}) + o.Downloader = logic.NewDBFileDownloader( + usermanager.OSUserProvider{}, + fs.OsFileManager{}, + httpclient.DefaultHTTPClient{}, + iomanager.DefaultIOHelper{}, + gzip.DefaultGzipHandler{}, + spinnerservice.NewRealSpinnerService(), + ) return o.Download() } diff --git a/cmd/download_test.go b/cmd/download_test.go index ec4d505f..05cdbbaf 100644 --- a/cmd/download_test.go +++ b/cmd/download_test.go @@ -12,6 +12,7 @@ import ( "github.com/yanosea/jrp/internal/gzip" "github.com/yanosea/jrp/internal/httpclient" "github.com/yanosea/jrp/internal/iomanager" + "github.com/yanosea/jrp/internal/spinnerservice" "github.com/yanosea/jrp/internal/usermanager" "github.com/yanosea/jrp/logic" @@ -51,7 +52,7 @@ func TestDownloadRunE(t *testing.T) { }{ { name: "positive testing", - args: args{o: cmd.DownloadOption{Out: os.Stdout, ErrOut: os.Stderr, Downloader: logic.NewDBFileDownloader(usermanager.OSUserProvider{}, fs.OsFileManager{}, httpclient.DefaultHTTPClient{}, iomanager.DefaultIOHelper{}, gzip.DefaultGzipHandler{})}}, + args: args{o: cmd.DownloadOption{Out: os.Stdout, ErrOut: os.Stderr, Downloader: logic.NewDBFileDownloader(usermanager.OSUserProvider{}, fs.OsFileManager{}, httpclient.DefaultHTTPClient{}, iomanager.DefaultIOHelper{}, gzip.DefaultGzipHandler{}, spinnerservice.NewRealSpinnerService())}}, }, } for _, tt := range tests { @@ -79,7 +80,7 @@ func TestDownload(t *testing.T) { }{ { name: "positive testing", - args: args{o: cmd.DownloadOption{Out: os.Stdout, ErrOut: os.Stderr, Downloader: logic.NewDBFileDownloader(usermanager.OSUserProvider{}, fs.OsFileManager{}, httpclient.DefaultHTTPClient{}, iomanager.DefaultIOHelper{}, gzip.DefaultGzipHandler{})}}, + args: args{o: cmd.DownloadOption{Out: os.Stdout, ErrOut: os.Stderr, Downloader: logic.NewDBFileDownloader(usermanager.OSUserProvider{}, fs.OsFileManager{}, httpclient.DefaultHTTPClient{}, iomanager.DefaultIOHelper{}, gzip.DefaultGzipHandler{}, spinnerservice.NewRealSpinnerService())}}, wantErr: false, setup: nil, }, diff --git a/cmd/root_test.go b/cmd/root_test.go index e20050d0..850ca140 100644 --- a/cmd/root_test.go +++ b/cmd/root_test.go @@ -16,6 +16,7 @@ import ( "github.com/yanosea/jrp/internal/gzip" "github.com/yanosea/jrp/internal/httpclient" "github.com/yanosea/jrp/internal/iomanager" + "github.com/yanosea/jrp/internal/spinnerservice" "github.com/yanosea/jrp/internal/usermanager" "github.com/yanosea/jrp/logic" @@ -52,7 +53,7 @@ func TestExecute(t *testing.T) { tu := usermanager.OSUserProvider{} tcu, _ := tu.Current() dbFileDirPath := filepath.Join(tcu.HomeDir, ".local", "share", "jrp") - tdl := logic.NewDBFileDownloader(usermanager.OSUserProvider{}, fs.OsFileManager{}, httpclient.DefaultHTTPClient{}, iomanager.DefaultIOHelper{}, gzip.DefaultGzipHandler{}) + tdl := logic.NewDBFileDownloader(usermanager.OSUserProvider{}, fs.OsFileManager{}, httpclient.DefaultHTTPClient{}, iomanager.DefaultIOHelper{}, gzip.DefaultGzipHandler{}, spinnerservice.NewRealSpinnerService()) type args struct { globalOption *cmd.GlobalOption 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..352adadb 100644 --- a/go.mod +++ b/go.mod @@ -3,6 +3,7 @@ module github.com/yanosea/jrp go 1.20 require ( + github.com/briandowns/spinner v1.23.1 github.com/fatih/color v1.17.0 github.com/spf13/cobra v1.8.1 go.uber.org/mock v0.4.0 @@ -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/internal/spinnerservice/spinner_service.go b/internal/spinnerservice/spinner_service.go new file mode 100644 index 00000000..19f8d4ad --- /dev/null +++ b/internal/spinnerservice/spinner_service.go @@ -0,0 +1,40 @@ +package spinnerservice + +import ( + "time" + + "github.com/briandowns/spinner" +) + +type SpinnerService interface { + Start() + Stop() + SetColor(colors ...string) error + SetSuffix(suffix string) +} + +type RealSpinnerService struct { + sp *spinner.Spinner +} + +func NewRealSpinnerService() *RealSpinnerService { + s := spinner.New(spinner.CharSets[11], 100*time.Millisecond) + s.Reverse() + return &RealSpinnerService{sp: s} +} + +func (rss *RealSpinnerService) Start() { + rss.sp.Start() +} + +func (rss *RealSpinnerService) Stop() { + rss.sp.Stop() +} + +func (rss *RealSpinnerService) SetColor(colors ...string) error { + return rss.sp.Color(colors...) +} + +func (rss *RealSpinnerService) SetSuffix(suffix string) { + rss.sp.Suffix = suffix +} diff --git a/logic/downloader.go b/logic/downloader.go index 8355924b..135d8c92 100644 --- a/logic/downloader.go +++ b/logic/downloader.go @@ -13,6 +13,7 @@ import ( "github.com/yanosea/jrp/internal/gzip" "github.com/yanosea/jrp/internal/httpclient" "github.com/yanosea/jrp/internal/iomanager" + "github.com/yanosea/jrp/internal/spinnerservice" "github.com/yanosea/jrp/internal/usermanager" ) @@ -26,16 +27,18 @@ type DBFileDownloader struct { HttpClient httpclient.HTTPClient IO iomanager.IOHelper Gzip gzip.GzipHandler + Spinner spinnerservice.SpinnerService } func NewDBFileDownloader(u usermanager.UserProvider, f fs.FileManager, - h httpclient.HTTPClient, i iomanager.IOHelper, g gzip.GzipHandler) *DBFileDownloader { + h httpclient.HTTPClient, i iomanager.IOHelper, g gzip.GzipHandler, s spinnerservice.SpinnerService) *DBFileDownloader { return &DBFileDownloader{ User: u, FileSystem: f, HttpClient: h, IO: i, Gzip: g, + Spinner: s, } } @@ -59,6 +62,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 + if err := d.Spinner.SetColor("yellow"); err != nil { + return err + } + d.Spinner.SetSuffix(color.YellowString(constant.DOWNLOAD_MESSAGE_DOWNLOADING)) + // start spinner + d.Spinner.Start() + // download db archive file resp, err := d.HttpClient.Get(constant.WNJPN_DB_ARCHIVE_FILE_URL) if err != nil { @@ -100,6 +111,9 @@ func (d *DBFileDownloader) Download() error { return err } + // stop spinner + d.Spinner.Stop() + // if db file is downloaded successfully, print message fmt.Println(color.GreenString(constant.DOWNLOAD_MESSAGE_SUCCEEDED)) } else { diff --git a/logic/downloader_test.go b/logic/downloader_test.go index 21253c66..956ef021 100644 --- a/logic/downloader_test.go +++ b/logic/downloader_test.go @@ -16,12 +16,14 @@ import ( "github.com/yanosea/jrp/internal/gzip" "github.com/yanosea/jrp/internal/httpclient" "github.com/yanosea/jrp/internal/iomanager" + "github.com/yanosea/jrp/internal/spinnerservice" "github.com/yanosea/jrp/internal/usermanager" mock_fs "github.com/yanosea/jrp/mock/fs" mock_gzip "github.com/yanosea/jrp/mock/gzip" mock_httpclient "github.com/yanosea/jrp/mock/httpclient" mock_iomanager "github.com/yanosea/jrp/mock/iomanager" + mock_spinnerservice "github.com/yanosea/jrp/mock/spinnerservice" mock_usermanager "github.com/yanosea/jrp/mock/usermanager" ) @@ -32,6 +34,7 @@ func TestNewDBFileDownloader(t *testing.T) { h httpclient.HTTPClient i iomanager.IOHelper g gzip.GzipHandler + s spinnerservice.SpinnerService } tests := []struct { name string @@ -39,12 +42,12 @@ func TestNewDBFileDownloader(t *testing.T) { }{ { name: "positive testing", - args: args{u: usermanager.OSUserProvider{}, f: fs.OsFileManager{}, h: httpclient.DefaultHTTPClient{}, i: iomanager.DefaultIOHelper{}, g: gzip.DefaultGzipHandler{}}, + args: args{u: usermanager.OSUserProvider{}, f: fs.OsFileManager{}, h: httpclient.DefaultHTTPClient{}, i: iomanager.DefaultIOHelper{}, g: gzip.DefaultGzipHandler{}, s: spinnerservice.NewRealSpinnerService()}, }, } for _, tt := range tests { t.Run(tt.name, func(t *testing.T) { - u := NewDBFileDownloader(tt.args.u, tt.args.f, tt.args.h, tt.args.i, tt.args.g) + u := NewDBFileDownloader(tt.args.u, tt.args.f, tt.args.h, tt.args.i, tt.args.g, tt.args.s) if u == nil { t.Errorf("NewDBFileDownloader() : returned nil") } @@ -55,6 +58,7 @@ func TestNewDBFileDownloader(t *testing.T) { func TestDownload(t *testing.T) { tu := usermanager.OSUserProvider{} tcu, _ := tu.Current() + sp := spinnerservice.NewRealSpinnerService() defaultDBFileDirPath := filepath.Join(tcu.HomeDir, ".local", "share", "jrp") envDBFileDirPath := filepath.Join(tcu.HomeDir, "jrp") defaultTempFilePath := filepath.Join(os.TempDir(), constant.WNJPN_DB_ARCHIVE_FILE_NAME) @@ -74,7 +78,7 @@ func TestDownload(t *testing.T) { args: args{downloader: nil, env: ""}, wantErr: false, setup: func(mockCtrl *gomock.Controller, tt *args) { - downloader := NewDBFileDownloader(usermanager.OSUserProvider{}, fs.OsFileManager{}, httpclient.DefaultHTTPClient{}, iomanager.DefaultIOHelper{}, gzip.DefaultGzipHandler{}) + downloader := NewDBFileDownloader(usermanager.OSUserProvider{}, fs.OsFileManager{}, httpclient.DefaultHTTPClient{}, iomanager.DefaultIOHelper{}, gzip.DefaultGzipHandler{}, sp) tt.downloader = downloader }, }, { @@ -82,7 +86,7 @@ func TestDownload(t *testing.T) { args: args{downloader: nil, env: filepath.Join(tcu.HomeDir, "jrp")}, wantErr: false, setup: func(mockCtrl *gomock.Controller, tt *args) { - downloader := NewDBFileDownloader(usermanager.OSUserProvider{}, fs.OsFileManager{}, httpclient.DefaultHTTPClient{}, iomanager.DefaultIOHelper{}, gzip.DefaultGzipHandler{}) + downloader := NewDBFileDownloader(usermanager.OSUserProvider{}, fs.OsFileManager{}, httpclient.DefaultHTTPClient{}, iomanager.DefaultIOHelper{}, gzip.DefaultGzipHandler{}, sp) tt.downloader = downloader }, }, { @@ -90,7 +94,7 @@ func TestDownload(t *testing.T) { args: args{downloader: nil, env: ""}, wantErr: false, setup: func(mockCtrl *gomock.Controller, tt *args) { - downloader := NewDBFileDownloader(usermanager.OSUserProvider{}, fs.OsFileManager{}, httpclient.DefaultHTTPClient{}, iomanager.DefaultIOHelper{}, gzip.DefaultGzipHandler{}) + downloader := NewDBFileDownloader(usermanager.OSUserProvider{}, fs.OsFileManager{}, httpclient.DefaultHTTPClient{}, iomanager.DefaultIOHelper{}, gzip.DefaultGzipHandler{}, sp) tt.downloader = downloader if err := downloader.Download(); err != nil { t.Error(err) @@ -103,17 +107,27 @@ func TestDownload(t *testing.T) { setup: func(mockCtrl *gomock.Controller, tt *args) { mu := mock_usermanager.NewMockUserProvider(mockCtrl) mu.EXPECT().Current().Return(nil, errors.New("failed to get current user")) - downloader := NewDBFileDownloader(mu, fs.OsFileManager{}, httpclient.DefaultHTTPClient{}, iomanager.DefaultIOHelper{}, gzip.DefaultGzipHandler{}) + downloader := NewDBFileDownloader(mu, fs.OsFileManager{}, httpclient.DefaultHTTPClient{}, iomanager.DefaultIOHelper{}, gzip.DefaultGzipHandler{}, sp) tt.downloader = downloader }, }, { - name: "negative testing (os.MkdirAll(dbFileDirPath, os.Filemode(0755)) fails)", + name: "negative testing (os.MkdirAll(dbFileDirPath, os.Filemode(0755) fails)", args: args{downloader: nil, env: ""}, wantErr: true, setup: func(mockCtrl *gomock.Controller, tt *args) { mfs := mock_fs.NewMockFileManager(mockCtrl) mfs.EXPECT().MkdirAll(gomock.Any(), os.FileMode(0755)).Return(errors.New("failed to create db file dir")) - downloader := NewDBFileDownloader(usermanager.OSUserProvider{}, mfs, httpclient.DefaultHTTPClient{}, iomanager.DefaultIOHelper{}, gzip.DefaultGzipHandler{}) + downloader := NewDBFileDownloader(usermanager.OSUserProvider{}, mfs, httpclient.DefaultHTTPClient{}, iomanager.DefaultIOHelper{}, gzip.DefaultGzipHandler{}, sp) + tt.downloader = downloader + }, + }, { + name: "negative testing (d.Spinner.SetColor(\"yellow\") fails)", + args: args{downloader: nil, env: ""}, + wantErr: true, + setup: func(mockCtrl *gomock.Controller, tt *args) { + ms := mock_spinnerservice.NewMockSpinnerService(mockCtrl) + ms.EXPECT().SetColor(gomock.Any()).Return(errors.New("failed to set spinner color")) + downloader := NewDBFileDownloader(usermanager.OSUserProvider{}, fs.OsFileManager{}, httpclient.DefaultHTTPClient{}, iomanager.DefaultIOHelper{}, gzip.DefaultGzipHandler{}, ms) tt.downloader = downloader }, }, { @@ -123,7 +137,7 @@ func TestDownload(t *testing.T) { setup: func(mockCtrl *gomock.Controller, tt *args) { mhc := mock_httpclient.NewMockHTTPClient(mockCtrl) mhc.EXPECT().Get(gomock.Any()).Return(nil, errors.New("failed to get http response")) - downloader := NewDBFileDownloader(usermanager.OSUserProvider{}, fs.OsFileManager{}, mhc, iomanager.DefaultIOHelper{}, gzip.DefaultGzipHandler{}) + downloader := NewDBFileDownloader(usermanager.OSUserProvider{}, fs.OsFileManager{}, mhc, iomanager.DefaultIOHelper{}, gzip.DefaultGzipHandler{}, sp) tt.downloader = downloader }, }, { @@ -136,7 +150,7 @@ func TestDownload(t *testing.T) { mfs.EXPECT().MkdirAll(defaultDBFileDirPath, os.FileMode(0755)).Return(nil), mfs.EXPECT().Create(gomock.Any()).Return(nil, errors.New("failed to create temp file")), ) - downloader := NewDBFileDownloader(usermanager.OSUserProvider{}, mfs, httpclient.DefaultHTTPClient{}, iomanager.DefaultIOHelper{}, gzip.DefaultGzipHandler{}) + downloader := NewDBFileDownloader(usermanager.OSUserProvider{}, mfs, httpclient.DefaultHTTPClient{}, iomanager.DefaultIOHelper{}, gzip.DefaultGzipHandler{}, sp) tt.downloader = downloader }, }, { @@ -146,7 +160,7 @@ func TestDownload(t *testing.T) { setup: func(mockCtrl *gomock.Controller, tt *args) { mio := mock_iomanager.NewMockIOHelper(mockCtrl) mio.EXPECT().Copy(gomock.Any(), gomock.Any()).Return(int64(0), errors.New("failed to copy response body to temp file")) - downloader := NewDBFileDownloader(usermanager.OSUserProvider{}, fs.OsFileManager{}, httpclient.DefaultHTTPClient{}, mio, gzip.DefaultGzipHandler{}) + downloader := NewDBFileDownloader(usermanager.OSUserProvider{}, fs.OsFileManager{}, httpclient.DefaultHTTPClient{}, mio, gzip.DefaultGzipHandler{}, sp) tt.downloader = downloader }, }, { @@ -167,7 +181,7 @@ func TestDownload(t *testing.T) { ) mio := mock_iomanager.NewMockIOHelper(mockCtrl) mio.EXPECT().Copy(mf, gomock.Any()).Return(int64(0), nil) - downloader := NewDBFileDownloader(usermanager.OSUserProvider{}, mfs, httpclient.DefaultHTTPClient{}, mio, gzip.DefaultGzipHandler{}) + downloader := NewDBFileDownloader(usermanager.OSUserProvider{}, mfs, httpclient.DefaultHTTPClient{}, mio, gzip.DefaultGzipHandler{}, sp) tt.downloader = downloader }, }, { @@ -177,7 +191,7 @@ func TestDownload(t *testing.T) { setup: func(mockCtrl *gomock.Controller, tt *args) { mgz := mock_gzip.NewMockGzipHandler(mockCtrl) mgz.EXPECT().NewReader(gomock.Any()).Return(nil, errors.New("failed to new reader")) - downloader := NewDBFileDownloader(usermanager.OSUserProvider{}, fs.OsFileManager{}, httpclient.DefaultHTTPClient{}, iomanager.DefaultIOHelper{}, mgz) + downloader := NewDBFileDownloader(usermanager.OSUserProvider{}, fs.OsFileManager{}, httpclient.DefaultHTTPClient{}, iomanager.DefaultIOHelper{}, mgz, sp) tt.downloader = downloader }, }, { @@ -193,7 +207,7 @@ func TestDownload(t *testing.T) { mfs.EXPECT().Create(defaultTempFilePath).Return(tempFile, nil), mfs.EXPECT().Create(dbFilePath).Return(nil, errors.New("failed to create db file")), ) - downloader := NewDBFileDownloader(usermanager.OSUserProvider{}, mfs, httpclient.DefaultHTTPClient{}, iomanager.DefaultIOHelper{}, gzip.DefaultGzipHandler{}) + downloader := NewDBFileDownloader(usermanager.OSUserProvider{}, mfs, httpclient.DefaultHTTPClient{}, iomanager.DefaultIOHelper{}, gzip.DefaultGzipHandler{}, sp) tt.downloader = downloader }, }, { @@ -219,7 +233,7 @@ func TestDownload(t *testing.T) { mhc.EXPECT().Get(gomock.Any()).Return(&http.Response{Body: io.NopCloser(bytes.NewReader([]byte{}))}, nil) mgz := mock_gzip.NewMockGzipHandler(mockCtrl) mgz.EXPECT().NewReader(gomock.Any()).Return(io.NopCloser(bytes.NewReader([]byte{})), nil) - tt.downloader = NewDBFileDownloader(usermanager.OSUserProvider{}, mfs, mhc, mio, mgz) + tt.downloader = NewDBFileDownloader(usermanager.OSUserProvider{}, mfs, mhc, mio, mgz, sp) }, }, { name: "negative testing (os.Remove(tempFilePath) fails)", @@ -246,7 +260,7 @@ func TestDownload(t *testing.T) { mgz := mock_gzip.NewMockGzipHandler(mockCtrl) mgz.EXPECT().NewReader(gomock.Any()).Return(io.NopCloser(bytes.NewReader([]byte{})), nil) os.RemoveAll(filepath.Join(tcu.HomeDir, ".local", "share", "jrp")) - tt.downloader = NewDBFileDownloader(usermanager.OSUserProvider{}, mfs, mhc, mio, mgz) + tt.downloader = NewDBFileDownloader(usermanager.OSUserProvider{}, mfs, mhc, mio, mgz, sp) }, }, } diff --git a/logic/generator_test.go b/logic/generator_test.go index 48e168f8..b3352fe7 100644 --- a/logic/generator_test.go +++ b/logic/generator_test.go @@ -15,6 +15,7 @@ import ( "github.com/yanosea/jrp/internal/gzip" "github.com/yanosea/jrp/internal/httpclient" "github.com/yanosea/jrp/internal/iomanager" + "github.com/yanosea/jrp/internal/spinnerservice" "github.com/yanosea/jrp/internal/usermanager" mock_database "github.com/yanosea/jrp/mock/database" @@ -117,7 +118,7 @@ func TestGenerate(t *testing.T) { tu := usermanager.OSUserProvider{} tcu, _ := tu.Current() defaultDBFileDirPath := filepath.Join(tcu.HomeDir, ".local", "share", "jrp") - tdl := NewDBFileDownloader(usermanager.OSUserProvider{}, fs.OsFileManager{}, httpclient.DefaultHTTPClient{}, iomanager.DefaultIOHelper{}, gzip.DefaultGzipHandler{}) + tdl := NewDBFileDownloader(usermanager.OSUserProvider{}, fs.OsFileManager{}, httpclient.DefaultHTTPClient{}, iomanager.DefaultIOHelper{}, gzip.DefaultGzipHandler{}, spinnerservice.NewRealSpinnerService()) if err := tdl.Download(); err != nil { t.Error(err) } diff --git a/main_test.go b/main_test.go index c2fe969e..449cd54b 100644 --- a/main_test.go +++ b/main_test.go @@ -9,6 +9,7 @@ import ( "github.com/yanosea/jrp/internal/gzip" "github.com/yanosea/jrp/internal/httpclient" "github.com/yanosea/jrp/internal/iomanager" + "github.com/yanosea/jrp/internal/spinnerservice" "github.com/yanosea/jrp/internal/usermanager" "github.com/yanosea/jrp/logic" ) @@ -17,7 +18,7 @@ func TestMain(t *testing.T) { tu := usermanager.OSUserProvider{} tcu, _ := tu.Current() dbFileDirPath := filepath.Join(tcu.HomeDir, ".local", "share", "jrp") - tdl := logic.NewDBFileDownloader(usermanager.OSUserProvider{}, fs.OsFileManager{}, httpclient.DefaultHTTPClient{}, iomanager.DefaultIOHelper{}, gzip.DefaultGzipHandler{}) + tdl := logic.NewDBFileDownloader(usermanager.OSUserProvider{}, fs.OsFileManager{}, httpclient.DefaultHTTPClient{}, iomanager.DefaultIOHelper{}, gzip.DefaultGzipHandler{}, spinnerservice.NewRealSpinnerService()) tests := []struct { name string diff --git a/mock/spinnerservice/spinner_service.go b/mock/spinnerservice/spinner_service.go new file mode 100644 index 00000000..7dfc0aa4 --- /dev/null +++ b/mock/spinnerservice/spinner_service.go @@ -0,0 +1,93 @@ +// Code generated by MockGen. DO NOT EDIT. +// Source: internal/spinnerservice/spinner_service.go +// +// Generated by this command: +// +// mockgen -source=internal/spinnerservice/spinner_service.go -destination=mock/spinnerservice/spinner_service.go -package=mock_spinnerservice +// + +// Package mock_spinnerservice is a generated GoMock package. +package mock_spinnerservice + +import ( + reflect "reflect" + + gomock "go.uber.org/mock/gomock" +) + +// MockSpinnerService is a mock of SpinnerService interface. +type MockSpinnerService struct { + ctrl *gomock.Controller + recorder *MockSpinnerServiceMockRecorder +} + +// MockSpinnerServiceMockRecorder is the mock recorder for MockSpinnerService. +type MockSpinnerServiceMockRecorder struct { + mock *MockSpinnerService +} + +// NewMockSpinnerService creates a new mock instance. +func NewMockSpinnerService(ctrl *gomock.Controller) *MockSpinnerService { + mock := &MockSpinnerService{ctrl: ctrl} + mock.recorder = &MockSpinnerServiceMockRecorder{mock} + return mock +} + +// EXPECT returns an object that allows the caller to indicate expected use. +func (m *MockSpinnerService) EXPECT() *MockSpinnerServiceMockRecorder { + return m.recorder +} + +// SetColor mocks base method. +func (m *MockSpinnerService) SetColor(colors ...string) error { + m.ctrl.T.Helper() + varargs := []any{} + for _, a := range colors { + varargs = append(varargs, a) + } + ret := m.ctrl.Call(m, "SetColor", varargs...) + ret0, _ := ret[0].(error) + return ret0 +} + +// SetColor indicates an expected call of SetColor. +func (mr *MockSpinnerServiceMockRecorder) SetColor(colors ...any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "SetColor", reflect.TypeOf((*MockSpinnerService)(nil).SetColor), colors...) +} + +// SetSuffix mocks base method. +func (m *MockSpinnerService) SetSuffix(suffix string) { + m.ctrl.T.Helper() + m.ctrl.Call(m, "SetSuffix", suffix) +} + +// SetSuffix indicates an expected call of SetSuffix. +func (mr *MockSpinnerServiceMockRecorder) SetSuffix(suffix any) *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "SetSuffix", reflect.TypeOf((*MockSpinnerService)(nil).SetSuffix), suffix) +} + +// Start mocks base method. +func (m *MockSpinnerService) Start() { + m.ctrl.T.Helper() + m.ctrl.Call(m, "Start") +} + +// Start indicates an expected call of Start. +func (mr *MockSpinnerServiceMockRecorder) Start() *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Start", reflect.TypeOf((*MockSpinnerService)(nil).Start)) +} + +// Stop mocks base method. +func (m *MockSpinnerService) Stop() { + m.ctrl.T.Helper() + m.ctrl.Call(m, "Stop") +} + +// Stop indicates an expected call of Stop. +func (mr *MockSpinnerServiceMockRecorder) Stop() *gomock.Call { + mr.mock.ctrl.T.Helper() + return mr.mock.ctrl.RecordCallWithMethodType(mr.mock, "Stop", reflect.TypeOf((*MockSpinnerService)(nil).Stop)) +} diff --git a/test/cover.html b/test/cover.html index cb4cf6b0..369dc222 100644 --- a/test/cover.html +++ b/test/cover.html @@ -95,19 +95,21 @@ - + - + - + - + - + - + - + + + @@ -274,6 +276,7 @@ "github.com/yanosea/jrp/internal/gzip" "github.com/yanosea/jrp/internal/httpclient" "github.com/yanosea/jrp/internal/iomanager" + "github.com/yanosea/jrp/internal/spinnerservice" "github.com/yanosea/jrp/internal/usermanager" "github.com/yanosea/jrp/logic" ) @@ -306,7 +309,14 @@ } func (o *DownloadOption) DownloadRunE(_ *cobra.Command, _ []string) error { - o.Downloader = logic.NewDBFileDownloader(usermanager.OSUserProvider{}, fs.OsFileManager{}, httpclient.DefaultHTTPClient{}, iomanager.DefaultIOHelper{}, gzip.DefaultGzipHandler{}) + o.Downloader = logic.NewDBFileDownloader( + usermanager.OSUserProvider{}, + fs.OsFileManager{}, + httpclient.DefaultHTTPClient{}, + iomanager.DefaultIOHelper{}, + gzip.DefaultGzipHandler{}, + spinnerservice.NewRealSpinnerService(), + ) return o.Download() } @@ -573,6 +583,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!" ) @@ -835,7 +846,49 @@ } -