edtf 0.0.1

data/.gitignore

@@ -0,0 +1,3 @@
+Gemfile.lock
+lib/edtf/parser.rb
+

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require ./spec/spec_helper.rb
+--format progress

data/Gemfile

@@ -0,0 +1,7 @@
+source :rubygems
+gemspec
+
+group :debug do
+	gem 'ruby-debug19', :require => 'ruby-debug', :platforms => [:ruby_19]
+	gem 'ruby-debug', :platforms => [:ruby_18]
+end

data/LICENSE

@@ -0,0 +1,26 @@
+Copyright 2011 Sylvester Keil. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+ 1. Redistributions of source code must retain the above copyright notice,
+    this list of conditions and the following disclaimer.
+
+ 2. Redistributions in binary form must reproduce the above copyright notice,
+    this list of conditions and the following disclaimer in the documentation
+    and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER ``AS IS'' AND ANY EXPRESS OR
+IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
+EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
+INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+The views and conclusions contained in the software and documentation are
+those of the authors and should not be interpreted as representing official
+policies, either expressed or implied, of the copyright holder.

data/README.md

@@ -0,0 +1,81 @@
+EDTF-Ruby
+=========
+
+Ruby implementation of the [Extended Date/Time Format
+Specification](http://www.loc.gov/standards/datetime/spec.html).
+
+
+Compatibility
+-------------
+
+As of EDTF Specification DRAFT, August 4, 2001:
+
+* Level 0: fully implemented
+* Level 1: fully implemented
+* Level 2: implemented features 204, 207, 208, and 209
+
+The following level 2 extensions are currently _not_ supported: 201, 202, 203,
+204, and 205.
+
+
+Quickstart
+----------
+
+EDTF Ruby is implemented as an extension to the regular Ruby date/time classes.
+You can access parse EDTF strings either using `Date.edtf` or `EDTF.parse`; if
+given a valid EDTF string the return value will either be an (extended) `Date`,
+`EDTF::Interval` or `Range` (for masked precision strings) instance.
+
+    $ [sudo] gem install edtf
+    $ irb
+    > require 'edtf'
+    > d = Date.edtf('1984?')
+    > d.uncertain?
+     => true
+    > d.certain!
+    > d.uncertain?               
+     => false
+    > d = Date.edtf('1999-03-uu')
+    > d.unspecified?
+     => true
+    > d.unspecified? :year
+     => false
+    > d.unspecified? :day
+     => true
+    > Date.edtf('2003-24').winter?
+     => true
+		> Date.edtf('196x')
+		 => #<Date: 1960-01-01>...#<Date: 1970-01-01>
+		> Date.edtf('y-17e7').year
+		 => -170000000
+		> d = Date.edtf('1984-06?/2004-08?')
+		> d.from.uncertain?
+		 => true
+		> d.each.to_a.length
+		 => 7367 # days between 1984-06 and 2004-08
+		> Date.edtf('2004-01-01/open').open?
+		 => true
+		
+
+For additional features take a look at the rdoc, source, and rspec examples.
+
+
+Development
+-----------
+
+    $ git clone https://inukshuk@github.com/inukshuk/edtf-ruby.git
+    $ cd edtf-ruby
+    $ bundle install
+    $ bundle exec rake racc
+    $ bundle exec rspec spec
+    $ bundle exec cucumber
+
+For extra credit, fork the project on github: pull requests welcome!
+
+Credits
+-------
+
+EDTF-Ruby was written by [Sylvester Keil](http://sylvester.keil.or.at).
+
+Published under the terms and conditions of the FreeBSD License; see LICENSE
+for details.

data/Rakefile

@@ -0,0 +1,21 @@
+
+require 'rake/clean'
+
+desc 'Generates the parser'
+task :racc do
+  system 'bundle exec racc -o lib/edtf/parser.rb lib/edtf/parser.y'
+end
+
+desc 'Generates the parser with debug information'
+task :racc_debug do
+  system 'bundle exec racc -v -t -o lib/edtf/parser.rb lib/edtf/parser.y'
+end
+
+desc 'Builds the gem file'
+task :build => [:racc] do
+  system 'gem build edtf.gemspec'
+end
+
+CLEAN.include('lib/edtf/parser.rb')
+CLEAN.include('lib/edtf/parser.output')
+CLEAN.include('*.gem')

data/edtf.gemspec

@@ -0,0 +1,34 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+require 'edtf/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'edtf'
+  s.version     = EDTF::VERSION.dup
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Sylvester Keil']
+  s.email       = ['http://sylvester.keil.or.at']
+  s.homepage    = 'http://inukshuk.github.com/edtf-ruby'
+  s.summary     = 'Extended Date/Time Format for Ruby.'
+  s.description = 'An Extended Date/Time Format (EDTF) Parser for Ruby.'
+  s.license     = 'FreeBSD'
+
+  s.add_development_dependency('rake', ['~>0.9'])
+  s.add_development_dependency('racc', ['~>1.4'])
+  s.add_development_dependency('cucumber', ['~>1.0'])
+  s.add_development_dependency('rspec', ['~>2.6'])
+  s.add_development_dependency('ZenTest', ['~>4.6'])
+
+  s.files        = `git ls-files`.split("\n") << 'lib/edtf/parser.rb'
+  s.test_files   = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables  = []
+  s.require_path = 'lib'
+
+  s.rdoc_options      = %w{--line-numbers --inline-source --title "EDTF-Ruby" --main README.md --webcvs=http://github.com/inukshuk/edtf-ruby/tree/master/}
+  s.extra_rdoc_files  = %w{README.md LICENSE}
+  
+end
+
+# vim: syntax=ruby

data/features/parser/date_times.feature

@@ -0,0 +1,35 @@
+Feature: EDTF parses date/time strings
+
+	As a user of edtf-ruby
+	I want to parse date/time strings formatted in EDTF
+	
+	Scenario Outline: EDTF parses a date/time string
+		When I parse the string "<string>"
+		Then the year should be "<year>"
+		And the month should be "<month>"
+		And the day should be "<day>"
+		And the hours should be "<hours>"
+		And the minutes should be "<minutes>"
+		And the seconds should be "<seconds>"
+
+		@002 @level0
+		Scenarios: simple dates
+			| string               | year | month | day | hours | minutes | seconds |
+			| 2001-02-03T09:30:01  | 2001 | 2     | 3   | 9     | 30      | 1       |
+
+
+	Scenario Outline: EDTF parses a date/time string with timezone indicator
+		When I parse the string "<string>"
+		Then the year should be "<year>" (UTC)
+		And the month should be "<month>" (UTC)
+		And the day should be "<day>" (UTC)
+		And the hours should be "<hours>" (UTC)
+		And the minutes should be "<minutes>"
+		And the seconds should be "<seconds>"
+
+		@002 @level0
+		Scenarios: date/times with timezone
+			| string                    | year | month | day | hours | minutes | seconds |
+			| 2004-01-01T10:10:10Z      | 2004 | 1     | 1   | 10    | 10      | 10      |
+			| 2004-01-01T10:10:10+05:00 | 2004 | 1     | 1   | 5     | 10      | 10      |
+			| 2004-01-01T02:10:10+05:00 | 2003 | 12    | 31  | 21    | 10      | 10      |

data/features/parser/dates.feature

@@ -0,0 +1,53 @@
+Feature: EDTF parser parses date strings
+
+  In order to use dates in EDTF
+  As a user of edtf-ruby
+  I want to parse date strings formatted in EDTF
+
+  Scenario Outline: EDTF parses a date string
+    When I parse the string "<string>"
+    Then the year should be "<year>"
+    And the month should be "<month>"
+    And the day should be "<day>"
+
+    @001 @level0
+    Scenarios: simple dates
+      | string     | year | month | day |
+      | 2001-02-03 | 2001 | 2     | 3   |
+      | 2008-12    | 2008 | 12    | 1   |
+      | 2008       | 2008 | 1     | 1   |
+      | -0999      | -999 | 1     | 1   |
+      | 0000       | 0    | 1     | 1   |
+
+
+  Scenario Outline: EDTF parses uncertain date strings
+    When I parse the string "<string>"
+    Then the year should be "<year>"
+    And the year should be uncertain? "<uncertain-year>"
+    And the month should be "<month>"
+    And the month should be uncertain? "<uncertain-month>"
+    And the day should be "<day>"
+    And the day should be uncertain? "<uncertain-day>"
+
+    @101 @level1
+    Scenarios: uncertain date examples from the specification
+      | string      | year | uncertain-year | month | uncertain-month | day | uncertain-day |
+      | 1992?       | 1992 | yes            | 1     | yes             | 1   | yes           |
+      | 1984?       | 1984 | yes            | 1     | yes             | 1   | yes           |
+      | 2004-06?    | 2004 | yes            | 6     | yes             | 1   | yes           |
+      | 2004-06-11? | 2004 | yes            | 6     | yes             | 11  | yes           |
+
+
+  Scenario Outline: EDTF parses uncertain or approximate date strings
+    When I parse the string "<string>"
+    Then the year should be "<year>"
+    And the month should be "<month>"
+    And the day should be "<day>"
+    And the date should be uncertain? "<uncertain>"
+    And the date should be approximate? "<approximate>"
+
+    @101 @level1
+    Scenarios: uncertain date examples from the specification
+      | string      | year | month | day | uncertain | approximate |
+      | 1984~       | 1984 | 1     | 1   | no        | yes         |
+      | 1984?~      | 1984 | 1     | 1   | yes       | yes         |

data/features/parser/intervals.feature

@@ -0,0 +1,19 @@
+Feature: EDTF parses ISO 8601 interval strings
+	As a user of edtf-ruby
+	I want to parse ISO 8601 interval strings
+	
+	Scenario Outline: parse intervals
+		When I parse the string "<string>"
+		Then the interval should start at "<from>"
+		And the interval should end at "<to>"
+	
+	@004 @level0
+	Scenarios: specification intervals
+		| string                | from       | to         |
+		| 1964/2008             | 1964-01-01 | 2008-01-01 |
+		| 2004-06/2006-08       | 2004-06-01 | 2006-08-01 |
+		| 2004-01-01/2004-01-02 | 2004-01-01 | 2004-01-02 |
+		| 2004-02-01/2005-02-08 | 2004-02-01 | 2005-02-08 |
+		| 2004-02-01/2005-02    | 2004-02-01 | 2005-02-01 |
+		| 2004-02-01/2005       | 2004-02-01 | 2005-01-01 |
+		| 2005/2006-02          | 2005-01-01 | 2006-02-01 |

data/features/parser/precision.feature

@@ -0,0 +1,14 @@
+Feature: Parse masked precision strings
+
+  As a user of edtf-ruby
+  I want to parse masked precision strings
+  
+  Scenario Outline: Masked precision strings
+    When I parse the string "<string>"
+    Then the duration should range from "<start>" to "<end>"
+  
+  @level2 @2041
+  Scenarios: decades and centuries
+    | string | start | end  |
+    | 196x   | 1960  | 1970 |
+    | 19xx   | 1900  | 2000 |

data/features/parser/unspecified.feature

@@ -0,0 +1,19 @@
+Feature: Parse unspecified date strings
+  As a user of EDTF-Ruby
+  I want to be able to parse date strings containing unspecified elements
+  
+  Scenario Outline: parse unspecified dates
+    When I parse the string "<string>"
+    Then the year should be "<year>"
+    And the month should be "<month>"
+    And the day should be "<day>"
+    And the unspecified string code be "<unspecified>"
+  
+    @102 @level1
+    Scenarios: examples from the specification draft
+      | string     | year | month | day | unspecified |
+      | 199u       | 1990 | 1     | 1   | sssu-ss-ss  |
+      | 19uu       | 1900 | 1     | 1   | ssuu-ss-ss  |
+      | 1999-uu    | 1999 | 1     | 1   | ssss-uu-ss  |
+      | 1999-02-uu | 1999 | 2     | 1   | ssss-ss-uu  |
+      | 1999-uu-uu | 1999 | 1     | 1   | ssss-uu-uu  |

data/features/step_definitions/edtf_steps.rb

@@ -0,0 +1,80 @@
+When /^I parse the string "([^"]*)"$/ do |string|
+  @edtf = EDTF.parse(string)
+end
+
+Then /^the year should be "([^"]*)"$/ do |year|
+  @edtf.year.should == year.to_i
+end
+
+Then /^the month should be "([^"]*)"$/ do |month|
+  @edtf.month.should == month.to_i
+end
+
+Then /^the day should be "([^"]*)"$/ do |day|
+  @edtf.day.should == day.to_i
+end
+
+Then /^the hours should be "([^"]*)"$/ do |hours|
+  @edtf.hour.should == hours.to_i
+end
+
+Then /^the year should be "([^"]*)" \(UTC\)$/ do |year|
+  @edtf.to_time.utc.year.should == year.to_i
+end
+
+Then /^the month should be "([^"]*)" \(UTC\)$/ do |month|
+  @edtf.to_time.utc.month.should == month.to_i
+end
+
+Then /^the day should be "([^"]*)" \(UTC\)$/ do |day|
+  @edtf.to_time.utc.day.should == day.to_i
+end
+
+Then /^the hours should be "([^"]*)" \(UTC\)$/ do |hours|
+  @edtf.to_time.utc.hour.should == hours.to_i
+end
+
+
+Then /^the minutes should be "([^"]*)"$/ do |minutes|
+  @edtf.min.should == minutes.to_i
+end
+
+Then /^the seconds should be "([^"]*)"$/ do |seconds|
+  @edtf.sec.should == seconds.to_i
+end
+
+Then /^the duration should range from "([^"]*)" to "([^"]*)"$/ do |*expected|
+  [@edtf.begin.year.to_s, @edtf.end.year.to_s].should == expected
+end
+
+Then /^the interval should start at "([^"]*)"$/ do |date|
+  @edtf.begin.to_s.should == date
+end
+
+Then /^the interval should end at "([^"]*)"$/ do |date|
+  @edtf.end.to_s.should == date
+end
+
+Then /^the date should be uncertain\? "([^"]*)"$/ do |arg1|
+  @edtf.uncertain?.should == !!(arg1 =~ /y(es)?/i)
+end
+
+Then /^the year should be uncertain\? "([^"]*)"$/ do |arg1|
+  @edtf.uncertain?(:year).should == !!(arg1 =~ /y(es)?/i)
+end
+
+Then /^the month should be uncertain\? "([^"]*)"$/ do |arg1|
+  @edtf.uncertain?(:month).should == !!(arg1 =~ /y(es)?/i)
+end
+
+Then /^the day should be uncertain\? "([^"]*)"$/ do |arg1|
+  @edtf.uncertain?(:day).should == !!(arg1 =~ /y(es)?/i)
+end
+
+Then /^the date should be approximate\? "([^"]*)"$/ do |arg1|
+  @edtf.approximate?.should == !!(arg1 =~ /y(es)?/i)
+end
+
+Then /^the unspecified string code be "([^"]*)"$/ do |arg1|
+  @edtf.unspecified.to_s.should == arg1
+end

data/features/support/env.rb

@@ -0,0 +1 @@
+require 'edtf'

data/lib/edtf.rb

@@ -0,0 +1,35 @@
+#--
+# EDTF-Ruby
+# Copyright 2011 Sylvester Keil. All rights reserved.
+#++
+
+require 'date'
+autoload :Rational, 'rational'
+
+require 'forwardable'
+
+require 'edtf/version'
+require 'edtf/uncertainty'
+require 'edtf/seasons'
+require 'edtf/date'
+require 'edtf/interval'
+require 'edtf/parser'
+require 'edtf/extensions'
+
+# = EDTF-Ruby
+#
+# This module extends the Ruby date/time classes to support the Extended
+# Date/Time Format (EDTF). See the `EDTF::ExtendedDate` module for an
+# overview of the features added to the Ruby `Date` class.
+#
+# To parse EDTF strings use either `Date.edtf` of `EDTF.parse`.
+#
+module EDTF
+  
+  def parse(input, options = {})
+    ::Date.edtf(input, options)
+  end
+  
+  module_function :parse
+  
+end