date_parser 0.1.21 → 0.1.31

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 67ebf3e486cf5ebd2af051c7bdebc2c779148d26
-  data.tar.gz: 42fb0b6410dad47a5055b5b4eb88a4df2be97259
+  metadata.gz: b0ee93c7c95e25f759c7897e8d363c29d8feb31c
+  data.tar.gz: 547bcbd2acdcd45c8879fb43a531d7d007931054
 SHA512:
-  metadata.gz: 6c805383acfb270d0966a6f0adecf474a614d3fe728c58c9370956ba9740ac3cb83250a425183d3ee7883dbacaf6dce4b7ce5365a211e0246ada87fe70fdfd03
-  data.tar.gz: 780c64b2a755551709b562f8e315b5081c716787be2adbf8d7f000e96f44c5d559f81920e60527a0717599668a6f44e09539557c80c4a8c9cbf972dc5f7da0ef
+  metadata.gz: 1894089457ad01c0fbe40a79080baa435772dfa34c02fcc0ad2b5bfb0ae0dc11a7055b18163a5714b0dd26caaf351893258b7b406f6b98b6ec505aeee2deba61
+  data.tar.gz: 11b01f4f1749856d15ba0f301185565f3119cb271a9de1c242ee49e65e1b46c2283256f4e2ea0114b028aef92429179aec069965b5d047adc2ce7466010cf054

data/NEWS.md

@@ -1,3 +1,8 @@
+# DateParser 0.1.3
+* New internal checks to avoid ambiguous behavior.
+    + Notably: creation_date is enforced to be a descendent of the Date class.
+* New tests to ensure that the program fails when unexpected types are passed in.
+
 # DateParser 0.1.2
 * New option: `parse_ambiguous_dates` flag, which determines whether or not some 
 looser phrases are considered dates.

data/README.md

@@ -1,14 +1,14 @@
 # DateParser
 
 DateParser is a simple, fast, effective way of parsing dates from natural language
-text in a flexible way.
+text.
 
 # Installation
 ```
 $ gem install date_parser
 ```
 
-# Usage
+# Examples
 ```ruby
 require 'date_parser'
 
@@ -88,7 +88,7 @@ DateParser::parse("No dates here",
     #=> [#<Date: 2016-01-01 ((2457389j,0s,0n),+0s,2299161j)>]
 ```
 
-# Examples
+# Usage
 
 DateParser has just one function: `parse(txt, creation_date, opts)`, which
 always returns an array with Date elements parsed from the text. If DateParser

data/lib/date_parser.rb

@@ -20,6 +20,8 @@ module DateParser
   #
   # * +creation_date+ - A Date object of when the text was created or released. 
   #   Defaults to nil, but if provided can make returned dates more accurate.
+  #   This is intentionally checked to be a Date object, as other data types
+  #   may cause unforeseen behavior.
   #
   # ==== Options
   #
@@ -78,6 +80,11 @@ module DateParser
     parse_single_years = opts[:parse_single_years].nil? ? false : opts[:parse_single_years]
     parse_ambiguous_dates = opts[:parse_ambiguous_dates].nil? ? true : opts[:parse_ambiguous_dates]
     
+    if ! Utils::descended_from?(creation_date, Date)
+      raise ArgumentError, "creation_date must be a descendent of the Date class." +
+                           "Otherwise, ambiguous behavior may result."
+    end
+    
     interpreted_dates = NaturalDateParsing::interpret_date(txt, 
                                                            creation_date, 
                                                            parse_single_years,

data/lib/date_parser/natural_date_parsing.rb

@@ -84,7 +84,7 @@ module NaturalDateParsing
   # * +parse_single_years+ - A boolean. If true, we interpret single numbers as
   #   years. This is a very broad assumption, and so defaults to false.
   #
-  # * +:parse_ambiguous_dates+ - Some phrases are not necessarily dates depending
+  # * +parse_ambiguous_dates+ - Some phrases are not necessarily dates depending
   #   on context. For example "1st" may not refer to 
   #   the 1st of a month. This option toggles whether or not those
   #   phrases are considered dates. Defaults to true.
@@ -202,7 +202,7 @@ module NaturalDateParsing
   # * +parse_single_years+ - A boolean. If true, we interpret single numbers as
   #   years. This is a very broad assumption, and so defaults to false.
   #
-  # * +:parse_ambiguous_dates+ - Some phrases are not necessarily dates depending
+  # * +parse_ambiguous_dates+ - Some phrases are not necessarily dates depending
   #   on context. For example "1st" may not refer to 
   #   the 1st of a month. This option toggles whether or not those
   #   phrases are considered dates. Defaults to true.

data/lib/date_parser/utils.rb

@@ -31,6 +31,9 @@ module Utils
   end
   
   # Performs delete_at for a range of integers
+  #
+  # Assumes that the integers in range are contiguous, and sorted in ascending
+  # order.
   def Utils.delete_at_indices(array, range)
     first_val = range.first
     for _ in range do
@@ -39,4 +42,10 @@ module Utils
     
     return array
   end
+  
+  # Checks to see if an object is descended from an ancestor (or is the ancestor)
+  # nil_accepted is a flag that checks 
+  def Utils.descended_from?(obj, ancestor, nil_accepted = true)
+    return obj.nil? ? nil_accepted : obj.class.ancestors.include?(ancestor)
+  end
 end

data/lib/spec/date_parser_spec.rb

@@ -115,4 +115,54 @@ describe DateParser do
       end
     end
   end
+  
+  #########################################################
+  ##
+  ## Type Testing
+  ##
+  
+  #########################
+  ## Negative Tests
+  ##
+  describe ".parse" do
+    context "Passing an int for creation_date" do
+      text = "2012-02-12"
+      creation_date = 12
+      
+      it "Raises an exception" do
+        expect { DateParser::parse(text, creation_date) }.to raise_exception(ArgumentError)
+      end
+    end
+    
+    context "Passing a String for creation_date" do
+      text = "2012-02-12"
+      creation_date = "Test"
+      
+      it "Raises an exception" do
+        expect { DateParser::parse(text, creation_date) }.to raise_exception(ArgumentError)
+      end
+    end
+    
+    context "Passing a Time for creation_date" do
+      text = "2012-02-12"
+      creation_date = Time.at(0)
+      
+      it "Raises an exception" do
+        expect { DateParser::parse(text, creation_date) }.to raise_exception(ArgumentError)
+      end
+    end
+    
+    #########################
+    ## Positive Tests
+    ##
+    context "Passing in a DateTime object for creation_date" do
+      text = "Something something something march 4 something something"
+      creation_date = DateTime.parse("Jan 1, 2004")
+      answer = [Date.parse("March 4, 2004")]
+      
+      it "Does not raise an exception, and produces the correct answer" do
+        expect(DateParser::parse(text, creation_date)).to eql(answer)
+      end
+    end
+  end
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: date_parser
 version: !ruby/object:Gem::Version
-  version: 0.1.21
+  version: 0.1.31
 platform: ruby
 authors:
 - Ryan Kwon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-29 00:00:00.000000000 Z
+date: 2016-09-15 00:00:00.000000000 Z
 dependencies: []
 description: DateParser is a simple, fast, and effective way to parse dates from natural
-  language text in a robust way.
+  language text.
 email: rynkwn@gmail.com
 executables: []
 extensions: []