wwwjdic 13.0.1 → 16.1.0

data/lib/wwwjdic/utils/downloader.rb

@@ -1,6 +1,10 @@
+# frozen_string_literal: true
+
 #--
 # 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.
 #
@@ -16,26 +20,32 @@
 #
 # 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
   module Utils
-
-    # This module is a simple wrapper container for Peter R. Marreck's
-    # gist.
+    # This module is a simple wrapper container for Jon Maken gist.
     #
-    # Author:: {Jon Maken}[mailto:jon.forums@gmail.com]
-    # License:: 3-clause BSD
-    # Revision:: 2012-03-25 23:01:19 -0600
+    # Author:: {Marco Bresciani}[mailto:marcobresciani_1974@libero.it]
+    # rubocop:disable Style/AsciiComments
+    # Copyright:: © 2014-2021 Marco Bresciani
+    # rubocop:enable Style/AsciiComments
+    # License:: GNU General Public License version 3
     module Downloader
-
       require 'net/http'
       require 'net/ftp'
       require 'openssl'
       require 'fileutils'
       require 'tempfile'
 
-      #!/usr/bin/env ruby
+      # rubocop:disable Style/AsciiComments
+      # Copyright:: © 2012 Jon Maken
+      # rubocop:enable Style/AsciiComments
+      # see https://gist.github.com/jonforums/2202048
       #
       # An HTTP/HTTPS/FTP file downloader library/CLI based upon
       # MiniPortile's HTTP implementation.
@@ -44,46 +54,41 @@ module WWWJDic
       # License:: 3-clause BSD
       # Revision:: 2012-03-25 23:01:19 -0600
       class Downloader
-
         VERSION = '0.1.0'
 
         class << self
           attr_accessor :logger, :max_ca_verify_depth, :ftp_data_chunk_size
         end
 
-        @logger = STDOUT.binmode
+        @logger = $stdout.binmode
         @max_ca_verify_depth = 5
         @ftp_data_chunk_size = 8192
 
-
         def self.download_file(url, full_path, count = 3)
-          raise RuntimeError, I18n.t('error.nil') if url.nil?
-          # return if File.exist?(full_path)
+          raise I18n.t('error.nil') if url.nil?
 
           http_download(url, full_path, count)
         end
 
-        private
-
-        def self.message(text)
+        private_class_method def self.message(text)
           @logger.print text
           @logger.flush
         end
 
-        def self.output(text = '')
+        private_class_method def self.output(text = '')
           @logger.puts text
           @logger.flush
         end
 
-        def self.http_download(url, full_path, count)
+        private_class_method def self.http_download(url, full_path, count)
           uri = URI.parse(url)
 
           begin
             filename = File.basename(uri.path)
 
             if ENV['HTTP_PROXY']
-              #protocol,
-              userinfo, proxy_host, proxy_port = URI::split(ENV['HTTP_PROXY'])
+              # protocol,
+              userinfo, proxy_host, proxy_port = URI.split(ENV['HTTP_PROXY'])
               proxy_user, proxy_pass = userinfo.split(/:/) if userinfo
               http = Net::HTTP.new(uri.host, uri.port, proxy_host, proxy_port, proxy_user, proxy_pass)
             else
@@ -101,7 +106,8 @@ module WWWJDic
                 return false
 
               when Net::HTTPRedirection
-                raise 'Too many redirections for the original URL, halting.' if count <= 0
+                raise 'Too many redirections, halting.' if count <= 0
+
                 url = response['location']
                 return http_download(url, full_path, count - 1)
 
@@ -111,25 +117,22 @@ module WWWJDic
                 temp_file << response.body
                 temp_file.close
 
-                if full_path.nil?
-                  return response.body
-                else
-                  File.unlink full_path if File.exist?(full_path)
-                  FileUtils.mkdir_p File.dirname(full_path)
-                  FileUtils.mv temp_file.path, full_path, :force => true
-                end
+                return response.body if full_path.nil?
+
+                File.unlink full_path if File.exist?(full_path)
+                FileUtils.mkdir_p File.dirname(full_path)
+                FileUtils.mv temp_file.path, full_path, force: true
               else
                 puts response
               end
             end
-
-          rescue Exception => e
-            File.unlink full_path if File.exist?(full_path) unless full_path.nil?
+          rescue StandardError => e
+            File.unlink full_path if !full_path.nil? && File.exist?(full_path)
             output "ERROR: #{e.message}"
-            raise 'Failed to download file'
+            raise "Failed to download file: #{e.message}"
           end
         end
-      end # Downloader
+      end
     end
   end
 end

data/lib/wwwjdic/utils/raisers.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,51 +18,46 @@
 #
 # 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'
 
 module WWWJDic
-
   # This module is a simple collection of useful things and methods that
   # I prefer to keep as DRYer as possible. Just include it and use the
   # methods...
   #
   # 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 Utils
-
     # This module contains some utility method to raise errors according
     # to (possibly) common conditions.
     #
     # 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 Raisers
-
       # Raises an +ArgumentError+ according to parameters, unless the
       # +array+ contains the exact +value+.
       def raiser_array(name = 'error.value', value = nil, array = nil)
-        unless value.nil?
-          raise ArgumentError, I18n.t(name, value: value) unless array.include? value
-        end
+        raise ArgumentError, I18n.t(name, value: value) if !value.nil? && !(array.include? value)
       end
 
       # Raises an +ArgumentError+ according to parameters, unless the
       # +array+ contains a downcased +value+.
       def raiser_downcase(name = 'error.value', value = nil, array = nil)
