date-formatter 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c390fc86284148fbbd76384d5e0a2a81aa92db33
-  data.tar.gz: b0a78b8d0d1b342d99125b7b7b64a5cecc2265f3
+  metadata.gz: 9df162a0fb3e1ec3c03706ff45460dd2063c2fa5
+  data.tar.gz: 77554d8bae8a8775767c02d8f0e4d1b26df8ea85
 SHA512:
-  metadata.gz: 4b470f1e3b04ec4146175e488c1b210129799b3083188f9e21e1cc44c94b12303e5a47a535d740e187334026a38cfe8852cfe44774e125b1ad9cf46f4d8f370f
-  data.tar.gz: b751629fdfb1be81962c61a00d1ae28cb5754a4112b59a06c0861d2c763bd4b8a0dbceea14e9be61834e8977a8ac048e672308bc21f685e1675a529501977790
+  metadata.gz: f712a4d3e6494680829656dfb2cdf07afec25402a06c543c6b963905bcb4df5bf8b163ae8bd77b00341fba88d184986a163e20954b53feb214054b3affd58359
+  data.tar.gz: dc2017997ec35eb9a10aac2bc344d4dedbe9aa1493236f44bc5706fc466431716d45a4f1f49211b22ca0e1680d06b7a40f94ad0c420d34dd6ea7a4d9cea24821

data/README.md

@@ -1,4 +1,4 @@
-# date-formatter - date formatter by example; auto-builds the strftime format string from a example date
+# date-formatter - date formatter by example; auto-builds the strftime format string from an example date
 
 
 * home  :: [github.com/feedreader/pluto](https://github.com/feedreader/pluto)
@@ -9,24 +9,81 @@
 
 
 
-
 ## Usage
 
+The date by example lets you format dates e.g. "January 04, 2020" 
+using an example as a format string e.g "January 04, 2020" instead of the classic strftime format specifier e.g. "%B %d, %Y". The date by example adds:
+
+- `String#to_strfime`
+- `Date#format`
+- `Time#format`
+- `DateTime#format`
+- `NilClass#format`
+
+to the built-in classes.
+
+
+
+### `String#to_strftime`
+
+The new `String#to_strftime` method auto-builds the `strftime` format string
+from an example date:
+
+``` ruby
+require 'date/formatter'
+
+p 'January 02, 2006'.to_strftime          #=> "%B %d, %Y"
+p 'Mon, Jan 02'.to_strftime               #=> "%a, %b %d"
+p '2 Jan 2006'.to_strftime                #=> "%-d %b %Y"
+p 'Monday, January 2, 2006'.to_strftime   #=> "%A, %B %-d, %Y"
+
+p 'Mon, Jan 02 3:00'.to_strftime          #=> "%a, %b %d %-H:%M"
+p '2 Mon 2006 03:00'.to_strftime          #=> "%-d %b %Y %H:%M"
+```
+
+
+### `Date#format`
+
+The new `Date#format` method formats the date like the passed in example:
+
+``` ruby
+date = Date.today   ## test run on 2020-02-09
+
+p date.format( 'January 02, 2006' )         #=> "February 09, 2020"
+p date.format( 'Mon, Jan 02' )              #=> "Sun, Feb 09"
+p date.format( '2 Jan 2006' )               #=> "9 Feb 2020"
+p date.format( 'Monday, January 2, 2006' )  #=> "Sunday, February 9, 2020"
+```
+
+
+
+### `Time#format`
+
+The new `Time#format` method format the time like the passed in example:
+
+``` ruby
+time = Time.now     ## test run on 2020-02-09 00:00
 
+p time.format( 'January 02, 2006' )         #=> "February 09, 2020"
+p time.format( 'Mon, Jan 02' )              #=> "Sun, Feb 09"
+p time.format( '2 Jan 2006' )               #=> "9 Feb 2020"
+p time.format( 'Monday, January 2, 2006' )  #=> "Sunday, February 9, 2020"
 
-Examples:
+p time.format( 'Mon, Jan 02 3:00' )         #=> "Sun, Feb 09 0:00"
+p time.format( '2 Mon 2006 03:00' )         #=> "9 Sun 2020 00:00"
+```
 
-| Date by Example         | => `strftime` Format |
-|-------------------------|----------------|
-| January 04, 2020        | => `%B %d, %Y` |
-| Fri, Jan 04             | => `%a, %b %d` |
-| 4 Jan 2020              | => `%-d %b %Y` |
-| Friday, January 4, 2020 | => `%A, %B %-d, %Y` |
-| Fri, Jan 04 8:00        | => `%a, %b %d %-H:%M` |
-| 4 Jan 2020 08:00        | => `%-d %b %Y %H:%M` |
 
+### `NilClass#format`
 
+For convenience the new `NilClass#format` will catch format calls on `nil`  
+and NOT crash but return an empty string
+following the `NilClass#to_s` example:
 
+``` ruby
+p nil.format( 'January 02, 2006' )         #=> ""
+p nil.to_s                                 #=> ""
+```
 
 
 ## License

data/Rakefile

@@ -5,7 +5,7 @@ Hoe.spec 'date-formatter' do
 
   self.version = DateByExample::VERSION
 
-  self.summary = "date-formatter - date formatter by example; auto-builds the strftime format string from a example date"
+  self.summary = "date-formatter - date formatter by example; auto-builds the strftime format string from an example date"
   self.description = summary
 
   self.urls    = ['https://github.com/feedreader/pluto']

data/lib/date-formatter/version.rb

@@ -1,8 +1,8 @@
 
 module DateByExample
     MAJOR = 0    ## todo: namespace inside version or something - why? why not??
-    MINOR = 0
-    PATCH = 1
+    MINOR = 1
+    PATCH = 0
     VERSION = [MAJOR,MINOR,PATCH].join('.')
   
     def self.version

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: date-formatter
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Gerald Bauer
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.16'
 description: date-formatter - date formatter by example; auto-builds the strftime
-  format string from a example date
+  format string from an example date
 email: wwwmake@googlegroups.com
 executables: []
 extensions: []
@@ -83,5 +83,5 @@ rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: date-formatter - date formatter by example; auto-builds the strftime format
-  string from a example date
+  string from an example date
 test_files: []