timerizer 0.0.1

data/lib/timerizer.rb

@@ -0,0 +1,336 @@
+require 'date'
+
+# Represents a relative amount of time. For example, `5 days`, `4 years`, and `5 years, 4 hours, 3 minutes, 2 seconds` are all RelativeTimes.
+class RelativeTime
+  # All potential units. Key is the unit name, and the value is its plural form.
+  @@units = {
+    :second     => :seconds,
+    :minute     => :minutes,
+    :hour       => :hours,
+    :day        => :days,
+    :week       => :weeks,
+    :month      => :months,
+    :year       => :years,
+    :decade     => :decades,
+    :century    => :centuries,
+    :millennium => :millennia
+  }
+
+  # Unit values in seconds. If a unit is not present in this hash, it is assumed to be in the {@@in_months} hash.
+  @@in_seconds = {
+      :second => 1,
+      :minute => 60,
+      :hour   => 3600,
+      :day    => 86400,
+      :week   => 604800
+  }
+
+  # Unit values in months. If a unit is not present in this hash, it is assumed to be in the {@@in_seconds} hash.
+  @@in_months = {
+    :month      => 1,
+    :year       => 12,
+    :decade     => 120,
+    :century    => 1200,
+    :millennium => 12000
+  }
+
+  # Average amount of time in a given unit. Used internally within the {#average} and {#unaverage} methods.
+  @@average_seconds = {
+    :month => 2629746,
+    :year  => 31556952
+  }
+
+  # Initialize a new instance of RelativeTime.
+  # @overload new(hash)
+  #   @param [Hash] units The base units to initialize with
+  #   @option units [Fixnum] :seconds The number of seconds
+  #   @option units [Fixnum] :months The number of months
+  # @overload new(count, unit)
+  #   @param [Fixnum] count The number of units to initialize with
+  #   @param [Symbol] unit The unit to initialize. See {@@units}
+  def initialize(count = 0, unit = :second)
+    if(count.is_a? Hash)
+      @seconds = count[:seconds] || 0
+      @months = count[:months] || 0
+      return
+    end
+
+    @seconds = 0
+    @months = 0
+
+    if(@@in_seconds.has_key?(unit))
+      @seconds = count * @@in_seconds.fetch(unit)
+    elsif(@@in_months.has_key?(unit))
+      @months = count * @@in_months.fetch(unit)
+    end
+  end
+
+  # Return the number of base units in a RelativeTime.
+  # @param [Symbol] unit The unit to return, either :seconds or :months
+  # @return [Fixnum] The requested unit count
+  # @raise [ArgumentError] Unit requested was not :seconds or :months
+  def get(unit)
+    return @seconds if unit == :seconds
+    return @months if unit == :months
+    raise ArgumentError
+  end
+
+  # Determines the time between RelativeTime and the given time.
+  # @param [Time] time The initial time.
+  # @return [Time] The difference between the current RelativeTime and the given time
+  # @example 5 hours before January 1st, 2000 at noon
+  #   5.minutes.before(Time.now(2000, 1, 1, 12, 00, 00))
+  #     => 2000-01-01 11:55:00 -0800
+  # @see #ago
+  # @see #after
+  # @see #from_now
+  def before(time)
+    time = time.to_time - @seconds
+
+    new_month = time.month - @months
+    new_year = time.year
+    while new_month < 1
+      new_month += 12
+      new_year -= 1
+    end
+    if(Date.valid_date?(new_year, new_month, time.day))
+      new_day = time.day
+    else
+      new_day = Date.new(new_year, new_month).days_in_month
+    end
+
+    new_time = Time.new(
+      new_year, new_month, new_day,
+      time.hour, time.min, time.sec
+    )
+    Time.at(new_time.to_i, time.nsec/1000)
+  end
+
+  # Return the time between the RelativeTime and the current time.
+  # @return [Time] The difference between the current RelativeTime and Time#now
+  # @see #before
+  def ago
+    self.before(Time.now)
+  end
+
+  # Return the time after the given time according to the current RelativeTime.
+  # @param [Time] time The starting time
+  # @return [Time] The time after the current RelativeTime and the given time
+  # @see #before
+  def after(time)
+    time = time.to_time + @seconds
+
+    new_year = time.year
+    new_month = time.month + @months
+    while new_month > 12
+      new_year += 1
+      new_month -= 12
+    end
+    if(Date.valid_date?(new_year, new_month, time.day))
+      new_day = time.day
+    else
+      new_day = Date.new(new_year, new_month).days_in_month
+    end
+
+
+    new_time = Time.new(
+      new_year, new_month, new_day,
+      time.hour, time.min, time.sec
+    )
+    Time.at(new_time.to_i, time.nsec/1000.0)
+  end
+
+  # Return the time after the current time and the RelativeTime.
+  # @return [Time] The time after the current time
+  def from_now
+    self.after(Time.now)
+  end
+
+  @@units.each do |unit, plural|
+    in_method = "in_#{plural}"
+    count_method = plural
+    superior_unit = @@units.keys.index(unit) + 1
+
+    define_method(in_method) do
+      if(@@in_seconds.has_key?(unit))
+        @seconds / @@in_seconds[unit]
+      elsif(@@in_months.has_key?(unit))
+        @months / @@in_months[unit]
+      end
+    end
+
+    define_method(count_method) do
+      in_superior = "in_#{@@units.values[superior_unit]}"
+      count_superior = @@units.keys[superior_unit]
+
+      time = self.send(in_method)
+      if(@@units.length > superior_unit)
+        time -= self.send(in_superior).send(count_superior).send(in_method)
+      end
+      time
+    end
+  end
+
+  # Average second-based units to month-based units.
+  # @return [RelativeTime] The averaged RelativeTime
+  # @example
+  #   5.weeks.average
+  #     => 1 month, 4 days, 13 hours, 30 minutes, 54 seconds
+  # @see #average!
+  # @see #unaverage
+  def average
+    return self unless @seconds > 0
+
+    months = (@seconds / @@average_seconds[:month])
+    seconds = @seconds - months.months.unaverage.get(:seconds)
+    RelativeTime.new({
+      :seconds => seconds,
+      :months => months + @months
+    })
+  end
+
+  # Destructively average second-based units to month-based units.
+  # @see #average
+  def average!
+    averaged = self.average
+    @seconds = averaged.get(:seconds)
+    @months = averaged.get(:months)
+    self
+  end
+
+  # Average month-based units to second-based units.
+  # @return [RelativeTime] the unaveraged RelativeTime.
+  # @example
+  #   1.month.unaverage
+  #     => 4 weeks, 2 days, 10 hours, 29 minutes, 6 seconds
+  # @see #average
+  # @see #unaverage!
+  def unaverage
+    seconds = @@average_seconds[:month] * @months
+    seconds += @seconds
+    RelativeTime.new({:seconds => seconds})
+  end
+
+  # Destructively average month-based units to second-based units.
+  # @see #unaverage
+  def unaverage!
+    unaveraged = self.average
+    @seconds = unaverage.get(:seconds)
+    @months = unaverage.get(:months)
+    self
+  end
+
+  # Add two {RelativeTime}s together.
+  # @raise ArgumentError Argument isn't a {RelativeTime}
+  # @see #-
+  def +(time)
+    raise ArgumentError unless time.is_a?(RelativeTime)
+    RelativeTime.new({
+      :seconds => @seconds + time.get(:seconds),
+      :months => @months + time.get(:months)
+    })
+  end
+
+  # Find the difference between two {RelativeTime}s.
+  # @raise ArgumentError Argument isn't a {RelativeTime}
+  # @see #+
+  def -(time)
+    raise ArgumentError unless time.is_a?(RelativeTime)
+    RelativeTime.new({
+      :seconds => @seconds - time.get(:seconds),
+      :months => @months - time.get(:months)
+    })
+  end
+
+  # Convert {RelativeTime} to a human-readable format.
+  # @example
+  #   (14.months 49.hours).to_s
+  #     => 2 years, 2 months, 3 days, 1 hour
+  def to_s
+    times = [] 
+
+    @@units.each do |unit, plural|
+      time = self.respond_to?(plural) ? self.send(plural) : 0
+      times << [time, (time != 1) ? plural : unit] if time > 0
+    end
+
+    times.map do |time|
+      time.join(' ')
+    end.reverse.join(', ')
+  end
+end
+# {Time} class monkeywrenched with {RelativeTime} support.
+class Time
+  add = instance_method(:+)
+  define_method(:+) do |time|
+    if(time.class == RelativeTime)
+      time.after(self)
+    else
+      add.bind(self).(time)
+    end
+  end
+
+  subtract = instance_method(:-)
+  define_method(:-) do |time|
+    if(time.class == RelativeTime)
+      time.before(self)
+    else
+      subtract.bind(self).(time)
+    end
+  end
+
+  # Convert {Time} to {Date}.
+  # @return [Date] {Time} as {Date}
+  # @example
+  #   Time.new(2000, 1, 1, 12, 30).to_date
+  #     => #<Date: 2000-01-01 ((2451545j,0s,0n),+0s,2299161j)>
+  def to_date
+    Date.new(self.year, self.month, self.day)
+  end
+
+  # Convert self to {Time}.
+  # @see Date#to_time
+  def to_time
+    self
+  end
+end
+
+# {Date} class monkeywrenched with {RelativeTime} helpers.
+class Date
+  # Return the number of days in a given month.
+  # @return [Fixnum] Number of days in the month of the {Date}.
+  # @example
+  #   Date.new(2000, 2).days_in_month
+  #     => 29
+  def days_in_month
+    days_in_feb = (not self.leap?) ? 28 : 29
+    number_of_days = [
+      31,  days_in_feb,  31,  30,  31,  30,
+      31,  31,           30,  31,  30,  31
+    ]
+
+    number_of_days.fetch(self.month - 1)
+  end
+
+  # Return self as {Date}.
+  # @see Time#to_date
+  def to_date
+    self
+  end
+end
+
+# Monkeywrenched {Fixnum} class enabled to return {RelativeTime} objects.
+# @example
+#   5.minutes
+#     => 5 minutes
+# @see RelativeTime @@units
+class Fixnum
+  units  = RelativeTime.class_variable_get(:@@units)
+  units.each do |unit, plural|
+    define_method(unit) do |added_time = RelativeTime.new|
+      time = RelativeTime.new(self, unit)
+      time + added_time
+    end
+    alias_method(plural, unit)
+  end
+end

metadata

@@ -0,0 +1,46 @@
+--- !ruby/object:Gem::Specification
+name: timerizer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Kyle Lacy
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-17 00:00:00.000000000 Z
+dependencies: []
+description: A simple set of Rails-like time helpers
+email: kylelacy@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/timerizer.rb
+homepage: http://github.com/kylewlacy/timerizer
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Rails time helpers... without the Rails
+test_files: []
+has_rdoc: