timetwister 0.2.7 → 0.2.8

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NTE4OTg0ODUxZDIzZmMwNTQ4NmYxZjYwNmY4ODNiMTI4ODdhMmMzMg==
-  data.tar.gz: !binary |-
-    YjcyNDQ2MDg0MTM2YzdiMDNhMjkwNmY3OWI3YmVmMThkNTk5NGMzNw==
+SHA256:
+  metadata.gz: ca0d0c30070a1b30680aed8c91ab6950f8b3673395546605f1dc1c0bb72954ea
+  data.tar.gz: cee49664ffebe37b764217e1cfd212c12b6e364928425a913598e3dc44eb6903
 SHA512:
-  metadata.gz: !binary |-
-    NjcxNWZkZTE0YWI1NGJiNGRhMDBmODA3YmRhNWY1YTFlNDgzOWNlMjIwODIy
-    NjdkNGI3YzU2ZTU1MzA5Y2YzYjFhYmJlZTI5NzFkYjQzZDY1MWFlOTU3MGY1
-    OWM0NjAzNjJkNDIyMDdmMjA0YjE0YzcwYjczMWI3MGNiMzNlNTg=
-  data.tar.gz: !binary |-
-    NmMyOWYzYWY2NWJmZmQyYmM4NjliMTc5YWQ3N2E2NzhkNmQ1MDdlZTQxYTQ5
-    ZjIxNWZhNTExODg0MDRkMDVkNDAyNGI3MjRkMWIyMjlhYzdjMzg5ZWE5OTcz
-    NjgzZmMwMTY4MDVlYzNlNzE0YzcyYTNmYTUzNDVhODczNGQ5ZWM=
+  metadata.gz: 897f1be9853d0c9ebe3800519b507f346bb0c78c265fe2b4d42a0d75e148faf9ccc919fe1d0e14bdc9b73676f39ecdd5ceb156dfaf25904f4d62c0e7fb89bd29
+  data.tar.gz: 867c87500e0011732f9c863fff5bb03ee78080f42ad63755d541ed07bc6d72ed83e41c8f490e3323498ff82dd5421cbd989360be66b96520d0dba21b2a0cc1ba

data/.github/workflows/ruby.yml

@@ -0,0 +1,35 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rspec

data/.travis.yml

@@ -1,6 +1,6 @@
 language: ruby
 rvm:
- - "2.2.3"
- - "2.0.0"
- - "1.9.3"
+ - "2.2"
+ - "2.5.3"
+ - "3.0.2"
 script: bundle exec rspec

data/README.md

@@ -1,9 +1,9 @@
-[![Build Status](https://travis-ci.org/alexduryee/timetwister.svg?branch=master)](https://travis-ci.org/alexduryee/timetwister)
+[![Build Status](https://travis-ci.com/alexduryee/timetwister.svg?branch=master)](https://travis-ci.org/alexduryee/timetwister)
 [![Coverage Status](https://coveralls.io/repos/alexduryee/timetwister/badge.svg?branch=master&service=github)](https://coveralls.io/github/alexduryee/timetwister?branch=master)
 
 # Timetwister
 
-A Chronic wrapper with improved date format parsing and fewer surprises.
+A DateTime 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.
 

data/lib/timetwister/parser.rb

@@ -1,6 +1,6 @@
 # encoding: utf-8
 
-require 'chronic'
+require 'date'
 require 'timetwister/utilities'
 
 class Parser
@@ -574,18 +574,7 @@ class Parser
 		proc = Proc.new do |string|
 			string.gsub!(/\?/,'')
 
-			# Chronic can't parse year-month strings properly
-			# so we need to change them to month-year before
-			# parsing them.
-
-			if string.match(/^[0-9]/)
-				tmpyear = string.split(' ')[0]
-				string.gsub!(/^.+? /,'')
-				string << " "
-				string << tmpyear
-			end
-
-			datetime = Chronic.parse(string)
+			datetime = DateTime.parse(string)
 			if datetime
 				@dates[:date_start] = datetime.strftime('%Y-%m')
 				@dates[:index_dates] << datetime.strftime('%Y').to_i
@@ -614,14 +603,14 @@ class Parser
 				# if month-specific, modify datetimes to include all days of each month
 				if specificity == 'month'
 					month_date_start = datetime_start.strftime('%Y-%m')
-					datetime_start = Chronic.parse(month_date_start + '-01')
+					datetime_start = DateTime.parse(month_date_start + '-01')
 					month_date_end = datetime_end.strftime('%Y-%m')
 					month_date_end_parts = month_date_end.split('-')
 
 					month_date_end_last = Utilities.days_in_month(month_date_end_parts[1],month_date_end_parts[0]).to_s
 					month_date_full = month_date_end + "-#{month_date_end_last}"
 
-					datetime_end = Chronic.parse(month_date_full)
+					datetime_end = DateTime.parse(month_date_full)
 				end
 
 				if datetime_start && datetime_end
@@ -699,14 +688,12 @@ class Parser
 			first_month = string.match(@regex_tokens[:named_month]).to_s
 			last_month = string.match(@regex_tokens[:named_month] + '$').to_s
 
-			# chronic is fiddly about short months with periods
-			# (e.g. "may.") so we remove them
-			date_string_first = first_month.delete('.') + ' 1,' + year
-			datetime_first = Chronic.parse(date_string_first)
+			date_string_first = first_month + ' 1,' + year
+			datetime_first = DateTime.parse(date_string_first)
 			if !last_month.empty?
 				@dates[:date_start] = datetime_first.strftime('%Y-%m')
 				date_string_last = last_month + ' ' + year
-				datetime_last = Chronic.parse(date_string_last)
+				datetime_last = DateTime.parse(date_string_last)
 				@dates[:date_end] = datetime_last.strftime('%Y-%m')
 			end
 			@dates[:inclusive_range] = true
@@ -729,7 +716,6 @@ class Parser
 			end
 
 			dates.each { |d| d.strip! }
-
 			if dates.length == 2
 				if dates[0].match(/[A-Za-z]/)
 					datetime_start = full_date_single_to_datetime(dates[0] + "-01")
@@ -773,20 +759,12 @@ class Parser
 						d << " "
 						d << year
 					end
-
-					# Chronic seemed to choke with YYYY-MM-DD dates
-					# so we'll flip it to MM-DD-YYYY
-					if d.match("^" + year)
-						d.gsub!(year + " ","")
-						d << " "
-						d << year
-					end
 				}
 
 				# change our strings to datetime objects
 				# and send them to be processed elsewhere
-				datetime_start = Chronic.parse(dates[0])
-				datetime_end = Chronic.parse(dates[1])
+				datetime_start = DateTime.parse(dates[0])
+				datetime_end = DateTime.parse(dates[1])
 				process_date_range(datetime_start, datetime_end)
 				@dates[:inclusive_range] = true
 			end
@@ -818,7 +796,7 @@ class Parser
 					month_date_end_last = Utilities.days_in_month(month_date_end_parts[1],month_date_end_parts[0]).to_s
 					month_date_full = month_date_end + "-#{month_date_end_last}"
 
-					datetime_end = Chronic.parse(month_date_full)
+					datetime_end = DateTime.parse(month_date_full)
 				else
 					datetime_start = full_date_single_to_datetime(dates[0] + "-01")
 					if datetime_start && datetime_end
@@ -870,13 +848,13 @@ class Parser
 				day = nil
 			end
 
-			new_string.gsub!(/[\.\,\s]+/,'')
+			new_string.gsub!(/[\.\,\s\-]+/,'')
 
 			month = new_string.clone
 			parse_string = month
 			parse_string += day ? " #{day}, #{year}" : " #{year}"
 		end
-		datetime = Chronic.parse(parse_string)
+		datetime = DateTime.parse(parse_string)
 	end
 
 
@@ -926,11 +904,11 @@ class Parser
 	# generates datetime from ISO8601-formatted date
 	def self.iso8601_datetime(iso_8601_date)
 		if iso_8601_date.match(/^[0-9]{4}\-[0-9]{2}\-[0-9]{2}$/)
-			Chronic.parse(iso_8601_date)
+			DateTime.parse(iso_8601_date)
 		elsif iso_8601_date.match(/^[0-9]{4}\-[0-9]{2}$/)
-			Chronic.parse(iso_8601_date + '-01')
+			DateTime.parse(iso_8601_date + '-01')
 		else
-			Chronic.parse(iso_8601_date + '-01-01')
+			DateTime.parse(iso_8601_date + '-01-01')
 		end
 	end
 

data/lib/timetwister/utilities.rb

@@ -4,10 +4,10 @@ class Utilities
 
 	# walk through a hash and transforms all ints to strings
 	# input: a hash
-	# output: same hash, but with all Fixnums converted to strings
+	# output: same hash, but with all Integers converted to strings
 	def self.stringify_values(hash)
 		hash.each do |k,v|
-			if v.is_a?(Fixnum)
+			if v.is_a?(Integer)
 				hash[k] = v.to_s
 			end
 		end
@@ -135,15 +135,15 @@ class Utilities
 			# italian
 			'gennaio' => 'January',
 			'febbraio' => 'February',
-			'marzo' => 'March',
+			# redundant date removed
 			'aprile' => 'April',
 			'maggio' => 'May',
 			'giugno' => 'June',
 			'luglio' => 'July',
-			'agosto' => 'August',
+			# redundant date removed
 			'settembre' => 'September',
 			'ottobre' => 'October',
-			'novembre' => 'November',
+			# redundant date removed
 			'dicembre' => 'December',
 
 			# german
@@ -151,7 +151,7 @@ class Utilities
 			'februar[^y]' => 'February',
 			'märz' => 'March',
 			'april' => 'April',
-			'mai' => 'May',
+			# redundant date removed
 			'juni' => 'June',
 			'juli' => 'July',
 			'august' => 'August',
@@ -236,11 +236,7 @@ class Utilities
 		]
 
 		# transform seasons to months
-		string.gsub!(/[Ww]inter/, " January 1 - March 20 ")
-		string.gsub!(/[Ss]pring/, " March 20 - June 21 ")
-		string.gsub!(/[Ss]ummer/, " June 21 - September 23 ")
-		string.gsub!(/[Aa]utumn/, " September 23 - December 22 ")
-		string.gsub!(/[Ff]all/, " September 23 - December 22 ")
+		string = replace_seasons(string)
 
 		# remove days of the week
 		dow = [/[Ss]unday,?\s+/, /[Mm]onday,?\s+/, /[Tt]uesday,?\s+/, /[Ww]ednesday,?\s+/, /[Tt]hursday,?\s+/, /[Ff]riday,?\s+/, /[Ss]aturday,?\s+/]
@@ -258,6 +254,28 @@ class Utilities
 		return string
 	end
 
+	def self.replace_seasons(string)
+		seasons = {	'win[^\s]*'	=>	['January 1', 'March 20'],
+					'spr[^\s]*'	=>	['March 20', 'June 21'],
+					'sum[^\s]*'	=>	['June 21', 'September 23'],
+					'aut[^\s]*'	=>	['September 23', 'December 31'],
+					'fal[^\s]*'	=>	['September 23', 'December 31']}
+
+		# if we're working with a range, we need to be a little careful, so that we don't create sub-ranges in a string
+		is_range = string.match(/[^-]+?-[^-]+?/)
+
+		seasons.each do |season, dates|
+			regex = Regexp.new(season, Regexp::IGNORECASE)
+
+			# is the season the beginning or the end of a range?
+			new_date = (is_range ? (string.match(Regexp.new(season + '.+?-', Regexp::IGNORECASE)) ? dates[0] : dates[1]) : dates.join(' - '))
+			
+			string = string.gsub(regex, new_date)
+		end
+
+		return string
+	end
+
 	# Removes the first 4-digit number found in the string and returns it
 	def self.extract_year(string)
 		year = string.match(/\d{4}/).to_s

data/lib/timetwister/version.rb

@@ -1,3 +1,3 @@
 module Timetwister
-  VERSION = "0.2.7"
+  VERSION = "0.2.8"
 end

data/spec/dates_spec.rb

@@ -195,7 +195,7 @@ describe Timetwister do
 	end
 
 	it "parses month ranges within one year" do
-		forms = ["July-September 1776", "1776 July-September"]
+		forms = ["July-September 1776", "1776 July-September", "1776 Jul.-Sept."]
 		forms.each do |f|
 			date = Timetwister.parse(f)
 			expect(date[0][:date_start]).to eq("1776-07")
@@ -344,7 +344,7 @@ describe Timetwister do
 		end
 	end
 
-	it "parses seasons" do
+	it "parses single seasons" do
 		date = Timetwister.parse("Winter 1776")
 		expect(date[0][:date_start]).to eq("1776-01-01")
 		expect(date[0][:date_start_full]).to eq("1776-01-01")
@@ -354,6 +354,15 @@ describe Timetwister do
 		expect(date[0][:index_dates]).to eq([1776])
 		expect(date[0][:test_data]).to eq("310")
 
+		date = Timetwister.parse("win. 1776")
+		expect(date[0][:date_start]).to eq("1776-01-01")
+		expect(date[0][:date_start_full]).to eq("1776-01-01")
+		expect(date[0][:date_end]).to eq("1776-03-20")
+		expect(date[0][:date_end_full]).to eq("1776-03-20")
+		expect(date[0][:inclusive_range]).to eq(true)
+		expect(date[0][:index_dates]).to eq([1776])
+		expect(date[0][:test_data]).to eq("310")
+
 		date = Timetwister.parse("1776 Spring")
 		expect(date[0][:date_start]).to eq("1776-03-20")
 		expect(date[0][:date_start_full]).to eq("1776-03-20")
@@ -363,6 +372,15 @@ describe Timetwister do
 		expect(date[0][:index_dates]).to eq([1776])
 		expect(date[0][:test_data]).to eq("310")
 
+		date = Timetwister.parse("1776 Spr")
+		expect(date[0][:date_start]).to eq("1776-03-20")
+		expect(date[0][:date_start_full]).to eq("1776-03-20")
+		expect(date[0][:date_end]).to eq("1776-06-21")
+		expect(date[0][:date_end_full]).to eq("1776-06-21")
+		expect(date[0][:inclusive_range]).to eq(true)
+		expect(date[0][:index_dates]).to eq([1776])
+		expect(date[0][:test_data]).to eq("310")
+
 		date = Timetwister.parse("1776 Summer")
 		expect(date[0][:date_start]).to eq("1776-06-21")
 		expect(date[0][:date_start_full]).to eq("1776-06-21")
@@ -372,14 +390,61 @@ describe Timetwister do
 		expect(date[0][:index_dates]).to eq([1776])
 		expect(date[0][:test_data]).to eq("310")
 
+		date = Timetwister.parse("1776 Summ")
+		expect(date[0][:date_start]).to eq("1776-06-21")
+		expect(date[0][:date_start_full]).to eq("1776-06-21")
+		expect(date[0][:date_end]).to eq("1776-09-23")
+		expect(date[0][:date_end_full]).to eq("1776-09-23")
+		expect(date[0][:inclusive_range]).to eq(true)
+		expect(date[0][:index_dates]).to eq([1776])
+		expect(date[0][:test_data]).to eq("310")
+
 		date = Timetwister.parse("Fall 1776")
 		expect(date[0][:date_start]).to eq("1776-09-23")
 		expect(date[0][:date_start_full]).to eq("1776-09-23")
-		expect(date[0][:date_end]).to eq("1776-12-22")
-		expect(date[0][:date_end_full]).to eq("1776-12-22")
+		expect(date[0][:date_end]).to eq("1776-12-31")
+		expect(date[0][:date_end_full]).to eq("1776-12-31")
+		expect(date[0][:inclusive_range]).to eq(true)
+		expect(date[0][:index_dates]).to eq([1776])
+		expect(date[0][:test_data]).to eq("310")
+
+		date = Timetwister.parse("Autumn 1776")
+		expect(date[0][:date_start]).to eq("1776-09-23")
+		expect(date[0][:date_start_full]).to eq("1776-09-23")
+		expect(date[0][:date_end]).to eq("1776-12-31")
+		expect(date[0][:date_end_full]).to eq("1776-12-31")
 		expect(date[0][:inclusive_range]).to eq(true)
 		expect(date[0][:index_dates]).to eq([1776])
 		expect(date[0][:test_data]).to eq("310")
+
+		date = Timetwister.parse("Aut. 1776")
+		expect(date[0][:date_start]).to eq("1776-09-23")
+		expect(date[0][:date_start_full]).to eq("1776-09-23")
+		expect(date[0][:date_end]).to eq("1776-12-31")
+		expect(date[0][:date_end_full]).to eq("1776-12-31")
+		expect(date[0][:inclusive_range]).to eq(true)
+		expect(date[0][:index_dates]).to eq([1776])
+		expect(date[0][:test_data]).to eq("310")
+	end
+
+	it "parses ranges of seasons" do
+		date = Timetwister.parse("Winter 1776 - Spring 1777")
+		expect(date[0][:date_start]).to eq("1776-01-01")
+		expect(date[0][:date_start_full]).to eq("1776-01-01")
+		expect(date[0][:date_end]).to eq("1777-06-21")
+		expect(date[0][:date_end_full]).to eq("1777-06-21")
+		expect(date[0][:inclusive_range]).to eq(true)
+		expect(date[0][:index_dates]).to eq([1776, 1777])
+		expect(date[0][:test_data]).to eq("80")
+
+		date = Timetwister.parse("1777 Spring - 1778 Summer")
+		expect(date[0][:date_start]).to eq("1777-03-20")
+		expect(date[0][:date_start_full]).to eq("1777-03-20")
+		expect(date[0][:date_end]).to eq("1778-09-23")
+		expect(date[0][:date_end_full]).to eq("1778-09-23")
+		expect(date[0][:inclusive_range]).to eq(true)
+		expect(date[0][:index_dates]).to eq([1777, 1778])
+		expect(date[0][:test_data]).to eq("80")
 	end
 
 	it "parses dates with punctuation" do
@@ -528,6 +593,24 @@ describe Timetwister do
 		expect(date[2][:test_data]).to eq("70")
 	end
 
+	it "parses lists of ISO 8601 dates" do
+		date = Timetwister.parse("1777 April 30, 1777 June 4")
+		expect(date[0][:date_start]).to eq("1777-04-30")
+		expect(date[0][:date_start_full]).to eq("1777-04-30")
+		expect(date[0][:date_end]).to eq("1777-04-30")
+		expect(date[0][:date_end_full]).to eq("1777-04-30")
+		expect(date[0][:index_dates]).to eq([1777])
+		expect(date[0][:test_data]).to eq("200")
+
+
+		expect(date[1][:date_start]).to eq("1777-06-04")
+		expect(date[1][:date_start_full]).to eq("1777-06-04")
+		expect(date[1][:date_end]).to eq("1777-06-04")
+		expect(date[1][:date_end_full]).to eq("1777-06-04")
+		expect(date[1][:index_dates]).to eq([1777])
+		expect(date[1][:test_data]).to eq("200")
+	end
+
 	it "parses lists of mixed date types" do
 		date = Timetwister.parse("July 1776 - August 1789, 1812 - 1820, 1900")
 		expect(date[0][:date_start]).to eq("1776-07")

data/timetwister.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.version       = Timetwister::VERSION
   spec.authors       = ["Alex Duryee"]
   spec.email         = ["alexanderduryee@nypl.org"]
-  spec.summary       = "Chronic wrapper to handle common date formats"
+  spec.summary       = "DateTime wrapper to handle common date formats"
   spec.homepage      = "http://github.com/alexduryee/timetwister"
   spec.license       = "MIT"
 
@@ -18,7 +18,6 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_runtime_dependency "chronic", "~> 0.10.2"
 end

metadata

@@ -1,58 +1,44 @@
 --- !ruby/object:Gem::Specification
 name: timetwister
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.2.8
 platform: ruby
 authors:
 - Alex Duryee
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-09-02 00:00:00.000000000 Z
+date: 2022-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: chronic
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.10.2
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.10.2
-description: 
+description:
 email:
 - alexanderduryee@nypl.org
 executables:
@@ -60,8 +46,9 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -78,26 +65,25 @@ homepage: http://github.com/alexduryee/timetwister
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
-summary: Chronic wrapper to handle common date formats
+summary: DateTime wrapper to handle common date formats
 test_files:
 - spec/dates_spec.rb
 - spec/spec_helper.rb