redis-objects-periodical 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a9f66a51e7b0786e3207daefee47c2ae7a792b512229e6d7b5ac6c40ed4b956
-  data.tar.gz: 38806524dc3b3d67ab62d76c1b3416518eecb2ba301d66c08eea29f3f88da13e
+  metadata.gz: be8af0088e6ff4a0d8e8e26185acd940452d08f123b1820eef198f636db7b1f7
+  data.tar.gz: 3cd7b2fbb4ea2fd2bd6e53c3d0798ec4bb1e93b89760a4a6fec48b0215fc072e
 SHA512:
-  metadata.gz: b3b3f462b12369d577165c968ce73fdd8d17589654ce553d0a98bf5922ad5a075808154590d7e9dc1b89555438f24bbd3052a2085b17980eb08251ec570cf3df
-  data.tar.gz: f8ef4de2a9b40c7efada26b858edd6cb546693d18e0d2b075b4f80c26f879e06fa79308bc9b9a2fcb509fc5556a4cc3afd6584c799c6725fe87074ff21e1f3d3
+  metadata.gz: 284c3aca951719e4efd85195dbd6457061732a1507821b173cf8e61e879e75fc751694b2540b6716b087ec311ad71c3c9e6d59a29f46f25552e0ae5586baf715
+  data.tar.gz: 5fafbcc175c1303535e6e23ee9df14f41a1db5006515416171f15e73f38ee5192e6a0b9adfa6fdfb1ef94c351768bd543c7d9b08e1ce8d1e1de0ac84f621ae1b

data/.rubocop_todo.yml

@@ -10,16 +10,17 @@
 # Configuration parameters: AllowedConstants.
 Style/Documentation:
   Exclude:
-    - 'spec/**/*'
-    - 'test/**/*'
-    - 'lib/redis-objects-periodical.rb'
-    - 'lib/redis/base_counter_object.rb'
-    - 'lib/redis/base_hash_key_object.rb'
-    - 'lib/redis/base_set_object.rb'
-    - 'lib/redis/recurring_at_intervals.rb'
-    - 'lib/redis/recurring_at_intervals/annual.rb'
-    - 'lib/redis/recurring_at_intervals/daily.rb'
-    - 'lib/redis/recurring_at_intervals/hourly.rb'
-    - 'lib/redis/recurring_at_intervals/minutely.rb'
-    - 'lib/redis/recurring_at_intervals/monthly.rb'
-    - 'lib/redis/recurring_at_intervals/weekly.rb'
+    - "spec/**/*"
+    - "test/**/*"
+    - "lib/redis-objects-periodical.rb"
+    - "lib/redis/base_counter_object.rb"
+    - "lib/redis/base_hash_key_object.rb"
+    - "lib/redis/base_set_object.rb"
+    - "lib/redis/base_value_object.rb"
+    - "lib/redis/recurring_at_intervals.rb"
+    - "lib/redis/recurring_at_intervals/annual.rb"
+    - "lib/redis/recurring_at_intervals/daily.rb"
+    - "lib/redis/recurring_at_intervals/hourly.rb"
+    - "lib/redis/recurring_at_intervals/minutely.rb"
+    - "lib/redis/recurring_at_intervals/monthly.rb"
+    - "lib/redis/recurring_at_intervals/weekly.rb"

data/CHANGELOG.md

@@ -1,5 +1,45 @@
 # Change log
 
+## v0.7.0 (Feb 12, 2023)
+
+### Feature
+
+- [#128](https://github.com/ryz310/redis-object-daily-counter/pull/128) Support`Redis::Value` as a periodical object ([@ryz310](https://github.com/ryz310))
+
+> The periodical values automatically switches the save destination when the date changes.
+>
+> ```rb
+> class Homepage
+>   include Redis::Objects
+>
+>   daily_value :cache, expireat: -> { Time.now + 2_678_400 } # about a month
+>
+>   def id
+>     1
+>   end
+> end
+>
+> homepage = Homepage.new
+>
+> # 2021-04-01
+> homepage.cache.value = 'a'
+>
+> # 2021-04-02 (next day)
+> homepage.cache.value = 'b'
+>
+> # 2021-04-03 (next day)
+> homepage.cache.value = 'c'
+>
+> homepage.cache[Date.new(2021, 4, 1)] # => 'a'
+> homepage.cache[Date.new(2021, 4, 1), 3] # => ['a', 'b', 'c']
+> homepage.cache[Date.new(2021, 4, 1)..Date.new(2021, 4, 2)] # => ['a', 'b']
+>
+> homepage.cache.delete_at(Date.new(2021, 4, 1))
+> homepage.cache.range(Date.new(2021, 4, 1), Date.new(2021, 4, 3)) # => [nil, 'b', 'c']
+> homepage.cache.at(Date.new(2021, 4, 2)) # => #<Redis::Value key="homepage:1:cache:2021-04-02">
+> homepage.cache.at(Date.new(2021, 4, 2)).value # 'b'
+> ```
+
 ## v0.6.0 (Feb 12, 2023)
 
 ### Feature

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    redis-objects-periodical (0.6.0)
-      redis-objects
+    redis-objects-periodical (0.7.0)
+      redis-objects (~> 1.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -32,6 +32,7 @@ class Homepage
   daily_counter :pv, expireat: -> { Time.now + 2_678_400 } # about a month
   daily_hash_key :browsing_history, expireat: -> { Time.now + 2_678_400 } # about a month
   daily_set :dau, expireat: -> { Time.now + 2_678_400 } # about a month
+  daily_value :cache, expireat: -> { Time.now + 2_678_400 } # about a month
 
   def id
     1
@@ -99,6 +100,46 @@ homepage.pv.at(Date.new(2021, 4, 2)).value # 2
 - `minutely_counter`
   - Key format: `model_name:id:field_name:yyyy-mm-ddThh:mi`
 
+### Periodical Values
+
+The periodical values automatically switches the save destination when the date changes.
+
+```rb
+# 2021-04-01
+homepage.cache.value = 'a'
+
+# 2021-04-02 (next day)
+homepage.cache.value = 'b'
+
+# 2021-04-03 (next day)
+homepage.cache.value = 'c'
+
+homepage.cache[Date.new(2021, 4, 1)] # => 'a'
+homepage.cache[Date.new(2021, 4, 1), 3] # => ['a', 'b', 'c']
+homepage.cache[Date.new(2021, 4, 1)..Date.new(2021, 4, 2)] # => ['a', 'b']
+
+homepage.cache.delete_at(Date.new(2021, 4, 1))
+homepage.cache.range(Date.new(2021, 4, 1), Date.new(2021, 4, 3)) # => [nil, 'b', 'c']
+homepage.cache.at(Date.new(2021, 4, 2)) # => #<Redis::Value key="homepage:1:cache:2021-04-02">
+homepage.cache.at(Date.new(2021, 4, 2)).value # 'b'
+```
+
+#### Periodical Values Family
+
+- `annual_value`
+  - Key format: `model_name:id:field_name:yyyy`
+  - Redis is a highly volatile key-value store, so I don't recommend using it.
+- `monthly_value`
+  - Key format: `model_name:id:field_name:yyyy-mm`
+- `weekly_value`
+  - Key format: `model_name:id:field_name:yyyyWw`
+- `daily_value`
+  - Key format: `model_name:id:field_name:yyyy-mm-dd`
+- `hourly_value`
+  - Key format: `model_name:id:field_name:yyyy-mm-ddThh`
+- `minutely_value`
+  - Key format: `model_name:id:field_name:yyyy-mm-ddThh:mi`
+
 ### Periodical Hashes
 
 The periodical hashes also automatically switches the save destination when the date changes.

data/lib/redis/base_value_object.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+class Redis
+  module BaseValueObject
+    private
+
+    def get_redis_object(key)
+      Redis::Value.new(key)
+    end
+
+    def get_value_from_redis(key)
+      unmarshal(redis.get(key))
+    end
+
+    def get_values_from_redis(keys)
+      redis.mget(*keys).map { |v| unmarshal(v) }
+    end
+
+    def delete_from_redis(key)
+      redis.del(key)
+    end
+
+    def empty_value
+      []
+    end
+  end
+end

data/lib/redis/objects/periodical/version.rb

@@ -3,7 +3,7 @@
 class Redis
   module Objects
     module Periodical
-      VERSION = '0.6.0'
+      VERSION = '0.7.0'
     end
   end
 end

data/lib/redis/objects/periodical_values.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'redis/periodical_value'
+
+Redis::PERIODICALS.each do |periodical| # rubocop:disable Metrics/BlockLength
+  new_module = Module.new
+  new_module.module_eval <<~RUBY, __FILE__, __LINE__ + 1
+    def self.included(klass)
+      klass.extend ClassMethods
+    end
+
+    module ClassMethods
+      def #{periodical}_value(name, options = {})
+        redis_objects[name.to_sym] = options.merge(:type => :value)
+
+        mod = Module.new do
+          define_method(name) do
+            Redis::#{periodical.capitalize}Value.new(
+              redis_field_key(name), redis_field_redis(name), redis_options(name)
+            )
+          end
+          define_method(:"#\{name}=") do |value|
+            public_send(name).value = value
+          end
+        end
+
+        if options[:global]
+          extend mod
+
+          # dispatch to class methods
+          define_method(name) do
+            self.class.public_send(name)
+          end
+          define_method(:"#\{name}=") do |value|
+            self.class.public_send(:"#\{name}=", value)
+          end
+        else
+          include mod
+        end
+      end
+    end
+  RUBY
+  Redis::Objects.const_set("#{periodical.capitalize}Values", new_module)
+end

data/lib/redis/periodical_value.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "#{File.dirname(__FILE__)}/recurring_at_intervals"
+require "#{File.dirname(__FILE__)}/base_value_object"
+
+Redis::PERIODICALS.each do |periodical|
+  require "#{File.dirname(__FILE__)}/recurring_at_intervals/#{periodical}"
+
+  new_class = Class.new(Redis::Value) do
+    include Redis::RecurringAtIntervals
+    include Redis::BaseValueObject
+    include const_get("Redis::RecurringAtIntervals::#{periodical.capitalize}")
+  end
+  Redis.const_set("#{periodical.capitalize}Value", new_class)
+end

data/lib/redis-objects-periodical.rb

@@ -9,6 +9,7 @@ class Redis
     autoload :"#{periodical.capitalize}Counter", 'redis/periodical_counter'
     autoload :"#{periodical.capitalize}HashKey", 'redis/periodical_hash_key'
     autoload :"#{periodical.capitalize}Set", 'redis/periodical_set'
+    autoload :"#{periodical.capitalize}Value", 'redis/periodical_value'
   end
 
   module Objects
@@ -16,6 +17,7 @@ class Redis
       autoload :"#{periodical.capitalize}Counters", 'redis/objects/periodical_counters'
       autoload :"#{periodical.capitalize}Hashes", 'redis/objects/periodical_hashes'
       autoload :"#{periodical.capitalize}Sets", 'redis/objects/periodical_sets'
+      autoload :"#{periodical.capitalize}Values", 'redis/objects/periodical_values'
     end
 
     class << self
@@ -29,6 +31,7 @@ class Redis
           klass.send :include, const_get("Redis::Objects::#{periodical.capitalize}Counters")
           klass.send :include, const_get("Redis::Objects::#{periodical.capitalize}Hashes")
           klass.send :include, const_get("Redis::Objects::#{periodical.capitalize}Sets")
+          klass.send :include, const_get("Redis::Objects::#{periodical.capitalize}Values")
         end
       end
     end

data/redis-objects-periodical.gemspec

@@ -29,7 +29,7 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.7.0'
 
-  spec.add_dependency 'redis-objects'
+  spec.add_dependency 'redis-objects', '~> 1.0'
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: redis-objects-periodical
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - ryz310
@@ -14,16 +14,16 @@ dependencies:
   name: redis-objects
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 description: Extends Redis::Objects to switch automatically the save destination within
   Redis on changing dates.
 email:
@@ -54,13 +54,16 @@ files:
 - lib/redis/base_counter_object.rb
 - lib/redis/base_hash_key_object.rb
 - lib/redis/base_set_object.rb
+- lib/redis/base_value_object.rb
 - lib/redis/objects/periodical/version.rb
 - lib/redis/objects/periodical_counters.rb
 - lib/redis/objects/periodical_hashes.rb
 - lib/redis/objects/periodical_sets.rb
+- lib/redis/objects/periodical_values.rb
 - lib/redis/periodical_counter.rb
 - lib/redis/periodical_hash_key.rb
 - lib/redis/periodical_set.rb
+- lib/redis/periodical_value.rb
 - lib/redis/recurring_at_intervals.rb
 - lib/redis/recurring_at_intervals/annual.rb
 - lib/redis/recurring_at_intervals/daily.rb