date_period_parser 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fff42959392de70cbf672c66f173f184875e6ccc
+  data.tar.gz: 62a0d643d3969e188eae4f9f6a8c9cf4efdf261c
+SHA512:
+  metadata.gz: 0b452fb2fecc484d1c57448afdaaadac74ea963cbc0693a86db999d483a681cb169db44d03b7495b897765784efb0a7812cc3c94832b35896acbe82a676be67b
+  data.tar.gz: d9d383b619362e45485f246cdf85d97dd6061be836dc174a2a10ca98b54c3daa72d1da52f3a0e6ed415afe2b88e5e89f09e7e80ec1955ab5c96a42514ede8242

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in date_period_parser.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 hasclass
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,126 @@
+# DatePeriodParser
+
+Parse a date-like string and returns it's start and end DateTime.
+
+This can be used to pass date-periods for URL parameters or query strings, e.g. filtering records in a given period.
+
+```ruby
+class PostsController
+  # GET /posts?period=2015-08
+  def index
+    date_range = DatePeriodParser.range(params["period"])
+    @posts = Posts.where(created_at: date_range)
+  end
+end
+```
+
+It is *not* meant to be a natural language date parser like the [https://github.com/mojombo/chronic](chronic gem).
+
+## Examples
+
+```ruby
+# year
+DatePeriodParse.parse("2014")
+#=> [<#DateTime 2014-01-01T00:00:00.000Z>, <#DateTime 2014-12-31T23:59:59.999Z>]
+
+# months
+DatePeriodParse.parse("2014-02")
+#=> [<#DateTime 2014-02-01T00:00:00.000Z>, <#DateTime 2014-02-28T23:59:59.999Z>]
+
+# day
+DatePeriodParse.parse("2014-12-31")
+#=> [<#DateTime 2014-12-31T00:00:00.000Z>, <#DateTime 2014-12-31T23:59:59.999Z>]
+
+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")
+#=> [<#DateTime 2014-12-31T00:00:00.000+0700>, <#DateTime 2014-12-31T23:59:59.999+0700>]
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'date_period_parser'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install date_period_parser
+
+## Usage
+
+See examples above. Currently supported are:
+
+* years  "2014"
+* months "2014-01"
+* dates  "2014-01-01"
+* shorcuts "today"
+
+It currently requires the year to have 4 digits.
+
+### DatePeriodParser.parse
+
+```ruby
+from,until = DatePeriodParser.parse("2014")
+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 # => #<DateTime 2014-01-01T00:00:00.000+0700")
+until   # => #<DateTime 2014-12-31T23:59:59.999+0700")
+
+# invalid periods
+DatePeriodParser.parse("123213")
+# => nil
+
+# so you can do:
+from,until = DatePeriodParser.parse("123213")
+from  ||= DateTime.yesterday
+until ||= DateTime.now
+
+# parse! raises ArgumentError for invalid periods
+from,until = DatePeriodParser.parse("123213")
+#=> ArgumentError
+```
+
+### DatePeriodParser.range
+
+Works the same as DatePeriodParser.parse but returns a range.
+
+```ruby
+rng = DatePeriodParser.range("2014")
+rng.member? DateTime.new(2014,8,6)
+
+# invalid periods return nil
+rng = DatePeriodParser.range("dsf89sfd")
+# => nil
+
+# range! raises ArgumentError for invalid periods
+rng = DatePeriodParser.range("dsf89sfd")
+#=> ArgumentError
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hasclss/date_period_parser.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "date_period_parser"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/date_period_parser.gemspec

@@ -0,0 +1,33 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'date_period_parser/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "date_period_parser"
+  spec.version       = DatePeriodParser::VERSION
+  spec.authors       = ["hasclass"]
+  spec.email         = ["sebi.burkhard@gmail.com"]
+
+  spec.summary       = %q{Parse a date-like string and returns it's start and end DateTime.}
+  spec.description   = %q{Parse a date-like string and returns it's start and end DateTime.}
+  spec.homepage      = "https://github.com/hasclass/date_period_parser"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.test_files = ["spec/date_period_parser_spec.rb"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/date_period_parser/version.rb

@@ -0,0 +1,3 @@
+module DatePeriodParser
+  VERSION = "0.1.1"
+end

data/lib/date_period_parser.rb

@@ -0,0 +1,118 @@
+require "date_period_parser/version"
+
+require 'date'
+
+module DatePeriodParser
+  DEFAULT_OFFSET = "+00:00".freeze
+
+  # ## Useage
+  #
+  #     from,until = DatePeriodParser.parse("2014")
+  #     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 # => #<DateTime 2014-01-01T00:00:00.000+0700")
+  #     until   # => #<DateTime 2014-12-31T23:59:59.999+0700")
+  #
+  #     # invalid periods
+  #     DatePeriodParser.parse("123213") # => nil
+  #     from,until = DatePeriodParser.parse("123213")
+  #     from # => nil
+  #     until # => nil
+  #
+  #
+  #
+  def parse(str, offset = nil)
+    parse!(str, offset)
+  rescue ArgumentError => e
+    nil
+  end
+
+  def parse!(str, offset = nil)
+    Base.new(str, offset).parse
+  end
+
+  def range(str, offset = nil)
+    range!(str, offset)
+  rescue ArgumentError => e
+    nil
+  end
+
+  def range!
+    first,last = Base.new(str, offset).parse
+    first..last
+  end
+
+  module_function :parse, :parse!, :range, :range!
+
+  class Base
+    attr_reader :value, :offset
+
+    def initialize(value, offset = nil)
+      @value  = value.freeze
+      @offset = (offset || DEFAULT_OFFSET).freeze
+    end
+
+    def parse
+      case @value
+      when /\Atoday\Z/                then parse_date(Date.today)
+      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
+      else raise ArgumentError.new("invalid date period")
+      end
+    end
+
+  protected
+
+    def parse_date(date = nil)
+      if date.nil?
+        year, month, day = @value.split("-").map(&:to_i)
+      else
+        year, month, day = date.year, date.month, date.day
+      end
+
+      date = DateTime.new(year, month, day, 0, 0, 0, offset)
+
+      [
+        date,
+        end_of_date(date)
+      ]
+    end
+
+    def parse_month
+      year, month = @value.split("-")
+
+      first = DateTime.new(year.to_i, month.to_i, 1, 0, 0, 0, offset)
+      [
+        first,
+        last_date_time_of_month(first)
+      ]
+    end
+
+    def parse_year
+      year = @value
+
+      first = DateTime.new(year.to_i, 1,1,0,0,0,offset)
+      [
+        first,
+        last_date_time_of_month(first >> 11)
+      ]
+    end
+
+    def last_date_time_of_month(dt)
+      first_day_this_month = DateTime.new(dt.year, dt.month, 1, 0, 0, 0, offset)
+      first_day_next_month = first_day_this_month >> 1
+      last_day_this_month  = first_day_next_month - 1
+
+      d = last_day_this_month
+      end_of_date(d)
+    end
+
+    def end_of_date(dt)
+      DateTime.new(dt.year, dt.month, dt.day, 23, 59, 59.999, offset)
+    end
+  end
+end

data/spec/date_period_parser_spec.rb

@@ -0,0 +1,96 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require "minitest/autorun"
+require 'date_period_parser'
+
+describe DatePeriodParser do
+  def parse(str, offset = nil)
+    DatePeriodParser.parse(str, offset)
+  end
+
+  it '2014' do
+    assert_equal DateTime.parse("2014-01-01T00:00:00.000+0000"),  parse("2014").first
+    assert_equal DateTime.parse("2014-12-31T23:59:59.999+0000"),  parse("2014").last
+  end
+
+  it '2014-01' do
+    assert_equal DateTime.parse("2014-01-01T00:00:00.000+0000"),  parse("2014-01").first
+    assert_equal DateTime.parse("2014-01-31T23:59:59.999+0000"),  parse("2014-01").last
+  end
+
+  it '2014-02' do
+    assert_equal DateTime.parse("2014-02-01T00:00:00.000+0000"),  parse("2014-02").first
+    assert_equal DateTime.parse("2014-02-28T23:59:59.999+0000"),  parse("2014-02").last
+
+    assert_equal DateTime.parse("2012-02-01T00:00:00.000+0000"),  parse("2012-02").first
+    assert_equal DateTime.parse("2012-02-29T23:59:59.999+0000"),  parse("2012-02").last
+  end
+
+  it '2014-12' do
+    assert_equal DateTime.parse("2014-12-01T00:00:00.000+0000"),  parse("2014-12").first
+    assert_equal DateTime.parse("2014-12-31T23:59:59.999+0000"),  parse("2014-12").last
+  end
+
+  it '2014-08' do
+    assert_equal DateTime.parse("2014-08-01T00:00:00.000+0000"),  parse("2014-08").first
+    assert_equal DateTime.parse("2014-08-31T23:59:59.999+0000"),  parse("2014-08").last
+  end
+
+  it '2014-01-01' do
+    assert_equal DateTime.parse("2014-01-01T00:00:00.000+0000"),  parse("2014-01-01").first
+    assert_equal DateTime.parse("2014-01-01T23:59:59.999+0000"),  parse("2014-01-01").last
+  end
+
+  it '2014-12-31' do
+    assert_equal DateTime.parse("2014-12-31T00:00:00.000+0000"),  parse("2014-12-31").first
+    assert_equal DateTime.parse("2014-12-31T23:59:59.999+0000"),  parse("2014-12-31").last
+  end
+
+  it 'today' do
+    today = Date.today
+    assert_equal DateTime.parse("#{today}T00:00:00.000+0000"),  parse("today").first
+    assert_equal DateTime.parse("#{today}T23:59:59.999+0000"),  parse("today").last
+  end
+
+  describe "with offsets" do
+    it '2014' do
+      assert_equal DateTime.parse("2014-01-01T00:00:00.000+0700"),  parse("2014", "+0700").first
+      assert_equal DateTime.parse("2014-12-31T23:59:59.999+0700"),  parse("2014", "+0700").last
+    end
+
+    it '2014-01' do
+      assert_equal DateTime.parse("2014-01-01T00:00:00.000+0700"),  parse("2014-01", "+7").first
+      assert_equal DateTime.parse("2014-01-31T23:59:59.999+0700"),  parse("2014-01", "+7").last
+    end
+
+    it '2014-01-01' do
+      assert_equal DateTime.parse("2014-01-01T00:00:00.000+0700"),  parse("2014-01-01", "+7").first
+      assert_equal DateTime.parse("2014-01-01T23:59:59.999+0700"),  parse("2014-01-01", "+7").last
+    end
+
+    it 'today' do
+      today = Date.today
+      assert_equal DateTime.parse("#{today}T00:00:00.000+0700"),  parse("today", "+7").first
+      assert_equal DateTime.parse("#{today}T23:59:59.999+0700"),  parse("today", "+7").last
+    end
+  end
+
+  it 'invalid pattern 2014-01-01-01' do
+    from, to = parse("2014-01-01-01")
+    assert_equal nil,  from
+    assert_equal nil,  to
+    # it is actually nil and not [nil, nil]
+    assert_equal nil,  parse("2014-01-01-01")
+  end
+
+  it 'invalid date 2014-13-01' do
+    assert_raises(ArgumentError) do
+      assert_equal DateTime.parse("2014-01-01T00:00:00.000+0000"),  DatePeriodParser.parse!("2014-13-01").first
+    end
+    assert_raises(ArgumentError) 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
+    end
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: date_period_parser
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- hasclass
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-08-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Parse a date-like string and returns it's start and end DateTime.
+email:
+- sebi.burkhard@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- date_period_parser.gemspec
+- lib/date_period_parser.rb
+- lib/date_period_parser/version.rb
+- spec/date_period_parser_spec.rb
+homepage: https://github.com/hasclass/date_period_parser
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Parse a date-like string and returns it's start and end DateTime.
+test_files:
+- spec/date_period_parser_spec.rb