repeatable 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2f40e8650290808378222b5008cbb78fdbea93aa
-  data.tar.gz: 185957b9333e449b91b843ea84517cf09019f33a
+  metadata.gz: 2b8c2addf36ece2740c6279e7a62055b85840788
+  data.tar.gz: eb550957ad299c4fc07fbbb2f9cc0dea135bbde1
 SHA512:
-  metadata.gz: e296b0cd1a654e675e09026b7c6672f72a5737819f3e35d8d784b5e5977f7f177747d96aff2f54291e177e3914ef02d7778f2a1d9cb37cc23100bfd414645381
-  data.tar.gz: aef5189d0560f22de05c6c7518457f5628f2c2132f4cb96e38467597c1e8929e15aa0a91e8681bdc17d50e4995fd96a8383d19a8e472ca34e6c33345f3ad8d3b
+  metadata.gz: 020b4553225e0c44e455021dd4b825c52aa5074e3a3204546714f24c643e6eb9bdd69af0103ac82486c840d236595096fca92f2ef5212d85df9492f80e4a0d60
+  data.tar.gz: 9d11e275bb37cea484f635bef9b5b7eb3dc2ca1ea0309132773f98b66d16bfc18572de7c9c5b59db6946391d758eae0e2b0322c6c21714c61edac544f06cbc28

data/.gitignore

@@ -1,3 +1,4 @@
+/*.gem
 /.bundle/
 /.yardoc
 /Gemfile.lock

data/README.md

@@ -24,7 +24,26 @@ Or install it yourself as:
 
 ## Usage
 
-Describe a schedule with a Hash:
+### Building a Schedule
+
+You can create a schedule in one of two ways.
+
+#### Composed objects
+
+You can compose each of the expression objects manually.
+
+```ruby
+second_monday = Repeatabe::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)
+
+schedule = Repeatable::Schedule.new(intersection)
+```
+
+
+#### Hash
+
+Or you can describe the same structure with a `Hash`, and the gem will compose the objects for you.
 
 ```ruby
 args = {
@@ -37,6 +56,53 @@ args = {
 schedule = Repeatable::Schedule.new(args)
 ```
 
+- - -
+
+#### Time Expressions
+
+There are a number of time expressions available which, when combined, can describe most any schedule.
+
+```ruby
+# SETS
+
+# Any conditions can be met
+{ union: [] }
+Repeatable::Expression::Union.new(expressions)
+
+# All conditions must be met
+{ intersection: [] }
+Repeatable::Expression::Intersection.new(expressions)
+
+
+# DATES
+
+# Every Sunday
+{ weekday: { weekday: 0 } }
+Repeatable::Expression::Weekday.new(weekday: 0)
+
+# The 3rd Monday of every month
+{ weekday_in_month: { weekday: 1, count: 3 } }
+Repeatable::Expression::WeekdayInMonth.new(weekday: 1, count: 3)
+
+# The 13th of every month
+{ day_in_month: { day: 13 } }
+Repeatable::Expression::DayInMonth.new(day: 13)
+
+# Any day in October
+{ range_in_year: { start_month: 10 } }
+Repeatable::Expression::RangeInYear.new(start_month: 10)
+
+# All days from October through December
+{ range_in_year: { start_month: 10, end_month: 12 } }
+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)
+```
+
+### Getting information from a Schedule
+
 Ask your schedule one of three questions:
 
 ```ruby
@@ -48,28 +114,10 @@ schedule.occurrences(Date.new(2015, 1, 1), Date.new(2016, 6, 30))
 
 schedule.include?(Date.new(2015, 10, 10))
   # => Whether the schedule has an event on the date given (true/false)
-```
-
-Available time expressions:
 
-```ruby
-# Sets
-union: []         # Any conditions can be met
-intersection: []  # All conditions must be met
-
-# Dates
-weekday: { weekday: 0 }
-  # Every Sunday
-weekday_in_month: { weekday: 1, count: 3 }
-  # The 3rd Monday of every month
-day_in_month: { day: 13 }
-  # The 13th of every month
-range_in_year: { start_month: 10 }
-  # Any day in October
-range_in_year: { start_month: 10, end_month: 12 }
-  # All days from October through December
-range_in_year: { start_month: 10, end_month: 12, start_day: 1, end_day: 20 }
-  # All days from October 1 through December 20
+schedule.to_h
+  # => Hash representation of the Schedule, which is useful for storage and
+  #    can be used to recreating an identical Schedule object at a later time
 ```
 
 ## Development

data/lib/repeatable/expression/base.rb

@@ -2,13 +2,25 @@ module Repeatable
   module Expression
     class Base
       def self.===(other)
-        other.ancestors.include?(self)
+        case other
+        when Class
+          other.ancestors.include?(self)
+        else
+          super
+        end
       end
 
       def include?(_date)
         fail(
           NotImplementedError,
-          "Don't use Expression::Base directly. Subclasses should implement `#include?`"
+          "Don't use Expression::Base directly. Subclasses must implement `#include?`"
+        )
+      end
+
+      def to_h
+        fail(
+          NotImplementedError,
+          "Don't use Expression::Base directly. Subclasses must implement `#to_h`"
         )
       end
     end

data/lib/repeatable/expression/day_in_month.rb

@@ -9,6 +9,10 @@ module Repeatable
         date.day == day
       end
 
+      def to_h
+        { day_in_month: { day: day } }
+      end
+
       private
 
       attr_reader :day

data/lib/repeatable/expression/range_in_year.rb

@@ -12,6 +12,14 @@ module Repeatable
         months_include?(date) || start_month_include?(date) || end_month_include?(date)
       end
 
+      def to_h
+        args = { start_month: start_month }
+        args[:end_month] = end_month unless end_month == start_month
+        args[:start_day] = start_day unless start_day.zero?
+        args[:end_day] = end_day unless end_day.zero?
+        { range_in_year: args }
+      end
+
       private
 
       attr_reader :start_month, :end_month, :start_day, :end_day

data/lib/repeatable/expression/set.rb

@@ -10,6 +10,12 @@ module Repeatable
         self
       end
 
+      def to_h
+        hash = {}
+        hash[self.class.name.demodulize.underscore.to_sym] = elements.map(&:to_h)
+        hash
+      end
+
       private
 
       attr_reader :elements

data/lib/repeatable/expression/weekday.rb

@@ -9,6 +9,10 @@ module Repeatable
         date.wday == weekday
       end
 
+      def to_h
+        { weekday: { weekday: weekday } }
+      end
+
       private
 
       attr_reader :weekday

data/lib/repeatable/expression/weekday_in_month.rb

@@ -10,6 +10,10 @@ module Repeatable
         day_matches?(date) && week_matches?(date)
       end
 
+      def to_h
+        { weekday_in_month: { weekday: weekday, count: count } }
+      end
+
       private
 
       attr_reader :weekday, :count

data/lib/repeatable/schedule.rb

@@ -3,7 +3,14 @@ require 'active_support/core_ext/string/inflections'
 module Repeatable
   class Schedule
     def initialize(args)
-      @expression = build_expression(args)
+      case args
+      when Hash
+        @expression = build_expression(args)
+      when Repeatable::Expression::Base
+        @expression = args
+      else
+        fail ArgumentError, "Can't build a Repeatable::Schedule from #{args.class}"
+      end
     end
 
     def occurrences(start_date, end_date)
@@ -25,6 +32,10 @@ module Repeatable
       expression.include?(date)
     end
 
+    def to_h
+      expression.to_h
+    end
+
     private
 
     attr_reader :expression

data/lib/repeatable/version.rb

@@ -1,3 +1,3 @@
 module Repeatable
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: repeatable
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Mo Lawson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-23 00:00:00.000000000 Z
+date: 2015-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport