time_slice 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4851aac99fd986d96c2c2a739abdfea9cb81dbacf77ffed24ad2cd30bc3eb800
+  data.tar.gz: dabebf80b0466d88855f12761278754253052500c6cbd7e34a8ab4dafe2408b9
+SHA512:
+  metadata.gz: a28092c1182a9caf9c9cf773d166d78729ee41da41f6e8867461e71895db7ed5227d78c15b54358f57e7eb63cf1ada2ac47fc47ce3cd06574525a23f4fa1d1da
+  data.tar.gz: 475bf4fd88fa5f5077e36c9f943ae67cbfe68774190e51a0e28f002a39c6a59a7bd73e728d9146aff352502e9b84fa69c30c8c542e11653c0b38d35ed4e74767

data/lib/time_slice/duration.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+##
+# The Duration class extends ActiveSupport::Duration to provide a more
+# flexible way of specifying and working with time durations.
+#
+# It allows creation of duration objects from string representations
+# and provides methods for working with these durations.
+#
+# == Supported Units
+#
+# * s: seconds
+# * m: minutes
+# * h: hours
+# * d: days
+# * w: weeks
+# * mo: months
+# * y: years
+#
+# == Usage
+#
+#   Duration.new("5m")  # => 5 minutes
+#   Duration.new("2h")  # => 2 hours
+#   Duration.new("1d")  # => 1 day
+#
+# == Examples
+#
+#   duration = Duration.new("3h")
+#   duration.unit  # => :hours
+#   duration.period  # => "3h"
+#   duration * 2  # => 21600 (number of seconds in 6 hours)
+#
+class TimeSlice
+  class Duration < ActiveSupport::Duration
+    MAP = {
+      "s" => :seconds,
+      "m" => :minutes,
+      "h" => :hours,
+      "d" => :days,
+      "w" => :weeks,
+      "mo" => :months,
+      "y" => :years,
+    }.freeze
+
+    attr_reader :unit
+
+    def initialize(value)
+      raise ArgumentError, "Fractional values are not allowed" if value && value.include?('.')
+
+      if value.is_a?(String) && value.match(/([0-9]+)([a-z]+)/i).try(:length) == 3 && (@unit = MAP[$2])
+        value = $1.to_i
+        super(value * PARTS_IN_SECONDS[@unit], @unit => value)
+      else
+        raise ArgumentError, "#{value} is not a valid duration"
+      end
+    end
+
+    def period
+      @period ||= "#{value / 1.send(@unit)}#{@unit.to_s[0]}"
+    end
+  end
+end

data/lib/time_slice/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+class TimeSlice
+  VERSION = "0.1"
+end

data/lib/time_slice.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+require "active_support"
+require "active_support/duration"
+require "active_support/core_ext/integer/time"
+require "rounding"
+
+##
+# The TimeSlice class represents a range of time divided into equal intervals.
+# It provides functionality for creating, manipulating, and querying time ranges
+# with a specified duration.
+#
+# == Usage
+#
+# The TimeSlice class can be initialized with a period (interval duration) and
+# options for specifying the range:
+#
+#   TimeSlice.new(period, options = {})
+#
+# Where:
+# * +period+: A string representing the duration of each interval (e.g., "1h" for 1 hour, "30m" for 30 minutes)
+# * +options+: A hash that can include +:from+ (start time), +:to+ (end time), and/or +:length+ (number of intervals)
+#
+# == Examples
+#
+#   # Create a range from 12:00 to 15:00 with 1-hour intervals
+#   range = TimeSlice.new("1h", from: "2019-01-06 12:00", to: "2019-01-06 15:00")
+#
+#   range.length  # => 4 (12-13, 13-14, 14-15, 15-16)
+#   range.index("2019-01-06 14:30:00")  # => 2
+#   range.to_a.last  # => [2019-01-06 15:00:00, 2019-01-06 16:00:00]
+#
+#   # Iterate over the intervals
+#   range.each do |start_time, end_time|
+#     puts "#{start_time} - #{end_time}"
+#   end
+#
+#   # Get previous intervals
+#   prev_range = range.previous("2019-01-06 13:00", 2)
+#
+class TimeSlice
+  include Enumerable
+  autoload :Duration, "time_slice/duration"
+
+  attr_reader :duration, :from, :to
+
+  def initialize(period, options = {})
+    @duration = Duration.new(period)
+    parse_time_options(options)
+    set_time_range(options)
+  end
+
+  def period
+    duration.period
+  end
+
+  def length
+    ((@to - @from) / duration.to_i).to_i + 1
+  end
+
+  def range
+    from..to
+  end
+
+  def each
+    return to_enum(:each) unless block_given?
+    length.times { |i| yield(self[i]) }
+  end
+
+  def [](index)
+    return nil if index >= length
+    at = @from + (index * duration.to_i)
+    [at, at + duration.to_i]
+  end
+
+  def last
+    self[length - 1]
+  end
+
+  def slice(index, length)
+    length.times.map { |i| self[index + i] }.compact
+  end
+
+  def index(starts_at)
+    starts_at = parse_time(starts_at)
+    index = ((starts_at - @from) / duration.to_i).to_i
+    index >= 0 && index < length ? index : nil
+  end
+
+  def previous(starts_at, n)
+    starts_at = parse_time(starts_at) - duration.to_i
+    self.class.new(period, to: starts_at, length: n)
+  end
+
+  private
+
+  def parse_time_options(options)
+    [:from, :to].each do |key|
+      options[key] = parse_time(options[key]) if options[key]
+    end
+    options[:length] = options[:length].to_i if options[:length]
+  end
+
+  def parse_time(time)
+    time.is_a?(String) ? Time.zone.parse(time) : time
+  end
+
+  def set_time_range(options)
+    if options[:from] && options[:to]
+      @from = options[:from].floor_to(duration)
+      @to = options[:to].floor_to(duration)
+    elsif options[:from] && options[:length]
+      @from = options[:from].floor_to(duration)
+      @to = @from + (options[:length] * duration.to_i) - duration.to_i
+    elsif options[:to] && options[:length]
+      @to = options[:to].floor_to(duration)
+      @from = @to - (options[:length] * duration.to_i) + duration.to_i
+    elsif options.keys == [:length]
+      @to = Time.current.floor_to(duration)
+      @from = @to - (options[:length] * duration.to_i) + duration.to_i
+    elsif options.keys == [:from]
+      @from = options[:from].floor_to(duration)
+      @to = Time.current.floor_to(duration)
+    end
+  end
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: time_slice
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Kien La
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2024-07-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: rounding
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.24.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.24.1
+- !ruby/object:Gem::Dependency
+  name: minitest-focus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.2.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.2.1
+description: Time slice
+email:
+- la.kien@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/time_slice.rb
+- lib/time_slice/duration.rb
+- lib/time_slice/version.rb
+homepage: https://github.com/kla/time_slice
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.14
+signing_key: 
+specification_version: 4
+summary: A Ruby library for slicing time.
+test_files: []