repeatable 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7810dbdca8bf11e8e30101cc1bd22afbcaf698a0
-  data.tar.gz: e1408eb13dbf184b1115d90ae814db6582b0a640
+  metadata.gz: 2a36439cf2a982c3ef546a1d7247517788a7f013
+  data.tar.gz: 81df50553e0f1e6894feed2b03f4512321c6973c
 SHA512:
-  metadata.gz: ebd63d839565ebe7971e5566462dad20d851a9a110eee829d1f53ec8868559fa6b46f14c8528e067827daa95da6e9929a479ca852d69e54884b4a6c071a3b139
-  data.tar.gz: b623c8e4040e6a8276f86c7b71078019fb830dd2ff88b0d5e784618580350cd5b8c51e45ce3846126765a97a1c448ea3e9d9d1f2261ded030cb7ad7ee195dcab
+  metadata.gz: d489cdad639be6b5cd0dbbb9e320bc73bbacdc4df5fb402fd0c54d2355d8ca6cdb26015804d50378c020b1c677cc368e9669d182d4611d7899e37cb57f75a36b
+  data.tar.gz: 3cad5c6ff55fb408a85a4ebbea1ad5ba3c90db7b2733050af10bb8d7f3ffa79534a52a87c6d163fa505c30cdf52962d57b47a36e7b319449cf95eec021817d78

data/.travis.yml

@@ -1,10 +1,12 @@
 language: ruby
 rvm:
-  - 2.1.8
-  - 2.2.4
-  - 2.3.0
+  - 2.1.9
+  - 2.2.5
+  - 2.3.1
 sudo: false
 addons:
   code_climate:
     repo_token:
       secure: fyZ7Ycc23fzfh8bBiqPUhlJGcIcnanZWqVc4nsKDJeE1G5ScW01+ot1g4miDWxo7w80gKRKP/PfoYf6lOQ1B5yJJCV0Z5fjoTW3y+EKksMuGNCFaWh8R73MIPlVtfOazGyI2t3l4zDWoik906wHHNQJFveMZawvZGrVMWF6YxKg=
+after_success:
+  - bundle exec codeclimate-test-reporter

data/CHANGELOG.md

@@ -2,7 +2,21 @@
 
 ### Unreleased
 
-[Commits](https://github.com/molawson/repeatable/compare/v0.5.0...master)
+[Commits](https://github.com/molawson/repeatable/compare/v0.6.0...master)
+
+### 0.6.0 (2017-05-04)
+
+Features:
+
+* Add `Expression::Difference` for set differences between 2 schedules ([@danott][])
+* Allow `Expression::DayInMonth` to take `:last` (or `'last'`) for its `day:` argument ([@PatrickLerner][])
+* Allow `Expression::WeekdayInMonth` to take negative `count` argument for last, second-to-last, etc. of a given weekday ([@danielma][])
+
+Bugfixes:
+
+* Fix `Expression::RangeInYear` to properly handle using `start_day` and `end_day` when `start_month == end_month` ([@danielma][])
+
+[Commits](https://github.com/molawson/repeatable/compare/v0.5.0...v0.6.0)
 
 ### 0.5.0 (2016-01-27)
 
@@ -65,3 +79,5 @@ Initial Release
 
 
 [@danott]: https://github.com/danott
+[@PatrickLerner]: https://github.com/PatrickLerner
+[@danielma]: https://github.com/danielma

data/Gemfile

@@ -4,4 +4,7 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'pry'
-gem 'codeclimate-test-reporter', group: :test, require: nil
+group :test do
+  gem 'simplecov'
+  gem 'codeclimate-test-reporter', '~> 1.0.0'
+end

data/README.md

@@ -22,6 +22,10 @@ Or install it yourself as:
 
     $ gem install repeatable
 
+## Requirements
+
+Because this gem relies heavily on required keyword arguments, especially to make dumping and parsing of schedules simpler, this code will only work on **Ruby 2.1** and higher.
+
 ## Usage
 
 ### Building a Schedule
@@ -33,9 +37,9 @@ You can create a schedule in one of two ways.
 Instantiate and compose each of the `Repeatable::Expression` objects manually.
 
 ```ruby
-second_monday = Repeatabe::Expression::WeekdayInMonth.new(weekday: 1, count: 2)
+second_monday = Repeatable::Expression::WeekdayInMonth.new(weekday: 1, count: 2)
 oct_thru_dec = Repeatable::Expression::RangeInYear.new(start_month: 10, end_month: 12)
-intersection = Repeatable::Expresson::Intersection.new(second_monday, oct_thru_dec)
+intersection = Repeatable::Expression::Intersection.new(second_monday, oct_thru_dec)
 
 schedule = Repeatable::Schedule.new(intersection)
 ```
@@ -49,7 +53,8 @@ Or describe the same structure with a `Hash`, and the gem will handle instantiat
 arg = {
   intersection: [
     { weekday_in_month: { weekday: 1, count: 2 } },
-    { range_in_year: { start_month: 10, end_month: 12 } }
+    { range_in_year: { start_month: 10, end_month: 12 } },
+    { exact_date: { date: "2015-08-01" } }
   ]
 }
 
@@ -73,6 +78,10 @@ Repeatable::Expression::Union.new(expressions)
 { intersection: [] }
 Repeatable::Expression::Intersection.new(expressions)
 
+# Date is part of the first set (`included`) but not part of the second set (`excluded`)
+{ difference: { included: expression, excluded: another_expression } }
+Repeatable::Expression::Difference.new(included: expression, excluded: another_expression)
+
 
 # DATES
 
@@ -84,6 +93,10 @@ Repeatable::Expression::Weekday.new(weekday: 0)
 { weekday_in_month: { weekday: 1, count: 3 } }
 Repeatable::Expression::WeekdayInMonth.new(weekday: 1, count: 3)
 
+# The last Thursday of every month
+{ weekday_in_month: { weekday: 4, count: -1 } }
+Repeatable::Expression::WeekdayInMonth.new(weekday: 4, count: -1)
+
 # Every other Monday, starting from December 1, 2015
 { biweekly: { weekday: 1, start_date: '2015-12-01' } }
 Repeatable::Expression::Biweekly.new(weekday: 1, start_date: Date.new(2015, 12, 1))
@@ -92,6 +105,10 @@ Repeatable::Expression::Biweekly.new(weekday: 1, start_date: Date.new(2015, 12,
 { day_in_month: { day: 13 } }
 Repeatable::Expression::DayInMonth.new(day: 13)
 
+# The last day of every month
+{ day_in_month: { day: :last } }
+Repeatable::Expression::DayInMonth.new(day: :last)
+
 # All days in October
 { range_in_year: { start_month: 10 } }
 Repeatable::Expression::RangeInYear.new(start_month: 10)
@@ -103,6 +120,10 @@ Repeatable::Expression::RangeInYear.new(start_month: 10, end_month: 12)
 # All days from October 1 through December 20
 { range_in_year: { start_month: 10, end_month: 12, start_day: 1, end_day: 20 } }
 Repeatable::Expression::RangeInYear.new(start_month: 10, end_month: 12, start_day: 1, end_day: 20)
+
+# only December 21, 2012
+{ exact_date: { date: '2012-12-21' } }
+Repeatable::Expression::ExactDate.new(date: Date.new(2012, 12, 21)
 ```
 
 #### Schedule Errors

data/lib/repeatable.rb

@@ -14,6 +14,7 @@ require 'repeatable/expression'
 require 'repeatable/expression/base'
 
 require 'repeatable/expression/date'
+require 'repeatable/expression/exact_date'
 require 'repeatable/expression/weekday'
 require 'repeatable/expression/biweekly'
 require 'repeatable/expression/weekday_in_month'
@@ -23,6 +24,7 @@ require 'repeatable/expression/range_in_year'
 require 'repeatable/expression/set'
 require 'repeatable/expression/union'
 require 'repeatable/expression/intersection'
+require 'repeatable/expression/difference'
 
 require 'repeatable/schedule'
 require 'repeatable/parser'

data/lib/repeatable/expression/base.rb

@@ -24,6 +24,22 @@ module Repeatable
         )
       end
 
+      def union(other)
+        Union.new(self, other)
+      end
+      alias + union
+      alias | union
+
+      def intersection(other)
+        Intersection.new(self, other)
+      end
+      alias & intersection
+
+      def difference(other)
+        Difference.new(included: self, excluded: other)
+      end
+      alias - difference
+
       private
 
       def hash_key

data/lib/repeatable/expression/day_in_month.rb

@@ -6,7 +6,11 @@ module Repeatable
       end
 
       def include?(date)
-        date.day == day
+        if day.to_s == 'last'
+          date.next_day.month != date.month
+        else
+          date.day == day
+        end
       end
 
       private

data/lib/repeatable/expression/difference.rb

@@ -0,0 +1,28 @@
+module Repeatable
+  module Expression
+    class Difference < Base
+      def initialize(included:, excluded:)
+        @included = included
+        @excluded = excluded
+      end
+
+      def include?(date)
+        included.include?(date) && !excluded.include?(date)
+      end
+
+      def to_h
+        Hash[hash_key, { included: included.to_h, excluded: excluded.to_h }]
+      end
+
+      def ==(other)
+        other.is_a?(self.class) &&
+          included == other.included &&
+          excluded == other.excluded
+      end
+
+      protected
+
+      attr_reader :included, :excluded
+    end
+  end
+end

data/lib/repeatable/expression/exact_date.rb

@@ -0,0 +1,17 @@
+module Repeatable
+  module Expression
+    class ExactDate < Date
+      def initialize(date:)
+        @date = Date(date)
+      end
+
+      def include?(other_date)
+        date == other_date
+      end
+
+      private
+
+      attr_reader :date
+    end
+  end
+end

data/lib/repeatable/expression/range_in_year.rb

@@ -9,7 +9,13 @@ module Repeatable
       end
 
       def include?(date)
-        months_include?(date) || start_month_include?(date) || end_month_include?(date)
+        return true if months_include?(date)
+
+        if start_month == end_month
+          start_month_include?(date) && end_month_include?(date)
+        else
+          start_month_include?(date) || end_month_include?(date)
+        end
       end
 
       def to_h

data/lib/repeatable/expression/weekday_in_month.rb

@@ -19,11 +19,33 @@ module Repeatable
       end
 
       def week_matches?(date)
-        week_in_month(date.day) == count
+        if negative_count?
+          week_from_end(date) == count
+        else
+          week_from_beginning(date) == count
+        end
       end
 
-      def week_in_month(day)
-        ((day - 1) / 7) + 1
+      def week_from_beginning(date)
+        week_in_month(date.day - 1)
+      end
+
+      def week_from_end(date)
+        -week_in_month(last_date_of_month(date).day - date.day)
+      end
+
+      def week_in_month(zero_indexed_day)
+        (zero_indexed_day / 7) + 1
+      end
+
+      def last_date_of_month(date)
+        next_month = date.next_month
+        first_day_of_next_month = ::Date.new(next_month.year, next_month.month, 1)
+        first_day_of_next_month.prev_day
+      end
+
+      def negative_count?
+        count < 0
       end
     end
   end

data/lib/repeatable/parser.rb

@@ -32,6 +32,12 @@ module Repeatable
       when Repeatable::Expression::Set
         args = value.map { |hash| build_expression(hash) }
         klass.new(*args)
+      when Repeatable::Expression::Difference
+        value = symbolize_keys(value)
+        klass.new(
+          included: build_expression(value[:included]),
+          excluded: build_expression(value[:excluded])
+        )
       else
         klass.new(symbolize_keys(value))
       end

data/lib/repeatable/version.rb

@@ -1,3 +1,3 @@
 module Repeatable
-  VERSION = '0.5.0'
+  VERSION = '0.6.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: repeatable
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Mo Lawson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-27 00:00:00.000000000 Z
+date: 2017-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -77,6 +77,8 @@ files:
 - lib/repeatable/expression/biweekly.rb
 - lib/repeatable/expression/date.rb
 - lib/repeatable/expression/day_in_month.rb
+- lib/repeatable/expression/difference.rb
+- lib/repeatable/expression/exact_date.rb
 - lib/repeatable/expression/intersection.rb
 - lib/repeatable/expression/range_in_year.rb
 - lib/repeatable/expression/set.rb
@@ -108,9 +110,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Describe recurring event schedules and calculate their occurrences
 test_files: []
-has_rdoc: