nhkore 0.3.16 → 0.3.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f23192b04fc6a0c1cf225db4a029e3226346d27c4fe977ee05f1b522c40708bb
-  data.tar.gz: 3e71d5ef9eb60327cb9ced89a819de77b5cd8910e755332d5764dc95e8263f71
+  metadata.gz: 6c5e1fbcf5bb3f6dc23b6595e4138efb68597ac79cd01dac27cd242b914153ea
+  data.tar.gz: 7608824e45a76a69175cf272e1301cfd062845a9de916b9034c0c4d13df73bb3
 SHA512:
-  metadata.gz: 2cec06bd51e86ddd7b30a052b4078a2932344996bd6d97c4b7d927d0bc8fbcecbd2fb21680957551857d3a152d33409aa7ee8e1dd496a271cb31c63cbe2eb2e9
-  data.tar.gz: 186c42412e35567aebe2afee71636fb58a28510bd6ab3e8b65df6adef5373860f25e87be71e5d8499dcf6b6babb0ee3aae796a01f818732bc53ad682e584e701
+  metadata.gz: 119c88fdd9377f96fe6bf3816d2c0b7eacbd5002fa2f0d8c852d8179f9058b8a8182ea5c828dbc61032647ac797c20289456144b30d0c5172a8be9ae527ffa14
+  data.tar.gz: 73e2e75d1f4d444fe0fc9ade55bff57aaaa8876e5978aad62a925536bac8b0cf2a1d5db39d2ddfd5de9f5e65e95aa30adadbee70608111e1b2e310b6fd840e8b

data/.yardopts

@@ -1,3 +1,3 @@
---files 'CHANGELOG.md,LICENSE.txt'
+--files 'LICENSE.txt,CHANGELOG.md'
 --protected
 --readme 'README.md'

data/CHANGELOG.md

@@ -5,10 +5,30 @@ All notable changes to this project will be documented in this file.
 Format is based on [Keep a Changelog v1.0.0](https://keepachangelog.com/en/1.0.0),
 and this project adheres to [Semantic Versioning v2.0.0](https://semver.org/spec/v2.0.0.html).
 
-## [[Unreleased]](https://github.com/esotericpig/nhkore/compare/v0.3.16...HEAD)
+## [[Unreleased]](https://github.com/esotericpig/nhkore/compare/v0.3.18...HEAD)
 -
 
 
+## [v0.3.18] - 2025-04-24
+
+### Changed
+- Changed Nokogiri gem version to `~> 1`, instead of `~> 1.xx`, as I got tired of the security alerts. Now, it will always be up-to-date and secure.
+- Updated gems.
+- Removed `yard_ghurt` gem.
+- Applied new RuboCop suggestions.
+
+### Fixed
+- Bing no longer allows `count`, so removed it. No workaround/fix for now....
+- New NHK Easy pages no longer have a dictionary, so changed it to only warn instead of an exception.
+
+
+## [v0.3.17] - 2024-09-03
+
+### Changed
+- Upgraded min Ruby version to 3.1 (lowest that is not EOL).
+- Updated gems.
+
+
 ## [v0.3.16] - 2024-08-14
 
 ### Fixed

data/Gemfile

@@ -1,7 +1,19 @@
 # encoding: UTF-8
 # frozen_string_literal: true
 
-
 source 'https://rubygems.org'
 
 gemspec
+
+group :development,:test do
+  gem 'bundler'  ,'~> 2.6'
+  gem 'rake'     ,'~> 13.2'
+  gem 'raketeer' ,'~> 0.2'  # Extra Rake tasks.
+  gem 'rdoc'     ,'~> 6.13' # YARDoc RDoc (*.rb).
+  gem 'redcarpet','~> 3.6'  # YARDoc Markdown (*.md).
+  gem 'yard'     ,'~> 0.9'  # YARDoc doc.
+end
+
+group :test do
+  gem 'minitest','~> 5.25'
+end

data/Gemfile.lock

@@ -1,20 +1,21 @@
 PATH
   remote: .
   specs:
-    nhkore (0.3.16)
+    nhkore (0.3.18)
       attr_bool (~> 0.2)
       bimyou_segmenter (~> 1.2)
       cri (~> 2.15)
+      csv (~> 3.3)
       down (~> 5.4)
       highline (~> 3.1)
       http-cookie (~> 1.0)
       japanese_deinflector (~> 0.0)
-      nokogiri (~> 1.16)
+      nokogiri (~> 1)
       psychgus (~> 1.3)
       public_suffix (~> 6.0)
       rainbow (~> 3.1)
       rss (~> 0.3)
-      rubyzip (~> 2.3)
+      rubyzip (~> 2.4)
       tiny_segmenter (~> 0.0)
       tty-progressbar (~> 0.18)
       tty-spinner (~> 0.9)
@@ -27,23 +28,26 @@ GEM
     attr_bool (0.2.2)
     bimyou_segmenter (1.2.0)
     cri (2.15.12)
+    csv (3.3.4)
+    date (3.4.1)
     domain_name (0.6.20240107)
     down (5.4.2)
       addressable (~> 2.8)
-    highline (3.1.0)
+    highline (3.1.2)
       reline
-    http-cookie (1.0.6)
+    http-cookie (1.0.8)
       domain_name (~> 0.5)
-    io-console (0.7.2)
+    io-console (0.8.0)
     japanese_deinflector (0.0.2)
-    mini_portile2 (2.8.7)
-    minitest (5.25.0)
-    nokogiri (1.16.7)
+    mini_portile2 (2.8.8)
+    minitest (5.25.5)
+    nokogiri (1.18.8)
       mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
-    psych (5.1.2)
+    psych (5.2.3)
+      date
       stringio
-    psychgus (1.3.4)
+    psychgus (1.3.5)
       psych (>= 3.0)
     public_suffix (6.0.1)
     racc (1.8.1)
@@ -51,22 +55,20 @@ GEM
     rake (13.2.1)
     raketeer (0.2.13)
       rake
-    rdoc (6.7.0)
+    rdoc (6.13.1)
       psych (>= 4.0.0)
-    redcarpet (3.6.0)
-    reline (0.5.9)
+    redcarpet (3.6.1)
+    reline (0.6.1)
       io-console (~> 0.5)
-    rexml (3.3.5)
-      strscan
+    rexml (3.4.1)
     rss (0.3.1)
       rexml
-    rubyzip (2.3.2)
-    stringio (3.1.1)
+    rubyzip (2.4.1)
+    stringio (3.1.7)
     strings-ansi (0.2.0)
-    strscan (3.1.0)
     tiny_segmenter (0.0.6)
     tty-cursor (0.7.1)
-    tty-progressbar (0.18.2)
+    tty-progressbar (0.18.3)
       strings-ansi (~> 0.2)
       tty-cursor (~> 0.7)
       tty-screen (~> 0.8)
@@ -74,25 +76,21 @@ GEM
     tty-screen (0.8.2)
     tty-spinner (0.9.3)
       tty-cursor (~> 0.7)
-    unicode-display_width (2.5.0)
-    yard (0.9.36)
-    yard_ghurt (1.2.1)
-      rake
-      yard
+    unicode-display_width (2.6.0)
+    yard (0.9.37)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 2.5)
+  bundler (~> 2.6)
   minitest (~> 5.25)
   nhkore!
   rake (~> 13.2)
   raketeer (~> 0.2)
-  rdoc (~> 6.7)
+  rdoc (~> 6.13)
   redcarpet (~> 3.6)
   yard (~> 0.9)
-  yard_ghurt (~> 1.2)
 
 BUNDLED WITH
-   2.5.17
+   2.6.8

data/Rakefile

@@ -1,7 +1,6 @@
 # encoding: UTF-8
 # frozen_string_literal: true
 
-
 require 'bundler/gem_tasks'
 
 require 'rake/clean'
@@ -9,46 +8,41 @@ require 'rake/testtask'
 require 'raketeer/irb'
 require 'raketeer/nokogiri_installs'
 require 'yard'
-require 'yard_ghurt'
 
 require 'nhkore/util'
 require 'nhkore/version'
 
-
 PKG_DIR = 'pkg'
 
 CLEAN.exclude('{.git,core,stock}/**/*')
-CLOBBER.include('doc/',File.join(PKG_DIR,''))
-
+CLOBBER.include('doc/',"#{PKG_DIR}/")
 
-task default: [:test]
+task default: %i[test]
 
 desc 'Generate documentation (YARDoc)'
-task doc: %i[yard yard_gfm_fix] do |task|
-end
+task doc: %i[yard]
 
-desc "Package '#{File.join(NHKore::Util::CORE_DIR,'')}' data as a Zip file into '#{File.join(PKG_DIR,'')}'"
-task :pkg_core do |task|
+desc "Package '#{NHKore::Util::CORE_DIR}/' data as a Zip file into '#{PKG_DIR}/'"
+task :pkg_core do |_task|
   mkdir_p PKG_DIR
 
-  pattern = File.join(NHKore::Util::CORE_DIR,'*.{csv,html,json,yml}')
+  pattern = "#{NHKore::Util::CORE_DIR}/*.{csv,html,json,yml}"
   zip_file = File.join(PKG_DIR,'nhkore-core.zip')
 
-  sh 'zip','-9rv',zip_file,*Dir.glob(pattern).sort
+  sh 'zip','-9rv',zip_file,*Dir.glob(pattern)
 end
 
 Rake::TestTask.new do |task|
-  task.libs = ['lib','test']
-  task.pattern = File.join('test','**','*_test.rb')
-  task.description += ": '#{task.pattern}'"
+  task.libs = %w[lib test]
+  task.pattern = 'test/**/*_test.rb'
   task.verbose = false
   task.warning = true
 end
 
 # If you need to run a part after the 1st part,
 # just type 'n' to not overwrite the file and then 'y' for continue.
-desc "Update '#{File.join(NHKore::Util::CORE_DIR,'')}' files for release"
-task :update_core do |task|
+desc "Update '#{NHKore::Util::CORE_DIR}/' files for release"
+task :update_core do |_task|
   require 'highline'
 
   continue_msg = "\nContinue (y/n)? "
@@ -63,7 +57,7 @@ task :update_core do |task|
   next unless hl.agree(continue_msg)
   puts
 
-  next unless sh(*cmd,'news','-s','1000','ez')
+  next unless sh(*cmd,'news','-s','1000','ez','--lenient')
   next unless hl.agree(continue_msg)
   puts
 
@@ -78,7 +72,7 @@ task :update_core do |task|
 end
 
 desc 'Update showcase file for release'
-task :update_showcase do |task|
+task :update_showcase do |_task|
   require 'highline'
 
   showcase_file = File.join('.','nhkore-ez.html')
@@ -86,43 +80,16 @@ task :update_showcase do |task|
   hl = HighLine.new
 
   next unless sh('ruby','-w','./lib/nhkore.rb',
-    'sift','ez','--no-eng',
-    '--out',showcase_file,
-  )
+                 'sift','ez','--no-eng',
+                 '--out',showcase_file)
+
+  dest_dir = File.join('..','esotericpig.github.io','showcase','')
 
