tempora 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8c7a7d910796a3c678069364a7b4ecd5ec076047510fb0ae12214a360849bcb
-  data.tar.gz: a1c2639026325e11d15985a329169ad1d09d80e4eff423f45c14a64c5b5d3e6a
+  metadata.gz: 829bad4acfece329fa910614c27da039a46933e2da7246d091df30fd1463cee5
+  data.tar.gz: 6d2d1e27e904b76d6f2661fb8328b8a3bceb83c142ffe376f76d261e66fdea07
 SHA512:
-  metadata.gz: c71c88d86a13485cdbf93c793052ad8a04b9a4e76383d31f8e187f09a8e0a76b9f1e69b1cb70db6c58f8a40270586eccb20a2e6ed3bf77705e4c106e385bb4e6
-  data.tar.gz: 3e8e137aca28e67bf704a99c42205a63052bdeec22c9ddb2d17a0dd29ca061db4809a7667cb8be12f7be474745e37c735e209d5a1fe48aa72aa394bb52dc9b97
+  metadata.gz: ff6c9aec13bd9eb4ce86085043887f750101a722d64a30d6b8af43e7e52962632e91b8dbb74561cf0df02d05acb7928234ab892eafbe3fe1930bbe6f05cf64cb
+  data.tar.gz: '08cc00d8bbac916783277803a0ef3279a7db353bd3a9e5743d2a0576824939e0b1b1039bea1143120068cf995060ac4bb0d827b553d73a2a368e902d69bbd40a'

data/lib/_timespan.rb

@@ -0,0 +1,106 @@
+require 'date'
+
+class TimeSpan
+  include Comparable
+
+  attr_reader :start_date, :end_date
+
+  def initialize(start_date, end_date)
+    @start_date = TimeSpan.from_date_like(start_date)
+    @end_date = TimeSpan.from_date_like(end_date)
+
+    raise ArgumentError, "start_date must be before end_date" if @start_date > @end_date
+  end
+
+  def self.from_date_like(date_like)
+    if date_like.respond_to?(:year) && date_like.respond_to?(:month) && date_like.respond_to?(:day)
+      Date.new(date_like.year, date_like.month, date_like.day)
+    else
+      raise ArgumentError, "Invalid date-like object: #{date_like.inspect}"
+    end
+  end
+
+  def range
+    @start_date..@end_date
+  end
+
+  def duration
+    (@end_date - @start_date).to_i + 1
+  end
+
+  def overlaps?(other)
+    @start_date <= other.end_date && @end_date >= other.start_date
+  end
+
+  def contains?(date)
+    range.cover?(TimeSpan.from_date_like(date))
+  end
+
+  def shift(days)
+    TimeSpan.new(@start_date + days, @end_date + days)
+  end
+
+  def intersection(other)
+    return nil unless overlaps?(other)
+
+    new_start = [@start_date, other.start_date].max
+    new_end = [@end_date, other.end_date].min
+
+    TimeSpan.new(new_start, new_end)
+  end
+
+  def <=>(other)
+    start_date <=> other.start_date
+  end
+
+  def to_s
+    "#{@start_date} to #{@end_date} (#{duration} days)"
+  end
+end
+# 🔹 TimeSpan Class (For Any Date Range)
+#
+# This will handle custom periods, like fiscal years, school semesters, or project timelines.
+#
+# 🔹 How TimeSpan Works
+#
+# ✅ Define Any Custom Date Range
+# fiscal_year = TimeSpan.new(Date.new(2024, 4, 1), Date.new(2025, 3, 31))
+# puts fiscal_year.to_s
+# # => "2024-04-01 to 2025-03-31 (365 days)"
+# ✅ Check Overlaps
+# q2 = TimeSpan.new(Date.new(2024, 4, 1), Date.new(2024, 6, 30))
+# q3 = TimeSpan.new(Date.new(2024, 7, 1), Date.new(2024, 9, 30))
+# puts q2.overlaps?(q3)  # => false
+# ✅ Check If a Date Falls Within the Range
+# semester = TimeSpan.new(Date.new(2024, 8, 1), Date.new(2024, 12, 15))
+# puts semester.contains?(Date.new(2024, 9, 10))  # => true
+# puts semester.contains?(Date.new(2025, 1, 1))   # => false
+# ✅ Shift Date Ranges
+# event = TimeSpan.new(Date.new(2024, 6, 10), Date.new(2024, 6, 15))
+# puts event.shift(7).to_s
+# # => "2024-06-17 to 2024-06-22 (6 days)"
+# 
+# 🔹 Why TimeSpan is Useful
+#
+# ✅ Handles custom time ranges (fiscal years, semesters, event durations)
+# ✅ Works alongside Week, Month, Quarter, and Year
+# ✅ Supports overlapping checks and shifts
+#
+# 🔹 How intersection Works
+#
+# ✅ Two Overlapping Periods
+# t1 = TimeSpan.new(Date.new(2024, 3, 1), Date.new(2024, 3, 20))
+# t2 = TimeSpan.new(Date.new(2024, 3, 10), Date.new(2024, 3, 25))
+#
+# overlap = t1.intersection(t2)
+# puts overlap.to_s
+# # => "2024-03-10 to 2024-03-20 (11 days)"
+# ✅ No Overlap Returns nil
+# t3 = TimeSpan.new(Date.new(2024, 4, 1), Date.new(2024, 4, 10))
+# puts t1.intersection(t3)
+# # => nil
+# 🔹 Why intersection is Useful
+#
+# ✅ Find common time slots (e.g., two employees' available time)
+# ✅ Determine overlapping project phases
+# ✅ Works with any time period comparisons

data/lib/month.rb

@@ -1,10 +1,10 @@
 require_relative 'timeperiod'
-require_relative 'initialization'
-require_relative 'week'
+require_relative 'tempora/initialization'
+require_relative 'tempora/has_weeks'
 
-class Month
-  include TimePeriod
+class Month < TimePeriod
   extend Initialization
+  include HasWeeks
 
   def initialize(year, month)
     @year   = Integer(year)
@@ -38,10 +38,6 @@ class Month
     self.class.from(start_date.prev_month) # @start_date << 1
   end
   
-  def weeks
-    Week.from(start_date)..Week.from(end_date)
-  end
-  
   alias_method :month, :number
   alias_method :succ, :next
   alias_method :pred, :prev

data/lib/quarter.rb

@@ -1,11 +1,12 @@
 require_relative 'timeperiod'
-require_relative 'initialization'
-require_relative 'month'
-require_relative 'week'
+require_relative 'tempora/initialization'
+require_relative 'tempora/has_months'
+require_relative 'tempora/has_weeks'
 
-class Quarter
-  include TimePeriod
+class Quarter < TimePeriod
   extend Initialization
+  include HasMonths
+  include HasWeeks
 
   def initialize(year, quarter)
     @year   = Integer(year)
@@ -34,19 +35,14 @@ class Quarter
   
   alias_method :succ, :next
   alias_method :pred, :prev
-    
-  def months
-    Month.from(start_date)..Month.from(end_date)
-  end
-  
-  def weeks
-    Week.from(start_date)..Week.from(end_date)
-  end
   
   private
   
   def self.initialization_parameter(date)
-    quarter = ((date.month - 1) / 3) + 1
-    [date.year, quarter]
+    [date.year, quarter_from_date(date)]
+  end
+  
+  def self.quarter_from_date(date)
+    ((date.month - 1) / 3) + 1
   end
 end

data/lib/tempora/has_months.rb

@@ -0,0 +1,9 @@
+module HasMonths
+  def months
+    Month.from(start_date)..Month.from(end_date)
+  end
+
+  def each_month(&block)
+    months.each(&block)
+  end
+end

data/lib/tempora/has_weeks.rb

@@ -0,0 +1,11 @@
+require 'week'
+
+module HasWeeks
+  def weeks
+    Week.from(start_date)..Week.from(end_date)
+  end
+
+  def each_week(&block)
+    weeks.each(&block)
+  end
+end

data/lib/{initialization.rb → tempora/initialization.rb}

@@ -1,5 +1,3 @@
-require 'date'
-
 module Initialization
   def now
     from Time.now
@@ -8,7 +6,7 @@ module Initialization
   alias_method :current, :now
   
   def from(date)
-    new *initialization_parameter(date.to_date)
+    new(*initialization_parameter(date.to_date))
   end
   
   private

data/lib/tempora/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Tempora
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/lib/tempora.rb

@@ -2,7 +2,6 @@
 
 require_relative "tempora/version"
 require_relative "timeperiod"
-require_relative "initialization"
 require_relative "year"
 require_relative "month"
 require_relative "week"

data/lib/timeperiod.rb

@@ -1,9 +1,14 @@
 require 'date'
 
-module TimePeriod
+class TimePeriod
   include Comparable
   
   attr_reader :start_date, :end_date, :year, :number
+  
+  def initialize(start_date, end_date)
+    @start_date = start_date
+    @end_date   = end_date
+  end
 
   def range
     start_date..end_date
@@ -26,7 +31,7 @@ module TimePeriod
   end
 
   def overlaps?(other)
-    range.overlaps?(other.range)
+    range.overlap?(other.range)
   end
 
   def intersection(other)
@@ -35,7 +40,7 @@ module TimePeriod
     new_start = [start_date, other.start_date].max
     new_end = [end_date, other.end_date].min
 
-    self.class.new(new_start, new_end)
+    TimePeriod.new(new_start, new_end)
   end
   
   def <=>(other)
@@ -45,5 +50,4 @@ module TimePeriod
   alias_method :begin, :start_date
   alias_method :end, :end_date
   alias_method :length, :duration
-end
-
+end

data/lib/week.rb

@@ -1,18 +1,17 @@
 require_relative 'timeperiod'
-require_relative 'initialization'
+require_relative 'tempora/initialization'
 
-class Week
-  include TimePeriod
+class Week < TimePeriod
   extend Initialization
     
   def initialize(year, week)
     @year   = Integer(year)
-    @number = Integer(week).clamp(1,52)
+    @number = Integer(week)
     
     @start_date = Date.commercial(@year, @number, 1)
     @end_date   = start_date + 6
   end
-  
+    
   def id(seperator="-")
     "#{year}#{seperator}W#{format('%02d', number)}"
   end
@@ -31,10 +30,10 @@ class Week
   
   alias_method :succ, :next
   alias_method :pred, :prev
-  
+    
   private
   
   def self.initialization_parameter(date)
-    [date.year, date.cweek]
+    [date.cwyear, date.cweek]
   end
 end

data/lib/year.rb

@@ -1,11 +1,12 @@
 require_relative 'timeperiod'
-require_relative 'initialization'
-require_relative 'month'
-require_relative 'week'
+require_relative 'tempora/initialization'
+require_relative 'tempora/has_months'
+require_relative 'tempora/has_weeks'
 
-class Year
-  include TimePeriod
+class Year < TimePeriod
   extend Initialization
+  include HasWeeks
+  include HasMonths
   
   def initialize(year)
     @year = Integer(year)
@@ -29,14 +30,6 @@ class Year
   def prev
     self.class.new(year - 1)
   end
-  
-  def months
-    Month.new(year, 1)..Month.new(year, 12)
-  end
-  
-  def weeks
-    Week.from(start_date)..Week.from(end_date)
-  end
 
   alias_method :succ, :next
   alias_method :pred, :prev

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tempora
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Max Power
@@ -20,10 +20,13 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- lib/initialization.rb
+- lib/_timespan.rb
 - lib/month.rb
 - lib/quarter.rb
 - lib/tempora.rb
+- lib/tempora/has_months.rb
+- lib/tempora/has_weeks.rb
+- lib/tempora/initialization.rb
 - lib/tempora/version.rb
 - lib/timeperiod.rb
 - lib/week.rb