natural-date 1.1 → 1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 681980a99568f3977ab2a0f7925e2a43574a20be
-  data.tar.gz: 07bc28df9cf1d66ac45af4a4a971676c651029e7
+  metadata.gz: 542d489e665790093de2be56251385422e79d4e2
+  data.tar.gz: 7ee809b6b7bfad9535bdca731effad0bef68108e
 SHA512:
-  metadata.gz: fdd7ed1788c36fb31512244e08190535fe222d1789ce19a7c1fbe2fd18572fdcba75bd1dab01be1d782580a80ae096c124a0856cfa04029f6b3320aa7c18934f
-  data.tar.gz: d23c7b259592c867df2e2cf44c7b6a689aad23a6c1bb4e2b7f27175d022a25da4b3ecd059f2ad97443ed43774bd59b5cdc13454f0d6ba6489ef71406da3930e8
+  metadata.gz: 55711080ed2742f5ed38ecacc94db1a9ef9a45035d0714151146f46dd6e88ca2214d3f77fd40025e647713641e95ced01939ee487223071bb72608f48ca4d06c
+  data.tar.gz: f83fbd5aae5cd47e64a3b50ecdaf599de0dc6ee7143b10e33a894d51784351739203579f9a97cfe72f3357cd21aa299358999dc32c6ca486d3546543e29847f4

data/README.md

@@ -24,33 +24,93 @@ Or install it yourself as:
 ```ruby
 require 'natural-date'
 
-# First you need to create a NaturalDateExpressionFactory with a specific locale. only pt-BR and en is supported by now =(
+# First you need to create a NaturalDateExpressionFactory with a specific locale.
+# Only pt-BR and en is supported by now.
 factory = NaturalDateExpressionFactory.new(:en)
 
-# then create a natural date expression passing a string expression and a reference date.
+# Then create a natural date expression passing a string expression and a reference date.
 # In the example below as we set the reference date to 9th of Dezember, 2016 the natural_date is
-# going to match only '2017-8-1'
+# going to match only '2017-8-1'.
+# When no reference date is provided the Date.today is going to be used.
 natural_date = factory.create('1th of august', Date.parse('2016-12-9'))
 
-# Test against a Date
-puts natural_date.match(Date.new(2016, 8, 1)) # => {:match=>false, :first_matched_expression=>nil}
-puts natural_date.match(Date.new(2017, 8, 1)) # => {:match=>true, :first_matched_expression=>{:day=>[1], :month=>[8], :year=>[2017]}}
+# NaturalDateExpression does not generate Dates (due it can represent a 
+# recurrent date expression like 'every monday') instead you need to 
+# match a particular date to the expression using the *=~* or *match?*.
+puts natural_date =~ Date.new(2016, 8, 1) # => false
+puts natural_date =~ Date.new(2017, 8, 1) # => true 
+
+# or using match?
+natural_date.match?(Date.new(2016, 8, 1))
+# => false
+natural_date.match?(Date.new(2017, 8, 1))
+# => true
+
+# You can also get some matched dates in a given interval
+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
+natural_date.fetch_dates
+# => array with dates matched inside the interval
 ```
 
-TODO: Write other examples
+## Types of expressions
 
-## Development
+You can create lots of different types of expressions, using days months, years and week days, the expression can 
+refer both single and recurring dates.
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+  - **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'.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+```ruby
+factory = NaturalDateExpressionFactory.new(:en)
+
+# Day and month
+factory.create('1st of November, 2016')
+# => '1st November 2016'
+factory.create('1 sep 2016')
+# => '1st September 2016'
+factory.create('1 of 1 2016')
+# => '1st September 2016'
+factory.create('1 of July', Date.new(2016, 1, 1)
+# => '1st July 2016' due the reference date is before '1st July, 2016'
+factory.create('1st of Apr', Date.new(2016, 9, 9)
+# => '1st April 2017' due the reference date is after '1st April, 2016'
+
+# Multiple days in a month
+factory.create('1 8 and 15 of July, 2016')
+# => ['1st July 2016', '8th July 2016', '15th July 2016']
+factory.create('1st 8 and 15th of September, 2016')
+# => ['1st July 2016', '8th July 2016', '15th July 2016'], not the best consistency but still ok
+
+# Single day in multiple months
+factory.create('1 of July and August 2016')
+# => ['1st July 2016', '1st August 2016']
+
+# Multiple days and multiple months
+factory.create('1, 7 of May and March 2016')
+# => ['1st May 2016', '7st May 2016', '1st March, 2016', '7st March 2016']
+
+# You can also set ranges in both days and months using *till* or *until*
+factory.create('1 till 7 of Jan 2016')
+# => ['1st January 2016'..'7st January 2016']
+factory.create('1 of Jan until April 2016')
+# => ['1st January 2016', '1st January 2016', '1st January 2016', '1st January 2016']
+
+# Also you can set week days like 'monday', 'sunday', 'sat'
+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.
+```
 
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/natural-date. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/lib/natural-date/natural_date_expression.rb

@@ -1,5 +1,20 @@
 class NaturalDateExpression
-  VERSION = "1.1"
+  VERSION = "1.2"
+
+  class DateMatch
+    attr_reader :first_matched_expression, :tested_date, :reference_date
+
+    def initialize match, first_matched_expression, tested_date, reference_date
+      @match = match
+      @first_matched_expression = first_matched_expression
+      @tested_date = tested_date
+      @reference_date = reference_date
+    end
+
+    def matches?
+      @match
+    end
+  end
 
   def initialize data, reference_date, expression_string
     @data = data
@@ -7,6 +22,14 @@ class NaturalDateExpression
     @expression_string = expression_string
   end
 
+  def match?
+    match(date).matches?
+  end
+
+  def =~ date
+    match(date).matches?
+  end
+
   def match date
     matches = @data.map do |expression_map|
       match_week?(date, expression_map) &&
@@ -16,14 +39,10 @@ class NaturalDateExpression
         match_year?(date, expression_map)
     end
 
-    first_matched_expression = if matches.any?
-                                 @data[matches.each_with_index.find { |exp, index| exp }.last]
-                               else
-                                 nil
-                               end
-
-    { match: matches.any?,
-      first_matched_expression: first_matched_expression }
+    DateMatch.new(matches.any?,
+                  (matches.any?? @data[matches.each_with_index.find { |exp, index| exp }.last] : nil),
+                  @date,
+                  @reference_date)
   end
 
   def recurrent?
@@ -35,9 +54,7 @@ class NaturalDateExpression
   end
 
   def fetch_dates dates_range = nil
-    (dates_range || (Date.today..(Date.today + 365))).to_a.select do |date|
-      match(date).fetch(:match)
-    end
+    (dates_range || (Date.today..(Date.today + 365))).to_a.select { |date| self =~ date }
   end
 
   private

data/lib/natural-date/natural_date_expression_factory.rb

@@ -6,7 +6,7 @@ class NaturalDateExpressionFactory
   STEPS = {}
   EXPRESSION_SPLITTER_STEP = {}
 
-  def create expression_string, reference_date
+  def create expression_string, reference_date = Date.today
     NaturalDateExpression.new(create_data_expression(expression_string, reference_date), reference_date, expression_string)
   end
 

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

@@ -17,9 +17,9 @@ keys:
     fri_5: 'friday fri'
     sat_6: 'saturday sat'
   day:
-    day_1: '1 1th'
-    day_2: '2 2th'
-    day_3: '3 3th'
+    day_1: '1 1th 1st'
+    day_2: '2 2th 2nd'
+    day_3: '3 3th 3rd'
     day_4: '4 4th'
     day_5: '5 5th'
     day_6: '6 6th'
@@ -37,9 +37,9 @@ keys:
     day_18: '18 18th'
     day_19: '19 19th'
     day_20: '20 20th'
-    day_21: '21 21th'
-    day_22: '22 22th'
-    day_23: '23 23th'
+    day_21: '21 21th 21st'
+    day_22: '22 22th 22nd'
+    day_23: '23 23th 23rd'
     day_24: '24 24th'
     day_25: '25 25th'
     day_26: '26 26th'
@@ -47,7 +47,7 @@ keys:
     day_28: '28 28th'
     day_29: '29 29th'
     day_30: '30 30th'
-    day_31: '31 31th'
+    day_31: '31 31th 31st'
   month:
     jan_1: 'jan janeiro'
     feb_2: 'feb february'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: natural-date
 version: !ruby/object:Gem::Version
-  version: '1.1'
+  version: '1.2'
 platform: ruby
 authors:
 - Andrew S Aguiar
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-12-09 00:00:00.000000000 Z
+date: 2016-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -110,8 +110,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Converts natural language in date expressions
 test_files: []
+has_rdoc: