cronline 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a31ad50c7f38818689b8cc1408e9a37f763a1def
+  data.tar.gz: 19173412d249957bc9f7abbd46cde64832237e48
+SHA512:
+  metadata.gz: a543d9a8a331c25ed01d340f0957590defa6cba13812a78d3732da05e0ce79fcc3acdc2f4f2581de2e03e27290d0b0dcaa9a564ab58172fe67374dda44fa6fa4
+  data.tar.gz: 03e18289c3d98ba4ca18d6a3bb9554dff21eda4c20d945898d4c207814632bb7c47840719d74c71d3a36804398248f43a893ce275746031bbbc87c8188d3ea55

data/.gitignore

@@ -0,0 +1,38 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+.idea
+

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 anton-vattay
+
+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,45 @@
+# CronLine
+
+Code goes in `lib/cronline`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+Converts a cron expression into a series of instants in time. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cronline'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cronline
+
+## Usage
+
+Create a simulator. You don't have to provide any parameters but you can optionally override them using the builder. Default timezone is the local time for the system.
+
+    sim = Cronline::Simulator.builder
+      .set_duration(2.weeks)
+      .set_timezone('Eastern Time (US & Canada)')
+      .build
+    times = sim.simulate_cron('0 30 7 ? * MON,WED *')
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/cronline/fork )
+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 a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require 'active_support/all'
+require "cronline"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/cronline.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cronline/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cronline"
+  spec.version       = Cronline::VERSION
+  spec.authors       = ["anton-vattay"]
+  spec.email         = ["anton.vattay@opower.com"]
+
+  spec.summary       = %q{Converts a cron expression to a sequence of instants in time}
+  spec.description   = %q{Simulates a cron expression over a range of time and produces the times which the cron is e
+                          expected to fire.}
+  spec.homepage      = "http://opower.com"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "http://gemserver.va.opower.it/"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'bundler', '~> 1.9'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_runtime_dependency 'activesupport', '~> 4.2'
+end

data/lib/cronline.rb

@@ -0,0 +1,17 @@
+require "cronline/version"
+require "time"
+require "cronline/simulator"
+require "cronline/cron"
+require "cronline/cron_field"
+require "cronline/cron_seconds"
+require "cronline/cron_minutes"
+require "cronline/cron_hours"
+require "cronline/cron_days_of_month"
+require "cronline/cron_days_of_week"
+require "cronline/cron_months"
+require "cronline/cron_years"
+require "active_support/all"
+
+module Cronline
+
+end

data/lib/cronline/cron.rb

@@ -0,0 +1,44 @@
+module Cronline
+  class Cron
+    attr_reader :seconds, :minutes, :hours, :days, :months, :years
+
+    @seconds
+    @minutes
+    @hours
+    @days
+    @months
+    @years
+
+    def initialize(cron_expression)
+      @seconds = CronSeconds.new(cron_expression)
+      @minutes = CronMinutes.new(cron_expression)
+      @hours = CronHours.new(cron_expression)
+
+      @months = CronMonths.new(cron_expression)
+      @years = CronYears.new(cron_expression)
+
+      cron_days_of_month = CronDaysOfMonth.new(cron_expression)
+      cron_days_of_week = CronDaysOfWeek.new(cron_expression)
+      if (cron_days_of_month).active? && (cron_days_of_week).active?
+        fail 'Only one days field is allowed'
+      elsif cron_days_of_week.active?
+        @days = cron_days_of_week
+      elsif cron_days_of_month.active?
+        @days = cron_days_of_month
+      else
+        fail 'One day field is required'
+      end
+    end
+
+    def test?(time)
+      @years.test?(time) && @months.test?(time) && @days.test?(time) &&
+          @hours.test?(time) && @minutes.test?(time) && @seconds.test?(time)
+    end
+
+    def test_up_to_hours?(time)
+      @years.test?(time) && @months.test?(time) && @days.test?(time) &&
+          @hours.test?(time)
+    end
+
+  end
+end

data/lib/cronline/cron_days_of_month.rb

@@ -0,0 +1,38 @@
+module Cronline
+  class CronDaysOfMonth < CronField
+    @last_day_of_month = false
+
+    def initialize(cron_expression)
+      @field_expression = cron_expression.split(' ')[3]
+      if @field_expression == 'L'
+        @last_day_of_month = true
+        @field_expression.sub!('L', '')
+      else
+        super(@field_expression, 0, 31)
+      end
+    end
+
+    def active?
+      @field_expression != '?'
+    end
+
+    def time_field(time)
+      time.day
+    end
+
+    def range(time)
+      if @last_day_of_month
+        puts @last_day_of_month
+        [last_day_of_month(time)]
+      else
+        super(time)
+      end
+    end
+
+    private
+
+    def last_day_of_month(time)
+        Date.new(time.year, time.month, -1).day
+    end
+  end
+end

data/lib/cronline/cron_days_of_week.rb

@@ -0,0 +1,56 @@
+module Cronline
+  class CronDaysOfWeek < CronField
+    @field_expression
+    @last_weekday_of_month = false
+
+    def initialize(cron_expression)
+      @field_expression = cron_expression.split(' ')[5]
+      Date::ABBR_DAYNAMES.each do |abbreviation|
+        unless abbreviation.nil?
+          @field_expression.gsub!(/(#{abbreviation})/i, Date::ABBR_DAYNAMES.index(abbreviation).to_s)
+        end
+      end
+      if @field_expression[-1,1] == 'L'
+        @last_weekday_of_month = true
+        @field_expression.sub!('L', '')
+      end
+      super(@field_expression, 1, 7)
+    end
+
+    def active?
+      @field_expression != '?'
+    end
+
+    def range(time)
+      if @last_weekday_of_month
+        [last_weekday_day_of_month(super(time)[0], time)]
+      else
+        super(time)
+      end
+    end
+
+    def test?(time)
+      if @last_weekday_of_month
+        test_last_weekday?(@range[0], time)
+      else
+        @range.include?(time.wday)
+      end
+    end
+
+    # Thank you Mohit Sindhwani https://www.ruby-forum.com/topic/125970
+    def last_weekday_day_of_month(weekday_number, time)
+      last_day_of_month = Date.new(time.year, time.month, -1)
+      last_day_wday = ((last_day_of_month.wday + 1) - weekday_number).abs
+      last_day = Date.new(time.year, time.month, (last_day_of_month.day - last_day_wday))
+      last_day.day
+    end
+
+    # Thank you Mohit Sindhwani https://www.ruby-forum.com/topic/125970
+    def test_last_weekday?(weekday_number, time)
+      last_day_of_month = Date.new(time.year, time.month, -1)
+      last_day_wday = ((last_day_of_month.wday + 1) - weekday_number).abs
+      last_day = Date.new(time.year, time.month, (last_day_of_month.day - last_day_wday))
+      last_day.year == time.year && last_day.month == time.month && last_day.day == time.day
+    end
+  end
+end

data/lib/cronline/cron_field.rb

@@ -0,0 +1,58 @@
+module Cronline
+  class CronField
+
+    @range
+    @wild = false
+
+    def self.wildcard
+      '*'
+    end
+
+    def initialize(field_expression, absolute_min, absolute_max)
+      @absolute_min = absolute_min
+      @absolute_max = absolute_max
+      if field_expression == CronField.wildcard
+        #Wild
+        @wild = true
+        @range = Integer(absolute_min)..Integer(absolute_max)
+      elsif field_expression.include?('-')
+        #Range
+        min = Integer(field_expression.split('-')[0])
+        max = Integer(field_expression.split('-')[1])
+        @range = min..max
+      elsif field_expression.include?(',')
+        #Value list
+        @range = field_expression.split(',').map do |number_expression|
+          Integer(number_expression)
+        end
+      elsif field_expression.include?('/')
+        #Increment
+        increment_start = field_expression.split('/')[0]
+        increment_step = field_expression.split('/')[1]
+        @range = (Integer(increment_start)..absolute_max).step(Integer(increment_step))
+      elsif field_expression == '?'
+        #Disabled
+        @range = []
+      elsif field_expression[-1, 1] == 'L'
+        #Last
+        @range = [Integer(field_expression.sub!('L', ''))]
+      else
+        #Single
+        @range = [Integer(field_expression)]
+      end
+    end
+
+    def range(time = nil)
+      @range
+    end
+
+    def test?(time)
+      range(time).include?(time_field(time))
+    end
+
+    def time_field(time)
+      fail 'time_field must be implemented'
+    end
+
+  end
+end

data/lib/cronline/cron_hours.rb

@@ -0,0 +1,12 @@
+module Cronline
+  class CronHours < CronField
+    def initialize(cron_expression)
+      expression = cron_expression.split(' ')[2]
+      super(expression, 0, 23)
+    end
+
+    def time_field(time)
+      time.hour
+    end
+  end
+end

data/lib/cronline/cron_minutes.rb

@@ -0,0 +1,14 @@
+module Cronline
+  class CronMinutes < CronField
+    def initialize(cron_expression)
+      expression = cron_expression.split(' ')[1]
+      super(expression, 0, 59)
+    end
+
+    def time_field(time)
+      time.min
+    end
+  end
+
+
+end

data/lib/cronline/cron_months.rb

@@ -0,0 +1,19 @@
+module Cronline
+  class CronMonths < CronField
+    def initialize(cron_expression)
+      expression = cron_expression.split(' ')[4]
+      Date::ABBR_MONTHNAMES.each do |abbreviation|
+        unless abbreviation.nil?
+          expression.gsub!(/(#{abbreviation})/i, Date::ABBR_MONTHNAMES.index(abbreviation).to_s)
+        end
+      end
+      super(expression, 1, 12)
+    end
+
+    def time_field(time)
+      time.month
+    end
+  end
+
+
+end

data/lib/cronline/cron_seconds.rb

@@ -0,0 +1,12 @@
+module Cronline
+  class CronSeconds < CronField
+    def initialize(cron_expression)
+      expression = cron_expression.split(' ')[0]
+      super(expression, 0 ,59)
+    end
+
+    def time_field(time)
+      time.sec
+    end
+  end
+end

data/lib/cronline/cron_years.rb

@@ -0,0 +1,25 @@
+module Cronline
+  class CronYears < CronField
+
+    def self.absolute_min_year
+      1970
+    end
+
+    def self.absolute_max_year
+      2099
+    end
+
+    def initialize(cron_expression)
+      expression = cron_expression.split(' ')[6]
+      if expression.nil?
+        super(CronField.wildcard, CronYears.absolute_min_year , CronYears.absolute_max_year)
+      else
+        super(expression, CronYears.absolute_min_year , CronYears.absolute_max_year)
+      end
+    end
+
+    def time_field(time)
+      time.year
+    end
+  end
+end

data/lib/cronline/simulator.rb

@@ -0,0 +1,138 @@
+module Cronline
+  class Simulator
+
+    def self.default_max_ticks
+      1e+5
+    end
+
+    def self.default_max_time_output
+      365
+    end
+
+    def self.default_timeframe_seconds
+      12.month.to_i
+    end
+
+    class Builder
+      def initialize
+        @start_time = Time.new
+        @end_time = @start_time + Simulator.default_timeframe_seconds
+        @max_ticks = Simulator.default_max_ticks
+        @max_time_output = Simulator.default_max_time_output
+      end
+
+      def set_timezone(timezone_string)
+        @timezone = timezone_string
+        self
+      end
+
+      def set_start_time(start_time)
+        @start_time = start_time
+        self
+      end
+
+      def set_end_time(end_time)
+        @end_time = end_time
+        self
+      end
+
+      def set_duration(duration)
+        @end_time = @start_time + duration
+        self
+      end
+
+      def set_max_ticks(max_ticks)
+        @max_ticks = max_ticks
+        self
+      end
+
+      def set_max_time_output(max_time_output)
+        @max_time_output = max_time_output
+        self
+      end
+
+      def build
+        @start_time = @start_time || Time.new
+        Simulator.new(
+            @timezone || nil,
+            @start_time,
+            @end_time,
+            @max_ticks,
+            @max_time_output)
+      end
+    end
+
+    def self.builder
+      Builder.new
+    end
+
+    def initialize(
+        timezone = nil,
+        start_time = Time.new,
+        end_time = start_time + Simulator.default_timeframe_seconds,
+        max_ticks = Simulator.default_max_ticks,
+        max_time_output = Simulator.default_max_time_output)
+      @start_time = start_time
+      @end_time = end_time
+      @max_ticks = max_ticks
+      @max_time_output = max_time_output
+      @timezone = timezone
+    end
+
+    def simulate_cron(cron_expression, timezone = nil)
+      merged_timezone = timezone.nil? ? @timezone : timezone
+      @time_accumulator = []
+      cron = Cron.new(cron_expression)
+      time_increment = time_increment_size
+      @start_unix_time = aligned_start_time(@start_time)
+      @end_unix_time = @end_time.to_time.to_i
+      @tick = 0
+      while @start_unix_time <= @end_unix_time do
+        if stop_simulation
+          break
+        end
+        if merged_timezone.nil?
+          time = Time.at(@start_unix_time)
+        else
+          time = Time.at(@start_unix_time).in_time_zone(merged_timezone)
+        end
+        if cron.test_up_to_hours?(time)
+          @time_accumulator += generate_hours_and_seconds(cron, time)
+        end
+        @start_unix_time += time_increment
+      end
+      @time_accumulator
+    end
+
+    def generate_hours_and_seconds(cron, time)
+      accumulator = []
+      cron.minutes.range.each do |minute|
+        cron.seconds.range.each do |second|
+          @tick += 1
+          accumulator.push(Time.new(time.year, time.month, time.day, time.hour, minute, second))
+        end
+      end
+      accumulator
+    end
+
+    def stop_simulation
+      if @tick >= @max_ticks
+        return true
+      end
+      if @time_accumulator.size >= @max_time_output
+        return true
+      end
+    end
+
+    def aligned_start_time(start_time)
+      #Align to day since minutes / seconds are relatively deterministic across timezones and DST...
+      Time.new(start_time.year, start_time.month, start_time.day, start_time.hour).to_i
+    end
+
+    def time_increment_size
+      #Skip seconds and minutes since we will generate these
+      1.hours.to_i
+    end
+
+  end
+end

data/lib/cronline/version.rb

@@ -0,0 +1,3 @@
+module Cronline
+  VERSION = "0.2.0"
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: cronline
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- anton-vattay
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+description: |-
+  Simulates a cron expression over a range of time and produces the times which the cron is e
+                            expected to fire.
+email:
+- anton.vattay@opower.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cronline.gemspec
+- lib/cronline.rb
+- lib/cronline/cron.rb
+- lib/cronline/cron_days_of_month.rb
+- lib/cronline/cron_days_of_week.rb
+- lib/cronline/cron_field.rb
+- lib/cronline/cron_hours.rb
+- lib/cronline/cron_minutes.rb
+- lib/cronline/cron_months.rb
+- lib/cronline/cron_seconds.rb
+- lib/cronline/cron_years.rb
+- lib/cronline/simulator.rb
+- lib/cronline/version.rb
+homepage: http://opower.com
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Converts a cron expression to a sequence of instants in time
+test_files: []