date_period_parser 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 50f01a223cc9dd3cc0aa207a58574c52c1bf8d55
-  data.tar.gz: d377682cd50e84844206f31f71f2d12615e5a1ec
+  metadata.gz: 9568f1e71186ac31a20d9a846213116cc8f84878
+  data.tar.gz: 1bb0d2e0e60544311cd7f5e0f7358153edfd1ce1
 SHA512:
-  metadata.gz: b025ae4f53aa7a07d64f7f40d7490e7c88663096af413e8c686a18006ceabeccb8ab4924df79192b00d589974caf02eb55733fc980f0c6e801509cf5d6c62239
-  data.tar.gz: 92d85586e7ee87b2cdec6cf7c0d99e58f2fd323f07a40e9a91dd6f314908d8a7c1a6fed0c4566bafc02d3ef1f8b7121f0f7e9130389510d4f7bba5799a041efe
+  metadata.gz: 8adf231887572db922d0ae3f562bc97388944a6c84a6473e225f987e81c275d71570c091fb2cc46bb135faa6c0b9ce010915a11c18533fc6f9550f5c4452d3b9
+  data.tar.gz: 2a8fdd8fba6e101de2f0c859411eac3a457d275e91856b2e3c2d049d31ece2cd0e94aa29c2f26d00f3a84993ed353d9a9170fa463093f470079880d71fbd0b95

data/README.md

@@ -13,6 +13,8 @@ class PostsController
   # GET /posts?period=2015-08
   def index
     date_range = DatePeriodParser.range(params["period"])
+    # with user specific timezones
+    # date_range = DatePeriodParser.range(params["period"], offset: current_user.timezone)
     date_range ||= DatePeriodParser.range("current-month") # default
     @posts = Posts.where(created_at: date_range)
   end
@@ -42,7 +44,7 @@ DatePeriodParse.parse("today")
 #=> [<#DateTime 2015-08-31T00:00:00.000Z>, <#DateTime 2014-08-31T23:59:59.999Z>]
 
 # timezone offsets
