nhkore 0.3.6 → 0.3.10

data/lib/nhkore/lib.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
 #++
 
 
@@ -50,8 +38,8 @@ module NHKore
   ###
   # Include this file to only require the files needed to use this
   # Gem as a library (i.e., don't include CLI-related files).
-  # 
-  # @author Jonathan Bradley Whited (@esotericpig)
+  #
+  # @author Jonathan Bradley Whited
   # @since  0.3.2
   ###
   module Lib

data/lib/nhkore/missingno.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
 #++
 
 
@@ -26,20 +14,20 @@ require 'nhkore/util'
 
 module NHKore
   ###
-  # @author Jonathan Bradley Whited (@esotericpig)
+  # @author Jonathan Bradley Whited
   # @since  0.2.0
   ###
   class Missingno
     attr_reader :kanas
     attr_reader :kanjis
-    
+
     # @param data [News,Article,Array<Word>]
     def initialize(data)
       super()
-      
+
       @kanas = {}
       @kanjis = {}
-      
+
       # News?
       if data.respond_to?(:articles)
         add_news(data)
@@ -50,43 +38,43 @@ module NHKore
         add_words(data)
       end
     end
-    
+
     def add_article(article)
-      add_words(article.words.values())
+      add_words(article.words.values)
     end
-    
+
     def add_news(news)
-      news.articles.values.each() do |article|
+      news.articles.each_value do |article|
         add_article(article)
       end
     end
-    
+
     def add_words(words)
-      words.each() do |word|
+      words.each do |word|
         # We only want ones that are both filled in because
         #   Word.scrape_ruby_tag() will raise an error if either is empty.
         next if Util.empty_web_str?(word.kana) || Util.empty_web_str?(word.kanji)
-        
+
         if !kanas.key?(word.kana)
           kanas[word.kana] = word
         end
-        
+
         if !kanjis.key?(word.kanji)
           kanjis[word.kanji] = word
         end
       end
     end
-    
+
     def kana_from_kanji(kanji)
       word = @kanjis[kanji]
-      
-      return word.nil?() ? nil : word.kana
+
+      return word.nil? ? nil : word.kana
     end
-    
+
     def kanji_from_kana(kana)
       word = @kanas[kana]
-      
-      return word.nil?() ? nil : word.kanji
+
+      return word.nil? ? nil : word.kanji
     end
   end
 end

data/lib/nhkore/news.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
 #++
 
 
@@ -29,155 +17,153 @@ require 'nhkore/util'
 
 module NHKore
   ###
-  # @author Jonathan Bradley Whited (@esotericpig)
+  # @author Jonathan Bradley Whited
   # @since  0.2.0
   ###
   class News
     include Fileable
-    
+
     DEFAULT_DIR = Util::CORE_DIR
-    FAVORED_URL = /https\:/i
-    
+    FAVORED_URL = /https:/i.freeze
+
     attr_reader :articles
     attr_reader :sha256s
-    
-    def initialize()
+
+    def initialize
       super()
-      
+
       @articles = {}
       @sha256s = {}
     end
-    
+
     def add_article(article,key: nil,overwrite: false)
       url = article.url
-      url = url.to_s() unless url.nil?()
-      
-      key = key.nil?() ? url : key.to_s()
-      
+      url = url.to_s unless url.nil?
+
+      key = key.nil? ? url : key.to_s
+
       if !overwrite
         raise ArgumentError,"duplicate article[#{key}] in articles" if @articles.key?(key)
         raise ArgumentError,"duplicate sha256[#{article.sha256}] in articles" if @sha256s.key?(article.sha256)
       end
-      
+
       @articles[key] = article
       @sha256s[article.sha256] = url
-      
+
       return self
     end
-    
+
     def self.build_file(filename)
       return File.join(DEFAULT_DIR,filename)
     end
-    
+
     def encode_with(coder)
       # Order matters.
       # Don't output @sha256s.
-      
+
       coder[:articles] = @articles
     end
-    
+
     def self.load_data(data,article_class: Article,file: nil,news_class: News,overwrite: false,**kargs)
       data = Util.load_yaml(data,file: file)
-      
+
       articles = data[:articles]
-      
-      news = news_class.new()
-      
-      if !articles.nil?()
-        articles.each() do |key,hash|
-          key = key.to_s() # Change from a symbol
-          news.add_article(article_class.load_data(key,hash),key: key,overwrite: overwrite)
-        end
+
+      news = news_class.new
+
+      articles&.each() do |key,hash|
+        key = key.to_s # Change from a symbol
+        news.add_article(article_class.load_data(key,hash),key: key,overwrite: overwrite)
       end
-      
+
       return news
     end
-    
+
     def update_article(article,url)
-      url = url.to_s() unless url.nil?()
-      
+      url = url.to_s unless url.nil?
+
       # Favor https.
-      return if article.url.to_s() =~ FAVORED_URL
+      return if article.url.to_s =~ FAVORED_URL
       return if url !~ FAVORED_URL
-      
+
       @articles.delete(article.url) # Probably no to_s() here
       @articles[url] = article
       article.url = url
     end
-    
+
     def article(key)
-      key = key.to_s() unless key.nil?()
-      
+      key = key.to_s unless key.nil?
+
       return @articles[key]
     end
-    
+
     def article_with_sha256(sha256)
       article = nil
-      
-      @articles.values().each() do |a|
+
+      @articles.each_value do |a|
         if a.sha256 == sha256
           article = a
-          
+
           break
         end
       end
-      
+
       return article
     end
-    
+
     def article?(key)
-      key = key.to_s() unless key.nil?()
-      
+      key = key.to_s unless key.nil?
+
       return @articles.key?(key)
     end
-    
+
     def sha256?(sha256)
       return @sha256s.key?(sha256)
     end
-    
-    def to_s()
+
+    def to_s
       # Put each Word on one line (flow/inline style).
       return Util.dump_yaml(self,flow_level: 8)
     end
   end
-  
+
   ###
-  # @author Jonathan Bradley Whited (@esotericpig)
+  # @author Jonathan Bradley Whited
   # @since  0.2.0
   ###
   class FutsuuNews < News
     DEFAULT_FILENAME = 'nhk_news_web_regular.yml'
     DEFAULT_FILE = build_file(DEFAULT_FILENAME)
-    
+
     def self.load_data(data,**kargs)
       return News.load_data(data,article_class: Article,news_class: FutsuuNews,**kargs)
     end
-    
+
     def self.load_file(file=DEFAULT_FILE,**kargs)
       return News.load_file(file,article_class: Article,news_class: FutsuuNews,**kargs)
     end
-    
+
     def save_file(file=DEFAULT_FILE,**kargs)
       super(file,**kargs)
     end
   end
-  
+
   ###
-  # @author Jonathan Bradley Whited (@esotericpig)
+  # @author Jonathan Bradley Whited
   # @since  0.2.0
   ###
   class YasashiiNews < News
     DEFAULT_FILENAME = 'nhk_news_web_easy.yml'
     DEFAULT_FILE = build_file(DEFAULT_FILENAME)
-    
+
     def self.load_data(data,**kargs)
       return News.load_data(data,article_class: Article,news_class: YasashiiNews,**kargs)
     end
-    
+
     def self.load_file(file=DEFAULT_FILE,**kargs)
       return News.load_file(file,article_class: Article,news_class: YasashiiNews,**kargs)
     end
-    
+
     def save_file(file=DEFAULT_FILE,**kargs)
       super(file,**kargs)
     end

data/lib/nhkore/polisher.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
 #++
 
 
@@ -26,28 +14,28 @@ require 'nhkore/word'
 
 module NHKore
   ###
-  # @author Jonathan Bradley Whited (@esotericpig)
+  # @author Jonathan Bradley Whited
   # @since  0.2.0
   ###
   class Polisher
     def begin_polish(str)
       return str
     end
-    
+
     def polish(str)
       str = begin_polish(str)
       str = end_polish(str)
-      
+
       return str
     end
-    
+
     def self.polish_any(obj,polishers)
-      return nil if obj.nil?()
-      
+      return nil if obj.nil?
+
       polishers = Array(polishers)
-      
-      return obj if polishers.empty?()
-      
+
+      return obj if polishers.empty?
+
       if obj.is_a?(Word)
         obj = Word.new(
           kana: polish_any(obj.kana,polishers),
@@ -55,17 +43,17 @@ module NHKore
           word: obj
         )
       else # String
-        polishers.each() do |polisher|
+        polishers.each do |polisher|
           obj = polisher.polish(obj)
         end
       end
-      
+
       return obj
     end
   end
-  
+
   ###
-  # @author Jonathan Bradley Whited (@esotericpig)
+  # @author Jonathan Bradley Whited
   # @since  0.2.0
   ###
   class BasicPolisher < Polisher
@@ -74,18 +62,18 @@ module NHKore
       # - Yunibaasaru・Sutajio・Japan
       # Keep numbers next to kanji/kana, else the below kana won't make sense:
       # - Word { kanji: ２０日, kana: はつか }
-      
+
       str = str.gsub(/[^[[:alnum:]]・]/,'')
-      
+
       # Numbers/dots by themselves (without kanji/kana) should be ignored (empty).
-      str = '' if str.gsub(/[[[:digit:]]・]+/,'').empty?()
-      
+      str = '' if str.gsub(/[[[:digit:]]・]+/,'').empty?
+
       return str
     end
   end
-  
+
   ###
-  # @author Jonathan Bradley Whited (@esotericpig)
+  # @author Jonathan Bradley Whited
   # @since  0.2.0
   ###
   class BestPolisher < BasicPolisher