date_period_parser 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 90516f6773fd43e04a5134ea3c2d067d885ea5f8
-  data.tar.gz: 4038d871c3a4339bb709ef6e7010a4947ad5b2a5
+  metadata.gz: 9c07ac23b3837999e42abd603e613c83033866e4
+  data.tar.gz: f0474b0706edd9799c033924a2341a0ba73cb8ed
 SHA512:
-  metadata.gz: a4e833f6ad144dcf5c2883feb4f4f5d0fc31a245b1dce0b39fc22ff4310cb4f9d2f9405043a0bf0c404d50437a051bb00e974bdceb6b3c1e4d5ec79015e79c3a
-  data.tar.gz: c28fefc56507da2baa84c8dd79dece8e8cb0a5e3b09e6558724894d4d59946c5e07f0116d095b71dcdf5e9138242febbe116d048e9e2218ff5bc74120da77ec0
+  metadata.gz: a9294cf45307a6ce57997bd9806b74d17104a87fbdeab9f816c4b706b7ffaf27eb54d8e2dc98ec72ae8f19ae54f574b20b3f803080111aa3355d31147b587990
+  data.tar.gz: 94211e5781292b746aecc88f69ef7936f55065b44238ab4866ef451f8c9c0101ed1e2614300da001cb3c06cef51f9e3b62880919b1dbce77b72605c69f0f77c2

data/README.md

@@ -4,23 +4,21 @@
 
 Parse a date-period string like 2015-Q1 and returns the start and end DateTime.
 
-Useful for reports to filterin records for a given time period.
+Useful for reporting/pagination/search to filter records for a given time period.
+
+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).
 
 ```ruby
-# Example useage in a rails controller
-
-class PostsController
-  # GET /posts?period=2015-08
-  def index
-    date_range = DatePeriodParser.range(params["period"], default: "this-month")
-    @posts = Posts.where(created_at: date_range)
-  end
+# Example useage in a rails controller action
+
+# GET /posts?period=2015-08
+def index
+  date_range = DatePeriodParser.range(params["period"], default: "today")
+  @posts = Posts.where(created_at: date_range)
 end
 ```
 
-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:
+Examples periods:
 
 * years  `YYYY`
 * months `YYYY-MM`

data/lib/date_period_parser.rb

@@ -95,7 +95,7 @@ module DatePeriodParser
   #
   def range!(period, options = {})
     period = options[:default] if period.nil? || period.empty?
-    first,last = Base.new(period, offset).parse
+    first,last = Base.new(period, options).parse
     first..last
   end
 

data/lib/date_period_parser/version.rb

@@ -1,3 +1,3 @@
 module DatePeriodParser
-  VERSION = "0.2.3"
+  VERSION = "0.2.4"
 end

data/spec/date_period_parser_spec.rb

@@ -7,6 +7,14 @@ describe DatePeriodParser do
     DatePeriodParser.parse(str, opts)
   end
 
+  def range(str, opts = {})
+    DatePeriodParser.range(str, opts)
+  end
+
+  it "range" do
+    range("today")
+  end
+
   it 'parse' do
     assert parse(:today) != nil
     assert_equal DateTime.new(2014, 1, 1,  0,  0,  0.000, "+0000"),  parse("2014").first

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: date_period_parser
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.2.4
 platform: ruby
 authors:
 - hasclass
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-09-16 00:00:00.000000000 Z
+date: 2015-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler