nhkore 0.3.4 → 0.3.9

data/lib/nhkore/cleaner.rb

@@ -1,23 +1,11 @@
-#!/usr/bin/env ruby
 # encoding: UTF-8
 # frozen_string_literal: true
 
 #--
 # This file is part of NHKore.
-# Copyright (c) 2020 Jonathan Bradley Whited (@esotericpig)
-# 
-# NHKore is free software: you can redistribute it and/or modify
-# it under the terms of the GNU Lesser General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-# 
-# NHKore is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Lesser General Public License for more details.
-# 
-# You should have received a copy of the GNU Lesser General Public License
-# along with NHKore.  If not, see <https://www.gnu.org/licenses/>.
+# Copyright (c) 2020-2021 Jonathan Bradley Whited
+#
+# SPDX-License-Identifier: LGPL-3.0-or-later
 #++
 
 
@@ -27,28 +15,28 @@ require 'nhkore/word'
 
 module NHKore
   ###
-  # @author Jonathan Bradley Whited (@esotericpig)
+  # @author Jonathan Bradley Whited
   # @since  0.2.0
   ###
   class Cleaner
     def begin_clean(str)
       return str
     end
-    
+
     def clean(str)
       str = begin_clean(str)
       str = end_clean(str)
-      
+
       return str
     end
-    
+
     def self.clean_any(obj,cleaners)
-      return nil if obj.nil?()
-      
+      return nil if obj.nil?
+
       cleaners = Array(cleaners)
-      
-      return obj if cleaners.empty?()
-      
+
+      return obj if cleaners.empty?
+
       if obj.is_a?(Word)
         obj = Word.new(
           kana: clean_any(obj.kana,cleaners),
@@ -56,17 +44,17 @@ module NHKore
           word: obj
         )
       else # String
-        cleaners.each() do |cleaner|
+        cleaners.each do |cleaner|
           obj = cleaner.clean(obj)
         end
       end
-      
+
       return obj
     end
   end
-  
+
   ###
-  # @author Jonathan Bradley Whited (@esotericpig)
+  # @author Jonathan Bradley Whited
   # @since  0.2.0
   ###
   class BasicCleaner < Cleaner
@@ -75,15 +63,15 @@ module NHKore
       #   and Polisher will remove the leftover punctuation, digits, etc.
       # If this is stricter, then errors will be raised in ArticleScraper's
       #   scrape_dicwin_word() & scrape_ruby_word().
-      
+
       str = Util.unspace_web_str(str) # Who needs space in Japanese?
-      
+
       return str
     end
   end
-  
+
   ###
-  # @author Jonathan Bradley Whited (@esotericpig)
+  # @author Jonathan Bradley Whited
   # @since  0.2.0
   ###
   class BestCleaner < BasicCleaner

data/lib/nhkore/cli/fx_cmd.rb

@@ -1,113 +1,101 @@
-#!/usr/bin/env ruby
 # encoding: UTF-8
 # frozen_string_literal: true
 
 #--
 # This file is part of NHKore.
-# Copyright (c) 2020 Jonathan Bradley Whited (@esotericpig)
-# 
-# NHKore is free software: you can redistribute it and/or modify
-# it under the terms of the GNU Lesser General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-# 
-# NHKore is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Lesser General Public License for more details.
-# 
-# You should have received a copy of the GNU Lesser General Public License
-# along with NHKore.  If not, see <https://www.gnu.org/licenses/>.
+# Copyright (c) 2020-2021 Jonathan Bradley Whited
+#
+# SPDX-License-Identifier: LGPL-3.0-or-later
 #++
 
 
 module NHKore
 module CLI
   ###
-  # @author Jonathan Bradley Whited (@esotericpig)
+  # @author Jonathan Bradley Whited
   # @since  0.2.0
   ###
   module FXCmd
-    def build_fx_cmd()
+    def build_fx_cmd
       app = self
-      
-      @fx_cmd = @app_cmd.define_command() do
+
+      @fx_cmd = @app_cmd.define_command do
         name    'fx'
         usage   'fx [OPTIONS] [COMMAND]...'
         summary 'Test spinner/progress special effects (for running long tasks)'
-        
-        description <<-EOD
+
+        description <<-DESC
           Test if the special effects work on your command line:\n
           - #{App::NAME} [-s/-X] fx
-        EOD
-        
+        DESC
+
         flag :a,:all,'test all special effects regardless of global options'
-        
+
         run do |opts,args,cmd|
           app.refresh_cmd(opts,args,cmd)
-          app.run_fx_cmd()
+          app.run_fx_cmd
         end
       end
     end
-    
-    def run_fx_cmd()
-      test_fx_progress_bar()
-      test_fx_spinner()
+
+    def run_fx_cmd
+      test_fx_progress_bar
+      test_fx_spinner
     end
-    
-    def test_fx_progress_bar()
+
+    def test_fx_progress_bar
       bars = nil
-      
+
       if @cmd_opts[:all]
         bars = {default: :default,classic: :classic,no: :no}
       else
         bars = {user: @progress_bar}
       end
-      
-      bars.each() do |name,bar|
-        name = name.to_s().capitalize()
+
+      bars.each do |name,bar|
+        name = name.to_s.capitalize
         bar = build_progress_bar("Testing #{name} progress",download: false,type: bar)
-        
-        bar.start()
-        
+
+        bar.start
+
         0.upto(99) do
           sleep(0.05)
-          bar.advance()
+          bar.advance
         end
-        
-        bar.finish()
+
+        bar.finish
       end
     end
-    
-    def test_fx_spinner()
+
+    def test_fx_spinner
       app_spinner = @spinner
       spinners = nil
-      
+
       if @cmd_opts[:all]
         spinners = {
           default: App::DEFAULT_SPINNER,
           classic: App::CLASSIC_SPINNER,
-          no: App::NO_SPINNER
+          no: {},
         }
       else
         spinners = {
           user: app_spinner
         }
       end
-      
-      spinners.each() do |name,spinner|
+
+      spinners.each do |name,spinner|
         @spinner = spinner
-        
-        start_spin("Testing #{name.to_s().capitalize()} spinner")
-        
+
+        start_spin("Testing #{name.to_s.capitalize} spinner")
+
         1.upto(3) do |i|
           sleep(1.1)
           update_spin_detail(" (#{i}/3)")
         end
-        
-        stop_spin()
+
+        stop_spin
       end
-      
+
       # Reset back to users'.
       @spinner = app_spinner
     end

data/lib/nhkore/cli/get_cmd.rb

@@ -1,23 +1,11 @@
-#!/usr/bin/env ruby
 # encoding: UTF-8
 # frozen_string_literal: true
 
 #--
 # This file is part of NHKore.
-# Copyright (c) 2020 Jonathan Bradley Whited (@esotericpig)
-# 
-# NHKore is free software: you can redistribute it and/or modify
-# it under the terms of the GNU Lesser General Public License as published by
-# the Free Software Foundation, either version 3 of the License, or
-# (at your option) any later version.
-# 
-# NHKore is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU Lesser General Public License for more details.
-# 
-# You should have received a copy of the GNU Lesser General Public License
-# along with NHKore.  If not, see <https://www.gnu.org/licenses/>.
+# Copyright (c) 2020-2021 Jonathan Bradley Whited
+#
+# SPDX-License-Identifier: LGPL-3.0-or-later
 #++
 
 
@@ -27,140 +15,141 @@ require 'nhkore/util'
 module NHKore
 module CLI
   ###
-  # @author Jonathan Bradley Whited (@esotericpig)
+  # @author Jonathan Bradley Whited
   # @since  0.2.0
   ###
   module GetCmd
     DEFAULT_GET_CHUNK_SIZE = 4 * 1024
-    DEFAULT_GET_URL_LENGTH = 5_000_000 # Just a generous estimation used as a fallback; may be outdated
+    DEFAULT_GET_URL_LENGTH = 11_000_000 # Just a generous estimation used as a fallback; may be outdated.
     GET_URL_FILENAME = 'nhkore-core.zip'
     GET_URL = "https://github.com/esotericpig/nhkore/releases/latest/download/#{GET_URL_FILENAME}"
-    
-    def build_get_cmd()
+
+    def build_get_cmd
       app = self
-      
-      @get_cmd = @app_cmd.define_command() do
+
+      @get_cmd = @app_cmd.define_command do
         name    'get'
         usage   'get [OPTIONS] [COMMAND]...'
         aliases :g
