ice_cube_ex 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3a1f31275d0e2a370214241ff1a1e6431fb40c2f
+  data.tar.gz: 7332e9354da6df596ec727898b5f61e65b1491f3
+SHA512:
+  metadata.gz: 2c25a1c70946711f7fc347c4ce12b5215298d3b39bf008037c6227e9c694f62056128c9ca7ed1966c8ac84ae9963fec1bd4917fe7c7465cd2101a9ad8dfc0314
+  data.tar.gz: 18f44f2f3c74d3c33ddfcedb5aa4447bb63072db0ce4c9f9fd728094ec2a460c5f22b92eb74f1b343a86cd348f8e12e55ab204c4da9510b1b965d817c6d704d1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,3 @@
+--colour
+--format documentation
+--format html -o "tmp/rspec.html"

data/.ruby-gemset

@@ -0,0 +1 @@
+ice_cube_ex

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.1.1

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.1.1
+  - 2.0.0
+  - 1.9.3
+script: CODECLIMATE_REPO_TOKEN=ed05e1960c1666b7ac33d1a5e02c01825cb280e564dc833a03a1d3f0675ea7fa bundle exec rspec

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ice_cube_ex.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 junhanamaki
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,37 @@
+# IceCubeEx
+
+[![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)
+[![Dependency Status](https://gemnasium.com/junhanamaki/ice_cube_ex.svg)](https://gemnasium.com/junhanamaki/ice_cube_ex)
+
+Extends gem [ice_cube](https://github.com/seejohnrun/ice_cube) to handle
+custom rules, outside of the iCalendar spec.
+
+## Installation
+
+First require ice_cube, and then require ice_cube_ex, by adding the following
+line to your application's Gemfile:
+
+    gem 'ice_cube'
+    gem 'ice_cube_ex'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ice_cube_ex
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/junhanamaki/ice_cube_ex/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/ice_cube_ex.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ice_cube_ex/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ice_cube_ex"
+  spec.version       = IceCubeEx::VERSION
+  spec.authors       = ["junhanamaki"]
+  spec.email         = ["jun.hanamaki@gmail.com"]
+  spec.summary       = %q{extending ice_cube with new rules}
+  spec.description   = %q{extends ice_cube to handle more rules, check
+                          homepage for more details}
+  spec.homepage      = "https://github.com/junhanamaki/ice_cube_ex"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 1.9.3'
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'simplecov', '~> 0.9'
+  spec.add_development_dependency 'codeclimate-test-reporter', '~> 0.3'
+  spec.add_development_dependency 'jazz_hands', '~> 0.5'
+  spec.add_development_dependency 'ice_cube', '~> 0.12'
+end

data/lib/ice_cube_ex.rb

@@ -0,0 +1,10 @@
+require "ice_cube_ex/version"
+
+unless defined?(IceCube)
+  raise 'gem ice_cube must be require before requiring ice_cube_ex'
+end
+
+module IceCubeEx
+end
+
+require 'ice_cube_ex/ice_cube/rule'

data/lib/ice_cube_ex/ice_cube/rule.rb

@@ -0,0 +1,12 @@
+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/lib/ice_cube_ex/ice_cube/rules/daily_cycle_rule.rb

@@ -0,0 +1,68 @@
+require 'ice_cube_ex/ice_cube/validations/daily_cycle_interval'
+
+module IceCube
+  class DailyCycleRule < ValidatedRule
+    include Validations::DailyCycleInterval
+
+    def initialize(cycle, repeat)
+      super
+      cycle(cycle, repeat)
+      schedule_lock(:hour, :min, :sec)
+      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
+    #
+    # 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
+    # than cycle_percentage and being a valid value.
+    # this by itself is not a problem, but it will ruin our cycle logic since
+    # only for the first case it will repeat 3 times instead of 2, because
+    # the following dates will be valid:
+    #
+    #   2014-2-2, 2014-2-3, 2014-2-4
+    #
+    # so to avoid this we start counting from start_time - 1.day
+    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)
+
+      until acceptable_time_percentage <= @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)
+      end
+
+      @uses += 1 if @time
+      @time
+    end
+
+    def number_of_days_between(acceptable_time, initial_time)
+      acceptable_time_date = get_date(acceptable_time)
+      initial_time_date = get_date(initial_time)
+
+      ((acceptable_time_date - initial_time_date) / (24 * 60 * 60)).to_i
+    end
+
+    def get_date(time)
+      Time.new(time.year, time.month, time.day, 0, 0, 0, '+00:00')
+    end
+
+    def calculate_cycle_percentage(day_count)
+      value = (day_count.to_f / @cycle.to_f)
+      percentage = ((value - value.to_i) * 100).to_i
+      percentage.zero? ? 100 : percentage
+    end
+  end
+end

data/lib/ice_cube_ex/ice_cube/validations/daily_cycle_interval.rb

@@ -0,0 +1,76 @@
+module IceCube
+  module Validations
+    module DailyCycleInterval
+      attr_accessor :rule
+
+      def cycle(cycle, repeat)
+        @interval = 1
+        @repeat   = normalize(repeat)
+        @cycle    = normalize(cycle)
+
+        unless @repeat < @cycle
+          raise ArgumentError, 'cycle has to be a value higher than repeat'
+        end
+
+        @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
+
+        def initialize(interval, cycle, repeat)
+          @interval = 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
+
+        def build_hash(builder)
+          builder[:interval] = interval
+          builder[:cycle]    = cycle
+          builder[:repeat]   = repeat
+        end
+
+        def build_ical(builder)
+          builder['FREQ']   << 'DAILY_CYCLE (CUSTOM RULE)'
+          builder['CYCLE']  << cycle
+          builder['REPEAT'] << repeat
+        end
+      end
+
+    private
+
+      def normalize(arg)
+        arg.to_i.tap do |val|
+          unless val > 1
+            raise ArgumentError, "'#{arg}' is not a valid argument. " \
+                                 "Please pass an integer higher than 1."
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ice_cube_ex/version.rb

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

data/spec/ice_cube_ex/ice_cube/rule_spec.rb

@@ -0,0 +1,16 @@
+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

data/spec/ice_cube_ex/ice_cube/rules/daily_cycle_spec.rb

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

data/spec/ice_cube_ex/ice_cube/schedule_spec.rb

@@ -0,0 +1,123 @@
+require 'spec_helper'
+
+describe IceCube::Schedule do
+  describe '.next_occurrence' do
+    context 'given schedule starting at 4-2-2012 at 12 hours' do
+      let(:start_time) do
+        Time.new(2012, 2, 4, 12)
+      end
+      let(:schedule) do
+        IceCube::Schedule.new(start_time) do |c|
+          c.rrule rule
+        end
+      end
+
+      context 'given rule of type DailyCycleRule initialized to ' \
+              'every 4 days (cycle), ' \
+              'repeat 2 days (repeat)' do
+        let(:repeat) { 2 }
+        let(:cycle)  { 4 }
+        let(:rule)   { IceCube::DailyCycleRule.new(cycle, repeat) }
+
+        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
+
+      context 'given rule of type DailyCycleRule 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) }
+
+        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 }
+
+          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 nil as fourth occurrence' do
+            expect(fourth_occurrence).to eq(nil)
+          end
+        end
+      end
+
+      context 'given rule of type DailyCycleRule initialized to ' \
+              'every 4 days (cycle), ' \
+              'repeat 2 days (repeat), ' \
+              'which repeats until 6-2-2012' do
+        let(:repeat)       { 2 }
+        let(:cycle)        { 4 }
+        let(:repeat_until) { Time.new(2012, 2, 6) }
+        let(:rule) do
+          IceCube::DailyCycleRule.new(cycle, repeat).until(repeat_until)
+        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 }
+
+          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 nil as third occurrence', test: true do
+            expect(third_occurrence).to eq(nil)
+          end
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+if ENV['CODECLIMATE_REPO_TOKEN'].nil?
+  require 'simplecov'
+  SimpleCov.start do
+    coverage_dir 'tmp/coverage'
+  end
+else
+  require "codeclimate-test-reporter"
+  CodeClimate::TestReporter.start
+end
+
+require 'pry'
+require 'ice_cube'
+require 'ice_cube_ex'

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: ice_cube_ex
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- junhanamaki
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: jazz_hands
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: ice_cube
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+description: |-
+  extends ice_cube to handle more rules, check
+                            homepage for more details
+email:
+- jun.hanamaki@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- 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/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/spec_helper.rb
+homepage: https://github.com/junhanamaki/ice_cube_ex
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+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/spec_helper.rb
+has_rdoc: