Default values for entries

lib/kredis/attributes.rb

@@ -2,56 +2,56 @@ module Kredis::Attributes
   extend ActiveSupport::Concern
 
   class_methods do
-    def kredis_proxy(name, key: nil, config: :shared, after_change: nil)
-      kredis_connection_with __method__, name, key, config: config, after_change: after_change
+    def kredis_proxy(name, key: nil, default: nil, config: :shared, after_change: nil)
+      kredis_connection_with __method__, name, key, default: default, config: config, after_change: after_change
     end
 
-    def kredis_string(name, key: nil, config: :shared, after_change: nil, expires_in: nil)
-      kredis_connection_with __method__, name, key, config: config, after_change: after_change, expires_in: expires_in
+    def kredis_string(name, key: nil, default: nil, config: :shared, after_change: nil, expires_in: nil)
+      kredis_connection_with __method__, name, key, default: default, config: config, after_change: after_change, expires_in: expires_in
     end
 
-    def kredis_integer(name, key: nil, config: :shared, after_change: nil, expires_in: nil)
-      kredis_connection_with __method__, name, key, config: config, after_change: after_change, expires_in: expires_in
+    def kredis_integer(name, key: nil, default: nil, config: :shared, after_change: nil, expires_in: nil)
+      kredis_connection_with __method__, name, key, default: default, config: config, after_change: after_change, expires_in: expires_in
     end
 
-    def kredis_decimal(name, key: nil, config: :shared, after_change: nil, expires_in: nil)
-      kredis_connection_with __method__, name, key, config: config, after_change: after_change, expires_in: expires_in
+    def kredis_decimal(name, key: nil, default: nil, config: :shared, after_change: nil, expires_in: nil)
+      kredis_connection_with __method__, name, key, default: default, config: config, after_change: after_change, expires_in: expires_in
     end
 
-    def kredis_datetime(name, key: nil, config: :shared, after_change: nil, expires_in: nil)
-      kredis_connection_with __method__, name, key, config: config, after_change: after_change, expires_in: expires_in
+    def kredis_datetime(name, key: nil, default: nil, config: :shared, after_change: nil, expires_in: nil)
+      kredis_connection_with __method__, name, key, default: default, config: config, after_change: after_change, expires_in: expires_in
     end
 
-    def kredis_flag(name, key: nil, config: :shared, after_change: nil, expires_in: nil)
-      kredis_connection_with __method__, name, key, config: config, after_change: after_change, expires_in: expires_in
+    def kredis_flag(name, key: nil, default: nil, config: :shared, after_change: nil, expires_in: nil)
+      kredis_connection_with __method__, name, key, default: default, config: config, after_change: after_change, expires_in: expires_in
 
       define_method("#{name}?") do
         send(name).marked?
       end
     end
 
-    def kredis_float(name, key: nil, config: :shared, after_change: nil, expires_in: nil)
-      kredis_connection_with __method__, name, key, config: config, after_change: after_change, expires_in: expires_in
+    def kredis_float(name, key: nil, default: nil, config: :shared, after_change: nil, expires_in: nil)
+      kredis_connection_with __method__, name, key, default: default, config: config, after_change: after_change, expires_in: expires_in
     end
 
     def kredis_enum(name, key: nil, values:, default:, config: :shared, after_change: nil)
       kredis_connection_with __method__, name, key, values: values, default: default, config: config, after_change: after_change
     end
 
-    def kredis_json(name, key: nil, config: :shared, after_change: nil, expires_in: nil)
-      kredis_connection_with __method__, name, key, config: config, after_change: after_change, expires_in: expires_in
+    def kredis_json(name, key: nil, default: nil, config: :shared, after_change: nil, expires_in: nil)
+      kredis_connection_with __method__, name, key, default: default, config: config, after_change: after_change, expires_in: expires_in
     end
 
-    def kredis_list(name, key: nil, typed: :string, config: :shared, after_change: nil)
-      kredis_connection_with __method__, name, key, typed: typed, config: config, after_change: after_change
+    def kredis_list(name, key: nil, default: nil, typed: :string, config: :shared, after_change: nil)
+      kredis_connection_with __method__, name, key, default: default, typed: typed, config: config, after_change: after_change
     end
 
-    def kredis_unique_list(name, limit: nil, key: nil, typed: :string, config: :shared, after_change: nil)
-      kredis_connection_with __method__, name, key, limit: limit, typed: typed, config: config, after_change: after_change
+    def kredis_unique_list(name, limit: nil, key: nil, default: nil, typed: :string, config: :shared, after_change: nil)
+      kredis_connection_with __method__, name, key, default: default, limit: limit, typed: typed, config: config, after_change: after_change
     end
 
-    def kredis_set(name, key: nil, typed: :string, config: :shared, after_change: nil)
-      kredis_connection_with __method__, name, key, typed: typed, config: config, after_change: after_change
+    def kredis_set(name, key: nil, default: nil, typed: :string, config: :shared, after_change: nil)
+      kredis_connection_with __method__, name, key, default: default, typed: typed, config: config, after_change: after_change
     end
 
     def kredis_slot(name, key: nil, config: :shared, after_change: nil)
@@ -62,16 +62,16 @@ def kredis_slots(name, available:, key: nil, config: :shared, after_change: nil)
       kredis_connection_with __method__, name, key, available: available, config: config, after_change: after_change
     end
 
-    def kredis_counter(name, key: nil, config: :shared, after_change: nil, expires_in: nil)
-      kredis_connection_with __method__, name, key, config: config, after_change: after_change, expires_in: expires_in
+    def kredis_counter(name, key: nil, default: nil, config: :shared, after_change: nil, expires_in: nil)
+      kredis_connection_with __method__, name, key, default: default, config: config, after_change: after_change, expires_in: expires_in
     end
 
-    def kredis_hash(name, key: nil, typed: :string, config: :shared, after_change: nil)
-      kredis_connection_with __method__, name, key, typed: typed, config: config, after_change: after_change
+    def kredis_hash(name, key: nil, default: nil, typed: :string, config: :shared, after_change: nil)
+      kredis_connection_with __method__, name, key, default: default, typed: typed, config: config, after_change: after_change
     end
 
-    def kredis_boolean(name, key: nil, config: :shared, after_change: nil, expires_in: nil)
-      kredis_connection_with __method__, name, key, config: config, after_change: after_change, expires_in: expires_in
+    def kredis_boolean(name, key: nil, default: nil, config: :shared, after_change: nil, expires_in: nil)
+      kredis_connection_with __method__, name, key, default: default, config: config, after_change: after_change, expires_in: expires_in
     end
 
     private
@@ -84,6 +84,7 @@ def kredis_connection_with(method, name, key, **options)
           if instance_variable_defined?(ivar_symbol)
             instance_variable_get(ivar_symbol)
           else
+            options.merge!(default: kredis_default_evaluated(options[:default])) if options[:default]
             new_type = Kredis.send(type, kredis_key_evaluated(key) || kredis_key_for_attribute(name), **options)
             instance_variable_set ivar_symbol,
               after_change ? enrich_after_change_with_record_access(new_type, after_change) : new_type
@@ -115,4 +116,12 @@ def enrich_after_change_with_record_access(type, original_after_change)
       when Symbol then Kredis::Types::CallbacksProxy.new(type, ->(_) { send(original_after_change) })
       end
     end
+
+  def kredis_default_evaluated(default)
+    case default
+    when Proc   then Proc.new { default.call(self) }
+    when Symbol then send(default)
+    else default
+    end
+  end
 end

lib/kredis/type/json.rb

@@ -8,7 +8,11 @@ def type
       end
 
       def cast_value(value)
-        JSON.load(value)
+        if value.is_a? Hash
+          value.stringify_keys
+        else
+          JSON.load(value)
+        end
       end
 
       def serialize(value)

lib/kredis/types.rb

@@ -1,8 +1,8 @@
 module Kredis::Types
   autoload :CallbacksProxy, "kredis/types/callbacks_proxy"
 
-  def proxy(key, config: :shared, after_change: nil)
-    type_from(Proxy, config, key, after_change: after_change)
+  def proxy(key, default: nil, config: :shared, after_change: nil)
+    type_from(Proxy, config, key, after_change: after_change, default: default)
   end
 
 
@@ -39,36 +39,36 @@ def json(key, default: nil, config: :shared, after_change: nil, expires_in: nil)
   end
 
 
-  def counter(key, expires_in: nil, config: :shared, after_change: nil)
-    type_from(Counter, config, key, after_change: after_change, expires_in: expires_in)
+  def counter(key, expires_in: nil, default: nil, config: :shared, after_change: nil)
+    type_from(Counter, config, key, after_change: after_change, default: default, expires_in: expires_in)
   end
 
   def cycle(key, values:, expires_in: nil, config: :shared, after_change: nil)
     type_from(Cycle, config, key, after_change: after_change, values: values, expires_in: expires_in)
   end
 
-  def flag(key, config: :shared, after_change: nil, expires_in: nil)
-    type_from(Flag, config, key, after_change: after_change, expires_in: expires_in)
+  def flag(key, default: nil, config: :shared, after_change: nil, expires_in: nil)
+    type_from(Flag, config, key, after_change: after_change, default: default, expires_in: expires_in)
   end
 
   def enum(key, values:, default:, config: :shared, after_change: nil)
     type_from(Enum, config, key, after_change: after_change, values: values, default: default)
   end
 
-  def hash(key, typed: :string, config: :shared, after_change: nil)
-    type_from(Hash, config, key, after_change: after_change, typed: typed)
+  def hash(key, typed: :string, default: nil, config: :shared, after_change: nil)
+    type_from(Hash, config, key, after_change: after_change, default: default, typed: typed)
   end
 
-  def list(key, typed: :string, config: :shared, after_change: nil)
-    type_from(List, config, key, after_change: after_change, typed: typed)
+  def list(key, default: nil, typed: :string, config: :shared, after_change: nil)
+    type_from(List, config, key, after_change: after_change, default: default, typed: typed)
   end
 
-  def unique_list(key, typed: :string, limit: nil, config: :shared, after_change: nil)
-    type_from(UniqueList, config, key, after_change: after_change, typed: typed, limit: limit)
+  def unique_list(key, default: nil, typed: :string, limit: nil, config: :shared, after_change: nil)
+    type_from(UniqueList, config, key, after_change: after_change, default: default, typed: typed, limit: limit)
   end
 
-  def set(key, typed: :string, config: :shared, after_change: nil)
-    type_from(Set, config, key, after_change: after_change, typed: typed)
+  def set(key, default: nil, typed: :string, config: :shared, after_change: nil)
+    type_from(Set, config, key, after_change: after_change, default: default, typed: typed)
   end
 
   def slot(key, config: :shared, after_change: nil)

lib/kredis/types/before_methods_hook.rb

@@ -0,0 +1,11 @@
+module Kredis::Types::BeforeMethodsHook
+  def before_methods(*methods, invoke:)
+    prepend(@method_wrapper = Module.new) unless @method_wrapper
+    methods.each do |method_name|
+      @method_wrapper.send(:define_method, method_name) do |*args, **kwargs, &block|
+        send invoke
+        super(*args, **kwargs, &block)
+      end
+    end
+  end
+end

lib/kredis/types/counter.rb

@@ -1,20 +1,16 @@
 class Kredis::Types::Counter < Kredis::Types::Proxying
   proxying :multi, :set, :incrby, :decrby, :get, :del, :exists?
 
+  before_methods :value, :increment, :decrement, invoke: :set_default
+
   attr_accessor :expires_in
 
   def increment(by: 1)
-    multi do
-      set 0, ex: expires_in, nx: true
-      incrby by
-    end[-1]
+    incrby by
   end
 
   def decrement(by: 1)
-    multi do
-      set 0, ex: expires_in, nx: true
-      decrby by
-    end[-1]
+    decrby by
   end
 
   def value
@@ -24,4 +20,9 @@ def value
   def reset
     del
   end
+
+  private
+    def set_default
+      set(default.to_i, ex: expires_in, nx: true) unless exists?
+    end
 end

lib/kredis/types/enum.rb

@@ -3,7 +3,7 @@
 class Kredis::Types::Enum < Kredis::Types::Proxying
   proxying :set, :get, :del, :exists?
 
-  attr_accessor :values, :default
+  attr_accessor :values
 
   def initialize(...)
     super
@@ -17,7 +17,7 @@ def value=(value)
   end
 
   def value
-    get || default
+    get || initialize_with_default
   end
 
   def reset
@@ -31,4 +31,8 @@ def define_predicates_for_values
         define_singleton_method("#{defined_value}!") { self.value = defined_value }
       end
     end
+
+    def initialize_with_default
+      default { |default_value| self.value = default_value }
+    end
 end

lib/kredis/types/flag.rb

@@ -8,10 +8,18 @@ def mark(expires_in: nil, force: true)
   end
 
   def marked?
-    exists?
+    exists? || exists_after_default_value?
   end
 
   def remove
     del
   end
+
+  private
+    def exists_after_default_value?
+      !!default do |default_value|
+        mark if default_value
+        !!default_value
+      end
+    end
 end

lib/kredis/types/hash.rb

@@ -3,6 +3,8 @@
 class Kredis::Types::Hash < Kredis::Types::Proxying
   proxying :hget, :hset, :hmget, :hdel, :hgetall, :hkeys, :hvals, :del, :exists?
 
+  before_methods :[], :[]=, :entries, :keys, :values, :values_at, :delete, invoke: :set_default
+
   attr_accessor :typed
 
   def [](key)
@@ -42,4 +44,9 @@ def keys
   def values
     strings_to_types(hvals || [], typed)
   end
+
+  private
+    def set_default
+      update(**default) unless exists? || default.nil?
+    end
 end

lib/kredis/types/list.rb

@@ -4,7 +4,8 @@ class Kredis::Types::List < Kredis::Types::Proxying
   attr_accessor :typed
 
   def elements
-    strings_to_types(lrange(0, -1) || [], typed)
+    value = exists? ? lrange(0, -1) : initialize_with_default || []
+    strings_to_types(value, typed)
   end
   alias to_a elements
 
@@ -24,4 +25,12 @@ def append(*elements)
   def clear
     del
   end
+
+  private
+    def initialize_with_default
+      default do |default_value|
+        append(default_value)
+        elements
+      end
+    end
 end

lib/kredis/types/proxying.rb

@@ -1,14 +1,18 @@
 require "active_support/core_ext/module/delegation"
+require "kredis/types/before_methods_hook"
 
 class Kredis::Types::Proxying
-  attr_accessor :proxy, :key
+  extend Kredis::Types::BeforeMethodsHook
+
+  attr_accessor :proxy, :redis, :key
 
   def self.proxying(*commands)
     delegate *commands, to: :proxy
   end
 
   def initialize(redis, key, **options)
-    @key = key
+    @redis, @key = redis, key
+    @default = options.delete(:default)
     @proxy = Kredis::Types::Proxy.new(redis, key)
     options.each { |key, value| send("#{key}=", value) }
   end
@@ -19,4 +23,14 @@ def failsafe(returning: nil, &block)
 
   private
     delegate :type_to_string, :string_to_type, :types_to_strings, :strings_to_types, to: :Kredis
+
+    def default
+      if @default.is_a?(Proc) && block_given?
+        yield(@default.call)
+      elsif @default.is_a?(Proc)
+        @default.call
+      else
+        @default
+      end
+    end
 end