redis-objects-daily-counter 0.2.0 → 0.4.1

data/lib/redis/recurring_at_intervals/weekly.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+class Redis
+  module RecurringAtIntervals
+    module Weekly
+      private
+
+      def redis_daily_field_key(date_or_time)
+        date_key = date_or_time.strftime('%YW%W')
+        [original_key, date_key].flatten.join(':')
+      end
+
+      def next_key(date, length = 1)
+        date + 7 * length
+      end
+    end
+  end
+end

data/lib/redis/recurring_at_intervals.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+class Redis
+  module RecurringAtIntervals
+    def initialize(key, *args)
+      @original_key = key
+      super(redis_daily_field_key(current_time), *args)
+    end
+
+    attr_reader :original_key
+
+    def [](date_or_time, length = nil)
+      if date_or_time.is_a? Range
+        range(date_or_time.first, date_or_time.max)
+      elsif length
+        case length <=> 0
+        when 1  then range(date_or_time, next_key(date_or_time, length - 1))
+        when 0  then empty_value
+        when -1 then nil  # Ruby does this (a bit weird)
+        end
+      else
+        get_value_from_redis(redis_daily_field_key(date_or_time))
+      end
+    end
+    alias slice []
+
+    def delete_at(date_or_time)
+      delete_from_redis(redis_daily_field_key(date_or_time))
+    end
+
+    def range(start_date_or_time, end_date_or_time)
+      keys = []
+      date_or_time = start_date_or_time
+
+      loop do
+        break if date_or_time > end_date_or_time
+
+        keys << redis_daily_field_key(date_or_time)
+        date_or_time = next_key(date_or_time)
+      end
+
+      get_values_from_redis(keys)
+    end
+
+    def at(date_or_time)
+      get_redis_object(redis_daily_field_key(date_or_time))
+    end
+
+    def current_time
+      @current_time ||= Time.respond_to?(:current) ? Time.current : Time.now
+    end
+
+    private
+
+    def get_redis_object(_key)
+      raise 'not implemented'
+    end
+
+    def get_value_from_redis(_key)
+      raise 'not implemented'
+    end
+
+    def get_values_from_redis(_keys)
+      raise 'not implemented'
+    end
+
+    def delete_from_redis(_key)
+      raise 'not implemented'
+    end
+
+    def redis_daily_field_key(_date_or_time)
+      raise 'not implemented'
+    end
+
+    def next_key(_date, _length = 1)
+      raise 'not implemented'
+    end
+  end
+end

data/lib/redis-objects-periodical.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'redis-objects'
+
+class Redis
+  PERIODICALS = %w[daily weekly monthly annual hourly minutely].freeze
+
+  PERIODICALS.each do |periodical|
+    autoload :"#{periodical.capitalize}Counter", 'redis/periodical_counter'
+    autoload :"#{periodical.capitalize}HashKey", 'redis/periodical_hash_key'
+    autoload :"#{periodical.capitalize}Set", 'redis/periodical_set'
+  end
+
+  module Objects
+    PERIODICALS.each do |periodical|
+      autoload :"#{periodical.capitalize}Counters", 'redis/objects/periodical_counters'
+      autoload :"#{periodical.capitalize}Hashes", 'redis/objects/periodical_hashes'
+      autoload :"#{periodical.capitalize}Sets", 'redis/objects/periodical_sets'
+    end
+
+    class << self
+      alias original_included included
+
+      def included(klass)
+        original_included(klass)
+
+        # Pull in each object type
+        PERIODICALS.each do |periodical|
+          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")
+        end
+      end
+    end
+  end
+end

data/redis-objects-daily-counter.gemspec

@@ -1,15 +1,16 @@
 # frozen_string_literal: true
 
-require_relative 'lib/redis/objects/daily-counter/version'
-
 Gem::Specification.new do |spec|
   spec.name          = 'redis-objects-daily-counter'
-  spec.version       = Redis::Objects::Daily::Counter::VERSION
+  spec.version       = '0.4.1'
   spec.authors       = ['ryz310']
   spec.email         = ['ryz310@gmail.com']
 
   spec.summary       = 'Daily counter within Redis::Objects'
   spec.description   = 'Daily counter within Redis::Objects. Works with any class or ORM.'
