Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Duration type with Mongoid 3 support and longer time units such as weeks, months and years

branch: master

Fetching latest commit…

Octocat-spinner-32-eaf2f5

Cannot retrieve the latest commit at this time

Octocat-spinner-32 config
Octocat-spinner-32 lib
Octocat-spinner-32 test
Octocat-spinner-32 .gitignore
Octocat-spinner-32 .travis.yml
Octocat-spinner-32 CHANGELOG
Octocat-spinner-32 Gemfile
Octocat-spinner-32 LICENSE
Octocat-spinner-32 README.md
Octocat-spinner-32 Rakefile
Octocat-spinner-32 xduration.gemspec
README.md

xduration

xduration is an extension of the ruby-duration gem. It additionally adds support for longer time units such as weeks, months and years.

Specific time unit classes that subclass and specialize Duration are made available:

  • Decades, Decade
  • Years, Year
  • Months, Month
  • Weeks, Week
  • Days, Day
  • Hours, Hour
  • Minutes, Minute
  • Seconds, Second

The class Fixnum is patched with additional am and pm methods to return the time, fx 1.am is today at 01:00 am.

The class Numeric is patched with methods such as:

  • duration
  • dseconds, dsecond, ..., dhours, ddays, dweeks, dyears, ddecades

Each method returns an appropriate instance of Hours, Decades and so on..

5.dhours # => Hours.new(5)

5.duration # => Duration.new(5) # 5 seconds

Rails

The locale file used for text output, fx for duration.i18n_for(:weeks).

/config/locales/duration/[i18n code].yml'

Here an example for a danish (da) locale file:

da:
  ruby_duration:
    second: sekond
    seconds: sekonder
    minute: minut
    minutes: minutter
    hour: time
    hours: timer
    day: dag
    days: dage
    week: uge
    weeks: uges
    month: måned
    months: måneder
    year: år
    years: år

For more advanced Duration functionality, the Timespan gem is recommended ;)

Duration is an immutable type that represents some amount of time with accuracy in seconds.

A lot of the code and inspirations is borrowed from duration lib, which is a mutable Duration type with lot more features but lack of tests.

Features

  • Representation of time in years, months, weeks, days, hours, minutes and seconds.
  • Construtor can receive the amount of time in seconds or a Hash with unit and amount of time.
  • Format method to display the time with i18n support.
  • Mongoid serialization support. Use require 'duration/mongoid'.
  • Tested on mri 1.8.7, ree 1.8.7, mri 1.9.2, jruby and rubinius. Kudos to rvm!

Extras

Macros

require 'duration/macros'

1.day + 4.hours
10.am

require 'duration/time_units'

weeks = Weeks.new(6)
years = Years.new(6)

Show me the code

constructor

Duration.new(100) => #<Duration: minutes=1, seconds=40, total=100>
Duration.new(:hours => 5, :minutes => 70) => #<Duration: hours=6, minutes=10, total=22200>

format

Duration.new(:weeks => 3, :days => 1).format("%w %~w and %d %~d") => "3 weeks and 1 day"
Duration.new(:weeks => 1, :days => 20).format("%w %~w and %d %~d") => "3 weeks and 6 days"

iso 8601 more info

Duration.new(:weeks => 1, :days => 20).iso8601 => "P3W6DT0H0M0S"

Mongoid support

The current version of this gem supports Mongoid >= 2.1.0.

require 'duration/mongoid'

class MyModel
  include Mongoid::Document
  field :duration, type => Duration
end

Note on Patches/Pull Requests

  • Fork the project.
  • Make your feature addition or bug fix.
  • Add tests for it. This is important so I don't break it in a future version unintentionally.
  • Commit, do not mess with rakefile, version, or history. (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
  • Send me a pull request. Bonus points for topic branches.

License

Copyright (c) 2010 Jose Peleteiro

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.

Something went wrong with that request. Please try again.