timetwister 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9ab710e9b2068bc7945925206c7033765c9ab6c8c03a0dec28e8271e1888d322
-  data.tar.gz: 8d37aba572fc43b434b5da1febff19e77d12155a744787aaada2a98d2748a262
+  metadata.gz: fc36713ba664a945f35f2174a7047646118b90e40ba78edede43e8a4efe891f8
+  data.tar.gz: b6861861782dae33194e0e4d601d316f6246b14baacb73e0b4ebe31f7007c007
 SHA512:
-  metadata.gz: a8ab93f028d366e5dfd48a25c72768796eac9d586b6d03e698eb7e58022b37d9862577a7cccd5425f9749091167481e17d20cbe1197904bb6209602e262eae94
-  data.tar.gz: 780ee2a7bb4575a385dcbf4d0a417e671f1da7d700115a547391546303ae189b7b96301268fecfeb8c16d088aca883cd100672f51167c8b7366651df665b8c0b
+  metadata.gz: 7880c0927a7a48d0cba0ac9dc52058fa3def90b986201d553fc0df9f288c7bd72c0fb2e71731892733db6ff138f1630a8edc6264fa4819106dabc7ef6fe181b7
+  data.tar.gz: b8d5517e5e2ae6c0457a1335f192e87d5b3b04623b6c04f499d7f98ec880bebb7bef0724fcbafb2ea3d4bd9745410bca5e216973bff95ba5ee8d8fa16daa14e4

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.3', '2.4', '2.5', '2.6', '2.7', '3.0']
+
+    steps:
+    - uses: actions/checkout@v3
+    - 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@v1
+      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/lib/timetwister/parser.rb

@@ -56,7 +56,17 @@ class Parser
 					if c[:proc]
 						# clone string to avoid changing it via in-place methods used in Procs
 						work_string = @string.clone
-						c[:proc].call(work_string, c[:arg])
+
+						# using a begin/rescue to catch dates that Date.parse errors on
+						begin
+							c[:proc].call(work_string, c[:arg])
+
+						# ArgumentError for pre-2.7.0 DateTime errors,
+						# Date::Error for 2.7.0 and later
+						rescue ArgumentError || Date::Error
+							@dates = { :original_string => @string, :index_dates => [], :keydate => nil, :keydate_z => nil, :date_start => nil, :date_end => nil,
+									:date_start_full => nil, :date_end_full => nil, :inclusive_range => nil, :certainty => nil }
+						end
 					end
 					break
 				end

data/lib/timetwister/utilities.rb

@@ -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.3.0"
+  VERSION = "0.4.0"
 end

data/spec/dates_spec.rb

@@ -46,7 +46,6 @@ describe Timetwister do
 	end
 
 	it "parses ranges of full dates" do
-
 		forms = ["July 4 1776 - March 1 1789", "4 July 1776 - 1 March 1789", "1776 July 4 - 1789 March 1", "1776 4 July - 1789 1 March", "1776 4 July to 1789 1 March"]
 		forms.each do |f|
 			date = Timetwister.parse(f)
@@ -344,7 +343,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 +353,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 +371,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 +389,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
@@ -507,6 +571,62 @@ describe Timetwister do
 		end
 	end
 
+	it "DOES NOT parse nonexistent dates" do
+		date = Timetwister.parse('1776 September 31')
+		expect(date[0][:date_start]).to eq(nil)
+		expect(date[0][:date_start_full]).to eq(nil)
+		expect(date[0][:date_end]).to eq(nil)
+		expect(date[0][:date_end_full]).to eq(nil)
+		expect(date[0][:inclusive_range]).to eq(nil)
+		expect(date[0][:index_dates]).to eq([])
+		expect(date[0][:test_data]).to eq(nil)
+
+		date = Timetwister.parse('1776-11-31')
+		expect(date[0][:date_start]).to eq(nil)
+		expect(date[0][:date_start_full]).to eq(nil)
+		expect(date[0][:date_end]).to eq(nil)
+		expect(date[0][:date_end_full]).to eq(nil)
+		expect(date[0][:inclusive_range]).to eq(nil)
+		expect(date[0][:index_dates]).to eq([])
+		expect(date[0][:test_data]).to eq(nil)
+
+		date = Timetwister.parse('1776-11-00')
+		expect(date[0][:date_start]).to eq(nil)
+		expect(date[0][:date_start_full]).to eq(nil)
+		expect(date[0][:date_end]).to eq(nil)
+		expect(date[0][:date_end_full]).to eq(nil)
+		expect(date[0][:inclusive_range]).to eq(nil)
+		expect(date[0][:index_dates]).to eq([])
+		expect(date[0][:test_data]).to eq(nil)
+
+		date = Timetwister.parse('1776 whatever 31')
+		expect(date[0][:date_start]).to eq(nil)
+		expect(date[0][:date_start_full]).to eq(nil)
+		expect(date[0][:date_end]).to eq(nil)
+		expect(date[0][:date_end_full]).to eq(nil)
+		expect(date[0][:inclusive_range]).to eq(nil)
+		expect(date[0][:index_dates]).to eq([])
+		expect(date[0][:test_data]).to eq(nil)
+
+		date = Timetwister.parse('1776 sometime 72 - december 42 1999')
+		expect(date[0][:date_start]).to eq(nil)
+		expect(date[0][:date_start_full]).to eq(nil)
+		expect(date[0][:date_end]).to eq(nil)
+		expect(date[0][:date_end_full]).to eq(nil)
+		expect(date[0][:inclusive_range]).to eq(nil)
+		expect(date[0][:index_dates]).to eq([])
+		expect(date[0][:test_data]).to eq(nil)
+
+		date = Timetwister.parse('just absolute garbage')
+		expect(date[0][:date_start]).to eq(nil)
+		expect(date[0][:date_start_full]).to eq(nil)
+		expect(date[0][:date_end]).to eq(nil)
+		expect(date[0][:date_end_full]).to eq(nil)
+		expect(date[0][:inclusive_range]).to eq(nil)
+		expect(date[0][:index_dates]).to eq([])
+		expect(date[0][:test_data]).to eq(nil)
+	end
+
 	it "parses lists of years" do
 		date = Timetwister.parse("1776, 1789, 1812")
 		expect(date[0][:date_start]).to eq("1776")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: timetwister
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Alex Duryee
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-08 00:00:00.000000000 Z
+date: 2023-03-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -46,6 +46,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".travis.yml"
 - Gemfile