-  next unless hl.agree("\nMove the file (y/n)? ")
+  next unless hl.agree("\nMove the file to '#{dest_dir}' (y/n)? ")
   puts
-  next unless sh('mv','-iv',showcase_file,
-    File.join('..','esotericpig.github.io','showcase',''),
-  )
+  next unless sh('mv','-iv',showcase_file,dest_dir)
 end
 
 YARD::Rake::YardocTask.new do |task|
-  task.options += ['--template-path',File.join('yard','templates')]
   task.options += ['--title',"NHKore v#{NHKore::VERSION} Doc"]
 end
-
-# Execute "rake yard_gfm_fix" for production.
-# Execute "rake yard_gfm_fix[true]" for testing locally.
-YardGhurt::GFMFixTask.new do |task|
-  task.arg_names = [:dev]
-  task.dry_run = false
-  task.fix_code_langs = true
-  task.md_files = ['index.html']
-
-  task.before = proc do |t,args|
-    # Delete this file as it's never used (index.html is an exact copy).
-    YardGhurt::Util.rm_exist(File.join(t.doc_dir,'file.README.html'))
-
-    # Root dir of my GitHub Page for CSS/JS.
-    ghp_root = YardGhurt::Util.to_bool(args.dev) ? '../../esotericpig.github.io' : '../../..'
-
-    t.css_styles << %Q(<link rel="stylesheet" type="text/css" href="#{ghp_root}/css/prism.css" />)
-    t.js_scripts << %Q(<script src="#{ghp_root}/js/prism.js"></script>)
-  end
-end
-
-# Probably not useful for others.
-YardGhurt::GHPSyncTask.new do |task|
-  task.ghp_dir = '../esotericpig.github.io/docs/nhkore/yardoc'
-end

data/bin/nhkore

@@ -9,8 +9,6 @@
 # SPDX-License-Identifier: LGPL-3.0-or-later
 #++
 
-
 require 'nhkore'
 
-
 NHKore.run

data/lib/nhkore/app.rb

@@ -8,7 +8,6 @@
 # SPDX-License-Identifier: LGPL-3.0-or-later
 #++
 
-
 require 'cri'
 require 'highline'
 require 'rainbow'
@@ -25,7 +24,6 @@ require 'nhkore/cli/news_cmd'
 require 'nhkore/cli/search_cmd'
 require 'nhkore/cli/sift_cmd'
 
-
 module NHKore
   module CLI
   end
@@ -40,7 +38,7 @@ module NHKore
       @color = color
     end
 
-    def color?(io)
+    def color?(_io)
       return @color
     end
   end
@@ -73,7 +71,7 @@ module NHKore
     attr_accessor :sleep_time
     attr_accessor :spinner
 
-    def initialize(args=ARGV)
+    def initialize(args = ARGV)
       super()
 
       @args = args
@@ -150,13 +148,13 @@ module NHKore
           This is similar to a core word/vocabulary list.
         DESC
 
-        flag :s,:'classic-fx',<<-DESC do |value,cmd|
+        flag :s,:'classic-fx',<<-DESC do |_value,_cmd|
           use classic spinner/progress special effects (in case of no Unicode support) when running long tasks
         DESC
           app.progress_bar = :classic
           app.spinner = CLASSIC_SPINNER
         end
-        flag COLOR_OPTS[0],COLOR_OPTS[1],"force color output (for commands like '| less -R')" do |value,cmd|
+        flag COLOR_OPTS[0],COLOR_OPTS[1],"force color output (for commands like '| less -R')" do |_value,_cmd|
           app.enable_color(true)
         end
         flag :n,:'dry-run',<<-DESC
@@ -164,11 +162,11 @@ module NHKore
         DESC
         # Big F because dangerous.
         flag :F,:force,"force overwriting files, creating directories, etc. (don't prompt); dangerous!"
-        flag :h,:help,'show this help' do |value,cmd|
+        flag :h,:help,'show this help' do |_value,cmd|
           puts cmd.help
           exit
         end
-        option :m,:'max-retry',<<-DESC,argument: :required,default: 3 do |value,cmd|
+        option :m,:'max-retry',<<-DESC,argument: :required,default: 3 do |value,_cmd|
           maximum number of times to retry URLs (-1 or integer >= 0)
         DESC
           value = value.to_i
@@ -176,14 +174,14 @@ module NHKore
 
           app.scraper_kargs[:max_retries] = value
         end
-        flag NO_COLOR_OPTS[0],NO_COLOR_OPTS[1],'disable color output' do |value,cmd|
+        flag NO_COLOR_OPTS[0],NO_COLOR_OPTS[1],'disable color output' do |_value,_cmd|
           app.enable_color(false)
         end
-        flag :X,:'no-fx','disable spinner/progress special effects when running long tasks' do |value,cmd|
+        flag :X,:'no-fx','disable spinner/progress special effects when running long tasks' do |_value,_cmd|
           app.progress_bar = :no
           app.spinner = {} # Still outputs status & stores tokens
         end
-        option :o,:'open-timeout',<<-DESC,argument: :required do |value,cmd|
+        option :o,:'open-timeout',<<-DESC,argument: :required do |value,_cmd|
           seconds for URL open timeouts (-1 or decimal >= 0)
         DESC
           value = value.to_f
@@ -191,7 +189,7 @@ module NHKore
 
           app.scraper_kargs[:open_timeout] = value
         end
-        option :r,:'read-timeout',<<-DESC,argument: :required do |value,cmd|
+        option :r,:'read-timeout',<<-DESC,argument: :required do |value,_cmd|
           seconds for URL read timeouts (-1 or decimal >= 0)
         DESC
           value = value.to_f
@@ -199,13 +197,13 @@ module NHKore
 
           app.scraper_kargs[:read_timeout] = value
         end
-        option :z,:sleep,<<-DESC,argument: :required,default: DEFAULT_SLEEP_TIME do |value,cmd|
+        option :z,:sleep,<<-DESC,argument: :required,default: DEFAULT_SLEEP_TIME do |value,_cmd|
           seconds to sleep per scrape (i.e., per page/article) so don't get banned (i.e., fake being human)
         DESC
           app.sleep_time = value.to_f
           app.sleep_time = 0.0 if app.sleep_time < 0.0
         end
-        option :t,:timeout,<<-DESC,argument: :required do |value,cmd|
+        option :t,:timeout,<<-DESC,argument: :required do |value,_cmd|
           seconds for all URL timeouts: [open, read] (-1 or decimal >= 0)
         DESC
           value = value.to_f
@@ -214,7 +212,7 @@ module NHKore
           app.scraper_kargs[:open_timeout] = value
           app.scraper_kargs[:read_timeout] = value
         end
-        option :u,:'user-agent',<<-DESC,argument: :required do |value,cmd|
+        option :u,:'user-agent',<<-DESC,argument: :required do |value,_cmd|
           HTTP header field 'User-Agent' to use instead of a random one
         DESC
           value = app.check_empty_opt(:'user-agent',value)
@@ -222,12 +220,12 @@ module NHKore
           app.scraper_kargs[:header] ||= {}
           app.scraper_kargs[:header]['user-agent'] = value
         end
-        flag :v,:version,'show the version and exit' do |value,cmd|
+        flag :v,:version,'show the version and exit' do |_value,_cmd|
           app.show_version
           exit
         end
 
-        run do |opts,args,cmd|
+        run do |_opts,_args,cmd|
           puts cmd.help
         end
       end
@@ -253,21 +251,20 @@ module NHKore
       file = Util.strip_web_str(@cmd_opts[opt_key].to_s)
 
       if file.empty?
-        # Do not check default_dir.empty?().
-        if default_filename.empty?
-          file = nil # nil is very important for BingScraper.init()!
-        else
-          file = File.join(default_dir,default_filename)
-        end
+        # Do not check `default_dir.empty?()`.
+        file = if default_filename.empty?
+                 nil # NOTE: nil is very important for BingScraper.init()!
+               else
+                 File.join(default_dir,default_filename)
+               end
+      # Directory?
+      elsif File.directory?(file) || Util.dir_str?(file)
+        file = File.join(file,default_filename)
+      # File name only? (no directory)
+      elsif Util.filename_str?(file)
+        file = File.join(default_dir,file)
       else
-        # Directory?
-        if File.directory?(file) || Util.dir_str?(file)
-          file = File.join(file,default_filename)
-        # File name only? (no directory)
-        elsif Util.filename_str?(file)
-          file = File.join(default_dir,file)
-        end
-        # Else, passed in both: 'directory/file'
+        # Passed in both: 'directory/file'
       end
 
       # '~' will expand to home, etc.
@@ -307,7 +304,7 @@ module NHKore
             config.head       = 'o'
           end
 
-          #config.frequency = 5 # For a big download, set this
+          # config.frequency = 5 # For a big download, set this
           config.interval = 1 if download
         end
       end
@@ -325,7 +322,7 @@ module NHKore
         aliases :v
         summary "Show the version and exit (aliases: #{app.color_alias('v')})"
 
-        run do |opts,args,cmd|
+        run do |_opts,_args,_cmd|
           app.show_version
         end
       end
@@ -501,14 +498,15 @@ module NHKore
       #   this due to relying on @cmd_opts[:ext] to be nil.
       #   It's easy to change this one instance, but I'm not sure
       #   at the moment where else might be affected
-      ## Cri has a default proc for default values
-      ##   that doesn't store the keys.
-      #new_opts.default_proc = proc do |hash,key|
-      #  # :max_retry => %s(max-retry)
-      #  key = key.to_s.gsub('_','-').to_sym
       #
-      #  opts.default_proc.call(hash,key)
-      #end
+      # # Cri has a default proc for default values
+      # #   that doesn't store the keys.
+      # new_opts.default_proc = proc do |hash,key|
+      #   # :max_retry => %s(max-retry)
+      #   key = key.to_s.gsub('_','-').to_sym
+      #
+      #   opts.default_proc.call(hash,key)
+      # end
 
       @cmd = cmd
       @cmd_args = args
@@ -547,7 +545,7 @@ module NHKore
 
     def stop_spin
       if @spinner.is_a?(Hash)
-        puts (NO_SPINNER_MSG % @spinner) + ' done!'
+        puts "#{NO_SPINNER_MSG % @spinner} done!"
       else
         @spinner.reset
         @spinner.stop('done!')
@@ -586,7 +584,7 @@ module NHKore
       @tokens[:progress] = 0
     end
 
-    def advance(progress=1)
+    def advance(progress = 1)
       total = @tokens[:total]
       progress = @tokens[:progress] + progress
       progress = total if progress > total

data/lib/nhkore/article.rb

@@ -8,13 +8,11 @@
 # SPDX-License-Identifier: LGPL-3.0-or-later
 #++
 
-
 require 'time'
 
 require 'nhkore/util'
 require 'nhkore/word'
 
-
 module NHKore
   class Article
     attr_reader :datetime
@@ -69,7 +67,7 @@ module NHKore
       coder[:words] = @words
     end
 
-    def self.load_data(key,hash)
+    def self.load_data(_key,hash)
       words = hash[:words]
 
       article = Article.new
@@ -80,7 +78,7 @@ module NHKore
       article.title = hash[:title]
       article.url = hash[:url]
 
-      words&.each() do |k,h|
+      words&.each do |k,h|
         k = k.to_s # Change from a symbol
         article.words[k] = Word.load_data(k,h)
       end
@@ -89,11 +87,11 @@ module NHKore
     end
 
     def datetime=(value)
-      if value.is_a?(Time)
-        @datetime = value
-      else
-        @datetime = Util.empty_web_str?(value) ? nil : Time.iso8601(value)
-      end
+      @datetime = if value.is_a?(Time)
+                    value
+                  else
+                    Util.empty_web_str?(value) ? nil : Time.iso8601(value)
+                  end
     end
 
     def futsuurl=(value)
@@ -118,7 +116,7 @@ module NHKore
 
       if !mini
         s << "\n  words:"
-        @words.each do |key,word|
+        @words.each do |_key,word|
           s << "\n    #{word}"
         end
       end