date_interval 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 813d0b8efd859f424896abe5f481d49f4b8c6f52
-  data.tar.gz: b7e075815608d25339f44a5e7e85415081cfecee
+  metadata.gz: 50fe6f00cdc14871f25bf3ebd95be0fd146b8403
+  data.tar.gz: c63993f601f26eeddaf989e72a27cad8f77a5910
 SHA512:
-  metadata.gz: 778f7247a5b7a65096b959aa518bad9b176810732dbfaf7e84029b04c57ddff6c416cef3b10bd1618ee70f71790e4eafdee49e464720b14b4e8d9da3ef67da03
-  data.tar.gz: 5983f419c51d80b2769b3e9369811b2c7e898b49cb1a86a0ba7d4bcb436bdb2a0b803c7a26f8d8f77e203773f7337e09b9d68889f27adc54446189080f767d65
+  metadata.gz: f9f1302693ed944c6c3c6d043d56ce6813878e8b1a45309df1dc11b083d7673a824cb7a73aad80b64337d158fff353f3241b8447161cf1eef39bf7c14e054e78
+  data.tar.gz: 4a9acc94cd65932d63f8769bc8c838e62b4800f5f1a16c715fd4a80aec9fbeb772d2cb5d34d6149ea4c03ea366a185298651b2d0c9de9c55e4e3d66b76850bc4

data/README.md

@@ -1,5 +1,8 @@
 # DateInterval
 
+[![Build Status](https://travis-ci.org/fnando/date_interval.png?branch=master)](https://travis-ci.org/fnando/date_interval)
+[![Code Climate](https://codeclimate.com/github/fnando/date_interval.png)](https://codeclimate.com/github/fnando/date_interval)
+
 Parse date intervals from strings.
 
 ## Installation
@@ -21,6 +24,8 @@ Or install it yourself as:
 You must always define at least one range at the beginning of the expression. The snippet below will return three dates objects.
 
 ```ruby
+require "date_interval"
+
 expr = "2014-01-01 - 2014-01-03"
 dates = DateInterval.parse(expr)
 ```
@@ -28,6 +33,8 @@ dates = DateInterval.parse(expr)
 You can provide as many intervals as you want. The following expression returns six date objects.
 
 ```ruby
+require "date_interval"
+
 expr = "2014-01-01 - 2014-01-03, 2014-02-01 - 2014-02-03"
 dates = DateInterval.parse(expr)
 ```
@@ -38,10 +45,58 @@ You can also define filters. Filters are applied in sequence, from left to right
 - `[+-]weekends`: filter weekend dates
 - `[+-]weekdays`: filter weekdays ()
 - `[+-]sundays`: filter sundays. You can use any weekday name (sundays-saturdays)
+- `[+-]holidays`: filter holidays. You must add the holidays by yourself (see below)
 - `[+-]yyy-mm-dd`: add/remove the given date.
 
 Beware that duplicated dates are removed from the final result. They're also sorted.
 
+Some expression examples:
+
+```text
+# Don't return weekends
+2014-01-01 - 2014-01-05, -weekends
+
+# Return only weekends
+2014-01-01 - 2014-01-05, none, +weekends
+
+# Don't return weekdays
+2014-01-01 - 2014-01-05, -weekdays
+
+# Return only weekdays
+2014-01-01 - 2014-01-05, none, +weekdays
+
+# Return mondays, wednesdays and fridays
+2014-01-01 - 2014-01-05, none, +monday, +wednesdays, +fridays
+
+# Return the specified range, including one more date
+2014-01-01 - 2014-01-05, +2014-07-31
+
+# Return the specified range, excluding one date
+2014-01-01 - 2014-01-05, -2014-01-05
+
+# Return the specified range, excluding holidays
+2014-01-01 - 2014-01-05, -holidays
+```
+
+### Defining holidays
+
+To define your holidays you must use the method `DateInterval::Filter::Holiday.add`. It accepts one or more dates.
+
+```ruby
+require "date_interval"
+
+DateInterval::Filter::Holidays.add(
+  Date.parse("2014-01-01"),
+  Date.parse("2014-12-25"),
+)
+
+DateInterval.parse("2014-01-01 - 2014-12-31, none, +holidays")
+# => [
+#     [0] #<Date: 2014-01-01>,
+#     [1] #<Date: 2014-12-25>
+#    ]
+```
+
 ## Contributing
 
 1. Fork it ( http://github.com/[my-github-username]/date_interval/fork )

data/lib/date_interval.rb

@@ -9,6 +9,7 @@ require "date_interval/filter/date"
 require "date_interval/filter/none"
 require "date_interval/filter/weekday"
 require "date_interval/filter/weekdays"
+require "date_interval/filter/holidays"
 require "date_interval/filter/weekend"
 require "date_interval/parser"
 require "date_interval/transformer"

data/lib/date_interval/date.rb

@@ -3,7 +3,7 @@ module DateInterval
     attr_reader :date
 
     extend Forwardable
-    def_delegator :date, :wday
+    def_delegators :date, :wday, :strftime
 
     def initialize(date)
       @date = date

data/lib/date_interval/filter/holidays.rb

@@ -0,0 +1,23 @@
+module DateInterval
+  module Filter
+    class Holidays < Operator
+      attr_reader :operator
+
+      def self.add(*dates)
+        dates.map {|date| holidays << date.strftime("%s") }
+      end
+
+      def self.holidays
+        @holidays ||= []
+      end
+
+      def initialize(operator)
+        @operator = operator
+      end
+
+      def filter(dates)
+        dates.select {|date| self.class.holidays.include?(date.strftime("%s")) }
+      end
+    end
+  end
+end

data/lib/date_interval/parser.rb

@@ -40,12 +40,18 @@ module DateInterval
       filter_weekdays.as(:weekdays) |
       filter_weekend.as(:weekend)   |
       filter_none.as(:none)         |
-      filter_date.as(:date)
+      filter_date.as(:date)         |
+      filter_holidays.as(:holidays)
     }
 
     rule(:s?) { str("s").maybe }
 
-    rule(:filter_weekend)   {
+    rule(:filter_holidays) {
+      operator? >>
+      str("holiday") >> s?
+    }
+
+    rule(:filter_weekend) {
       operator? >>
       str("weekend") >> s?
     }

data/lib/date_interval/transformer.rb

@@ -20,6 +20,10 @@ module DateInterval
       Filter::Weekdays.new(operator.to_s)
     }
 
+    rule(holidays: {operator: simple(:operator)}) {
+      Filter::Holidays.new(operator.to_s)
+    }
+
     rule(none: simple(:name)) {
       Filter::None.new
     }

data/lib/date_interval/version.rb

@@ -1,3 +1,3 @@
 module DateInterval
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/spec/date_interval_spec.rb

@@ -3,7 +3,14 @@ require "spec_helper"
 describe DateInterval do
   it "parses the interval" do
     interval = DateInterval.parse("2014-01-01 - 2014-01-05")
-    expected_interval = (Date.parse("2014-01-01")..Date.parse("2014-01-05")).to_a
+    expected_interval = date_range("2014-01-01", "2014-01-05")
+
+    expect(interval).to eql(expected_interval)
+  end
+
+  it "parses multiple intervals" do
+    interval = DateInterval.parse("2014-01-01 - 2014-01-05, 2014-01-06 - 2014-01-10")
+    expected_interval = date_range("2014-01-01", "2014-01-10")
 
     expect(interval).to eql(expected_interval)
   end
@@ -166,4 +173,22 @@ describe DateInterval do
 
     expect(interval).to eql(expected_interval)
   end
+
+  it "excludes holidays" do
+    DateInterval::Filter::Holidays.add Date.parse("2014-01-01")
+
+    interval = DateInterval.parse("2014-01-01 - 2014-01-02, -holidays")
+    expected_interval = [to_date("2014-01-02")]
+
+    expect(interval).to eql(expected_interval)
+  end
+
+  it "includes holidays" do
+    DateInterval::Filter::Holidays.add Date.parse("2014-01-01")
+
+    interval = DateInterval.parse("2014-01-01 - 2014-01-02, none, +holidays")
+    expected_interval = [to_date("2014-01-01")]
+
+    expect(interval).to eql(expected_interval)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: date_interval
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Nando Vieira
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-30 00:00:00.000000000 Z
+date: 2014-01-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parslet
@@ -99,6 +99,7 @@ files:
 - lib/date_interval/date.rb
 - lib/date_interval/filter.rb
 - lib/date_interval/filter/date.rb
+- lib/date_interval/filter/holidays.rb
 - lib/date_interval/filter/none.rb
 - lib/date_interval/filter/operator.rb
 - lib/date_interval/filter/weekday.rb