redis-objects-periodical 0.4.0

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+Gem::Specification.new do |spec|
+  spec.name          = 'redis-objects-daily-counter'
+  spec.version       = '0.4.0'
+  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'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/ryz310/redis-objects-daily-counter'
+  spec.metadata['changelog_uri'] = 'https://github.com/ryz310/redis-objects-daily-counter/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

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

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: redis-objects-periodical
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- ryz310
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-07-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis-objects
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Extends Redis::Objects to switch automatically the save destination within
+  Redis on changing dates.
+email:
+- ryz310@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gem_comet.yml"
+- ".github/dependabot.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Dockerfile
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- docker-compose.yml
+- 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/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-periodical
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/ryz310/redis-objects-periodical
+  source_code_uri: https://github.com/ryz310/redis-objects-periodical
+  changelog_uri: https://github.com/ryz310/redis-objects-periodical/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Extends Redis::Objects as periodical.
+test_files: []