ical_builder 0.2.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Marshall Roch
+
+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.rdoc

@@ -0,0 +1,7 @@
+= ical_builder
+
+Description goes here.
+
+== Copyright
+
+Copyright (c) 2009 Marshall Roch. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "ical_builder"
+    gem.summary = %Q{An iCalendar generator in Ruby, modelled after Jim Weirich's Builder}
+    gem.email = "marshall@mroch.com"
+    gem.homepage = "http://github.com/mroch/ical_builder"
+    gem.authors = ["Marshall Roch"]
+    gem.add_dependency 'blankslate'
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = 'ical_builder'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = false
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test

data/VERSION.yml

@@ -0,0 +1,4 @@
+---
+:patch: 1
+:major: 0
+:minor: 2

data/ical_builder.gemspec

@@ -0,0 +1,52 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{ical_builder}
+  s.version = "0.2.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Marshall Roch"]
+  s.date = %q{2011-03-28}
+  s.email = %q{marshall@mroch.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+    "README.rdoc"
+  ]
+  s.files = [
+    "LICENSE",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION.yml",
+    "ical_builder.gemspec",
+    "init.rb",
+    "lib/ical_builder.rb",
+    "lib/ical_template.rb",
+    "rails/init.rb",
+    "test/ical_builder_test.rb",
+    "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/mroch/ical_builder}
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{An iCalendar generator in Ruby, modelled after Jim Weirich's Builder}
+  s.test_files = [
+    "test/ical_builder_test.rb",
+    "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<blankslate>, [">= 0"])
+    else
+      s.add_dependency(%q<blankslate>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<blankslate>, [">= 0"])
+  end
+end
+

data/init.rb

@@ -0,0 +1,2 @@
+require 'ical_builder'
+require 'ical_template'

data/lib/ical_builder.rb

@@ -0,0 +1,94 @@
+require 'blankslate'
+
+module Builder
+  class Ical < BlankSlate
+    def initialize(options = {})
+      @target = options[:target] || ''
+    end
+
+    def to_s
+      __fold(@target.to_s)
+    end
+
+    def <<(str)
+      @target << str
+    end
+
+    # RRULE is a special case since it needs to take a hash, but FREQ must
+    # always be first.
+    def rrule(*args)
+      if args[0].is_a?(Hash)
+        freq = __value({ :freq => args[0].delete(:freq) })
+        others = args[0].empty? ? nil : __value(args[0])
+        args[0] = [freq, others].compact.join(';')
+      end
+      method_missing(:rrule, *args)
+    end
+
+    def method_missing(sym, *args, &block)
+      value = args.shift
+      if block
+        @target << "BEGIN:#{__property(sym)}\r\n"
+        block.call(self)
+        @target << "END:#{__property(sym)}\r\n"
+      else
+        @target << "#{__property(sym)}#{__parameters(args)}:#{__value(value)}\r\n"
+      end
+    end
+
+    private
+      def __property(sym)
+        sym.to_s.upcase.gsub(/_/, '-')
+      end
+
+      # 4.2 Property Parameters
+      def __parameters(args)
+        return '' if args.nil? || args.empty?
+
+        ';' + args.collect { |arg| 
+          case arg
+          when Hash
+            arg.collect { |k, v| "#{__property(k)}=#{__value(v)}" }.sort.join(';')
+          else
+            arg.to_s
+          end
+        }.join(';')
+      end
+
+      # 4.3 Property Value Data Types
+      def __value(val)
+        case val
+        when Array
+          # 4.1.1
+          val.collect { |v| __value(v) }.join(',')
+        when Hash
+          # 4.1.1
+          val.collect { |k, v| "#{__property(k)}=#{__value(v)}" }.sort.join(';')
+        when true, false
+          # 4.3.2
+          val.to_s.upcase
+        when Date
+          # 4.3.4
+          val.strftime('%Y%m%d')
+        when Time
+          # 4.3.5
+          val.strftime('%Y%m%dT%H%M%S' + (val.utc? ? 'Z' : ''))
+        else
+          val.to_s
+        end
+      end
+
+      # 4.1 Content Lines
+      def __fold(str)
+        str.split("\r\n").collect { |line| __fold_line(line) }.join("\r\n") + "\r\n"
+      end
+
+      def __fold_line(line)
+        if line.length > 75
+          line[0..74] + "\r\n" + __fold_line(" " + line[75..-1])
+        else
+          line
+        end
+      end
+  end
+end

data/lib/ical_template.rb

@@ -0,0 +1,17 @@
+module Builder
+  class IcalPlugin < ActionView::TemplateHandler
+    include ActionView::TemplateHandlers::Compilable if defined?(ActionView::TemplateHandlers::Compilable)
+
+    def compile(template)
+      "_set_controller_content_type(Mime::ICS);" +
+        "cal = ::Builder::Ical.new;" +
+        "self.output_buffer = cal.to_s;" +
+        template.source +
+        ";cal.to_s;"
+    end
+
+  end
+end
+
+ActionView::Template.register_template_handler(:ical, Builder::IcalPlugin)
+ActionView::Template.exempt_from_layout(:ical)

data/rails/init.rb

@@ -0,0 +1 @@
+Kernel.load File.join(File.dirname(__FILE__), '..', 'init.rb')

data/test/ical_builder_test.rb

@@ -0,0 +1,140 @@
+require 'test_helper'
+
+class IcalBuilderTest < Test::Unit::TestCase
+
+  def setup
+    @builder = Builder::Ical.new
+  end
+
+  should "handle boolean property values (4.3.2)" do
+    @builder.gibberish(true)
+    assert_equal "GIBBERISH:TRUE\r\n", @builder.to_s
+  end
+
+  should "handle date property values (4.3.4)" do
+    @builder.gibberish(Date.new(2009, 9, 11))
+    assert_equal "GIBBERISH:20090911\r\n", @builder.to_s
+  end
+
+  should "handle date-time property values (4.3.5)" do
+    # Local time after 12pm
+    @builder.gibberish(Time.local(2009, 9, 11, 13, 45, 22))
+    assert_equal "GIBBERISH:20090911T134522\r\n", @builder.to_s
+    
+    # Local time before 12pm
+    @builder = Builder::Ical.new
+    @builder.gibberish(Time.local(2009, 9, 11, 1, 45, 22))
+    assert_equal "GIBBERISH:20090911T014522\r\n", @builder.to_s
+    
+    # UTC after 12pm
+    @builder = Builder::Ical.new
+    @builder.gibberish(Time.utc(2009, 9, 11, 13, 45, 22))
+    assert_equal "GIBBERISH:20090911T134522Z\r\n", @builder.to_s
+    
+    # UTC before 12pm
+    @builder = Builder::Ical.new
+    @builder.gibberish(Time.utc(2009, 9, 11, 1, 45, 22))
+    assert_equal "GIBBERISH:20090911T014522Z\r\n", @builder.to_s
+  end
+
+  should "handle lists of values (4.1.1)" do
+    @builder.gibberish(['foo', 'bar'])
+    assert_equal "GIBBERISH:foo,bar\r\n", @builder.to_s
+  end
+
+  should "handle lists of values with only one item (4.1.1)" do
+    @builder.gibberish(['foo'])
+    assert_equal "GIBBERISH:foo\r\n", @builder.to_s
+  end
+
+  should "allow newlines (4.3.11)" do
+    @builder.text("Foo bar\nBaz bliffl")
+    assert_equal "TEXT:Foo bar\nBaz bliffl\r\n", @builder.to_s
+  end
+
+  should "handle values with multiple parts (4.1.1)" do
+    @builder.gibberish({ :foo => 'bar', :bymonth => 11, :byday => '1SU' })
+    assert_equal "GIBBERISH:BYDAY=1SU;BYMONTH=11;FOO=bar\r\n", @builder.to_s
+  end
+
+  should "handle values and properties with multiple values" do
+    @builder.gibberish({ :freq => 'YEARLY', :bymonth => 11, :byday => '1SU' }, { :foo => 'bar', :baz => 'bliffl' })
+    assert_equal "GIBBERISH;BAZ=bliffl;FOO=bar:BYDAY=1SU;BYMONTH=11;FREQ=YEARLY\r\n", @builder.to_s
+  end
+
+  should "format parameters without double-quotes correctly" do
+    @builder.organizer('MAILTO:jsmith@host.com', :cn => 'John Smith')
+    assert_equal "ORGANIZER;CN=John Smith:MAILTO:jsmith@host.com\r\n", @builder.to_s
+  end
+
+  should "format parameters with double-quotes correctly" do
+    @builder.organizer('MAILTO:jsmith@host.com', :cn => '"John Smith"')
+    assert_equal "ORGANIZER;CN=\"John Smith\":MAILTO:jsmith@host.com\r\n", @builder.to_s
+  end
+
+  should "format parameters with dashes correctly" do
+    @builder.attendee('MAILTO: jdoe@host.com', :delegated_from => '"MAILTO:jsmith@host.com"')
+    assert_equal \
+      "ATTENDEE;DELEGATED-FROM=\"MAILTO:jsmith@host.com\":MAILTO: jdoe@host.com\r\n", 
+      @builder.to_s
+  end
+
+  should "format parameters with multiple values correctly" do
+    @builder.attendee(
+      'MAILTO:janedoe@host.com',
+      :member => ['"MAILTO:projectA@host.com"', '"MAILTO:projectB@host.com"']
+    )
+    assert_equal \
+      "ATTENDEE;MEMBER=\"MAILTO:projectA@host.com\",\"MAILTO:projectB@host.com\":MAILT\r\n O:janedoe@host.com\r\n",
+      @builder.to_s
+  end
+
+  should "append arbitrary text" do
+    @builder.foo("bar")
+    @builder << "ARBITRARY-PROPERTY:\"Lorem ipsum dolor sit amet\"\r\n"
+    assert_equal "FOO:bar\r\nARBITRARY-PROPERTY:\"Lorem ipsum dolor sit amet\"\r\n", @builder.to_s
+  end
+
+  should "not fold lines less than 75 characters long" do
+    @builder.text("Lorem ipsum dolor sit amet, consectetur adipiscing elit.")
+    assert_equal "TEXT:Lorem ipsum dolor sit amet, consectetur adipiscing elit.\r\n", @builder.to_s
+  end
+
+  should "not fold lines exactly 75 characters long" do
+    @builder.text("Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec nullam.")
+    assert_equal "TEXT:Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec nullam.\r\n", @builder.to_s
+  end
+
+  should "not fold lines exactly 75 characters long even if they end in whitespace" do
+    @builder.text("Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec nullam ")
+    assert_equal "TEXT:Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec nullam \r\n", @builder.to_s
+  end
+
+  should "fold lines longer than 75 characters" do
+    @builder.description("Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nam eget elit tellus. In hac habitasse platea dictumst. Vestibulum tincidunt velit id erat interdum id tristique diam blandit. Praesent nullam.")
+    assert_equal \
+      "DESCRIPTION:Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nam eg\r\n et elit tellus. In hac habitasse platea dictumst. Vestibulum tincidunt vel\r\n it id erat interdum id tristique diam blandit. Praesent nullam.\r\n",
+      @builder.to_s
+  end
+
+  should "fold lines longer than 75 characters even if only whitespace" do
+    @builder.text("Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec nullam. ")
+    assert_equal "TEXT:Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec nullam.\r\n  \r\n", @builder.to_s
+  end
+
+  should "fold arbitrary text" do
+    @builder << "TEXT:Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nam eget elit tellus. In hac habitasse platea dictumst.\r\n"
+    assert_equal "TEXT:Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nam eget elit\r\n  tellus. In hac habitasse platea dictumst.\r\n", @builder.to_s
+  end
+
+  should "always place FREQ first in RRULE values" do
+    @builder.rrule({ :freq => 'YEARLY', :interval => 1, :byday => '1SU' })
+    assert_equal "RRULE:FREQ=YEARLY;BYDAY=1SU;INTERVAL=1\r\n", @builder.to_s
+  end
+
+  should "format RRULEs properly even with only FREQ" do
+    @builder.rrule({ :freq => 'YEARLY' })
+    assert_equal "RRULE:FREQ=YEARLY\r\n", @builder.to_s
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'ical_builder'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification 
+name: ical_builder
+version: !ruby/object:Gem::Version 
+  hash: 21
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 1
+  version: 0.2.1
+platform: ruby
+authors: 
+- Marshall Roch
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-28 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: blankslate
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: 
+email: marshall@mroch.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- ical_builder.gemspec
+- init.rb
+- lib/ical_builder.rb
+- lib/ical_template.rb
+- rails/init.rb
+- test/ical_builder_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/mroch/ical_builder
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: An iCalendar generator in Ruby, modelled after Jim Weirich's Builder
+test_files: 
+- test/ical_builder_test.rb
+- test/test_helper.rb