edtf 0.0.8 → 0.0.9

data/README.md

@@ -21,10 +21,6 @@ EDTF-Ruby parser implements all levels and features of the EDTF specification
   nested expressions (the parser will not accept some of the more complex
   examples, though).
 
-The level 2 list extensions (203 and 204) currently return simple Ruby arrays;
-therefore, advanced behavior (such as 'earlier' or 'later') is parsed correctly
-but not yet exposed by the Ruby API.
-
 EDTF-Ruby has been confirmed to work on the following Ruby implementations:
 1.9.3, 1.9.2, 1.8.7, Rubinius, and JRuby. Active Support's date extensions
 are currently listed as a dependency, because of a number of many functional
@@ -39,8 +35,9 @@ You can access parse EDTF strings either using `Date.edtf` or `EDTF.parse`
 (both methods come with an alternative bang! version, that will raise an error
 if the string cannot be parsed instead of silently returning nil); if
 given a valid EDTF string the return value will either be an (extended) `Date`,
-`EDTF::Interval` or `Range` (for masked precision strings) instance. Given
-a Date, you can print the corresponding EDTF string using the `#edtf` method.
+`EDTF::Interval`, `EDTF::Set`, or `Range` (for masked precision strings)
+instance. Given a Date, you can print the corresponding EDTF string using the
+`#edtf` method.
 
     $ [sudo] gem install edtf
     $ irb
@@ -86,6 +83,21 @@ a Date, you can print the corresponding EDTF string using the `#edtf` method.
     => true # an open ended interval covers today
     > Date.edtf("(1999-(02)~-23)?").edtf
     => "1999?-(02)?~-23?" # when printing, EDTF-Ruby reduces nested parentheses
+    > s = Date.edtf('{1667,1668, 1670..1672}')
+    > s.include?(Date.edtf('1669'))
+    => false
+    > s.include?(Date.edtf('1671'))
+    => true # the range is enumerated for membership tests
+    > s.length
+    => 3 # but we're still aware that there were only three elements
+    > s.map(&:year)
+    => [1667, 1668, 1670, 1671, 1672] # when enumerated there are 5 elements
+    > s.earlier?
+    => false # the original list was not vague
+    > s.earlier! # but we can make it so
+    > s.edtf
+    => "{..1667, 1668, 1670..1672}"
+
 
 For additional features take a look at the documentation or the extensive
 list of rspec examples.

data/lib/edtf.rb

@@ -40,6 +40,7 @@ autoload :Rational, 'rational'
 
 require 'forwardable'
 require 'enumerator'
+require 'set'
 
 require 'active_support/core_ext/date/calculations'
 require 'active_support/core_ext/date_time/calculations'
@@ -56,6 +57,7 @@ require 'edtf/date_time'
 require 'edtf/epoch'
 require 'edtf/season'
 require 'edtf/interval'
+require 'edtf/set'
 require 'edtf/parser'
 require 'edtf/extensions'
 

data/lib/edtf/extensions.rb

@@ -0,0 +1,11 @@
+
+class Range
+	
+	def edtf
+		[
+			self.begin.respond_to?(:edtf) ? self.begin.edtf : self.begin.to_s,
+			self.end.respond_to?(:edtf) ? self.end.edtf : self.end.to_s
+		].join(exclude_end? ? '...' : '..')
+	end
+	
+end

data/lib/edtf/parser.y

@@ -219,29 +219,32 @@ rule
     ;
 
 
-  choice_list : '[' list ']' { result = val[1] }
+  choice_list : '[' list ']'   { result = val[1].choice! }
 
   inclusive_list : '{' list '}' { result = val[1] }
 
