cloudwatch_chrono 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c8a24dc71df54c6c133cf55c03373ce27d52bf2cd8e33d787e3d521b684eebf9
+  data.tar.gz: d91fcb71572877e9d468752caf8626dc9d96360fa8be389e486c69f17d3ea58d
+SHA512:
+  metadata.gz: cc34848789572696d2467a4364568f3bf31d41f2a9ca750ffd3d4a3e27ec1ed40f39202579fd0a845a8223278a8bedd40e7bc1902f3c620c5ee7826da5b73ac7
+  data.tar.gz: 912ffe56fb3496accc291278d704a572fd4cf09d10a969616c8f34ffcb4d1b5586e05effdb3c21c7d5a9343bec5388bbc96929383449db667387e4dc24457468

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in cloudwatch_chrono.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,57 @@
+PATH
+  remote: .
+  specs:
+    cloudwatch_chrono (0.1.0)
+      chrono
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.2.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2)
+    chrono (0.4.0)
+      activesupport
+    coderay (1.1.2)
+    concurrent-ruby (1.1.6)
+    diff-lcs (1.3)
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    method_source (1.0.0)
+    minitest (5.14.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    zeitwerk (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  cloudwatch_chrono!
+  pry
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/README.md

@@ -0,0 +1,17 @@
+# CloudwatchChrono
+
+Wrapper of [chrono](https://github.com/r7kamura/chrono) for [Amazon CloudWatch Events Cron Expressions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions).
+
+## Iterator
+Parses cron syntax and determines next scheduled run.
+
+```ruby
+Time.now #=> 2020-05-01 19:57:52.020655 +0900
+iterator = CloudwatchChrono::Iterator.new("0 18 ? * MON-FRI *")
+iterator.next #=> 2020-05-04 18:00:00 +0900
+iterator.next #=> 2020-05-05 18:00:00 +0900
+iterator.next #=> 2020-05-06 18:00:00 +0900
+```
+
+## Syntax
+See https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cloudwatch_chrono"
+
+# 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(__FILE__)

data/bin/setup

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

data/cloudwatch_chrono.gemspec

@@ -0,0 +1,29 @@
+require_relative 'lib/cloudwatch_chrono/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cloudwatch_chrono"
+  spec.version       = CloudwatchChrono::VERSION
+  spec.authors       = ["Takuya Kosugiyama"]
+  spec.email         = ["re@itkq.jp"]
+
+  spec.summary       = %q{Chronology for CloudWatch cron expression.}
+  spec.description   = %q{Chronology for CloudWatch cron expression.}
+  spec.homepage      = "https://github.com/itkq/cloudwatch_chrono"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/itkq/cloudwatch_chrono"
+  spec.metadata["changelog_uri"] = "https://github.com/itkq/cloudwatch_chrono/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "chrono"
+  spec.add_development_dependency "pry"
+end

data/lib/cloudwatch_chrono.rb

@@ -0,0 +1,5 @@
+require "cloudwatch_chrono/fields"
+require "cloudwatch_chrono/iterator"
+require "cloudwatch_chrono/next_time"
+require "cloudwatch_chrono/schedule"
+require "cloudwatch_chrono/version"

data/lib/cloudwatch_chrono/fields.rb

@@ -0,0 +1,7 @@
+require "chrono/fields/base"
+require "chrono/fields/day"
+require "chrono/fields/hour"
+require "chrono/fields/minute"
+require "chrono/fields/month"
+require "cloudwatch_chrono/fields/wday"
+require "cloudwatch_chrono/fields/year"

data/lib/cloudwatch_chrono/fields/wday.rb

@@ -0,0 +1,28 @@
+require "chrono/fields/wday"
+
+module CloudwatchChrono
+  module Fields
+    class Wday < Chrono::Fields::Wday
+      CLOUDWATCH_REGEXP = %r<\A(?:(?<step>(?:\*|\?|(?:(?<atom>\d+|sun|mon|tue|wed|thu|fri|sat)(?:-\g<atom>)?))(?:/\d+)?)(?:,\g<step>)*)\z>ix.freeze
+
+      def initialize(source)
+        if source == 'L'
+          @last_wday = true
+        else
+          unless CLOUDWATCH_REGEXP =~ source
+            raise InvalidField.new('Unparsable field', source)
+          end
+        end
+        @source = source
+      end
+
+      def interpolated
+        if @last_wday
+          '6-6'
+        else
+          super.gsub("?", "#{range.first}-#{range.last}")
+        end
+      end
+    end
+  end
+end

data/lib/cloudwatch_chrono/fields/year.rb

@@ -0,0 +1,11 @@
+module CloudwatchChrono
+  module Fields
+    class Year < Chrono::Fields::Base
+      private
+
+      def range
+        1970..2199
+      end
+    end
+  end
+end

data/lib/cloudwatch_chrono/iterator.rb

@@ -0,0 +1,9 @@
+require "chrono/iterator"
+
+module CloudwatchChrono
+  class Iterator < Chrono::Iterator
+    def next
+      self.now = NextTime.new(now: now, source: source).to_time
+    end
+  end
+end

data/lib/cloudwatch_chrono/next_time.rb

@@ -0,0 +1,90 @@
+require "chrono/next_time"
+
+module CloudwatchChrono
+  class NextTime < Chrono::NextTime
+    def to_time
+      # the longest cycle is 4 years (leap year)
+      # Note that the combination of day-month and wday is OR
+      max_time = time + (365 * 3 + 366).days
+      while @time < max_time
+        case
+        when !scheduled_in_this_year?
+          carry_year
+        when !scheduled_in_this_month?
+          carry_month
+        when !scheduled_in_this_day?
+          carry_day
+        when !scheduled_in_this_hour?
+          carry_hour
+        when !scheduled_in_this_minute?
+          carry_minute
+        else
+          return @time
+        end
+      end
+      raise ArgumentError, "invalid cron string '#{@source}'"
+    end
+
+    private
+
+    def scheduled_in_this_day?
+      if schedule.last_day?
+        return time.day == time.end_of_month.day
+      elsif schedule.latest_weekday
+        return time.day == calc_latest_weekday
+      elsif schedule.ordered_weekday
+        return time.day == calc_ordered_weekday
+      end
+
+      super
+    end
+
+    def calc_latest_weekday
+      target = time.change(day: schedule.latest_weekday)
+      case target.wday
+      when 0 # SUN
+        target.day + 1
+      when 6 # SAT
+        target.day - 1
+      else
+        target.day
+      end
+    end
+
+    def calc_ordered_weekday
+      wday, order = schedule.ordered_weekday
+
+      month = time.month
+      curr = time.beginning_of_month
+      while curr.wday != wday
+        curr = curr.advance(days: 1)
+      end
+
+      if curr.month != month
+        curr = curr.advance(weeks: 1)
+      end
+
+      (order - 1).times do
+        curr = curr.advance(weeks: 1)
+      end
+
+      if curr.month != month
+        raise ArgumentError, "invalid cron string '#{@source}'"
+      end
+
+      curr.day
+    end
+
+    def schedule
+      @schedule ||= Schedule.new(source)
+    end
+
+    def scheduled_in_this_year?
+      schedule.years.include?(time.year)
+    end
+
+    def carry_year
+      self.time = time.next_year.beginning_of_year
+    end
+  end
+end

data/lib/cloudwatch_chrono/schedule.rb

@@ -0,0 +1,44 @@
+require "chrono/schedule"
+
+module CloudwatchChrono
+  class Schedule < Chrono::Schedule
+    def initialize(source)
+      if %r<\A[ \t]*(?:(?<field>\S+)[ \t]+){5}\g<field>[ \t]*\z> !~ source
+        raise Chrono::Fields::Base::InvalidField.new('invalid source', source)
+      end
+      @source = source
+    end
+
+    def wdays
+      Fields::Wday.new(fields[4]).to_a
+    end
+
+    def years
+      Fields::Year.new(fields[5]).to_a
+    end
+
+    def days?
+      !%w[* ?].include?(fields[2])
+    end
+
+    def wdays?
+      !%w[* ?].include?(fields[4])
+    end
+
+    def last_day?
+      fields[2] == 'L'
+    end
+
+    def latest_weekday
+      fields[2].slice(/\A(\d+)W\z/, 1)
+    end
+
+    # e.g. 3#2 means the second Tuesday and returns [3, 2]
+    def ordered_weekday
+      m = fields[2].match(/\A([0-6])#([1-5])\z/)
+      if m
+        m[1, 2].map(&:to_i)
+      end
+    end
+  end
+end

data/lib/cloudwatch_chrono/version.rb

@@ -0,0 +1,3 @@
+module CloudwatchChrono
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: cloudwatch_chrono
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Takuya Kosugiyama
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: chrono
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Chronology for CloudWatch cron expression.
+email:
+- re@itkq.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cloudwatch_chrono.gemspec
+- lib/cloudwatch_chrono.rb
+- lib/cloudwatch_chrono/fields.rb
+- lib/cloudwatch_chrono/fields/wday.rb
+- lib/cloudwatch_chrono/fields/year.rb
+- lib/cloudwatch_chrono/iterator.rb
+- lib/cloudwatch_chrono/next_time.rb
+- lib/cloudwatch_chrono/schedule.rb
+- lib/cloudwatch_chrono/version.rb
+homepage: https://github.com/itkq/cloudwatch_chrono
+licenses: []
+metadata:
+  homepage_uri: https://github.com/itkq/cloudwatch_chrono
+  source_code_uri: https://github.com/itkq/cloudwatch_chrono
+  changelog_uri: https://github.com/itkq/cloudwatch_chrono/blob/master/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Chronology for CloudWatch cron expression.
+test_files: []