ice_cube_ex 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3a1f31275d0e2a370214241ff1a1e6431fb40c2f
-  data.tar.gz: 7332e9354da6df596ec727898b5f61e65b1491f3
+  metadata.gz: e5c2110052533d6a2c202dd9b5956ab34860f27b
+  data.tar.gz: 4e9b6686c099e9e8c31de765379dd5bcdab0914b
 SHA512:
-  metadata.gz: 2c25a1c70946711f7fc347c4ce12b5215298d3b39bf008037c6227e9c694f62056128c9ca7ed1966c8ac84ae9963fec1bd4917fe7c7465cd2101a9ad8dfc0314
-  data.tar.gz: 18f44f2f3c74d3c33ddfcedb5aa4447bb63072db0ce4c9f9fd728094ec2a460c5f22b92eb74f1b343a86cd348f8e12e55ab204c4da9510b1b965d817c6d704d1
+  metadata.gz: 371cce05e26cb616d3b3611ef2becf34c1d47ce0ec161d9489525f3fd5a1cf13ac9f1996b29ee3cc84d788c453f26ac00b39799b9a48be1c8afd2e8a1a58961a
+  data.tar.gz: b10f2e2527efcf30594e5176b5b0b6a2cce0eb6fd0d09a07ca6f4a4486139d9cc0d996455d28cf1c7b9c4f64abaaa248f451686b65a87c75eebc5a793398e736

data/README.md

@@ -1,5 +1,6 @@
 # IceCubeEx
 