-        unless value.nil?
-          raise ArgumentError, I18n.t(name, value: value) unless array.include? value.downcase
-        end
+        raise ArgumentError, I18n.t(name, value: value) if !value.nil? && !(array.include? value.downcase)
       end
 
       # Raises an +ArgumentError+ according to parameters, unless the
       # +array+ contains the number of the +value+.
       def raiser_to_i(name = 'error.value', value = nil, array = nil)
-        unless value.nil?
-          raise ArgumentError, I18n.t(name, value: value) unless array.include? value.to_i
-        end
+        raise ArgumentError, I18n.t(name, value: value) if !value.nil? && !(array.include? value.to_i)
       end
     end
   end

data/lib/wwwjdic/utils/splitter.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'
@@ -26,8 +32,9 @@ require_relative '../constants'
 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 Splitter
     # Creates a +Splitter+ object.
@@ -39,20 +46,21 @@ module WWWJDic
     end
 
     def title
-      $1 if /<TITLE>(.*)<\/TITLE>/.match @translation
+      Regexp.last_match(1) if %r{<TITLE>(.*)</TITLE>}.match @translation
     end
 
     def translation
-      $1.strip if /<pre>(.*)<\/pre>/m.match @translation
+      Regexp.last_match(1).strip if %r{<pre>(.*)</pre>}m.match @translation
     end
 
     def message
-      return $1.strip if /<p>(.*)<p>/m.match @translation unless @translation.nil?
-      $1 if /<p>(.*)<pre>/m.match @translation if @translation.nil?
+      return Regexp.last_match(1).strip unless @translation.nil? || !/<p>(.*)<p>/m.match(@translation)
+
+      Regexp.last_match(1) if @translation.nil? && /<p>(.*)<pre>/m.match(@translation)
     end
 
     def lines
-      result = Array.new
+      result = []
       translation.each_line do |a_line|
         stripped_line = a_line.strip
         result.push stripped_line unless stripped_line.empty?
@@ -60,19 +68,12 @@ module WWWJDic
       result unless result.empty?
     end
 
+    # @return [Array] the arrays of elements containing the answer
     def content
-      result = Array.new
+      result = []
       lines.each do |a_line|
-        inner = Hash.new
-        if /(.*)\[/m.match a_line
-          inner[:word] = $1.strip
-          inner[:kana] = $1.strip if /\[(.*)\]/m.match a_line
-          inner[:text] = $1.strip if /\] \/(.*)\//m.match a_line
-        else
-          inner[:kana] = $1.strip if /^(.*)(\s)\//m.match a_line
-          inner[:word] = inner[:kana]
-          inner[:text] = $1.strip if /\/(.*)\//m.match a_line
-        end
+        inner = {}
+        fill_inner_data(a_line, inner)
         inner[:meanings] = inner[:text].split('/') if inner[:text].include? '/'
         result.push inner unless inner.empty?
       end
@@ -80,5 +81,18 @@ module WWWJDic
       result unless result.empty?
     end
 
+    private
+
+    def fill_inner_data(a_line, inner)
+      if /(.*)\[/m.match a_line
+        inner[:word] = Regexp.last_match(1).strip
+        inner[:kana] = Regexp.last_match(1).strip if /\[(.*)\]/m.match a_line
+        inner[:text] = Regexp.last_match(1).strip if %r{\] /(.*)/}m.match a_line
+      else
+        inner[:kana] = Regexp.last_match(1).strip if %r{^(.*)(\s)/}m.match a_line
+        inner[:word] = inner[:kana]
+        inner[:text] = Regexp.last_match(1).strip if %r{/(.*)/}m.match a_line
+      end
+    end
   end
 end

data/lib/wwwjdic/version.rb

@@ -1,20 +1,34 @@
+# frozen_string_literal: true
+
 #--
 # wwwjdic
-# Copyright © 2014, 2015, 2016  Marco Bresciani
+# © 2014-2021 Marco Bresciani
 #
 # This file is part of wwwjdic.
 #
-# wwwjdic is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License
-# as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
+# wwwjdic is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by the
+# Free Software Foundation, either version 3 of the License, or (at your
+# option) any later version.
+#
+# wwwjdic 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 General Public License
+# for more details.
 #
-# wwwjdic 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 General Public License for more details.
+# You should have received a copy of the GNU General Public License
+# along with wwwjdic. If not, see <http://www.gnu.org/licenses/>.
 #
-# 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
+
   # Current version number for WWWJDic gem.
-  VERSION = '13.0.1'
+  VERSION = '16.1.0'
 end

data/test/test_helper.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,8 +18,15 @@
 #
 # 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 'simplecov'
+SimpleCov.start
+
 require 'i18n'
 require 'json'
 require 'minitest/autorun'

data/test/test_wwwjdic.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,17 +18,21 @@
 #
 # 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_relative 'test_helper'
 
 describe WWWJDic::WWWJDic do
   describe 'when created' do
-    subject {WWWJDic::breener}
+    subject { WWWJDic.breener }
 
     it 'must create a wwwjdic object' do
-      subject.wont_be_nil
-      subject.must_be_instance_of WWWJDic::WWWJDic
+      _(subject).wont_be_nil
+      _(subject).must_be_instance_of WWWJDic::WWWJDic
     end
   end
 end

data/test/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:
   test: