selene 0.2.0 → 0.3.0

data/lib/selene/alarm_builder.rb

@@ -9,8 +9,8 @@ module Selene
       @component
     end
 
-    def parse(name, params, value)
-      @component[name.downcase] = value
+    def parse(line)
+      @component[line.name.downcase] = line.value
     end
 
   end

data/lib/selene/calendar_builder.rb

@@ -2,13 +2,22 @@ module Selene
   class CalendarBuilder
 
     def initialize
+      @errors = []
       @component = Hash.new { |component, property| component[property] = [] }
     end
 
-    def parse(name, params, value)
+    def parse(line)
+      set_property line.name, line.value
+    end
+
+    def set_property(name, value)
       @component[name.downcase] = value
     end
 
+    def name(line)
+      line.name.downcase
+    end
+
     def append(builder)
       case builder
       when EventBuilder

data/lib/selene/daylight_savings_time_builder.rb

@@ -9,12 +9,12 @@ module Selene
       @component
     end
 
-    def parse(name, params, value)
-      @component[name.downcase] = case name
-      when 'RRULE' 
-        Hash[value.split(';').map { |vs| k, v = vs.split('=', 2); [k.downcase, v] }]
+    def parse(line)
+      @component[line.name.downcase] = case line.name
+      when 'RRULE'
+        Hash[line.value.split(';').map { |vs| k, v = vs.split('=', 2); [k.downcase, v] }]
       else
-        value
+        line.value
       end
     end
   end

data/lib/selene/event_builder.rb

@@ -9,14 +9,14 @@ module Selene
       @component
     end
 
-    def parse(name, params, value)
-      component[name.downcase] = case name
+    def parse(line)
+      component[line.name.downcase] = case line.name
       when 'DTSTAMP', 'DTSTART', 'DTEND'
-        Parser.parse_date_and_time(name, params, value)
+        line.value_with_params
       when 'GEO'
-        value.split(';')
+        line.value.split(';')
       else
-        value
+        line.value
       end
     end
 

data/lib/selene/line.rb

@@ -0,0 +1,72 @@
+module Selene
+  class Line < Struct.new(:name, :params, :value)
+
+    # Match everything until we hit ';' (parameter separator) or ':' (value separator)
+    NAME = /(?<name>[^:\;]+)/
+
+    # Match everything until we hit ':' (value separator)
+    PARAMS = /(?:\;(?<params>[^:]*))/
+
+    # Match everything that's left
+    VALUE = /(?<value>.*)/
+
+    # Match everything that is not ';' (parameter separator)
+    PARAM = /[^\;]+/
+
+    # Match everything before '='
+    PARAM_KEY_VALUE = /(?<key>[^=]+)=(?<value>.*)/
+
+    # Split a string into content lines
+    def self.split(string)
+      delimiter = string.scan(/\r\n?|\n/).first || "\r\n"
+      string.gsub(/#{delimiter}\s/, '').split(delimiter).map { |line| parse(line) }
+    end
+
+    # Parse a content line into a line object
+    def self.parse(content_line)
+      content_line.match(/#{NAME}#{PARAMS}?:#{VALUE}/) do |match|
+        return new(match[:name], parse_params(match[:params]), match[:value])
+      end
+    end
+
+
+    def self.parse_params(params_string)
+      {}.tap do |params|
+        return params unless params_string
+        params_string.scan(PARAM).map do |param|
+          param.match(PARAM_KEY_VALUE) do |match|
+            params[match[:key].downcase] = match[:value]
+          end
+        end
+      end
+    end
+
+    def initialize(name, params, value)
+      self.name = name.upcase
+      self.params = params || {}
+      self.value = value
+    end
+
+    def begin_component?
+      name == 'BEGIN'
+    end
+
+    def end_component?
+      name == 'END'
+    end
+
+    def params?
+      params && !params.empty?
+    end
+
+    def value_with_params
+      params? ? [value, params] : value
+    end
+
+    def ==(line)
+      super(line) unless line.is_a?(Hash)
+      members.all? { |key| line[key] == self.send(key) }
+    end
+
+  end
+end

data/lib/selene/parser.rb

@@ -2,6 +2,7 @@ require 'selene/alarm_builder'
 require 'selene/calendar_builder'
 require 'selene/daylight_savings_time_builder'
 require 'selene/event_builder'
+require 'selene/line'
 require 'selene/standard_time_builder'
 require 'selene/time_zone_builder'
 
@@ -23,11 +24,10 @@ module Selene
     def self.parse(string)
       { 'calendars' => [] }.tap do |feed|
         stack = []
-        split_content_lines(string).each_with_index do |content_line, i|
-          line = parse_content_line(content_line)
-          if line[:name].upcase == 'BEGIN'
-            stack << builder(line[:value]).new
-          elsif line[:name].upcase == 'END'
+        Line.split(string).each do |line|
+          if line.begin_component?
+            stack << builder(line.value).new
+          elsif line.end_component?
             builder = stack.pop
             if !stack.empty?
               stack[-1].append(builder)
@@ -35,35 +35,11 @@ module Selene
               feed['calendars'] << builder.component
             end
           else
-            stack[-1].parse(line[:name], line[:params], line[:value])
+            stack[-1].parse(line)
           end
         end
       end
     end
 
-    def self.parse_content_line(string)
-      string =~ /([^:\;]+)(?:\;([^:]*))?:(.*)/i
-      { :name => $1, :params => parse_params($2), :value => $3 }
-    end
-
-    def self.parse_date_and_time(name, params, value)
-      params && params != {} ? [value, params] : value
-    end
-
-    def self.parse_params(raw_params)
-      return unless raw_params
-      {}.tap do |params|
-        raw_params.scan(/[^\;]+/i).map do |param|
-          param =~ /([^=]+)=(.*)/
-          params[$1.downcase] = $2
-        end
-      end
-    end
-
-    def self.split_content_lines(string)
-      line_break = string.scan(/\r\n?|\n/).first || "\r\n"
-      string.gsub(/#{line_break}\s/, '').split(line_break)
-    end
-
   end
 end

data/lib/selene/standard_time_builder.rb

@@ -9,8 +9,8 @@ module Selene
       @component
     end
 
-    def parse(name, params, value)
-      @component[name.downcase] = value
+    def parse(line)
+      @component[line.name.downcase] = line.value
     end
   end
 end

data/lib/selene/time_zone_builder.rb

@@ -9,8 +9,8 @@ module Selene
       @component
     end
 
-    def parse(name, params, value)
-      @component[name.downcase] = value
+    def parse(line)
+      @component[line.name.downcase] = line.value
     end
 
     def append(builder)

data/lib/selene/version.rb

@@ -1,3 +1,3 @@
 module Selene
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/test/selene/alarm_builder_test.rb

@@ -0,0 +1,16 @@
+require 'test_helper'
+
+module Selene
+  class AlarmBuilderTest < TestCase
+
+    def builder
+      @builder ||= AlarmBuilder.new
+    end
+
+    def test_parses_action
+      parse_line 'ACTION', {}, 'AUDIO'
+      assert_equal builder.component['action'], 'AUDIO'
+    end
+
+  end
+end

data/test/selene/calendar_builder_test.rb

@@ -16,27 +16,27 @@ module Selene
     end
 
     def test_parse_prodid
-      builder.parse('PRODID', '', '-//Meetup//RemoteApi//EN')
+      parse_line('PRODID', '', '-//Meetup//RemoteApi//EN')
       assert_equal builder.component['prodid'], '-//Meetup//RemoteApi//EN'
     end
 
     def test_parse_version
-      builder.parse('VERSION', '', '2.0')
+      parse_line('VERSION', '', '2.0')
       assert_equal @builder.component['version'], '2.0'
     end
 
     def test_parse_calscale
-      builder.parse('CALSCALE', '', 'Gregorian')
+      parse_line('CALSCALE', '', 'Gregorian')
       assert_equal builder.component['calscale'], 'Gregorian'
     end
 
     def test_parse_method
-      builder.parse('METHOD', '', 'Publish')
+      parse_line('METHOD', '', 'Publish')
       assert_equal builder.component['method'], 'Publish'
     end
 
     def test_parse_x_prop
-      builder.parse('X-ORIGINAL-URL', '', 'http://www.google.com')
+      parse_line('X-ORIGINAL-URL', '', 'http://www.google.com')
       assert_equal builder.component['x-original-url'], 'http://www.google.com'
     end
 

data/test/selene/daylight_savings_time_builder_test.rb

@@ -8,7 +8,7 @@ module Selene
     end
 
     def test_parses_rrule 
-      builder.parse('RRULE', '', 'FREQ=YEARLY;BYMONTH=3;BYDAY=2SU')
+      parse_line('RRULE', '', 'FREQ=YEARLY;BYMONTH=3;BYDAY=2SU')
       assert_equal builder.component['rrule'], { 'freq' => 'YEARLY', 'bymonth' => '3', 'byday' => '2SU' }
     end
 

data/test/selene/event_builder_test.rb

@@ -9,78 +9,78 @@ module Selene
 
     def test_parses_dtstart
       expected = ['20130110T183000', { 'tzid' => 'America/New_York' }]
-      builder.parse('DTSTART', { 'tzid' => 'America/New_York' }, '20130110T183000')
+      parse_line('DTSTART', { 'tzid' => 'America/New_York' }, '20130110T183000')
       assert_equal builder.component['dtstart'], expected
     end
 
     def test_parses_dtstamp
-      builder.parse('DTSTAMP', nil, '20121231T093631Z')
+      parse_line('DTSTAMP', nil, '20121231T093631Z')
       assert_equal builder.component['dtstamp'], '20121231T093631Z'
     end
 
     def test_parses_dtstart_without_tzid
-      builder.parse('DTSTART', nil, '20130110T183000')
+      parse_line('DTSTART', {}, '20130110T183000')
       assert_equal builder.component['dtstart'], '20130110T183000'
     end
 
     def test_parses_dtend
       expected = ['20130110T183000', { 'tzid' => 'America/New_York' }]
-      builder.parse('DTEND', { 'tzid' => 'America/New_York' }, '20130110T183000')
+      parse_line('DTEND', { 'tzid' => 'America/New_York' }, '20130110T183000')
       assert_equal builder.component['dtend'], expected
     end
 
     def test_parses_dtstart_without_tzid
-      builder.parse('DTEND', nil, '20130110T183000')
+      parse_line('DTEND', nil, '20130110T183000')
       assert_equal builder.component['dtend'], '20130110T183000'
     end
 
     def test_parses_status
-      builder.parse('STATUS', nil, 'CONFIRMED')
+      parse_line('STATUS', nil, 'CONFIRMED')
       assert_equal builder.component['status'], 'CONFIRMED'
     end
 
     def test_parses_summary
-      builder.parse('SUMMARY', nil, 'DetroitRuby: 2012 Plan + Lightning talks')
+      parse_line('SUMMARY', nil, 'DetroitRuby: 2012 Plan + Lightning talks')
       assert_equal builder.component['summary'], 'DetroitRuby: 2012 Plan + Lightning talks'
     end
 
     def test_parses_description
-      builder.parse('DESCRIPTION', nil, 'DetroitRuby\nThursday\, January 10 at 6:30 PM\n\n')
+      parse_line('DESCRIPTION', nil, 'DetroitRuby\nThursday\, January 10 at 6:30 PM\n\n')
       assert_equal builder.component['description'], 'DetroitRuby\nThursday\, January 10 at 6:30 PM\n\n'
     end
 
     def test_parses_class
-      builder.parse('CLASS', nil, 'PUBLIC')
+      parse_line('CLASS', nil, 'PUBLIC')
       assert_equal builder.component['class'], 'PUBLIC'
     end
 
     def test_parses_created
-      builder.parse('CREATED', nil, '20120106T161509Z')
+      parse_line('CREATED', nil, '20120106T161509Z')
       assert_equal builder.component['created'], '20120106T161509Z'
     end
 
     def test_parses_geo
-      builder.parse('GEO', nil, '42.33;-83.05')
+      parse_line('GEO', nil, '42.33;-83.05')
       assert_equal builder.component['geo'], ['42.33', '-83.05']
     end
 
     def test_parses_location
-      builder.parse('LOCATION', nil, 'Compuware Building (One Campus Martius\, Detroit\, MI 48226)')
+      parse_line('LOCATION', nil, 'Compuware Building (One Campus Martius\, Detroit\, MI 48226)')
       assert_equal builder.component['location'], 'Compuware Building (One Campus Martius\, Detroit\, MI 48226)'
     end
 
     def test_parses_url
-      builder.parse('URL', nil, 'http://www.meetup.com/DetroitRuby/events/93346412/')
+      parse_line('URL', nil, 'http://www.meetup.com/DetroitRuby/events/93346412/')
       assert_equal builder.component['url'], 'http://www.meetup.com/DetroitRuby/events/93346412/'
     end
 
     def test_parses_last_modified
-      builder.parse('LAST-MODIFIED', nil, '20120106T161509Z')
+      parse_line('LAST-MODIFIED', nil, '20120106T161509Z')
       assert_equal builder.component['last-modified'], '20120106T161509Z'
     end
 
     def test_parses_uid
-      builder.parse('UID', nil, 'event_qgkxkcyrcbnb@meetup.com')
+      parse_line('UID', nil, 'event_qgkxkcyrcbnb@meetup.com')
       assert_equal builder.component['uid'], 'event_qgkxkcyrcbnb@meetup.com'
     end
 

data/test/selene/line_test.rb

@@ -0,0 +1,24 @@
+require 'test_helper'
+
+module Selene
+  class LineTest < TestCase
+
+    def test_lines_are_unfolded_before_splitting
+      assert_equal Line.split("TEST:This is a\r\n  test").first.value, "This is a test"
+    end
+
+    def test_parses_content_line
+      assert_equal Line.parse('VERSION:2.0'), { :name => 'VERSION', :params => {}, :value => '2.0' }
+    end
+
+    def test_parses_url
+      expected = { :name => 'TZURL', :params => {}, :value => 'http://www.meetup.com/DetroitRuby/events/ical/DetroitRuby/' }
+      assert_equal Line.parse('TZURL:http://www.meetup.com/DetroitRuby/events/ical/DetroitRuby/'), expected
+    end
+
+    def test_parses_params
+      expected = { :name => 'DTSTART', :params => { 'tzid' => 'America/New_York' }, :value => '20130110T183000' }
+      assert_equal Line.parse('DTSTART;TZID=America/New_York:20130110T183000'), expected
+    end
+  end
+end

data/test/selene/parser_test.rb

@@ -4,30 +4,10 @@ require 'json'
 module Selene
   class ParserTest < TestCase
 
-    def test_lines_are_unfolded_before_splitting
-      assert_equal Selene::Parser.split_content_lines("This is a\r\n  test").first, "This is a test"
-    end
-
     def test_parses_blank_string
       assert_equal Selene::Parser.parse(""), { 'calendars' => [] }
     end
 
-    def test_parses_content_line
-      assert_equal Selene::Parser.parse_content_line('VERSION:2.0'), { :name => 'VERSION', :params => nil, :value => '2.0' }
-    end
-
-    def test_parses_content_line_with_url
-      expected = { :name => 'TZURL', :params => nil, :value => 'http://www.meetup.com/DetroitRuby/events/ical/DetroitRuby/' }
-      assert_equal Selene::Parser.parse_content_line('TZURL:http://www.meetup.com/DetroitRuby/events/ical/DetroitRuby/'), expected
-    end
-
-    def test_parses_content_line_with_param
-      expected = { :name => 'DTSTART', :params => { 'tzid' => 'America/New_York' }, :value => '20130110T183000' } 
-      assert_equal Selene::Parser.parse_content_line('DTSTART;TZID=America/New_York:20130110T183000'), expected
-    end
-
-    # Sanity tests just to make sure the thing works
-
     def test_parses_simple_calendar
       assert_equal Selene::Parser.parse("BEGIN:VCALENDAR\r\nSUMMARY:Meetups\r\nEND:VCALENDAR"), { 'calendars' => [{ 'summary' => 'Meetups' }] }
     end

data/test/test_helper.rb

@@ -12,6 +12,13 @@ module Selene
       File.read(File.join(File.dirname(__FILE__), 'fixtures', filename))
     end
 
+    # This is a helper method that takes a name, params and a value, turns them into a proper line hash,
+    # and passes them to the builder to be parsed.
+    def parse_line(name, params, value)
+      raise "Must define builder method in test case" unless builder
+      builder.parse(Line.new(name, params, value))
+    end
+
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: selene
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-03 00:00:00.000000000 Z
+date: 2013-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: debugger
@@ -79,6 +79,7 @@ files:
 - lib/selene/calendar_builder.rb
 - lib/selene/daylight_savings_time_builder.rb
 - lib/selene/event_builder.rb
+- lib/selene/line.rb
 - lib/selene/parser.rb
 - lib/selene/standard_time_builder.rb
 - lib/selene/time_zone_builder.rb
@@ -86,9 +87,11 @@ files:
 - selene.gemspec
 - test/fixtures/meetup.ics
 - test/fixtures/meetup.json
+- test/selene/alarm_builder_test.rb
 - test/selene/calendar_builder_test.rb
 - test/selene/daylight_savings_time_builder_test.rb
 - test/selene/event_builder_test.rb
+- test/selene/line_test.rb
 - test/selene/parser_test.rb
 - test/selene/time_zone_builder_test.rb
 - test/test_helper.rb
@@ -106,7 +109,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3007603395114085871
+      hash: -4237878709699740480
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -115,7 +118,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3007603395114085871
+      hash: -4237878709699740480
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -125,9 +128,11 @@ summary: Selene is an iCalendar parser for Ruby
 test_files:
 - test/fixtures/meetup.ics
 - test/fixtures/meetup.json
+- test/selene/alarm_builder_test.rb
 - test/selene/calendar_builder_test.rb
 - test/selene/daylight_savings_time_builder_test.rb
 - test/selene/event_builder_test.rb
+- test/selene/line_test.rb
 - test/selene/parser_test.rb
 - test/selene/time_zone_builder_test.rb
 - test/test_helper.rb