pbyrne-valid-date 1.0.0 → 1.0.1

data/README

@@ -1,2 +1,13 @@
-# TODO add a brief readme
-# TODO Add RDoc documentation to lib/valid-date.rb
+Adds String#valid_date? method to add utility to the Rails String#to_date method. Determines whether the string contains a valid date, to check before converting to a date and avoiding an exception.
+
+Examples:
+
+    "2008-01-01".valid_date? #=> true
+    "20080101".valid_date?   #=> true
+    "0000-00-00".valid_date? #=> false
+    "".valid_date?           #=> nil
+    
+
+This gem is released under a broad open-source license. See LICENSE for more details.
+
+# TODO consider switching from manual gemspec to using jeweler (the recommended tool by github to manage the gemspec)

data/lib/valid-date.rb

@@ -1,6 +1,15 @@
+# todo should this require be in the gemspec, since we assume active support is already loaded when using the gem, per the gemspec?
 require 'activesupport'
 
 class String
+  # 
+  # Determines whether the string contains a valid date for use with the Rails String#to_date method.
+  # 
+  #   "2008-01-01".valid_date? #=> true
+  #   "20080101".valid_date?   #=> true
+  #   "0000-00-00".valid_date? #=> false
+  #   "".valid_date?           #=> nil
+  # 
   def valid_date?
     unless self == ''
       begin

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: pbyrne-valid-date
 version: !ruby/object:Gem::Version 
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors: 
 - Patrick Byrne
@@ -33,7 +33,7 @@ extra_rdoc_files:
 files: 
 - lib/valid-date.rb
 - README
-has_rdoc: false
+has_rdoc: true
 homepage: http://github.com/pbyrne/valid-date/
 post_install_message: 
 rdoc_options: []