tempora 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 829bad4acfece329fa910614c27da039a46933e2da7246d091df30fd1463cee5
-  data.tar.gz: 6d2d1e27e904b76d6f2661fb8328b8a3bceb83c142ffe376f76d261e66fdea07
+  metadata.gz: 1af2de3467a21cc28a33db0590f6934e0892cd6fca23f51183b16252b5f91016
+  data.tar.gz: d0365bb120ea9e0a42e768382136efff98ab25d88343c3876db913ceafd00a93
 SHA512:
-  metadata.gz: ff6c9aec13bd9eb4ce86085043887f750101a722d64a30d6b8af43e7e52962632e91b8dbb74561cf0df02d05acb7928234ab892eafbe3fe1930bbe6f05cf64cb
-  data.tar.gz: '08cc00d8bbac916783277803a0ef3279a7db353bd3a9e5743d2a0576824939e0b1b1039bea1143120068cf995060ac4bb0d827b553d73a2a368e902d69bbd40a'
+  metadata.gz: 5d21b7f7290f12435d5e77aae4221022dfa0db3b242ad3506edf9bdd446866bc1db576759ea91f5517c8a0b988f159d42517ddd1656beca618384cb46e66de0b
+  data.tar.gz: efbab1ef415bfb7eaa6ffd6877e07d16efe49219a3376437e451cf4a75c3c6076b2d8fc0f908042d0394fe2392ae144a2ef3859153fd120e3deda523c0192493

data/lib/month.rb

@@ -2,49 +2,51 @@ require_relative 'timeperiod'
 require_relative 'tempora/initialization'
 require_relative 'tempora/has_weeks'
 
-class Month < TimePeriod
-  extend Initialization
-  include HasWeeks
+module Tempora
+  class Month < TimePeriod
+    extend Initialization
+    include HasWeeks
 
-  def initialize(year, month)
-    @year   = Integer(year)
-    @number = Integer(month).clamp(1, 12)
+    def initialize(year, month)
+      @year   = Integer(year)
+      @number = Integer(month).clamp(1, 12)
     
-    @start_date = Date.new(@year, @number,  1)
-    @end_date   = Date.new(@year, @number, -1)
-  end
+      @start_date = Date.new(@year, @number,  1)
+      @end_date   = Date.new(@year, @number, -1)
+    end
   
-  def id(seperator="-")
-    "#{year}#{seperator}#{number.to_s.rjust(2, '0')}"
-  end
+    def id(seperator="-")
+      "#{year}#{seperator}#{number.to_s.rjust(2, '0')}"
+    end
 
-  def to_s
-    "#{month_name} #{year}"
-  end
+    def to_s
+      "#{month_name} #{year}"
+    end
 
-  def month_name
-    Date::MONTHNAMES[number]
-  end
+    def month_name
+      Date::MONTHNAMES[number]
+    end
   
-  def month_abbr
-    Date::ABBR_MONTHNAMES[number]
-  end
+    def month_abbr
+      Date::ABBR_MONTHNAMES[number]
+    end
   
-  def next
-    self.class.from(start_date.next_month) # @start_date >> 1
-  end
+    def next
+      self.class.from(start_date.next_month) # @start_date >> 1
+    end
   
-  def prev
-    self.class.from(start_date.prev_month) # @start_date << 1
-  end
+    def prev
+      self.class.from(start_date.prev_month) # @start_date << 1
+    end
   
-  alias_method :month, :number
-  alias_method :succ, :next
-  alias_method :pred, :prev
+    alias_method :month, :number
+    alias_method :succ, :next
+    alias_method :pred, :prev
 
-  private
+    private
   
-  def self.initialization_parameter(date)
-    [date.year, date.month]
+    def self.initialization_parameter(date)
+      [date.year, date.month]
+    end
   end
-end
+end

data/lib/quarter.rb

@@ -3,46 +3,48 @@ require_relative 'tempora/initialization'
 require_relative 'tempora/has_months'
 require_relative 'tempora/has_weeks'
 
-class Quarter < TimePeriod
-  extend Initialization
-  include HasMonths
-  include HasWeeks
+module Tempora
+  class Quarter < TimePeriod
+    extend Initialization
+    include HasMonths
+    include HasWeeks
 
-  def initialize(year, quarter)
-    @year   = Integer(year)
-    @number = Integer(quarter).clamp(1,4)
+    def initialize(year, quarter)
+      @year   = Integer(year)
+      @number = Integer(quarter).clamp(1,4)
 
-    start_month = (quarter - 1) * 3 + 1
-    @start_date = Date.new(year, start_month, 1)
-    @end_date   = @start_date.next_month(3).prev_day
-  end
+      start_month = (quarter - 1) * 3 + 1
+      @start_date = Date.new(year, start_month, 1)
+      @end_date   = @start_date.next_month(3).prev_day
+    end
   
-  def id(seperator="-")
-    "#{year}#{seperator}Q#{number}"
-  end
+    def id(seperator="-")
+      "#{year}#{seperator}Q#{number}"
+    end
 
-  def to_s
-    "Q#{number} #{year}"
-  end
+    def to_s
+      "Q#{number} #{year}"
+    end
   
-  def next
-    self.class.from(start_date >> 3)
-  end
+    def next
+      self.class.from(start_date >> 3)
+    end
 
-  def prev
-    self.class.from(start_date << 3)
-  end
+    def prev
+      self.class.from(start_date << 3)
+    end
   
-  alias_method :succ, :next
-  alias_method :pred, :prev
+    alias_method :succ, :next
+    alias_method :pred, :prev
   
-  private
+    private
   
-  def self.initialization_parameter(date)
-    [date.year, quarter_from_date(date)]
-  end
+    def self.initialization_parameter(date)
+      [date.year, quarter_from_date(date)]
+    end
   
-  def self.quarter_from_date(date)
-    ((date.month - 1) / 3) + 1
+    def self.quarter_from_date(date)
+      ((date.month - 1) / 3) + 1
+    end
   end
-end
+end

data/lib/tempora/has_days.rb

@@ -0,0 +1,11 @@
+module Tempora
+  module HasDays
+    def days
+      range.to_a
+    end
+
+    def each_day(&block)
+      range.each(&block)
+    end
+  end
+end

data/lib/tempora/has_months.rb

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

data/lib/tempora/has_weeks.rb

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

data/lib/tempora/version.rb

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

data/lib/tempora.rb

@@ -10,5 +10,6 @@ require_relative "quarter"
 
 module Tempora
   class Error < StandardError; end
-  # Your code goes here...
 end
+
+Object.send(:include, Tempora)

data/lib/timeperiod.rb

@@ -1,53 +1,53 @@
 require 'date'
+require_relative 'tempora/has_days'
 
-class TimePeriod
-  include Comparable
+module Tempora
+  class TimePeriod
+    include Comparable
+    include HasDays
   
-  attr_reader :start_date, :end_date, :year, :number
+    attr_reader :start_date, :end_date, :year, :number
   
-  def initialize(start_date, end_date)
-    @start_date = start_date
-    @end_date   = end_date
-  end
+    def initialize(start_date, end_date)
+      @start_date = start_date
+      @end_date   = end_date
+    end
 
-  def range
-    start_date..end_date
-  end
+    def range
+      start_date..end_date
+    end
 
-  def duration
-    (end_date - start_date).to_i + 1
-  end
-  
-  def days
-    range.to_a
-  end
+    def duration
+      (end_date - start_date).to_i + 1
+    end
 
-  def each_day(&block)
-    range.each(&block)
-  end
+    def contains?(date)
+      range.cover?(date)
+    end
 
-  def contains?(date)
-    range.cover?(date)
-  end
+    def overlaps?(other)
+      range.overlap?(other.range)
+    end
 
-  def overlaps?(other)
-    range.overlap?(other.range)
-  end
-
-  def intersection(other)
-    return nil unless overlaps?(other)
+    def intersection(other)
+      return nil unless overlaps?(other)
 
-    new_start = [start_date, other.start_date].max
-    new_end = [end_date, other.end_date].min
+      new_start = [start_date, other.start_date].max
+      new_end = [end_date, other.end_date].min
 
-    TimePeriod.new(new_start, new_end)
-  end
+      TimePeriod.new(new_start, new_end)
+    end
   
-  def <=>(other)
-    start_date <=> other.start_date
-  end
+    def shift(days)
+      TimePeriod.new(@start_date + days, @end_date + days)
+    end
+  
+    def <=>(other)
+      start_date <=> other.start_date
+    end
   
-  alias_method :begin, :start_date
-  alias_method :end, :end_date
-  alias_method :length, :duration
+    alias_method :begin, :start_date
+    alias_method :end, :end_date
+    alias_method :length, :duration
+  end
 end

data/lib/week.rb

@@ -1,39 +1,41 @@
 require_relative 'timeperiod'
 require_relative 'tempora/initialization'
 
-class Week < TimePeriod
-  extend Initialization
+module Tempora
+  class Week < TimePeriod
+    extend Initialization
     
-  def initialize(year, week)
-    @year   = Integer(year)
-    @number = Integer(week)
+    def initialize(year, week)
+      @year   = Integer(year)
+      @number = Integer(week)
     
-    @start_date = Date.commercial(@year, @number, 1)
-    @end_date   = start_date + 6
-  end
+      @start_date = Date.commercial(@year, @number, 1)
+      @end_date   = start_date + 6
+    end
     
-  def id(seperator="-")
-    "#{year}#{seperator}W#{format('%02d', number)}"
-  end
+    def id(seperator="-")
+      "#{year}#{seperator}W#{format('%02d', number)}"
+    end
   
-  def to_s
-    "Week #{number}, #{year}"
-  end
+    def to_s
+      "Week #{number}, #{year}"
+    end
   
-  def next
-    self.class.from(start_date + 7)
-  end
+    def next
+      self.class.from(start_date + 7)
+    end
 
-  def prev
-    self.class.from(start_date - 7)
-  end
+    def prev
+      self.class.from(start_date - 7)
+    end
   
-  alias_method :succ, :next
-  alias_method :pred, :prev
+    alias_method :succ, :next
+    alias_method :pred, :prev
     
-  private
+    private
   
-  def self.initialization_parameter(date)
-    [date.cwyear, date.cweek]
+    def self.initialization_parameter(date)
+      [date.cwyear, date.cweek]
+    end
   end
 end

data/lib/year.rb

@@ -3,34 +3,36 @@ require_relative 'tempora/initialization'
 require_relative 'tempora/has_months'
 require_relative 'tempora/has_weeks'
 
-class Year < TimePeriod
-  extend Initialization
-  include HasWeeks
-  include HasMonths
+module Tempora
+  class Year < TimePeriod
+    extend Initialization
+    include HasWeeks
+    include HasMonths
   
-  def initialize(year)
-    @year = Integer(year)
+    def initialize(year)
+      @year = Integer(year)
     
-    @start_date = Date.new(@year, 1, 1)
-    @end_date   = Date.new(@year, 12, 31)
-  end
+      @start_date = Date.new(@year, 1, 1)
+      @end_date   = Date.new(@year, 12, 31)
+    end
   
-  def id
-    year
-  end
+    def id
+      year
+    end
 
-  def to_s
-    year.to_s
-  end
+    def to_s
+      year.to_s
+    end
   
-  def next
-    self.class.new(year + 1)
-  end
+    def next
+      self.class.new(year + 1)
+    end
   
-  def prev
-    self.class.new(year - 1)
-  end
+    def prev
+      self.class.new(year - 1)
+    end
 
-  alias_method :succ, :next
-  alias_method :pred, :prev
+    alias_method :succ, :next
+    alias_method :pred, :prev
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: tempora
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Max Power
 bindir: exe
 cert_chain: []
-date: 2025-02-15 00:00:00.000000000 Z
+date: 2025-02-16 00:00:00.000000000 Z
 dependencies: []
 description: Tempora is a lightweight Ruby library for handling months, weeks, quarters,
   and years with intuitive date-based calculations and range support.
@@ -20,10 +20,10 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- lib/_timespan.rb
 - lib/month.rb
 - lib/quarter.rb
 - lib/tempora.rb
+- lib/tempora/has_days.rb
 - lib/tempora/has_months.rb
 - lib/tempora/has_weeks.rb
 - lib/tempora/initialization.rb

data/lib/_timespan.rb

@@ -1,106 +0,0 @@
-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