ruby-duration 0.1.8 → 0.2.0

data/.gitignore

@@ -19,4 +19,6 @@ rdoc
 pkg
 
 ## PROJECT::SPECIFIC
-.document
+.document
+.yardoc
+doc

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Jose Peleteiro
+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

data/README.md

@@ -0,0 +1,83 @@
+ruby-duration
+=============
+
+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](http://rubyforge.org/projects/duration) 
+lib, which is a **mutable** Duration type, with a lot more features but lack of test. I decide to create
+a new one because and belive it's better to be immutable and the old project is still on rubyforge's subversion.
+
+I'll try to contact the author of duration to make ruby-duration version 2 of duration's lib. ;)
+
+
+Features
+--------
+
+  * Representation of time in 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!
+
+
+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](http://en.wikipedia.org/wiki/ISO_8601#Durations)
+
+    Duration.new(:weeks => 1, :days => 20).iso8601 => "P3W6DT0H0M0S"
+
+### Mongoid support
+
+    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.

data/Rakefile

@@ -39,6 +39,22 @@ rescue LoadError
   end
 end
 
+namespace(:test) do
+  desc "Run tests on multiple ruby versions"
+  task(:portability) do
+    versions = %w{system 1.8.7 ree-1.8.7 1.9.2 jruby rubinius}
+    versions.each do |version|
+      system <<-BASH
+        bash -c 'source ~/.rvm/scripts/rvm;
+                 rvm use #{version};
+                 echo "-------- `ruby -v` ---------\n";
+                 gem install jeweler activesupport minitest yard i18n
+                 rake -s test'
+      BASH
+    end
+  end
+end
+
 task :test => :check_dependencies
 
 task :default => :test

data/VERSION

@@ -1 +1 @@
-0.1.8
+0.2.0

data/lib/duration.rb

@@ -9,10 +9,8 @@
 class Duration
   include Comparable
 
-  # Unit names
   UNITS = [:seconds, :minutes, :hours, :days, :weeks]
 
-  # Unit labels
   UNIT_LABELS = {:second => 'second',
                  :seconds => 'seconds',
                  :minute => 'minute',
@@ -23,8 +21,7 @@ class Duration
                  :days => 'days',
                  :week => 'week',
                  :weeks => 'weeks'}
-
-  # Unit multiples
+                 
   MULTIPLES = {:seconds => 1,
                :minutes => 60,
                :hours   => 3600,
@@ -36,9 +33,8 @@ class Duration
                :day     => 86400,
                :week    => 604800}
 
+  attr_reader :weeks, :days, :hours, :minutes, :seconds, :total
 
-  attr_reader :total, :seconds, :minutes, :hours, :days, :weeks
-  
   # Initialize a duration. 'args' can be a hash or anything else.  If a hash is
   # passed, it will be scanned for a key=>value pair of time units such as those
   # listed in the Duration::UNITS array or Duration::MULTIPLES hash.
@@ -46,8 +42,6 @@ class Duration
   # If anything else except a hash is passed, #to_i is invoked on that object
   # and expects that it return the number of seconds desired for the duration.
   def initialize(args = 0)
-    # Two types of arguments are accepted.  If it isn't a hash, it's converted
-    # to an integer.
     if args.kind_of?(Hash)
       @seconds = 0
       MULTIPLES.each do |unit, multiple|
@@ -58,7 +52,6 @@ class Duration
       @seconds = args.to_i
     end
 
-    # Calculate duration
     calculate!
   end
 
@@ -68,15 +61,18 @@ class Duration
     @total <=> other.to_i
   end
   
-  # Formats a duration in ISO8601. See http://en.wikipedia.org/wiki/ISO_8601#Durations
+  # Formats a duration in ISO8601.
+  # @see http://en.wikipedia.org/wiki/ISO_8601#Durations
   def iso8601
     format("P%wW%dDT%hH%mM%sS")
   end
   
+  # @return true if total is 0
   def blank?
     @total == 0
   end
   
+  # @return true if total different than 0
   def present?
     !blank?
   end
@@ -97,7 +93,6 @@ class Duration
   #   %~h => locale-dependent "hours" terminology
   #   %~d => locale-dependent "days" terminology
   #   %~w => locale-dependent "weeks" terminology
-  #
   def format(format_str)
     identifiers = {
       'w'  => @weeks,
@@ -113,8 +108,7 @@ class Duration
       '~m' => @minutes == 1 ? UNIT_LABELS[:minute] : UNIT_LABELS[:minutes],
       '~h' => @hours   == 1 ? UNIT_LABELS[:hour] : UNIT_LABELS[:hours],
       '~d' => @days    == 1 ? UNIT_LABELS[:day] : UNIT_LABELS[:days],
-      '~w' => @weeks   == 1 ? UNIT_LABELS[:week] : UNIT_LABELS[:weeks]
-    }
+      '~w' => @weeks   == 1 ? UNIT_LABELS[:week] : UNIT_LABELS[:weeks]}
 
     format_str.gsub(/%?%(w|d|h|m|s|t|H|M|S|~(?:s|m|h|d|w))/) do |match|
       match['%%'] ? match : identifiers[match[1..-1]]

data/lib/duration/mongoid.rb

@@ -2,23 +2,33 @@
 require 'duration'
 require 'active_support/core_ext'
 
-class Duration
-  def self.get(seconds)
+# Mongoid serialization support for Duration type.
+module Duration::Mongoid
+  
+  # Deserialize a Duration given the amount of seconds stored by Mongodb
+  #
+  # @param [Integer, nil] duration in seconds
+  # @return [Duration] deserialized Duration
+  def get(seconds)
     return if !seconds
     Duration.new(seconds)
   end
 
-  def self.set(args)
-    return if args.blank?
-    if args.is_a?(Hash)
-      args.delete_if{|k, v| v.blank? || !Duration::UNITS.include?(k.to_sym)}
-      return if args.blank?
-      Duration.new(args).to_i
-    elsif args.respond_to?(:to_i)
-      args.to_i
-    else
-      nil
+  # Serialize a Duration or a Hash (with duration units) or a amount of seconds to
+  # a BSON serializable type.
+  #
+  # @param [Duration, Hash, Integer] value
+  # @return [Integer] duration in seconds
+  def set(value)
+    return if value.blank?
+    if value.is_a?(Hash)
+      value.delete_if{|k, v| v.blank? || !Duration::UNITS.include?(k.to_sym)}
+      return if value.blank?
+      Duration.new(value).to_i
+    elsif value.respond_to?(:to_i)
+      value.to_i
     end
   end
 end
 
+Duration.send(:extend, Duration::Mongoid)

data/ruby-duration.gemspec

@@ -5,21 +5,21 @@
 
 Gem::Specification.new do |s|
   s.name = %q{ruby-duration}
-  s.version = "0.1.8"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jose Peleteiro"]
-  s.date = %q{2010-09-15}
+  s.date = %q{2010-09-16}
   s.description = %q{Duration type}
   s.email = %q{jose@peleteiro.net}
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.rdoc"
+     "README.md"
   ]
   s.files = [
     ".gitignore",
      "LICENSE",
-     "README.rdoc",
+     "README.md",
      "Rakefile",
      "VERSION",
      "lib/duration.rb",

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ruby-duration
 version: !ruby/object:Gem::Version 
-  hash: 11
+  hash: 23
   prerelease: false
   segments: 
   - 0
-  - 1
-  - 8
-  version: 0.1.8
+  - 2
+  - 0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Jose Peleteiro
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-15 00:00:00 -03:00
+date: 2010-09-16 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -54,11 +54,11 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.rdoc
+- README.md
 files: 
 - .gitignore
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION
 - lib/duration.rb

data/README.rdoc

@@ -1,17 +0,0 @@
-= duration
-
-Description goes here.
-
-== 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.
-
-== Copyright
-
-Copyright (c) 2010 Jose Peleteiro. See LICENSE for details.