core_ext 0.0.1

data/lib/core_ext/time/calculations.rb

@@ -0,0 +1,284 @@
+require 'core_ext/duration'
+require 'core_ext/time/conversions'
+require 'core_ext/time_with_zone'
+require 'core_ext/time/zones'
+require 'core_ext/date_and_time/calculations'
+require 'core_ext/date/calculations'
+
+class Time
+  include DateAndTime::Calculations
+
+  COMMON_YEAR_DAYS_IN_MONTH = [nil, 31, 28, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31]
+
+  class << self
+    # Overriding case equality method so that it returns true for CoreExt::TimeWithZone instances
+    def ===(other)
+      super || (self == Time && other.is_a?(CoreExt::TimeWithZone))
+    end
+
+    # Returns the number of days in the given month.
+    # If no year is specified, it will use the current year.
+    def days_in_month(month, year = current.year)
+      if month == 2 && ::Date.gregorian_leap?(year)
+        29
+      else
+        COMMON_YEAR_DAYS_IN_MONTH[month]
+      end
+    end
+
+    # Returns the number of days in the given year.
+    # If no year is specified, it will use the current year.
+    def days_in_year(year = current.year)
+      days_in_month(2, year) + 337
+    end
+
+    # Returns <tt>Time.zone.now</tt> when <tt>Time.zone</tt> or <tt>config.time_zone</tt> are set, otherwise just returns <tt>Time.now</tt>.
+    def current
+      ::Time.zone ? ::Time.zone.now : ::Time.now
+    end
+
+    # Layers additional behavior on Time.at so that CoreExt::TimeWithZone and DateTime
+    # instances can be used when called with a single argument
+    def at_with_coercion(*args)
+      return at_without_coercion(*args) if args.size != 1
+
+      # Time.at can be called with a time or numerical value
+      time_or_number = args.first
+
+      if time_or_number.is_a?(CoreExt::TimeWithZone) || time_or_number.is_a?(DateTime)
+        at_without_coercion(time_or_number.to_f).getlocal
+      else
+        at_without_coercion(time_or_number)
+      end
+    end
+    alias_method :at_without_coercion, :at
+    alias_method :at, :at_with_coercion
+  end
+
+  # Returns the number of seconds since 00:00:00.
+  #
+  #   Time.new(2012, 8, 29,  0,  0,  0).seconds_since_midnight # => 0.0
+  #   Time.new(2012, 8, 29, 12, 34, 56).seconds_since_midnight # => 45296.0
+  #   Time.new(2012, 8, 29, 23, 59, 59).seconds_since_midnight # => 86399.0
+  def seconds_since_midnight
+    to_i - change(:hour => 0).to_i + (usec / 1.0e+6)
+  end
+
+  # Returns the number of seconds until 23:59:59.
+  #
+  #   Time.new(2012, 8, 29,  0,  0,  0).seconds_until_end_of_day # => 86399
+  #   Time.new(2012, 8, 29, 12, 34, 56).seconds_until_end_of_day # => 41103
+  #   Time.new(2012, 8, 29, 23, 59, 59).seconds_until_end_of_day # => 0
+  def seconds_until_end_of_day
+    end_of_day.to_i - to_i
+  end
+
+  # Returns a new Time where one or more of the elements have been changed according
+  # to the +options+ parameter. The time options (<tt>:hour</tt>, <tt>:min</tt>,
+  # <tt>:sec</tt>, <tt>:usec</tt>, <tt>:nsec</tt>) reset cascadingly, so if only
+  # the hour is passed, then minute, sec, usec and nsec is set to 0. If the hour
+  # and minute is passed, then sec, usec and nsec is set to 0. The +options+
+  # parameter takes a hash with any of these keys: <tt>:year</tt>, <tt>:month</tt>,
+  # <tt>:day</tt>, <tt>:hour</tt>, <tt>:min</tt>, <tt>:sec</tt>, <tt>:usec</tt>
+  # <tt>:nsec</tt>. Pass either <tt>:usec</tt> or <tt>:nsec</tt>, not both.
+  #
+  #   Time.new(2012, 8, 29, 22, 35, 0).change(day: 1)              # => Time.new(2012, 8, 1, 22, 35, 0)
+  #   Time.new(2012, 8, 29, 22, 35, 0).change(year: 1981, day: 1)  # => Time.new(1981, 8, 1, 22, 35, 0)
+  #   Time.new(2012, 8, 29, 22, 35, 0).change(year: 1981, hour: 0) # => Time.new(1981, 8, 29, 0, 0, 0)
+  def change(options)
+    new_year  = options.fetch(:year, year)
+    new_month = options.fetch(:month, month)
+    new_day   = options.fetch(:day, day)
+    new_hour  = options.fetch(:hour, hour)
+    new_min   = options.fetch(:min, options[:hour] ? 0 : min)
+    new_sec   = options.fetch(:sec, (options[:hour] || options[:min]) ? 0 : sec)
+
+    if new_nsec = options[:nsec]
+      raise ArgumentError, "Can't change both :nsec and :usec at the same time: #{options.inspect}" if options[:usec]
+      new_usec = Rational(new_nsec, 1000)
+    else
+      new_usec  = options.fetch(:usec, (options[:hour] || options[:min] || options[:sec]) ? 0 : Rational(nsec, 1000))
+    end
+
+    if utc?
+      ::Time.utc(new_year, new_month, new_day, new_hour, new_min, new_sec, new_usec)
+    elsif zone
+      ::Time.local(new_year, new_month, new_day, new_hour, new_min, new_sec, new_usec)
+    else
+      raise ArgumentError, 'argument out of range' if new_usec >= 1000000
+      ::Time.new(new_year, new_month, new_day, new_hour, new_min, new_sec + (new_usec.to_r / 1000000), utc_offset)
+    end
+  end
+
+  # Uses Date to provide precise Time calculations for years, months, and days
+  # according to the proleptic Gregorian calendar. The +options+ parameter
+  # takes a hash with any of these keys: <tt>:years</tt>, <tt>:months</tt>,
+  # <tt>:weeks</tt>, <tt>:days</tt>, <tt>:hours</tt>, <tt>:minutes</tt>,
+  # <tt>:seconds</tt>.
+  #
+  #   Time.new(2015, 8, 1, 14, 35, 0).advance(seconds: 1) # => 2015-08-01 14:35:01 -0700
+  #   Time.new(2015, 8, 1, 14, 35, 0).advance(minutes: 1) # => 2015-08-01 14:36:00 -0700
+  #   Time.new(2015, 8, 1, 14, 35, 0).advance(hours: 1)   # => 2015-08-01 15:35:00 -0700
+  #   Time.new(2015, 8, 1, 14, 35, 0).advance(days: 1)    # => 2015-08-02 14:35:00 -0700
+  #   Time.new(2015, 8, 1, 14, 35, 0).advance(weeks: 1)   # => 2015-08-08 14:35:00 -0700
+  def advance(options)
+    unless options[:weeks].nil?
+      options[:weeks], partial_weeks = options[:weeks].divmod(1)
+      options[:days] = options.fetch(:days, 0) + 7 * partial_weeks
+    end
+
+    unless options[:days].nil?
+      options[:days], partial_days = options[:days].divmod(1)
+      options[:hours] = options.fetch(:hours, 0) + 24 * partial_days
+    end
+
+    d = to_date.advance(options)
+    d = d.gregorian if d.julian?
+    time_advanced_by_date = change(:year => d.year, :month => d.month, :day => d.day)
+    seconds_to_advance = \
+      options.fetch(:seconds, 0) +
+      options.fetch(:minutes, 0) * 60 +
+      options.fetch(:hours, 0) * 3600
+
+    if seconds_to_advance.zero?
+      time_advanced_by_date
+    else
+      time_advanced_by_date.since(seconds_to_advance)
+    end
+  end
+
+  # Returns a new Time representing the time a number of seconds ago, this is basically a wrapper around the Numeric extension
+  def ago(seconds)
+    since(-seconds)
+  end
+
+  # Returns a new Time representing the time a number of seconds since the instance time
+  def since(seconds)
+    self + seconds
+  rescue
+    to_datetime.since(seconds)
+  end
+  alias :in :since
+
+  # Returns a new Time representing the start of the day (0:00)
+  def beginning_of_day
+    #(self - seconds_since_midnight).change(usec: 0)
+    change(:hour => 0)
+  end
+  alias :midnight :beginning_of_day
+  alias :at_midnight :beginning_of_day
+  alias :at_beginning_of_day :beginning_of_day
+
+  # Returns a new Time representing the middle of the day (12:00)
+  def middle_of_day
+    change(:hour => 12)
+  end
+  alias :midday :middle_of_day
+  alias :noon :middle_of_day
+  alias :at_midday :middle_of_day
+  alias :at_noon :middle_of_day
+  alias :at_middle_of_day :middle_of_day
+
+  # Returns a new Time representing the end of the day, 23:59:59.999999
+  def end_of_day
+    change(
+      :hour => 23,
+      :min => 59,
+      :sec => 59,
+      :usec => Rational(999999999, 1000)
+    )
+  end
+  alias :at_end_of_day :end_of_day
+
+  # Returns a new Time representing the start of the hour (x:00)
+  def beginning_of_hour
+    change(:min => 0)
+  end
+  alias :at_beginning_of_hour :beginning_of_hour
+
+  # Returns a new Time representing the end of the hour, x:59:59.999999
+  def end_of_hour
+    change(
+      :min => 59,
+      :sec => 59,
+      :usec => Rational(999999999, 1000)
+    )
+  end
+  alias :at_end_of_hour :end_of_hour
+
+  # Returns a new Time representing the start of the minute (x:xx:00)
+  def beginning_of_minute
+    change(:sec => 0)
+  end
+  alias :at_beginning_of_minute :beginning_of_minute
+
+  # Returns a new Time representing the end of the minute, x:xx:59.999999
+  def end_of_minute
+    change(
+      :sec => 59,
+      :usec => Rational(999999999, 1000)
+    )
+  end
+  alias :at_end_of_minute :end_of_minute
+
+  # Returns a Range representing the whole day of the current time.
+  def all_day
+    beginning_of_day..end_of_day
+  end
+
+  def plus_with_duration(other) #:nodoc:
+    if CoreExt::Duration === other
+      other.since(self)
+    else
+      plus_without_duration(other)
+    end
+  end
+  alias_method :plus_without_duration, :+
+  alias_method :+, :plus_with_duration
+
+  def minus_with_duration(other) #:nodoc:
+    if CoreExt::Duration === other
+      other.until(self)
+    else
+      minus_without_duration(other)
+    end
+  end
+  alias_method :minus_without_duration, :-
+  alias_method :-, :minus_with_duration
+
+  # Time#- can also be used to determine the number of seconds between two Time instances.
+  # We're layering on additional behavior so that CoreExt::TimeWithZone instances
+  # are coerced into values that Time#- will recognize
+  def minus_with_coercion(other)
+    other = other.comparable_time if other.respond_to?(:comparable_time)
+    other.is_a?(DateTime) ? to_f - other.to_f : minus_without_coercion(other)
+  end
+  alias_method :minus_without_coercion, :-
+  alias_method :-, :minus_with_coercion
+
+  # Layers additional behavior on Time#<=> so that DateTime and CoreExt::TimeWithZone instances
+  # can be chronologically compared with a Time
+  def compare_with_coercion(other)
+    # we're avoiding Time#to_datetime and Time#to_time because they're expensive
+    if other.class == Time
+      compare_without_coercion(other)
+    elsif other.is_a?(Time)
+      compare_without_coercion(other.to_time)
+    else
+      to_datetime <=> other
+    end
+  end
+  alias_method :compare_without_coercion, :<=>
+  alias_method :<=>, :compare_with_coercion
+
+  # Layers additional behavior on Time#eql? so that CoreExt::TimeWithZone instances
+  # can be eql? to an equivalent Time
+  def eql_with_coercion(other)
+    # if other is an CoreExt::TimeWithZone, coerce a Time instance from it so we can do eql? comparison
+    other = other.comparable_time if other.respond_to?(:comparable_time)
+    eql_without_coercion(other)
+  end
+  alias_method :eql_without_coercion, :eql?
+  alias_method :eql?, :eql_with_coercion
+
+end

data/lib/core_ext/time/conversions.rb

@@ -0,0 +1,66 @@
+require 'core_ext/time_zone'
+
+class Time
+  DATE_FORMATS = {
+    :db           => '%Y-%m-%d %H:%M:%S',
+    :number       => '%Y%m%d%H%M%S',
+    :nsec         => '%Y%m%d%H%M%S%9N',
+    :usec         => '%Y%m%d%H%M%S%6N',
+    :time         => '%H:%M',
+    :short        => '%d %b %H:%M',
+    :long         => '%B %d, %Y %H:%M',
+    :long_ordinal => lambda { |time|
+      day_format = CoreExt::Inflector.ordinalize(time.day)
+      time.strftime("%B #{day_format}, %Y %H:%M")
+    },
+    :rfc822       => lambda { |time|
+      offset_format = time.formatted_offset(false)
+      time.strftime("%a, %d %b %Y %H:%M:%S #{offset_format}")
+    },
+    :iso8601      => lambda { |time| time.iso8601 }
+  }
+
+  # Converts to a formatted string. See DATE_FORMATS for built-in formats.
+  #
+  # This method is aliased to <tt>to_s</tt>.
+  #
+  #   time = Time.now                    # => 2007-01-18 06:10:17 -06:00
+  #
+  #   time.to_formatted_s(:time)         # => "06:10"
+  #   time.to_s(:time)                   # => "06:10"
+  #
+  #   time.to_formatted_s(:db)           # => "2007-01-18 06:10:17"
+  #   time.to_formatted_s(:number)       # => "20070118061017"
+  #   time.to_formatted_s(:short)        # => "18 Jan 06:10"
+  #   time.to_formatted_s(:long)         # => "January 18, 2007 06:10"
+  #   time.to_formatted_s(:long_ordinal) # => "January 18th, 2007 06:10"
+  #   time.to_formatted_s(:rfc822)       # => "Thu, 18 Jan 2007 06:10:17 -0600"
+  #   time.to_formatted_s(:iso8601)      # => "2007-01-18T06:10:17-06:00"
+  #
+  # == Adding your own time formats to +to_formatted_s+
+  # You can add your own formats to the Time::DATE_FORMATS hash.
+  # Use the format name as the hash key and either a strftime string
+  # or Proc instance that takes a time argument as the value.
+  #
+  #   # config/initializers/time_formats.rb
+  #   Time::DATE_FORMATS[:month_and_year] = '%B %Y'
+  #   Time::DATE_FORMATS[:short_ordinal]  = ->(time) { time.strftime("%B #{time.day.ordinalize}") }
+  def to_formatted_s(format = :default)
+    if formatter = DATE_FORMATS[format]
+      formatter.respond_to?(:call) ? formatter.call(self).to_s : strftime(formatter)
+    else
+      to_default_s
+    end
+  end
+  alias_method :to_default_s, :to_s
+  alias_method :to_s, :to_formatted_s
+
+  # Returns a formatted string of the offset from UTC, or an alternative
+  # string if the time zone is already UTC.
+  #
+  #   Time.local(2000).formatted_offset        # => "-06:00"
+  #   Time.local(2000).formatted_offset(false) # => "-0600"
+  def formatted_offset(colon = true, alternate_utc_string = nil)
+    utc? && alternate_utc_string || CoreExt::TimeZone.seconds_to_utc_offset(utc_offset, colon)
+  end
+end

data/lib/core_ext/time/zones.rb

@@ -0,0 +1,95 @@
+require 'core_ext/time_with_zone'
+require 'core_ext/time/acts_like'
+require 'core_ext/date_and_time/zones'
+
+class Time
+  include DateAndTime::Zones
+  class << self
+    attr_accessor :zone_default
+
+    # Returns the TimeZone for the current request, if this has been set (via Time.zone=).
+    # If <tt>Time.zone</tt> has not been set for the current request, returns the TimeZone specified in <tt>config.time_zone</tt>.
+    def zone
+      Thread.current[:time_zone] || zone_default
+    end
+
+    # Sets <tt>Time.zone</tt> to a TimeZone object for the current request/thread.
+    #
+    # This method accepts any of the following:
+    #
+    # * A Rails TimeZone object.
+    # * An identifier for a Rails TimeZone object (e.g., "Eastern Time (US & Canada)", <tt>-5.hours</tt>).
+    # * A TZInfo::Timezone object.
+    # * An identifier for a TZInfo::Timezone object (e.g., "America/New_York").
+    #
+    # Here's an example of how you might set <tt>Time.zone</tt> on a per request basis and reset it when the request is done.
+    # <tt>current_user.time_zone</tt> just needs to return a string identifying the user's preferred time zone:
+    #
+    #   class ApplicationController < ActionController::Base
+    #     around_action :set_time_zone
+    #
+    #     def set_time_zone
+    #       if logged_in?
+    #         Time.use_zone(current_user.time_zone) { yield }
+    #       else
+    #         yield
+    #       end
+    #     end
+    #   end
+    def zone=(time_zone)
+      Thread.current[:time_zone] = find_zone!(time_zone)
+    end
+
+    # Allows override of <tt>Time.zone</tt> locally inside supplied block; resets <tt>Time.zone</tt> to existing value when done.
+    def use_zone(time_zone)
+      new_zone = find_zone!(time_zone)
+      begin
+        old_zone, ::Time.zone = ::Time.zone, new_zone
+        yield
+      ensure
+        ::Time.zone = old_zone
+      end
+    end
+
+    # Returns a TimeZone instance matching the time zone provided.
+    # Accepts the time zone in any format supported by <tt>Time.zone=</tt>.
+    # Raises an +ArgumentError+ for invalid time zones.
+    #
+    #   Time.find_zone! "America/New_York" # => #<CoreExt::TimeZone @name="America/New_York" ...>
+    #   Time.find_zone! "EST"              # => #<CoreExt::TimeZone @name="EST" ...>
+    #   Time.find_zone! -5.hours           # => #<CoreExt::TimeZone @name="Bogota" ...>
+    #   Time.find_zone! nil                # => nil
+    #   Time.find_zone! false              # => false
+    #   Time.find_zone! "NOT-A-TIMEZONE"   # => ArgumentError: Invalid Timezone: NOT-A-TIMEZONE
+    def find_zone!(time_zone)
+      if !time_zone || time_zone.is_a?(CoreExt::TimeZone)
+        time_zone
+      else
+        # Look up the timezone based on the identifier (unless we've been
+        # passed a TZInfo::Timezone)
+        unless time_zone.respond_to?(:period_for_local)
+          time_zone = CoreExt::TimeZone[time_zone] || TZInfo::Timezone.get(time_zone)
+        end
+
+        # Return if a TimeZone instance, or wrap in a TimeZone instance if a TZInfo::Timezone
+        if time_zone.is_a?(CoreExt::TimeZone)
+          time_zone
+        else
+          CoreExt::TimeZone.create(time_zone.name, nil, time_zone)
+        end
+      end
+    rescue TZInfo::InvalidTimezoneIdentifier
+      raise ArgumentError, "Invalid Timezone: #{time_zone}"
+    end
+
+    # Returns a TimeZone instance matching the time zone provided.
+    # Accepts the time zone in any format supported by <tt>Time.zone=</tt>.
+    # Returns +nil+ for invalid time zones.
+    #
+    #   Time.find_zone "America/New_York" # => #<CoreExt::TimeZone @name="America/New_York" ...>
+    #   Time.find_zone "NOT-A-TIMEZONE"   # => nil
+    def find_zone(time_zone)
+      find_zone!(time_zone) rescue nil
+    end
+  end
+end

data/lib/core_ext/time.rb

@@ -0,0 +1,20 @@
+require 'date'
+require 'time'
+
+require 'core_ext/duration'
+require 'core_ext/time_with_zone'
+require 'core_ext/time_zone'
+
+require 'core_ext/time/acts_like.rb'
+require 'core_ext/time/calculations.rb'
+require 'core_ext/time/conversions.rb'
+require 'core_ext/time/zones.rb'
+
+require 'core_ext/date'
+require 'core_ext/date_time'
+
+require 'core_ext/integer/time'
+require 'core_ext/numeric/time'
+
+require 'core_ext/string/conversions'
+require 'core_ext/string/zones'