ice_cube_ex 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e5c2110052533d6a2c202dd9b5956ab34860f27b
-  data.tar.gz: 4e9b6686c099e9e8c31de765379dd5bcdab0914b
+  metadata.gz: c56e3b3deea8d3db6aa092f1bfb2718acc5556c2
+  data.tar.gz: 903127529c8a3dddc212b3e8ea34b2e71beb5f23
 SHA512:
-  metadata.gz: 371cce05e26cb616d3b3611ef2becf34c1d47ce0ec161d9489525f3fd5a1cf13ac9f1996b29ee3cc84d788c453f26ac00b39799b9a48be1c8afd2e8a1a58961a
-  data.tar.gz: b10f2e2527efcf30594e5176b5b0b6a2cce0eb6fd0d09a07ca6f4a4486139d9cc0d996455d28cf1c7b9c4f64abaaa248f451686b65a87c75eebc5a793398e736
+  metadata.gz: 83b57e7f76e01c907d25382b44a4883c1a7ccfb25ce77a7b6afcdbdf8631485d573f3702925a808bd0638688e495e0564eb5ad50999ffbc9bfbc3d0f3b5097a6
+  data.tar.gz: 57e654fa8a9d8d342b496adf6f3b14cefb896202a15b749943dcb181326c9be748810591047f59fdf9a1dd761a5c74a25c0cbb45b5a7b944a0afec70cdf741b8

data/README.md

@@ -31,15 +31,16 @@ 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:
+This rule allows to specify a number of days, which indicates a cycle, and
+another number of days to skip inside that cycle.
+For example, we want an event that starts at 2015-1-1 to recur every 5 days
+while skipping the last 3 days, we would do something like this:
 
     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:
+Now try calculating next occurrences:
 
     occurrence_time = schedule.next_occurrence(Time.new(2014-12-30))
     # returns 2015-1-1

data/lib/ice_cube_ex/rule.rb

@@ -4,8 +4,8 @@ module IceCubeEx
   class Rule
     class << self
       # DayCycle Rule
-      def day_cycle(interval, cycle)
-        DayCycleRule.new(interval, cycle)
+      def day_cycle(cycle, skip)
+        DayCycleRule.new(cycle, skip)
       end
     end
   end

data/lib/ice_cube_ex/rules/day_cycle_rule.rb

@@ -4,16 +4,16 @@ module IceCubeEx
   class DayCycleRule < IceCube::ValidatedRule
     include Validations::DayCycleInterval
 
-    def initialize(cycle, repeat)
+    def initialize(cycle, skip)
       super
-      cycle(cycle, repeat)
+      cycle(cycle, skip)
       schedule_lock(:hour, :min, :sec)
       reset
     end
 
     # given the following case:
     #
-    #   Schedule start_time 2014-2-2, DayCycleRule with cycle 4, repeat 2
+    #   Schedule start_time 2014-2-2, DayCycleRule with cycle 4, skip 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
@@ -32,13 +32,13 @@ module IceCubeEx
 
       return nil unless find_acceptable_time_before(closing_time)
       number_of_days = number_of_days_between(@time, cycle_start_time)
-      acceptable_time_percentage = calculate_percentage(number_of_days)
+      current_cycle_percentage = calculate_percentage(number_of_days)
 
-      until acceptable_time_percentage <= @acceptable_cycle_percentage
+      until current_cycle_percentage <= @acceptable_cycle_percentage
         @time += 1
         return nil unless find_acceptable_time_before(closing_time)
         number_of_days = number_of_days_between(@time, cycle_start_time)
-        acceptable_time_percentage = calculate_percentage(number_of_days)
+        current_cycle_percentage = calculate_percentage(number_of_days)
       end
 
       @uses += 1 if @time
@@ -57,7 +57,7 @@ module IceCubeEx
     end
 
     def calculate_percentage(day_count)
-      value = (day_count.to_f / @cycle.to_f)
+      value      = (day_count.to_f / @cycle.to_f)
       percentage = ((value - value.to_i) * 100).to_i
       percentage.zero? ? 100 : percentage
     end

data/lib/ice_cube_ex/validations/day_cycle_interval.rb

@@ -3,45 +3,46 @@ module IceCubeEx
     module DayCycleInterval
       attr_accessor :rule
 
-      def cycle(cycle, repeat)
+      def cycle(cycle, skip)
         @interval = 1
-        @repeat   = normalize(repeat)
+        @skip     = normalize(skip)
         @cycle    = normalize(cycle)
 
-        unless @repeat < @cycle
-          raise ArgumentError, 'cycle has to be a value higher than repeat'
+        unless @skip < @cycle
+          raise ArgumentError, "we can't skip more days than the number of "   \
+                               "days in the cycle, so skip has to be a value " \
+                               "bellow cycle"
         end
 
-        @acceptable_cycle_percentage = ((@repeat.to_f / @cycle.to_f) * 100).to_i
+        @acceptable_cycle_percentage = \
+          (((@cycle - @skip).to_f / @cycle.to_f) * 100).to_i
         replace_validations_for \
-          :interval, [Validation.new(@interval, @cycle, @repeat)]
+          :interval, [Validation.new(@interval, @cycle, @skip)]
         clobber_base_validations(:wday, :day)
         self
       end
 
       class Validation < IceCube::Validations::DailyInterval::Validation
-        attr_reader :cycle, :repeat
+        attr_reader :cycle, :skip
 
-        def initialize(interval, cycle, repeat)
+        def initialize(interval, cycle, skip)
           super(interval)
           @cycle    = cycle
-          @repeat   = repeat
+          @skip   = skip
         end
 
         def build_s(builder)
-          builder.base = "Every #{cycle} days, repeat #{repeat} times"
+          builder.base = "Every #{cycle} days, skip #{skip} times"
         end
 
         def build_hash(builder)
           builder[:interval] = interval
           builder[:cycle]    = cycle
-          builder[:repeat]   = repeat
+          builder[:skip]     = skip
         end
 
         def build_ical(builder)
-          builder['FREQ']   << 'DAY_CYCLE (CUSTOM RULE)'
-          builder['CYCLE']  << cycle
-          builder['REPEAT'] << repeat
+          builder['FREQ'] << 'DAY_CYCLE (CUSTOM RULE)'
         end
       end
 

data/lib/ice_cube_ex/version.rb

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

data/spec/ice_cube_ex/rule_spec.rb

@@ -2,11 +2,11 @@ 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) }
+    context 'cycle 5 days, ' \
+            'skip 3 days' do
+      let(:cycle) { 5 }
+      let(:skip)  { 3 }
+      before { @rule = IceCubeEx::Rule.day_cycle(cycle, skip) }
 
       it 'returns an instance of DayCycleRule' do
         expect(@rule.class).to eq(IceCubeEx::DayCycleRule)

data/spec/ice_cube_ex/rules/day_cycle_spec.rb

@@ -3,23 +3,23 @@ require 'spec_helper'
 describe IceCubeEx::DayCycleRule do
   describe '.new' do
     context 'given cycle argument bellow 2' do
-      let(:cycle)  { 0 }
-      let(:repeat) { 1 }
+      let(:cycle) { 0 }
+      let(:skip)  { 1 }
 
       it 'raises error' do
         expect do
-          IceCubeEx::DayCycleRule.new(cycle, repeat)
+          IceCubeEx::DayCycleRule.new(cycle, skip)
         end.to raise_error
       end
     end
 
-    context 'given cycle argument lower than repeat' do
-      let(:cycle)  { 9 }
-      let(:repeat) { 10 }
+    context 'given cycle argument lower than skip' do
+      let(:cycle) { 9 }
+      let(:skip)  { 10 }
 
       it 'raises error' do
         expect do
-          IceCubeEx::DayCycleRule.new(cycle, repeat)
+          IceCubeEx::DayCycleRule.new(cycle, skip)
         end.to raise_error
       end
     end

data/spec/ice_cube_ex/schedule_spec.rb

@@ -13,12 +13,64 @@ describe IceCube::Schedule do
         end
       end
 
+      context 'given rule of type DayCycleRule initialized to ' \
+              'every 5 days (cycle), ' \
+              'skip 2 days (skip)' do
+        let(:cycle) { 5 }
+        let(:skip)  { 2 }
+        let(:rule)  { IceCubeEx::DayCycleRule.new(cycle, skip) }
+
+        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 }
+          let(:seventh_occurrence) { schedule.next_occurrence sixth_occurrence }
+          let(:eighth_occurrence)  { schedule.next_occurrence seventh_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 6-2-2012 at 12am as third occurrence' do
+            expect(third_occurrence).to eq(Time.new(2012, 2, 6, 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 10-2-2012 at 12am as fifth occurrence' do
+            expect(fifth_occurrence).to eq(Time.new(2012, 2, 10, 12))
+          end
+
+          it 'returns 11-2-2012 at 12am as sixth occurrence' do
+            expect(sixth_occurrence).to eq(Time.new(2012, 2, 11, 12))
+          end
+
+          it 'returns 14-2-2012 at 12am as seventh occurrence' do
+            expect(seventh_occurrence).to eq(Time.new(2012, 2, 14, 12))
+          end
+
+          it 'returns 15-2-2012 at 12am as eighth occurrence' do
+            expect(eighth_occurrence).to eq(Time.new(2012, 2, 15, 12))
+          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) }
+              'skip 2 days  (skip)' do
+        let(:cycle) { 4 }
+        let(:skip)  { 2 }
+        let(:rule)  { IceCubeEx::DayCycleRule.new(cycle, skip) }
 
         context 'calculating from 3-2-2012' do
           let(:from) { Time.new(2012, 2, 3) }
@@ -37,7 +89,7 @@ describe IceCube::Schedule 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
+          it 'returns 8-2-2012 at 12am as third occurrence' do
             expect(third_occurrence).to eq(Time.new(2012, 2, 8, 12))
           end
 
@@ -45,7 +97,7 @@ describe IceCube::Schedule 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
+          it 'returns 12-2-2012 at 12am as fifth occurrence' do
             expect(fifth_occurrence).to eq(Time.new(2012, 2, 12, 12))
           end
 
@@ -57,12 +109,12 @@ describe IceCube::Schedule do
 
       context 'given rule of type DayCycleRule initialized to ' \
               'every 4 days (cycle), ' \
-              'repeat 2 days (repeat), ' \
+              'skip 2 days (skip), ' \
               'which repeats 3 times (count)' do
-        let(:repeat) { 2 }
-        let(:cycle)  { 4 }
-        let(:count)  { 3 }
-        let(:rule)   { IceCubeEx::DayCycleRule.new(cycle, repeat).count(3) }
+        let(:cycle) { 4 }
+        let(:skip)  { 2 }
+        let(:count) { 3 }
+        let(:rule)  { IceCubeEx::DayCycleRule.new(cycle, skip).count(3) }
 
         context 'calculating from 3-2-2012' do
           let(:from) { Time.new(2012, 2, 3) }
@@ -79,7 +131,7 @@ describe IceCube::Schedule 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
+          it 'returns 8-2-2012 at 12am as third occurrence' do
             expect(third_occurrence).to eq(Time.new(2012, 2, 8, 12))
           end
 
@@ -91,13 +143,13 @@ describe IceCube::Schedule do
 
       context 'given rule of type DayCycleRule initialized to ' \
               'every 4 days (cycle), ' \
-              'repeat 2 days (repeat), ' \
+              'skip 2 days (skip), ' \
               'which repeats until 6-2-2012' do
-        let(:repeat)       { 2 }
         let(:cycle)        { 4 }
+        let(:skip)         { 2 }
         let(:repeat_until) { Time.new(2012, 2, 6) }
         let(:rule) do
-          IceCubeEx::DayCycleRule.new(cycle, repeat).until(repeat_until)
+          IceCubeEx::DayCycleRule.new(cycle, skip).until(repeat_until)
         end
 
         context 'calculating from 3-2-2012' do
@@ -114,7 +166,7 @@ describe IceCube::Schedule do
             expect(second_occurrence).to eq(Time.new(2012, 2, 5, 12))
           end
 
-          it 'returns nil as third occurrence', test: true do
+          it 'returns nil as third occurrence' do
             expect(third_occurrence).to eq(nil)
           end
         end
@@ -122,10 +174,10 @@ describe IceCube::Schedule do
 
       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) }
+              'skip 2 days (skip)' do
+        let(:cycle) { 4 }
+        let(:skip)  { 2 }
+        let(:rule)  { IceCubeEx::DayCycleRule.new(cycle, skip) }
 
         context 'given serialized and deserialized schedule with YAML' do
           before do
@@ -149,7 +201,7 @@ describe IceCube::Schedule 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
+            it 'returns 8-2-2012 at 12am as third occurrence' do
               expect(third_occurrence).to eq(Time.new(2012, 2, 8, 12))
             end
 
@@ -157,7 +209,7 @@ describe IceCube::Schedule 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
+            it 'returns 12-2-2012 at 12am as fifth occurrence' do
               expect(fifth_occurrence).to eq(Time.new(2012, 2, 12, 12))
             end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ice_cube_ex
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - junhanamaki
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-28 00:00:00.000000000 Z
+date: 2014-10-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler