when-cron 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c6cb41b52b68db876230191f75c10dae240f4d40
-  data.tar.gz: e8c00085e9e93d136787e99e7ae85909c14e14da
+  metadata.gz: 7be791179d6810b1a235984131c4c440b13c945f
+  data.tar.gz: 56b1bf74f137172458f068778a8ec123fa43f38a
 SHA512:
-  metadata.gz: b9f877e0558fa5c2689ec41704db1accc2808bf4f23d2dcde1cc37eba7a4c3895be94ed5be7c0702757fff12c6d47973de604e9b3dd795c8f375a290c88ba7eb
-  data.tar.gz: 8f3c9b5015c529772246b44886256bfc89e72f65f41f32f849e5d6fd501e5e2ee8f306a33bf6780cae6d0bf3150d9eb3985f069402821a1365608d1dbf56b955
+  metadata.gz: c2cf26e262f12206f73ed74be0c4c8cf5a0179ea74f28a82b116c19e5cdb95983b2735396aab3cc5dd989719ea6eef69794be9e28d393f6908cbb733a9121c3e
+  data.tar.gz: 616f6a08f514dfd476880bce095335bcc4362ae6edfc82c6cf33aaa1b76c23a0a685f71709cbb15fcae15e3ba2c6fc1a80f0cca72ac239315062e1f15cb7abcf

data/README.md

@@ -1,12 +1,12 @@
-# When
+# When-Cron
 
-TODO: Write a gem description
+A basic cron implementation in Ruby.
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'when'
+    gem 'when-cron'
 
 And then execute:
 
@@ -14,11 +14,25 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install when
+    $ gem install when-cron
 
 ## Usage
 
-TODO: Write usage instructions here
+Compare to anything that has an interface like Ruby's Time class with ==.
+
+```When::Cron.new('* * * * *') == Time.now # => true```
+
+Only numbers or * are supported for values, only - , / are supported as operators.
+
+```When::Cron.valid?('a b c d e') # => false```
+
+When::Cron will allow nonsensical values (exa. 100 in the minute spot), but because the minute will never match, == will always return false.
+
+```When::Cron.new('100 * * * *') == Time.now # => false```
+
+When::Cron will raise an error for extremely nonsensical cron strings.
+
+```When::Cron.new('this is getting ridiculous') # => raises When::Cron::InvalidString```
 
 ## Contributing
 

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

@@ -1,11 +1,19 @@
 module When
   class Cron
+    def self.valid?(cron)
+      begin
+        new(cron)
+      rescue When::CronPart::InvalidString
+        return false
+      end
+      true
+    end
+
     def initialize(cron)
-      @cron = cron
+      parse(cron)
     end
 
     def ==(time)
-      parsed?
       matches = []
       matches << (@minute == time.min)
       matches << (@hour == time.hour)
@@ -15,12 +23,6 @@ module When
       matches.all?
     end
 
-    private
-
-    def parsed?
-      @parsed ||= parse(@cron)
-    end
-
     def parse(string)
       strings = string.split(' ')
       @minute = CronPart.new(strings[0])

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

@@ -1,31 +1,39 @@
 module When
   class CronPart
+    class InvalidString < StandardError; end
+
     def initialize(cron_part)
-      @cron_part = cron_part
+      @part = parse(cron_part)
     end
 
     def ==(int)
-      part == 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+$/
+      elsif cron_part =~ /\//
         CronInterval.new(*cron_part.split('/').map { |s| parse(s) })
-      elsif cron_part =~ /^(\d+|\*)-(\d+|\*)$/
+      elsif cron_part =~ /-/
         CronRange.new(*cron_part.split('-').map { |s| parse(s) })
       elsif cron_part == '*'
         Wildcard.new
       else
-        cron_part.to_i
+        to_valid_int(cron_part)
+      end
+    end
+
+    def to_valid_int(cron_part)
+      int = cron_part.to_i
+      if int.to_s == cron_part
+        int
+      else
+        raise When::CronPart::InvalidString, "found #{cron_part.inspect}: only * or integer values and / , - operators are supported"
       end
     end
   end
+
 end

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

@@ -2,6 +2,12 @@ require 'spec_helper'
 include When
 
 describe CronPart do
+  context 'invalid value' do
+    it 'raises an error' do
+      expect { CronPart.new('a') }.to raise_error
+    end
+  end
+
   context 'basic number' do
     let(:cron_part) { CronPart.new('5') }
 

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

@@ -4,6 +4,16 @@ include When
 describe Cron do
   let(:now) { Time.new(2013, 6, 15, 12, 30, 30) }
 
+  describe '.valid?' do
+    it 'returns false for strings it cannot interpret' do
+      expect(Cron.valid?('* * * * a,b')).to be false
+    end
+
+    it 'returns true for cron string it can interpret' do
+      expect(Cron.valid?('* * * * 1')).to be true
+    end
+  end
+
   describe '#==' do
     context 'simple cron' do
       let(:cron) { Cron.new('30 12 15 6 6') }

data/when-cron.gemspec

@@ -4,7 +4,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |spec|
   spec.name          = "when-cron"
-  spec.version       = '1.0.0'
+  spec.version       = '1.0.1'
   spec.authors       = ["TH"]
   spec.email         = ["tylerhartland7@gmail.com"]
   spec.description   = %q{A basic cron implementation.}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: when-cron
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - TH
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-10 00:00:00.000000000 Z
+date: 2014-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler