texel-recurrence-rule-parser 0.0.1

data/History.txt

@@ -0,0 +1,6 @@
+=== 1.0.0 / 2008-12-09
+
+* 1 major enhancement
+
+  * Birthday!
+

data/Manifest.txt

@@ -0,0 +1,7 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/rrule_parser
+lib/rrule_parser.rb
+spec/lib/rrule_parser_spec.rb

data/README.txt

@@ -0,0 +1,53 @@
+= RruleParser
+
+* FIX (url)
+
+== DESCRIPTION:
+
+This package takes icalendar events (or any object conforming to their calling conventions),
+and handles translating recurrence rules into temporal expressions.
+
+== FEATURES/PROBLEMS:
+
+Current list of supported expressions:
+FREQ
+INTERVAL
+BYDAY
+
+== SYNOPSIS:
+
+  code samples forthcoming.
+
+== REQUIREMENTS:
+
+requires Runt and Icalendar.
+requires RSpec if you wish to run the specs.
+
+== INSTALL:
+
+sudo gem install texel-rrule-parser
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 FIX
+
+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/Rakefile

@@ -0,0 +1,12 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/rrule_parser.rb'
+
+Hoe.new('RruleParser', RruleParser::VERSION) do |p|
+  # p.rubyforge_name = 'RruleParserx' # if different than lowercase project name
+  # p.developer('FIX', 'FIX@example.com')
+end
+
+# vim: syntax=Ruby

data/lib/rrule_parser.rb

@@ -0,0 +1,84 @@
+require 'runt'
+require 'icalendar'
+
+class RruleParser
+  VERSION = '1.0.0'
+  
+  DAYS = {
+    "SU" => Runt::Sunday,
+    "MO" => Runt::Monday,
+    "TU" => Runt::Tuesday,
+    "WE" => Runt::Wednesday,
+    "TH" => Runt::Thursday,
+    "FR" => Runt::Friday,
+    "SA" => Runt::Saturday,
+    "SU" => Runt::Sunday
+  }
+  
+  ADVERB_MAP = {
+    "DAILY"   => "DAY",
+    "WEEKLY"  => "WEEK",
+    "MONTHLY" => "MONTH",
+    "YEARLY"  => "YEAR"
+  }
+  
+  attr_accessor :event
+  attr_accessor :rules
+  
+  def initialize(event)
+    @expressions      = []
+    self.rules        = {}
+    self.event        = event
+    self.parse_rules(event)
+  end
+  
+  # Parse rules, output temporal expressions
+  def expressions
+    @expressions = []
+    @expressions << parse_frequency_and_interval
+    @expressions << parse_byday
+    @expressions.compact!
+    @expressions
+  end
+  
+  def expression
+    self.expressions.inject {|m, v| v & m}
+  end
+  
+  protected
+  
+  def parse_rules(event)
+    rrules = event.recurrence_rules
+
+    rrules.each do |rule|
+      pairs = rule.split(";")
+      pairs.each do |pair|
+        array = pair.split('=')
+        self.rules[array[0].downcase.to_sym] = array[1]
+      end
+    end
+    
+    # Parse comma separated lists.
+    self.rules.each do |key, rule|
+      if rule =~ /,/
+        rules[key] = rule.split(',')
+      end
+    end
+  end
+  
+  def parse_frequency_and_interval
+    if self.rules[:freq]
+      frequency = self.rules[:freq]
+      interval  = self.rules[:interval] ? self.rules[:interval].to_i : 1
+      Runt::EveryTE.new(self.event.start, interval, Runt::DPrecision.const_get(ADVERB_MAP[frequency]))
+    end
+  end
+  
+  def parse_byday
+    if self.rules[:byday]
+      self.rules[:byday].map{ |day| Runt::DIWeek.new(RruleParser::DAYS[day]) }.inject do |m, expr|
+        m | expr
+      end
+    end
+  end
+end

data/spec/lib/rrule_parser_spec.rb

@@ -0,0 +1,91 @@
+require 'lib/rrule_parser'
+require 'icalendar'
+
+module RruleParserSpecHelper
+  def create_default_event
+    @interval    = 2
+    @frequency   = "WEEKLY"
+    @byday       = "MO,WE,FR"
+    @event       = Icalendar::Event.new
+    @event.start = Time.now
+    @event.end   = Time.now + 3600
+    @event.recurrence_rules = ["FREQ=#{@frequency};INTERVAL=#{@interval};BYDAY=#{@byday};WKST=SU"]
+  end
+  
+  def create_parser(event)
+    @parser = RruleParser.new(event)
+  end
+  
+  def create_default_parser
+    create_default_event
+    create_parser(@event)
+  end
+end
+
+describe RruleParser do
+  include RruleParserSpecHelper
+  
+  describe "#new" do
+    context "when passed a valid event object" do
+      before(:each) do
+        create_default_event
+      end
+      
+      it "should create a new RruleParser object" do
+        rrp = RruleParser.new(@event)
+        rrp.should be_an_instance_of(RruleParser)
+      end
+    end
+  end
+  
+  describe "#rules" do
+    context "with a valid event object" do
+      before(:each) do
+        create_default_parser
+      end
+      
+      it "should be a hash" do
+        @parser.rules.should be_an_instance_of(Hash)
+      end
+      
+      it "should have keys corresponding to rules" do
+        %w(FREQ INTERVAL BYDAY WKST).map {|m| m.downcase}.map {|m| m.to_sym}.each do |key|
+          @parser.rules.keys.should include(key)
+        end
+      end
+      
+      it "should split rules containing commas into arrays" do
+        @parser.rules[:byday].should be_an_instance_of(Array)
+      end
+    end
+  end
+  
+  describe "#expressions" do
+    before(:each) do
+      create_default_parser
+    end
+    
+    it "should return an array" do
+      @parser.expressions.should be_an_instance_of(Array)
+    end
+  end
+  
+  describe "#parse_frequency_and_interval" do
+    before(:each) do
+      create_default_parser
+      @result = @parser.send(:parse_frequency_and_interval)
+    end
+    
+    it "return a valid temporal expression" do
+      @result.should be_an_instance_of(Runt::EveryTE)
+    end
+    
+    it "should have the correct interval" do
+      @result.instance_variable_get("@interval").should == @interval
+    end
+    
+    it "should have the correct frequency" do
+      @result.instance_variable_get("@precision").should == Runt::DPrecision.const_get(RruleParser::ADVERB_MAP[@frequency])
+    end
+  end
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: texel-recurrence-rule-parser
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Leigh Caplan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-12-10 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: runt
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.6.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: icalendar
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 1.0.2
+    version: 
+description: Recurrence Rule Parser helps generate Temporal Expressions from iCalendar events.
+email: texel1@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- bin/rrule_parser
+- lib/rrule_parser.rb
+has_rdoc: true
+homepage: http://github.com/texel/recurrence-rule-parser
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: iCalendar to Temporal Expression parser
+test_files: 
+- spec/lib/rrule_parser_spec.rb