scripref 0.12.0 → 0.13.0

data/scripref.gemspec

@@ -0,0 +1,37 @@
+# -*- encoding: utf-8 -*-
+# stub: scripref 0.13.0 ruby lib
+#
+# This file is automatically generated by rim.
+# PLEASE DO NOT EDIT IT DIRECTLY!
+# Change the values in Rim.setup in Rakefile instead.
+
+Gem::Specification.new do |s|
+  s.name = "scripref"
+  s.version = "0.13.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["Jan Friedrich"]
+  s.date = "2020-04-09"
+  s.description = ""
+  s.email = "janfri26@gmail.com"
+  s.files = ["./.aspell.pws", "Changelog", "LICENSE", "README.md", "Rakefile", "lib/scripref", "lib/scripref.rb", "lib/scripref/basic_methods.rb", "lib/scripref/bookname.rb", "lib/scripref/const_reader.rb", "lib/scripref/english.rb", "lib/scripref/formatter.rb", "lib/scripref/german.rb", "lib/scripref/include.rb", "lib/scripref/parser.rb", "lib/scripref/passage.rb", "lib/scripref/pipelining.rb", "lib/scripref/processor.rb", "regtest/formatter.rb", "regtest/formatter.yml", "regtest/parser.rb", "regtest/parser.yml", "regtest/processor.rb", "regtest/processor.yml", "scripref.gemspec", "test/test_bookname.rb", "test/test_english.rb", "test/test_formatter.rb", "test/test_german.rb", "test/test_helper.rb", "test/test_integration.rb", "test/test_parser.rb", "test/test_passage.rb", "test/test_pipelining.rb", "test/test_processor.rb"]
+  s.homepage = "https://github.com/janfri/scripref"
+  s.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+  s.rubygems_version = "3.1.2"
+  s.summary = "Library for parsing scripture references in real texts."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+  end
+
+  if s.respond_to? :add_runtime_dependency then
+    s.add_development_dependency(%q<rake>, [">= 0"])
+    s.add_development_dependency(%q<rim>, ["~> 2.17"])
+    s.add_development_dependency(%q<regtest>, ["~> 2"])
+  else
+    s.add_dependency(%q<rake>, [">= 0"])
+    s.add_dependency(%q<rim>, ["~> 2.17"])
+    s.add_dependency(%q<regtest>, ["~> 2"])
+  end
+end

data/test/test_formatter.rb

@@ -13,105 +13,105 @@ class TestFormatter < Test::Unit::TestCase
 
   def test_only_book
     text = 'Ruth'
-    assert_formated_text_for_ast text, [pass(text, 8, nil, nil, 8, nil, nil)]
+    assert_formated_text_for_ast text, [pass(text: text, b1: 8, b2: 8)]
   end
 
   def test_book_and_chapter
     text = 'Ruth 2'
-    assert_formated_text_for_ast text, [pass(text, 8, 2, nil, 8, 2, nil)]
+    assert_formated_text_for_ast text, [pass(text: text, b1: 8, c1: 2, b2: 8, c2: 2)]
   end
 
   def test_book_chapter_and_verse
     text = 'Ruth 2,5'
-    assert_formated_text_for_ast text, [pass(text, 8, 2, 5, 8, 2, 5)]
+    assert_formated_text_for_ast text, [pass(text: text, b1: 8, c1: 2, v1: 5, b2: 8, c2: 2, v2: 5)]
   end
 
   def test_verse_range
     text = 'Ruth 2,5-11'
-    assert_formated_text_for_ast text, [pass(text, 8, 2, 5, 8, 2, 11)]
+    assert_formated_text_for_ast text, [pass(text: text, b1: 8, c1: 2, v1: 5, b2: 8, c2: 2, v2: 11)]
   end
 
   def test_chapter_verse_range
     text = 'Ruth 2,5-3,7'
-    assert_formated_text_for_ast text, [pass(text, 8, 2, 5, 8, 3, 7)]
+    assert_formated_text_for_ast text, [pass(text: text, b1: 8, c1: 2, v1: 5, b2: 8, c2: 3, v2: 7)]
   end
 
   def test_chapter_range
     text = 'Ruth 2-3'
-    assert_formated_text_for_ast text, [pass(text, 8, 2, nil, 8, 3, nil)]
+    assert_formated_text_for_ast text, [pass(text: text, b1: 8, c1: 2, b2: 8, c2: 3)]
   end
 
   def test_book_range
     text = '1. Mose-Offenbarung'
-    assert_formated_text_for_ast text, [pass(text, 1, nil, nil, 66, nil, nil)]
+    assert_formated_text_for_ast text, [pass(text: text, b1: 1, b2: 66)]
   end
 
   def test_book_chapter_range
     text = '1. Mose 1-Offenbarung 22'
-    assert_formated_text_for_ast text, [pass(text, 1, 1, nil, 66, 22, nil)]
+    assert_formated_text_for_ast text, [pass(text: text, b1: 1, c1: 1, b2: 66, c2: 22)]
   end
 
   def test_book_chapter_verse_range
     text = '1. Mose 1,1-Offenbarung 22,21'
-    assert_formated_text_for_ast text, [pass(text, 1, 1, 1, 66, 22, 21)]
+    assert_formated_text_for_ast text, [pass(text: text, b1: 1, c1: 1, v1: 1, b2: 66, c2: 22, v2: 21)]
   end
 
   def test_one_following_verse
     text = 'Ruth 2,5f'
-    assert_formated_text_for_ast text, [pass(text, 8, 2, 5, 8, 2, :f)]
+    assert_formated_text_for_ast text, [pass(text: text, b1: 8, c1: 2, v1: 5, b2: 8, c2: 2, v2: :f)]
   end
 
   def test_more_following_verse
     text = 'Ruth 2,5ff'
-    assert_formated_text_for_ast text, [pass(text, 8, 2, 5, 8, 2, :ff)]
+    assert_formated_text_for_ast text, [pass(text: text, b1: 8, c1: 2, v1: 5, b2: 8, c2: 2, v2: :ff)]
   end
 
   def test_first_addon
     text = 'Ruth 2,5a'
-    assert_formated_text_for_ast text, [pass(text, 8, 2, 5, 8, 2, 5, a1: :a)]
+    assert_formated_text_for_ast text, [pass(text: text, b1: 8, c1: 2, v1: 5, b2: 8, c2: 2, v2: 5, a1: :a)]
   end
 
   def test_second_addon
     text = 'Ruth 2,5-7a'
-    assert_formated_text_for_ast text, [pass(text, 8, 2, 5, 8, 2, 7, a2: :a)]
+    assert_formated_text_for_ast text, [pass(text: text, b1: 8, c1: 2, v1: 5, b2: 8, c2: 2, v2: 7, a2: :a)]
   end
 
   def test_both_addons
     text = 'Ruth 2,5b-7a'
-    assert_formated_text_for_ast text, [pass(text, 8, 2, 5, 8, 2, 7, a1: :b, a2: :a)]
+    assert_formated_text_for_ast text, [pass(text: text, b1: 8, c1: 2, v1: 5, b2: 8, c2: 2, v2: 7, a1: :b, a2: :a)]
   end
 
   def test_reset_addons
     text = 'Ruth'
-    assert_formated_text_for_ast text, [pass(text, 8, nil, nil, 8, nil, nil)]
+    assert_formated_text_for_ast text, [pass(text: text, b1: 8, b2: 8)]
   end
 
   def test_book_with_only_one_chapter
     text = 'Obadja 3'
-    assert_formated_text_for_ast text, [pass(text, 31, 1, 3, 31, 1, 3)]
+    assert_formated_text_for_ast text, [pass(text: text, b1: 31, c1: 1, v1: 3, b2: 31, c2: 1, v2: 3)]
     text = 'Obadja 1'
-    assert_formated_text_for_ast text, [pass(text, 31, 1, 1, 31, 1, 1)]
+    assert_formated_text_for_ast text, [pass(text: text, b1: 31, c1: 1, v1: 1, b2: 31, c2: 1, v2: 1)]
   end
 
   def test_book_with_only_one_chapter_range
     text = 'Obadja 3-5'
-    assert_formated_text_for_ast text, [pass(text, 31, 1, 3, 31, 1, 5)]
+    assert_formated_text_for_ast text, [pass(text: text, b1: 31, c1: 1, v1: 3, b2: 31, c2: 1, v2: 5)]
     text = 'Obadja 1-4'
-    assert_formated_text_for_ast text, [pass(text, 31, 1, 1, 31, 1, 4)]
+    assert_formated_text_for_ast text, [pass(text: text, b1: 31, c1: 1, v1: 1, b2: 31, c2: 1, v2: 4)]
   end
 
   def test_book_with_only_one_chapter_at_begin_of_range
     text = 'Obadja-Jona'
-    assert_formated_text_for_ast text, [pass(text, 31, 1, nil, 32, nil, nil)]
+    assert_formated_text_for_ast text, [pass(text: text, b1: 31, c1: 1, b2: 32)]
     text = 'Obadja 3-Jona 2,4'
-    assert_formated_text_for_ast text, [pass(text, 31, 1, 3, 32, 2, 4)]
+    assert_formated_text_for_ast text, [pass(text: text, b1: 31, c1: 1, v1: 3, b2: 32, c2: 2, v2: 4)]
   end
 
   def test_book_with_only_one_chapter_at_end_of_range
     text = 'Amos 2,4-Obadja 3'
-    assert_formated_text_for_ast text, [pass(text, 30, 2, 4, 31, 1, 3)]
+    assert_formated_text_for_ast text, [pass(text: text, b1: 30, c1: 2, v1: 4, b2: 31, c2: 1, v2: 3)]
     text = 'Amos 2,4-Obadja 1'
-    assert_formated_text_for_ast text, [pass(text, 30, 2, 4, 31, 1, 1)]
+    assert_formated_text_for_ast text, [pass(text: text, b1: 30, c1: 2, v1: 4, b2: 31, c2: 1, v2: 1)]
   end
 
   ######################################################################
@@ -121,49 +121,49 @@ class TestFormatter < Test::Unit::TestCase
   def test_two_books
     text = 'Ruth; Markus'
     t1, t2 = text.split(semi)
-    assert_formated_text_for_ast text, [pass(t1, 8, nil, nil, 8, nil, nil), semi, pass(t2, 41, nil, nil, 41, nil, nil)]
+    assert_formated_text_for_ast text, [pass(text: t1, b1: 8, b2: 8), semi, pass(text: t2, b1: 41, b2: 41)]
   end
 
   def test_two_complete_refs
     text = 'Ruth 2,1; Markus 4,8'
     t1, t2 = text.split(semi)
-    assert_formated_text_for_ast text, [pass(t1, 8, 2, 1, 8, 2, 1), semi, pass(t2, 41, 4, 8, 41, 4, 8)]
+    assert_formated_text_for_ast text, [pass(text: t1, b1: 8, c1: 2, v1: 1, b2: 8, c2: 2, v2: 1), semi, pass(text: t2, b1: 41, c1: 4, v1: 8, b2: 41, c2: 4, v2: 8)]
   end
 
   def test_two_refs_same_book
     text = 'Ruth 2,1; 5,4'
     t1, t2 = text.split(semi)
-    assert_formated_text_for_ast text, [pass(t1, 8, 2, 1, 8, 2, 1), semi, pass(t2, 8, 5, 4, 8, 5, 4)]
+    assert_formated_text_for_ast text, [pass(text: t1, b1: 8, c1: 2, v1: 1, b2: 8, c2: 2, v2: 1), semi, pass(text: t2, b1: 8, c1: 5, v1: 4, b2: 8, c2: 5, v2: 4)]
   end
 
   def test_two_chapters_same_book
     text = 'Ruth 2; 5'
     t1, t2 = text.split(semi)
-    assert_formated_text_for_ast text, [pass(t1, 8, 2, nil, 8, 2, nil), semi, pass(t2, 8, 5, nil, 8, 5, nil)]
+    assert_formated_text_for_ast text, [pass(text: t1, b1: 8, c1: 2, b2: 8, c2: 2), semi, pass(text: t2, b1: 8, c1: 5, b2: 8, c2: 5)]
   end
 
   def test_two_chapters_different_book
     text = 'Ruth 2; Markus 4'
     t1, t2 = text.split(semi)
-    assert_formated_text_for_ast text, [pass(t1, 8, 2, nil, 8, 2, nil), semi, pass(t2, 41, 4, nil, 41, 4, nil)]
+    assert_formated_text_for_ast text, [pass(text: t1, b1: 8, c1: 2, b2: 8, c2: 2), semi, pass(text: t2, b1: 41, c1: 4, b2: 41, c2: 4)]
   end
 
   def test_two_verses
     text = 'Ruth 2,5.11'
     t1, t2 = text.split(dot)
-    assert_formated_text_for_ast text, [pass(t1, 8, 2, 5, 8, 2, 5), dot, pass(t2, 8, 2, 11, 8, 2, 11)]
+    assert_formated_text_for_ast text, [pass(text: t1, b1: 8, c1: 2, v1: 5, b2: 8, c2: 2, v2: 5), dot, pass(text: t2, b1: 8, c1: 2, v1: 11, b2: 8, c2: 2, v2: 11)]
   end
 
   def test_partial_passage_after_full_passage
     text = 'Ruth 2,5; 4'
     t1, t2 = text.split(semi)
-    assert_formated_text_for_ast text, [pass(t1, 8, 2, 5, 8, 2, 5), semi, pass(t2, 8, 4, nil, 8, 4, nil)]
+    assert_formated_text_for_ast text, [pass(text: t1, b1: 8, c1: 2, v1: 5, b2: 8, c2: 2, v2: 5), semi, pass(text: t2, b1: 8, c1: 4, b2: 8, c2: 4)]
     text = 'Ruth 2,5; Markus'
     t1, t2 = text.split(semi)
-    assert_formated_text_for_ast text, [pass(t1, 8, 2, 5, 8, 2, 5), semi, pass(t2, 41, nil, nil, 41, nil, nil)]
+    assert_formated_text_for_ast text, [pass(text: t1, b1: 8, c1: 2, v1: 5, b2: 8, c2: 2, v2: 5), semi, pass(text: t2, b1: 41, b2: 41)]
     text = 'Ruth 2,5; Markus 4'
     t1, t2 = text.split(semi)
-    assert_formated_text_for_ast text, [pass(t1, 8, 2, 5, 8, 2, 5), semi, pass(t2, 41, 4, nil, 41, 4, nil)]
+    assert_formated_text_for_ast text, [pass(text: t1, b1: 8, c1: 2, v1: 5, b2: 8, c2: 2, v2: 5), semi, pass(text: t2, b1: 41, c1: 4, b2: 41, c2: 4)]
   end
 
   ######################################################################
@@ -173,61 +173,61 @@ class TestFormatter < Test::Unit::TestCase
   def test_verse_range_and_separated_verse
     text = 'Ruth 2,1-3.11'
     t1, t2 = text.split(dot)
-    assert_formated_text_for_ast text, [pass(t1, 8, 2, 1, 8, 2, 3), dot, pass(t2, 8, 2, 11, 8, 2, 11)]
+    assert_formated_text_for_ast text, [pass(text: t1, b1: 8, c1: 2, v1: 1, b2: 8, c2: 2, v2: 3), dot, pass(text: t2, b1: 8, c1: 2, v1: 11, b2: 8, c2: 2, v2: 11)]
   end
 
   def test_separate_verse_and_verse_range
     text = 'Ruth 2,1.3-11'
     t1, t2 = text.split(dot)
-    assert_formated_text_for_ast text, [pass(t1, 8, 2, 1, 8, 2, 1), dot, pass(t2, 8, 2, 3, 8, 2, 11)]
+    assert_formated_text_for_ast text, [pass(text: t1, b1: 8, c1: 2, v1: 1, b2: 8, c2: 2, v2: 1), dot, pass(text: t2, b1: 8, c1: 2, v1: 3, b2: 8, c2: 2, v2: 11)]
   end
 
   def test_two_verse_ranges
     text = 'Ruth 2,1-3.7-11'
     t1, t2 = text.split(dot)
-    assert_formated_text_for_ast text, [pass(t1, 8, 2, 1, 8, 2, 3), dot, pass(t2, 8, 2, 7, 8, 2, 11)]
+    assert_formated_text_for_ast text, [pass(text: t1, b1: 8, c1: 2, v1: 1, b2: 8, c2: 2, v2: 3), dot, pass(text: t2, b1: 8, c1: 2, v1: 7, b2: 8, c2: 2, v2: 11)]
   end
 
   def test_two_verse_range_different_books
     text = 'Ruth 2,1-11; Markus 4,3-7'
     t1, t2 = text.split(semi)
-    assert_formated_text_for_ast text, [pass(t1, 8, 2, 1, 8, 2, 11), semi, pass(t2, 41, 4, 3,41, 4, 7)]
+    assert_formated_text_for_ast text, [pass(text: t1, b1: 8, c1: 2, v1: 1, b2: 8, c2: 2, v2: 11), semi, pass(text: t2, b1: 41, c1: 4, v1: 3, b2: 41, c2: 4, v2: 7)]
   end
 
   def test_two_verse_range_different_chapters
     text = 'Ruth 2,1-11; 3,10-19'
     t1, t2 = text.split(semi)
-    assert_formated_text_for_ast text, [pass(t1, 8, 2, 1, 8, 2, 11), semi, pass(t2, 8, 3, 10, 8, 3, 19)]
+    assert_formated_text_for_ast text, [pass(text: t1, b1: 8, c1: 2, v1: 1, b2: 8, c2: 2, v2: 11), semi, pass(text: t2, b1: 8, c1: 3, v1: 10, b2: 8, c2: 3, v2: 19)]
   end
 
   def test_book_range_and_following_book
     text = 'Ruth-Markus; Johannes'
     t1, t2 = text.split(semi)
-    assert_formated_text_for_ast text, [pass(t1, 8, nil, nil, 41, nil, nil), semi, pass(t2, 43, nil, nil, 43, nil, nil)]
+    assert_formated_text_for_ast text, [pass(text: t1, b1: 8, b2: 41), semi, pass(text: t2, b1: 43, b2: 43)]
   end
 
   def test_chapter_range_and_following_book
     text = 'Ruth 1-2; Johannes 4'
     t1, t2 = text.split(semi)
-    assert_formated_text_for_ast text, [pass(t1, 8, 1, nil, 8, 2, nil), semi, pass(t2, 43, 4, nil, 43, 4, nil)]
+    assert_formated_text_for_ast text, [pass(text: t1, b1: 8, c1: 1, b2: 8, c2: 2), semi, pass(text: t2, b1: 43, c1: 4, b2: 43, c2: 4)]
   end
 
   def test_chapter_range_and_following_chapter
     text = 'Ruth 1-2; 4'
     t1, t2 = text.split(semi)
-    assert_formated_text_for_ast text, [pass(t1, 8, 1, nil, 8, 2, nil), semi, pass(t2, 8, 4, nil, 8, 4, nil)]
+    assert_formated_text_for_ast text, [pass(text: t1, b1: 8, c1: 1, b2: 8, c2: 2), semi, pass(text: t2, b1: 8, c1: 4, b2: 8, c2: 4)]
   end
 
   def test_book_only_after_full_passage
     text = 'Matthäus 3,4; Markus; Johannes 3,16'
     t1, t2, t3 = text.split(semi)
-    assert_formated_text_for_ast text, [pass(t1, 40, 3, 4, 40, 3, 4), semi, pass(t2, 41, nil, nil, 41, nil, nil), semi, pass(t3, 43, 3, 16, 43, 3, 16)]
+    assert_formated_text_for_ast text, [pass(text: t1, b1: 40, c1: 3, v1: 4, b2: 40, c2: 3, v2: 4), semi, pass(text: t2, b1: 41, b2: 41), semi, pass(text: t3, b1: 43, c1: 3, v1: 16, b2: 43, c2: 3, v2: 16)]
   end
 
   def test_chapter_only_after_full_passage
     text = 'Matthäus 3,4; 8; Johannes 3,16'
     t1, t2, t3 = text.split(semi)
-    assert_formated_text_for_ast text, [pass(t1, 40, 3, 4, 40, 3, 4), semi, pass(t2, 40, 8, nil, 40, 8, nil), semi, pass(t3, 43, 3, 16, 43, 3, 16)]
+    assert_formated_text_for_ast text, [pass(text: t1, b1: 40, c1: 3, v1: 4, b2: 40, c2: 3, v2: 4), semi, pass(text: t2, b1: 40, c1: 8, b2: 40, c2: 8), semi, pass(text: t3, b1: 43, c1: 3, v1: 16, b2: 43, c2: 3, v2: 16)]
   end
 
   ######################################################################
@@ -238,13 +238,13 @@ class TestFormatter < Test::Unit::TestCase
     text = 'Ruth 2,1-11.15; 3,7.9-12; Markus 4; 5,3.18-21'
     t1, t2, t3, t4, t5, t6, t7 = text.split(/; |\./)
     ast = [
-      pass(t1, 8, 2, 1, 8, 2, 11), dot,
-      pass(t2, 8, 2, 15, 8, 2, 15), semi,
-      pass(t3, 8, 3, 7, 8, 3, 7), dot,
-      pass(t4, 8, 3, 9, 8, 3, 12), semi,
-      pass(t5, 41, 4, nil, 41, 4, nil), semi,
-      pass(t6, 41, 5, 3, 41, 5, 3), dot,
-      pass(t7, 41, 5, 18, 41, 5, 21)
+      pass(text: t1, b1: 8, c1: 2, v1: 1, b2: 8, c2: 2, v2: 11), dot,
+      pass(text: t2, b1: 8, c1: 2, v1: 15, b2: 8, c2: 2, v2: 15), semi,
+      pass(text: t3, b1: 8, c1: 3, v1: 7, b2: 8, c2: 3, v2: 7), dot,
+      pass(text: t4, b1: 8, c1: 3, v1: 9, b2: 8, c2: 3, v2: 12), semi,
+      pass(text: t5, b1: 41, c1: 4, b2: 41, c2: 4), semi,
+      pass(text: t6, b1: 41, c1: 5, v1: 3, b2: 41, c2: 5, v2: 3), dot,
+      pass(text: t7, b1: 41, c1: 5, v1: 18, b2: 41, c2: 5, v2: 21)
     ]
     assert_formated_text_for_ast text, ast
   end
@@ -257,13 +257,13 @@ class TestFormatter < Test::Unit::TestCase
     @german_formatter.bookformat = :abbrev
     text = 'Mat 3,4; Mar; Joh 3,16'
     t1, t2, t3 = text.split(semi)
-    assert_formated_text_for_ast text, [pass(t1, 40, 3, 4, 40, 3, 4), semi, pass(t2, 41, nil, nil, 41, nil, nil), semi, pass(t3, 43, 3, 16, 43, 3, 16)]
+    assert_formated_text_for_ast text, [pass(text: t1, b1: 40, c1: 3, v1: 4, b2: 40, c2: 3, v2: 4), semi, pass(text: t2, b1: 41, b2: 41), semi, pass(text: t3, b1: 43, c1: 3, v1: 16, b2: 43, c2: 3, v2: 16)]
   end
 
   def test_exception_for_unhandled_bookformat
     assert_raise NoMethodError do
       @german_formatter.bookformat = :unknown
-      @german_formatter.format [pass(1,2,3,4,5,6,7)]
+      @german_formatter.format [pass(text: 1, b1: 2, c1: 3, v1: 4, b2: 5, c2: 6, v2: 7)]
     end
   end
   private

data/test/test_helper.rb

@@ -4,8 +4,8 @@ require 'test/unit'
 
 module Test::Helper
 
-  def pass *args
-    Scripref::Passage.new(*args)
+  def pass **kwargs
+    Scripref::Passage.new(**kwargs)
   end
 
   def semi