nhkore 0.3.4 → 0.3.9

data/lib/nhkore/dict.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,53 +15,53 @@ require 'nhkore/error'
 
 module NHKore
   ###
-  # @author Jonathan Bradley Whited (@esotericpig)
+  # @author Jonathan Bradley Whited
   # @since  0.2.0
   ###
   class Dict
     attr_reader :entries
-    
-    def initialize()
+
+    def initialize
       super()
-      
+
       @entries = {}
     end
-    
+
     def [](id)
       return @entries[id]
     end
-    
+
     def []=(id,entry)
-      return @entries[id] = entry
+      @entries[id] = entry
     end
-    
+
     def self.scrape(hash,missingno: nil,url: nil)
-      dict = Dict.new()
-      
-      hash.each() do |id,array|
+      dict = Dict.new
+
+      hash.each do |id,array|
         entry = Entry.scrape(id,array,missingno: missingno,url: url)
-        
-        next if entry.nil?()
+
+        next if entry.nil?
         raise ScrapeError,"duplicate ID[#{id}] at URL[#{url}] in hash[#{hash}]" if dict.key?(id)
-        
+
         dict[id] = entry
       end
-      
+
       return dict
     end
-    
+
     def key?(id)
       return @entries.key?(id)
     end
-    
-    def to_s()
-      s = ''.dup()
-      
-      @entries.each() do |id,entry|
+
+    def to_s
+      s = ''.dup
+
+      @entries.each do |id,entry|
         s << "#{id}:\n"
-        s << "  #{entry.to_s().gsub("\n","\n  ").rstrip()}\n"
+        s << "  #{entry.to_s.gsub("\n","\n  ").rstrip}\n"
       end
-      
+
       return s
     end
   end

data/lib/nhkore/dict_scraper.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,48 +17,51 @@ require 'nhkore/util'
 
 module NHKore
   ###
-  # @author Jonathan Bradley Whited (@esotericpig)
+  # @author Jonathan Bradley Whited
   # @since  0.2.0
   ###
   class DictScraper < Scraper
     attr_accessor :missingno
-    
+
     def initialize(url,missingno: nil,parse_url: true,**kargs)
       url = self.class.parse_url(url) if parse_url
-      
+
       super(url,**kargs)
-      
+
       @missingno = missingno
     end
-    
+
     def self.parse_url(url,basename: nil)
-      url = Util.strip_web_str(url)
-      
-      raise ParseError,"cannot parse dictionary URL from URL[#{url}]" if url.empty?()
-      
+      url = Util.strip_web_str(url.to_s)
+
+      raise ParseError,"cannot parse dictionary URL from URL[#{url}]" if url.empty?
+
       i = url.rindex(%r{[/\\]}) # Can be a URL or a file
-      i = i.nil?() ? 0 : (i + 1) # If no match found, no path
-      
-      basename = File.basename(url[i..-1],'.*') if basename.nil?()
+      i = i.nil? ? 0 : (i + 1) # If no match found, no path
+
+      basename = File.basename(url[i..-1],'.*') if basename.nil?
       path = url[0...i]
-      
+
       return "#{path}#{basename}.out.dic"
     end
-    
-    def scrape()
+
+    def scrape
       require 'json'
-      
-      json = JSON.load(@str_or_io)
-      
-      return Dict.new() if json.nil?()
-      
+
+      str = read # Make sure it has all been read.
+      str = str.string if str.respond_to?(:string) # For StringIO.
+
+      json = JSON.parse(str)
+
+      return Dict.new if json.nil?
+
       hash = json['reikai']
-      
-      return Dict.new() if hash.nil?()
-      
+
+      return Dict.new if hash.nil?
+
       hash = hash['entries']
-      
-      return Dict.new() if hash.nil?()
+
+      return Dict.new if hash.nil?
       return Dict.scrape(hash,missingno: @missingno,url: @url)
     end
   end

data/lib/nhkore/entry.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,77 +15,77 @@ require 'nhkore/util'
 
 module NHKore
   ###
-  # @author Jonathan Bradley Whited (@esotericpig)
+  # @author Jonathan Bradley Whited
   # @since  0.2.0
   ###
   class Entry
     HYOUKI_SEP = '・'
-    
+
     attr_reader :defns
     attr_accessor :id
-    
-    def initialize()
+
+    def initialize
       super()
-      
+
       @defns = []
       @id = nil
     end
-    
-    def build_defn()
+
+    def build_defn
       defns = []
       i = 0
-      
-      @defns.each() do |defn|
+
+      @defns.each do |defn|
         defns << "#{i += 1}）#{defn}" # Japanese parenthesis
       end
-      
+
       return defns.join("\n")
     end
-    
-    def build_hyouki()
+
+    def build_hyouki
       # Since Ruby v1.9, Hash preserves order.
       # Ruby v2.7 doc for Set still says no guarantee of order, so don't use.
       hyoukis = {}
-      
-      @defns.each() do |defn|
-        defn.hyoukis.each() do |hyouki|
+
+      @defns.each do |defn|
+        defn.hyoukis.each do |hyouki|
           hyouki = hyouki.chomp(HYOUKI_SEP)
-          
-          next if hyouki.empty?()
-          
+
+          next if hyouki.empty?
+
           hyoukis[hyouki] = true
         end
       end
-      
+
       return hyoukis.keys.join(HYOUKI_SEP)
     end
-    
+
     def self.scrape(id,array,missingno: nil,url: nil)
-      entry = Entry.new()
-      
-      entry.id = Util.unspace_web_str(id.to_s()).downcase()
-      
-      return nil if entry.id.empty?()
-      
-      array.each() do |hash|
+      entry = Entry.new
+
+      entry.id = Util.unspace_web_str(id.to_s).downcase
+
+      return nil if entry.id.empty?
+
+      array.each do |hash|
         defn = Defn.scrape(hash,missingno: missingno,url: url)
-        entry.defns << defn unless defn.nil?()
+        entry.defns << defn unless defn.nil?
       end
-      
-      return nil if entry.defns.empty?()
+
+      return nil if entry.defns.empty?
       return entry
     end
-    
-    def to_s()
-      s = ''.dup()
-      
-      return s if @defns.empty?()
-      
-      hyouki = build_hyouki()
-      
+
+    def to_s
+      s = ''.dup
+
+      return s if @defns.empty?
+
+      hyouki = build_hyouki
+
       s << "#{hyouki}\n" unless Util.empty_web_str?(hyouki)
-      s << build_defn()
-      
+      s << build_defn
+
       return s
     end
   end

data/lib/nhkore/error.rb

@@ -1,35 +1,30 @@
-#!/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
   ###
-  # @author Jonathan Bradley Whited (@esotericpig)
+  # @author Jonathan Bradley Whited
   # @since  0.2.0
   ###
   class Error < ::StandardError; end
-  
-  class CLIError < Error; end # @since 0.2.0
-  class ParseError < Error; end # @since 0.2.0
-  class ScrapeError < Error; end # @since 0.2.0
-  class ZipError < Error; end # @since 0.2.0
+
+  # @since 0.2.0
+  class CLIError < Error; end
+
+  # @since 0.2.0
+  class ParseError < Error; end
+
+  # @since 0.2.0
+  class ScrapeError < Error; end
+
+  # @since 0.2.0
+  class ZipError < Error; end
 end

data/lib/nhkore/fileable.rb

@@ -1,46 +1,35 @@
-#!/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
   ###
-  # @author Jonathan Bradley Whited (@esotericpig)
+  # @author Jonathan Bradley Whited
   # @since  0.2.0
   ###
   module Fileable
     def self.included(mod)
       mod.extend ClassMethods
     end
-    
+
     def save_file(file,mode: 'wt',**kargs)
-      File.open(file,mode: mode,**kargs) do |file|
-        file.write(to_s())
+      File.open(file,mode: mode,**kargs) do |f|
+        f.write(to_s)
       end
     end
-    
+
+    # Auto-extended when Fileable is included.
     module ClassMethods
       def load_file(file,mode: 'rt:BOM|UTF-8',**kargs)
         data = File.read(file,mode: mode,**kargs)
-        
+
         return load_data(data,file: file,**kargs)
       end
     end