Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Ruby Date/Time Precision

branch: master

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 gem_tasks
Octocat-spinner-32 gemfiles
Octocat-spinner-32 lib
Octocat-spinner-32 spec
Octocat-spinner-32 .gitignore
Octocat-spinner-32 .travis.yml
Octocat-spinner-32 Gemfile
Octocat-spinner-32 LICENSE
Octocat-spinner-32 README
Octocat-spinner-32 README.md
Octocat-spinner-32 Rakefile
Octocat-spinner-32 date_time_precision.gemspec
README.md

Ruby Date/Time Precision Build Status

Sometimes it is desirable to manipulate dates or times for which incomplete information is known. For example, one might only know the year, or the year and the month. Unfortunately, Ruby's built-in Date, Time, and DateTime classes do not keep track of the precision of the data. For example:

Date.new.to_s        # => "-4712-01-01"
Date.new(2000).to_s  # => "2000-01-01"

There is no way to tell the difference between January 1, 2000 and a Date where only the year 2000 was known.

The DateTimePrecision gem patches the Date, Time, DateTime, and NilClass classes to keep track of precision. The behavior of these classes should otherwise remain unchanged.

Usage

require 'date_time_precision'

d = Date.new(2000)
d.precision  # => DateTimePrecision::YEAR

t = Time::parse("2001-05")
t.precision  # => DateTimePrecision::MONTH
t.precision > d.precision # => true

dt = DateTime.new(nil, 7, 4)
dt.year?     # => false
dt.month?    # => true

The gem adds the following (possibly missing) methods to Date, Time, and/or DateTime:

Instance Methods

  • precision
  • precision=
  • partial_match?
  • year?
  • month?
  • day?
  • hour?
  • min?
  • sec?
  • to_date
  • to_time
  • to_datetime
  • utc
  • local

Class Methods

  • utc
  • local

Formats

It is useful to convert the various time classes into other formats that preserve the precision. The currently supported formats are Hash, JSON, and ISO 8601.

Examples:

# Requires Active Support
require 'date_time_precision/format/string'

Date.new(2000, 5).to_s(:long)
# => "May 2000"

Date.new(nil, 5, 10).to_s(:long)
# => "May 10"
require 'date_time_precision/format/hash'

date = Date.new(2000, 10)
hash = date.to_h
# => {:year=>2000, :mon=>10}

hash.to_date.precision
# => 2

birthday = Date.new(nil, 11, 12)
birthday.to_h
# => {:mon => 11, :day => 12}
require 'date_time_precision/format/json'

date = Date.new(2000, 10)
puts json = date.to_json
# => {"year":2000,"mon":10}

JSON.parse(json).to_date.precision
# => 2
require 'date_time_precision/format/iso8601'

Date.new(2000, 5).iso8601
# => "2000-05"

Time.iso8601("2000-05").precision
# => 2

Ruby Compatibility

Tested in MRI 1.8.7/1.9.2/1.9.3/2.0.0/2.1.0, REE, JRuby 1.8/1.9, and Rubinius 1.8/1.9.

Note that starting in MRI 1.9.3, the core Date/Time classes were rewritten in C, making it difficult to override internal functionality. Some functions are now implemented internally and are not exposed. The workaround is inefficient: #parse and #strptime perform the same work twice, once to get the precision and once inside the original C method.

Gem Compatibility

Sometimes other gems will use the Date/Time class in ways that don't preserve precision. If you want to use the DateTimePrecision gem with these gems, any compatibility issues will most likely need to be patched within DateTimePrecision itself. This is because DateTimePrecision makes some modifications to how the core Date/Time classes work. (For example, by allowing nil values to be passed to constructors.)

This gem should work with Rails/ActiveSupport 2, 3, and 4 (but perhaps missing some edge cases).

So far, the following gems are on the compatibility watch list:

If you know of any others, feel free to submit a pull request!

Installation

Add this line to your application's Gemfile:

gem 'date_time_precision'

And then execute:

$ bundle

Or install it yourself as:

$ gem install date_time_precision

Wishlist / TO-DO

  • [x] Time::mktime
  • [x] Time::utc and Time#utc
  • [x] Time::local
  • [x] Correct generation and parsing of the ISO 8601 format, which supports partial dates and times
  • [ ] The various time zone methods (partially done)
  • [.] Easy string formatting based on precision
  • [ ] ActiveSupport::TimeWithZone

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Added some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request
Something went wrong with that request. Please try again.