wwwjdic 13.0.1 → 16.1.0

data/lib/wwwjdic.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
+#--
 # wwwjdic
-# Copyright © 2014, 2015, 2016, 2017, 2018, 2019  Marco Bresciani
+# © 2014-2021 Marco Bresciani
 #
 # This file is part of wwwjdic.
 #
@@ -15,10 +18,11 @@
 #
 # You should have received a copy of the GNU General Public License
 # along with wwwjdic. If not, see <http://www.gnu.org/licenses/>.
-
-require 'digest/md5'
-require 'i18n'
-require 'uri'
+#
+# SPDX-FileCopyrightText: 2014-2021 Marco Bresciani
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+#++
 
 require_relative 'wwwjdic/application'
 require_relative 'wwwjdic/parser'
@@ -29,10 +33,9 @@ require_relative 'wwwjdic/parsers/search'
 require_relative 'wwwjdic/parsers/server'
 
 # Author:: {Marco Bresciani}[mailto:marcobresciani_1974@libero.it]
-# Copyright:: Copyright © 2014, 2015, 2016, 2017, 2018, 2019  Marco Bresciani
+# Copyright:: © 2014-2021 Marco Bresciani
 # License:: GNU General Public License version 3
 module WWWJDic
-
   # Creates a new WWWJDic object (from the verb 'to Breen'... :) ).
   #
   # Usage::
@@ -42,15 +45,11 @@ module WWWJDic
     WWWJDic.new(parser)
   end
 
-# ------------------------------ here starts the list of private methods
-
-  private
-
-# Provides the parameters' parsers object.
+  # Provides the parameters' parsers object.
   def self.parser
-    parsers = {dict: Parsers::Dict.new, display: Parsers::Display.new,
-               key: Parsers::Key.new, search: Parsers::Search.new,
-               server: Parsers::Server.new}
+    parsers = { dict: Parsers::Dict.new, display: Parsers::Display.new,
+                key: Parsers::Key.new, search: Parsers::Search.new,
+                server: Parsers::Server.new }
 
     Parser.new parsers
   end

data/lib/wwwjdic/application.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 #--
 # wwwjdic
-# Copyright © 2014, 2015, 2016, 2017, 2018, 2019  Marco Bresciani
+# © 2014-2021 Marco Bresciani
 #
 # This file is part of wwwjdic.
 #
@@ -16,6 +18,10 @@
 #
 # You should have received a copy of the GNU General Public License
 # along with wwwjdic. If not, see <http://www.gnu.org/licenses/>.
+#
+# SPDX-FileCopyrightText: 2014-2021 Marco Bresciani
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
 #++
 
 require 'i18n'
@@ -28,11 +34,11 @@ require_relative 'utils/splitter'
 module WWWJDic
   # This class is a simple API to interact with WWWJDic Backboor
   # Entry/API.
+  #
   # Author:: {Marco Bresciani}[mailto:marcobresciani_1974@libero.it]
-  # Copyright:: Copyright © 2014, 2015, 2016, 2017, 2018, 2019  Marco Bresciani
+  # Copyright:: © 2014-2021 Marco Bresciani
   # License:: GNU General Public License version 3
   class WWWJDic
-
     # Creates a +WWWJDic+ object. This constructor should be used
     # through the WWWJDic::breener method only.
     #
@@ -53,20 +59,15 @@ module WWWJDic
     def uri(word = nil, args = {})
       raise ArgumentError, I18n.t('error.nil') if word.nil?
       raise ArgumentError, I18n.t('error.param', value: word) if word.empty?
-      raise ArgumentError, I18n.t('error.param', value: args) unless args.keys.to_set.proper_subset? Set.new(ALLOWED_PARAMS)
 
-      params = Hash.new
-      params[:search] = word
-      @defaults[:search] = word
-
-      unless args.nil?
-        ALL_PARAMS.each do |param_name|
-          params[param_name] = @parser.parse(param_name.to_s, args.fetch(param_name, @defaults[param_name]))
-        end
+      unless args.keys.to_set.proper_subset? Set.new(ALLOWED_PARAMS)
+        raise ArgumentError,
+              I18n.t('error.param', value: args)
       end
 
-      a_wwwjdic = URIS[params[:server]] + params[:dict] + DISPLAY[params[:display]] + params[:search] + KEYS[params[:key]]
-      a_wwwjdic + CGI::escape(word).to_s
+      params = parse_params(args, word)
+
+      build_uri(params, word)
     end
 
     # Create the reference uri for a +word+ translation, according to
@@ -74,7 +75,7 @@ module WWWJDic
     #
     # Usage:: <tt>new_wwwjdic.raw_uri word
     def raw_uri(word = nil, args = {})
-      args = Hash.new if args.nil?
+      args = {} if args.nil?
       args[:display] = :raw
       uri(word, args)
     end
@@ -86,7 +87,7 @@ module WWWJDic
     def json_uri(word = nil, args = {})
       an_uri = uri(word, args)
 
-      result = Hash.new
+      result = {}
       result[word] = an_uri
 
       result.to_json
@@ -106,34 +107,24 @@ module WWWJDic
     end
 
     # Save a file, with specified +filename+, that contains the current
-    # wwwjdic configuration, in JSON format. Uses the internal state to
-    # retrieve data from the URI. Defaults to 'wwwjdic' with no specific
-    # extension.
+    # wwwjdic configuration, in JSON format.
+    # Uses the internal state to retrieve data from the URI.
+    # Defaults to 'wwwjdic' with no specific extension.
     #
     # Usage::
     #   - <tt>a_string = new_wwwjdic.json_translate filename</tt>
-    # Params::
-    #   - +filename+: [String] is the filename to be saved.
+    # @param word [String] the word to translate
+    # @param args [Hash] the customization arguments
+    # @param filename [String] the name of the file where to save JSON
+    # @return [Object]
     def json_translate(word = nil, args = {}, filename = nil)
       translation = translate(word, args)
 
-      a_hash = Hash.new
-      a_hash[word.to_sym] = raw_uri(word, args)
-
-      the_splitter = Splitter.new translation
-
-      a_hash[:title] = the_splitter.title
-      a_hash[:translation] = the_splitter.translation
-      a_hash[:message] = the_splitter.message
-
-      unless a_hash[:translation].nil?
-        a_hash[:lines] = the_splitter.lines
-        a_hash[:content] = the_splitter.content
-      end
+      a_hash = build_hash(args, translation, word)
 
       result = a_hash.to_json
 
-      File.open(filename, 'w+') {|f| f << JSON.pretty_generate(a_hash)} unless filename.nil?
+      File.open(filename, 'w+') { |f| f << JSON.pretty_generate(a_hash) } unless filename.nil?
 
       result
     end
@@ -180,7 +171,7 @@ module WWWJDic
     # Restores the original status cleaning up the (possibly) previously
     # saved URIs restoring the default +to_s+.
     def reset
-      @defaults = Hash.new
+      @defaults = {}
       @defaults[:dict] = '1'
       @defaults[:display] = :regular
 
@@ -201,7 +192,9 @@ module WWWJDic
       # romaji conversion if the key is not in Japanese coding (UTF-8,
       # EUC or Shift_JIS.) If you want to look up using "sensei" it has
       # to be a J. For anything else the value of J doesn't matter much.
+      # rubocop:disable Style/AsciiComments
       # 1MUJ齧歯 and 1MUE齧歯 will both find 齧歯. 1MUJgesshi does too,
+      # rubocop:enable Style/AsciiComments
       # but 1MUEgesshi won't.
       #
       # I think you have missed a key point I made in my previous email:
@@ -229,5 +222,44 @@ module WWWJDic
     def to_s
       @wwwjdic.to_s
     end
+
+    private
+
+    def build_hash(args, translation, word)
+      the_splitter = Splitter.new translation
+
+      a_hash = { word.to_sym => raw_uri(word, args),
+                 title: the_splitter.title,
+                 translation: the_splitter.translation,
+                 message: the_splitter.message }
+
+      unless a_hash[:translation].nil?
+        a_hash[:lines] = the_splitter.lines
+        a_hash[:content] = the_splitter.content
+      end
+      a_hash
+    end
+
+    def build_uri(params, word)
+      a_wwwjdic = URIS[params[:server]] +
+                  params[:dict] +
+                  DISPLAY[params[:display]] +
+                  params[:search] +
+                  KEYS[params[:key]]
+      a_wwwjdic + CGI.escape(word).to_s
+    end
+
+    def parse_params(args, word)
+      params = {}
+      params[:search] = word
+      @defaults[:search] = word
+
+      unless args.nil?
+        ALL_PARAMS.each do |param_name|
+          params[param_name] = @parser.parse(param_name.to_s, args.fetch(param_name, @defaults[param_name]))
+        end
+      end
+      params
+    end
   end
 end

data/lib/wwwjdic/constants.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 #--
 # wwwjdic
-# Copyright © 2014, 2015, 2016, 2017, 2018, 2019  Marco Bresciani
+# © 2014-2021 Marco Bresciani
 #
 # This file is part of wwwjdic.
 #
@@ -16,32 +18,66 @@
 #
 # You should have received a copy of the GNU General Public License
 # along with wwwjdic. If not, see <http://www.gnu.org/licenses/>.
+#
+# SPDX-FileCopyrightText: 2014-2021 Marco Bresciani
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
 #++
 
 module WWWJDic
+  # Author:: {Marco Bresciani}[mailto:marcobresciani_1974@libero.it]
+  # Copyright:: © 2014-2021 Marco Bresciani
+  # License:: GNU General Public License version 3
+
   # Allowed parameters for configuration
-  ALLOWED_PARAMS = [:dict, :display, :key, :server].freeze
+  ALLOWED_PARAMS = %i[dict display key server].freeze
 
   # All parameters for configuration
   ALL_PARAMS = ALLOWED_PARAMS + [:search]
 
   # Numeric codes for language-specific dictionaries
-  AVAIL_LANGS = {en: '1', de: 'G', fr: 'H', ru: 'I', sv: 'J', hu: 'K', es: 'L', nl: 'M', sl: 'N', it: 'O'}.freeze
+  AVAIL_LANGS = { en: '1', de: 'G', fr: 'H', ru: 'I', sv: 'J', hu: 'K', es: 'L', nl: 'M', sl: 'N', it: 'O' }.freeze
 
   # Numeric codes for dictionaries usage
   DICTIONARY_CODES = [('1'..'9').to_a, ('A'..'R').to_a].flatten
 
   # Naming for all supported dictionaries
-  DICTIONARY_NAMES = ['Jpn-Eng General (EDICT)', 'Japanese Names (ENAMDICT)', 'Computing/Telecomms', 'Life Sciences/Bio-Med', 'Legal Terms', 'Finance/Marketing', 'Buddhism', 'Miscellaneous', 'Special Text-glossing', 'Engineering/Science', 'Linguistics', 'River & Water Systems', 'Automobile Industry', 'Japanese Wordnet', 'Work-in-progress File', 'Japanese-German (WaDoku)', 'Japanese-French', 'Japanese-Russian', 'Japanese-Swedish', 'Japanese-Hungarian', 'Japanese-Spanish', 'Japanese-Dutch', 'Japanese-Slovenian', 'Japanese-Italian', 'Untranslated', 'Combined Jpn-Eng', 'Expanded Text-glossing'].freeze
+  DICTIONARY_NAMES = ['Jpn-Eng General (EDICT)',
+                      'Japanese Names (ENAMDICT)',
+                      'Computing/Telecomms',
+                      'Life Sciences/Bio-Med',
+                      'Legal Terms',
+                      'Finance/Marketing',
+                      'Buddhism',
+                      'Miscellaneous',
+                      'Special Text-glossing',
+                      'Engineering/Science',
+                      'Linguistics',
+                      'River & Water Systems',
+                      'Automobile Industry',
+                      'Japanese Wordnet',
+                      'Work-in-progress File',
+                      'Japanese-German (WaDoku)',
+                      'Japanese-French',
+                      'Japanese-Russian',
+                      'Japanese-Swedish',
+                      'Japanese-Hungarian',
+                      'Japanese-Spanish',
+                      'Japanese-Dutch',
+                      'Japanese-Slovenian',
+                      'Japanese-Italian',
+                      'Untranslated',
+                      'Combined Jpn-Eng',
+                      'Expanded Text-glossing'].freeze
 
   # Mapping between dictionaries names with codes
-  DICTS_BY_CODES = Hash[DICTIONARY_CODES.zip(DICTIONARY_NAMES)]
+  DICTS_BY_CODES = DICTIONARY_CODES.zip(DICTIONARY_NAMES).to_h
 
   # Mapping between dictionaries codes with names
-  DICTS_BY_NAMES = Hash[DICTIONARY_NAMES.zip(DICTIONARY_CODES)]
+  DICTS_BY_NAMES = DICTIONARY_NAMES.zip(DICTIONARY_CODES).to_h
 
   # Display modes
-  DISPLAY = {regular: 'M', raw: 'Z'}.freeze
+  DISPLAY = { regular: 'M', raw: 'Z' }.freeze
 
   # k is the key type:
   #
@@ -72,7 +108,10 @@ module WWWJDic
   # for EUC, ISO-2022-JP or UCS, S for Shift_JIS and U for UTF-8,
   # followed by the search string. Up to 99 example sentences may be
   # displayed.
-  KEYS = {english: 'E', common: 'P', exact: 'Q', both: 'R', japanese: 'J', start_kanji: 'K', any_kanji: 'L', kanji: 'M', glossing: 'G', no_repeated: 'H', jis_kanji: 'H', multi_radical: 'X'}.freeze
+  KEYS = { english: 'E', common: 'P', exact: 'Q', both: 'R',
+           japanese: 'J', start_kanji: 'K', any_kanji: 'L', kanji: 'M',
+           glossing: 'G', no_repeated: 'H', jis_kanji: 'H',
+           multi_radical: 'X' }.freeze
 
   # KANJIDIC letter codes (see
   # http://www.edrdg.org/kanjidic/kanjidic.html)
@@ -100,14 +139,19 @@ module WWWJDic
   # [E] the index in Henshall (A Guide To Remembering Japanese
   # Characters);
   # [Y] the PinYin (Chinese) pronunciation(s) of the kanji;
-  KANJIDIC_CODES = {unicode: 'U', nelson: 'N', radical: 'B', classical: 'C', stroke: 'S', grade: 'G', halpern: 'H', frequency: 'F', skip: 'P', gakken: 'K', heisig: 'L', spahn: 'I', corner: 'Q', morohashi_index: 'MN', morohashi_page: 'MP', henshall: 'E', pinyin: 'Y'}.freeze
+  KANJIDIC_CODES = { unicode: 'U', nelson: 'N', radical: 'B',
+                     classical: 'C', stroke: 'S', grade: 'G',
+                     halpern: 'H', frequency: 'F', skip: 'P',
+                     gakken: 'K', heisig: 'L', spahn: 'I', corner: 'Q',
+                     morohashi_index: 'MN', morohashi_page: 'MP',
+                     henshall: 'E', pinyin: 'Y' }.freeze
 
   # Reference URI for Backdoor Entry/API
-  URI_DEFAULT = 'http://www.edrdg.org/cgi-bin/wwwjdic/wwwjdic.cgi?'.freeze
+  URI_DEFAULT = 'http://www.edrdg.org/cgi-bin/wwwjdic/wwwjdic.cgi?'
 
   # Monash URI for Backdoor Entry/API
-  URI_OLD = 'http://www.csse.monash.edu.au/~jwb/cgi-bin/wwwjdic.cgi?'.freeze
+  URI_OLD = 'http://nihongo.monash.edu/cgi-bin/wwwjdic?'
 
   # URIs for Backdoor Entry/API
