vremya 1.0

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Merimond Corporation
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,3 @@
+# Vremya
+
+A lump of syntactic sugar around native Date and Time objects, that takes the pain out of timezones, traversal, formatting etc.

data/Rakefile

@@ -0,0 +1,17 @@
+require 'rubygems'
+require 'bundler'
+require 'rspec/core/rake_task'
+require 'yard'
+
+Bundler.require
+Bundler::GemHelper.install_tasks
+
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  # nothing
+end
+
+desc "Generate docs"
+YARD::Rake::YardocTask.new do |t|
+  t.files   = ['lib/**/*.rb']
+end

data/lib/vremya.rb

@@ -0,0 +1,509 @@
+require 'tzinfo'
+
+class Vremya
+  
+  SECONDS_IN_A_DAY = 60 * 60 * 24
+  
+  def self.now(zone = nil)
+    self.new(Time.now.gmtime.to_i, zone)
+  end
+  
+  def self.parse(string, format, timezone = nil)
+    self.new(DateTime.strptime(string, format)).as_if_in(timezone)
+  end
+  
+  def self.timezones
+    TZInfo::Timezone.all_identifiers
+  end
+  
+  # Returns a new Vremya object with the value given by time since the Epoch.
+  # @return [Vremya]
+  def initialize(timestamp, zone = nil)
+    if timestamp.is_a?(DateTime)
+      timestamp = timestamp.strftime("%s").to_i
+    end
+    unless timestamp.respond_to?(:to_i)
+      raise 'Timestamp expected, %s' % timestamp.class
+    end
+    @zone  = TZInfo::Timezone.get(zone || 'GMT')
+    @stamp = timestamp.to_i
+  end
+  
+  # Returns a new Vremya object where one or more of the elements have been
+  # changed according to the options parameter. The following options are
+  # available: :year, :month, :day, :hour, :minute, :second. 
+  def change(options)
+    opts = to_hash.merge(options)
+    date = Date.new(opts[:year], opts[:month], opts[:day])
+    advance({
+      :days    => (date - to_date).to_i,
+      :hours   => opts[:hour] - hour,
+      :minutes => opts[:minute] - minute,
+      :seconds => opts[:second] - second
+    })
+  end
+  
+  # Returns a new Vremya object by going forward or back in time according
+  # to the options parameter. The following options are available:
+  # :years, :months, :days, :hours, :minutes, :seconds. 
+  def advance(options)
+    opts = {
+      :years   => 0,
+      :months  => 0,
+      :days    => 0,
+      :hours   => 0,
+      :minutes => 0,
+      :seconds => 0
+    }.merge(options)
+    date = to_date
+    date = date >> opts[:years] * 12
+    date = date >> opts[:months]
+    date = date + opts[:days]
+    diff = (date - to_date).to_i * 60 * 60 * 24
+    diff += opts[:hours] * 3600
+    diff += opts[:minutes] * 60
+    diff += opts[:seconds]
+    self + diff
+  end
+  
+  # Returns same time and date one month ago. In cases where previous month
+  # doen't have the same date (e.g. Mar 30 -> Feb 30), it will go back to the
+  # last day of the month (Feb 29 or Feb 28).
+  # @return [Vremya]
+  def previous_month
+    advance(:months => -1)
+  end
+  
+  alias_method :prev_month, :previous_month
+  
+  # Returns same time and date last year.
+  # @return [Vremya]
+  def previous_year
+    advance(:years => -1)
+  end
+  
+  alias_method :prev_year, :previous_year
+  
+  # Goes back 24 hours and returns a new Vremya object.
+  # @return [Vremya]
+  def previous_day
+    advance(:days => -1)
+  end
+  
+  alias_method :prev_day, :previous_day
+  
+  # Returns same time and date next year.
+  # @return [Vremya]
+  def next_year
+    advance(:years => 1)
+  end
+  
+  # Returns same time and date next month. In cases where next month
+  # doen't have the same date (e.g. Mar 31 -> Apr 31), it will advance to the
+  # last day of the month (Apr 30).
+  # @return [Vremya]
+  def next_month
+    advance(:months => 1)
+  end
+  
+  # Advances by 24 hours and returns a new Vremya object.
+  # @return [Vremya]
+  def next_day
+    advance(:days => 1)
+  end
+  
+  # Returns a new Vremya object representing the start of the day (00:00).
+  # @return [Vremya]
+  def beginning_of_day
+    change(:hour => 0, :minute => 0, :second => 0)
+  end
+  
+  alias_method :at_beginning_of_day, :beginning_of_day
+  alias_method :midnight,            :beginning_of_day
+  alias_method :at_midnight,         :beginning_of_day
+  
+  # Returns a new Time representing the "start" of this week (Monday, 0:00).
+  # @return [Vremya]
+  def beginning_of_week
+    advance(:days => wday == 0 ? -6 : 1 - wday)
+  end
+  
+  alias_method :at_beginning_of_week, :beginning_of_week
+  
+  # Returns a new Time representing the start of the month (1st of the month, 0:00).
+  # @return [Vremya]
+  def beginning_of_month
+    change(:day => 1, :hour => 0, :minute => 0, :second => 0)
+  end
+  
+  alias_method :at_beginning_of_month, :beginning_of_month
+  
+  # Returns a new Time representing the start of the year (1st of January, 0:00).
+  # @return [Vremya]
+  def beginning_of_year
+    change(:month => 1, :day => 1, :hour => 0, :minute => 0, :second => 0)
+  end
+  
+  alias_method :at_beginning_of_year, :beginning_of_year
+  
+  # Returns the second of the minute (0..60).
+  # @return [Fixnum]
+  def second
+    time_in_utc.sec
+  end
+  
+  alias_method :sec, :second
+  
+  # Returns the minute of the hour (0..59) for time.
+  # @return [Fixnum]
+  def minute
+    time_in_utc.min
+  end
+  
+  alias_method :min, :minute
+  
+  # Returns the hour of the day (0..23).
+  # @return [Fixnum]
+  def hour
+    time_in_utc.hour
+  end
+  
+  # Returns the day of the month (1..n).
+  # @return [Fixnum]
+  def day
+    time_in_utc.day
+  end
+  
+  # Returns the month of the year (1..12).
+  # @return [Fixnum]
+  def month
+    time_in_utc.month
+  end
+  
+  # Returns the year (including the century).
+  # @return [Fixnum]
+  def year
+    time_in_utc.year
+  end
+  
+  # Returns true if specified time lies in the future.
+  # @return [Boolean]
+  def future?
+    to_time > Time.now
+  end
+  
+  # Returns true if specified time lies in the past.
+  # @return [Boolean]
+  def past?
+    to_time < Time.now
+  end
+  
+  # Returns true if date represents January.
+  # @return [Boolean]
+  def january?
+    month == 1
+  end
+  
+  alias_method :jan?, :january?
+  
+  # Returns true if date represents February.
+  # @return [Boolean]
+  def february?
+    month == 2
+  end
+  
+  alias_method :feb?, :february?
+  
+  # Returns true if date represents March.
+  # @return [Boolean]
+  def march?
+    month == 3
+  end
+  
+  alias_method :mar?, :march?
+  
+  # Returns true if date represents April.
+  # @return [Boolean]
+  def april?
+    month == 4
+  end
+  
+  alias_method :apr?, :april?
+  
+  # Returns true if date represents May.
+  # @return [Boolean]
+  def may?
+    month == 5
+  end
+  
+  # Returns true if date represents June.
+  # @return [Boolean]
+  def june?
+    month == 6
+  end
+  
+  alias_method :jun?, :june?
+  
+  # Returns true if date represents July.
+  # @return [Boolean]
+  def july?
+    month == 7
+  end
+  
+  alias_method :jul?, :july?
+  
+  # Returns true if date represents August.
+  # @return [Boolean]
+  def august?
+    month == 8
+  end
+  
+  alias_method :aug?, :august?
+  
+  # Returns true if date represents September.
+  # @return [Boolean]
+  def september?
+    month == 9
+  end
+  
+  alias_method :sep?, :september?
+  
+  # Returns true if date represents October.
+  # @return [Boolean]
+  def october?
+    month == 10
+  end
+  
+  alias_method :oct?, :october?
+  
+  # Returns true if date represents November.
+  # @return [Boolean]
+  def november?
+    month == 11
+  end
+  
+  alias_method :nov?, :november?
+  
+  # Returns true if date represents December.
+  # @return [Boolean]
+  def december?
+    month == 12
+  end
+  
+  alias_method :dec?, :december?
+  
+  # Returns true if time represents Monday.
+  # @return [Boolean]
+  def monday?
+    wday == 1
+  end
+  
+  alias_method :mon?, :monday?
+  
+  # Returns true if time represents Tuesday.
+  # @return [Boolean]
+  def tuesday?
+    wday == 2
+  end
+  
+  alias_method :tue?, :tuesday?
+  
+  # Returns true if time represents Wednesday.
+  # @return [Boolean]
+  def wednesday?
+    wday == 3
+  end
+  
+  alias_method :wed?, :wednesday?
+  
+  # Returns true if time represents Thursday.
+  # @return [Boolean]
+  def thursday?
+    wday == 4
+  end
+  
+  alias_method :thu?, :thursday?
+  
+  # Returns true if time represents Friday.
+  # @return [Boolean]
+  def friday?
+    wday == 5
+  end
+  
+  alias_method :fri?, :friday?
+  
+  # Returns true if time represents Saturday.
+  # @return [Boolean]
+  def saturday?
+    wday == 6
+  end
+  
+  alias_method :sat?, :saturday?
+  
+  # Returns true if time represents Sunday.
+  # @return [Boolean]
+  def sunday?
+    wday == 0
+  end
+  
+  alias_method :sun?, :sunday?
+  
+  # Returns true if time represents any day of the week except Sunday and Saturday.
+  # @return [Boolean]
+  def weekday?
+    not weekend?
+  end
+  
+  # Returns true if time represents Sunday or Saturday.
+  # @return [Boolean]
+  def weekend?
+    saturday? or sunday?
+  end
+  
+  # Returns an integer representing the day of the week, 0..6, with Sunday == 0.
+  # @return [Fixnum]
+  def wday
+    time_in_utc.wday
+  end
+  
+  # Returns an integer representing the day of the week, 0..6. Similar to #wday, but assumes Monday == 0 and Sunday == 6.
+  def wday_starting_on_monday
+    sunday? ? 6 : wday - 1
+  end
+  
+  # Returns true if daylight savings are in effect at this timezone.
+  # @return [Boolean]
+  def daylight_saving?
+    @zone.current_period.dst?
+  end
+  
+  alias_method :dst?, :daylight_saving?
+  
+  # Returns timezone identifier, e.g. "Europe/Paris"
+  # @return [String]
+  def timezone_name
+    @zone.name
+  end
+  
+  # Returns the offset in seconds between the timezone of time and UTC.
+  # @return [Fixnum]
+  def utc_offset
+    @zone.current_period.utc_offset
+  end
+  
+  # Returns a new Vremya object in GMT timezone.
+  # @return [Vremya]
+  def to_utc
+    self.class.new(to_i)
+  end
+  
+  # Returns a new Vremya object in specified timezone.
+  # @return [Vremya]
+  def to_timezone(zone)
+    self.class.new(to_i, zone)
+  end
+  
+  # Returns the difference with specified timezone in seconds.
+  # @return [Integer]
+  def difference_with_zone(zone)
+    to_timezone(zone).utc_offset - utc_offset
+  end
+  
+  # Returns a new Vremya instance by advancing in time.
+  def as_if_in(zone)
+    to_timezone(zone) - difference_with_zone(zone)
+  end
+  
+  # Substracts some number of seconds to time and returns that value as a new Vremya object.
+  # @return [Vremya]
+  def -(value)
+    self.+(-value)
+  end
+  
+  # Adds some number of seconds to time and returns that value as a new Vremya object.
+  # @return [Vremya]
+  def +(value)
+    self.class.new(to_i + value, timezone_name)
+  end
+  
+  # Returns the number of seconds since 1970-01-01 00:00:00 UTC.
+  # @return [Fixnum]
+  def to_i
+    @stamp
+  end
+  
+  # Returns a native Ruby Time object in UTC timezone.
+  # @return [Time]
+  def to_time
+    Time.at(@stamp).getutc
+  end
+
+  # Returns a native Ruby Time object in UTC timezone.
+  # @return [Time]
+  def to_date
+    Date.new(year, month, day)
+  end
+  
+  # Returns a string which represents the time as date-time defined by RFC 2616.
+  # @return [String]
+  def rfc2616
+    to_utc.strftime("%a, %e %b %Y %T GMT")
+  end
+  
+  # Returns a string which represents the time as date-time defined by RFC 2822.
+  # @return [String]
+  def rfc2822
+    strftime("%a, %b %e %T %z %Y")
+  end
+  
+  # Returns a string which represents the time as date-time defined by ISO 8601.
+  # @return [String]
+  def iso8601
+    strftime("%Y-%m-%dT%H:%M:%S%z")
+  end
+  
+  # Returns a string representing time.
+  # @return [String]
+  def to_s
+    strftime("%a %b %d %T %z %Y")
+  end
+  
+  # Returns a hash with time & date attributes.
+  # @return [Hash]
+  def to_hash
+    { :year => year, :month => month, :day => day, :hour => hour, :minute => minute, :second => second }
+  end
+  
+  # Returns a string which represents the time as date-time defined by ISO 8601.
+  # @return [String]
+  def as_yaml(*args)
+    iso8601
+  end
+  
+  # Returns a YAML representation of the instance.
+  # @return [String]
+  def to_yaml
+    as_yaml.to_yaml
+  end
+  
+  # Returns time as a string according to the given format. The formatting is identical to Time.strftime 
+  # @return [String]
+  def strftime(string)
+    @zone.strftime string.gsub(/%z/, utc_offset_as_string), to_time
+  end
+  
+  private
+  
+  def utc_offset_as_string
+    "%s%s" % [utc_offset < 0 ? '-' : '+', formatted_hours(utc_offset)]
+  end
+  
+  def formatted_hours(seconds)
+    "%02d:%02d" % (seconds / 60).divmod(60)
+  end
+  
+  def time_in_utc
+    to_time + utc_offset
+  end
+  
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification 
+name: vremya
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  version: "1.0"
+platform: ruby
+authors: 
+- Alex Serebryakov
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-10-08 00:00:00 +04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  type: :development
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  name: rspec
+  requirement: *id001
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :development
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  name: yard
+  requirement: *id002
+  prerelease: false
+- !ruby/object:Gem::Dependency 
+  type: :runtime
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 3
+        - 37
+        version: 0.3.37
+  name: tzinfo
+  requirement: *id003
+  prerelease: false
+description: "A lump of syntactic sugar around native Date and Time objects, that takes the pain out of timezones, traversal, formatting etc. "
+email: 
+- alex@merimond.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/vremya.rb
+- Rakefile
+- README.md
+- LICENSE
+has_rdoc: true
+homepage: https://github.com/merimond/vremya
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: vremya
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Time & date library for Ruby
+test_files: []
+