phony 2.20.13 → 2.22.2

data/lib/phony/local_splitters/fixed.rb

@@ -1,7 +1,7 @@
+# frozen_string_literal: true
+
 module Phony
-  
   module LocalSplitters
-    
     # Local splitter class to split the last part of
     # a number, i.e. minus cc or ndc.
     #
@@ -11,64 +11,57 @@ module Phony
     #       to avoid getting new local splitter instances.
     #
     class Fixed
-    
       @mapping = {}
-    
+
       # Get a splitter for the given format.
       #
       # Caches the created splitter for the given format.
       #
-      def self.instance_for format = nil
+      def self.instance_for(format = nil)
         @mapping[format] ||= new(format)
       end
-    
+
       # Initialize with a local format, like [3, 2, 2] (also the default).
       #
       # The format [3, 2, 2] splits a number like '3332222' into ['333', '22', '22'].
       #
-      def initialize format = nil
-        format = format && format.dup || [3, 2, 2]
+      def initialize(format = nil)
+        format = format&.dup || [3, 2, 2]
         @format, @length = extract_params format
         @format << @format.pop + 10
       end
-      
-      #
-      #
-      def extract_params format
+
+      def extract_params(format)
         if format.last.respond_to? :max
           last = format.pop
-          length = format.inject(0) { |total, part| total + part }
-          length = (length+last.min..length+last.max)
+          length = format.sum
+          length = (length + last.min..length + last.max)
           format << last.min
         else
-          length = format.inject(0) { |total, part| total + part }
+          length = format.sum
         end
         [format, length]
       end
-    
+
       # Split a local number according to an assumed country specific format.
       #
       # Examples
       # * split '3643533' # => ['364', '35', '33'] # (Switzerland)
       #
-      def split number
-        @format.inject([]) do |result, size|
-          result << number.slice!(0..size-1)
-          return result if number.empty?
-          result
+      def split(number)
+        cursor = 0
+        @format.each_with_object([]) do |size, result|
+          result << number.slice(cursor...cursor + size)
+          cursor += size
+          return result if cursor >= number.size
         end
       end
-      
-      #
-      #
-      def plausible? rest, hints = {}
+
+      def plausible?(rest, hints = {})
         return true if hints[:check_length] == false
-        
+
         @length === rest.inject(0) { |total, part| total + part.size }
       end
-      
     end
-    
   end
-  
-end
+end

data/lib/phony/local_splitters/regex.rb

@@ -1,7 +1,7 @@
+# frozen_string_literal: true
+
 module Phony
-  
   module LocalSplitters
-    
     # Local splitter class to split the last part of
     # a number, i.e. minus cc or ndc.
     #
@@ -11,63 +11,62 @@ module Phony
     #       to avoid getting new local splitter instances.
     #
     class Regex
-      
       attr_reader :fallback, :mapping
-      
+
       # Get a splitter for the given format.
       #
       # Note: Not cached.
       #
-      def self.instance_for mapping
+      def self.instance_for(mapping)
         new mapping
       end
-    
+
       # Initialize with a regex => format mapping.
       #
-      def initialize mapping
+      def initialize(mapping)
         @fallback = mapping.delete(:fallback) || [12]
         @mapping  = mapping
       end
-    
+
       # Split a local number according to an assumed country specific format.
       #
       # Examples
       # * split '3643533' # => ['364', '35', '33'] # (Switzerland)
       #
-      def split number
+      def split(number)
         mapping.each do |regex, format|
-          next unless number =~ regex
+          next unless number&.match?(regex)
+
           return split_with(number, format)
         end
         split_with number, fallback
       end
-      
-      def plausible? rest, hints = {}
-        number = rest.inject('', :+)
+
+      def plausible?(rest, _hints = {})
+        number = rest.sum('')
         mapping.each do |regex, format|
-          next unless number =~ regex
+          next unless number&.match?(regex)
+
           return plausible_with? number, format
         end
         plausible_with? number, fallback
       end
-      
+
       private
-        
-        def split_with number, format
-          format.inject([]) do |result, size|
-            result << number.slice!(0..size-1)
-            return result if number.empty?
-            result
-          end << number
-        end
-        
-        def plausible_with? number, format
-          length = format.inject 0, :+
-          number.length == length
-        end
 
+      def split_with(number, format)
+        cursor = 0
+        format.each_with_object([]) do |size, result|
+          result << number.slice(cursor...cursor + size)
+          cursor += size
+          return result if cursor >= number.size
+        end << number
+      end
+
+      def plausible_with?(number, format)
+        length = format.sum
+        number.length == length
+      end
     end
-    
   end
-  
-end
+end

data/lib/phony/national_code.rb

@@ -1,14 +1,12 @@
-module Phony
+# frozen_string_literal: true
 
+module Phony
   # NationalCodes have a special numbers splitter, a national code splitter and a local code splitter.
   #
   class NationalCode
-    
     attr_reader :local_splitter
-    
-    #
-    #
-    def initialize national_splitter, local_splitter
+
+    def initialize(national_splitter, local_splitter)
       @national_splitter = national_splitter
       @local_splitter    = local_splitter
     end
@@ -16,9 +14,10 @@ module Phony
     # Split gets a number without country code and splits it into
     # its parts.
     #
-    def split national_number
+    def split(national_number)
       zero, ndc_or_rest, rest = @national_splitter.split national_number.dup
       return [zero, ndc_or_rest] unless rest
+
       [zero, ndc_or_rest, *@local_splitter.split(rest)]
     end
 
@@ -26,10 +25,8 @@ module Phony
     #
     # Note: Some cases, like Italy, don't remove the relative zero.
     #
-    def normalize national_number, options = {}
+    def normalize(national_number, _options = {})
       national_number.gsub(/\A0+/, EMPTY_STRING)
     end
-
   end
-
 end

data/lib/phony/national_splitters/default.rb

@@ -1,15 +1,14 @@
-module Phony
+# frozen_string_literal: true
 
+module Phony
   module NationalSplitters
-    
-    # TODO Default = Fixed.new(...)?
+    # TODO: Default = Fixed.new(...)?
     #
     class Default < DSL
-
       def self.instance_for
-        @instance ||= new
+        @instance_for ||= new
       end
-      
+
       # "Splits" the national part of a phone number into a single piece.
       #
       # @param [String] national_number An national part of a number.
@@ -19,10 +18,10 @@ module Phony
       # @example Split the national part of a Swiss number.
       #   Phony.split("1234567") # => ["1234567"]
       #
-      def split national_number
+      def split(national_number)
         [nil, national_number]
       end
-      
+
       # By default, the national part of a number is always plausible.
       #
       # @param [String] rest An national part of a number (ignored).
@@ -34,16 +33,15 @@ module Phony
       # @example Split the national part of a Swiss number.
       #   Phony.plausible?("1234567") # => true
       #
-      def plausible? rest, size, hints = {}
+      def plausible?(_rest, _size, _hints = {})
         true
       end
-      
+
       # A valid length (at least 3).
       #
       def length
         3
       end
-
     end
   end
 end

data/lib/phony/national_splitters/dsl.rb

@@ -1,31 +1,21 @@
+# frozen_string_literal: true
+
 module Phony
-  
   module NationalSplitters
-    
     # TODO
     #
     class DSL
-      
-      #
-      #
-      def >> local_splitter
+      def >>(local_splitter)
         country_for local_splitter
       end
-      
-      #
-      #
-      def country_for local_splitter
+
+      def country_for(local_splitter)
         Phony::Country.new Phony::NationalCode.new(self, local_splitter)
       end
 
-      # TODO Remove?
+      # TODO: Remove?
       #
-      def reserved
-
-      end
-      
+      def reserved; end
     end
-    
   end
-  
-end
+end

data/lib/phony/national_splitters/fixed.rb

@@ -1,15 +1,14 @@
+# frozen_string_literal: true
+
 module Phony
-  
   module NationalSplitters
-    
     # TODO
     #
     class Fixed < DSL
-      
       attr_writer :special_splitter
-      
+
       @mapping = {}
-      
+
       # Get a splitter for the given format.
       #
       # Caches the created splitter for the given format.
@@ -17,27 +16,25 @@ module Phony
       def self.instance_for *parameters
         @mapping[parameters] ||= new(*parameters)
       end
-      
-      def initialize size, options = {}
+
+      def initialize(size, _options = {})
         @size = size
         @zero = nil # options[:zero] == false ? nil : '0'
       end
-      
+
       # Takes a national number and splits it into ndc and rest.
       #
-      def split national_number
+      def split(national_number)
         return [@zero, national_number] unless @size
-        [@zero, national_number.slice!(0...@size), national_number]
+
+        [@zero, national_number.slice(0...@size), national_number.slice(@size..)]
       end
-      
+
       # A valid length.
       #
       def length
         @size
       end
-      
     end
-    
   end
-  
-end
+end

data/lib/phony/national_splitters/none.rb

@@ -1,18 +1,17 @@
+# frozen_string_literal: true
+
 module Phony
-  
   module NationalSplitters
-    
     # This is a national splitter for countries
     # which have no NDC / Area Code.
     #
     class None < Default
-      
       # Get a splitter. Caches.
       #
       def self.instance_for(*)
-        @instance ||= new
+        @instance_for ||= new
       end
-      
+
       # On false:
       #
       # This is a hack to make phony's
@@ -33,18 +32,15 @@ module Phony
       #
       # Note: Decided it stays in. When formatting, it's turned into nil.
       #
-      def split national_number
+      def split(national_number)
         [nil, false, national_number]
       end
-      
+
       # A valid length.
       #
       def length
         0
       end
-      
     end
-    
   end
-  
-end
+end

data/lib/phony/national_splitters/regex.rb

@@ -1,7 +1,7 @@
+# frozen_string_literal: true
+
 module Phony
-  
   module NationalSplitters
-    
     # National splitter class to split the ndc-local part of a number.
     #
     # Countries can create new instances according to their needs.
@@ -10,46 +10,42 @@ module Phony
     #       to avoid getting new local splitter instances.
     #
     class Regex < Fixed
-      
       attr_reader :on_fail_take, :regex
-      
+
       # Get a splitter for the given format.
       #
       # Note: Not cached.
       #
-      def self.instance_for regex, on_fail_take = nil, options = {}
+      def self.instance_for(regex, on_fail_take = nil, options = {})
         new regex, on_fail_take, options
       end
 
-      def initialize regex, on_fail_take = nil, options = {}
-        super on_fail_take, options
+      def initialize(regex, on_fail_take = nil, options = {})
+        super(on_fail_take, options)
 
         @regex = regex
       end
-    
+
       # Split a local number according to an assumed country specific format.
       #
       # Examples
       # * split '3643533' # => ['364', '35', '33'] # (Switzerland)
       #
-      def split national_number
+      def split(national_number)
         # Improve matching.
         #
-        return [@zero, national_number.slice!(0..$1.size-1), national_number] if national_number =~ regex
-        
+        return [@zero, national_number.slice!(0..::Regexp.last_match(1).size - 1), national_number] if national_number =~ regex
+
         # Not found.
         #
-        super national_number
+        super(national_number)
       end
-      
+
       # A valid length.
       #
       def length
         # raise "#{self.class.name} has no length that can be automatically extracted."
       end
-      
     end
-    
   end
-  
-end
+end

data/lib/phony/national_splitters/variable.rb

@@ -1,68 +1,67 @@
+# frozen_string_literal: true
+
 module Phony
-  
   module NationalSplitters
-    
     class Variable < Fixed
-      
-      #
-      #
-      def initialize fallback, ndcs, options = {}
-        super fallback, options
+      def initialize(fallback, ndcs, options = {})
+        super(fallback, options)
         @ndcs = optimize ndcs
       end
-      
+
       # Takes a national number and splits it into ndc and rest.
       #
-      def split national_number
+      def split(national_number)
+        national_number = national_number.dup
         fallback_number = national_number.dup
-        
+
         # Extract a starting point.
         #
         # This if can possibly be removed.
         #
-        presumed_code = if @mapped_ndc_min_length > 0
-          presumed_code = national_number.slice!(0..@mapped_ndc_min_length-1)
-        else
-          ''
-        end
-        
+        presumed_code = if @mapped_ndc_min_length.positive?
+                          presumed_code = national_number.slice!(0..@mapped_ndc_min_length - 1)
+                        else
+                          ''
+                        end
+
         # Try for all possible mapped.
         #
         @mapped_ndc_min_length.upto @mapped_ndc_max_length do |i|
           ndcs_of_size_i = @ndcs[i]
-          return [@zero, presumed_code, national_number] unless ndcs_of_size_i && !ndcs_of_size_i.include?(presumed_code)
+          unless ndcs_of_size_i && !ndcs_of_size_i.include?(presumed_code)
+            return [@zero, presumed_code,
+                    national_number]
+          end
+
           presumed_code << national_number.slice!(0..0)
         end
-        
+
         # Not found.
         #
-        super fallback_number
+        super(fallback_number)
       end
-      
+
       # A valid length.
       #
       def length
         (@mapped_ndc_min_length..@mapped_ndc_max_length)
       end
-      
+
       private
-        
-        # Optimizes and restructures the given ndcs array.
-        #
-        def optimize ndc_ary
-          ndcs = {}
-          ndc_ary.each do |ndc|
-            ndcs[ndc.length] ||= []
-            ndcs[ndc.length] << ndc
-          end
-          keys = ndcs.keys
-          @mapped_ndc_min_length = keys.min # || 1
-          @mapped_ndc_max_length = keys.max
-          ndcs
+
+      # Optimizes and restructures the given ndcs array.
+      #
+      def optimize(ndc_ary)
+        ndcs = {}
+        ndc_ary.each do |ndc|
+          ndcs[ndc.length] ||= []
+          ndcs[ndc.length] << ndc
         end
-      
+        keys = ndcs.keys
+        @mapped_ndc_min_length = keys.min # || 1
+        @mapped_ndc_max_length = keys.max
+        ndcs
+      end
     end
-    
   end
-  
-end
+end

data/lib/phony/trunk_code.rb

@@ -1,7 +1,7 @@
-module Phony
+# frozen_string_literal: true
 
+module Phony
   class TrunkCode
-  
     # Parameters:
     #  * code: The trunk code, e.g. 0.
     #
@@ -10,17 +10,17 @@ module Phony
     #  * split: [true, false (default)] Remove the trunk code when splitting (only use if number scheme is defined unambiguously).
     #  * format: [true (default), false] Add the trunk code when formatting (passing `false` will not add it).
     #
-    def initialize code, options = {}
+    def initialize(code, options = {})
       @code = code
-      @trunk_code_replacement = /\A#{code.gsub(%r{%s}, '')}/
+      @trunk_code_replacement = /\A#{code.gsub(/%s/, '')}/
       @normalize = options[:normalize] || options[:normalize].nil?
       @split     = options[:split]
       @format    = options[:format] || options[:format].nil?
     end
-    
+
     # Prepends itself to the other codes.
     #
-    def | other
+    def |(other)
       other.codes.unshift self
       other
     end
@@ -28,30 +28,30 @@ module Phony
     # Split gets a number without country code and splits it into
     # its parts.
     #
-    def split national_number
-      national_number.gsub! @trunk_code_replacement, EMPTY_STRING if @split
-      return [self, national_number]
+    def split(national_number)
+      return [self, national_number] unless @split
+
+      without_trunk = national_number.gsub @trunk_code_replacement, EMPTY_STRING
+      [self, without_trunk]
     end
-    
+
     # Normalize normalizes the given national number.
     #
-    def normalize national_number, options = {}
-      national_number.gsub! @trunk_code_replacement, EMPTY_STRING if @normalize && options[:cc]
-      return national_number
+    def normalize(national_number, options = {})
+      return national_number unless @normalize && options[:cc]
+
+      national_number.gsub @trunk_code_replacement, EMPTY_STRING
     end
-    
+
     # Format the trunk code using the spaces given.
     #
-    def format space, force = nil
-      if force || @format
+    def format(space, force = nil)
+      return unless force || @format
         if @code.size > 1
           (@code % space).gsub(/\D/, ' ')
         else
           @code
         end
-      end
     end
-  
   end
-
-end
+end