+  spec.post_install_message = 'The redis-objects-daily-counter gem has been deprecated and has '\
+                           'been replaced by redis-objects-periodical. Please switch to '\
+                           'redis-objects-periodical as soon as possible.'
   spec.homepage      = 'https://github.com/ryz310/redis-objects-daily-counter'
   spec.license       = 'MIT'
 
@@ -26,7 +27,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 2.6.0'
+  spec.required_ruby_version = '>= 2.7.0'
 
   spec.add_dependency 'redis-objects'
 

data/redis-objects-periodical.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative 'lib/redis/objects/periodical/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'redis-objects-periodical'
+  spec.version       = Redis::Objects::Periodical::VERSION
+  spec.authors       = ['ryz310']
+  spec.email         = ['ryz310@gmail.com']
+
+  spec.summary       = 'Extends Redis::Objects as periodical.'
+  spec.description   = 'Extends Redis::Objects to switch automatically the save destination ' \
+                       'within Redis on changing dates.'
+  spec.homepage      = 'https://github.com/ryz310/redis-objects-periodical'
+  spec.license       = 'MIT'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/ryz310/redis-objects-periodical'
+  spec.metadata['changelog_uri'] = 'https://github.com/ryz310/redis-objects-periodical/blob/master/CHANGELOG.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 2.7.0'
+
+  spec.add_dependency 'redis-objects'
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: redis-objects-daily-counter
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.1
 platform: ruby
 authors:
 - ryz310
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-09-20 00:00:00.000000000 Z
+date: 2022-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: redis-objects
@@ -33,6 +33,7 @@ extra_rdoc_files: []
 files:
 - ".circleci/config.yml"
 - ".gem_comet.yml"
+- ".github/dependabot.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -48,22 +49,26 @@ files:
 - bin/console
 - bin/setup
 - docker-compose.yml
-- lib/redis-objects-daily-counter.rb
-- lib/redis/annual_counter.rb
+- lib/redis-objects-periodical.rb
 - lib/redis/base_counter_object.rb
-- lib/redis/daily_counter.rb
-- lib/redis/hourly_counter.rb
-- lib/redis/minutely_counter.rb
-- lib/redis/monthly_counter.rb
-- lib/redis/objects/annual_counters.rb
-- lib/redis/objects/daily-counter/version.rb
-- lib/redis/objects/daily_counters.rb
-- lib/redis/objects/hourly_counters.rb
-- lib/redis/objects/minutely_counters.rb
-- lib/redis/objects/monthly_counters.rb
-- lib/redis/objects/weekly_counters.rb
-- lib/redis/weekly_counter.rb
+- lib/redis/base_hash_key_object.rb
+- lib/redis/base_set_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/periodical_counter.rb
+- lib/redis/periodical_hash_key.rb
+- lib/redis/periodical_set.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
 - redis-objects-daily-counter.gemspec
+- redis-objects-periodical.gemspec
 homepage: https://github.com/ryz310/redis-objects-daily-counter
 licenses:
 - MIT
@@ -71,7 +76,9 @@ metadata:
   homepage_uri: https://github.com/ryz310/redis-objects-daily-counter
   source_code_uri: https://github.com/ryz310/redis-objects-daily-counter
   changelog_uri: https://github.com/ryz310/redis-objects-daily-counter/blob/master/CHANGELOG.md
-post_install_message:
+post_install_message: The redis-objects-daily-counter gem has been deprecated and
+  has been replaced by redis-objects-periodical. Please switch to redis-objects-periodical
+  as soon as possible.
 rdoc_options: []
 require_paths:
 - lib
@@ -79,14 +86,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Daily counter within Redis::Objects

data/lib/redis/annual_counter.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-require "#{File.dirname(__FILE__)}/base_counter_object"
-
-class Redis
-  class AnnualCounter < BaseCounterObject
-    private
-
-    def redis_daily_field_key(date_or_time)
-      date_key = date_or_time.strftime('%Y')
-      [original_key, date_key].flatten.join(':')
-    end
-
-    def next_key(date, length)
-      date.next_year(length - 1)
-    end
-  end
-end

data/lib/redis/daily_counter.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-require "#{File.dirname(__FILE__)}/base_counter_object"
-
-class Redis
-  class DailyCounter < BaseCounterObject
-    private
-
-    def redis_daily_field_key(date_or_time)
-      date_key = date_or_time.strftime('%Y-%m-%d')
-      [original_key, date_key].flatten.join(':')
-    end
-
-    def next_key(date, length)
-      date + length - 1
-    end
-  end
-end

data/lib/redis/hourly_counter.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-require "#{File.dirname(__FILE__)}/base_counter_object"
-
-class Redis
-  class HourlyCounter < BaseCounterObject
-    def range(start_time, end_time)
-      keys =
-        (start_time.to_i..end_time.to_i)
-        .step(3600)
-        .map { |integer| redis_daily_field_key(Time.at(integer)) }
-      redis.mget(*keys).map(&:to_i)
-    end
-
-    private
-
-    def redis_daily_field_key(time)
-      time_key = time.strftime('%Y-%m-%dT%H')
-      [original_key, time_key].flatten.join(':')
-    end
-
-    def next_key(time, length)
-      time + 3600 * (length - 1)
-    end
-  end
-end

data/lib/redis/minutely_counter.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-require "#{File.dirname(__FILE__)}/base_counter_object"
-
-class Redis
-  class MinutelyCounter < BaseCounterObject
-    def range(start_time, end_time)
-      keys =
-        (start_time.to_i..end_time.to_i)
-        .step(60)
-        .map { |integer| redis_daily_field_key(Time.at(integer)) }
-      redis.mget(*keys).map(&:to_i)
-    end
-
-    private
-
-    def redis_daily_field_key(time)
-      time_key = time.strftime('%Y-%m-%dT%H:%M')
-      [original_key, time_key].flatten.join(':')
-    end
-
-    def next_key(time, length)
-      time + 60 * (length - 1)
-    end
-  end
-end

data/lib/redis/monthly_counter.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-require "#{File.dirname(__FILE__)}/base_counter_object"
-
-class Redis
-  class MonthlyCounter < BaseCounterObject
-    private
-
-    def redis_daily_field_key(date_or_time)
-      date_key = date_or_time.strftime('%Y-%m')
-      [original_key, date_key].flatten.join(':')
-    end
-
-    def next_key(date, length)
-      date.next_month(length - 1)
-    end
-  end
-end

data/lib/redis/objects/annual_counters.rb

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-require 'redis/annual_counter'
-class Redis
-  module Objects
-    module AnnualCounters
-      class << self
-        def included(klass)
-          klass.extend ClassMethods
-        end
-      end
-
-      module ClassMethods
-        def annual_counter(name, options = {}) # rubocop:disable Metrics/MethodLength
-          options[:start] ||= 0
-          options[:type]  ||= (options[:start]).zero? ? :increment : :decrement
-          redis_objects[name.to_sym] = options.merge(type: :counter)
-
-          mod = Module.new do
-            define_method(name) do
-              Redis::AnnualCounter.new(
-                redis_field_key(name), redis_field_redis(name), redis_options(name)
-              )
-            end
-          end
-
-          if options[:global]
-            extend mod
-
-            # dispatch to class methods
-            define_method(name) do
-              self.class.public_send(name)
-            end
-          else
-            include mod
-          end
-        end
-      end
-    end
-  end
-end

data/lib/redis/objects/daily_counters.rb

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-require 'redis/daily_counter'
-class Redis
-  module Objects
-    module DailyCounters
-      class << self
-        def included(klass)
-          klass.extend ClassMethods
-        end
-      end
-
-      module ClassMethods
-        def daily_counter(name, options = {}) # rubocop:disable Metrics/MethodLength
-          options[:start] ||= 0
-          options[:type]  ||= (options[:start]).zero? ? :increment : :decrement
-          redis_objects[name.to_sym] = options.merge(type: :counter)
-
-          mod = Module.new do
-            define_method(name) do
-              Redis::DailyCounter.new(
-                redis_field_key(name), redis_field_redis(name), redis_options(name)
-              )
-            end
-          end
-
-          if options[:global]
-            extend mod
-
-            # dispatch to class methods
-            define_method(name) do
-              self.class.public_send(name)
-            end
-          else
-            include mod
-          end
-        end
-      end
-    end
-  end
-end

data/lib/redis/objects/hourly_counters.rb

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-require 'redis/hourly_counter'
-class Redis
-  module Objects
-    module HourlyCounters
-      class << self
-        def included(klass)
-          klass.extend ClassMethods
-        end
-      end
-
-      module ClassMethods
-        def hourly_counter(name, options = {}) # rubocop:disable Metrics/MethodLength
-          options[:start] ||= 0
-          options[:type]  ||= (options[:start]).zero? ? :increment : :decrement
-          redis_objects[name.to_sym] = options.merge(type: :counter)
-
-          mod = Module.new do
-            define_method(name) do
-              Redis::HourlyCounter.new(
-                redis_field_key(name), redis_field_redis(name), redis_options(name)
-              )
-            end
-          end
-
-          if options[:global]
-            extend mod
-
-            # dispatch to class methods
-            define_method(name) do
-              self.class.public_send(name)
-            end
-          else
-            include mod
-          end
-        end
-      end
-    end
-  end
-end

data/lib/redis/objects/minutely_counters.rb

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-require 'redis/minutely_counter'
-class Redis
-  module Objects
-    module MinutelyCounters
-      class << self
-        def included(klass)
-          klass.extend ClassMethods
-        end
-      end
-
-      module ClassMethods
-        def minutely_counter(name, options = {}) # rubocop:disable Metrics/MethodLength
-          options[:start] ||= 0
-          options[:type]  ||= (options[:start]).zero? ? :increment : :decrement
-          redis_objects[name.to_sym] = options.merge(type: :counter)
-
-          mod = Module.new do
-            define_method(name) do
-              Redis::MinutelyCounter.new(
-                redis_field_key(name), redis_field_redis(name), redis_options(name)
-              )
-            end
-          end
-
-          if options[:global]
-            extend mod
-
-            # dispatch to class methods
-            define_method(name) do
-              self.class.public_send(name)
-            end
-          else
-            include mod
-          end
-        end
-      end
-    end
-  end
-end

data/lib/redis/objects/monthly_counters.rb

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-require 'redis/daily_counter'
-class Redis
-  module Objects
-    module MonthlyCounters
-      class << self
-        def included(klass)
-          klass.extend ClassMethods
-        end
-      end
-
-      module ClassMethods
-        def monthly_counter(name, options = {}) # rubocop:disable Metrics/MethodLength
-          options[:start] ||= 0
-          options[:type]  ||= (options[:start]).zero? ? :increment : :decrement
-          redis_objects[name.to_sym] = options.merge(type: :counter)
-
-          mod = Module.new do
-            define_method(name) do
-              Redis::MonthlyCounter.new(
-                redis_field_key(name), redis_field_redis(name), redis_options(name)
-              )
-            end
-          end
-
-          if options[:global]
-            extend mod
-
-            # dispatch to class methods
-            define_method(name) do
-              self.class.public_send(name)
-            end
-          else
-            include mod
-          end
-        end
-      end
-    end
-  end
-end

data/lib/redis/objects/weekly_counters.rb

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-require 'redis/weekly_counter'
-class Redis
-  module Objects
-    module WeeklyCounters
-      class << self
-        def included(klass)
-          klass.extend ClassMethods
-        end
-      end
-
-      module ClassMethods
-        def weekly_counter(name, options = {}) # rubocop:disable Metrics/MethodLength
-          options[:start] ||= 0
-          options[:type]  ||= (options[:start]).zero? ? :increment : :decrement
-          redis_objects[name.to_sym] = options.merge(type: :counter)
-
-          mod = Module.new do
-            define_method(name) do
-              Redis::WeeklyCounter.new(
-                redis_field_key(name), redis_field_redis(name), redis_options(name)
-              )
-            end
-          end
-
-          if options[:global]
-            extend mod
-
-            # dispatch to class methods
-            define_method(name) do
-              self.class.public_send(name)
-            end
-          else
-            include mod
-          end
-        end
-      end
-    end
-  end
-end

data/lib/redis/weekly_counter.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-require "#{File.dirname(__FILE__)}/base_counter_object"
-
-class Redis
-  class WeeklyCounter < BaseCounterObject
-    private
-
-    def redis_daily_field_key(date_or_time)
-      date_key = date_or_time.strftime('%YW%W')
-      [original_key, date_key].flatten.join(':')
-    end
-
-    def next_key(date, length)
-      date + 7 * (length - 1)
-    end
-  end
-end