-  URIS = {edrdg: URI_DEFAULT, monash: URI_OLD}.freeze
+  URIS = { edrdg: URI_DEFAULT, monash: URI_OLD }.freeze
 end

data/lib/wwwjdic/locales/de.yml

@@ -1,5 +1,8 @@
+#--
 # wwwjdic
-# Copyright © 2014, 2015, 2016, 2017, 2018, 2019  Marco Bresciani
+# rubocop:disable Style/AsciiComments
+# © 2014-2021 Marco Bresciani
+# rubocop:enable Style/AsciiComments
 #
 # This file is part of wwwjdic.
 #
@@ -15,6 +18,11 @@
 #
 # You should have received a copy of the GNU General Public License
 # along with wwwjdic. If not, see <http://www.gnu.org/licenses/>.
+#
+# SPDX-FileCopyrightText: 2014-2021 Marco Bresciani
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+#++
 
 de:
   error:
@@ -24,6 +32,3 @@ de:
     value: "Der Wert %{value} ist nicht im zulässigen Bereich."
   warn:
     deprecated: Diese Methode ist veraltet.
-  test:
-    kotoba: Sprache
-    test: test data

data/lib/wwwjdic/locales/en.yml

@@ -1,5 +1,8 @@
+#--
 # wwwjdic
-# Copyright © 2014, 2015, 2016, 2017, 2018, 2019  Marco Bresciani
+# rubocop:disable Style/AsciiComments
+# © 2014-2021 Marco Bresciani
+# rubocop:enable Style/AsciiComments
 #
 # This file is part of wwwjdic.
 #
@@ -15,6 +18,11 @@
 #
 # You should have received a copy of the GNU General Public License
 # along with wwwjdic. If not, see <http://www.gnu.org/licenses/>.
+#
+# SPDX-FileCopyrightText: 2014-2021 Marco Bresciani
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+#++
 
 en:
   error:
@@ -24,6 +32,3 @@ en:
     value: "Value %{value} is not in allowed range."
   warn:
     deprecated: This method has been deprecated.
-  test:
-    kotoba: word
-    test: test data

data/lib/wwwjdic/locales/es.yml

@@ -1,5 +1,8 @@
+#--
 # wwwjdic
-# Copyright © 2014, 2015, 2016, 2017, 2018, 2019  Marco Bresciani
+# rubocop:disable Style/AsciiComments
+# © 2014-2021 Marco Bresciani
+# rubocop:enable Style/AsciiComments
 #
 # This file is part of wwwjdic.
 #
@@ -15,6 +18,11 @@
 #
 # You should have received a copy of the GNU General Public License
 # along with wwwjdic. If not, see <http://www.gnu.org/licenses/>.
+#
+# SPDX-FileCopyrightText: 2014-2021 Marco Bresciani
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+#++
 
 es:
   error:
@@ -24,6 +32,3 @@ es:
     value: "Valor %{value} no está dentro del rango permitido."
   warn:
     deprecated: Este método ha quedado obsoleto.
-  test:
-    kotoba: palabra
-    test: test data

data/lib/wwwjdic/locales/fr.yml

@@ -1,5 +1,8 @@
+#--
 # wwwjdic
-# Copyright © 2014, 2015, 2016, 2017, 2018, 2019  Marco Bresciani
+# rubocop:disable Style/AsciiComments
+# © 2014-2021 Marco Bresciani
+# rubocop:enable Style/AsciiComments
 #
 # This file is part of wwwjdic.
 #
@@ -15,6 +18,11 @@
 #
 # You should have received a copy of the GNU General Public License
 # along with wwwjdic. If not, see <http://www.gnu.org/licenses/>.
+#
+# SPDX-FileCopyrightText: 2014-2021 Marco Bresciani
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+#++
 
 fr:
   error:
@@ -24,6 +32,3 @@ fr:
     value: "Valeur %{value} n'est pas dans la plage autorisée."
   warn:
     deprecated: Cette méthode a été déconseillée.
-  test:
-    kotoba: mot
-    test: test data