Contents

# rubocop:disable all

module Familia::Features

  module Quantization

    module ClassMethods
      # Generates a quantized timestamp based on the given parameters.
      #
      # @param quantum [Integer, Array, nil] The time quantum in seconds or an array of [quantum, pattern].
      # @param pattern [String, nil] The strftime pattern to format the timestamp.
      # @param now [Time, nil] The current time (default: Familia.now).
      # @return [Integer, String] A unix timestamp or formatted timestamp string.
      #
      # This method rounds the current time to the nearest quantum and optionally formats it
      # according to the given pattern. It's useful for creating time-based buckets
      # or keys with reduced granularity.
      #
      # @example
      #   User.qstamp(1.hour, '%Y%m%d%H')  # Returns a string like "2023060114" for 2:30 PM
      #   User.qstamp(10.minutes)  # Returns an integer timestamp rounded to the nearest 10 minutes
      #   User.qstamp([1.hour, '%Y%m%d%H'])  # Same as the first example
      #
      # @raise [ArgumentError] If quantum is not positive
      #
      def qstamp(quantum = nil, pattern: nil, time: nil)
        # Handle default values and array input
        if quantum.is_a?(Array)
          quantum, pattern = quantum
        end
        quantum ||= @opts[:quantize] || ttl || 10.minutes

        # Validate quantum
        unless quantum.is_a?(Numeric) && quantum.positive?
          raise ArgumentError, "Quantum must be positive (#{quantum.inspect} given)"
        end

        # Call Familia.qstamp with our processed parameters
        Familia.qstamp(quantum, pattern: pattern, time: time)
      end
    end

    def self.included base
      Familia.ld "[#{base}] Loaded #{self}"
      base.extend ClassMethods
    end

    def qstamp(quantum = nil, pattern: nil, time: nil)
      self.class.qstamp(quantum || ttl, pattern: pattern, time: time)
    end

    extend ClassMethods

    Familia::Base.add_feature self, :quantization
  end
end

Version data entries

4 entries across 4 versions & 1 rubygems

Version	Path
familia-1.0.0.pre.rc7	lib/familia/features/quantization.rb
familia-1.0.0.pre.rc6	lib/familia/features/quantization.rb
familia-1.0.0.pre.rc5	lib/familia/features/quantization.rb
familia-1.0.0.pre.rc4	lib/familia/features/quantization.rb