id_pack 1.0.0 → 1.0.3

data/lib/id_pack/id_packer.rb

@@ -1,41 +1,41 @@
 module IdPack
 
-# This is a module to encode an integer array into our compressed format.
-# Basically there are only 2 methods in this module, encode and decode.
-#
-# Usage:
-#   encode:
-#     a usual use case of encode is to provide the server with object ids
-#     that have already been fetched and hence we don't need their data to
-#     be returned
-#
-#     Example:
-#
-#       IdPack::IdPacker.new.encode([5, 6, 21, 23, 25]) # => "_F~C_P.V"
-#
-#   decode:
-#     mainly used by the server to convert the compressed string back into
-#     the integer array
-#
-#     Example:
-#
-#       IdPack::IdPacker.new.decode("_F~C_P.V") # => [5, 6, 21, 23, 25]
+  # This is a module to encode an integer array into our compressed format.
+  # Basically there are only 2 methods in this module, encode and decode.
+  #
+  # Usage:
+  #   encode:
+  #     a usual use case of encode is to provide the server with object ids
+  #     that have already been fetched and hence we don't need their data to
+  #     be returned
+  #
+  #     Example:
+  #
+  #       IdPack::IdPacker.new.encode([5, 6, 21, 23, 25]) # => "_F~C_P.V"
+  #
+  #   decode:
+  #     mainly used by the server to convert the compressed string back into
+  #     the integer array
+  #
+  #     Example:
+  #
+  #       IdPack::IdPacker.new.decode("_F~C_P.V") # => [5, 6, 21, 23, 25]
 
   class IdPacker
 
     class InvalidEncodedCharException < StandardError; end
 
-    SPACES_PREFIX = '_'
-    BINARY_PREFIX = '.'
-    RANGE_PREFIX  = '~'
+    SPACES_PREFIX = '_'.freeze
+    BINARY_PREFIX = '.'.freeze
+    RANGE_PREFIX  = '~'.freeze
     WINDOW_SIZE = 10
     EXCLUDE_NIL = true
-    ENCODED_NUMBER_CHARS = (('A'..'Z').to_a + ('a'..'z').to_a + ('0'..'9').to_a).join + '-'
+    ENCODED_NUMBER_CHARS = "#{(('A'..'Z').to_a + ('a'..'z').to_a + ('0'..'9').to_a).join}-".freeze
 
 
     # [5, 6, 21, 23, 25]
     # => "_F~C_P.V"
-    def encode array, window_size = WINDOW_SIZE, exclude_nil = EXCLUDE_NIL, output_charset = ENCODED_NUMBER_CHARS
+    def encode(array, window_size = WINDOW_SIZE, _exclude_nil = EXCLUDE_NIL, output_charset = ENCODED_NUMBER_CHARS)
       encoded_array = ''
 
       ranges = convert_numbers_to_ranges array.uniq.sort
@@ -48,7 +48,7 @@ module IdPack
       decimal_number = 0
       encoded_string = ''
 
-      ranges.each_with_index do |range, i|
+      ranges.each_with_index do |range, _i|
         spaces = range.begin - prev_end
 
         if group_with_prev
@@ -56,26 +56,34 @@ module IdPack
             ranges_to_group << range
             binary_number = convert_ranges_to_binary_number ranges_to_group
             decimal_number = convert_binary_number_to_decimal_number binary_number
-            encoded_string = BINARY_PREFIX + encode_decimal_number(decimal_number, output_charset)
+            encoded_string = BINARY_PREFIX + encode_decimal_number(
+              decimal_number, output_charset
+            )
             encoded_array += encoded_string
             ranges_to_group = []
             group_with_prev = false
           elsif range.end - curr_start + 1 >= window_size
             if ranges_to_group.length == 1
-              encoded_string = RANGE_PREFIX + encode_decimal_number(ranges_to_group.first.size, output_charset)
+              encoded_string = RANGE_PREFIX + encode_decimal_number(
+                ranges_to_group.first.size, output_charset
+              )
               encoded_array += encoded_string
             else
               binary_number = convert_ranges_to_binary_number ranges_to_group
               decimal_number = convert_binary_number_to_decimal_number binary_number
-              encoded_string = BINARY_PREFIX + encode_decimal_number(decimal_number, output_charset)
+              encoded_string = BINARY_PREFIX + encode_decimal_number(
+                decimal_number, output_charset
+              )
               encoded_array += encoded_string
             end
             ranges_to_group = []
-            encoded_string = SPACES_PREFIX + encode_decimal_number(spaces, output_charset)
+            encoded_string = SPACES_PREFIX + encode_decimal_number(spaces,
+                                                                   output_charset)
             encoded_array += encoded_string
 
             if range.size >= window_size
-              encoded_string = RANGE_PREFIX + encode_decimal_number(range.size, output_charset)
+              encoded_string = RANGE_PREFIX + encode_decimal_number(range.size,
+                                                                    output_charset)
               encoded_array += encoded_string
               group_with_prev = false
             else
@@ -88,12 +96,14 @@ module IdPack
           end
         else
           if spaces >= 0
-            encoded_string = SPACES_PREFIX + encode_decimal_number(spaces, output_charset)
+            encoded_string = SPACES_PREFIX + encode_decimal_number(spaces,
+                                                                   output_charset)
             encoded_array += encoded_string
           end
 
           if range.size >= window_size
-            encoded_string = RANGE_PREFIX + encode_decimal_number(range.size, output_charset)
+            encoded_string = RANGE_PREFIX + encode_decimal_number(range.size,
+                                                                  output_charset)
             encoded_array += encoded_string
           else
             ranges_to_group.push range
@@ -106,12 +116,15 @@ module IdPack
       end
 
       if ranges_to_group.length == 1
-        encoded_string = RANGE_PREFIX + encode_decimal_number(ranges_to_group.first.size, output_charset)
+        encoded_string = RANGE_PREFIX + encode_decimal_number(
+          ranges_to_group.first.size, output_charset
+        )
         encoded_array += encoded_string
-      elsif ranges_to_group.length > 0
+      elsif ranges_to_group.length.positive?
         binary_number = convert_ranges_to_binary_number ranges_to_group
         decimal_number = convert_binary_number_to_decimal_number binary_number
-        encoded_string = BINARY_PREFIX + encode_decimal_number(decimal_number, output_charset)
+        encoded_string = BINARY_PREFIX + encode_decimal_number(decimal_number,
+                                                               output_charset)
         encoded_array += encoded_string
       end
 
@@ -130,8 +143,10 @@ module IdPack
       encoded_caches.each_char do |c|
         if [SPACES_PREFIX, BINARY_PREFIX, RANGE_PREFIX].include?(c)
           unless curr_encoded_string_prefix == nil
-            ids_to_include, end_id = convert_encoded_number_to_ids(curr_encoded_string_prefix, encoded_number, start_id)
-            ids = ids.concat(ids_to_include)
+            ids_to_include, end_id = convert_encoded_number_to_ids(
+              curr_encoded_string_prefix, encoded_number, start_id
+            )
+            ids.concat(ids_to_include)
             start_id = end_id + (c == SPACES_PREFIX ? 0 : 1)
           end
           curr_encoded_string_prefix = c
@@ -143,8 +158,10 @@ module IdPack
       end
 
       unless curr_encoded_string_prefix == nil
-        ids_to_include, end_id = convert_encoded_number_to_ids(curr_encoded_string_prefix, encoded_number, start_id)
-        ids = ids.concat(ids_to_include)
+        ids_to_include, end_id = convert_encoded_number_to_ids(
+          curr_encoded_string_prefix, encoded_number, start_id
+        )
+        ids.concat(ids_to_include)
         start_id = end_id + 1
       end
 
@@ -166,11 +183,11 @@ module IdPack
     # "encoded_0",diff_last_synced_at_0,\
     # "encoded_1",diff_last_synced_at_1,\
     # "encoded_2",diff_last_synced_at_2, ...
-    def encode_sync_str id_synced_at
+    def encode_sync_str(id_synced_at)
       min_synced_at = id_synced_at.values.min
       encoded_min_synced_at = LZString.compress_to_encoded_uri_component(min_synced_at.to_s)
 
-      grouped_synced_at = id_synced_at.group_by do |id, synced_at|
+      grouped_synced_at = id_synced_at.group_by do |_id, synced_at|
         synced_at
       end
 
@@ -178,12 +195,19 @@ module IdPack
         ids = ids_group.map do |id_group|
           int_id = id_group[0].to_s.to_i
 
-          int_id && int_id.to_s == id_group[0].to_s ?
-            int_id :
+          if int_id && int_id.to_s == id_group[0].to_s
+            int_id
+          else
             id_group[0].to_s
+          end
         end
 
-        joined_ids = ids.first.is_a?(String) ? ids.join("").gsub(/-/, "") : ids.join(",")
+        joined_ids = if ids.first.is_a?(String)
+                       ids.join("").gsub(/-/,
+                                         "")
+                     else
+                       ids.join(",")
+                     end
 
         encoded_indices = LZString.compress_to_encoded_uri_component(joined_ids)
         diff_synced_at = synced_at - min_synced_at
@@ -193,14 +217,14 @@ module IdPack
       end.join(",")
     end
 
-    def decode_sync_str sync_str, base_timestamp = 0
+    def decode_sync_str(sync_str, base_timestamp = 0)
       # format of sync_str:
       # min_last_synced_at,
       # "encoded_0", diff_last_requested_at_0,
       # "encoded_1", diff_last_requested_at_1,
       # "encoded_2", diff_last_requested_at_2, ...
 
-      sync_str = sync_str.encode('UTF-8', 'UTF-8', :invalid => :replace)
+      sync_str = sync_str.encode('UTF-8', 'UTF-8', invalid: :replace)
 
       encoded_min_last_synced_at, *encoded_ranges = sync_str.split(',')
       min_last_synced_at = LZString.decompress_from_encoded_uri_component(encoded_min_last_synced_at).to_i
@@ -219,7 +243,8 @@ module IdPack
           primary_keys.map!(&:to_i)
         else
           primary_keys = primary_keys_str.scan(/.{32}/).map do |uuid_str|
-            [uuid_str[0,8], uuid_str[8,4], uuid_str[12,4], uuid_str[16,4], uuid_str[20,16]].join("-")
+            [uuid_str[0, 8], uuid_str[8, 4], uuid_str[12, 4], uuid_str[16, 4],
+             uuid_str[20, 16]].join("-")
           end
         end
 
@@ -232,7 +257,7 @@ module IdPack
 
         synced_at_map
       end
-    rescue
+    rescue StandardError
       # invalid sync_str, return empty map
       {}
     end
@@ -242,8 +267,8 @@ module IdPack
 
     # [1,2,3,6,7,8]
     # => [1..3, 6..8]
-    def convert_numbers_to_ranges numbers
-      return [] unless numbers.length > 0
+    def convert_numbers_to_ranges(numbers)
+      return [] unless numbers.length.positive?
 
       ranges = []
       range = nil
@@ -251,11 +276,13 @@ module IdPack
       numbers.each_with_index do |number, i|
         range = Range.new(
           (
-            range && number == numbers[i - 1] + 1 ?
-              range.begin :
+            if range && number == numbers[i - 1] + 1
+              range.begin
+            else
               number
+            end
           ),
-          number
+          number,
         )
 
         ranges << range unless numbers[i + 1] && numbers[i + 1] == number + 1
@@ -266,11 +293,11 @@ module IdPack
 
     # [1..3, 6..8]
     # => "11100111"
-    def convert_ranges_to_binary_number ranges
+    def convert_ranges_to_binary_number(ranges)
       binary_number = ''
 
       ranges.each_with_index do |range, i|
-        binary_number += '0' * (range.begin - ranges[i - 1].end - 1) if i > 0
+        binary_number += '0' * (range.begin - ranges[i - 1].end - 1) if i.positive?
         binary_number += '1' * (range.end - range.begin + 1)
       end
 
@@ -279,11 +306,11 @@ module IdPack
 
     # "10101"
     # => 21
-    def convert_binary_number_to_decimal_number binary_number
+    def convert_binary_number_to_decimal_number(binary_number)
       decimal_number = 0
 
       binary_number.length.times do |i|
-        decimal_number += 2 ** (binary_number.length - i - 1) * binary_number[i].to_i
+        decimal_number += 2**(binary_number.length - i - 1) * binary_number[i].to_i
       end
 
       decimal_number
@@ -291,19 +318,19 @@ module IdPack
 
     # 5
     # => F"
-    def encode_decimal_number decimal_number, output_charset = ENCODED_NUMBER_CHARS
-      return nil if !decimal_number.is_a?(Integer) || decimal_number < 0
+    def encode_decimal_number(decimal_number, output_charset = ENCODED_NUMBER_CHARS)
+      return nil if !decimal_number.is_a?(Integer) || decimal_number.negative?
 
       encoded_number = ""
       base = output_charset.length
       quotient = decimal_number
       remainder = nil
 
-      while true do
+      loop do
         remainder = quotient % base
         encoded_number = output_charset[remainder] + encoded_number
         quotient = (quotient - remainder) / base
-        break if quotient == 0
+        break if quotient.zero?
       end
 
       encoded_number
@@ -387,7 +414,7 @@ module IdPack
         end_id = start_id + decimal_number - 1
       end
 
-      [ ids, end_id ]
+      [ids, end_id]
     end
 
   end