schedule-checker 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9adf8745c8e04282d98a235b0133b6641c23ce6c
+  data.tar.gz: 3e5a646261bf9436c0668bac97e7f346d40feadc
+SHA512:
+  metadata.gz: 8d9eceedce95b4fbba1172984011d213a2bfc17fd5ac73044813beb6e49fd8a02fc112697ce186759afee4cc5e21221412066615ccffd4e91cbd953b167a2f9e
+  data.tar.gz: 7237505954b1800dba60416cdae16a601e0c67c68a938f70ee493a648e6cac98ca266931260bcd1c06df9065809cdebf8d647e2193a2e780c2390e6e16d78be5

data/lib/schedule-checker.rb

@@ -0,0 +1,14 @@
+require 'schedule-checker/schedule'
+
+module ScheduleChecker
+
+  def self.parse_schedule_file(filename)
+    str = File.read(filename)
+    ScheduleChecker::Parser.new(str).schedule
+  end
+
+  def self.nonstop_schedule
+    ScheduleChecker::Schedule.nonstop
+  end
+
+end

data/lib/schedule-checker/parser.rb

@@ -0,0 +1,87 @@
+require 'schedule-checker/schedule'
+require 'schedule-checker/session'
+require 'schedule-checker/timepoint'
+require 'yaml'
+
+module ScheduleChecker
+
+  class Parser
+    attr_reader :config, :schedule
+
+    ALLOWED_KEYS = ["sessions","timezone"]
+
+    def initialize(s)
+      session_string_pairs = []
+      nonstop = false
+
+      @config = Parser.downcase_keys(YAML.load(s))
+
+      check_keys
+
+      is_utc = is_utc?
+
+      raise "no sessions specified" unless @config["sessions"] and @config["sessions"].length > 0
+
+      sessions = []
+      raise "sessions should be a list" unless @config["sessions"].is_a? Array
+
+      @config["sessions"].each do |session_string|
+        s = session_string.downcase.strip
+
+        #TODO - come back later and make this nonstop-session processing better
+        #  Should probably have non-stop be a property of Session, not Schedule, and 
+        #  rely on Schedule to check for timed/nonstop session conflicts.
+
+        if ["nonstop","non-stop"].include?(s)
+          raise "config can't simultaneously be non-stop and have scheduled sessions" if sessions.length>0
+          nonstop = true
+        else
+          raise "config can't simultaneously be non-stop and have scheduled sessions" if nonstop
+          sessions << Parser.parse_session(s,is_utc)
+        end
+      end
+      
+      if(nonstop)
+        @schedule = ScheduleChecker::Schedule.nonstop
+      else
+        @schedule = ScheduleChecker::Schedule.new
+        sessions.each{|s| @schedule.add_session(s)}
+      end
+    end
+
+  private
+    def self.downcase_keys(h)
+      rv = {}
+      h.each{|k,v| rv[k.downcase] = v }
+      rv
+    end
+
+    def check_keys
+      @config.keys.each{|k| raise "unsupported setting '#{k}'" unless ALLOWED_KEYS.include?(k) }
+    end
+
+    def is_utc?
+      return true unless @config.has_key?("timezone")
+      case @config["timezone"].downcase
+        when "utc"
+          true
+        when "local"
+          return false
+        else
+          raise "unsupported timezone value: #{s}"
+      end
+    end
+
+    def self.parse_session(s,is_utc)
+      raise "malformed session value: #{s}" unless s.include?("-")
+      starttime,endtime = s.split("-",2)
+      raise "malformed session value: #{s}" if starttime.nil? or endtime.nil?
+      starttime.strip!
+      endtime.strip!
+      ScheduleChecker::Session.new(
+        ScheduleChecker::Timepoint.from_string(starttime,is_utc),
+        ScheduleChecker::Timepoint.from_string(endtime,is_utc))
+    end
+  end
+
+end

data/lib/schedule-checker/schedule.rb

@@ -0,0 +1,33 @@
+require 'schedule-checker/parser'
+require 'schedule-checker/session'
+
+module ScheduleChecker
+  class Schedule
+    attr_reader :sessions,:nonstop
+  
+    def initialize(nonstop=false)
+      @sessions = [] # Session objects
+      @nonstop = nonstop
+    end
+
+    def self.nonstop
+      ScheduleChecker::Schedule.new(true)
+    end
+
+    def add_session(session)
+      raise "can't add to a non-stop schedule" if @nonstop
+
+      if self.in_a_session?(session.startpoint) || self.in_a_session?(session.endpoint)
+        raise "new session overlaps with existing session"
+      end
+      @sessions << session
+    end
+  
+    def in_a_session?(t) # t is a timestamp
+      return true if @nonstop
+      @sessions.each{|s| return true if s.in_session?(t) }
+      false
+    end
+  
+  end
+end

