when-cron 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c6cb41b52b68db876230191f75c10dae240f4d40
+  data.tar.gz: e8c00085e9e93d136787e99e7ae85909c14e14da
+SHA512:
+  metadata.gz: b9f877e0558fa5c2689ec41704db1accc2808bf4f23d2dcde1cc37eba7a4c3895be94ed5be7c0702757fff12c6d47973de604e9b3dd795c8f375a290c88ba7eb
+  data.tar.gz: 8f3c9b5015c529772246b44886256bfc89e72f65f41f32f849e5d6fd501e5e2ee8f306a33bf6780cae6d0bf3150d9eb3985f069402821a1365608d1dbf56b955

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,2 @@
+--color
+--format progress

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,5 @@
+guard :rspec, all_after_pass: true, all_on_start: true do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 TH
+
+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,29 @@
+# When
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'when'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install when
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+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/bin/when

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'when'
+
+

data/lib/when-cron/cron/cron.rb

@@ -0,0 +1,33 @@
+module When
+  class Cron
+    def initialize(cron)
+      @cron = cron
+    end
+
+    def ==(time)
+      parsed?
+      matches = []
+      matches << (@minute == time.min)
+      matches << (@hour == time.hour)
+      matches << (@day == time.day)
+      matches << (@month == time.month)
+      matches << (@wday == time.wday)
+      matches.all?
+    end
+
+    private
+
+    def parsed?
+      @parsed ||= parse(@cron)
+    end
+
+    def parse(string)
+      strings = string.split(' ')
+      @minute = CronPart.new(strings[0])
+      @hour = CronPart.new(strings[1])
+      @day = CronPart.new(strings[2])
+      @month = CronPart.new(strings[3])
+      @wday = CronPart.new(strings[4])
+    end
+  end
+end

data/lib/when-cron/cron/cron_array.rb

@@ -0,0 +1,11 @@
+module When
+  class CronArray
+    def initialize(array)
+      @array = array
+    end
+
+    def ==(int)
+      @array.any? { |i| i == int }
+    end
+  end
+end

data/lib/when-cron/cron/cron_interval.rb

@@ -0,0 +1,12 @@
+module When
+  class CronInterval
+    def initialize(range, interval)
+      @range = range
+      @interval = interval
+    end
+
+    def ==(int)
+      int == @range && (int - @range.first) % @interval == 0
+    end
+  end
+end

data/lib/when-cron/cron/cron_part.rb

@@ -0,0 +1,31 @@
+module When
+  class CronPart
+    def initialize(cron_part)
+      @cron_part = cron_part
+    end
+
+    def ==(int)
+      part == int
+    end
+
+    private
+
+    def part
+      @part ||= parse(@cron_part)
+    end
+
+    def parse(cron_part)
+      if cron_part =~ /,/
+        CronArray.new(cron_part.split(',').map { |s| parse(s) })
+      elsif cron_part =~ /^((\d+|\*)-(\d+|\*)|\*)\/\d+$/
+        CronInterval.new(*cron_part.split('/').map { |s| parse(s) })
+      elsif cron_part =~ /^(\d+|\*)-(\d+|\*)$/
+        CronRange.new(*cron_part.split('-').map { |s| parse(s) })
+      elsif cron_part == '*'
+        Wildcard.new
+      else
+        cron_part.to_i
+      end
+    end
+  end
+end

data/lib/when-cron/cron/cron_range.rb

@@ -0,0 +1,14 @@
+module When
+  class CronRange
+    attr_reader :first, :last
+
+    def initialize(first, last)
+      @first = first
+      @last = last
+    end
+
+    def ==(int)
+      @first <= int && @last >= int
+    end
+  end
+end

data/lib/when-cron/cron/wildcard.rb

@@ -0,0 +1,31 @@
+module When
+  class Wildcard
+    def ==(obj)
+      true
+    end
+
+    def <=(obj)
+      true
+    end
+
+    def >=(obj)
+      true
+    end
+
+    def <(obj)
+      true
+    end
+
+    def >(obj)
+      true
+    end
+
+    def first
+      0
+    end
+
+    def last
+      0
+    end
+  end
+end

data/lib/when-cron.rb

@@ -0,0 +1,4 @@
+Gem.find_files("when-cron/**/*.rb").each { |path| require path }
+
+module When
+end

data/spec/lib/when/cron/cron_array_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+include When
+
+describe CronArray do
+  let(:cron_array) { CronArray.new([1,2,3]) }
+
+  describe '#==' do
+    context 'the array contains the given value' do
+      it 'returns true' do
+        expect(cron_array == 1).to eq true
+      end
+    end
+
+    context 'the array does not contain the given value' do
+      it 'returns false' do
+        expect(cron_array == 4).to eq false
+      end
+    end
+  end
+end

data/spec/lib/when/cron/cron_interval_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+include When
+
+describe CronInterval do
+  describe '#==' do
+    context 'wildcard over int' do
+      let(:cron_interval) { CronInterval.new(Wildcard.new, 3) }
+
+      it 'returns true for zero and multiples of 3' do
+        expect(cron_interval == (0 + rand(10)*3)).to eq true
+      end
+
+      it 'returns false for non zero non multiples of 3' do
+        expect(cron_interval == (1 + rand(10)*3)).to eq false
+        expect(cron_interval == (2 + rand(10)*3)).to eq false
+      end
+    end
+
+    context 'cron range over int' do
+      let(:cron_interval) { CronInterval.new(CronRange.new(8,39), 15) }
+
+      it 'returns true for 8, 23, and 38' do
+        expect(cron_interval == 8).to eq true
+        expect(cron_interval == 23).to eq true
+        expect(cron_interval == 38).to eq true
+      end
+
+      it 'returns false for 7, 24, 39, and 53' do
+        expect(cron_interval == 7).to eq false
+        expect(cron_interval == 24).to eq false
+        expect(cron_interval == 39).to eq false
+        expect(cron_interval == 53).to eq false
+      end
+    end
+  end
+end

data/spec/lib/when/cron/cron_part_spec.rb

@@ -0,0 +1,140 @@
+require 'spec_helper'
+include When
+
+describe CronPart do
+  context 'basic number' do
+    let(:cron_part) { CronPart.new('5') }
+
+    it 'returns true when compared to 5' do
+      expect(cron_part == 5).to eq true
+    end
+
+    it 'returns false when compared to 4 or 6' do
+      expect(cron_part == 4).to eq false
+      expect(cron_part == 6).to eq false
+    end
+  end
+
+  context 'list of numbers' do
+    let(:cron_part) { CronPart.new('3,5,8') }
+
+    it 'returns true when compared to 3, 5, or 8' do
+      expect(cron_part == 3).to eq true
+      expect(cron_part == 5).to eq true
+      expect(cron_part == 8).to eq true
+    end
+
+    it 'returns false when compared to 2,4,6,7 or 9' do
+      expect(cron_part == 2).to eq false
+      expect(cron_part == 4).to eq false
+      expect(cron_part == 6).to eq false
+      expect(cron_part == 7).to eq false
+      expect(cron_part == 9).to eq false
+    end
+  end
+
+  context 'range' do
+    let(:cron_part) { CronPart.new('3-5') }
+
+    it 'returns true for 3, 4, or 5' do
+      expect(cron_part == 3).to eq true
+      expect(cron_part == 4).to eq true
+      expect(cron_part == 5).to eq true
+    end
+
+    it 'returns false for 2 or 6' do
+      expect(cron_part == 2).to eq false
+      expect(cron_part == 6).to eq false
+    end
+  end
+
+  context 'wildcard' do
+    let(:cron_part) { CronPart.new('*') }
+
+    it 'returns true for any number' do
+      expect(cron_part == rand(1000)).to eq true
+    end
+  end
+
+  context 'list and range' do
+    let(:cron_part) { CronPart.new('2,3,5-7') }
+
+    it 'returns true for 2, 3, 5, 6, or 7' do
+      expect(cron_part == 2).to eq true
+      expect(cron_part == 3).to eq true
+      expect(cron_part == 5).to eq true
+      expect(cron_part == 6).to eq true
+      expect(cron_part == 7).to eq true
+    end
+
+    it 'returns false for 1, 4, or 8' do
+      expect(cron_part == 1).to eq false
+      expect(cron_part == 4).to eq false
+      expect(cron_part == 8).to eq false
+    end
+  end
+
+  context 'wildcard interval' do
+    let(:cron_part) { CronPart.new('*/14') }
+
+    it 'returns true for zero or any multiple of 14' do
+      expect(cron_part == 0).to eq true
+      expect(cron_part == 14 * rand(1000)).to eq true
+    end
+
+    it 'returns false for any non-zero non-multiple of 14' do
+      expect(cron_part == 14 * rand(1000) + 1).to eq false
+    end
+  end
+
+  context 'wildcard ranges' do
+    let(:cron_part) { CronPart.new('*-5,9-*') }
+
+    it 'returns true for 0 to 5 and 9 or above' do
+      expect(cron_part == 0).to eq true
+      expect(cron_part == rand(5)).to eq true
+      expect(cron_part == 5).to eq true
+      expect(cron_part == 9).to eq true
+      expect(cron_part == 9 + rand(1000)).to eq true
+    end
+  end
+
+  context 'range interval' do
+    let(:cron_part) { CronPart.new('23-45/7') }
+
+    it 'returns true for 23, 30, 37, and 44' do
+      expect(cron_part == 23).to eq true
+      expect(cron_part == 30).to eq true
+      expect(cron_part == 37).to eq true
+      expect(cron_part == 44).to eq true
+    end
+
+    it 'returns false for 16, 24, 43, 51' do
+      expect(cron_part == 16).to eq false
+      expect(cron_part == 24).to eq false
+      expect(cron_part == 43).to eq false
+      expect(cron_part == 51).to eq false
+    end
+  end
+
+  context 'list, range, wildcard' do
+    let(:cron_part) { CronPart.new('1,2,5-7,9-*') }
+
+    it 'returns true for 1, 2, 5, 6, 7, 9 and above' do
+      expect(cron_part == 1).to eq true
+      expect(cron_part == 2).to eq true
+      expect(cron_part == 5).to eq true
+      expect(cron_part == 6).to eq true
+      expect(cron_part == 7).to eq true
+      expect(cron_part == 9).to eq true
+      expect(cron_part == 9 + rand(1000)).to eq true
+    end
+
+    it 'returns false for 0, 3, 4, 8' do
+      expect(cron_part == 0).to eq false
+      expect(cron_part == 3).to eq false
+      expect(cron_part == 4).to eq false
+      expect(cron_part == 8).to eq false
+    end
+  end
+end

data/spec/lib/when/cron/cron_range_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+include When
+
+describe CronRange do
+  let(:cron_range) { CronRange.new(1, 3) }
+  describe '#==' do
+    it 'returns true if value is within range' do
+      expect(cron_range == 1).to eq true
+      expect(cron_range == 2).to eq true
+      expect(cron_range == 3).to eq true
+    end
+
+    it 'returns false if value is outside range' do
+      expect(cron_range == 4).to eq false
+      expect(cron_range == 0).to eq false
+    end
+  end
+end

data/spec/lib/when/cron/cron_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+include When
+
+describe Cron do
+  let(:now) { Time.new(2013, 6, 15, 12, 30, 30) }
+
+  describe '#==' do
+    context 'simple cron' do
+      let(:cron) { Cron.new('30 12 15 6 6') }
+      it 'returns true for now' do
+        expect(cron == now).to eq true
+      end
+
+      it 'returns false for an hour earlier' do
+        expect(cron == now - 3600).to eq false
+      end
+    end
+
+    context 'complex cron' do
+      let(:cron) { Cron.new('25-35/5 */12 */5 4-8/2 6') }
+      it 'returns true for now' do
+        expect(cron == now).to eq true
+      end
+
+      it 'returns false for an hour earlier' do
+        expect(cron == now - 3600).to eq false
+      end
+    end
+  end
+end

data/spec/lib/when/cron/wildcard_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+include When
+
+describe Wildcard do
+  describe '#==' do
+    it 'returns true' do
+      expect(Wildcard.new == 'asdf').to eq true
+    end
+  end
+
+  describe '#<=' do
+    it 'returns true' do
+      expect(Wildcard.new <= 'asdf').to eq true
+    end
+  end
+
+  describe '#>=' do
+    it 'returns true' do
+      expect(Wildcard.new >= 'asdf').to eq true
+    end
+  end
+
+  describe '#<' do
+    it 'returns true' do
+      expect(Wildcard.new < 'asdf').to eq true
+    end
+  end
+
+  describe '#>' do
+    it 'returns true' do
+      expect(Wildcard.new > 'asdf').to eq true
+    end
+  end
+
+  describe '#first' do
+    it 'returns zero' do
+      expect(Wildcard.new.first).to eq 0
+    end
+  end
+
+  describe '#last' do
+    it 'returns zero' do
+      expect(Wildcard.new.last).to eq 0
+    end
+  end
+end

data/spec/lib/when_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe When do
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'when-cron'
+
+RSpec.configure do |config|
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  config.order = 'random'
+end

data/when-cron.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "when-cron"
+  spec.version       = '1.0.0'
+  spec.authors       = ["TH"]
+  spec.email         = ["tylerhartland7@gmail.com"]
+  spec.description   = %q{A basic cron implementation.}
+  spec.summary       = %q{A basic cron implementation.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "guard-rspec"
+end

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: when-cron
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- TH
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A basic cron implementation.
+email:
+- tylerhartland7@gmail.com
+executables:
+- when
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/when
+- lib/when-cron.rb
+- lib/when-cron/cron/cron.rb
+- lib/when-cron/cron/cron_array.rb
+- lib/when-cron/cron/cron_interval.rb
+- lib/when-cron/cron/cron_part.rb
+- lib/when-cron/cron/cron_range.rb
+- lib/when-cron/cron/wildcard.rb
+- spec/lib/when/cron/cron_array_spec.rb
+- spec/lib/when/cron/cron_interval_spec.rb
+- spec/lib/when/cron/cron_part_spec.rb
+- spec/lib/when/cron/cron_range_spec.rb
+- spec/lib/when/cron/cron_spec.rb
+- spec/lib/when/cron/wildcard_spec.rb
+- spec/lib/when_spec.rb
+- spec/spec_helper.rb
+- when-cron.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: A basic cron implementation.
+test_files:
+- spec/lib/when/cron/cron_array_spec.rb
+- spec/lib/when/cron/cron_interval_spec.rb
+- spec/lib/when/cron/cron_part_spec.rb
+- spec/lib/when/cron/cron_range_spec.rb
+- spec/lib/when/cron/cron_spec.rb
+- spec/lib/when/cron/wildcard_spec.rb
+- spec/lib/when_spec.rb
+- spec/spec_helper.rb
+has_rdoc: