fmcache 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 450fac8896504841b9ed4dcc1f8846c077678aa00f6e046377f0aaf1d9d5bca8
-  data.tar.gz: 66d1c2585c68faafc4949d41e5112ba798f16d985fd7e557c1c154ee34b294b0
+  metadata.gz: 3420398f6bb70d1972fe648bc4a880ac64bbc08d43cad850109b60a11cee4c38
+  data.tar.gz: 170a4ef45eaa1ebdb23b12abfa7d142792a33cbad1383c0470c2cabcfc202e2c
 SHA512:
-  metadata.gz: 829181d98d91b0d32fd9a95bca2991a908a8f0f25238e4d185b94c28fa83c543b9d0092d347bf5204add4212fc225eaa520a35697afb2634ccef4a487c5f60ff
-  data.tar.gz: c340dc530f656b75a33e5becfc7fe9562ff08a1c3f7b36a30f8f2614146d5480f804ab85e041c7e4cd0de32ef5e66d20c5a5e2f5cbb0a7dcedd67db3b81e6801
+  metadata.gz: e633c361b62356812fcce2fcdab642b3678d444c063fe06497644146e3ad02fddfa5927664418c0bbdaf7b89c3835a8d8118bcca1b8e3cb92e9eeaeac823c739
+  data.tar.gz: 4ae7c3394bb79a1535f5eac8625b18ccbfd4f318a54e855e94dbe25584e46cb7e8d979beed88a06736d5131da73d4cebb481315e378217b5c74049d272d78ed0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fmcache (0.1.2)
+    fmcache (0.1.3)
       field_mask_parser (~> 0.4.2)
 
 GEM

data/lib/fmcache/decoder.rb

@@ -32,12 +32,14 @@ module FMCache
 
     # @param [<Hash>] list
     # @param [FieldMaskParser::Node] field_mask
+    # @param [<String>] fields
+    # @return [DecodeResult]
     def decode_list(list, field_mask: nil, fields: nil)
       if field_mask.nil? && fields.nil?
         raise "invalid args!"
       end
       if fields
-        field_mask = field_mask_parser.call(fields.map(&:to_s))
+        field_mask = field_mask_parser.call(fields)
       end
 
       values         = []
@@ -61,6 +63,7 @@ module FMCache
       )
     end
 
+    # @param [FieldsChecker::CheckResult] decode_result
     # @param [DecodeResult] decode_result
     # @param [DecodeResult] invalid_decode_result
     # @return [<Hash>, <Hash>, IncompleteInfo]

data/lib/fmcache/decoder/fields_checker.rb

@@ -60,7 +60,7 @@ module FMCache
             missing_fields += m_f
           end
         else
-          # NOTE: When the cach of id does not exist, treat current and lower
+          # NOTE: When the cache of id does not exist, treat current and lower
           # layer as missing fields
           # TODO(south37) Improve performance
           missing_fields += fields

data/lib/fmcache/decoder/value_decoder.rb

@@ -13,7 +13,7 @@ module FMCache
 
         h = fetch(field_mask, [])
 
-        d = h.values.first  # NOTE: Top of h is a user
+        d = h.values.first  # NOTE: Top of h is a hash
 
         [d.to_h, @invalid_fields]
       end
@@ -53,6 +53,8 @@ module FMCache
         r
       end
 
+      # @param [FieldMaskParser::Node] field_mask
+      # @param [<Symbol>] prefix
       def fetch_items(field_mask, prefix)
         r = {}
         field_mask.attrs.each do |attr|
@@ -66,14 +68,15 @@ module FMCache
         r
       end
 
-      # @param [String] h
+      # @param [<Hash>] h
+      # @return [<Item>]
       def itemize(h)
         h.map do |hh|
           Item.new(id: hh.fetch(:id), p_id: hh.fetch(:p_id), value: hh.fetch(:value))
         end
       end
 
-      # @param [{ Integer => Data }]
+      # @param [{ Integer => Data }] parents
       # @param [FieldMaskParser::Node] field_mask
       # @param [<Symbol>] prefix
       def assign_has_one!(parents, field_mask, prefix)

data/lib/fmcache/encoder.rb

@@ -6,19 +6,15 @@ module FMCache
     # @param [FieldMaskParser::Node] field_mask
     # @return [{ String => { String => <Hash> } }]
     def encode(values, field_mask)
+      fields = Helper.to_fields(field_mask)
+
       r = {}
       values.each do |value|
         h = {}
-
-        # NOTE: initialize each field by array
-        fields = Helper.to_fields(field_mask).map(&:to_s)
         fields.each do |f|
           h[f] = []
         end
-
-        encode_one(value, field_mask).each do |f, v|
-          h[f] = v
-        end
+        h.merge! encode_one(value, field_mask)
 
         id = value.fetch(:id)
         r[Helper.to_key(id)] = h

data/lib/fmcache/engine.rb

@@ -3,6 +3,10 @@ module FMCache
     DEFAULT_TTL = 7 * 24 * 3600  # 7 days
 
     # @param [Redis | MockRRedis] client
+    # @param [Proc] fm_parser
+    # @param [Integer] ttl
+    # @param [Proc] notifier
+    # @param [#dump#load] json_serializer
     def initialize(client:, fm_parser:, ttl: DEFAULT_TTL, notifier: nil, json_serializer: nil)
       @client    = Client.new(client, notifier)
       @fm_parser = wrap(fm_parser)
@@ -31,7 +35,7 @@ module FMCache
       normalize!(field_mask)
 
       keys   = Helper.to_keys(ids)
-      fields = Helper.to_fields(field_mask).map(&:to_s)
+      fields = Helper.to_fields(field_mask)
       h = client.get(keys: keys, fields: fields)
       decode(merge(@jsonizer.dejsonize(h), ids), field_mask)
     end
@@ -66,6 +70,7 @@ module FMCache
       Helper.sort(values + v + i_v, ids)
     end
 
+    # @param [<Integer | String>] ids
     def delete(ids:)
       ids = ids.map(&:to_i)
       client.del(keys: Helper.to_keys(ids))
@@ -99,6 +104,8 @@ module FMCache
       hash
     end
 
+    # @param [Proc] fm_parser
+    # @return [Proc]
     def wrap(fm_parser)
       -> (fields) {
         n = fm_parser.call(fields)
@@ -107,6 +114,7 @@ module FMCache
       }
     end
 
+    # @param [FieldMaskParser::Node] field_mask
     def normalize!(field_mask)
       if !field_mask.attrs.include?(:id)
         field_mask.attrs << :id

data/lib/fmcache/field.rb

@@ -1,6 +1,9 @@
 module FMCache
   class Field
     class << self
+      # @param [<Symbol>] prefix
+      # @param [Symbol] attr
+      # @return [String]
       def to_s(prefix:, attr:)
         l = prefix + [attr]
         l.join(".")

data/lib/fmcache/helper.rb

@@ -2,6 +2,7 @@ module FMCache
   class Helper
     class << self
       # @param [FieldMaskParser::Node] field_mask
+      # @param [<Symbol>] prefix
       # @return [<String>]
       def to_fields(field_mask, prefix: [])
         field_mask.to_paths(prefix: prefix, sort: false)

data/lib/fmcache/version.rb

@@ -1,3 +1,3 @@
 module FMCache
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fmcache
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Nao Minami