-  list : earlier                              { result = val }
-       | earlier ',' list_elements ',' later  { result = [val[0]] + val[2] + [val[4]] }
-       | earlier ',' list_elements            { result = [val[0]] + val[2] }
-       | earlier ',' later                    { result = [val[0]] + [val[2]] }
-       | list_elements ',' later              { result = val[0] + [val[2]] }
-       | list_elements
-       | later                                { result = val }
+  list : earlier                              { result = EDTF::Set.new(val[0]).earlier! }
+       | earlier ',' list_elements ',' later  { result = EDTF::Set.new([val[0]] + val[2] + [val[4]]).earlier!.later! }
+       | earlier ',' list_elements            { result = EDTF::Set.new([val[0]] + val[2]).earlier! }
+       | earlier ',' later                    { result = EDTF::Set.new([val[0]] + [val[2]]).earlier!.later! }
+       | list_elements ',' later              { result = EDTF::Set.new(val[0] + [val[2]]).later! }
+       | list_elements                        { result = EDTF::Set.new(*val[0]) }
+       | later                                { result = EDTF::Set.new(val[0]).later! }
        ;
         
   list_elements : list_element                   { result = [val[0]].flatten }
                 | list_elements ',' list_element { result = val[0] + [val[2]].flatten }
                 ;
-             
-  list_element : date
-               | partial_uncertain_or_approximate
-               | unspecified
-               | consecutives { result = val[0].map { |d| Date.new(*d) } }
+     
+  list_element : atomic
+               | consecutives
                ;
 
+  atomic : date
+         | partial_uncertain_or_approximate
+         | unspecified
+         ;
+
   earlier : DOTS date { result = val[1] }
 
   later : year_month_day DOTS { result = Date.new(*val[0]).year_precision! }
@@ -249,9 +252,9 @@ rule
         | year DOTS           { result = Date.new(val[0]).year_precision! }
         ;
 
-  consecutives : year_month_day DOTS year_month_day
-               | year_month DOTS year_month
-               | year DOTS year { result = (val[0]..val[2]).to_a.map }
+  consecutives : year_month_day DOTS year_month_day { result = (Date.new(val[0]).day_precision! .. Date.new(val[2]).day_precision!) }
+               | year_month DOTS year_month         { result = (Date.new(val[0]).month_precision! .. Date.new(val[2]).month_precision!) }
+               | year DOTS year                     { result = (Date.new(val[0]).year_precision! .. Date.new(val[2]).year_precision!) }
                ;
 
   partial_unspecified :

data/lib/edtf/set.rb

@@ -0,0 +1,79 @@
+module EDTF
+	
+	class Set
+		extend Forwardable
+		
+		include Enumerable
+		include Comparable
+				
+		def_delegators :@dates, :size, :length, :empty?
+		def_delegators :to_a, :include?
+		
+		attr_accessor :choice, :later, :earlier
+		
+		
+		def initialize(*dates)
+			@dates = ::Set.new(dates.flatten)
+			@choice, @later, @earlier = false, false, false
+		end
+		
+		def initialize_copy(other)
+			@set = other.to_set
+		end
+
+		[:choice, :later, :earlier].each do |m|
+			define_method("#{m}?") { send(m) }
+			define_method("#{m}!") do
+				send("#{m}=", true)
+				self
+			end
+		end
+
+		def <<(date)
+			dates << date
+			self
+		end
+		
+		def each
+			if block_given?
+				to_a.each(&Proc.new)
+				self
+			else
+				to_enum
+			end
+		end
+		
+		def edtf
+			parenthesize(dates.map { |d| d.respond_to?(:edtf) ? d.edtf : d.to_s }.join(', '))
+		end
+		
+		def to_a
+			dates.map { |d| Array(d) }.flatten
+		end
+		
+		def to_set
+			to_a.to_set
+		end
+		
+		alias to_s edtf
+		
+		def <=>(other)
+			return nil unless other.respond_to?(:to_a)
+			to_a <=> other.to_a
+		end
+		
+		private
+				
+		attr_reader :dates
+		
+		def parenthesize(string)
+			p = choice? ? %w([ ]) : %w({ })
+			p[-1,0] = '..' if earlier?
+			p[-1,0] = string unless string.empty?
+			p[-1,0] = '..' if later?
+			p.join
+		end
+				
+	end
+	
+end

data/lib/edtf/version.rb

@@ -1,3 +1,3 @@
 module EDTF
-  VERSION = '0.0.8'.freeze
+  VERSION = '0.0.9'.freeze
 end

data/spec/edtf/interval_spec.rb

@@ -39,7 +39,7 @@ module EDTF
       end
       
       it 'does not include christmas day 2009' do
-        interval.should_not include(Date.new(2009,12,24))
+        interval.should_not be_include(Date.new(2009,12,24))
       end
 
  			it 'christmas day 2009 is less than max' do
@@ -51,11 +51,11 @@ module EDTF
 			end
      
       it 'covers christmas day 2009' do
-        interval.should cover(Date.new(2009,12,24))
+        interval.should be_cover(Date.new(2009,12,24))
       end
 			
       it 'covers 2011-12-31' do
-        interval.should cover(Date.new(2011,12,31))
+        interval.should be_cover(Date.new(2011,12,31))
       end
 
     end
@@ -64,15 +64,15 @@ module EDTF
       let(:interval) { Date.edtf('2008-08-23/2011-07-01') }
       
       it 'includes christmas day 2009' do
-        interval.should include(Date.new(2009,12,24))
+        interval.should be_include(Date.new(2009,12,24))
       end
       
       it 'covers christmas day 2009' do
-        interval.should cover(Date.new(2009,12,24))
+        interval.should be_cover(Date.new(2009,12,24))
       end
 
       it 'does not cover 2011-07-02' do
-        interval.should_not cover(Date.new(2011,07,02))
+        interval.should_not be_cover(Date.new(2011,07,02))
       end
     end
 
@@ -94,15 +94,15 @@ module EDTF
 			end
 			
       it 'includes christmas day 2009' do
-        interval.should include(Date.new(2009,12,24))
+        interval.should be_include(Date.new(2009,12,24))
       end
       
       it 'covers christmas day 2009' do
-        interval.should cover(Date.new(2009,12,24))
+        interval.should be_cover(Date.new(2009,12,24))
       end
 
       it 'covers 2023-07-02' do
-        interval.should cover(Date.new(2023,07,02))
+        interval.should be_cover(Date.new(2023,07,02))
       end
 			
 		end    

data/spec/edtf/set_spec.rb

@@ -0,0 +1,73 @@
+module EDTF
+  describe 'Sets' do
+	
+		describe 'constructor' do
+			
+			it 'creates a new empty set by default' do
+				Set.new.should be_empty
+			end
+			
+		end
+	
+		describe '#edtf' do
+			
+			it 'returns {} by default' do
+				Set.new.edtf.should == '{}'
+			end
+
+			it 'returns [] for empty choice lists' do
+				Set.new.choice!.edtf.should == '[]'
+			end
+			
+			it 'returns {1984} if the set contains the year 1984' do
+				Set.new(Date.edtf('1984')).edtf.should == '{1984}'
+			end
+			
+			it 'returns {1984, 1985-10} for the set containing these dates' do
+				Set.new(Date.edtf('1984'), Date.new(1984,10).month_precision).edtf.should == '{1984, 1984-10}'
+			end
+
+			it 'returns {..1984, 1985-10} for the set containing these dates and earlier == true' do
+				Set.new(Date.edtf('1984'), Date.new(1984,10).month_precision).earlier!.edtf.should == '{..1984, 1984-10}'
+			end
+
+			it 'returns {1984, 1985-10..} for the set containing these dates and later == true' do
+				Set.new(Date.edtf('1984'), Date.new(1984,10).month_precision).later!.edtf.should == '{1984, 1984-10..}'
+			end
+
+			it 'returns [1667, 1668, 1670..1672] for the years 1667, 1668 and the interval 1670..1672' do
+				s = Set.new.choice!
+				s << Date.edtf('1667') << Date.edtf('1668')
+				s << (Date.edtf('1670') .. Date.edtf('1672'))
+				s.edtf.should == '[1667, 1668, 1670..1672]'
+			end
+			
+		end
+		
+		describe 'the set [1667, 1668, 1670..1672]' do
+			let(:set) { Set.new(Date.edtf('1667'), Date.edtf('1668'), Date.edtf('1670')..Date.edtf('1672')).choice! }
+		
+			it 'includes the year 1671' do
+				set.should include(Date.new(1671).year_precision!)
+			end
+
+			it 'does not include the date 1671-01-01' do
+				set.should_not include(Date.new(1671))
+			end
+
+			it 'does not include the year 1669' do
+				set.should_not include(Date.new(1669).year_precision!)
+			end
+			
+			it 'has a length of 3' do
+				set.should have(3).elements
+			end
+			
+			it 'maps to the year array [1667, 1668, 1670, 1671, 1672]' do
+				set.map(&:year).should == [1667, 1668, 1670, 1671, 1672]
+			end
+		
+		end
+		
+	end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: edtf
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2011-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70235877316060 !ruby/object:Gem::Requirement
+  requirement: &70355024984460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70235877316060
+  version_requirements: *70355024984460
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70235877525400 !ruby/object:Gem::Requirement
+  requirement: &70355024983720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '0.9'
   type: :development
   prerelease: false
-  version_requirements: *70235877525400
+  version_requirements: *70355024983720
 - !ruby/object:Gem::Dependency
   name: racc
-  requirement: &70235877523860 !ruby/object:Gem::Requirement
+  requirement: &70355024982860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '1.4'
   type: :development
   prerelease: false
-  version_requirements: *70235877523860
+  version_requirements: *70355024982860
 - !ruby/object:Gem::Dependency
   name: cucumber
-  requirement: &70235877522840 !ruby/object:Gem::Requirement
+  requirement: &70355024981980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *70235877522840
+  version_requirements: *70355024981980
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70235877521760 !ruby/object:Gem::Requirement
+  requirement: &70355024981220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: '2.6'
   type: :development
   prerelease: false
-  version_requirements: *70235877521760
+  version_requirements: *70355024981220
 - !ruby/object:Gem::Dependency
   name: ZenTest
-  requirement: &70235877521200 !ruby/object:Gem::Requirement
+  requirement: &70355024980360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,7 +76,7 @@ dependencies:
         version: '4.6'
   type: :development
   prerelease: false
-  version_requirements: *70235877521200
+  version_requirements: *70355024980360
 description: A Ruby implementation of the Extended Date/Time Format (EDTF).
 email:
 - http://sylvester.keil.or.at
@@ -115,6 +115,7 @@ files:
 - lib/edtf/interval.rb
 - lib/edtf/parser.y
 - lib/edtf/season.rb
+- lib/edtf/set.rb
 - lib/edtf/uncertainty.rb
 - lib/edtf/version.rb
 - spec/edtf/date_spec.rb
@@ -122,6 +123,7 @@ files:
 - spec/edtf/interval_spec.rb
 - spec/edtf/parser_spec.rb
 - spec/edtf/season_spec.rb
+- spec/edtf/set_spec.rb
 - spec/edtf/uncertainty_spec.rb
 - spec/spec_helper.rb
 - lib/edtf/parser.rb
@@ -147,7 +149,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -533372685399765203
+      hash: -1918843685167052448
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -156,7 +158,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -533372685399765203
+      hash: -1918843685167052448
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.10
@@ -181,5 +183,6 @@ test_files:
 - spec/edtf/interval_spec.rb
 - spec/edtf/parser_spec.rb
 - spec/edtf/season_spec.rb
+- spec/edtf/set_spec.rb
 - spec/edtf/uncertainty_spec.rb
 - spec/spec_helper.rb