-        summary "Download NHKore's pre-scraped files from the latest release (aliases: #{app.color_alias('g')})"
-        
-        description <<-EOD
+        summary "Download NHKore's pre-scraped files from the latest release" \
+                " (aliases: #{app.color_alias('g')})"
+
+        description(<<-DESC)
           Download NHKore's pre-scraped files from the latest release &
           save to folder: #{Util::CORE_DIR}
-          
+
           Note: the latest NHK articles may not have been scraped yet.
-        EOD
-        
+        DESC
+
         option :o,:out,'directory to save downloaded files to',argument: :required,default: Util::CORE_DIR,
-          transform: -> (value) do
-          app.check_empty_opt(:out,value)
-        end
+            transform: lambda { |value|
+              app.check_empty_opt(:out,value)
+            }
         flag nil,:'show-url','show download URL and exit (for downloading manually)' do |value,cmd|
           puts GET_URL
           exit
         end
-        
+
         run do |opts,args,cmd|
           app.refresh_cmd(opts,args,cmd)
-          app.run_get_cmd()
+          app.run_get_cmd
         end
       end
     end
-    
-    def run_get_cmd()
+
+    def run_get_cmd
       require 'down/net_http'
       require 'tempfile'
       require 'zip'
-      
+
       build_out_dir(:out,default_dir: Util::CORE_DIR)
-      
+
       return unless check_out_dir(:out)
-      
+
       chunk_size = DEFAULT_GET_CHUNK_SIZE
       down = nil
       dry_run = @cmd_opts[:dry_run]
       force = @cmd_opts[:force]
       max_retries = @scraper_kargs[:max_retries]
-      max_retries = 3 if max_retries.nil?()
+      max_retries = 3 if max_retries.nil?
       out_dir = @cmd_opts[:out]
-      
+
       begin
         start_spin('Opening URL')
-        
+
         begin
           down = Down::NetHttp.open(GET_URL,rewindable: false,**@scraper_kargs)
         rescue Down::ConnectionError
           raise if (max_retries -= 1) < 0
           retry
         end
-        
-        stop_spin()
-        
+
+        stop_spin
+
         return if dry_run
-        
+
         Tempfile.create(["#{App::NAME}_",'.zip'],binmode: true) do |file|
           puts
           puts "Downloading #{GET_URL_FILENAME} to temp file:"
           puts "> #{file.path}"
-          
+
           len = down.size
-          len = DEFAULT_GET_LENGTH if len.nil?() || len < 1
+          len = DEFAULT_GET_LENGTH if len.nil? || len < 1
           bar = build_progress_bar('> Downloading',download: true,total: len)
-          
-          bar.start()
-          
-          while !down.eof?()
+
+          bar.start
+
+          while !down.eof?
             file.write(down.read(chunk_size))
             bar.advance(chunk_size)
           end
-          
-          down.close()
-          file.close()
-          bar.finish()
-          
+
+          down.close
+          file.close
+          bar.finish
+
           puts
           puts "Extracting #{GET_URL_FILENAME}..."
-          
+
           # We manually ask the user whether to overwrite each file, so set this to
           # true so that Zip extract() will force overwrites and not raise an error.
           Zip.on_exists_proc = true
-          
+
           Zip::File.open(file) do |zip_file|
-            zip_file.each() do |entry|
-              if !entry.name_safe?()
+            zip_file.each do |entry|
+              if !entry.name_safe?
                 raise ZipError,"unsafe entry name[#{entry.name}] in Zip file"
               end
-              
+
               name = Util.strip_web_str(File.basename(entry.name))
-              
-              next if name.empty?()
-              
+
+              next if name.empty?
+
               out_file = File.join(out_dir,name)
-              
+
               puts "> #{name}"
-              
+
               if !force && File.exist?(out_file)
                 puts
                 puts 'Warning: output file already exists!'
                 puts "> '#{out_file}'"
-                
+
                 overwrite = @high.agree('Overwrite this file (yes/no)? ')
                 puts
-                
+
                 next unless overwrite
               end
-              
+
               entry.extract(out_file)
             end
           end
-          
+
           puts
           puts "Extracted #{GET_URL_FILENAME} to directory:"
           puts "> #{out_dir}"
         end
       ensure
-        down.close() if !down.nil?() && !down.closed?()
+        down.close if !down.nil? && !down.closed?
       end
     end
   end