merb-helpers 1.0.3 → 1.0.4

data/lib/merb-helpers/core_ext.rb

@@ -40,7 +40,6 @@ class Time
   end
   
   def to_time; self; end
-  public :to_date
 end
 
 # Truncates a string to the given length and appends the given suffix if the string is, in fact, truncated.

data/lib/merb-helpers/date_time_formatting.rb

@@ -11,23 +11,28 @@ module DateAndTimeFormatting
   module InstanceMethods
     
     
-    # Format a date/time instance using a defined format
+    # Formats a date/time instance using a defined format
     #
     # ==== Parameters
     # format<Symbol>:: of the format key from Date.date_formats
     #
     # ==== Returns
     # String:: formatted string
-    #
+    # 
     # ==== Example
     #   Time.now.formatted(:rfc822) # => "Sun, 16 Nov 2007 00:21:16 -0800"
     #   Time.now.formatted(:db) # => "2008-11-16 00:22:09"
     #
-    # You can also add your own formats using +Date.add_format+
+    # You can also add your own formats using +Date.add_format+ when your app loads.
+    #
+    # # Add the following to your init.rb
+    #   Merb::BootLoader.before_app_loads do
+    #     Date.add_format(:matt, "%H:%M:%S %Y-%m-%d")
+    #   end
     #
-    #   Date.add_format(:matt, "%H:%M:%S %Y-%m-%d")
+    # # Format a Time instance with the format you just specified
     #   Time.now.formatted(:matt) # => "00:00:00 2007-11-02"
-    # 
+    #
     #--
     # @public
     def formatted(format = :default)
@@ -58,6 +63,13 @@ module DateAndTimeFormatting
     end
     
     # Adds a date and time format
+    # 
+    # Because this operation is not thread safe, you should define
+    # custom formats when you load you application. The recommended way
+    # to do that, is to use the before_app_loads bootloader.
+    #
+    # If you want to add a format at runtime, you will need to use a mutex
+    # and synchronize it yourself.
     #
     # ==== Parameters
     # key<Symbol>:: name of the format
@@ -68,8 +80,10 @@ module DateAndTimeFormatting
     #
     # ==== Example
     #
-    #   Date.add_format(:matt, "%H:%M:%S %Y-%m-%d")
-    #   Time.now.formatted(:matt) # => "00:00:00 2007-11-02"
+    #   Merb::BootLoader.before_app_loads do
+    #     Date.add_format(:matt, "%H:%M:%S %Y-%m-%d")
+    #   end
+    # 
     #
     # --
     # @public
@@ -94,7 +108,7 @@ module Ordinalize
   # Ordinalize turns a number into an ordinal string used to denote the
   # position in an ordered sequence such as 1st, 2nd, 3rd, 4th.
   #
-  # Examples
+  # ==== Examples
   #   1.ordinalize     # => "1st"
   #   2.ordinalize     # => "2nd"
   #   1002.ordinalize  # => "1002nd"
@@ -128,7 +142,7 @@ module OrdinalizedFormatting
   # Gives you a relative date in an attractive format
   #
   # ==== Parameters
-  # format<String>:: strftime string used to formatt a time/date object
+  # format<String>:: strftime string used to format a time/date object
   # locale<String, Symbol>:: An optional value which can be used by localization plugins
   #
   # ==== Returns
@@ -139,4 +153,4 @@ module OrdinalizedFormatting
   def strftime_ordinalized(fmt, format=nil)
     strftime(fmt.gsub(/(^|[^-])%d/, '\1_%d_')).gsub(/_(\d+)_/) { |s| s.to_i.ordinalize }
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: merb-helpers
 version: !ruby/object:Gem::Version 
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors: 
 - Michael D. Ivey
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-11-25 00:00:00 -08:00
+date: 2008-12-08 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,7 +20,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.0.3
+        version: 1.0.4
     version: 
 description: Helper support for Merb
 email: ivey@gweezlebur.com