unclekryon 0.4.10 → 0.4.11

data/lib/unclekryon/iso.rb

@@ -1,28 +1,14 @@
-#!/usr/bin/env ruby
 # encoding: UTF-8
 # frozen_string_literal: true
 
 #--
 # This file is part of UncleKryon-server.
-# Copyright (c) 2018-2019 Jonathan Bradley Whited (@esotericpig)
-# 
-# UncleKryon-server 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.
-# 
-# UncleKryon-server 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 UncleKryon-server.  If not, see <https://www.gnu.org/licenses/>.
+# Copyright (c) 2018-2021 Jonathan Bradley Whited
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
 #++
 
 
-require 'bundler/setup'
-
 require 'yaml'
 
 require 'unclekryon/dev_opts'
@@ -43,7 +29,7 @@ module UncleKryon
   class Iso
     DEFAULT_FILEPATH = "#{BaseIsos::DEFAULT_DIR}/iso.yaml"
     ID = 'ISO'
-    
+
     @@can_provs_terrs = nil
     @@countries = nil
     @@iso = nil
@@ -51,42 +37,43 @@ module UncleKryon
     @@regions = nil
     @@subregions = nil
     @@usa_states = nil
-    
+
     attr_accessor :updated_can_provs_terrs_on
     attr_accessor :updated_countries_on
     attr_accessor :updated_languages_on
     attr_accessor :updated_regions_on
     attr_accessor :updated_subregions_on
     attr_accessor :updated_usa_states_on
-    
-    def initialize()
+
+    def initialize
       super()
-      
-      update_all()
+
+      update_all
     end
-    
-    def self.can_provs_terrs()
+
+    def self.can_provs_terrs
       if !@@can_provs_terrs
-        @@can_provs_terrs = CanProvsTerrs.load_file()
+        @@can_provs_terrs = CanProvsTerrs.load_file
       end
       return @@can_provs_terrs
     end
-    
-    def self.countries()
+
+    def self.countries
       if !@@countries
-        @@countries = Countries.load_file()
+        @@countries = Countries.load_file
       end
       return @@countries
     end
-    
+
     def self.find_kryon_locations(text)
       locs = []
-      
+
       # Fix bad data
-      text = text.gsub(/\A[[:space:]]*SASKATOON\-CALGARY[[:space:]]*\z/,'SASKATOON, SASKATCHEWAN, CANADA / CALGARY, ALBERTA, CANADA')
-      
+      text = text.gsub(/\A[[:space:]]*SASKATOON\-CALGARY[[:space:]]*\z/,
+          'SASKATOON, SASKATCHEWAN, CANADA / CALGARY, ALBERTA, CANADA')
+
       # Multiple countries are separated by '/' or '&'
-      text.split(/[[:space:]]*[\/\&][[:space:]]*/).each() do |t|
+      text.split(%r{[[:space:]]*[/\&][[:space:]]*}).each do |t|
         # Fix misspellings and/or weird shortenings
         t = t.gsub(/Kansas[[:space:]]*\,[[:space:]]*City/i,'Kansas City')
         t = t.gsub(/[\+\*]+/,'') # Means more countries, but won't worry about it (since not listed)
@@ -95,9 +82,12 @@ module UncleKryon
         t = t.gsub(/\A[[:space:]]*NEWPORT[[:space:]]+BEACH[[:space:]]*\z/,'Newport Beach, California')
         t = t.gsub(/\A[[:space:]]*SAN[[:space:]]+RAFAEL[[:space:]]*\z/,'San Rafael, California')
         t = t.gsub(/\A[[:space:]]*MILANO\,[[:space:]]*MARITTIMA[[:space:]]*\z/,'MILANO MARITTIMA, ITALY')
-        t = t.gsub(/\A[[:space:]]*MAR[[:space:]]+DEL[[:space:]]+PLATA[[:space:]]*\z/,'MAR DEL PLATA, ARGENTINA')
-        t = t.gsub(/\A[[:space:]]*PATAGONIA[[:space:]]+CRUISE[[:space:]]+2012[[:space:]]*\z/,'Patagonia, South America')
-        t = t.gsub(/\A[[:space:]]*PHILADELPHIA,[[:space:]]+PENNSYLVANNIA[[:space:]]*\z/,'Philadelphia, Pennsylvania')
+        t = t.gsub(/\A[[:space:]]*MAR[[:space:]]+DEL[[:space:]]+PLATA[[:space:]]*\z/,
+                   'MAR DEL PLATA, ARGENTINA')
+        t = t.gsub(/\A[[:space:]]*PATAGONIA[[:space:]]+CRUISE[[:space:]]+2012[[:space:]]*\z/,
+                   'Patagonia, South America')
+        t = t.gsub(/\A[[:space:]]*PHILADELPHIA,[[:space:]]+PENNSYLVANNIA[[:space:]]*\z/,
+                   'Philadelphia, Pennsylvania')
         t = t.gsub(/\ATHE[[:space:]]+AWAKENING[[:space:]]+ZONE.COM\z/,'World')
         t = t.gsub(/\ASEDONA, AZ - Summer Light Conference\z/,'Sedona, AZ')
         t = t.gsub(/\AHAWAII CRUISE 11\z/,'Hawaii')
@@ -113,72 +103,72 @@ module UncleKryon
         t = t.gsub(/\AHAWAI\'I\s+CRUISE\s+[[:digit:]]+\z/i,'Hawaii')
         t = t.gsub(/\AALASKA\s+CRUISE\s+[[:digit:]]+\z/i,'Alaska')
         t = t.gsub(/\AGLASS\s+HOUSE\s+MT\.\s+\(AU\)\z/i,'Glass House Mountains, Australia')
-        
+
         parts = t.split(/[[:space:]\,\-]+/)
         last = parts.last
-        last2 = (parts.length() >= 2) ? (parts[-2] + last) : nil
-        
+        last2 = (parts.length >= 2) ? (parts[-2] + last) : nil
+
         city = nil
         state = nil
-        country = countries().find_by_name(last) # By name because e.g. code CO is Colorado and Colombia
+        country = countries.find_by_name(last) # By name because e.g. code CO is Colorado and Colombia
         subregion = nil
         region = nil
-        
+
         parse_state = true
-        state_i = parts.length() - 1
-        
+        state_i = parts.length - 1
+
         # USA state?
-        if country.nil?()
+        if country.nil?
           parse_state = false
-          state = usa_states().find(last)
-          
-          if state.nil?() && !last2.nil?()
-            state = usa_states().find_by_name(last2)
-            state_i = parts.length() - 2 unless state.nil?()
+          state = usa_states.find(last)
+
+          if state.nil? && !last2.nil?
+            state = usa_states.find_by_name(last2)
+            state_i = parts.length - 2 unless state.nil?
           end
-          
-          if state.nil?()
+
+          if state.nil?
             # CAN prov/terr? (use state var)
-            state = can_provs_terrs().find(last)
-            
-            if state.nil?() && !last2.nil?()
-              state = can_provs_terrs().find_by_name(last2)
-              state_i = parts.length() - 2 unless state.nil?()
+            state = can_provs_terrs.find(last)
+
+            if state.nil? && !last2.nil?
+              state = can_provs_terrs.find_by_name(last2)
+              state_i = parts.length - 2 unless state.nil?
             end
-            
-            if state.nil?()
+
+            if state.nil?
               # Try country code
-              country = countries().find_by_code(last) # Try by code; e.g., CAN for Canada
-              
-              if country.nil?()
-                country = countries().find_by_name(t)
-                state_i = 0 unless country.nil?()
+              country = countries.find_by_code(last) # Try by code; e.g., CAN for Canada
+
+              if country.nil?
+                country = countries.find_by_name(t)
+                state_i = 0 unless country.nil?
               end
-              if country.nil?() && !last2.nil?()
-                country = countries().find_by_name(last2)
-                state_i = 0 unless country.nil?()
+              if country.nil? && !last2.nil?
+                country = countries.find_by_name(last2)
+                state_i = 0 unless country.nil?
               end
-              
-              if country.nil?()
+
+              if country.nil?
                 # Subregion?
-                subregion = subregions().find_by_name(t)
-                
-                if subregion.nil?() && !last2.nil?()
-                  subregion = subregions().find_by_name(last2)
+                subregion = subregions.find_by_name(t)
+
+                if subregion.nil? && !last2.nil?
+                  subregion = subregions.find_by_name(last2)
                 end
-                
-                if subregion.nil?()
+
+                if subregion.nil?
                   # Region?
-                  region = regions().find_by_name(t)
-                  
-                  if region.nil?() && !last2.nil?()
-                    region = regions().find_by_name(last2)
+                  region = regions.find_by_name(t)
+
+                  if region.nil? && !last2.nil?
+                    region = regions.find_by_name(last2)
                   end
-                  
-                  if region.nil?()
+
+                  if region.nil?
                     msg = %Q(No state/country/region: "#{text}","#{t}","#{last}")
-                    
-                    if DevOpts.instance.dev?()
+
+                    if DevOpts.instance.dev?
                       raise msg
                     else
                       log.warn(msg)
@@ -197,111 +187,111 @@ module UncleKryon
               end
             else
               state = state.code
-              country = countries().find_by_code('CAN').code
+              country = countries.find_by_code('CAN').code
             end
           else
             state = state.code
-            country = countries().find_by_code('USA').code
+            country = countries.find_by_code('USA').code
           end
         else
           country = country.code
         end
-        
-        if region.nil?() || subregion.nil?()
+
+        if region.nil? || subregion.nil?
           # Not USA
           if parse_state
-            if parts.length() >= 2
-              state = parts[-2].gsub(/[[:space:]]+/,' ').strip()
-              
+            if parts.length >= 2
+              state = parts[-2].gsub(/[[:space:]]+/,' ').strip
+
               # CAN prov/terr? (use state var)
-              if country == countries().find_by_code('CAN').code
-                state = can_provs_terrs().find(state)
-                
-                if state.nil?()
-                  if parts.length() >= 3
-                    state = can_provs_terrs().find_by_name(parts[-3] + parts[-2])
-                    state_i = parts.length() - 3 unless state.nil?()
+              if country == countries.find_by_code('CAN').code
+                state = can_provs_terrs.find(state)
+
+                if state.nil?
+                  if parts.length >= 3
+                    state = can_provs_terrs.find_by_name(parts[-3] + parts[-2])
+                    state_i = parts.length - 3 unless state.nil?
                   end
                 else
                   state = state.code
-                  state_i = parts.length() - 2
+                  state_i = parts.length - 2
                 end
               else
-                if state.length() == 2
-                  state = state.upcase()
-                  state_i = parts.length() - 2
+                if state.length == 2
+                  state = state.upcase
+                  state_i = parts.length - 2
                 else
                   state = nil
                 end
               end
             end
           end
-          
+
           # City
           city = []
-          for i in 0...state_i
-            c = parts[i].gsub(/[[:space:]]+/,' ').strip()
-            city.push(c) unless c.empty?()
+          (0...state_i).each do |i|
+            c = parts[i].gsub(/[[:space:]]+/,' ').strip
+            city.push(c) unless c.empty?
           end
-          city = city.compact()
-          city = city.empty?() ? nil : city.map(&:capitalize).join(' ')
-          
+          city = city.compact
+          city = city.empty? ? nil : city.map(&:capitalize).join(' ')
+
           # Region
-          if !country.nil?()
-            region = countries().find_by_code(country).region
+          if !country.nil?
+            region = countries.find_by_code(country).region
           end
         end
-        
+
         # Location
         loc = [city,state,country,subregion,region] # Don't do compact(); we want all 4 ','
-        locs.push(loc.join(',')) unless loc.compact().empty?()
+        locs.push(loc.join(',')) unless loc.compact.empty?
       end
-      
-      return locs.empty?() ? nil : locs
+
+      return locs.empty? ? nil : locs
     end
-    
-    def self.iso()
+
+    def self.iso
       if !@@iso
-        @@iso = Iso.load_file()
+        @@iso = Iso.load_file
       end
       return @@iso
     end
-    
-    def self.languages()
+
+    def self.languages
       if !@@languages
-        @@languages = Languages.load_file()
+        @@languages = Languages.load_file
       end
       return @@languages
     end
-    
+
     def self.load_file(filepath=DEFAULT_FILEPATH)
       y = YAML.load_file(filepath)
       iso = y[ID]
       return iso
     end
-    
-    def self.regions()
+
+    def self.regions
       if !@@regions
-        @@regions = Regions.load_file()
+        @@regions = Regions.load_file
       end
       return @@regions
     end
-    
+
     def save_to_file(filepath=DEFAULT_FILEPATH)
       File.open(filepath,'w') do |f|
-        iso = {ID=>self}
+        iso = {ID => self}
         YAML.dump(iso,f)
       end
     end
-    
-    def self.subregions()
+
+    def self.subregions
       if !@@subregions
-        @@subregions = Subregions.load_file()
+        @@subregions = Subregions.load_file
       end
       return @@subregions
     end
-    
-    def update_all()
+
+    def update_all
       @updated_can_provs_terrs_on = BaseData.max_updated_on_s(self.class.can_provs_terrs.values)
       @updated_countries_on = BaseData.max_updated_on_s(self.class.countries.values)
       @updated_languages_on = BaseData.max_updated_on_s(self.class.languages.values)
@@ -309,16 +299,16 @@ module UncleKryon
       @updated_subregions_on = BaseData.max_updated_on_s(self.class.subregions.values)
       @updated_usa_states_on = BaseData.max_updated_on_s(self.class.usa_states.values)
     end
-    
-    def self.usa_states()
+
+    def self.usa_states
       if !@@usa_states
-        @@usa_states = UsaStates.load_file()
+        @@usa_states = UsaStates.load_file
       end
       return @@usa_states
     end
-    
-    def to_s()
-      s = 'Updated On:'.dup()
+
+    def to_s
+      s = 'Updated On:'.dup
       s << "\n- CAN Provs/Terrs: #{@updated_can_provs_terrs_on}"
       s << "\n- Countries:  #{@updated_countries_on}"
       s << "\n- Languages:  #{@updated_languages_on}"
@@ -330,7 +320,7 @@ module UncleKryon
   end
 end
 
-if $0 == __FILE__
+if $PROGRAM_NAME == __FILE__
   puts UncleKryon::Iso.can_provs_terrs['ON']
   puts UncleKryon::Iso.countries['USA']
   puts UncleKryon::Iso.languages['eng']

data/lib/unclekryon/iso/base_iso.rb

@@ -1,23 +1,11 @@
-#!/usr/bin/env ruby
 # encoding: UTF-8
 # frozen_string_literal: true
 
 #--
 # This file is part of UncleKryon-server.
-# Copyright (c) 2018-2019 Jonathan Bradley Whited (@esotericpig)
-# 
-# UncleKryon-server 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.
-# 
-# UncleKryon-server 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 UncleKryon-server.  If not, see <https://www.gnu.org/licenses/>.
+# Copyright (c) 2018-2021 Jonathan Bradley Whited
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
 #++
 
 
@@ -32,120 +20,120 @@ module UncleKryon
   class BaseIso < BaseData
     attr_reader :name
     attr_reader :code
-    
-    def initialize()
+
+    def initialize
       super()
-      
+
       @name = nil
       @code = nil
     end
-    
+
     def self.fix_name(name)
-      return self.flip_word_order(self.simplify_name(name))
+      return flip_word_order(simplify_name(name))
     end
-    
+
     def self.flip_word_order(word)
       # e.g., change 'English, Old' to 'Old English'
-      return word.gsub(/([^\,\;]+)[[:space:]]*[\,\;]+[[:space:]]*([^\,\;]+)/,'\\2 \\1').strip()
+      return word.gsub(/([^\,\;]+)[[:space:]]*[\,\;]+[[:space:]]*([^\,\;]+)/,'\\2 \\1').strip
     end
-    
+
     def self.simplify_code(code)
       # e.g., remove 'US-' from 'US-AL'
-      return code.gsub(/[[:alnum:][:space:]]+\-[[:space:]]*/,'').strip()
+      return code.gsub(/[[:alnum:][:space:]]+\-[[:space:]]*/,'').strip
     end
-    
+
     def self.simplify_name(name)
       # e.g., remove '(the)' from 'United States of America (the)'
-      return name.gsub(/[[:space:]]*\([^\)]*\)[[:space:]]*/,'').strip()
+      return name.gsub(/[[:space:]]*\([^\)]*\)[[:space:]]*/,'').strip
     end
-    
-    def ==(y)
-      return @name == y.name && @code == y.code
+
+    def ==(other)
+      return @name == other.name && @code == other.code
     end
-    
-    def to_s()
+
+    def to_s
       return %Q(["#{@name}",#{@code}])
     end
   end
-  
+
   class BaseIsos
     include Logging
-    
+
     DEFAULT_DIR = 'iso'
-    
+
     attr_reader :id
     attr_reader :values
-    
-    def initialize()
+
+    def initialize
       super()
-      
+
       @id = self.class.get_class_name(self)
       @values = {}
     end
-    
+
     def find(text)
       lang = find_by_name(text)
-      return lang unless lang.nil?()
-      
+      return lang unless lang.nil?
+
       lang = find_by_code(text)
       return lang
     end
-    
+
     def find_by_code(code)
-      code = code.gsub(/[[:space:]]+/,'').downcase()
-      
-      @values.each() do |k,v|
+      code = code.gsub(/[[:space:]]+/,'').downcase
+
+      @values.each do |k,v|
         codes = nil
-        
+
         if v.respond_to?(:codes)
           codes = v.codes()
         elsif v.respond_to?(:code)
-          codes = [v.code()]
+          codes = [v.code]
         else
           raise "No codes()/code() method for class #{v.class.name}"
         end
-        
-        codes.each() do |c|
-          next if c.nil?()
-          c = c.gsub(/[[:space:]]+/,'').downcase()
+
+        codes.each do |c|
+          next if c.nil?
+          c = c.gsub(/[[:space:]]+/,'').downcase
           return v if c == code
         end
       end
-      
+
       return nil
     end
-    
+
     def find_by_name(name)
-      name = name.gsub(/[[:space:]]+/,'').downcase()
-      
-      @values.each() do |k,v|
+      name = name.gsub(/[[:space:]]+/,'').downcase
+
+      @values.each do |k,v|
         names = nil
-        
+
         if v.respond_to?(:names)
           names = v.names()
         elsif v.respond_to?(:name)
-          names = [v.name()]
+          names = [v.name]
         else
           raise "No names()/name() method for class #{v.class.name}"
         end
-        
-        names.each() do |n|
-          next if n.nil?()
-          n = n.gsub(/[[:space:]]+/,'').downcase()
+
+        names.each do |n|
+          next if n.nil?
+          n = n.gsub(/[[:space:]]+/,'').downcase
           return v if n == name
         end
       end
-      
+
       return nil
     end
-    
+
     def load_file(filepath)
       y = YAML.load_file(filepath)
       @values.merge!(y[@id])
-      
+
       return self
     end
-    
+
     def save_to_file(filepath)
       File.open(filepath,'w') do |f|
         v = {}
@@ -153,43 +141,43 @@ module UncleKryon
         YAML.dump(v,f)
       end
     end
-    
-    def sort_keys!()
+
+    def sort_keys!
       # Old way: @values = @values.sort().to_h()
-      
+
       new_values = {}
-      
-      @values.keys().sort().each() do |code|
+
+      @values.keys.sort.each do |code|
         new_values[code] = @values[code]
       end
-      
+
       @values = new_values
       return self
     end
-    
+
     def [](code)
       @values[code]
     end
-    
+
     def []=(code,value)
       @values[code] = value
     end
-    
+
     def self.get_class_name(class_var)
       return class_var.class.name.split('::').last
     end
-    
+
     def key?(code)
       @values.key?(code)
     end
-    
-    def to_s()
-      s = ''.dup()
-      
-      @values.each() do |code,value|
+
+    def to_s
+      s = ''.dup
+
+      @values.each do |code,value|
         s << "#{code}: #{value}\n"
       end
-      
+
       return s
     end
   end