xduration 2.2.3 → 3.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f3f0711581bf23394090cd5d2527d1ed88d5514e
+  data.tar.gz: 5cc07346c97931605e0b61d91e452ec0850ffe4c
+SHA512:
+  metadata.gz: a9eff3904f88e24b96bb0f21d360628b971ec55415303f0f9e5b081e1fb78f38bec737be7ee6a1635c2275f650f1857280429100dedfdace4d92917d4a598736
+  data.tar.gz: d1b82e8ed44416f61f1713a28c5c513e74f7ea70a65a0f535486aeb51c52ad126f37a8738cb0f1c9936bd625704d846fa835e5e3c49a6cd39349055ebae57889

data/CHANGELOG

@@ -1,3 +1,7 @@
+## 3.0.0
+
+Updated for Duration 3.0.0 functionality to support Mongoid 3.0+
+
 ## 0.2.2
 
 * Renamed to 'xduration'

data/Gemfile

@@ -1,4 +1,4 @@
-source :gemcutter
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in xduration.gemspec
 gemspec

data/README.md

@@ -1,6 +1,61 @@
 xduration
 =============
 
+xduration is an extension of the [ruby-duration](https://github.com/peleteiro/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:
+
+```yaml
+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](https://github.com/kristianmandrup/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](http://rubyforge.org/projects/duration) 
@@ -10,7 +65,7 @@ lib, which is a **mutable** Duration type with lot more features but lack of tes
 Features
 --------
 
-  * Representation of time in weeks, days, hours, minutes and seconds.
+  * 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'`.

data/lib/duration.rb

@@ -80,7 +80,7 @@ class Duration
     Duration.new(@total % other.to_i)
   end
   
-  %w(minutes hours days).each do |meth|
+  %w(minutes hours days weeks months years).each do |meth|
     define_method("total_#{meth}") { @total / MULTIPLES[meth.to_sym] }
   end
 
@@ -89,6 +89,8 @@ class Duration
   def iso8601
     output = 'P'
 
+    output << "#{years}Y" if years > 0
+    output << "#{months}M" if months > 0
     output << "#{weeks}W" if weeks > 0
     output << "#{days}D" if days > 0
     if seconds > 0 || minutes > 0 || hours > 0

data/lib/duration/mongoid.rb

@@ -5,30 +5,50 @@ require "mongoid/fields"
 module Mongoid
   module Fields
     class Duration
-      include Mongoid::Fields::Serializable
-    
-      # Deserialize a Duration given the amount of seconds stored by Mongodb
-      #
-      # @param [Integer, nil] duration in seconds
-      # @return [Duration] deserialized Duration
-      def deserialize(seconds)
-        return if !seconds
+
+      # Instantiates a new Duration object
+      def initialize(seconds)
         ::Duration.new(seconds)
       end
 
-      # 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 serialize(value)
-        return if value.blank?
-        if value.is_a?(Hash)
-          value.delete_if{|k, v| v.blank? || !::Duration::UNITS.include?(k.to_sym)}
+      # Converts the Duration object into a MongoDB friendly value.
+      def mongoize
+        self.to_i
+      end
+
+      class << self
+        # Deserialize a Duration given the amount of seconds stored by Mongodb
+        #
+        # @param [Integer, nil] duration in seconds
+        # @return [Duration] deserialized Duration
+        def demongoize(seconds)
+          return if !seconds
+          ::Duration.new(seconds)
+        end
+
+        # 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 mongoize(value)
           return if value.blank?
-          ::Duration.new(value).to_i
-        elsif value.respond_to?(:to_i)
-          value.to_i
+          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
+
+        # Converts the object that was supplied to a criteria and converts it
+        # into a database friendly form.
+        def evolve(object)
+          case object
+          when ::Duration then object.mongoize
+          else object
+          end
         end
       end
     end

data/lib/duration/version.rb

@@ -1,3 +1,3 @@
 class Duration
-  VERSION = "2.2.3"
+  VERSION = "3.0.0"
 end

data/xduration.gemspec

@@ -8,21 +8,21 @@ Gem::Specification.new do |s|
   s.authors     = ["Jose Peleteiro", "Bruno Azisaka Maciel", "Kristian Mandrup"]
   s.email       = ["jose@peleteiro.net", "bruno@azisaka.com.br", "kmandrup@gmail.com"]
   s.homepage    = "http://github.com/kristianmandrup/xduration"
-  s.summary     = "Duration type"
-  s.description = "Duration type"
+  s.summary     = "Duration type with Mongoid 2.4+ support"
+  s.description = "Duration with support for longer time periods"
 
   s.required_rubygems_version = ">= 1.3.6"
 
   s.add_dependency "activesupport", ">= 3.0.0"
-  s.add_dependency "i18n", ">= 0"
+  s.add_dependency "i18n",          ">= 0.6"
 
-  s.add_development_dependency "bundler", ">= 1.0.0"
-  s.add_development_dependency "minitest", ">= 0"
-  s.add_development_dependency "yard", ">= 0"
-  s.add_development_dependency "rake", ">= 0"
-  s.add_development_dependency "simplecov", ">= 0.3.5"
-  s.add_development_dependency "mongoid", "~> 2.4.0"
-  s.add_development_dependency "rails", ">= 3.1"
+  s.add_development_dependency "bundler",   ">= 1.0.0"
+  s.add_development_dependency "minitest",  ">= 0"
+  s.add_development_dependency "yard",      ">= 0"
+  s.add_development_dependency "rake",      ">= 0.9.2"
+  s.add_development_dependency "simplecov", ">= 0.5"
+  s.add_development_dependency "mongoid",   ">= 2.4.0"
+  s.add_development_dependency "rails",     ">= 3.1"
 
   s.files        = `git ls-files`.split("\n")
   s.executables  = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xduration
 version: !ruby/object:Gem::Version
-  version: 2.2.3
-  prerelease: 
+  version: 3.0.0
 platform: ruby
 authors:
 - Jose Peleteiro
@@ -11,153 +10,135 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-07 00:00:00.000000000 Z
+date: 2013-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: i18n
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.9.2
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 0.3.5
+        version: '0.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
-        version: 0.3.5
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: mongoid
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - '>='
       - !ruby/object:Gem::Version
         version: 2.4.0
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '3.1'
-description: Duration type
+description: Duration with support for longer time periods
 email:
 - jose@peleteiro.net
 - bruno@azisaka.com.br
@@ -202,28 +183,27 @@ files:
 - xduration.gemspec
 homepage: http://github.com/kristianmandrup/xduration
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options:
 - --charset=UTF-8
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.0.0
 signing_key: 
-specification_version: 3
-summary: Duration type
+specification_version: 4
+summary: Duration type with Mongoid 2.4+ support
 test_files: []
 has_rdoc: