montrose 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a88cd103fc68290cf832c8e41ec2e8a1ca4d4a87
-  data.tar.gz: c74c51dad1844316155c1b138b0b34f548d27dfd
+  metadata.gz: 860d9ff5e15a0ab0bf99a0882c367d79629ebc8f
+  data.tar.gz: 4366bbc4218a7f42f53f2b71e4cf42a12c2b53b4
 SHA512:
-  metadata.gz: 3d186764038aaeb902fb809225a5e26779831e55a3ed0cc11998a6395821c9ab4e34af9d0152f43558f660c39d02ad9e2eff82630e24d56986e1958d0ff51de6
-  data.tar.gz: 4c939c9c4e6a416f20fb24b718d6fab5026b17650f72e5769b03abaa40ecc10d002a6a8210cd0ec6ae44c832d41020a222cf5e248597ede1754d830e8587d92b
+  metadata.gz: a970bd59b217242a61e1c6dd485b8577537c60b0ed0f56dcaf2d274f52ec1f781ba239f8269a11eb3ff8df55c8dacb6a606e223883e3c2977ffb44e354cbbe38
+  data.tar.gz: 04c563a8c68abd4480232873c9629b802fccfae66b25b477bbb82ed19ae855bb3665ecef2914497c5ec6f2579ef43cc9cc7c7875bb88060ff5e05ee74171e557

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+### 0.4.0 - (2016-04-20)
+
+* enhancements
+  * Respect configured time zone by using `Time.current` from `ActiveSupport`
+  * Adds `Montrose::Recurrence#to_json` method
+  * Additional tests for utils methods (by @AlexWheeler)
+
 ### 0.3.0 - (2016-02-19)
 
 * enhancements

data/README.md

@@ -29,10 +29,11 @@ Or install it yourself as:
 
 ## Why
 
-Dealing with recurring events is hard. `Montrose` provides a simple interface for specifying and enumerating recurring events as `Time` objects.
+Dealing with recurring events is hard. `Montrose` provides a simple interface for specifying and enumerating recurring events as `Time` objects for Ruby applications.
 
 More specifically, this project intends to:
 
+* model recurring events in Ruby
 * embrace Ruby idioms
 * support Ruby 2.1+
 * be reasonably performant
@@ -42,11 +43,11 @@ More specifically, this project intends to:
 What `Montrose` doesn't do:
 
 * support all calendaring use cases under the sun
-* schedule recurring jobs for you. See instead [rufus-scheduler](https://github.com/jmettraux/rufus-scheduler), [sidekiq-cron](https://github.com/ondrejbartas/sidekiq-cron), [sidetiq](https://github.com/tobiassvn/sidetiq), [whenever](https://github.com/javan/whenever)
+* schedule recurring jobs for your Rails app. Use one of these instead: [cron](https://en.wikipedia.org/wiki/Cron), [rufus-scheduler](https://github.com/jmettraux/rufus-scheduler), [sidekiq-cron](https://github.com/ondrejbartas/sidekiq-cron), [sidetiq](https://github.com/tobiassvn/sidetiq), [whenever](https://github.com/javan/whenever)
 
 ## Concepts
 
-Montrose allows you to easily create "recurrence" objects through chaining:
+Montrose allows you to easily create "recurrence objects" through chaining:
 
 ```ruby
 # Every Monday at 10:30am
@@ -181,8 +182,8 @@ Montrose.daily(interval: 2)
 Montrose.every(10.days, total: 5)
 
 # everyday in January for 3 years
-starts = Time.now.beginning_of_year
-ends = Time.now.end_of_year + 2.years
+starts = Time.current.beginning_of_year
+ends = Time.current.end_of_year + 2.years
 Montrose.daily(month: :january, between: starts...ends)
 
 # weekly for 10 occurrences
@@ -356,7 +357,7 @@ Montrose.daily(except: [Date.today, "2017-01-31"])
 # Chaining
 Montrose.weekly.starting(3.weeks.from_now).on(:friday)
 Montrose.every(:day).at("4:05pm")
-Montrose.yearly.between(Time.now..10.years.from_now)
+Montrose.yearly.between(Time.current..10.years.from_now)
 
 # Enumerating events
 r = Montrose.every(:month, mday: 31, until: "January 1, 2017")

data/lib/montrose/options.rb

@@ -6,11 +6,6 @@ module Montrose
     @default_until = nil
     @default_every = nil
 
-    MAX_HOURS_IN_DAY = 24
-    MAX_DAYS_IN_YEAR = 366
-    MAX_WEEKS_IN_YEAR = 53
-    MAX_DAYS_IN_MONTH = 31
-
     class << self
       def new(options = {})
         return options if options.is_a?(self)
@@ -36,7 +31,7 @@ module Montrose
       def default_until
         case @default_until
         when String
-          Time.parse(@default_until)
+          ::Montrose::Utils.parse_time(@default_until)
         when Proc
           @default_until.call
         else
@@ -51,11 +46,11 @@ module Montrose
       def default_starts
         case @default_starts
         when String
-          Time.parse(@default_starts)
+          ::Montrose::Utils.parse_time(@default_starts)
         when Proc
           @default_starts.call
         when nil
-          Time.now
+          ::Montrose::Utils.current_time
         else
           @default_starts
         end
@@ -261,19 +256,19 @@ module Montrose
     end
 
     def assert_hour(hour)
-      assert_range_includes(1..MAX_HOURS_IN_DAY, hour)
+      assert_range_includes(1..::Montrose::Utils::MAX_HOURS_IN_DAY, hour)
     end
 
     def assert_mday(mday)
-      assert_range_includes(1..MAX_DAYS_IN_MONTH, mday, :absolute)
+      assert_range_includes(1..::Montrose::Utils::MAX_DAYS_IN_MONTH, mday, :absolute)
     end
 
     def assert_yday(yday)
-      assert_range_includes(1..MAX_DAYS_IN_YEAR, yday, :absolute)
+      assert_range_includes(1..::Montrose::Utils::MAX_DAYS_IN_YEAR, yday, :absolute)
     end
 
     def assert_week(week)
-      assert_range_includes(1..MAX_WEEKS_IN_YEAR, week, :absolute)
+      assert_range_includes(1..::Montrose::Utils::MAX_WEEKS_IN_YEAR, week, :absolute)
     end
 
     def decompose_on_arg(arg)

data/lib/montrose/recurrence.rb

@@ -62,6 +62,15 @@ module Montrose
     end
     alias to_h to_hash
 
+    # Returns json string of options used to create
+    # the recurrence
+    #
+    # @return [String] json of recurrence options
+    #
+    def to_json
+      to_hash.to_json
+    end
+
     def inspect
       "#<#{self.class}:#{object_id.to_s(16)} #{to_h.inspect}>"
     end

data/lib/montrose/rule/day_of_month.rb

@@ -23,7 +23,7 @@ module Montrose
 
       # matches days specified at negative numbers
       def included_from_end_of_month?(time)
-        month_days = Time.days_in_month(time.month, time.year) # given by activesupport
+        month_days = ::Montrose::Utils.days_in_month(time.month, time.year) # given by activesupport
         @days.any? { |d| month_days + d + 1 == time.mday }
       end
     end

data/lib/montrose/rule/day_of_year.rb

@@ -22,16 +22,9 @@ module Montrose
       private
 
       def included_from_end_of_month?(time)
-        year_days = days_in_year(time.year) # given by activesupport
+        year_days = ::Montrose::Utils.days_in_year(time.year) # given by activesupport
         @days.any? { |d| year_days + d + 1 == time.yday }
       end
-
-      # Returns the number of days in the given year.
-      # If no year is specified, it will use the current year.
-      # https://github.com/rails/rails/pull/22244
-      def days_in_year(year)
-        Time.days_in_month(2, year) + 337
-      end
     end
   end
 end

data/lib/montrose/rule/nth_day_of_month.rb

@@ -47,15 +47,7 @@ module Montrose
         end
 
         def total_days
-          days_in_month(@time)
-        end
-
-        private
-
-        # Get the days in the month for +time
-        def days_in_month(time)
-          date = Date.new(time.year, time.month, 1)
-          ((date >> 1) - date).to_i
+          ::Montrose::Utils.days_in_month(@time.month, @time.year)
         end
       end
     end

data/lib/montrose/utils.rb

@@ -2,15 +2,20 @@ module Montrose
   module Utils
     module_function
 
-    MONTHS = Date::MONTHNAMES
-    DAYS = Date::DAYNAMES
+    MONTHS = ::Date::MONTHNAMES
+    DAYS = ::Date::DAYNAMES
+
+    MAX_HOURS_IN_DAY = 24
+    MAX_DAYS_IN_YEAR = 366
+    MAX_WEEKS_IN_YEAR = 53
+    MAX_DAYS_IN_MONTH = 31
 
     def as_time(time)
       return nil unless time
 
       case
       when time.is_a?(String)
-        Time.parse(time)
+        parse_time(time)
       when time.respond_to?(:to_time)
         time.to_time
       else
@@ -22,6 +27,14 @@ module Montrose
       as_time(time).to_date
     end
 
+    def parse_time(*args)
+      ::Time.zone.nil? ? ::Time.parse(*args) : ::Time.zone.parse(*args)
+    end
+
+    def current_time
+      ::Time.current
+    end
+
     def month_number(name)
       case name
       when Symbol, String
@@ -51,5 +64,17 @@ module Montrose
       day_number(name) or fail ConfigurationError,
         "Did not recognize day #{name}, must be one of #{DAYS.inspect}"
     end
+
+    def days_in_month(month, year = current_time.year)
+      date = ::Date.new(year, month, 1)
+      ((date >> 1) - date).to_i
+    end
+
+    # Returns the number of days in the given year.
+    # If no year is specified, it will use the current year.
+    # https://github.com/rails/rails/pull/22244
+    def days_in_year(year)
+      ::Montrose::Utils.days_in_month(2, year) + 337
+    end
   end
 end

data/lib/montrose/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Montrose
-  VERSION = "0.3.0".freeze
+  VERSION = "0.4.0".freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: montrose
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Ross Kaffenberger
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-02-20 00:00:00.000000000 Z
+date: 2016-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport