activesupport-refinements 0.0.1

data/lib/active_support/refinements/core_ext/class/subclasses.rb

@@ -0,0 +1,44 @@
+module ClassExt; end; module ClassExt::Subclasses
+require 'active_support/refinements/core_ext/module/anonymous'
+require 'active_support/refinements/core_ext/module/reachable'
+
+refine Class do
+  begin
+    ObjectSpace.each_object(Class.new) {}
+
+    def descendants # :nodoc:
+      descendants = []
+      ObjectSpace.each_object(singleton_class) do |k|
+        descendants.unshift k unless k == self
+      end
+      descendants
+    end
+  rescue StandardError # JRuby
+    def descendants # :nodoc:
+      descendants = []
+      ObjectSpace.each_object(Class) do |k|
+        descendants.unshift k if k < self
+      end
+      descendants.uniq!
+      descendants
+    end
+  end
+
+  # Returns an array with the direct children of +self+.
+  #
+  #   Integer.subclasses # => [Fixnum, Bignum]
+  #
+  #   class Foo; end
+  #   class Bar < Foo; end
+  #   class Baz < Foo; end
+  #
+  #   Foo.subclasses # => [Baz, Bar]
+  def subclasses
+    subclasses, chain = [], descendants
+    chain.each do |k|
+      subclasses << k unless chain.any? { |c| c > k }
+    end
+    subclasses
+  end
+end
+end

data/lib/active_support/refinements/core_ext/date.rb

@@ -0,0 +1,5 @@
+require 'active_support/refinements/core_ext/date/acts_like'
+require 'active_support/refinements/core_ext/date/calculations'
+require 'active_support/refinements/core_ext/date/conversions'
+require 'active_support/refinements/core_ext/date/zones'
+

data/lib/active_support/refinements/core_ext/date/acts_like.rb

@@ -0,0 +1,10 @@
+module DateExt; end; module DateExt::ActsLike
+require 'active_support/refinements/core_ext/object/acts_like'
+
+refine Date do
+  # Duck-types as a Date-like class. See Object#acts_like?.
+  def acts_like_date?
+    true
+  end
+end
+end

data/lib/active_support/refinements/core_ext/date/calculations.rb

@@ -0,0 +1,123 @@
+module DateExt; end; module DateExt::Calculations
+require 'date'
+require 'active_support/duration'
+require 'active_support/refinements/core_ext/object/acts_like'
+require 'active_support/refinements/core_ext/date/zones'
+require 'active_support/refinements/core_ext/time/zones'
+require 'active_support/refinements/core_ext/date_and_time/calculations'
+
+refine Date do
+  include DateAndTime::Calculations
+
+  class << self
+    attr_accessor :beginning_of_week_default
+
+    # Returns the week start (e.g. :monday) for the current request, if this has been set (via Date.beginning_of_week=).
+    # If <tt>Date.beginning_of_week</tt> has not been set for the current request, returns the week start specified in <tt>config.beginning_of_week</tt>.
+    # If no config.beginning_of_week was specified, returns :monday.
+    def beginning_of_week
+      Thread.current[:beginning_of_week] || beginning_of_week_default || :monday
+    end
+
+    # Sets <tt>Date.beginning_of_week</tt> to a week start (e.g. :monday) for current request/thread.
+    #
+    # This method accepts any of the following day symbols:
+    # :monday, :tuesday, :wednesday, :thursday, :friday, :saturday, :sunday
+    def beginning_of_week=(week_start)
+      Thread.current[:beginning_of_week] = find_beginning_of_week!(week_start)
+    end
+
+    # Returns week start day symbol (e.g. :monday), or raises an ArgumentError for invalid day symbol.
+    def find_beginning_of_week!(week_start)
+      raise ArgumentError, "Invalid beginning of week: #{week_start}" unless ::Date::DAYS_INTO_WEEK.key?(week_start)
+      week_start
+    end
+
+    # Returns a new Date representing the date 1 day ago (i.e. yesterday's date).
+    def yesterday
+      ::Date.current.yesterday
+    end
+
+    # Returns a new Date representing the date 1 day after today (i.e. tomorrow's date).
+    def tomorrow
+      ::Date.current.tomorrow
+    end
+
+    # Returns Time.zone.today when <tt>Time.zone</tt> or <tt>config.time_zone</tt> are set, otherwise just returns Date.today.
+    def current
+      ::Time.zone ? ::Time.zone.today : ::Date.today
+    end
+  end
+
+  # Converts Date to a Time (or DateTime if necessary) with the time portion set to the beginning of the day (0:00)
+  # and then subtracts the specified number of seconds.
+  def ago(seconds)
+    to_time_in_current_zone.since(-seconds)
+  end
+
+  # Converts Date to a Time (or DateTime if necessary) with the time portion set to the beginning of the day (0:00)
+  # and then adds the specified number of seconds
+  def since(seconds)
+    to_time_in_current_zone.since(seconds)
+  end
+#  alias :in :since
+
+  # Converts Date to a Time (or DateTime if necessary) with the time portion set to the beginning of the day (0:00)
+  def beginning_of_day
+    to_time_in_current_zone
+  end
+#  alias :midnight :beginning_of_day
+#  alias :at_midnight :beginning_of_day
+#  alias :at_beginning_of_day :beginning_of_day
+
+  # Converts Date to a Time (or DateTime if necessary) with the time portion set to the end of the day (23:59:59)
+  def end_of_day
+    to_time_in_current_zone.end_of_day
+  end
+
+  def plus_with_duration(other) #:nodoc:
+    if ActiveSupport::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 ActiveSupport::Duration === other
+      plus_with_duration(-other)
+    else
+      minus_without_duration(other)
+    end
+  end
+#  alias_method :minus_without_duration, :-
+#  alias_method :-, :minus_with_duration
+
+  # Provides precise Date calculations for years, months, and days. The +options+ parameter takes a hash with
+  # any of these keys: <tt>:years</tt>, <tt>:months</tt>, <tt>:weeks</tt>, <tt>:days</tt>.
+  def advance(options)
+    options = options.dup
+    d = self
+    d = d >> options.delete(:years) * 12 if options[:years]
+    d = d >> options.delete(:months)     if options[:months]
+    d = d +  options.delete(:weeks) * 7  if options[:weeks]
+    d = d +  options.delete(:days)       if options[:days]
+    d
+  end
+
+  # Returns a new Date where one or more of the elements have been changed according to the +options+ parameter.
+  # The +options+ parameter is a hash with a combination of these keys: <tt>:year</tt>, <tt>:month</tt>, <tt>:day</tt>.
+  #
+  #   Date.new(2007, 5, 12).change(day: 1)               # => Date.new(2007, 5, 1)
+  #   Date.new(2007, 5, 12).change(year: 2005, month: 1) # => Date.new(2005, 1, 12)
+  def change(options)
+    ::Date.new(
+      options.fetch(:year, year),
+      options.fetch(:month, month),
+      options.fetch(:day, day)
+    )
+  end
+end
+end

data/lib/active_support/refinements/core_ext/date/conversions.rb

@@ -0,0 +1,86 @@
+module DateExt; end; module DateExt::Conversions
+require 'date'
+require 'active_support/inflector/methods'
+require 'active_support/refinements/core_ext/date/zones'
+require 'active_support/refinements/core_ext/module/remove_method'
+
+refine Date do
+  DATE_FORMATS = {
+    :short        => '%e %b',
+    :long         => '%B %e, %Y',
+    :db           => '%Y-%m-%d',
+    :number       => '%Y%m%d',
+    :long_ordinal => lambda { |date|
+      day_format = ActiveSupport::Inflector.ordinalize(date.day)
+      date.strftime("%B #{day_format}, %Y") # => "April 25th, 2007"
+    },
+    :rfc822       => '%e %b %Y'
+  }
+
+  # Ruby 1.9 has Date#to_time which converts to localtime only.
+  remove_possible_method :to_time
+
+  # Ruby 1.9 has Date#xmlschema which converts to a string without the time component.
+  remove_possible_method :xmlschema
+
+  # Convert to a formatted string. See DATE_FORMATS for predefined formats.
+  #
+  # This method is aliased to <tt>to_s</tt>.
+  #
+  #   date = Date.new(2007, 11, 10)       # => Sat, 10 Nov 2007
+  #
+  #   date.to_formatted_s(:db)            # => "2007-11-10"
+  #   date.to_s(:db)                      # => "2007-11-10"
+  #
+  #   date.to_formatted_s(:short)         # => "10 Nov"
+  #   date.to_formatted_s(:long)          # => "November 10, 2007"
+  #   date.to_formatted_s(:long_ordinal)  # => "November 10th, 2007"
+  #   date.to_formatted_s(:rfc822)        # => "10 Nov 2007"
+  #
+  # == Adding your own time formats to to_formatted_s
+  # You can add your own formats to the Date::DATE_FORMATS hash.
+  # Use the format name as the hash key and either a strftime string
+  # or Proc instance that takes a date argument as the value.
+  #
+  #   # config/initializers/time_formats.rb
+  #   Date::DATE_FORMATS[:month_and_year] = '%B %Y'
+  #   Date::DATE_FORMATS[:short_ordinal] = ->(date) { date.strftime("%B #{date.day.ordinalize}") }
+  def to_formatted_s(format = :default)
+    if formatter = DATE_FORMATS[format]
+      if formatter.respond_to?(:call)
+        formatter.call(self).to_s
+      else
+        strftime(formatter)
+      end
+    else
+      to_default_s
+    end
+  end
+#  alias_method :to_default_s, :to_s
+#  alias_method :to_s, :to_formatted_s
+
+  # Overrides the default inspect method with a human readable one, e.g., "Mon, 21 Feb 2005"
+  def readable_inspect
+    strftime('%a, %d %b %Y')
+  end
+#  alias_method :default_inspect, :inspect
+#  alias_method :inspect, :readable_inspect
+
+  # Converts a Date instance to a Time, where the time is set to the beginning of the day.
+  # The timezone can be either :local or :utc (default :local).
+  #
+  #   date = Date.new(2007, 11, 10)  # => Sat, 10 Nov 2007
+  #
+  #   date.to_time                   # => Sat Nov 10 00:00:00 0800 2007
+  #   date.to_time(:local)           # => Sat Nov 10 00:00:00 0800 2007
+  #
+  #   date.to_time(:utc)             # => Sat Nov 10 00:00:00 UTC 2007
+  def to_time(form = :local)
+    ::Time.send("#{form}_time", year, month, day)
+  end
+
+  def xmlschema
+    to_time_in_current_zone.xmlschema
+  end
+end
+end

data/lib/active_support/refinements/core_ext/date/zones.rb

@@ -0,0 +1,17 @@
+module DateExt; end; module DateExt::Zones
+require 'date'
+require 'active_support/refinements/core_ext/time/zones'
+
+refine Date do
+  # Converts Date to a TimeWithZone in the current zone if <tt>Time.zone</tt> or
+  # <tt>Time.zone_default</tt> is set, otherwise converts Date to a Time via
+  # Date#to_time.
+  def to_time_in_current_zone
+    if ::Time.zone
+      ::Time.zone.local(year, month, day)
+    else
+      to_time
+    end
+  end
+end
+end

data/lib/active_support/refinements/core_ext/date_and_time/calculations.rb

@@ -0,0 +1,232 @@
+module DateAndTime
+  module Calculations
+    DAYS_INTO_WEEK = {
+      :monday    => 0,
+      :tuesday   => 1,
+      :wednesday => 2,
+      :thursday  => 3,
+      :friday    => 4,
+      :saturday  => 5,
+      :sunday    => 6
+    }
+
+    # Returns a new date/time representing yesterday.
+    def yesterday
+      advance(:days => -1)
+    end
+
+    # Returns a new date/time representing tomorrow.
+    def tomorrow
+      advance(:days => 1)
+    end
+
+    # Returns true if the date/time is today.
+    def today?
+      to_date == ::Date.current
+    end
+
+    # Returns true if the date/time is in the past.
+    def past?
+      self < self.class.current
+    end
+
+    # Returns true if the date/time is in the future.
+    def future?
+      self > self.class.current
+    end
+
+    # Returns a new date/time the specified number of days ago.
+    def days_ago(days)
+      advance(:days => -days)
+    end
+
+    # Returns a new date/time the specified number of days in the future.
+    def days_since(days)
+      advance(:days => days)
+    end
+
+    # Returns a new date/time the specified number of weeks ago.
+    def weeks_ago(weeks)
+      advance(:weeks => -weeks)
+    end
+
+    # Returns a new date/time the specified number of weeks in the future.
+    def weeks_since(weeks)
+      advance(:weeks => weeks)
+    end
+
+    # Returns a new date/time the specified number of months ago.
+    def months_ago(months)
+      advance(:months => -months)
+    end
+
+    # Returns a new date/time the specified number of months in the future.
+    def months_since(months)
+      advance(:months => months)
+    end
+
+    # Returns a new date/time the specified number of years ago.
+    def years_ago(years)
+      advance(:years => -years)
+    end
+
+    # Returns a new date/time the specified number of years in the future.
+    def years_since(years)
+      advance(:years => years)
+    end
+
+    # Returns a new date/time at the start of the month.
+    # DateTime objects will have a time set to 0:00.
+    def beginning_of_month
+      first_hour{ change(:day => 1) }
+    end
+    alias :at_beginning_of_month :beginning_of_month
+
+    # Returns a new date/time at the start of the quarter.
+    # Example: 1st January, 1st July, 1st October.
+    # DateTime objects will have a time set to 0:00.
+    def beginning_of_quarter
+      first_quarter_month = [10, 7, 4, 1].detect { |m| m <= month }
+      beginning_of_month.change(:month => first_quarter_month)
+    end
+    alias :at_beginning_of_quarter :beginning_of_quarter
+
+    # Returns a new date/time at the end of the quarter.
+    # Example: 31st March, 30th June, 30th September.
+    # DateTIme objects will have a time set to 23:59:59.
+    def end_of_quarter
+      last_quarter_month = [3, 6, 9, 12].detect { |m| m >= month }
+      beginning_of_month.change(:month => last_quarter_month).end_of_month
+    end
+    alias :at_end_of_quarter :end_of_quarter
+
+    # Return a new date/time at the beginning of the year.
+    # Example: 1st January.
+    # DateTime objects will have a time set to 0:00.
+    def beginning_of_year
+      change(:month => 1).beginning_of_month
+    end
+    alias :at_beginning_of_year :beginning_of_year
+
+    # Returns a new date/time representing the given day in the next week.
+    # Week is assumed to start on +start_day+, default is
+    # +Date.beginning_of_week+ or +config.beginning_of_week+ when set.
+    # DateTime objects have their time set to 0:00.
+    def next_week(start_day = Date.beginning_of_week)
+      first_hour{ weeks_since(1).beginning_of_week.days_since(days_span(start_day)) }
+    end
+
+    # Short-hand for months_since(1).
+    def next_month
+      months_since(1)
+    end
+
+    # Short-hand for months_since(3)
+    def next_quarter
+      months_since(3)
+    end
+
+    # Short-hand for years_since(1).
+    def next_year
+      years_since(1)
+    end
+
+    # Returns a new date/time representing the given day in the previous week.
+    # Week is assumed to start on +start_day+, default is
+    # +Date.beginning_of_week+ or +config.beginning_of_week+ when set.
+    # DateTime objects have their time set to 0:00.
+    def prev_week(start_day = Date.beginning_of_week)
+      first_hour{ weeks_ago(1).beginning_of_week.days_since(days_span(start_day)) }
+    end
+    alias_method :last_week, :prev_week
+
+    # Short-hand for months_ago(1).
+    def prev_month
+      months_ago(1)
+    end
+    alias_method :last_month, :prev_month
+
+    # Short-hand for months_ago(3).
+    def prev_quarter
+      months_ago(3)
+    end
+    alias_method :last_quarter, :prev_quarter
+
+    # Short-hand for years_ago(1).
+    def prev_year
+      years_ago(1)
+    end
+    alias_method :last_year, :prev_year
+
+    # Returns the number of days to the start of the week on the given day.
+    # Week is assumed to start on +start_day+, default is
+    # +Date.beginning_of_week+ or +config.beginning_of_week+ when set.
+    def days_to_week_start(start_day = Date.beginning_of_week)
+      start_day_number = DAYS_INTO_WEEK[start_day]
+      current_day_number = wday != 0 ? wday - 1 : 6
+      (current_day_number - start_day_number) % 7
+    end
+
+    # Returns a new date/time representing the start of this week on the given day.
+    # Week is assumed to start on +start_day+, default is
+    # +Date.beginning_of_week+ or +config.beginning_of_week+ when set.
+    # +DateTime+ objects have their time set to 0:00.
+    def beginning_of_week(start_day = Date.beginning_of_week)
+      result = days_ago(days_to_week_start(start_day))
+      acts_like?(:time) ? result.midnight : result
+    end
+    alias :at_beginning_of_week :beginning_of_week
+
+    # Returns Monday of this week assuming that week starts on Monday.
+    # +DateTime+ objects have their time set to 0:00.
+    def monday
+      beginning_of_week(:monday)
+    end
+
+    # Returns a new date/time representing the end of this week on the given day.
+    # Week is assumed to start on +start_day+, default is
+    # +Date.beginning_of_week+ or +config.beginning_of_week+ when set.
+    # DateTime objects have their time set to 23:59:59.
+    def end_of_week(start_day = Date.beginning_of_week)
+      last_hour{ days_since(6 - days_to_week_start(start_day)) }
+    end
+    alias :at_end_of_week :end_of_week
+
+    # Returns Sunday of this week assuming that week starts on Monday.
+    # +DateTime+ objects have their time set to 23:59:59.
+    def sunday
+      end_of_week(:monday)
+    end
+
+    # Returns a new date/time representing the end of the month.
+    # DateTime objects will have a time set to 23:59:59.
+    def end_of_month
+      last_day = ::Time.days_in_month(month, year)
+      last_hour{ days_since(last_day - day) }
+    end
+    alias :at_end_of_month :end_of_month
+
+    # Returns a new date/time representing the end of the year.
+    # DateTime objects will have a time set to 23:59:59.
+    def end_of_year
+      change(:month => 12).end_of_month
+    end
+    alias :at_end_of_year :end_of_year
+
+    private
+
+    def first_hour
+      result = yield
+      acts_like?(:time) ? result.change(:hour => 0) : result
+    end
+
+    def last_hour
+      result = yield
+      acts_like?(:time) ? result.end_of_day : result
+    end
+
+    def days_span(day)
+      (DAYS_INTO_WEEK[day] - DAYS_INTO_WEEK[Date.beginning_of_week]) % 7
+    end
+  end
+end