cronex 0.2.0

data/spec/casing_spec.rb

@@ -0,0 +1,22 @@
+require 'cronex'
+
+module Cronex
+  describe ExpressionDescriptor do
+
+    subject(:expression) { '* * * * *' }
+
+    context 'casing:' do
+      it 'sentence' do
+        expect(desc(expression, casing: :sentence)).to eq('Every minute')
+      end
+
+      it 'title' do
+        expect(desc(expression, casing: :title)).to eq('Every Minute')
+      end
+
+      it 'lower' do
+        expect(desc(expression, casing: :lower)).to eq('every minute')
+      end
+    end
+  end
+end

data/spec/exp_descriptor_spec.rb

@@ -0,0 +1,363 @@
+require 'cronex'
+
+module Cronex
+  describe ExpressionDescriptor do
+
+    let(:opts) { { zero_based_dow: false } }
+
+    it 'every second' do
+      expect(desc('* * * * * *')).to eq('Every second')
+    end
+
+    it 'every 45 seconds' do
+      expect(desc('*/45 * * * * *')).to eq('Every 45 seconds')
+    end
+
+    it 'minute span' do
+      expect(desc('0-10 11 * * *')).to eq('Every minute between 11:00 AM and 11:10 AM')
+    end
+
+    context 'every minute' do
+      it 'every minute' do
+        expect(desc('* * * * *')).to eq('Every minute')
+      end
+
+      it 'every minute */1' do
+        expect(desc('*/1 * * * *')).to eq('Every minute')
+      end
+
+      it 'every minute 0 0/1' do
+        expect(desc('0 0/1 * * * ?')).to eq('Every minute')
+      end
+    end
+
+    context 'every X minutes:' do
+      it 'every 5 minutes' do
+        expect(desc('*/5 * * * *')).to eq('Every 5 minutes')
+      end
+
+      it 'every 5 minute 0 */5' do
+        expect(desc('0 */5 * * * *')).to eq('Every 5 minutes')
+      end
+
+      it 'every 10 minutes 0 0/10' do
+        expect(desc('0 0/10 * * * ?')).to eq('Every 10 minutes')
+      end
+    end
+
+    context 'every hour:' do
+      it 'every hour 0 0' do
+        expect(desc('0 0 * * * ?')).to eq('Every hour')
+      end
+
+      it 'every hour 0 0 0/1' do
+        expect(desc('0 0 0/1 * * ?')).to eq('Every hour')
+      end
+    end
+
+    it 'daily at time' do
+      expect(desc('30 11 * * *')).to eq('At 11:30 AM')
+    end
+
+    context 'time of day certain days of week:' do
+      it 'time of day on MON-FRI' do
+        expect(desc('0 23 ? * MON-FRI')).to eq('At 11:00 PM, Monday through Friday')
+      end
+
+      it 'time of day on 1-5' do
+        expect(desc('30 11 * * 1-5')).to eq('At 11:30 AM, Monday through Friday')
+      end
+    end
+
+    it 'one month only' do
+      expect(desc('* * * 3 *')).to eq('Every minute, only in March')
+    end
+
+    it 'two months only' do
+      expect(desc('* * * 3,6 *')).to eq('Every minute, only in March and June')
+    end
+
+    it 'two times each afternoon' do
+      expect(desc('30 14,16 * * *')).to eq('At 2:30 PM and 4:30 PM')
+    end
+
+    it 'three times daily' do
+      expect(desc('30 6,14,16 * * *')).to eq('At 6:30 AM, 2:30 PM and 4:30 PM')
+    end
+
+    context 'once a week:' do
+      it 'once a week 0' do
+        expect(desc('46 9 * * 0')).to eq('At 9:46 AM, only on Sunday')
+      end
+
+      it 'once a week SUN' do
+        expect(desc('46 9 * * SUN')).to eq('At 9:46 AM, only on Sunday')
+      end
+
+      it 'once a week 7' do
+        expect(desc('46 9 * * 7')).to eq('At 9:46 AM, only on Sunday')
+      end
+
+      it 'once a week 1' do
+        expect(desc('46 9 * * 1')).to eq('At 9:46 AM, only on Monday')
+      end
+
+      it 'once a week 6' do
+        expect(desc('46 9 * * 6')).to eq('At 9:46 AM, only on Saturday')
+      end
+    end
+
+    context 'once a week non zero based:' do
+      it 'once a week 1' do
+        expect(desc('46 9 * * 1', opts)).to eq('At 9:46 AM, only on Sunday')
+      end
+
+      it 'once a week SUN' do
+        expect(desc('46 9 * * SUN', opts)).to eq('At 9:46 AM, only on Sunday')
+      end
+
+      it 'once a week 2' do
+        expect(desc('46 9 * * 2', opts)).to eq('At 9:46 AM, only on Monday')
+      end
+
+      it 'once a week 7' do
+        expect(desc('46 9 * * 7', opts)).to eq('At 9:46 AM, only on Saturday')
+      end
+    end
+
+    context 'twice a week:' do
+      it 'twice a week 1,2' do
+        expect(desc('46 9 * * 1,2')).to eq('At 9:46 AM, only on Monday and Tuesday')
+      end
+
+      it 'twice a week MON,TUE' do
+        expect(desc('46 9 * * MON,TUE')).to eq('At 9:46 AM, only on Monday and Tuesday')
+      end
+
+      it 'twice a week 0,6' do
+        expect(desc('46 9 * * 0,6')).to eq('At 9:46 AM, only on Sunday and Saturday')
+      end
+
+      it 'twice a week 6,7' do
+        expect(desc('46 9 * * 6,7')).to eq('At 9:46 AM, only on Saturday and Sunday')
+      end
+    end
+
+    context 'twice a week non zero based:' do
+      it 'twice a week 1,2' do
+        expect(desc('46 9 * * 1,2', opts)).to eq('At 9:46 AM, only on Sunday and Monday')
+      end
+
+      it 'twice a week SUN,MON' do
+        expect(desc('46 9 * * SUN,MON', opts)).to eq('At 9:46 AM, only on Sunday and Monday')
+      end
+
+      it 'twice a week 6,7' do
+        expect(desc('46 9 * * 6,7', opts)).to eq('At 9:46 AM, only on Friday and Saturday')
+      end
+    end
+
+    it 'day of month' do
+      expect(desc('23 12 15 * *')).to eq('At 12:23 PM, on day 15 of the month')
+    end
+
+    it 'day of month ignores day of week' do
+      expect(desc('23 12 15 * SUN')).to eq('At 12:23 PM, on day 15 of the month')
+    end
+
+    it 'month name' do
+      expect(desc('23 12 * JAN *')).to eq('At 12:23 PM, only in January')
+    end
+
+    it 'day of month with question mark' do
+      expect(desc('23 12 ? JAN *')).to eq('At 12:23 PM, only in January')
+    end
+
+    it 'month name range 2' do
+      expect(desc('23 12 * JAN-FEB *')).to eq('At 12:23 PM, January through February')
+    end
+
+    it 'month name range 3' do
+      expect(desc('23 12 * JAN-MAR *')).to eq('At 12:23 PM, January through March')
+    end
+
+    it 'day of week name' do
+      expect(desc('23 12 * * SUN')).to eq('At 12:23 PM, only on Sunday')
+    end
+
+    context 'day of week range:' do
+      it 'day of week range MON-FRI' do
+        expect(desc('*/5 15 * * MON-FRI')).to eq('Every 5 minutes, at 3:00 PM, Monday through Friday')
+      end
+
+      it 'day of week range 0-6' do
+        expect(desc('*/5 15 * * 0-6')).to eq('Every 5 minutes, at 3:00 PM, Sunday through Saturday')
+      end
+
+      it 'day of week range 6-7' do
+        expect(desc('*/5 15 * * 6-7')).to eq('Every 5 minutes, at 3:00 PM, Saturday through Sunday')
+      end
+    end
+
+    context 'day of week once in month:' do
+      it 'day of week once MON#3' do
+        expect(desc('* * * * MON#3')).to eq('Every minute, on the third Monday of the month')
+      end
+
+      it 'day of week once 0#3' do
+        expect(desc('* * * * 0#3')).to eq('Every minute, on the third Sunday of the month')
+      end
+    end
+
+    context 'last day of week of the month:' do
+      it 'last day of week 4L' do
+        expect(desc('* * * * 4L')).to eq('Every minute, on the last Thursday of the month')
+      end
+
+      it 'last day of week 0L' do
+        expect(desc('* * * * 0L')).to eq('Every minute, on the last Sunday of the month')
+      end
+    end
+
+    it 'last day of the month' do
+      expect(desc('*/5 * L JAN *')).to eq('Every 5 minutes, on the last day of the month, only in January')
+    end
+
+    it 'time of day with seconds' do
+      expect(desc('30 02 14 * * *')).to eq('At 2:02:30 PM')
+    end
+
+    it 'second intervals' do
+      expect(desc('5-10 * * * * *')).to eq('Seconds 5 through 10 past the minute')
+    end
+
+    it 'second minutes hours intervals' do
+      expect(desc('5-10 30-35 10-12 * * *')).to eq(
+        'Seconds 5 through 10 past the minute, minutes 30 through 35 past the hour, between 10:00 AM and 12:59 PM')
+    end
+
+    it 'every 5 minutes at 30 seconds' do
+      expect(desc('30 */5 * * * *')).to eq('At 30 seconds past the minute, every 5 minutes')
+    end
+
+    it 'minutes past the hour range' do
+      expect(desc('0 30 10-13 ? * WED,FRI')).to eq(
+        'At 30 minutes past the hour, between 10:00 AM and 1:59 PM, only on Wednesday and Friday')
+    end
+
+    it 'seconds past the minute interval' do
+      expect(desc('10 0/5 * * * ?')).to eq('At 10 seconds past the minute, every 5 minutes')
+    end
+
+    it 'between with interval' do
+      expect(desc('2-59/3 1,9,22 11-26 1-6 ?')).to eq(
+        'Every 3 minutes, minutes 02 through 59 past the hour, at 1:00 AM, 9:00 AM and 10:00 PM, between day 11 and 26 of the month, January through June')
+    end
+
+    it 'recurring first of month' do
+      expect(desc('0 0 6 1/1 * ?')).to eq('At 6:00 AM')
+    end
+
+    it 'minutes past the hour' do
+      expect(desc('0 5 0/1 * * ?')).to eq('At 05 minutes past the hour')
+    end
+
+    it 'every past the hour' do
+      expect(desc('0 0,5,10,15,20,25,30,35,40,45,50,55 * ? * *')).to eq(
+        'At 00, 05, 10, 15, 20, 25, 30, 35, 40, 45, 50 and 55 minutes past the hour')
+    end
+
+    it 'every x minute past the hour with interval' do
+      expect(desc('0 0-30/2 17 ? * MON-FRI')).to eq(
+        'Every 2 minutes, minutes 00 through 30 past the hour, at 5:00 PM, Monday through Friday')
+    end
+
+    it 'one year only with seconds' do
+      expect(desc('* * * * * * 2013')).to eq('Every second, only in 2013')
+    end
+
+    it 'one year only without seconds' do
+      expect(desc('* * * * * 2013')).to eq('Every minute, only in 2013')
+    end
+
+    it 'two years only' do
+      expect(desc('* * * * * 2013,2014')).to eq('Every minute, only in 2013 and 2014')
+    end
+
+    it 'year range 2' do
+      expect(desc('23 12 * JAN-FEB * 2013-2014')).to eq('At 12:23 PM, January through February, 2013 through 2014')
+    end
+
+    it 'year range 3' do
+      expect(desc('23 12 * JAN-MAR * 2013-2015')).to eq('At 12:23 PM, January through March, 2013 through 2015')
+    end
+
+    context 'multi part range seconds:' do
+      it 'multi part range seconds 2,4-5' do
+        expect(desc('2,4-5 1 * * *')).to eq('Minutes 02,04 through 05 past the hour, at 1:00 AM')
+      end
+
+      it 'multi part range seconds 2,26-28' do
+        expect(desc('2,26-28 18 * * *')).to eq('Minutes 02,26 through 28 past the hour, at 6:00 PM')
+      end
+    end
+
+    context 'minutes past the hour:' do
+      it 'minutes past the hour 5,10' do
+        expect(desc('5,10 0 * * *')).to eq('At 05 and 10 minutes past the hour')
+      end
+
+      it 'minutes past the hour 5,10 day 2' do
+        expect(desc('5,10 0 2 * *')).to eq('At 05 and 10 minutes past the hour, on day 2 of the month')
+      end
+
+      it 'minutes past the hour 5/10 day 2' do
+        expect(desc('5/10 0 2 * *')).to eq('Every 10 minutes, starting at 05 minutes past the hour, on day 2 of the month')
+      end
+    end
+
+    context 'seconds past the minute:' do
+      it 'seconds past the minute 5,6' do
+        expect(desc('5,6 0 0 * * *')).to eq('At 5 and 6 seconds past the minute')
+      end
+
+      it 'seconds past the minute 5,6 at 1' do
+        expect(desc('5,6 0 1 * * *')).to eq('At 5 and 6 seconds past the minute, at 1:00 AM')
+      end
+
+      it 'seconds past the minute 5,6 day 2' do
+        expect(desc('5,6 0 0 2 * *')).to eq('At 5 and 6 seconds past the minute, on day 2 of the month')
+      end
+    end
+
+    context 'increments starting at X > 1:' do
+      it 'second increments' do
+        expect(desc('5/15 0 * * * *')).to eq('Every 15 seconds, starting at 5 seconds past the minute')
+      end
+
+      it 'minute increments' do
+        expect(desc('30/10 * * * *')).to eq('Every 10 minutes, starting at 30 minutes past the hour')
+      end
+
+      it 'hour increments' do
+        expect(desc('0 30 2/6 * * ?')).to eq('At 30 minutes past the hour, every 6 hours, starting at 2:00 AM')
+      end
+
+      it 'day of month increments' do
+        expect(desc('0 30 8 2/7 * *')).to eq('At 8:30 AM, every 7 days, starting on day 2 of the month')
+      end
+
+      it 'day of week increments' do
+        expect(desc('0 30 11 * * 2/2')).to eq('At 11:30 AM, every 2 days of the week, starting on Tuesday')
+      end
+
+      it 'month increments' do
+        expect(desc('0 20 10 * 2/3 THU')).to eq('At 10:20 AM, only on Thursday, every 3 months, starting in February')
+      end
+
+      it 'year increments' do
+        expect(desc('0 0 0 1 MAR * 2010/5')).to eq('At 0:00 AM, on day 1 of the month, only in March, every 5 years, starting in 2010')
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'rspec'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  def desc(expression, opts = {})
+    Cronex::ExpressionDescriptor.new(expression, opts).description
+  end
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: cronex
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Adrian Kazaku
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+description: Ruby library that converts cron expressions into human readable strings
+email:
+- alpinweis@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rubocop.yml
+- CHANGELOG.md
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- cronex.gemspec
+- lib/cronex.rb
+- lib/cronex/description.rb
+- lib/cronex/description/base.rb
+- lib/cronex/description/day_of_month.rb
+- lib/cronex/description/day_of_week.rb
+- lib/cronex/description/hours.rb
+- lib/cronex/description/minutes.rb
+- lib/cronex/description/month.rb
+- lib/cronex/description/seconds.rb
+- lib/cronex/description/year.rb
+- lib/cronex/errors.rb
+- lib/cronex/exp_descriptor.rb
+- lib/cronex/parser.rb
+- lib/cronex/resource.rb
+- lib/cronex/utils.rb
+- lib/cronex/version.rb
+- resources/resources_en.yml
+- spec/casing_spec.rb
+- spec/exp_descriptor_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/alpinweis/cronex
+licenses:
+- Apache 2
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Ruby library that converts cron expressions into human readable strings
+test_files:
+- spec/casing_spec.rb
+- spec/exp_descriptor_spec.rb
+- spec/spec_helper.rb