+[![Gem Version](https://badge.fury.io/rb/ice_cube_ex.svg)](http://badge.fury.io/rb/ice_cube_ex)
 [![build](https://travis-ci.org/junhanamaki/ice_cube_ex.svg?branch=master)](https://travis-ci.org/junhanamaki/ice_cube_ex)
 [![Code Climate](https://codeclimate.com/github/junhanamaki/ice_cube_ex.png)](https://codeclimate.com/github/junhanamaki/ice_cube_ex)
 [![Test Coverage](https://codeclimate.com/github/junhanamaki/ice_cube_ex/coverage.png)](https://codeclimate.com/github/junhanamaki/ice_cube_ex)
@@ -26,7 +27,40 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+ice_cube_ex has new rules that can be used with ice_cube's schedules:
+
+### DayCycleRule
+
+This rule allows to specify a cycle (in number of days), and the number of
+repeat counting from the start of the cycle. For example, if we want to repeat
+3 days, every 5 days, starting from 2015-1-1 we would do:
+
+    schedule = IceCube::Schedule.new(Time.new(2015, 1, 1)) do |s|
+      s.rrule IceCubeEx::Rule.day_cycle(5, 3)
+    end
+
+Now try calculating some next occurrences:
+
+    occurrence_time = schedule.next_occurrence(Time.new(2014-12-30))
+    # returns 2015-1-1
+
+    occurrence_time = schedule.next_occurrence(occurrence_time)
+    # returns 2015-1-2
+
+    occurrence_time = schedule.next_occurrence(occurrence_time)
+    # returns 2015-1-3
+
+    occurrence_time = schedule.next_occurrence(occurrence_time)
+    # returns 2015-1-6
+
+    occurrence_time = schedule.next_occurrence(occurrence_time)
+    # returns 2015-1-7
+
+    occurrence_time = schedule.next_occurrence(occurrence_time)
+    # returns 2015-1-8
+
+You can also use count and until to limit your rule as you would normally do
+with a regular ice_cube rule.
 
 ## Contributing
 

data/lib/ice_cube_ex/rule.rb

@@ -0,0 +1,12 @@
+require 'ice_cube_ex/rules/day_cycle_rule'
+
+module IceCubeEx
+  class Rule
+    class << self
+      # DayCycle Rule
+      def day_cycle(interval, cycle)
+        DayCycleRule.new(interval, cycle)
+      end
+    end
+  end
+end

data/lib/ice_cube_ex/{ice_cube/rules/daily_cycle_rule.rb → rules/day_cycle_rule.rb}

@@ -1,8 +1,8 @@
-require 'ice_cube_ex/ice_cube/validations/daily_cycle_interval'
+require 'ice_cube_ex/validations/day_cycle_interval'
 
-module IceCube
-  class DailyCycleRule < ValidatedRule
-    include Validations::DailyCycleInterval
+module IceCubeEx
+  class DayCycleRule < IceCube::ValidatedRule
+    include Validations::DayCycleInterval
 
     def initialize(cycle, repeat)
       super
@@ -11,12 +11,9 @@ module IceCube
       reset
     end
 
-    #
-    # cycle_start_time and why we start from one day before:
-    #
     # given the following case:
     #
-    #   Schedule start_time 2014-2-2, DailyCycleRule with cycle 4, repeat 2
+    #   Schedule start_time 2014-2-2, DayCycleRule with cycle 4, repeat 2
     #
     # if we invoke schedule.next_occurrence(2014-2-1), first calculated
     # time will be 2014-2-2, which will give a day_count of 0, thus being lower
@@ -27,21 +24,21 @@ module IceCube
     #
     #   2014-2-2, 2014-2-3, 2014-2-4
     #
-    # so to avoid this we start counting from start_time - 1.day
+    # so to avoid this we start counting from start_time - 1.day (cycle_start_time)
     def next_time(time, schedule, closing_time)
       @time = time
       @schedule = schedule
       cycle_start_time = schedule.start_time - 24 * 60 * 60
 
       return nil unless find_acceptable_time_before(closing_time)
-      day_count = number_of_days_between(@time, cycle_start_time)
-      acceptable_time_percentage = calculate_cycle_percentage(day_count)
+      number_of_days = number_of_days_between(@time, cycle_start_time)
+      acceptable_time_percentage = calculate_percentage(number_of_days)
 
-      until acceptable_time_percentage <= @cycle_percentage
+      until acceptable_time_percentage <= @acceptable_cycle_percentage
         @time += 1
         return nil unless find_acceptable_time_before(closing_time)
-        day_count = number_of_days_between(@time, cycle_start_time)
-        acceptable_time_percentage = calculate_cycle_percentage(day_count)
+        number_of_days = number_of_days_between(@time, cycle_start_time)
+        acceptable_time_percentage = calculate_percentage(number_of_days)
       end
 
       @uses += 1 if @time
@@ -59,7 +56,7 @@ module IceCube
       Time.new(time.year, time.month, time.day, 0, 0, 0, '+00:00')
     end
 
-    def calculate_cycle_percentage(day_count)
+    def calculate_percentage(day_count)
       value = (day_count.to_f / @cycle.to_f)
       percentage = ((value - value.to_i) * 100).to_i
       percentage.zero? ? 100 : percentage

data/lib/ice_cube_ex/{ice_cube/validations/daily_cycle_interval.rb → validations/day_cycle_interval.rb}

@@ -1,6 +1,6 @@
-module IceCube
+module IceCubeEx
   module Validations
-    module DailyCycleInterval
+    module DayCycleInterval
       attr_accessor :rule
 
       def cycle(cycle, repeat)
@@ -12,38 +12,22 @@ module IceCube
           raise ArgumentError, 'cycle has to be a value higher than repeat'
         end
 
-        @cycle_percentage = ((@repeat.to_f / @cycle.to_f) * 100).to_i
+        @acceptable_cycle_percentage = ((@repeat.to_f / @cycle.to_f) * 100).to_i
         replace_validations_for \
           :interval, [Validation.new(@interval, @cycle, @repeat)]
         clobber_base_validations(:wday, :day)
         self
       end
 
-      class Validation
-        attr_reader :interval, :cycle, :repeat
+      class Validation < IceCube::Validations::DailyInterval::Validation
+        attr_reader :cycle, :repeat
 
         def initialize(interval, cycle, repeat)
-          @interval = interval
+          super(interval)
           @cycle    = cycle
           @repeat   = repeat
         end
 
-        def type
-          :day
-        end
-
-        def dst_adjust?
-          true
-        end
-
-        def validate(step_time, schedule)
-          t0, t1 = schedule.start_time, step_time
-          days = Date.new(t1.year, t1.month, t1.day) -
-                 Date.new(t0.year, t0.month, t0.day)
-          offset = (days % interval).nonzero?
-          interval - offset if offset
-        end
-
         def build_s(builder)
           builder.base = "Every #{cycle} days, repeat #{repeat} times"
         end
@@ -55,7 +39,7 @@ module IceCube
         end
 
         def build_ical(builder)
-          builder['FREQ']   << 'DAILY_CYCLE (CUSTOM RULE)'
+          builder['FREQ']   << 'DAY_CYCLE (CUSTOM RULE)'
           builder['CYCLE']  << cycle
           builder['REPEAT'] << repeat
         end

data/lib/ice_cube_ex/version.rb

@@ -1,3 +1,3 @@
 module IceCubeEx
-  VERSION = "0.0.1"
+  VERSION = "0.1.0"
 end

data/lib/ice_cube_ex.rb

@@ -7,4 +7,4 @@ end
 module IceCubeEx
 end
 
-require 'ice_cube_ex/ice_cube/rule'
+require 'ice_cube_ex/rule'

data/spec/ice_cube_ex/rule_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe IceCubeEx::Rule do
+  describe '.day_cycle' do
+    context 'every 5 days, ' \
+            'repeat 3 days' do
+      let(:cycle)  { 5 }
+      let(:repeat) { 3 }
+      before { @rule = IceCubeEx::Rule.day_cycle(cycle, repeat) }
+
+      it 'returns an instance of DayCycleRule' do
+        expect(@rule.class).to eq(IceCubeEx::DayCycleRule)
+      end
+    end
+  end
+end

data/spec/ice_cube_ex/{ice_cube/rules/daily_cycle_spec.rb → rules/day_cycle_spec.rb}

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe IceCube::DailyCycleRule do
+describe IceCubeEx::DayCycleRule do
   describe '.new' do
     context 'given cycle argument bellow 2' do
       let(:cycle)  { 0 }
@@ -8,7 +8,7 @@ describe IceCube::DailyCycleRule do
 
       it 'raises error' do
         expect do
-          IceCube::DailyCycleRule.new(cycle, repeat)
+          IceCubeEx::DayCycleRule.new(cycle, repeat)
         end.to raise_error
       end
     end
@@ -19,7 +19,7 @@ describe IceCube::DailyCycleRule do
 
       it 'raises error' do
         expect do
-          IceCube::DailyCycleRule.new(cycle, repeat)
+          IceCubeEx::DayCycleRule.new(cycle, repeat)
         end.to raise_error
       end
     end

data/spec/ice_cube_ex/{ice_cube/schedule_spec.rb → schedule_spec.rb}

@@ -1,4 +1,5 @@
 require 'spec_helper'
+require 'yaml'
 
 describe IceCube::Schedule do
   describe '.next_occurrence' do
@@ -12,12 +13,12 @@ describe IceCube::Schedule do
         end
       end
 
-      context 'given rule of type DailyCycleRule initialized to ' \
+      context 'given rule of type DayCycleRule initialized to ' \
               'every 4 days (cycle), ' \
               'repeat 2 days (repeat)' do
         let(:repeat) { 2 }
         let(:cycle)  { 4 }
-        let(:rule)   { IceCube::DailyCycleRule.new(cycle, repeat) }
+        let(:rule)   { IceCubeEx::DayCycleRule.new(cycle, repeat) }
 
         context 'calculating from 3-2-2012' do
           let(:from) { Time.new(2012, 2, 3) }
@@ -54,14 +55,14 @@ describe IceCube::Schedule do
         end
       end
 
-      context 'given rule of type DailyCycleRule initialized to ' \
+      context 'given rule of type DayCycleRule initialized to ' \
               'every 4 days (cycle), ' \
               'repeat 2 days (repeat), ' \
               'which repeats 3 times (count)' do
         let(:repeat) { 2 }
         let(:cycle)  { 4 }
         let(:count)  { 3 }
-        let(:rule)   { IceCube::DailyCycleRule.new(cycle, repeat).count(3) }
+        let(:rule)   { IceCubeEx::DayCycleRule.new(cycle, repeat).count(3) }
 
         context 'calculating from 3-2-2012' do
           let(:from) { Time.new(2012, 2, 3) }
@@ -88,7 +89,7 @@ describe IceCube::Schedule do
         end
       end
 
-      context 'given rule of type DailyCycleRule initialized to ' \
+      context 'given rule of type DayCycleRule initialized to ' \
               'every 4 days (cycle), ' \
               'repeat 2 days (repeat), ' \
               'which repeats until 6-2-2012' do
@@ -96,7 +97,7 @@ describe IceCube::Schedule do
         let(:cycle)        { 4 }
         let(:repeat_until) { Time.new(2012, 2, 6) }
         let(:rule) do
-          IceCube::DailyCycleRule.new(cycle, repeat).until(repeat_until)
+          IceCubeEx::DayCycleRule.new(cycle, repeat).until(repeat_until)
         end
 
         context 'calculating from 3-2-2012' do
@@ -118,6 +119,54 @@ describe IceCube::Schedule do
           end
         end
       end
+
+      context 'given rule of type DayCycleRule initialized to ' \
+              'every 4 days (cycle), ' \
+              'repeat 2 days (repeat)' do
+        let(:repeat) { 2 }
+        let(:cycle)  { 4 }
+        let(:rule)   { IceCubeEx::DayCycleRule.new(cycle, repeat) }
+
+        context 'given serialized and deserialized schedule with YAML' do
+          before do
+            @schedule = YAML::load(YAML::dump(schedule))
+          end
+
+          context 'calculating from 3-2-2012' do
+            let(:from) { Time.new(2012, 2, 3) }
+            let(:first_occurrence)  { @schedule.next_occurrence from }
+            let(:second_occurrence) { @schedule.next_occurrence first_occurrence }
+            let(:third_occurrence)  { @schedule.next_occurrence second_occurrence }
+            let(:fourth_occurrence) { @schedule.next_occurrence third_occurrence }
+            let(:fifth_occurrence)  { @schedule.next_occurrence fourth_occurrence }
+            let(:sixth_occurrence)  { @schedule.next_occurrence fifth_occurrence }
+
+            it 'returns 4-2-2012 at 12am as first occurrence' do
+              expect(first_occurrence).to eq(start_time)
+            end
+
+            it 'returns 5-2-2012 at 12am as second occurrence' do
+              expect(second_occurrence).to eq(Time.new(2012, 2, 5, 12))
+            end
+
+            it 'returns 8-2-2012 at 12am as third occurrence', test: true do
+              expect(third_occurrence).to eq(Time.new(2012, 2, 8, 12))
+            end
+
+            it 'returns 9-2-2012 at 12am as fourth occurrence' do
+              expect(fourth_occurrence).to eq(Time.new(2012, 2, 9, 12))
+            end
+
+            it 'returns 12-2-2012 at 12am as fifth occurrence', test: true do
+              expect(fifth_occurrence).to eq(Time.new(2012, 2, 12, 12))
+            end
+
+            it 'returns 13-2-2012 at 12am as sixth occurrence' do
+              expect(sixth_occurrence).to eq(Time.new(2012, 2, 13, 12))
+            end
+          end
+        end
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ice_cube_ex
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - junhanamaki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-27 00:00:00.000000000 Z
+date: 2014-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -114,13 +114,13 @@ files:
 - Rakefile
 - ice_cube_ex.gemspec
 - lib/ice_cube_ex.rb
-- lib/ice_cube_ex/ice_cube/rule.rb
-- lib/ice_cube_ex/ice_cube/rules/daily_cycle_rule.rb
-- lib/ice_cube_ex/ice_cube/validations/daily_cycle_interval.rb
+- lib/ice_cube_ex/rule.rb
+- lib/ice_cube_ex/rules/day_cycle_rule.rb
+- lib/ice_cube_ex/validations/day_cycle_interval.rb
 - lib/ice_cube_ex/version.rb
-- spec/ice_cube_ex/ice_cube/rule_spec.rb
-- spec/ice_cube_ex/ice_cube/rules/daily_cycle_spec.rb
-- spec/ice_cube_ex/ice_cube/schedule_spec.rb
+- spec/ice_cube_ex/rule_spec.rb
+- spec/ice_cube_ex/rules/day_cycle_spec.rb
+- spec/ice_cube_ex/schedule_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/junhanamaki/ice_cube_ex
 licenses:
@@ -147,8 +147,8 @@ signing_key:
 specification_version: 4
 summary: extending ice_cube with new rules
 test_files:
-- spec/ice_cube_ex/ice_cube/rule_spec.rb
-- spec/ice_cube_ex/ice_cube/rules/daily_cycle_spec.rb
-- spec/ice_cube_ex/ice_cube/schedule_spec.rb
+- spec/ice_cube_ex/rule_spec.rb
+- spec/ice_cube_ex/rules/day_cycle_spec.rb
+- spec/ice_cube_ex/schedule_spec.rb
 - spec/spec_helper.rb
 has_rdoc: 

data/lib/ice_cube_ex/ice_cube/rule.rb

@@ -1,12 +0,0 @@
-require 'ice_cube_ex/ice_cube/rules/daily_cycle_rule'
-
-module IceCube
-  class Rule
-    class << self
-      # DailyCycle Rule
-      def daily_cycle(interval, cycle)
-        DailyCycleRule.new(interval, cycle)
-      end
-    end
-  end
-end

data/spec/ice_cube_ex/ice_cube/rule_spec.rb

@@ -1,16 +0,0 @@
-require 'spec_helper'
-
-describe IceCube::Rule do
-  describe '.daily_cycle' do
-    context 'every 5 days, ' \
-            'repeat 3 days' do
-      let(:cycle)  { 5 }
-      let(:repeat) { 3 }
-      before { @rule = IceCube::Rule.daily_cycle(cycle, repeat) }
-
-      it 'returns an instance of DailyCycleRule' do
-        expect(@rule.class).to eq(IceCube::DailyCycleRule)
-      end
-    end
-  end
-end