cronex 0.2.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    YzZlZDk0MGYzNDdhZDY2MGVkZGUwMDI3NDhiZjYxNDRhMjhkMjQ0ZA==
+  data.tar.gz: !binary |-
+    YzU5N2E3ZDI5NGQzMGY4NmMyN2Q1OTIwYTQwMWExZjc2YjUyOWE3YQ==
+SHA512:
+  metadata.gz: !binary |-
+    MDhhMzZjMTczNDhkMjYwZjNiYmZlNDMxYTE1YThkZGYzNmNmYTA2MGQwYzQ4
+    YTY2NWRiMTk0NjYzNmQ5MzBhYTVhZTZlZDkxM2Y3MzQ3MjBkNmQxZTYwY2Yx
+    ZDk3NTEzNzgxMjUxZDdmOWRkMjVmYWE3NzM0OGYzOTgzMTQwYjQ=
+  data.tar.gz: !binary |-
+    MjZlNTcwYWJmM2Y0OGI1MzE1NjdiMDQzMzk5NjYxNmFiYzY1YTgxYTk1ZDAw
+    YjdhNDQ0Njc2ODE0NjE4ZmY1OTJhYTgyYWVhYjcyN2JlZjViYTE5ZmY5YWVi
+    OGRlYjJkOWEwNTFlZTU5ZDNmNGNlZTZkMzkyOWE3MDkzYzU2YzY=

data/.gitignore

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

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,47 @@
+Encoding:
+  Enabled: false
+
+AmbiguousOperator:
+  Enabled: false
+
+CaseIndentation:
+  Enabled: false
+
+CyclomaticComplexity:
+  Enabled: false
+  Max: 10
+
+PerceivedComplexity:
+  Enabled: false
+  Max: 10
+
+Documentation:
+  Enabled: false
+
+EmptyLinesAroundBody:
+  Enabled: false
+
+ClassLength:
+  Enabled: false
+
+LineLength:
+  Enabled: true
+  Max: 160
+
+MethodLength:
+  Enabled: false
+
+ModuleFunction:
+  Enabled: false
+
+NestedTernaryOperator:
+  Enabled: false
+
+RaiseArgs:
+  Enabled: false
+
+RescueModifier:
+  Enabled: false
+
+UnusedMethodArgument:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+### [0.2.0] - 2015-10-25
+- Initial public version

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.md

@@ -0,0 +1,13 @@
+Copyright 2015, Opower
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,56 @@
+#Cronex
+
+A Ruby library that converts cron expressions into human readable strings.
+Translated to Ruby from [cron-expression-descriptor](https://github.com/bradyholt/cron-expression-descriptor) (C#) via
+[cron-parser](https://github.com/RedHogs/cron-parser) (Java).
+
+Original Author & Credit: Brady Holt (http://www.geekytidbits.com).
+
+## Features
+
+ * Supports all cron expression special characters including: `*` `/` `,` `-` `?` `L` `W` `#`
+ * Supports 5, 6 (w/ seconds or year), or 7 (w/ seconds and year) part cron expressions
+ * Provides casing options (sentence, title, lower)
+ * Support for non-standard non-zero-based week day numbers
+ * Supports printing to locale specific human readable format
+
+For a quick intro to cron see Quartz [Cron Tutorial](http://www.quartz-scheduler.org/documentation/quartz-1.x/tutorials/crontrigger).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'cronex'
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install cronex
+
+## Usage
+
+#### Zero based day of week
+
+    Cronex::ExpressionDescriptor.new('*/5 15 * * 1-5').description
+    => Every 5 minutes, at 3:00 PM, Monday through Friday
+
+    Cronex::ExpressionDescriptor.new('0 0/30 8-9 5,20 * ?').description
+    => Every 30 minutes, between 8:00 AM and 9:59 AM, on day 5 and 20 of the month
+
+#### Non-zero based day of week
+
+    Cronex::ExpressionDescriptor.new('*/5 15 * * 1-5', zero_based_dow: false).description
+    => Every 5 minutes, at 3:00 PM, Sunday through Thursday
+
+See spec tests for more examples.
+
+### 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,8 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = 'spec/*_spec.rb'
+end
+
+task :default => :spec

data/cronex.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/cronex/version', __FILE__)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'cronex'
+  spec.version       = Cronex::VERSION
+  spec.summary       = 'Ruby library that converts cron expressions into human readable strings'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/alpinweis/cronex'
+
+  spec.authors       = ['Adrian Kazaku']
+  spec.email         = ['alpinweis@gmail.com']
+
+  spec.required_ruby_version = '>= 1.9.3'
+
+  spec.license       = 'Apache 2'
+
+  spec.files         = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
+  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'pry', '~> 0.10'
+  spec.add_development_dependency 'rake', '~> 10.1'
+  spec.add_development_dependency 'rspec', '~> 3.1'
+end

data/lib/cronex.rb

@@ -0,0 +1,10 @@
+require 'date'
+require 'time'
+require 'yaml'
+require_relative 'cronex/version'
+require_relative 'cronex/errors'
+require_relative 'cronex/resource'
+require_relative 'cronex/utils'
+require_relative 'cronex/parser'
+require_relative 'cronex/exp_descriptor'
+require_relative 'cronex/description'

data/lib/cronex/description.rb

@@ -0,0 +1,8 @@
+require_relative 'description/base'
+require_relative 'description/seconds'
+require_relative 'description/minutes'
+require_relative 'description/hours'
+require_relative 'description/day_of_week'
+require_relative 'description/day_of_month'
+require_relative 'description/month'
+require_relative 'description/year'

data/lib/cronex/description/base.rb

@@ -0,0 +1,59 @@
+module Cronex
+  class Description
+
+    attr_accessor :resources, :options
+
+    def initialize(resources, options = {})
+      @resources = resources
+      @options = options || {}
+    end
+
+    def special_chars
+      ['/', '-', ',']
+    end
+
+    def segment_description(expression, all_description)
+      if expression.empty? || expression == '0'
+        desc = ''
+      elsif expression == '*'
+        desc = all_description
+      elsif !Cronex::Utils.include_any?(expression, special_chars)
+        desc = format(description_format(expression), single_item_description(expression))
+      elsif expression.include?('/')
+        segments = expression.split('/')
+        desc = format(interval_description_format(segments[1]), single_item_description(segments[1]))
+        # interval contains 'between' piece (e.g. 2-59/3)
+        if segments[0].include?('-')
+          between_segment_of_interval = segments[0]
+          between_segments = between_segment_of_interval.split('-')
+          desc += ', ' + format(
+            between_description_format(between_segment_of_interval),
+            single_item_description(between_segments[0]),
+            single_item_description(between_segments[1]).gsub(':00', ':59'))
+        elsif !Cronex::Utils.include_any?(segments[0], special_chars + ['*'])
+          desc += ', ' + format(starting_description_format(segments[0]), single_item_description(segments[0]))
+        end
+      elsif expression.include?('-')
+        segments = expression.split('-')
+        desc = format(
+          between_description_format(expression),
+          single_item_description(segments[0]),
+          single_item_description(segments[1]).gsub(':00', ':59'))
+      elsif expression.include?(',')
+        segments = expression.split(',')
+        segments = segments.map { |s| single_item_description(s) }
+        desc_content = segments[0...-1].join(', ') + ' ' + resources.get('and') + ' ' + segments.last
+        desc = format(description_format(expression), desc_content)
+      end
+
+      desc
+    end
+
+    def plural(expression, singular, plural)
+      number = Cronex::Utils.number?(expression)
+      return plural if number && number > 1
+      return plural if expression.include?(',')
+      singular
+    end
+  end
+end

data/lib/cronex/description/day_of_month.rb

@@ -0,0 +1,23 @@
+module Cronex
+  class DayOfMonthDescription < Description
+    def single_item_description(expression)
+      expression
+    end
+
+    def interval_description_format(expression)
+      ', ' + resources.get('every_x') + ' ' + plural(expression, resources.get('day'), resources.get('days'))
+    end
+
+    def between_description_format(expression)
+      ', ' + resources.get('between_days_of_the_month')
+    end
+
+    def description_format(expression)
+      ', ' + resources.get('on_day_of_the_month')
+    end
+
+    def starting_description_format(expression)
+      resources.get('starting') + ' ' + resources.get('on_day_of_the_month')
+    end
+  end
+end

data/lib/cronex/description/day_of_week.rb

@@ -0,0 +1,52 @@
+module Cronex
+  class DayOfWeekDescription < Description
+    def single_item_description(expression)
+      exp = expression
+      if expression.include?('#')
+        exp = expression.partition('#').first
+      elsif expression.include?('L')
+        exp = exp.gsub('L', '')
+      end
+
+      if Cronex::Utils.number?(exp)
+        dow_num = Integer(exp)
+        zero_based_dow = options[:zero_based_dow]
+        invalid_dow = !zero_based_dow && dow_num <= 1
+        if invalid_dow || (zero_based_dow && dow_num == 0)
+          return Cronex::Utils.day_of_week_name(0) # or 7 as in java DateTime().withDayOfWeek(7) for Sunday
+        elsif !zero_based_dow
+          dow_num -= 1
+        end
+        return Cronex::Utils.day_of_week_name(dow_num)
+      else
+        return Date.parse(exp.capitalize).strftime('%A')
+      end
+    end
+
+    def interval_description_format(expression)
+      format(', ' + resources.get('interval_description_format'), expression)
+    end
+
+    def between_description_format(expression)
+      ', ' + resources.get('between_weekday_description_format')
+    end
+
+    def description_format(expression)
+      if expression.include?('#')
+        dow_num = expression.split('#').last
+        days = Hash[%w(1 2 3 4 5).zip(%w(first second third forth fifth))]
+        dow_desc = days[dow_num]
+        dow_desc = dow_desc ? resources.get(dow_desc) : ''
+        ', ' + resources.get('on_the_day_of_the_month').gsub(/{{.*}}/, dow_desc)
+      elsif expression.include?('L')
+        ', ' + resources.get('on_the_last_of_the_month')
+      else
+        ', ' + resources.get('only_on')
+      end
+    end
+
+    def starting_description_format(expression)
+      resources.get('starting') + ' ' + resources.get('on_x')
+    end
+  end
+end

data/lib/cronex/description/hours.rb

@@ -0,0 +1,23 @@
+module Cronex
+  class HoursDescription < Description
+    def single_item_description(expression)
+      Cronex::Utils.format_time(expression, '0')
+    end
+
+    def interval_description_format(expression)
+      format(resources.get('every_x') + ' ' + plural(expression, resources.get('hour'), resources.get('hours')), expression)
+    end
+
+    def between_description_format(expression)
+      resources.get('between_x_and_y')
+    end
+
+    def description_format(expression)
+      resources.get('at_x')
+    end
+
+    def starting_description_format(expression)
+      resources.get('starting') + ' ' + description_format(expression)
+    end
+  end
+end

data/lib/cronex/description/minutes.rb

@@ -0,0 +1,27 @@
+module Cronex
+  class MinutesDescription < Description
+    def single_item_description(expression)
+      Cronex::Utils.format_minutes(expression)
+    end
+
+    def interval_description_format(expression)
+      format(resources.get('every_x') + ' ' + min_plural(expression), expression)
+    end
+
+    def between_description_format(expression)
+      resources.get('minutes_through_past_the_hour')
+    end
+
+    def description_format(expression)
+      expression == '0' ? '' : [resources.get('at_x'), min_plural(expression), resources.get('past_the_hour')].join(' ')
+    end
+
+    def starting_description_format(expression)
+      resources.get('starting') + ' ' + description_format(expression)
+    end
+
+    def min_plural(expression)
+      plural(expression, resources.get('minute'), resources.get('minutes'))
+    end
+  end
+end

data/lib/cronex/description/month.rb

@@ -0,0 +1,23 @@
+module Cronex
+  class MonthDescription < Description
+    def single_item_description(expression)
+      DateTime.new(Time.now.year, Integer(expression), 1).strftime('%B')
+    end
+
+    def interval_description_format(expression)
+      format(', ' + resources.get('every_x') + ' ' + plural(expression, resources.get('month'), resources.get('months')), expression)
+    end
+
+    def between_description_format(expression)
+      ', ' + resources.get('between_description_format')
+    end
+
+    def description_format(expression)
+      ', ' + resources.get('only_in')
+    end
+
+    def starting_description_format(expression)
+      resources.get('starting') + ' ' + resources.get('in_x')
+    end
+  end
+end