readthis 1.5.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d99b745b536b4761198212736eba995173cf7dd0
-  data.tar.gz: fb66dd2f67cc90114ad5037ea10b684722d6d468
+  metadata.gz: e16646d64b4ceca02395a09548e24ecea98acc2f
+  data.tar.gz: 450ed32fe1925d4bee3f6b1fa43503305c7210ad
 SHA512:
-  metadata.gz: 992a39d5b3c6fde1796dbd8ac8dc8c03aa44cd79152a15e6b1ca553327d4dec95f754ddb68a2275aa636d75d13658e43b712ebd95ae4b49ae21f6a164ad66b87
-  data.tar.gz: e5521f55739341901c7bbe6d9743127686643ca44cb82bf338f046a81fd16a522f364ee757e5f548f3ed9c647b495904c0faa1144470e47f4610f510cebc23e1
+  metadata.gz: 456a017c4ceacfb887523a018fff2c2093acff21ddb9fb105e25e408781cb5a8b00b9c455c27f6fec18a8a2c2bc0a2320e8610744471048830dacb273df275c3
+  data.tar.gz: 5061eac72e442c3f235b22719bd3c2bc824b71e4a5add63a6b13cba4ebce8ca8d16ff76593ea9f218e3a231a73ab681dc44fa2dc00eef161d6de4ff97a0943c7

data/lib/readthis/cache.rb

@@ -19,21 +19,32 @@ module Readthis
 
     # Creates a new Readthis::Cache object with the given options.
     #
-    # @option options [Hash]    :redis Options that will be passed to the redis connection
-    # @option options [Boolean] :compress (false) Enable or disable automatic compression
-    # @option options [Number]  :compression_threshold (8k) Minimum string size for compression
-    # @option options [Number]  :expires_in The number of seconds until an entry expires
-    # @option options [Boolean] :refresh (false) Automatically refresh key expiration
-    # @option options [Module]  :marshal (Marshal) Module that responds to `dump` and `load`
-    # @option options [String]  :namespace Prefix used to namespace entries
-    # @option options [Number]  :pool_size (5) The number of threads in the pool
-    # @option options [Number]  :pool_timeout (5) How long before a thread times out
+    # @option options [Hash] :redis Options that will be passed to the redis
+    #   connection
+    # @option options [Boolean] :compress (false) Enable or disable automatic
+    #   compression
+    # @option options [Number] :compression_threshold (8k) Minimum string size
+    #   for compression
+    # @option options [Number] :expires_in The number of seconds until an entry
+    #   expires
+    # @option options [Boolean] :refresh (false) Automatically refresh key
+    #   expiration
+    # @option options [Boolean] :retain_nils (false) Whether nil values should
+    #   be included in read_multi output
+    # @option options [Module] :marshal (Marshal) Module that responds to
+    #   `dump` and `load`
+    # @option options [String] :namespace Prefix used to namespace entries
+    # @option options [Number] :pool_size (5) The number of threads in the pool
+    # @option options [Number] :pool_timeout (5) How long before a thread times
+    #   out
     #
     # @example Create a new cache instance
+    #
     #   Readthis::Cache.new(namespace: 'cache',
     #                       redis: { url: 'redis://localhost:6379/0' })
     #
     # @example Create a compressed cache instance
+    #
     #   Readthis::Cache.new(compress: true, compression_threshold: 2048)
     #
     def initialize(options = {})
@@ -246,19 +257,20 @@ module Readthis
       end
     end
 
-    # Read multiple values at once from the cache. Options can be passed in the
-    # last argument.
+    # Efficiently read multiple values at once from the cache. Options can be
+    # passed in the last argument.
     #
     # @overload read_multi(keys)
     #   Return all values for the given keys.
     #   @param [String] One or more keys to fetch
+    #   @param [Hash] options Configuration to override
     #
     # @return [Hash] A hash mapping keys to the values found.
     #
     # @example
     #
-    #   cache.write('a', 1)
-    #   cache.read_multi('a', 'b') # => { 'a' => 1, 'b' => nil }
+    #   cache.read_multi('a', 'b') # => { 'a' => 1 }
+    #   cache.read_multi('a', 'b', retain_nils: true) # => { 'a' => 1, 'b' => nil }
     #
     def read_multi(*keys)
       options = merged_options(extract_options!(keys))
@@ -271,7 +283,7 @@ module Readthis
 
         refresh_entity(mapping, store, options)
 
-        keys.zip(values).to_h
+        values_to_hash(keys, values, options)
       end
     end
 
@@ -318,9 +330,9 @@ module Readthis
     #   end
     #
     def fetch_multi(*keys)
-      results   = read_multi(*keys)
-      extracted = extract_options!(keys)
-      missing   = {}
+      options = extract_options!(keys).merge(retain_nils: true)
+      results = read_multi(*keys, options)
+      missing = {}
 
       invoke(:fetch_multi, keys) do |_store|
         results.each do |key, value|
@@ -332,7 +344,7 @@ module Readthis
         end
       end
 
-      write_multi(missing, extracted) if missing.any?
+      write_multi(missing, options) if missing.any?
 
       results
     end
@@ -426,6 +438,14 @@ module Readthis
       @options.merge(options || {})
     end
 
+    def zipped_results(keys, values, options)
+      zipped = keys.zip(values)
+
+      zipped.select! { |(_, value)| value } unless options[:retain_nils]
+
+      zipped.to_h
+    end
+
     def pool_options(options)
       { size:    options.fetch(:pool_size, 5),
         timeout: options.fetch(:pool_timeout, 5) }

data/lib/readthis/version.rb

@@ -1,3 +1,3 @@
 module Readthis
-  VERSION = '1.5.0'.freeze
+  VERSION = '2.0.0'.freeze
 end

data/spec/readthis/cache_spec.rb

@@ -210,14 +210,25 @@ RSpec.describe Readthis::Cache do
       cache.write('a', 1)
       cache.write('b', 2)
       cache.write('c', '3')
+      cache.write('d', nil)
 
-      expect(cache.read_multi('a', 'b', 'c')).to eq(
+      expect(cache.read_multi('a', 'b', 'c', 'd')).to eq(
         'a' => 1,
         'b' => 2,
         'c' => '3'
       )
     end
 
+    it 'can be configured to retain keys with nil values' do
+      cache.write('a', nil)
+      cache.write('b', nil)
+
+      expect(cache.read_multi('a', 'b', retain_nils: true)).to eq(
+        'a' => nil,
+        'b' => nil
+      )
+    end
+
     it 'respects namespacing' do
       cache.write('d', 1, namespace: 'cache')
       cache.write('e', 2, namespace: 'cache')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: readthis
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Parker Selbert
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-18 00:00:00.000000000 Z
+date: 2016-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis