eventual 0.4.9 → 0.5.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,22 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+eventual.gemspec
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Macario Ortega
+
+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

@@ -9,75 +9,114 @@ Reconocimiento de fechas y periodos en lenguaje natural. Útil para crear interf
 == SINOPSIS:
 
 El método event_parse del modulo Eventual reconoce y convierte una fecha o periodo expresado en lenguaje natural en objetos _Date_ o _DateTime_
-Ejemplos:
 
+Ejemplos:
   require 'rubygems'
-  require 'eventual'
+  require 'eventual' 
 
-  Eventual.event_parse( 'del 5 al 7 de junio' )
+  EsDatesParser.new.parse( 'del 5 al 7 de junio del 2009' ).map
   => [#<DateTime: 4909975/2,0,2299161>, #<DateTime: 4909977/2,0,2299161>, #<DateTime: 4909979/2,0,2299161>]
   
-  Eventual.event_parse( 'del 5 al 7 de junio 2009', Date )
-  => [#<Date: 4909975/2,0,2299161>, #<Date: 4909977/2,0,2299161>, #<Date: 4909979/2,0,2299161>]
+  # Si no se especifica el año se usará el año actual
+  EsDatesParser.new.parse( 'del 5 al 7 de junio' ).map{ |d| d.to_s } # Quizá mas tarde se localize a otros idiomas
+  => ["2010-06-05", "2010-06-06", "2010-06-07"]
+  
+  # Se puede especificar un año por omisión
+  dates      = EsDatesParser.new.parse( 'del 5 al 7 de junio' )
+  dates.year = 2007
+  dates.map{ |d| d.to_s }
+  => ["2007-06-05", "2007-06-06", "2007-06-07"]
   
-  Eventual.event_parse( 'del 5 al 7 de junio del 2009 a las 16:00 y 18:00 horas' ){ |d| d.to_s }
+  # Si se especifica la hora el resultado será un Array de DateTime
+  EsDatesParser.new.parse( 'del 5 al 7 de junio del 2009 a las 16:00 y 18:00 horas' ).map
+  => [#<DateTime: 14729929/6,0,2299161>, #<DateTime: 9819953/4,0,2299161>, #<DateTime: 14729935/6,0,2299161>, #<DateTime: 9819957/4,0,2299161>, #<DateTime: 14729941/6,0,2299161>, #<DateTime: 9819961/4,0,2299161>]
+  
+  EsDatesParser.new.parse( 'del 5 al 7 de junio del 2009 a las 16:00 y 18:00 horas' ).map{ |d| d.to_s }
   => ["2009-06-05T16:00:00+00:00", "2009-06-05T18:00:00+00:00", "2009-06-06T16:00:00+00:00", "2009-06-06T18:00:00+00:00", "2009-06-07T16:00:00+00:00", "2009-06-07T18:00:00+00:00"]
   
-  Eventual.event_parse( 'del 5 al 7 de junio 2009' ){ |d| Eventual::WDAY_LIST[ d.wday ] }
-  => ['viernes', 'sabado', 'domingo']
+  # Se pueden restringir los resultados a ciertos dias
+  EsDatesParser.new.parse('lunes y martes de diciembre del 2001 a las 15:00').map{ |d| d.to_s  }  
+  => ["2010-12-06T15:00:00+00:00", "2010-12-07T15:00:00+00:00", "2010-12-13T15:00:00+00:00", "2010-12-14T15:00:00+00:00", "2010-12-20T15:00:00+00:00", "2010-12-21T15:00:00+00:00", "2010-12-27T15:00:00+00:00", "2010-12-28T15:00:00+00:00"]
   
-Ejemplos de formatos reconocidos:
-
-* 1 de enero
-* 21, 22 y 23 de enero del 2009
-* 21, 22 y 23 de enero a las 20:00 horas
-* 21, 22 y 23 de enero a las 20:00 y 22:00 horas
-* viernes 1, sábado 2, domingo 3 y lunes 4 de enero del 2010
-* martes y miércoles del 1 al 20 de junio del 2009 a las 16:00 y 18:00 horas
-* sábados y domingos del 1 de enero al 31 de diciembre del 2008 a las 16:00
-* sábado y domingo del 1 de enero al 31 de diciembre
-* lunes a viernes del 1 de enero al 31 de diciembre del 2008 a las 16:00
-* todos los sábados de diciembre del 2009
-* lunes a viernes de enero a abril
-* del viernes 1 al domingo 3 de enero del 2010
+  # Se puede checar si las fechas reconocidas incluyen cierta fecha, la comparación es "perezosa" es decir no instancia todos los objetos Date o DateTime 
+  # como hace map y por lo tanto es mas eficiente
+  EsDatesParser.new.parse( 'del 5 al 7 de junio del 2007' ).include? Date.civil(2007, 6, 6)
+  => true
   
-Se puede extender _Date_ y _DateTime_ con Eventual requiriendo 'eventual/date_time' y 'eventual/date':
+  EsDatesParser.new.parse( 'del 5 al 7 de junio del 2007' ).include? Date.civil(2006, 6, 6)
+  => false
   
-  require 'rubygems'
-  require 'eventual'
-  require 'eventual/date_time'
-  require 'eventual/date'
-
-  DateTime.event_parse( 'del 5 al 7 de junio' )
-  => [#<DateTime: 4909975/2,0,2299161>, #<DateTime: 4909977/2,0,2299161>, #<DateTime: 4909979/2,0,2299161>]
+  # Se toma en cuenta la hora
+  EsDatesParser.new.parse( 'del 5 al 7 de junio del 2007 a las 16:00' ).include? DateTime.civil(2007, 6, 6, 16, 0)
+  => true
   
-  Date.event_parse( 'del 5 al 7 de junio 2009' )
-  => [#<Date: 4909975/2,0,2299161>, #<Date: 4909977/2,0,2299161>, #<Date: 4909979/2,0,2299161>]
-
-
-Si se pasa un bloque se puede especificar si se desea usar el texto que sigue a la definición de fechas mediante pasando la opción _use_trailing_ => _true_:
+  EsDatesParser.new.parse( 'del 5 al 7 de junio del 2007 a las 16:00' ).include? DateTime.civil(2007, 6, 6, 15, 0)
+  => false
+  
+  # Si se pasa un Date que corresponda al periodo la comparación es positiva
+  EsDatesParser.new.parse( 'del 5 al 7 de junio del 2007 a las 16:00' ).include? Date.civil(2007, 6, 6)
+  => true
+  
+  # El evento tiene una duración por omisión de 60 minutos
+  EsDatesParser.new.parse( 'del 5 al 7 de junio del 2007 a las 16:00' ).include? DateTime.civil(2007, 6, 6, 16, 59)
+  => true
+  
+  EsDatesParser.new.parse( 'del 5 al 7 de junio del 2007 a las 16:00' ).include? DateTime.civil(2007, 6, 6, 17, 00)
+  => false
+  
+  # Pero se puede cambiar
+  dates           = EsDatesParser.new.parse( 'del 5 al 7 de junio del 2007 a las 16:00' )
+  dates.time_span = 120
+  dates.include? DateTime.civil(2007, 6, 6, 17, 00)
+  => true
+  
+Ejemplos de formatos reconocidos:
 
-  str = "1 de enero del 2009\nSede:El tercer lugar\n2 de enero del 2009\nSede:El tercer lugar"
-  Eventual.event_parse( str, :use_trailing => true ) do |dia, texto_extra|
-    [dia.to_s, texto_extra]
-  end
-  => [["2009-01-01T00:00:00+00:00", "Sede:El tercer lugar"], ["2009-01-02T00:00:00+00:00", "Sede:El tercer lugar"]]
+* marzo
+* marzo de 2009
+* marzo del 2009
+* todo marzo 2009
+* marzo, 2009
+* marzo '09
+* lunes y martes marzo del 2010
+* todos los lunes y martes de marzo del 2010
+* lunes y martes durante marzo del 2010
+* lunes y martes durante todo marzo del 2010
+* lunes y martes, marzo del 2010
+* 21 de marzo
+* 21 marzo
+* domingo 21 de marzo
+* 1, 2 y 3 de marzo
+* 1, 2 y 3 marzo
+* lunes 1, martes 2 y miercoles 3 de marzo
+* 1 al 3 de marzo
+* 1 al 3, marzo
+* del 1 al 3 de marzo
+* del 1 al 3, marzo
+* 24 de febrero al 3 de marzo del 2010
+* 24 de diciembre del 2009 al 3 de enero del 2010
+* lunes y martes del 1 al 22 de marzo del '10
+* fines de semana del 1 al 22 de marzo del '10
+* entre semana del 1 al 22 de marzo del '10
+* lunes y martes del 1 al 22 de marzo del '10
+* todos los lunes y martes del 1 al 22 de marzo del '10
+* los lunes y martes del 1 al 22 de marzo del '10
+* los lunes y los martes del 1 al 22 de marzo del '10
+* lunes y martes de diciembre a las 15
+* lunes y martes de diciembre a las 15:30 hrs.
+* lunes y martes de diciembre a las 15:00 y 16:00 horas
+* lunes y martes de diciembre a las 3 am
+* lunes y martes de diciembre a las 3:15 p.m.
 
 == TODO:
 
-* No estoy seguro de que Iconv funcione en windows, lo arreglaré pronto
-
 Formatos a reconocer
 
-* todos los lunes de junio
-* todo junio
-* domingos de septiembre
-* martes y miércoles de agosto
 * todo el año
 
 == INSTALACIÓN:
 
-  sudo gem install maca-eventual -s http://gems.github.com
+  [sudo] gem install eventual -s http://gemcutter.org
 
 == LICENCIA:
 

data/Rakefile

@@ -1,18 +1,45 @@
-require 'rubygems' unless ENV['NO_RUBYGEMS']
-%w[rake rake/clean fileutils newgem rubigen].each { |f| require f }
-require File.dirname(__FILE__) + '/lib/eventual'
-
-
-$hoe = Hoe.new('eventual', Eventual::VERSION) do |p|
-  p.developer('Macario Ortega', 'macarui@gmail.com')
-  p.changes        = p.paragraphs_of("History.txt", 0..1).join("\n\n")
-  p.rubyforge_name = p.name
-  
-  p.clean_globs |= %w[**/.DS_Store tmp *.log]
-  p.rsync_args   = '-av --delete --ignore-errors'
-end
-
-require 'newgem/tasks' # load /tasks/*.rake
-Dir['tasks/**/*.rake'].each { |t| load t }
-
-task :default => :spec
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name                 = "eventual"
+    gem.summary              = %Q{ Reconocimiento de eventos y periodos de tiempo en lengua natural. Natural date event parsing in spanish so far. }
+    gem.description          = %Q{ Reconocimiento de eventos y periodos de tiempo en lengua natural. Natural date event parsing in spanish so far. }
+    gem.email                = "macarui@gmail.com"
+    gem.homepage             = "http://github.com/maca/eventual"
+    gem.authors              = ["Macario Ortega"]
+    gem.post_install_message = %{ \n\n***********************************\nPor favor tenga en cuenta que el API ha cambiado, consulte la página del proyecto: http://github.com/maca/eventual. English implementation is due.\n***********************************\n\n }
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "eventual #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.5.0

data/lib/eventual/es/event_parser.treetop

@@ -0,0 +1,83 @@
+grammar EsDates
+  rule root
+    (date_list / dates) year? times? <Eventual::Node>
+  end
+
+  rule dates
+    (period / date)
+  end
+  
+  rule period
+    weekdays_constrain? (range / month)
+  end
+  
+  rule date
+    weekday_constrain? day_number month_name?
+  end
+  
+  rule date_list
+    dates (',' space dates)* (space 'y' space dates) / dates (space? "\n" space? dates)*
+  end
+  
+  rule range
+    (('del' / 'de' / ',') space)? (month / date) year? space ('al' / 'a') space (month / date) <Eventual::DatePeriod>
+  end
+
+  rule month
+    month_name '' <Eventual::MonthPeriod>
+  end
+  
+  rule day_number
+    ([0-2] [0-9] / '3' [0-1] / [1-9]) '' <Eventual::Day>
+  end
+  
+  ##########
+  rule times
+    space 'a' space ('las' / 'la') (time_12 / time_24) ((space 'y' / ',') (time_12 / time_24))* <Eventual::Times>
+  end
+  
+  rule time_24
+    space ([0-1] [0-9] / '2' [0-4] / [0-9]) (':' [0-5] [0-9])? (space? ('hrs.' / 'hrs' / 'horas'))? <Eventual::Time>
+  end
+  
+  rule time_12
+    space ('0' [0-9] / '1' [0-2] / [0-9]) (':' [0-5] [0-9])?  space? period:(('a'/'p') '.'? space? 'm' '.'? space?) <Eventual::Time12>
+  end
+
+  ##########
+  rule month_name
+    (((space 'de') / ',')? space)? ('enero' / 'febrero' / 'marzo' / 'abril' / 'mayo' / 'junio' / 'julio' / 'agosto' / 'septiembre' / 'octubre' / 'noviembre' / 'diciembre') <Eventual::MonthName>
+  end
+   
+  rule year
+    ((space 'de' 'l'?) / ',')? space ([1-9] [0-9] [0-9] [0-9] / "'" [0-9] [0-9]) <Eventual::Year>
+  end
+  
+  rule weekdays_constrain
+    wdays_node:(weekday_list / weekdays / weekday) (',' / (space ('del' / 'de' / 'durante todo' / 'durante')))? space <Eventual::WeekdayConstrain>
+  end
+  
+  rule weekday_constrain
+    wdays_node:weekday space <Eventual::WeekdayConstrain>
+  end
+  
+  rule weekday_list
+    (weekday_constrain_sugar? weekday (',' space weekday_constrain_sugar? weekday)* (space 'y' space weekday_constrain_sugar? weekday)?)
+  end
+  
+  rule weekdays
+    weekday_constrain_sugar? ((('dias' space)? 'entre' space 'semana') / 'fines' space 'de' space 'semana')
+  end
+  
+  rule weekday_constrain_sugar
+    (('todos' space)? 'los' space)
+  end
+
+  rule weekday
+    (('lun' 'es'? ) / ('mar' 'tes'? ) / ('mi' 'ercoles'? ) / ('jue' 'ves'? ) / ('vie' 'rnes'? ) / ('sab' 'ado'? 's'? ) / ('dom' 'ingo'? 's'? ))
+  end
+   
+  rule space
+    ' '+
+  end
+end

data/lib/eventual/es.rb

@@ -0,0 +1 @@
+Treetop.load "#{ File.dirname __FILE__ }/es/event_parser"

data/lib/eventual/syntax_nodes.rb

@@ -0,0 +1,217 @@
+module Eventual
+  Weekdays        = %w(domingo lunes martes miércoles jueves viernes sábado).freeze
+  MonthNames      = %w(enero febrero marzo abril mayo junio julio agosto septiembre noviembre).unshift(nil).freeze
+  ShortMonthNames = %w(ene feb mar abr may jun jul ago sept oct nov dic).freeze
+  WdaysR          = [/d/, /l/, /ma/, /mi/, /j/, /v/, /s/].freeze
+  WdayListR       = /\b(?:#{ WdaysR.join('|') })/.freeze
+  
+  class WdayMatchError < StandardError
+    def initialize value, wday_index
+      @value, @wday_index = value, wday_index
+    end
+    
+    def to_s
+      "El #{@value.day} de #{MonthNames[@value.month]} del #{@value.year} cae en #{Weekdays[@value.wday]} no #{Weekdays[@wday_index]}"
+    end
+  end
+  
+  class Year < Treetop::Runtime::SyntaxNode
+    def value
+      match  = text_value.match(/(')?(\d{2,4})/)
+      value  = match[2].to_i
+      value += 2000 if match[1]
+      value
+    end
+  end
+  
+  class WeekdayConstrain < Treetop::Runtime::SyntaxNode
+    def value
+      text    = wdays_node.text_value.sub('semana', '')
+      days    = text.scan(WdayListR).map{ |d| WdaysR.index /#{d}/ }
+      days   += (1..5).map if text.include?('entre')
+      days   += [6,0] if text.include?('fines')
+      days.uniq
+    end
+  end
+  
+  class MonthName < Treetop::Runtime::SyntaxNode
+    def value
+      ShortMonthNames.index(text_value.downcase.match(/#{ ShortMonthNames.join('|') }/).to_s) + 1
+    end
+  end
+   
+  class Node < Treetop::Runtime::SyntaxNode
+    attr_accessor :year
+    attr_accessor :time_span
+    
+    attr_accessor :month
+    attr_accessor :weekdays
+    attr_accessor :times
+    
+    def last
+      to_a.last
+    end
+    
+    def first
+      to_a.first
+    end
+    
+    def to_a
+      map
+    end
+    
+    def date_within_weekdays? date
+      return true unless weekdays
+      weekdays.include?(date.wday)
+    end
+    
+    def map &block
+      walk { |elements| elements.map &block }
+    end
+    
+    def include? date
+      result = false
+      walk { |elements| break result = true if elements.include? date }
+      
+      unless date.class == Date or times.nil? or times.empty?
+        @time_span ||= 60
+        within_time = times.inject(nil) { |memo, time|
+          first = ::Time.local date.year, date.month, date.day, time.hour, time.minute
+          time  = ::Time.local date.year, date.month, date.day, date.hour, date.min
+          break true if time >= first and time < first + 60 * @time_span
+        }
+        return false unless within_time
+      end
+      result
+    end
+    
+    private
+    def walk &block
+      year  = self.year || Date.today.year
+      month = nil
+          
+      walk  = lambda do |elements|
+        break unless elements
+        weekdays = elements.first.value if elements.first.class == WeekdayConstrain
+        
+        elements.reverse.map do |element|
+          case element
+          when Day, Period
+            element.weekdays = weekdays
+            element.year     = year
+            element.month    = month
+            element.times    = @times
+            
+            yield element
+          when Year
+            year  = element.value
+            next nil
+          when MonthName
+            month = element.value
+            next nil
+          when WeekdayConstrain
+            next nil
+          when Times
+            @times = element.map
+            next nil
+          else
+            walk.call element.elements
+          end
+        end.reverse
+      end
+      walk.call(elements).flatten.compact
+    end
+  end
+
+  class Day < Node
+    def map &block
+      dates = times ? times.map{ |time| DateTime.civil year, month, text_value.to_i, time.hour, time.minute } : [Date.civil(year, month, text_value.to_i)]
+      raise WdayMatchError.new(dates.first, weekdays.first) unless date_within_weekdays? dates.first
+      dates.map(&block)
+    end
+    
+    def include? date
+      to_a.include? date
+    end
+  end
+
+  class Period < Node
+    def range
+      (first..last)
+    end
+    
+    def include? date
+      return false unless date_within_weekdays? date
+      range.include? date
+    end
+    
+    alias node_map map
+    private :node_map
+    
+    def map
+      array = []
+      range.each do |date|
+        next unless date_within_weekdays? date
+        next array.push(block_given? ? yield(date) : date) unless times
+        
+        times.each do |time|
+          new_date = DateTime.civil date.year, date.month, date.day, time.hour, time.minute
+          array.push block_given? ? yield(new_date) : new_date
+        end
+      end
+      array
+    end
+  end
+    
+  class MonthPeriod < Period
+    def first
+      return Date.civil(year, month_name.value) unless times and !times.empty?
+      time = times.first
+      return DateTime.civil(year, month_name.value, 1, time.hour, time.minute)
+    end
+    
+    def last
+      date = (first >> 1) - 1
+      return date unless times and !times.empty?
+      time = times.last
+      DateTime.civil(date.year, date.month, date.day, time.hour, time.minute)
+    end
+  end
+
+  class DatePeriod < Period
+    def first
+      node_map.first
+    end
+    
+    def last
+      node_map.last
+    end
+  end
+
+  class Times < Treetop::Runtime::SyntaxNode
+    def map
+      walk_times = lambda do |elements|
+        break unless elements
+        elements.map { |e| Time === e ? e.value : walk_times.call(e.elements) }
+      end
+      walk_times.call(elements).flatten.compact.sort_by{ |t| '%02d%02d' % [t.hour, t.minute] }
+    end
+  end
+  
+  class Time < Treetop::Runtime::SyntaxNode
+    attr_accessor :hour, :minute
+    def value
+      @hour, @minute = text_value.scan(/\d+/).map(&:to_i)
+      @minute ||= 0
+      self
+    end
+  end
+
+  class Time12 < Time
+    def value
+      super
+      @hour += 12 if period.text_value.gsub(/[^a-z]/, '') == 'pm'
+      self
+    end
+  end
+end