initial commit

.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in timetwister.gemspec
+gemspec

LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Alex Duryee
+
+MIT License
+
+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.

README.md

@@ -0,0 +1,44 @@
+# Timetwister
+
+A Chronic wrapper with improved date format parsing and fewer surprises.
+
+Developed by the New York Public Library to transform freetext date metadata into machine-readable data.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'timetwister'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install timetwister
+
+## Usage
+
+```require 'timetwister'
+Timetwister.parse("Jun 1898 - [July 4 1900]")
+ => {:original_string=>"Jun 1898 - July 4 1900", :index_dates=>[1898, 1899, 1900], :date_start=>"1898-06-01", :date_end=>"1900-07-04", :date_start_full=>"1898-06-01", :date_end_full=>"1900-07-04", :inclusive_range=>true, :certainty=>"inferred", :test_data=>"330"} ```
+
+Output explanation:
+
+- `:original_string` is the original input
+- `:index_dates` is an `Array` of each year encompassed by the provided date range
+- `:date_start` and `:date_end` are ISO8601 representations of the input date, with no assumed values
+- `:date_start_full` and `:date_end_full` are ISO8601 representations of the input date in YYYY-MM-DD format (using assumed values when needed)
+- `:inclusive_range` is whether or not the input value is a range
+- `:certainty` is the certainty of the provided date, based on use of flags and punctuation
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/timetwister/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

lib/timetwister.rb

@@ -0,0 +1,20 @@
+require "timetwister/version"
+require "timetwister/parser"
+
+module Timetwister
+
+  	def self.parse(str, options={})
+
+		dates = { :original_string => str, :index_dates => [], :date_start => nil, :date_end => nil,
+			:date_start_full => nil, :date_end_full => nil, :inclusive_range => nil, :certainty => nil }
+
+		# defensive check - we don't want to try to parse certain malformed strings
+		# (otherwise dates get flipped and types get wacky)
+		if str.include?('??')
+			return dates
+		end
+
+		return Parser.string_to_dates(str, dates, options)
+
+	end
+end