data/lib/schedule-checker/session.rb

@@ -0,0 +1,21 @@
+module ScheduleChecker
+  class Session
+    attr_reader :startpoint,:endpoint
+  
+    def initialize(startpoint,endpoint)
+      @startpoint = startpoint
+      @endpoint = endpoint
+    end
+
+    def in_session?(t) #t is a timestamp or Timepoint
+      if startpoint.gt(endpoint)
+        return startpoint.lte(t) || endpoint.gt(t)
+      end
+      startpoint.lte(t) && endpoint.gt(t)
+    end
+  
+    def to_s
+      "Session:#{startpoint.to_s}-#{endpoint.to_s}"
+    end
+  end
+end

data/lib/schedule-checker/timepoint.rb

@@ -0,0 +1,66 @@
+module ScheduleChecker
+  class Timepoint
+    attr_reader :normalized_ts
+  
+    # day: 0-6 for Sunday-Saturday
+    # hour: 0-24
+    def initialize(day,hour,minute,second,is_utc=true)
+      raise "invalid day (must be 0-6, 0 is Monday)" unless (0..6).to_a.include?(day)
+      @normalized_ts = is_utc ?
+        Time.utc(2012,1,day+1,hour,minute,second) :
+        Time.local(2012,1,day+1,hour,minute,second).getutc
+    end
+
+    def self.from_string(s,is_utc=true)
+      raise "bad format '#{s}'" unless s.match(/^\w\w\w[\w]*\/\d\d:\d\d:\d\d$/)
+      day_str,time_str = s.split("/")
+      day = ScheduleChecker::Timepoint.day_str_to_i(day_str)
+      h,m,s = time_str.split(":")
+      ScheduleChecker::Timepoint.new(day,h.to_i,m.to_i,s.to_i,is_utc)
+    end
+
+    def normalized_ts_as_local
+      @normalized_ts.get_local
+    end
+  
+    def to_s
+      @normalized_ts.strftime("#{wday_abbrev}/%H:%M:%S")
+    end
+  
+    def lte(t)
+      #only cares about wday and time
+      x = t.is_a?(ScheduleChecker::Timepoint) ? t.normalized_ts : ScheduleChecker::Timepoint.normalize_timestamp(t)
+      self.normalized_ts <= x
+    end
+  
+    def gt(t)
+      #only cares about wday and time
+      x = t.is_a?(ScheduleChecker::Timepoint) ? t.normalized_ts : ScheduleChecker::Timepoint.normalize_timestamp(t)
+      self.normalized_ts > x
+    end
+
+    def self.normalize_timestamp(ts)
+      x = ts.getutc
+      ScheduleChecker::Timepoint.new(x.wday,x.hour,x.min,x.sec).normalized_ts
+    end
+  
+    DAYS = ["sun","mon","tue","wed","thu","fri","sat"]
+    def self.pretty_day(n)
+      raise "Illegal day int '#{n}'" unless (0..6).to_a.include?(n)
+      DAYS[n].capitalize
+    end
+  
+    def self.day_str_to_i(str)
+      d = str.downcase.slice(0,3)
+      rv = DAYS.find_index(d)
+      raise "Illegal day string '#{str}'" unless rv
+      rv
+    end
+
+  private
+    def wday_abbrev
+      ScheduleChecker::Timepoint.pretty_day(@normalized_ts.wday)
+    end
+  
+  end
+end

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: schedule-checker
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Grant Birchmeier
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-29 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: grant@grantb.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/schedule-checker.rb
+- lib/schedule-checker/parser.rb
+- lib/schedule-checker/schedule.rb
+- lib/schedule-checker/session.rb
+- lib/schedule-checker/timepoint.rb
+homepage: http://github.com/gbirchmeier/schedule-checker
+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.2.2
+signing_key: 
+specification_version: 4
+summary: A simple file format and module for specifying a weekly schedule of sessions
+  and checking if a given time is within a session or not.
+test_files: []
+has_rdoc: