timeliness 0.1.0 → 0.1.1

data/CHANGELOG.rdoc

@@ -0,0 +1,6 @@
+= 0.1.1 - 2010-10-14
+* Alias for validates_timeliness compatibility
+* Tiny cleanup
+
+= 0.1.0 - 2010-10-14
+* Initial release

data/README.rdoc

@@ -11,11 +11,11 @@ Date/time parser for Ruby with the following features:
 * It's pretty fast. Up to 60% faster than Time/Date parse method.
 * Control the parser strictness.
 * Control behaviour of ambiguous date formats (US vs European e.g. mm/dd/yy, dd/mm/yy).
-* I18n support (for months).
+* I18n support (for months), if I18n gem loaded.
 * Fewer WTFs than Time/Date parse method.
 * Has no dependencies.
 
-Extracted from the validates_timeliness gem, it has been rewritten cleaner and much faster. It's most suitable for when
+Extracted from my {validates_timeliness gem}[http://github.com/adzap/validates_timeliness], it has been rewritten cleaner and much faster. It's most suitable for when
 you need to control the parsing behaviour. It's faster than the Time/Date class parse methods, so it has general appeal.
 
 
@@ -36,7 +36,7 @@ or specified with :now option:
 
   Timeliness.parse('12:13:14', :now => Time.mktime(2010,9,8)) #=> Wed Sep 08 12:13:14 1000 2010
 
-You can also provide a type which will tell the parser that you are only interested in the values for that type.
+You can also provide a type which will tell the parser that you are only interested in the part of the value for that type.
 
   Timeliness.parse('2010-09-08 12:13:14', :date)     #=> Wed Sep 08 00:00:00 1000 2010
   Timeliness.parse('2010-09-08 12:13:14', :time)     #=> Sat Jan 01 12:13:14 1100 2000
@@ -48,7 +48,7 @@ Now let's get strict. Pass the :strict option with true and things get finicky
   Timeliness.parse('2010-09-08 12:13:14', :time, :strict => true)     #=> nil
   Timeliness.parse('2010-09-08 12:13:14', :datetime, :strict => true) #=> Wed Sep 08 12:13:14 1000 2010 i.e. the whole string is used
 
-The strict option without a type is ignored.
+The date and time strings are not accepted for a datetime type. The strict option without a type is ignored.
 
 To control what zone the time object is returned in, you have two options. Firstly you can set the default zone. Below
 is the list of options with their effective time creation method call
@@ -166,7 +166,7 @@ Here is what each format token means:
 
 All other characters are considered literal. For the technically minded, these formats are compiled into a single regular expression
 
-To see all defined formats look at the {parser source code}[http://github.com/adzap/timeliness/tree/master/lib/timeliness/parser.rb].
+To see all defined formats look at the {source code}[http://github.com/adzap/timeliness/tree/master/lib/timeliness/formats.rb].
 
 
 == Settings

data/lib/timeliness/formats.rb

@@ -163,7 +163,7 @@ module Timeliness
         compile_formats
       end
 
-      # Removes US date formats so that ambigious dates are parsed as European format
+      # Removes US date formats so that ambiguous dates are parsed as European format
       #
       def use_euro_formats
         @date_format_set     = FormatSet.compile(date_formats.select { |format| US_FORMAT_REGEXP !~ format })
@@ -194,18 +194,18 @@ module Timeliness
         case type
         when :date
           [ @date_format_set, @datetime_format_set ]
-        when :time
-          if string.length < 11
-            [ @time_format_set ]
-          else
-            [ @datetime_format_set, @time_format_set ]
-          end
         when :datetime
           if string.length < 11
             [ @date_format_set, @datetime_format_set ]
           else
             [ @datetime_format_set, @date_format_set ]
           end
+        when :time
+          if string.length < 11
+            [ @time_format_set ]
+          else
+            [ @datetime_format_set, @time_format_set ]
+          end
         else
           if string.length < 11
             [ @date_format_set, @time_format_set, @datetime_format_set ]

data/lib/timeliness/parser.rb

@@ -12,11 +12,12 @@ module Timeliness
         time_array = _parse(value, type, options)
         return nil if time_array.nil?
 
-        if type == :date
+        case type
+        when :date
           time_array[3..7] = nil
-        elsif type == :time
+        when :time
           time_array[0..2] = current_date(options)
-        elsif type.nil?
+        when nil
           dummy_date = current_date(options)
           time_array[0] ||= dummy_date[0]
           time_array[1] ||= dummy_date[1]

data/lib/timeliness/version.rb

@@ -1,3 +1,3 @@
 module Timeliness
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

data/lib/timeliness.rb

@@ -12,10 +12,20 @@ module Timeliness
     extend Forwardable
     def_delegators Parser, :parse, :_parse
     def_delegators Formats, :add_formats, :remove_formats, :use_us_formats, :use_euro_formats
+
     attr_accessor :default_timezone, :date_for_time_type, :ambiguous_year_threshold
+
+    alias :dummy_date_for_time_type :date_for_time_type
   end
 
-  # Default timezone (:local or :utc)
+  # Default timezone. Options:
+  #   - :local (default)
+  #   - :utc
+  #   
+  #   If ActiveSupport loaded, also
+  #   - :current
+  #   - 'Zone name'
+  #
   @default_timezone = :local
 
   # Set the default date part for a time type values.

data/timeliness.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{timeliness}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Adam Meehan"]

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: timeliness
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 1
-  - 0
-  version: 0.1.0
+  - 1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Adam Meehan