-DatePeriodParse.parse("2014-12-31", "+0700")
+DatePeriodParse.parse("2014-12-31", offset: "+0700")
 #=> [<#DateTime 2014-12-31T00:00:00.000+0700>, <#DateTime 2014-12-31T23:59:59.999+0700>]
 ```
 
@@ -81,7 +83,7 @@ from # => #<DateTime 2014-01-01T00:00:00.000+0000")
 until   # => #<DateTime 2014-12-31T23:59:59.999+0000")
 
 # offsets:
-from,until = DatePeriodParser.parse("2014", "+0700")
+from,until = DatePeriodParser.parse("2014", offset: "+0700")
 from # => #<DateTime 2014-01-01T00:00:00.000+0700")
 until   # => #<DateTime 2014-12-31T23:59:59.999+0700")
 

data/lib/date_period_parser/version.rb

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

data/lib/date_period_parser.rb

@@ -12,7 +12,7 @@ module DatePeriodParser
   #     until   # => #<DateTime 2014-12-31T23:59:59.999+0000")
   #
   #     # offsets:
-  #     from,until = DatePeriodParser.parse("2014", "+0700")
+  #     from,until = DatePeriodParser.parse("2014", offset: "+0700")
   #     from # => #<DateTime 2014-01-01T00:00:00.000+0700")
   #     until   # => #<DateTime 2014-12-31T23:59:59.999+0700")
   #
@@ -24,23 +24,23 @@ module DatePeriodParser
   #
   #
   #
-  def parse(str, offset = nil)
-    parse!(str, offset)
+  def parse(str, options = {})
+    parse!(str, options)
   rescue ArgumentError => e
     nil
   end
 
-  def parse!(str, offset = nil)
-    Base.new(str, offset).parse
+  def parse!(str, options = {})
+    Base.new(str, options).parse
   end
 
-  def range(str, offset = nil)
-    range!(str, offset)
+  def range(str, options = {})
+    range!(str, options)
   rescue ArgumentError => e
     nil
   end
 
-  def range!
+  def range!(str, options = {})
     first,last = Base.new(str, offset).parse
     first..last
   end
@@ -50,9 +50,10 @@ module DatePeriodParser
   class Base
     attr_reader :value, :offset
 
-    def initialize(value, offset = nil)
-      @value  = value.freeze
-      @offset = (offset || DEFAULT_OFFSET).freeze
+    def initialize(value, options = nil)
+      options ||= {} # in case someone sends Base.new("", nil)
+      @value    = value.freeze
+      @offset = (options[:offset] || options['offset'] || DEFAULT_OFFSET).freeze
     end
 
     def parse

data/spec/date_period_parser_spec.rb

@@ -3,8 +3,18 @@ require "minitest/autorun"
 require 'date_period_parser'
 
 describe DatePeriodParser do
-  def parse(str, offset = nil)
-    DatePeriodParser.parse(str, offset)
+  def parse(str, opts = {})
+    DatePeriodParser.parse(str, opts)
+  end
+
+  it 'parse' do
+    assert_equal DateTime.new(2014, 1, 1,  0,  0,  0.000, "+0000"),  parse("2014").first
+    assert_equal DateTime.new(2014, 1, 1,  0,  0,  0.000, "+0000"),  parse("2014", nil).first
+    assert_equal DateTime.new(2014, 1, 1,  0,  0,  0.000, "+0000"),  parse("2014", {}).first
+    assert_equal DateTime.new(2014, 1, 1,  0,  0,  0.000, "+0000"),  parse("2014", {offset: nil}).first
+    assert_equal DateTime.new(2014, 1, 1,  0,  0,  0.000, "+0000"),  parse("2014", {'offset' => nil}).first
+    assert_equal DateTime.new(2014, 1, 1,  0,  0,  0.000, "+0700"),  parse("2014", {offset: "+0700"}).first
+    assert_equal DateTime.new(2014, 1, 1,  0,  0,  0.000, "+0700"),  parse("2014", {'offset' => "+0700"}).first
   end
 
   it '2014' do
@@ -108,24 +118,24 @@ describe DatePeriodParser do
 
   describe "with offsets" do
     it '2014' do
-      assert_equal DateTime.new(2014, 1, 1,  0,  0,  0.000, "+0700"),  parse("2014", "+0700").first
-      assert_equal DateTime.new(2014,12,31, 23, 59, 59.999, "+0700"),  parse("2014", "+0700").last
+      assert_equal DateTime.new(2014, 1, 1,  0,  0,  0.000, "+0700"),  parse("2014", offset: "+0700").first
+      assert_equal DateTime.new(2014,12,31, 23, 59, 59.999, "+0700"),  parse("2014", offset: "+0700").last
     end
 
     it '2014-01' do
-      assert_equal DateTime.new(2014, 1, 1,  0,  0,  0.000, "+0700"),  parse("2014-01", "+7").first
-      assert_equal DateTime.new(2014, 1,31, 23, 59, 59.999, "+0700"),  parse("2014-01", "+7").last
+      assert_equal DateTime.new(2014, 1, 1,  0,  0,  0.000, "+0700"),  parse("2014-01", offset: "+7").first
+      assert_equal DateTime.new(2014, 1,31, 23, 59, 59.999, "+0700"),  parse("2014-01", offset: "+7").last
     end
 
     it '2014-01-01' do
-      assert_equal DateTime.new(2014, 1, 1,  0,  0,  0.000, "+0700"),  parse("2014-01-01", "+7").first
-      assert_equal DateTime.new(2014, 1, 1, 23, 59, 59.999, "+0700"),  parse("2014-01-01", "+7").last
+      assert_equal DateTime.new(2014, 1, 1,  0,  0,  0.000, "+0700"),  parse("2014-01-01", offset: "+7").first
+      assert_equal DateTime.new(2014, 1, 1, 23, 59, 59.999, "+0700"),  parse("2014-01-01", offset: "+7").last
     end
 
     it 'today' do
       t = Date.today
-      assert_equal DateTime.new(t.year, t.month, t.day,  0,  0,  0.000, "+0700"),  parse("today", "+7").first
-      assert_equal DateTime.new(t.year, t.month, t.day, 23, 59, 59.999, "+0700"),  parse("today", "+7").last
+      assert_equal DateTime.new(t.year, t.month, t.day,  0,  0,  0.000, "+0700"),  parse("today", offset: "+7").first
+      assert_equal DateTime.new(t.year, t.month, t.day, 23, 59, 59.999, "+0700"),  parse("today", offset: "+7").last
     end
   end
 
@@ -147,7 +157,7 @@ describe DatePeriodParser do
       assert_equal DateTime.parse("2014-01-01T00:00:00.000+0000"),  DatePeriodParser.parse!("2014-12-41").first
     end
     assert_raises(ArgumentError) do
-      assert_equal DateTime.parse("2014-01-01T00:00:00.000+0000"),  DatePeriodParser.parse!("2014-12-41", "+2400").first
+      assert_equal DateTime.parse("2014-01-01T00:00:00.000+0000"),  DatePeriodParser.parse!("2014-12-41", offset: "+2400").first
     end
   end
 end

metadata

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