when-cron 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7be791179d6810b1a235984131c4c440b13c945f
-  data.tar.gz: 56b1bf74f137172458f068778a8ec123fa43f38a
+  metadata.gz: 420cf2151fc72d5f0b8826761b8b5f0a826539d0
+  data.tar.gz: 43452faf5af725c4c9b6e73a123beea17ac51285
 SHA512:
-  metadata.gz: c2cf26e262f12206f73ed74be0c4c8cf5a0179ea74f28a82b116c19e5cdb95983b2735396aab3cc5dd989719ea6eef69794be9e28d393f6908cbb733a9121c3e
-  data.tar.gz: 616f6a08f514dfd476880bce095335bcc4362ae6edfc82c6cf33aaa1b76c23a0a685f71709cbb15fcae15e3ba2c6fc1a80f0cca72ac239315062e1f15cb7abcf
+  metadata.gz: b9b1fb00c0b8239626e911b6d438eb97573571825977f05d910a15d7b1ac0e56d6fe6f8baf77fc1ea2fab95af4a390c1a821893b4b47a254d08f68f4df8710e7
+  data.tar.gz: 8c230d9008b79afc09e9d1a48d36fc853a644a3b9bb031498ccd2f533fdbcfe744180b879027d8fddbb7bea132ca98bff082dbfb098b358341c9cf44c2c7b303

data/README.md

@@ -22,11 +22,14 @@ 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.
+Numbers, *, and abbreviations (SUN, JAN, etc) are supported for values.
+
+, - and / are supported as operators.
 
 ```When::Cron.valid?('a b c d e') # => false```
+```When::Cron.valid('a b c d e') # => nil```
 
-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 will only validate your string when specifically asked. This allows faster analysis of previously validated strings, but might lead to silent failures for invalid strings.
 
 ```When::Cron.new('100 * * * *') == Time.now # => false```
 

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

@@ -1,35 +1,36 @@
 module When
   class Cron
     def self.valid?(cron)
-      begin
-        new(cron)
-      rescue When::CronPart::InvalidString
-        return false
-      end
-      true
+      Validator.valid?(cron)
+    end
+
+    def self.valid(cron)
+      new(cron) if valid?(cron)
     end
 
     def initialize(cron)
-      parse(cron)
+      @cron = cron
     end
 
     def ==(time)
-      matches = []
-      matches << (@minute == time.min)
-      matches << (@hour == time.hour)
-      matches << (@day == time.day)
-      matches << (@month == time.month)
-      matches << (@wday == time.wday)
-      matches.all?
+      @parsed ||= parse(@cron)
+
+      @minute == time.min &&
+      @hour   == time.hour &&
+      @day    == time.day &&
+      @month  == time.month &&
+      @wday   == time.wday
     end
 
+    private
+
     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])
+      @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_part.rb

@@ -2,11 +2,36 @@ module When
   class CronPart
     class InvalidString < StandardError; end
 
+    REMAP = {
+      'SUN' => '0',
+      'MON' => '1',
+      'TUE' => '2',
+      'WED' => '3',
+      'THU' => '4',
+      'FRI' => '5',
+      'SAT' => '6',
+
+      'JAN' => '1',
+      'FEB' => '2',
+      'MAR' => '3',
+      'APR' => '4',
+      'MAY' => '5',
+      'JUN' => '6',
+      'JUL' => '7',
+      'AUG' => '8',
+      'SEP' => '9',
+      'OCT' => '10',
+      'NOV' => '11',
+      'DEC' => '12',
+    }
+
     def initialize(cron_part)
+      @cron_part = cron_part
       @part = parse(cron_part)
     end
 
     def ==(int)
+      @part ||= parse(@cron_part)
       @part == int
     end
 
@@ -22,10 +47,14 @@ module When
       elsif cron_part == '*'
         Wildcard.new
       else
-        to_valid_int(cron_part)
+        to_int(cron_part)
       end
     end
 
+    def to_int(cron_part)
+      to_valid_int(REMAP[cron_part.upcase] || cron_part)
+    end
+
     def to_valid_int(cron_part)
       int = cron_part.to_i
       if int.to_s == cron_part

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

@@ -0,0 +1,112 @@
+module When
+  class Cron
+    class Validator
+      MONTHS = {
+        'JAN' => '1',
+        'FEB' => '2',
+        'MAR' => '3',
+        'APR' => '4',
+        'MAY' => '5',
+        'JUN' => '6',
+        'JUL' => '7',
+        'AUG' => '8',
+        'SEP' => '9',
+        'OCT' => '10',
+        'NOV' => '11',
+        'DEC' => '12',
+      }
+
+      WDAYS = {
+        'SUN' => '0',
+        'MON' => '1',
+        'TUE' => '2',
+        'WED' => '3',
+        'THU' => '4',
+        'FRI' => '5',
+        'SAT' => '6',
+      }
+
+      NOT_BASIC_CHARS      = /[^\d,\/\*\-]/
+      NOT_BASIC_OR_LETTERS = /[^\d,\/\*\-a-zA-Z]/
+
+      def self.valid?(cron)
+        v = new(cron)
+        v.correct_number_of_parts? &&
+        v.min_correct? &&
+        v.hour_correct? &&
+        v.day_correct? &&
+        v.month_correct? &&
+        v.wday_correct?
+      end
+
+      attr_reader :cron
+
+      def initialize(cron)
+        @cron = cron
+      end
+
+      def parts
+        @parts ||= cron.split(' ')
+      end
+
+      def min
+        parts[0]
+      end
+
+      def hour
+        parts[1]
+      end
+
+      def day
+        parts[2]
+      end
+
+      def month
+        parts[3]
+      end
+
+      def wday
+        parts[4]
+      end
+
+      def correct_number_of_parts?
+        cron.split(' ').count == 5
+      end
+
+      def min_correct?
+        correct_range?(min, 0..59) &&
+        !(min =~ NOT_BASIC_CHARS)
+      end
+
+      def hour_correct?
+        correct_range?(hour, 0..23) &&
+        !(hour =~ NOT_BASIC_CHARS)
+      end
+
+      def day_correct?
+        correct_range?(day, 1..31) &&
+        !(day =~ NOT_BASIC_CHARS)
+      end
+
+      def month_correct?
+        correct_range?(month, 1..12) &&
+        month.scan(/[a-zA-Z]+/).all? { |w| MONTHS[w.upcase] } &&
+        !(month =~ NOT_BASIC_OR_LETTERS)
+      end
+
+      def wday_correct?
+        correct_range?(wday, 0..6) &&
+        wday.scan(/[a-zA-Z]+/).all? { |w| WDAYS[w.upcase] } &&
+        !(wday =~ NOT_BASIC_OR_LETTERS)
+      end
+
+      private
+
+      def correct_range?(part, range)
+        part.scan(/\d+/).all? do |digits|
+          range === digits.to_i
+        end
+      end
+    end
+  end
+end

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

@@ -143,4 +143,19 @@ describe CronPart do
       expect(cron_part == 8).to eq false
     end
   end
+
+  context 'abbreviations' do
+    CronPart::REMAP.each do |abbr, val|
+      cron_part = CronPart.new(abbr)
+
+      it "returns true for #{abbr} => #{val}" do
+        expect(cron_part == val.to_i).to eq true
+      end
+
+      it 'returns false for #{abbr} => #{val} +/- 1' do
+        expect(cron_part == val.to_i + 1).to eq false
+        expect(cron_part == val.to_i - 1).to eq false
+      end
+    end
+  end
 end

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

@@ -14,6 +14,20 @@ describe Cron do
     end
   end
 
+  describe '.valid' do
+    context 'a valid cron string is given' do
+      it 'returns a new cron object' do
+        expect(Cron.valid('* * * * *')).to be_kind_of Cron
+      end
+    end
+
+    context 'an invalid cron string is given' do
+      it 'returns nil' do
+        expect(Cron.valid('* * * * * *')).to be_nil
+      end
+    end
+  end
+
   describe '#==' do
     context 'simple cron' do
       let(:cron) { Cron.new('30 12 15 6 6') }
@@ -36,5 +50,17 @@ describe Cron do
         expect(cron == now - 3600).to eq false
       end
     end
+
+    context 'abbreviations' do
+      let(:cron) { Cron.new('* * * JUN SAT')}
+
+      it 'returns true for now' do
+        expect(cron == now).to eq true
+      end
+
+      it 'returns false for a day earlier' do
+        expect(cron == now - 3600 * 24).to eq false
+      end
+    end
   end
 end

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

@@ -0,0 +1,108 @@
+require 'spec_helper'
+include When
+
+describe Cron::Validator do
+  describe '.valid?' do
+    context 'number of parts' do
+      it 'returns true with 5 space separated parts' do
+        expect(Cron::Validator.valid?('* * * * *')).to be true
+      end
+
+      [ 1, 3, 6, 9 ].each do |i|
+        cron = (['*'] * i).join(' ')
+        it "returns false for '#{cron}'" do
+          expect(Cron::Validator.valid?(cron)).to be false
+        end
+      end
+    end
+    context 'minutes' do
+      [ '0', '1', '59' ].each do |min|
+        it "returns true when minute is #{min}" do
+          expect(Cron::Validator.valid?("#{min} * * * *")).to be true
+        end
+      end
+
+      [ '60', '134', '75' ].each do |min|
+        it "returns false when minute is #{min}" do
+          expect(Cron::Validator.valid?("#{min} * * * *")).to be false
+        end
+      end
+    end
+
+    context 'hours' do
+      [ '0', '5', '23' ].each do |hour|
+        it "returns true when hour is #{hour}" do
+          expect(Cron::Validator.valid?("* #{hour} * * *")).to be true
+        end
+      end
+
+      [ '24', '50', '999' ].each do |hour|
+        it "returns false when hour is #{hour}" do
+          expect(Cron::Validator.valid?("* #{hour} * * *")).to be false
+        end
+      end
+    end
+
+    context 'days' do
+      [ '1', '5', '31' ].each do |day|
+        it "returns true when day is #{day}" do
+          expect(Cron::Validator.valid?("* * #{day} * *")).to be true
+        end
+      end
+
+      [ '0', '32', '467' ].each do |day|
+        it "returns false when day is #{day}" do
+          expect(Cron::Validator.valid?("* * #{day} * *")).to be false
+        end
+      end
+    end
+
+    context 'months' do
+      [ '1', '5', '12', 'JAN', 'jan', 'AUG', 'DEC' ].each do |month|
+        it "returns true when month is #{month}" do
+          expect(Cron::Validator.valid?("* * * #{month} *")).to be true
+        end
+      end
+
+      [ '0', '32', '467', 'MEY', 'JIN' ].each do |month|
+        it "returns false when month is #{month}" do
+          expect(Cron::Validator.valid?("* * * #{month} *")).to be false
+        end
+      end
+    end
+
+    context 'wdays' do
+      [ '0', '5', '6', 'Mon', 'TUE', 'thu', 'saT' ].each do |wday|
+        it "returns true when wday is #{wday}" do
+          expect(Cron::Validator.valid?("* * * * #{wday}")).to be true
+        end
+      end
+
+      [ '7', '32', '467', 'MIN', 'TUW' ].each do |wday|
+        it "returns false when wday is #{wday}" do
+          expect(Cron::Validator.valid?("* * * * #{wday}")).to be false
+        end
+      end
+    end
+
+    context 'characters' do
+      [ '!', '&', '[', '\\' ].each do |char|
+        5.times do |i|
+          cron = [ '*', '*', '*', '*' ].insert(i, char).join(' ')
+          it "returns false for #{cron}" do
+            expect(Cron::Validator.valid?(cron)).to eq false
+          end
+        end
+      end
+
+      [ '-', '*', '/', ',' ].each do |char|
+        5.times do |i|
+          cron = [ '*', '*', '*', '*' ].insert(i, char).join(' ')
+          it "returns true for #{cron}" do
+            expect(Cron::Validator.valid?(cron)).to eq true
+          end
+        end
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,8 +1,5 @@
 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

@@ -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.1'
+  spec.version       = '1.0.2'
   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.1
+  version: 1.0.2
 platform: ruby
 authors:
 - TH
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-24 00:00:00.000000000 Z
+date: 2014-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -102,12 +102,14 @@ files:
 - 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/validator.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/validator_spec.rb
 - spec/lib/when/cron/wildcard_spec.rb
 - spec/lib/when_spec.rb
 - spec/spec_helper.rb
@@ -142,7 +144,7 @@ test_files:
 - 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/validator_spec.rb
 - spec/lib/when/cron/wildcard_spec.rb
 - spec/lib/when_spec.rb
 - spec/spec_helper.rb
-has_rdoc: