date_period_parser 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9568f1e71186ac31a20d9a846213116cc8f84878
-  data.tar.gz: 1bb0d2e0e60544311cd7f5e0f7358153edfd1ce1
+  metadata.gz: 133a42526128ad51856ce395e6c78d80b9bf055e
+  data.tar.gz: 275d7a0d7a3c2aa139b531258dba1381236e776e
 SHA512:
-  metadata.gz: 8adf231887572db922d0ae3f562bc97388944a6c84a6473e225f987e81c275d71570c091fb2cc46bb135faa6c0b9ce010915a11c18533fc6f9550f5c4452d3b9
-  data.tar.gz: 2a8fdd8fba6e101de2f0c859411eac3a457d275e91856b2e3c2d049d31ece2cd0e94aa29c2f26d00f3a84993ed353d9a9170fa463093f470079880d71fbd0b95
+  metadata.gz: 588749532d5a8686966fc13e4571ab2813b744c63955ffbfd70d63a39a2c6a2a65f7c6b99ba2c52b12143b83ed4788c610ba72f72bff938723052f2344b03fca
+  data.tar.gz: 77f86b17364e4d176d7d505b64ab7d4ec5157c3a3c49d2b91cfd00d2315b56358d8d260830f71e762518bc55eb4d962dfe3945bb817c4241e846ae9f73310ca9

data/README.md

@@ -21,7 +21,16 @@ class PostsController
 end
 ```
 
-It is **not** a natural language date parser like the [chronic gem](https://github.com/mojombo/chronic).
+It is **not** a natural language date parser like the [chronic gem](https://github.com/mojombo/chronic). But intends to parse common formats like [ISO_8601](https://en.wikipedia.org/wiki/ISO_8601).
+
+Examples:
+
+* years  `YYYY`
+* months `YYYY-MM`
+* dates  `YYYY-MM-DD`
+* beginning of year/month to now `ytd`, `mtd`
+* shorcuts `today`, `yesterday` and `yday`, `current-month`, `previous-month`, `current-year`, `previous-year`
+
 
 Tested with all common Rubies, 1.9.3 .. 2.2, JRuby (1.9 mode). For details check .travis.yml
 
@@ -64,16 +73,25 @@ Or install it yourself as:
 
     $ gem install date_period_parser
 
-## Usage
-
-See examples above. Currently supported are:
-
-* years  `YYYY`
-* months `YYYY-MM`
-* dates  `YYYY-MM-DD`
-* shorcuts `today`, `yesterday` and `yday`, `current-month`, `previous-month`, `current-year`, `previous-year`
-
-It currently requires the year to have 4 digits.
+## Recognized patterns
+
+Values below for today: 2015-07-14 15:33
+
+| Pattern            | From             | Until            |
+|--------------------|------------------|------------------|
+| 2015               | 2015-01-01 00:00 | 2015-12-31 23:59 |
+| ytd                | 2015-01-01 00:00 | 2015-07-14 15:33 |
+| current-year       | 2015-01-01 00:00 | 2015-07-31 23:59 |
+| previous-year      | 2014-01-01 00:00 | 2014-12-31 23:59 |
+| 2015-07            | 2015-07-01 00:00 | 2015-07-31 23:59 |
+| mtd                | 2015-07-01 00:00 | 2015-07-14 15:33 |
+| current-month      | 2015-07-01 00:00 | 2015-07-31 23:59 |
+| previous-month     | 2015-06-01 00:00 | 2015-06-30 23:59 |
+| 2015-12-31         | 2015-12-31 00:00 | 2015-12-31 23:59 |
+| today              | 2015-07-14 00:00 | 2015-07-14 23:59 |
+| yesterday          | 2015-07-13 00:00 | 2015-07-13 23:59 |
+
+Difference between `ytd` and `current-year` (`mtd` and `current-month` respectively) is that `ytd` will return DateTime.now vs. current-month spans from first to last day of the month.
 
 ### DatePeriodParser.parse
 

data/lib/date_period_parser.rb

@@ -63,8 +63,10 @@ module DatePeriodParser
       when /\Ayday\Z/                 then parse_date(Date.today - 1)
       when /\Acurrent-month\Z/        then parse_month(Date.today)
       when /\Aprevious-month\Z/       then parse_month(Date.today << 1)
-      when /\Acurrent-year\Z/        then parse_year(Date.today)
-      when /\Aprevious-year\Z/       then parse_year(Date.today << 12)
+      when /\Acurrent-year\Z/         then parse_year(Date.today)
+      when /\Aprevious-year\Z/        then parse_year(Date.today << 12)
+      when /\Amtd\Z/                  then mtd
+      when /\Aytd\Z/                  then ytd
       when /\A\d\d\d\d\Z/             then parse_year
       when /\A\d\d\d\d\-\d\d\Z/       then parse_month
       when /\A\d\d\d\d\-\d\d\-\d\d\Z/ then parse_date
@@ -73,6 +75,26 @@ module DatePeriodParser
     end
 
   protected
+    def now_with_offset
+      d = DateTime.now
+      DateTime.new(d.year, d.month, d.day, d.hour, d.minute, d.second, offset)
+    end
+
+    def mtd
+      now = now_with_offset
+      [
+        DateTime.new(now.year, now.month, 1, 0, 0, 0, offset),
+        now
+      ]
+    end
+
+    def ytd
+      now = now_with_offset
+      [
+        DateTime.new(now.year, 1, 1, 0, 0, 0, offset),
+        now
+      ]
+    end
 
     def parse_date(date = nil)
       if date.nil?
@@ -126,6 +148,10 @@ module DatePeriodParser
       end_of_date(d)
     end
 
+    def start_of_date(dt)
+      DateTime.new(dt.year, dt.month, dt.day, 0,  0,  0, offset)
+    end
+
     def end_of_date(dt)
       DateTime.new(dt.year, dt.month, dt.day, 23, 59, 59.999, offset)
     end

data/lib/date_period_parser/version.rb

@@ -1,3 +1,3 @@
 module DatePeriodParser
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/spec/date_period_parser_spec.rb

@@ -82,9 +82,23 @@ describe DatePeriodParser do
 
 
   it 'ytd' do
+    t = DateTime.now
+    assert_equal DateTime.new(t.year, 1, 1, 0, 0, 0.000, "+0000"),                        parse("ytd").first
+    assert_equal DateTime.new(t.year, t.month, t.day, t.hour,t.minute,t.second, "+0000"), parse("ytd").last
+
+    assert_equal DateTime.new(t.year, 1, 1, 0, 0, 0.000, "+0400"),                        parse("ytd", offset: "+0400").first
+    assert_equal DateTime.new(t.year, t.month, t.day, t.hour,t.minute,t.second, "+0400"), parse("ytd", offset: "+0400").last
   end
+
   it 'mtd' do
-  end
+    t = DateTime.now
+    assert_equal DateTime.new(t.year, t.month, 1, 0, 0, 0.000, "+0000"),                  parse("mtd").first
+    assert_equal DateTime.new(t.year, t.month, t.day, t.hour,t.minute,t.second, "+0000"), parse("mtd").last
+
+    assert_equal DateTime.new(t.year, t.month, 1, 0, 0, 0.000, "+0400"),                  parse("mtd", offset: "+0400").first
+    assert_equal DateTime.new(t.year, t.month, t.day, t.hour,t.minute,t.second, "+0400"), parse("mtd", offset: "+0400").last
+    end
+
   it 'wtd' do
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: date_period_parser
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - hasclass