natural-date 1.2 → 1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 542d489e665790093de2be56251385422e79d4e2
-  data.tar.gz: 7ee809b6b7bfad9535bdca731effad0bef68108e
+  metadata.gz: c67af377850cb1f455ec9f16d20b11d46775ce32
+  data.tar.gz: 8fee5e98a916dee160b302a2e951862b1a9e9097
 SHA512:
-  metadata.gz: 55711080ed2742f5ed38ecacc94db1a9ef9a45035d0714151146f46dd6e88ca2214d3f77fd40025e647713641e95ced01939ee487223071bb72608f48ca4d06c
-  data.tar.gz: f83fbd5aae5cd47e64a3b50ecdaf599de0dc6ee7143b10e33a894d51784351739203579f9a97cfe72f3357cd21aa299358999dc32c6ca486d3546543e29847f4
+  metadata.gz: 710e4c81e0f646632c199ee1a2203d6a9cefedf2ab12c43799ea9a037c29d8e5eb9c4648e0b193accf74d2a30e701c709073eca689bb3ba304335d86153efd67
+  data.tar.gz: 1996da7c86a768655b85c8b3de403fd29eb52e73841375022cc19f68206114e43b6856a5c7cf89bca9fa1c297ffeda80a693413835b12a0a9a4b404cc579e5ac

data/README.md

@@ -1,7 +1,7 @@
 # Natural Date - Alpha
 
-Natural language date/time parser in Ruby. `natural-date` can convert from plain text to date expressions that can 
-symbolize since single dates till recurrent dates.
+Natural language date parser in Ruby. `natural-date` can convert from plain text to date expressions that can 
+symbolize both single dates and recurrent dates.
 
 ## Installation
 
@@ -50,9 +50,10 @@ natural_date.match?(Date.new(2017, 8, 1))
 natural_date.fetch_dates(Date.today..(Date.today + 5))
 # => array with dates matched inside the interval
 
-# If you don't pass any interval a default interval of Date.today..Date.today + 365 will be given
+# If you don't pass any interval a default interval of reference_date..reference_date + 365 will be given
 natural_date.fetch_dates
 # => array with dates matched inside the interval
+
 ```
 
 ## Types of expressions
@@ -63,9 +64,10 @@ refer both single and recurring dates.
   - **Days**: Can be written as numbers `1..31` or ordinals like `['1st'..'31st']`.
   - **Months**: Can be written using the whole name `['January'..'December']` or using the first 3 letters `['Jan'..'Dec']`, also they are case insensitive `'JAN' == 'Jan' == 'jAn'` also you can use numbers if you use the 'of' world before `'1 of 12' == '1st December'`.
   - **Years**: You can write the year as usual 4 digits number like `2016` or you can ignore the year, if you ignore it the year is going to be guessed based on the expression and the reference date
-  - **Week Days**: As months you can write both whole name and abbreviation (first 3 letters) 'monday' == 'mon'.
+  - **Week Days**: As months you can write both whole name and abbreviation (first 3 letters) `'monday' == 'mon'`.
 
 ```ruby
+# first you need to create a Factory based on a language, nowadays only english and brazilian portuguese are available.
 factory = NaturalDateExpressionFactory.new(:en)
 
 # Day and month
@@ -105,6 +107,13 @@ factory.create('every monday of January')
 # => every monday of January any year
 factory.create('every monday and friday')
 # => every monday and friday of any month and any year.
+
+# You can also pass several dates expressions using a ';' or a '\n' to separate them
+factory.create('1 2 of May 2016 ; 3 4 June 2016')
+# => ['1st May 2016', '2nd May 2016', '3rd June 2016', '4th June 2016']
+
+factory.create("1 May 2016\n4 June 2016")
+# => ['1st May 2016', '4th June 2016']
 ```
 
 ## Contributing

data/lib/natural-date.rb

@@ -7,9 +7,13 @@ require 'natural-date/translator/mod_applier'
 require 'natural-date/translator/mounter'
 require 'natural-date/translator/normalizer'
 require 'natural-date/translator/splitter_literal_date'
-require 'natural-date/translator/time_mounter'
 require 'natural-date/translator/unknown_cleaner'
 require 'natural-date/translator/year_finder'
+require 'natural-date/matcher/week_matcher'
+require 'natural-date/matcher/month_matcher'
+require 'natural-date/matcher/literal_matcher'
+require 'natural-date/matcher/day_matcher'
+require 'natural-date/matcher/year_matcher'
 require 'natural-date/language_bundle'
 require 'natural-date/natural_date_expression_factory'
 require 'natural-date/natural_date_expression'

data/lib/natural-date/matcher/day_matcher.rb

@@ -0,0 +1,5 @@
+module DayMatcher
+  def self.match? date, reference_date, expression_map
+    !expression_map[:day] || expression_map[:day].include?(date.day)
+  end
+end

data/lib/natural-date/matcher/literal_matcher.rb

@@ -0,0 +1,6 @@
+module LiteralMatcher
+  def self.match? date, expression_map
+    # TODO
+    !expression_map[:literal] || expression_map[:literal].any? { |token| match_literal_token?(token, args) }
+  end
+end

data/lib/natural-date/matcher/month_matcher.rb

@@ -0,0 +1,5 @@
+module MonthMatcher
+  def self.match? date, reference_date, expression_map
+    !expression_map[:month] || expression_map[:month].include?(date.month)
+  end
+end

data/lib/natural-date/matcher/week_matcher.rb

@@ -0,0 +1,35 @@
+module WeekMatcher
+  def self.match? date, reference_date, expression_map
+    !expression_map[:week_day] || expression_map[:week_day].any? { |token| match_week_token?(token, date) }
+  end
+
+  private
+
+  def self.match_month? date, expression_map
+    !expression_map[:month] || expression_map[:month].include?(date.month)
+  end
+
+  def self.match_week_token? token, date
+    return match_nth_week_token?(token, date) if token.to_s.include?('.')
+    token.to_i == date.wday
+  end
+
+  def self.match_nth_week_token? token, date
+    nth, token_wday = token.split('.')
+
+    wdays = (date.beginning_of_month..date.end_of_month).to_a.select do |day|
+      day.wday == token_wday.to_i
+    end
+
+    case nth
+    when 'first_1'
+      wdays.first == date
+    when 'last_999'
+      wdays.last == date
+    when 'prior_last_999'
+      wdays[wdays.size - 2] == date
+    else
+      wdays[nth.to_i - 1] == date
+    end
+  end
+end

data/lib/natural-date/matcher/year_matcher.rb

@@ -0,0 +1,12 @@
+module YearMatcher
+  def self.match? date, reference_date, expression_map
+    return expression_map[:year].include?(date.year) if expression_map[:year]
+    return true if expression_map[:week_day] || !expression_map[:day] || !expression_map[:month]
+
+    require 'pry'
+
+    binding.pry unless date
+
+    date.year == reference_date.year
+  end
+end

data/lib/natural-date/natural_date_expression.rb

@@ -1,5 +1,5 @@
 class NaturalDateExpression
-  VERSION = "1.2"
+  VERSION = "1.3"
 
   class DateMatch
     attr_reader :first_matched_expression, :tested_date, :reference_date
@@ -30,13 +30,16 @@ class NaturalDateExpression
     match(date).matches?
   end
 
+  MATCHERS = [
+    WeekMatcher,
+    MonthMatcher,
+    DayMatcher,
+    YearMatcher
+  ].freeze
+
   def match date
     matches = @data.map do |expression_map|
-      match_week?(date, expression_map) &&
-        match_month?(date, expression_map) &&
-        match_literal?(date, expression_map) &&
-        match_day?(date, expression_map) &&
-        match_year?(date, expression_map)
+      MATCHERS.map { |matcher| matcher.match?(date, @reference_date, expression_map) }.all?
     end
 
     DateMatch.new(matches.any?,
@@ -54,55 +57,6 @@ class NaturalDateExpression
   end
 
   def fetch_dates dates_range = nil
-    (dates_range || (Date.today..(Date.today + 365))).to_a.select { |date| self =~ date }
-  end
-
-  private
-
-  def match_year? date, expression_map
-    return expression_map[:year].include?(date.year) if expression_map[:year]
-    return true if expression_map[:week_day] || !expression_map[:day] || !expression_map[:month]
-
-    date.year == @reference_date.year
-  end
-
-  def match_day? date, expression_map
-    !expression_map[:day] || expression_map[:day].include?(date.day)
-  end
-
-  def match_literal? date, expression_map
-    !expression_map[:literal] || expression_map[:literal].any? { |token| match_literal_token?(token, args) }
-  end
-
-  def match_week? date, expression_map
-    !expression_map[:week_day] || expression_map[:week_day].any? { |token| match_week_token?(token, date) }
-  end
-
-  def match_month? date, expression_map
-    !expression_map[:month] || expression_map[:month].include?(date.month)
-  end
-
-  def match_week_token? token, date
-    return match_nth_week_token?(token, date) if token.to_s.include?('.')
-    token.to_i == date.wday
-  end
-
-  def match_nth_week_token? token, date
-    nth, token_wday = token.split('.')
-
-    wdays = (date.beginning_of_month..date.end_of_month).to_a.select do |day|
-      day.wday == token_wday.to_i
-    end
-
-    case nth
-    when 'first_1'
-      wdays.first == date
-    when 'last_999'
-      wdays.last == date
-    when 'prior_last_999'
-      wdays[wdays.size - 2] == date
-    else
-      wdays[nth.to_i - 1] == date
-    end
+    (dates_range || (@reference_date..(@reference_date + 365))).to_a.select { |date| self =~ date }
   end
 end

data/lib/natural-date/natural_date_expression_factory.rb

@@ -3,15 +3,15 @@ class NaturalDateExpressionFactory
     @lang = lang
   end
 
-  STEPS = {}
-  EXPRESSION_SPLITTER_STEP = {}
-
   def create expression_string, reference_date = Date.today
     NaturalDateExpression.new(create_data_expression(expression_string, reference_date), reference_date, expression_string)
   end
 
   private
 
+  STEPS = {}
+  EXPRESSION_SPLITTER_STEP = {}
+
   def create_data_expression expression_string, reference_date
     expression_splitter.map(expression_string.to_s).map do |expression|
       steps.reduce(expression) do |tokens, step|
@@ -40,7 +40,6 @@ class NaturalDateExpressionFactory
     [ Translator::Cleaner,
       Translator::SplitterLiteralDate,
       Translator::Mounter,
-      Translator::TimeMounter,
       Translator::Normalizer,
       Translator::Expander,
       Translator::ModApplier,

data/lib/natural-date/translator/en.yml

@@ -9,13 +9,13 @@ keys:
     last_999: 'last'
     of_month: 'of month'
   week_day:
-    sun_0: 'sunday sun'
-    mon_1: 'monday mon'
-    tue_2: 'tuesday tue'
-    wed_3: 'wednesday wed'
-    thu_4: 'thursday thu'
-    fri_5: 'friday fri'
-    sat_6: 'saturday sat'
+    sun_0: 'sunday sundays sun'
+    mon_1: 'monday mondays mon'
+    tue_2: 'tuesday tuesdays tue'
+    wed_3: 'wednesday wednesdays wed'
+    thu_4: 'thursday thursdays thu'
+    fri_5: 'friday fridays fri'
+    sat_6: 'saturday saturdays sat'
   day:
     day_1: '1 1th 1st'
     day_2: '2 2th 2nd'
@@ -49,7 +49,7 @@ keys:
     day_30: '30 30th'
     day_31: '31 31th 31st'
   month:
-    jan_1: 'jan janeiro'
+    jan_1: 'jan january'
     feb_2: 'feb february'
     mar_3: 'mar march'
     apr_4: 'apr april'

data/natural-date.gemspec

@@ -25,4 +25,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.13"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry", "~> 0.10.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: natural-date
 version: !ruby/object:Gem::Version
-  version: '1.2'
+  version: '1.3'
 platform: ruby
 authors:
 - Andrew S Aguiar
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-10 00:00:00.000000000 Z
+date: 2016-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
 description: Natural language date/time parser in Ruby. natural-date can convert from
   plain text to date expressions symbolizing since single dates till recurrent dates
 email:
@@ -72,9 +86,13 @@ files:
 - bin/setup
 - lib/natural-date.rb
 - lib/natural-date/language_bundle.rb
+- lib/natural-date/matcher/day_matcher.rb
+- lib/natural-date/matcher/literal_matcher.rb
+- lib/natural-date/matcher/month_matcher.rb
+- lib/natural-date/matcher/week_matcher.rb
+- lib/natural-date/matcher/year_matcher.rb
 - lib/natural-date/natural_date_expression.rb
 - lib/natural-date/natural_date_expression_factory.rb
-- lib/natural-date/translator.rb
 - lib/natural-date/translator/cleaner.rb
 - lib/natural-date/translator/en.yml
 - lib/natural-date/translator/expander.rb
@@ -86,7 +104,6 @@ files:
 - lib/natural-date/translator/pt-BR.yml
 - lib/natural-date/translator/splitter_literal_date.rb
 - lib/natural-date/translator/step.rb
-- lib/natural-date/translator/time_mounter.rb
 - lib/natural-date/translator/unknown_cleaner.rb
 - lib/natural-date/translator/year_finder.rb
 - natural-date.gemspec

data/lib/natural-date/translator.rb

@@ -1,2 +0,0 @@
-module Translator
-end

data/lib/natural-date/translator/time_mounter.rb

@@ -1,55 +0,0 @@
-module Translator
-  class TimeMounter < Step
-    def map tokens, reference_date
-      tokens
-        .map { |token| normalize(token) }
-    end
-
-    private
-
-    def normalize token
-      case token.first
-      when :unknown
-        if time? token
-          [:time, create_token_value(token.last.upcase)]
-        else
-          token
-        end
-      else token
-      end
-    end
-
-    def time? token
-      token_key = token.last.to_s.upcase
-
-      %w(H AM PM :).any? do |s|
-        token.last.to_s.upcase.include? s
-      end
-    end
-
-    def create_token_value raw_value
-      if raw_value.include? ':'
-        hour, minute = raw_value.split(':')
-
-        "#{adjust_hour(hour, raw_value)}:#{adjust_minute(minute)}"
-      else
-        #TODO
-        raw_value
-      end
-    end
-
-    def adjust_minute minute
-      minute.to_i
-    end
-
-    def adjust_hour hour, raw_value
-      if raw_value.include? 'PM'
-        Time.parse("#{hour}pm").hour
-      elsif raw_value.include? 'AM'
-        Time.parse("#{hour}am").hour
-      else
-        hour.to_i
-      end
-    end
-  end
-end