eternal 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a8a2cd0f6db16d5069aebdc6389b42a17fb14392e9e4d7d2943b04894f6ce48c
+  data.tar.gz: faf42fe5c77f76263af0042120f7688b7c42a76baabf33326c09e36af065b6e5
+SHA512:
+  metadata.gz: 54e9347e2d34d1ab8ce3a3d5020bf9de4f436196f6ef237eb99684dd6f70521601d5fafcbe6fd4e75d77689318160ae14464a878fc784ddb15e25fb9a196793f
+  data.tar.gz: 5b1e4449cf31d12f1bcb63c1740f58ab441a008f035cb5062a5b6fc52ffde5196315351cb750416d8ebdd035a8c85344b79e27e28c874a90000283aed96e1286

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,52 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+.swp
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.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
+

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.2.0
+  - 2.4.0
+  - ruby-head

data/Gemfile

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+gem 'chronic_duration', :git => 'https://github.com/kritr/chronic_duration.git'
+gem 'chronic', :git => 'https://github.com/davispuh/chronic.git', :branch => 'rewrite'
+gem 'numerizer', :git => 'https://github.com/kritr/numerizer.git', :branch => 'ambiguous-cases'
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Krithik Rao
+
+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,14 @@
+# [eternal](https://github.com/kritr/eternal)
+
+[![Build Status](https://travis-ci.org/KritR/eternal.svg?branch=master)](https://travis-ci.org/KritR/eternal)
+[![Coverage Status](https://coveralls.io/repos/github/KritR/eternal/badge.svg?branch=master)](https://coveralls.io/github/KritR/eternal?branch=master)
+[![Maintainability](https://api.codeclimate.com/v1/badges/7a13b8b52ff3263a2626/maintainability)](https://codeclimate.com/github/KritR/eternal/maintainability)
+
+A parser for event timings and occurrences
+
+## Usage
+
+````Eternal.parse('I have dance practice every friday at 5 pm')````
+will return an ````ice_cube```` object with the rule to repeat weeekly on fridays at 5pm.
+
+Additional context can then be inputted into this object to complete the rule.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/**/test_*.rb']
+end
+desc "run tests"
+
+task default: :test

data/eternal.gemspec

@@ -0,0 +1,26 @@
+Gem::Specification.new do |s|
+  s.name        = 'eternal'
+  s.version     = '0.0.1'
+  s.date        = '2018-04-04'
+  s.summary     = %{Eternal parses events, dates, and everything involved in 
+  schedules using chronic and chronic duration. These events are returned as 
+  ice_cube objects which can be converted to ical or yaml, or simply used to
+  calculate the next occurrence of the schedule specified.}
+  s.description = "A parser for event timings and schedules"
+  s.authors     = ["Krithik Rao"]
+  s.email       = 'krdevmail@gmail.com'
+  s.files       = `git ls-files`.split($/)
+  s.homepage    = 'https://github.com/KritR/eternal'
+  s.license     = 'MIT'
+
+  s.add_dependency "chronic_duration", "~>0.10", ">= 0.10.8" 
+  s.add_dependency "numerizer", "~>0.2", ">= 0.2.0" 
+  s.add_dependency "chronic", "~>0.10", ">= 0.10.2" 
+  s.add_dependency "ice_cube", "~>0.16", ">= 0.16.2"
+  #s.add_dependency "textoken", "~> 1.1.2"
+
+  s.add_development_dependency "rake", "~>12.3", ">= 12.3.1"
+  s.add_development_dependency "simplecov", "~>0.14", ">= 0.14.1"
+  s.add_development_dependency "coveralls", "~>0.8", ">= 0.8.21"
+  s.add_development_dependency "minitest", "~>5.11", ">= 5.11.3"
+end

data/lib/eternal.rb

@@ -0,0 +1,229 @@
+require 'ice_cube'
+require 'chronic'
+require 'chronic_duration'
+require 'patterns'
+require 'time'
+
+class Eternal
+  def self.parse(str)
+    str = str.dup
+    cleanup!(str)
+    tokens = tokenize(str)
+    #delete_unknown!(tokens)
+    recognize_keywords!(tokens)
+    nested_tokens = nest_keywords(tokens)
+    rrule = Evaluator.new(nested_tokens)
+    rrule.evaluate
+  end
+
+  def self.cleanup!(str)
+    str.gsub!(/\b(?:(last|spann?)(?:ing|s)?(?: for)?|for)(?: a| the)?(?: period| time| duration| span)?(?: of)?\b/i, 'duration')
+    str.gsub!(/\b(start|end)(s|ing)?(\sin|\son)?\b/i, '\1')
+    str.gsub!(/\b(end)(\sat)\b/i, 'endtime')
+    str.gsub!(/\beach\b/i,'every')
+    str.gsub!(/\b(start)(\sat)\b/i, 'at')
+    str.gsub!(/\b(?:every\s)?(#{DAYS_REGEX})\b/i, 'every 1 week on \1')
+    str.gsub!(/\b(?:on\s?)?(#{DAYS_REGEX})s\b/i, 'every 1 week on \1')
+    str.gsub!(/\bevery (#{TIME_UNITS_REGEX})\b/i, 'every 1 \1')
+    str.gsub!(/\bevery other\b/i, 'every 2')
+    str.gsub!(/\b(#{REPEATERS_REGEX})\b/i) { 'every 1 ' + REPEATERS[$1]}
+    str.gsub!(/\b(#{TIME_UNITS_REGEX})(?:s)\b/i, '\1')
+    # I HAVE NO IDEA IF THIS WORKS | DEFINITELY A HACK
+    str.gsub!(/\b(\w*)\sto\b/i) do |match|
+      previous_word = $1
+      if ($1 =~ /#{TIME_UNITS_REGEX}s?/i) == nil
+        match = previous_word + ' ' + 'end' 
+      else
+        match = previous_word + ' ' + 'before'
+      end
+      match
+    end
+    str.gsub!(/\b(\w*)\sfrom\b/i) do |match|
+      previous_word = $1
+      if ($1 =~ /#{TIME_UNITS_REGEX}s?/i) == nil
+        match = previous_word + ' ' + 'start' 
+      else
+        match = previous_word + ' ' + 'after'
+      end
+      match
+    end
+  end
+
+  def self.tokenize(str)
+    str.gsub!(/\s+/m, ' ')
+    str.strip!
+    str.split(" ")
+  end
+
+  def self.delete_unknown!(tokens)
+    tokens.select! {|token| (token =~ REGEX_ALL) != nil}
+  end
+
+  def self.recognize_keywords!(tokens)
+    tokens.map! do |token| 
+      token = token.to_sym if (token =~ KEYWORDS_REGEX) != nil
+      token
+    end
+  end
+
+
+  def self.nest_keywords(tokens)
+    nested = [[]]
+    tokens.each do |token|
+      if (token.is_a? Symbol) 
+        nested << []
+      end
+      nested.last << token
+    end
+    nested
+  end
+  
+end
+
+class Evaluator
+
+  REPEAT_SPANS = {
+    :year => :yearly,
+    :week => :weekly,
+    :day => :daily,
+    :hour => :hourly,
+    :minute => :minutely,
+    :second => :secondly,
+  }
+  EVAL_ORDER = [:duration, :at_time, :every, :at_date, :on, :end_time, :end_date]
+  def initialize(rule_list)
+    @rule_list = rule_list
+    @schedule = IceCube::Schedule.new
+    @rules = []
+    @options = []
+  end
+
+  def evaluate
+    p @rule_list
+    @rule_list.each do |rule|
+      operation = rule.shift
+      p operation
+      case operation
+      when :every
+        amount = rule[0]
+        duration = rule[1]
+        @options << {every: {duration: REPEAT_SPANS[duration.to_sym], amount: amount}}
+      when :at
+        time = Chronic.parse(rule.reduce(:concat))
+        @options << {at_time: time}
+      when :on
+        if rule.all? {|x| (x =~ /#{DAYS_REGEX}|and/i) != nil}
+          rule.select! {|x| (x =~ /#{DAYS_REGEX}/i) != nil}
+          rule.map!(&:to_sym)
+          @options << {on: rule}
+        else 
+          days = Chronic.parse(rule.reduce(:concat))
+          @options << {at_date: days}
+        end
+      when :start
+        time = rule.reduce(:concat)
+        if ChronicDuration.parse(time) < 24 * 60 * 60
+          @options << {at_time: Chronic.parse(time, :guess => :begin)}
+        else
+          @options << {at_date: Chronic.parse(time, :guess => :begin)}
+        end
+      when :endtime
+        time = rule.reduce(:concat)
+        @options << {end_time: time}
+      when :end
+        time = rule.reduce(:concat)
+        @options << {end_date: time}
+      when :duration
+        time = rule.reduce(:concat)
+        @options << {duration: ChronicDuration.parse(time)}
+      #when :until
+      end
+    end
+    p @options
+    option = @options.reduce(:merge)
+    sorted = option.sort_by { |a|EVAL_ORDER.index(a) }
+    sorted.each {|opt| operation = opt[0]; args = opt[1]; self.send(operation, args) }
+    @rules.each {|rule| @schedule.add_recurrence_rule(rule) }
+    @schedule
+  end
+  
+  def every(opts)
+    p opts
+    @rules << IceCube::Rule.send(opts[:duration], opts[:amount])
+  end
+
+  def on(day)
+    if(@rules.last)
+      @rules.last.day(day)
+    else 
+      at_date(Chronic.parse(day.last.to_s))
+    end
+  end
+
+  def at_time(time)
+    new_time = time
+    old_time = @schedule.start_time
+    yr  = new_time.year
+    mon = new_time.mon
+    day = new_time.day
+    hr  = new_time.hour
+    min = new_time.min
+    sec = new_time.sec
+    @schedule.start_time = Time.new(yr, mon, day, hr, min, sec)
+  end
+  def at_date(time)
+    new_time = time
+    old_time = @schedule.start_time
+    yr  = new_time.year
+    mon = new_time.mon
+    day = new_time.day
+    hr  = old_time.hour
+    min = old_time.min
+    sec = old_time.sec
+    @schedule.start_time = Time.new(yr, mon, day, hr, min, sec)
+  end
+
+  # needs to be deferred till existence of rule
+  def until(string)
+    @rules.last.until(Chronic.parse(string, :guess => :begin))
+  end
+
+  def in(span)
+    @rules.last.month_of_year(span) if MONTHS.values.include? span
+  end
+
+  def end_time(string)
+    now = @schedule.start_time || Time.now
+    new_time = Chronic.parse(string, :now => :now, :guess => :begin)
+    old_time = @schedule.start_time
+    yr  = new_time.year
+    mon = new_time.mon
+    day = new_time.day
+    hr  = new_time.hour
+    min = new_time.min
+    sec = new_time.sec
+    @schedule.end_time = Time.new(yr, mon, day, hr, min, sec)
+  end
+
+  def end_date(string)
+    now = @schedule.start_time || Time.now
+    new_time = Chronic.parse(string, :now => :now, :guess => :begin)
+    old_time = @schedule.start_time
+    yr  = new_time.year
+    mon = new_time.mon
+    day = new_time.day
+    hr  = old_time.hour
+    min = old_time.min
+    sec = old_time.sec
+    @schedule.end_time = Time.new(yr, mon, day, hr, min, sec)
+  end
+
+  def duration(time)
+    @schedule.duration = time
+  end
+
+  def except(time)
+    
+  end
+end
+

data/lib/patterns.rb

@@ -0,0 +1,35 @@
+DAYS = ['saturday', 'monday', 'tuesday', 'wednesday', 'thursday', 'friday', 'sunday']
+ABBREVIATED_DAYS = ['sat', 'mon', 'tu(e(s)?)?', 'wed', 'th(u(r(s)?)?)?', 'fri', 'sun']
+ALL_DAYS = DAYS + ABBREVIATED_DAYS
+MONTHS = ['january', 'february', 'march', 'april', 'may', 'june', 'july', 'august', 'september', 'october', 'november', 'december']
+ABBREVIATED_MONTHS = MONTHS.map { |x| x[0..2] }
+TIME_UNITS = ['second', 'hour', 'minute', 'week', 'month', 'year', 'decade', 'century'] 
+ABBREVIATED_TIME_UNITS = ['sec', 'hr', 'min', 'wk', 'mo', 'yr', 'dec', 'cent']
+ALL_TIME_UNITS = TIME_UNITS + ABBREVIATED_TIME_UNITS
+SEASONS = ['summer','spring','autumn|fall', 'winter']
+PREP_PHRASES = ['on','in','at', 'from', 'to', 'duration']
+DETERMINERS = ['each','every']
+REPEATERS = {'minutely' => 'minute', 'hourly' => 'hour' ,'daily' => 'day', 'weekly' => 'week', 'monthly' => 'month', 'yearly' => 'year'}
+KEYWORDS = ['every', 'at', 'on', 'start', 'end', 'duration', 'until', 'endtime'] # 'except', 'and',]
+
+
+# Combines array options into single regex
+def regexify_strings(array)
+  Regexp.union(array)
+end
+
+DAYS_REGEX = regexify_strings(DAYS)
+ABBREVIATED_DAYS_REGEX = regexify_strings(ABBREVIATED_DAYS)
+ALL_DAY_REGEX = regexify_strings(ALL_DAYS)
+MONTHS_REGEX = regexify_strings(MONTHS)
+ABBREVIATED_MONTHS_REGEX = regexify_strings(ABBREVIATED_MONTHS)
+TIME_UNITS_REGEX = regexify_strings(TIME_UNITS)
+ABBREVIATED_TIME_UNITS_REGEX = regexify_strings(ABBREVIATED_TIME_UNITS)
+ALL_TIME_UNITS_REGEX = regexify_strings(ALL_TIME_UNITS)
+ORDINAL_REGEX = /(\d+)(st|nd|rd|th)/i
+SEASONS_REGEX = regexify_strings(SEASONS)
+PREP_PHRASES_REGEX = regexify_strings(PREP_PHRASES)
+DETERMINERS_REGEX = regexify_strings(DETERMINERS)
+REPEATERS_REGEX = regexify_strings(REPEATERS.keys)
+KEYWORDS_REGEX = regexify_strings(KEYWORDS)
+

data/test/test_eternal.rb

@@ -0,0 +1,12 @@
+require 'test_helper'
+require 'ice_cube'
+
+describe 'Eternal' do
+  it 'can parse repeats occuring weekly' do
+    schedule = IceCube::Schedule.new() do |s|
+      s.add_recurrence_rule(IceCube::Rule.weekly.day(:sunday))
+    end
+    eternal_output = Eternal.parse('every sunday') 
+    value(eternal_output).must_equal schedule
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,7 @@
+require 'coveralls'
+Coveralls.wear!
+require 'simplecov'
+SimpleCov.start
+require 'minitest/autorun'
+require 'minitest/spec'
+require 'eternal'

metadata

@@ -0,0 +1,218 @@
+--- !ruby/object:Gem::Specification
+name: eternal
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Krithik Rao
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-04-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: chronic_duration
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.8
+- !ruby/object:Gem::Dependency
+  name: numerizer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: chronic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.10.2
+- !ruby/object:Gem::Dependency
+  name: ice_cube
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.16.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.16.2
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.1
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.14.1
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.21
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.21
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.11.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.11'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.11.3
+description: A parser for event timings and schedules
+email: krdevmail@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- eternal.gemspec
+- lib/eternal.rb
+- lib/patterns.rb
+- test/test_eternal.rb
+- test/test_helper.rb
+homepage: https://github.com/KritR/eternal
+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.7.3
+signing_key: 
+specification_version: 4
+summary: Eternal parses events, dates, and everything involved in  schedules using
+  chronic and chronic duration. These events are returned as  ice_cube objects which
+  can be converted to ical or yaml, or simply used to calculate the next occurrence
+  of the schedule specified.
+test_files: []