scripref 0.9.1 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5a2bd9fe1cbf211fb440e24443090c3491e9ec0b
-  data.tar.gz: d6e4bd60dd77a8aa63eef39cb4ee777a2315c4ed
+  metadata.gz: 605d0d995b512d6af69e3b2152228dc201085b2b
+  data.tar.gz: a400e265c6d777d287170fbef3edb56c0143fcc6
 SHA512:
-  metadata.gz: b43ac2c70d71ba2420d6dadfe9abe6ae8bcad9b4914c2420d7337fe5bdfe7e11f8ac730042830fd4eff18e76a7e6f3f3e0cc2e58c7caa79b3cd81395e4383cc5
-  data.tar.gz: 9e5b4035b11fbf2305edd243fa703be3b54f8cd0a55ad074737b6a9e9dc63edd1412f3c4272ae074bcd20e6c30b7fb6e3c0215f84738c7d6696646b1437e60a1
+  metadata.gz: 37506e93da2d733beaa800db74ef5d1f16fe7aee313312298752a3f442549434b5360646b62d7d754dc189efa6edf1b09372be04b0a85e8f39dca290f2082b1a
+  data.tar.gz: 1e74214d77ed1f74256c102ea448eba2ba703d90269dc697360494dee102900d9f2503c8310f95ce783d1c92512a9eacba62e734adb8e411729d28dacccf3f98

data/{CHANGELOG → Changelog}

@@ -1,3 +1,12 @@
+0.10.0
+Add methods Passage#make_comparable, #make_comparable!, #comparable?,
+#overlap?, #start, #end and #<=>.
+Implement formatting of more than one passage with formatter.
+Allow passage separator after ranges of books and chapters.
+Add tests and fixing bugs.
+Doing a lot of internal refactorings.
+Add documentation.
+
 0.9.1
 Add Philemon to book with only one chapter.
 

data/lib/scripref.rb

@@ -1,6 +1,7 @@
 # - encoding: utf-8 -
 require 'delegate'
 require 'scripref/parser'
+require 'scripref/passage'
 require 'scripref/processor'
 require 'scripref/formatter'
 require 'scripref/english'
@@ -8,35 +9,25 @@ require 'scripref/german'
 
 module Scripref
 
-  VERSION = '0.9.1'
+  VERSION = '0.10.0'
 
-  Passage = Struct.new(:text, :b1, :c1, :v1, :b2, :c2, :v2, :a1, :a2) do
-
-    include Comparable
-
-    def initialize text, b1, c1, v1, b2, c2, v2, opts={}
-      super text, b1, c1, v1, b2, c2, v2, opts[:a1], opts[:a2]
-    end
-
-    def to_a
-      [b1, c1, v1, b2, c2, v2]
+  class Token < DelegateClass(String)
+    def initialize *args
+      super
     end
+  end
 
-    def <=> o
-      a1 = self.to_a.map {|e| e.nil? ? 0 : e}
-      a2 = o.to_a.map {|e| e.nil? ? 0 : e}
-      a1 <=> a2
-    end
+  class Book < Token; end
+  class Chapter < Token; end
+  class Verse < Token; end
 
-    alias to_s text
-  end
+  class Addon < Token; end
+  class Postfix < Token; end
 
-  class Sep < DelegateClass(String)
-    def initialize s
-      super s
-    end
-  end
+  class Sep < Token; end
   class PassSep < Sep; end
   class VerseSep < Sep; end
 
+  class Space < Token; end
+
 end

data/lib/scripref/english.rb

@@ -42,6 +42,9 @@ module Scripref
     # Regular expression to match a separator between verses.
     VERSE_SEP_RE = /,\s*/o
 
+    # Separator between verses.
+    VERSE_SEPARATOR = ','
+
     # Regular expression to match addons for a verse.
     VERSE_ADDON_RE = /[ab]\s*/o
 

data/lib/scripref/formatter.rb

@@ -16,20 +16,41 @@ module Scripref
     # Formats a reference (array of passages)
     def format *reference
       @last_b = @last_c = @last_v = :undefined
-      @result = ''
-      reference.flatten.each do |pass|
-        @pass = pass
+      @result = []
+      reference.flatten.each do |entry|
+        next if entry.kind_of? Sep
+        @pass = entry
         process_passage
       end
-      @result
+      @result.join
     end
 
     def format_book num
       Array(book_names[num - 1]).first
     end
 
+    def format_chapter num
+      num.to_s
+    end
+
+    def format_verse num
+      num.to_s
+    end
+
+    def format_addon a
+      a.to_s
+    end
+
+    def format_postfix p
+      p.to_s
+    end
+
     private
 
+    def last_token
+      @result.last
+    end
+
     def process_passage
       @changed = false
       process_b1
@@ -38,7 +59,11 @@ module Scripref
     def process_b1
       b1 = @pass.b1
       if @last_b != b1
-        @result << format_book(b1)
+        case last_token
+        when Token
+          push_sep pass_separator
+        end
+        push_book b1
         @last_b = b1
         @changed = true
       end
@@ -48,9 +73,14 @@ module Scripref
     def process_c1
       c1 = @pass.c1
       if c1 && (@changed || @last_c != c1)
-        @result << ' '
         if ! book_has_only_one_chapter?(@pass.b1)
-          @result << c1.to_s
+          case last_token
+          when Book
+            push_space
+          when Token
+            push_sep pass_separator
+          end
+          push_chapter c1
         end
         @last_c = c1
         @changed = true
@@ -62,9 +92,16 @@ module Scripref
       v1 = @pass.v1
       if v1 && (@changed || @last_v != v1)
         if ! book_has_only_one_chapter?(@pass.b1)
-          @result << cv_separator
+          case last_token
+          when Verse
+            push_sep verse_separator
+          when Token
+            push_sep cv_separator
+          end
+        else
+          push_space
         end
-        @result << v1.to_s
+        push_verse v1
         @last_v = v1
         process_a1
       end
@@ -73,7 +110,7 @@ module Scripref
 
     def process_a1
       a1 = @pass.a1
-      @result << a1.to_s if a1
+      push_addon a1
     end
 
     def process_b2
@@ -81,8 +118,8 @@ module Scripref
       @hyphen = false
       b2 = @pass.b2
       if b2 && (@changed || @last_b != b2)
-        @result << hyphen_separator
-        @result << format_book(b2)
+        push_sep hyphen_separator
+        push_book(b2)
         @last_b = b2
         @changed = true
         @hyphen = true
@@ -94,13 +131,13 @@ module Scripref
       c2 = @pass.c2
       if c2 && (@changed || @last_c != c2)
         if @hyphen
-          @result << ' '
+          push_space
         else
-          @result << hyphen_separator
+          push_sep hyphen_separator
           @hyphen = true
         end
         if ! book_has_only_one_chapter?(@pass.b2)
-          @result << c2.to_s
+          push_chapter c2
         end
         @last_c = c2
         @changed = true
@@ -112,22 +149,22 @@ module Scripref
       v2 = @pass.v2
       case v2
       when :f
-        @result << postfix_one_following_verse
+        push_postfix postfix_one_following_verse
         return
       when :ff
-        @result << postfix_more_following_verses
+        push_postfix postfix_more_following_verses
         return
       end
       if v2 && (@changed || @last_v != v2)
         if @hyphen
           if ! book_has_only_one_chapter?(@pass.b2)
-            @result << cv_separator
+            push_sep cv_separator
           end
         else
-          @result << hyphen_separator
+          push_sep hyphen_separator
           @hyphen = true
         end
-        @result << v2.to_s
+        push_verse v2
         @last_v = @v2
         @changed = true
         process_a2
@@ -136,7 +173,37 @@ module Scripref
 
     def process_a2
       a2 = @pass.a2
-      @result << a2.to_s if a2
+      push_addon a2
+    end
+
+    def push_book b
+      @result << Book.new(format_book(b))
+    end
+
+    def push_chapter c
+      @result << Chapter.new(format_chapter(c))
+    end
+
+    def push_verse v
+      @result << Verse.new(format_verse(v))
+    end
+
+    def push_addon a
+      if a
+        @result << Addon.new(format_addon(a))
+      end
+    end
+
+    def push_postfix p
+      @result << Postfix.new(format_postfix(p))
+    end
+
+    def push_space
+      @result << Space.new(' ')
+    end
+
+    def push_sep s
+      @result << Sep.new(s)
     end
 
     alias << format

data/lib/scripref/german.rb

@@ -39,6 +39,9 @@ module Scripref
     # Regular expression to match a separator between verses.
     VERSE_SEP_RE = /\.\s*/o
 
+    # Separator between verses.
+    VERSE_SEPARATOR = '.'
+
     # Regular expression to match addons for a verse.
     VERSE_ADDON_RE = /[ab]\s*/o
 

data/lib/scripref/parser.rb

@@ -52,8 +52,11 @@ module Scripref
       s = scan(book_re) or return nil
       @text << s
       @b1 = @b2 = abbrev2num(s)
+      @c1 = @v1 = @c2 = @v2 = nil
 
-      if check(Regexp.new(chapter_re.source + cv_sep_re.source))
+      if pass_sep
+        b1 or give_up 'EOS or book expected!'
+      elsif check(Regexp.new(chapter_re.source + cv_sep_re.source))
         @c1 = @v1 = nil
         @c2 = @v2 = nil
         c1
@@ -74,6 +77,7 @@ module Scripref
       s = scan(chapter_re) or return nil
       @text << s
       @c1 = @c2 = s.to_i
+      @v1 = @v2 = nil
 
       if cv_sep
         v1 or give_up 'Verse expected!'
@@ -123,14 +127,16 @@ module Scripref
       @b2 = abbrev2num(s)
       @c2 = @v2 = nil
 
-      if check(Regexp.new(chapter_re.source + cv_sep_re.source))
+      if pass_sep
+        b1 or give_up 'EOS or book expected!'
+      elsif check(Regexp.new(chapter_re.source + cv_sep_re.source))
         c2
       else
         if book_has_only_one_chapter?(@b2)
           @c2 = 1
           epsilon or v2 or give_up 'EOS or chapter or verse expected!'
         else
-          epsilon or c2 or ('EOS or chapter expected')
+          epsilon or c2 or give_up 'EOS or chapter expected!'
         end
       end
     end
@@ -143,6 +149,8 @@ module Scripref
 
       if cv_sep
         v2 or give_up 'Verse expected!'
+      elsif pass_sep
+        b1 or c1 or give_up 'Book or chapter expected!'
       else
         epsilon or give_up 'EOS or chapter verse separator expected!'
       end

data/lib/scripref/passage.rb

@@ -0,0 +1,76 @@
+# - encoding: utf-8 -
+module Scripref
+
+  Passage = Struct.new(:text, :b1, :c1, :v1, :b2, :c2, :v2, :a1, :a2) do
+
+    include Comparable
+
+    def initialize text, b1, c1, v1, b2, c2, v2, a1: nil, a2: nil
+      super text, b1, c1, v1, b2, c2, v2, a1, a2
+    end
+
+    def to_a
+      [b1, c1, v1, b2, c2, v2]
+    end
+
+    def <=> other
+      return unless other.kind_of? Passage
+      self.make_comparable.to_a <=> other.make_comparable.to_a
+    end
+
+    # Returns a copy which is comparable, that means
+    # all values are numeric.
+    # This is a heuristic approach.
+    def make_comparable max: 999, ff: 3
+      self.dup.make_comparable! max: max, ff: ff
+    end
+
+    # Makes the Passage instance comparable, that means
+    # all values are numeric.
+    # This is a heuristic approach.
+    def make_comparable! max: 999, ff: 3
+      self.b1 ||= 1
+      self.c1 ||= 1
+      self.v1 ||= 1
+      self.b2 ||= max
+      self.c2 ||= max
+      self.v2 ||= max
+      if self.v2 == :f
+        self.v2 = self.v1 + 1
+      end
+      if self.v2 == :ff
+        self.v2 = self.v1 + ff
+      end
+      self
+    end
+
+    # Checks if the instance is comparable, that means
+    # all values are numeric and so the <=> method
+    # can be applied.
+    def comparable?
+      to_a.map {|e| Numeric === e}.uniq == [true]
+    end
+
+    # Returns true if the instance and the given passage overlap.
+    # That means both has at least one verse in common.
+    def overlap? passage
+      fail ArgumentError, 'value must be a passage' unless passage.kind_of? Passage
+      a = self.make_comparable.to_a
+      b = passage.make_comparable.to_a
+      [a[0..2] <=> b[3..5], b[0..2] <=> a[3..5]].max < 1
+    end
+
+    # Returns an array of b1, c1, v1
+    def start
+      [b1, c1, v1]
+    end
+
+    # Returns an array of b2, c2, v2
+    def end
+      [b2, c2, v2]
+    end
+
+    alias to_s text
+  end
+
+end

data/regtest/parser.yml

@@ -340,10 +340,10 @@ result:
 - :text: '4'
   :b1: 8
   :c1: 4
-  :v1: 9
+  :v1: 
   :b2: 8
   :c2: 4
-  :v2: 12
+  :v2: 
   :a1: 
   :a2: 
 - "; "
@@ -369,9 +369,9 @@ result:
 ---
 sample: Ruth 2,1a-11.15a; 3,7b.9-12b; Markus ; 5,3a.18b-21a
 exception: |-
-  EOS or hyphen and book or chapter expected!
+  EOS or book expected!
   Ruth 2,1a-11.15a; 3,7b.9-12b; Markus ; 5,3a.18b-21a
-                                       ^
+                                         ^
 ---
 sample: Ruth 2,1a-11.15a; 3,7b.9-12b; Markus 45,3a.18b-21a
 result:

data/test/test_formatter.rb

@@ -18,126 +18,248 @@ class TestFormatter < Test::Unit::TestCase
   end
 
   def test_only_book
-    @german = 'Römer'
-    @english = 'Romans'
-    check_formatting
+    text = 'Ruth'
+    assert_formated_text_for_ast text, [pass(text, 8, nil, nil, 8, nil, nil)]
   end
 
   def test_book_and_chapter
-    @german = 'Römer 8'
-    @english = 'Romans 8'
-    check_formatting
+    text = 'Ruth 2'
+    assert_formated_text_for_ast text, [pass(text, 8, 2, nil, 8, 2, nil)]
   end
 
-  def test_one_verse
-    @german = 'Römer 6,23'
-    @english = 'Romans 6:23'
-    check_formatting
+  def test_book_chapter_and_verse
+    text = 'Ruth 2,5'
+    assert_formated_text_for_ast text, [pass(text, 8, 2, 5, 8, 2, 5)]
   end
 
-  def test_book_range
-    @german = 'Römer-Hebräer'
-    @english = 'Romans-Hebrews'
-    check_formatting
+  def test_verse_range
+    text = 'Ruth 2,5-11'
+    assert_formated_text_for_ast text, [pass(text, 8, 2, 5, 8, 2, 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)]
   end
 
   def test_chapter_range
-    @german = 'Römer 1-8'
-    @english = 'Romans 1-8'
-    check_formatting
+    text = 'Ruth 2-3'
+    assert_formated_text_for_ast text, [pass(text, 8, 2, nil, 8, 3, nil)]
+  end
+
+  def test_book_range
+    text = '1. Mose-Offenbarung'
+    assert_formated_text_for_ast text, [pass(text, 1, nil, nil, 66, nil, nil)]
+  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)]
+  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)]
+  end
+
+  def test_one_following_verse
+    text = 'Ruth 2,5f'
+    assert_formated_text_for_ast text, [pass(text, 8, 2, 5, 8, 2, :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)]
   end
 
-  def test_simple_passage
-    @german = 'Römer 8,1-10'
-    @english = 'Romans 8:1-10'
-    check_formatting
+  def test_first_addon
+    text = 'Ruth 2,5a'
+    assert_formated_text_for_ast text, [pass(text, 8, 2, 5, 8, 2, 5, a1: :a)]
   end
 
-  def test_passage_with_chapter_change
-    @german = 'Römer 1,1-5,11'
-    @english = 'Romans 1:1-5:11'
-    check_formatting
+  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)]
   end
 
-  def test_passage_with_book_change
-    @german = '1. Korinther 1,1-2. Korinther 13,13'
-    @english = '1 Corinthians 1:1-2 Corinthians 13:13'
-    check_formatting
+  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)]
   end
 
-  def test_passage_with_different_chapter_and_same_verse
-    @german = '2. Petrus 1,13-2,13'
-    @english = '2 Peter 1:13-2:13'
-    check_formatting
+  def test_reset_addons
+    @parser.parse 'Ruth 2,5b-7a'
+    text = 'Ruth'
+    assert_formated_text_for_ast text, [pass(text, 8, nil, nil, 8, nil, nil)]
   end
 
   def test_book_with_only_one_chapter
-    @german = 'Obadja 3'
-    @english = 'Obadiah 3'
-    check_formatting
+    text = 'Obadja 3'
+    assert_formated_text_for_ast text, [pass(text, 31, 1, 3, 31, 1, 3)]
+    text = 'Obadja 1'
+    assert_formated_text_for_ast text, [pass(text, 31, 1, 1, 31, 1, 1)]
   end
 
   def test_book_with_only_one_chapter_range
-    @german = 'Obadja 3-5'
-    @english = 'Obadiah 3-5'
-    check_formatting
+    text = 'Obadja 3-5'
+    assert_formated_text_for_ast text, [pass(text, 31, 1, 3, 31, 1, 5)]
+    text = 'Obadja 1-4'
+    assert_formated_text_for_ast text, [pass(text, 31, 1, 1, 31, 1, 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)]
+    text = 'Obadja 3-Jona 2,4'
+    assert_formated_text_for_ast text, [pass(text, 31, 1, 3, 32, 2, 4)]
   end
 
   def test_book_with_only_one_chapter_at_end_of_range
-    @german = 'Amos 2,4-Obadja 3'
-    @english = 'Amos 2:4-Obadiah 3'
-    check_formatting
+    text = 'Amos 2,4-Obadja 3'
+    assert_formated_text_for_ast text, [pass(text, 30, 2, 4, 31, 1, 3)]
+    text = 'Amos 2,4-Obadja 1'
+    assert_formated_text_for_ast text, [pass(text, 30, 2, 4, 31, 1, 1)]
   end
 
-  def test_attr_writer_overrides_value_of_mixin
-    @german = '1. Korinther 1,1 - 2. Korinther 13,13'
-    @english = '1 Corinthians 1:1 - 2 Corinthians 13:13'
-    @german_formatter.hyphen_separator = ' - '
-    @english_formatter.hyphen_separator = ' - '
-    check_formatting
+  ######################################################################
+  # more than one passage
+  ######################################################################
+
+  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)]
   end
 
-  def test_alternative_booknames
-    ast = @parser.parse('Zephanja 1,8')
-    assert_equal 'Zefanja 1,8', @german_formatter.format(ast)
+  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)]
   end
 
-  def test_addon1
-    @german = 'Markus 2,4b'
-    @english = 'Mark 2:4b'
-    check_formatting
+  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)]
   end
 
-  def test_addon2
-    @german = 'Markus 2,2-4b'
-    @english = 'Mark 2:2-4b'
-    check_formatting
+  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)]
   end
 
-  def test_both_addons
-    @german = 'Markus 2,2b-4a'
-    @english = 'Mark 2:2b-4a'
-    check_formatting
+  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)]
   end
 
-  def test_postfix_one_following_verse
-    @german = 'Markus 2,2f'
-    @english = 'Mark 2:2f'
-    check_formatting
+  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)]
   end
 
-  def test_postfix_more_following_verses
-    @german = 'Markus 2,2ff'
-    @english = 'Mark 2:2ff'
-    check_formatting
+  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)]
+    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)]
+    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)]
+  end
+
+  ######################################################################
+  # mixed variants of more than one passage
+  ######################################################################
+
+  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)]
+  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)]
+  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)]
+  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)]
+  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)]
+  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)]
+  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)]
+  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)]
+  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)]
+  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)]
+  end
+
+  ######################################################################
+  # complex variants of references
+  ######################################################################
+
+  def test_complex_example
+    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)
+    ]
+    assert_formated_text_for_ast text, ast
   end
 
   private
 
-  def check_formatting
-    ast = @parser.parse(@german)
-    assert_equal @german, @german_formatter.format(ast)
-    assert_equal @english, @english_formatter.format(ast)
+  def assert_formated_text_for_ast text, ast
+    assert_equal text, @german_formatter.format(ast)
   end
 
 end

data/test/test_integration.rb

@@ -0,0 +1,143 @@
+# - encoding: utf-8 -
+require 'test/unit'
+require 'test_helper'
+require 'scripref'
+require 'scripref/english'
+require 'scripref/formatter'
+require 'scripref/german'
+require 'scripref/parser'
+
+class TestIntegration < Test::Unit::TestCase
+
+  include Test::Helper
+
+  def setup
+    @parser = Scripref::Parser.new(Scripref::German)
+    @german_formatter = Scripref::Formatter.new(Scripref::German)
+    @english_formatter = Scripref::Formatter.new(Scripref::English)
+  end
+
+  def test_only_book
+    @german = 'Römer'
+    @english = 'Romans'
+    check_formatting
+  end
+
+  def test_book_and_chapter
+    @german = 'Römer 8'
+    @english = 'Romans 8'
+    check_formatting
+  end
+
+  def test_one_verse
+    @german = 'Römer 6,23'
+    @english = 'Romans 6:23'
+    check_formatting
+  end
+
+  def test_book_range
+    @german = 'Römer-Hebräer'
+    @english = 'Romans-Hebrews'
+    check_formatting
+  end
+
+  def test_chapter_range
+    @german = 'Römer 1-8'
+    @english = 'Romans 1-8'
+    check_formatting
+  end
+
+  def test_simple_passage
+    @german = 'Römer 8,1-10'
+    @english = 'Romans 8:1-10'
+    check_formatting
+  end
+
+  def test_passage_with_chapter_change
+    @german = 'Römer 1,1-5,11'
+    @english = 'Romans 1:1-5:11'
+    check_formatting
+  end
+
+  def test_passage_with_book_change
+    @german = '1. Korinther 1,1-2. Korinther 13,13'
+    @english = '1 Corinthians 1:1-2 Corinthians 13:13'
+    check_formatting
+  end
+
+  def test_passage_with_different_chapter_and_same_verse
+    @german = '2. Petrus 1,13-2,13'
+    @english = '2 Peter 1:13-2:13'
+    check_formatting
+  end
+
+  def test_book_with_only_one_chapter
+    @german = 'Obadja 3'
+    @english = 'Obadiah 3'
+    check_formatting
+  end
+
+  def test_book_with_only_one_chapter_range
+    @german = 'Obadja 3-5'
+    @english = 'Obadiah 3-5'
+    check_formatting
+  end
+
+  def test_book_with_only_one_chapter_at_end_of_range
+    @german = 'Amos 2,4-Obadja 3'
+    @english = 'Amos 2:4-Obadiah 3'
+    check_formatting
+  end
+
+  def test_attr_writer_overrides_value_of_mixin
+    @german = '1. Korinther 1,1 - 2. Korinther 13,13'
+    @english = '1 Corinthians 1:1 - 2 Corinthians 13:13'
+    @german_formatter.hyphen_separator = ' - '
+    @english_formatter.hyphen_separator = ' - '
+    check_formatting
+  end
+
+  def test_alternative_booknames
+    ast = @parser.parse('Zephanja 1,8')
+    assert_equal 'Zefanja 1,8', @german_formatter.format(ast)
+  end
+
+  def test_addon1
+    @german = 'Markus 2,4b'
+    @english = 'Mark 2:4b'
+    check_formatting
+  end
+
+  def test_addon2
+    @german = 'Markus 2,2-4b'
+    @english = 'Mark 2:2-4b'
+    check_formatting
+  end
+
+  def test_both_addons
+    @german = 'Markus 2,2b-4a'
+    @english = 'Mark 2:2b-4a'
+    check_formatting
+  end
+
+  def test_postfix_one_following_verse
+    @german = 'Markus 2,2f'
+    @english = 'Mark 2:2f'
+    check_formatting
+  end
+
+  def test_postfix_more_following_verses
+    @german = 'Markus 2,2ff'
+    @english = 'Mark 2:2ff'
+    check_formatting
+  end
+
+  private
+
+  def check_formatting
+    ast = @parser.parse(@german)
+    assert_equal @german, @german_formatter.format(ast)
+    assert_equal @english, @english_formatter.format(ast)
+  end
+
+end

data/test/test_parser.rb

@@ -116,6 +116,15 @@ class TestParser < Test::Unit::TestCase
     assert_parsed_ast_for_text [pass(text, 31, 1, 1, 31, 1, 4)], text
   end
 
+  def test_book_with_only_one_chapter_at_begin_of_range
+    text = 'Obad - Jona'
+    assert_parsed_ast_for_text [pass(text, 31, 1, nil, 32, nil, nil)], text
+    text = 'Obad 3 - Jona 2,4'
+    assert_parsed_ast_for_text [pass(text, 31, 1, 3, 32, 2, 4)], text
+    text = 'Obad 1,3 - Jona 2,4'
+    assert_parsed_ast_for_text [pass(text, 31, 1, 3, 32, 2, 4)], text
+  end
+
   def test_book_with_only_one_chapter_at_end_of_range
     text = 'Amos 2,4 - Obad 3'
     assert_parsed_ast_for_text [pass(text, 30, 2, 4, 31, 1, 3)], text
@@ -128,9 +137,15 @@ class TestParser < Test::Unit::TestCase
   end
 
   ######################################################################
-  # more than one reference
+  # more than one passage
   ######################################################################
 
+  def test_two_books
+    text = 'Ruth; Markus'
+    t1, t2 = text.split(semi)
+    assert_parsed_ast_for_text [pass(t1, 8, nil, nil, 8, nil, nil), semi, pass(t2, 41, nil, nil, 41, nil, nil)], text
+  end
+
   def test_two_complete_refs
     text = 'Ruth 2,1; Markus 4,8'
     t1, t2 = text.split(semi)
@@ -161,8 +176,20 @@ class TestParser < Test::Unit::TestCase
     assert_parsed_ast_for_text [pass(t1, 8, 2, 5, 8, 2, 5), dot, pass(t2, 8, 2, 11, 8, 2, 11)], text
   end
 
+  def test_partial_passage_after_full_passage
+    text = 'Ruth 2,5; 4'
+    t1, t2 = text.split(semi)
+    assert_parsed_ast_for_text [pass(t1, 8, 2, 5, 8, 2, 5), semi, pass(t2, 8, 4, nil, 8, 4, nil)], text
+    text = 'Ruth 2,5; Markus'
+    t1, t2 = text.split(semi)
+    assert_parsed_ast_for_text [pass(t1, 8, 2, 5, 8, 2, 5), semi, pass(t2, 41, nil, nil, 41, nil, nil)], text
+    text = 'Ruth 2,5; Markus 4'
+    t1, t2 = text.split(semi)
+    assert_parsed_ast_for_text [pass(t1, 8, 2, 5, 8, 2, 5), semi, pass(t2, 41, 4, nil, 41, 4, nil)], text
+  end
+
   ######################################################################
-  # mixed variants of more than one reference
+  # mixed variants of more than one passage
   ######################################################################
 
   def test_verse_range_and_separated_verse
@@ -195,6 +222,36 @@ class TestParser < Test::Unit::TestCase
     assert_parsed_ast_for_text [pass(t1, 8, 2, 1, 8, 2, 11), semi, pass(t2, 8, 3, 10, 8, 3, 19)], text
   end
 
+  def test_book_range_and_following_book
+    text = 'Ruth-Markus; Johannes'
+    t1, t2 = text.split(semi)
+    assert_parsed_ast_for_text [pass(t1, 8, nil, nil, 41, nil, nil), semi, pass(t2, 43, nil, nil, 43, nil, nil)], text
+  end
+
+  def test_chapter_range_and_following_book
+    text = 'Ruth 1-2; Joh 4'
+    t1, t2 = text.split(semi)
+    assert_parsed_ast_for_text [pass(t1, 8, 1, nil, 8, 2, nil), semi, pass(t2, 43, 4, nil, 43, 4, nil)], text
+  end
+
+  def test_chapter_range_and_following_chapter
+    text = 'Ruth 1-2; 4'
+    t1, t2 = text.split(semi)
+    assert_parsed_ast_for_text [pass(t1, 8, 1, nil, 8, 2, nil), semi, pass(t2, 8, 4, nil, 8, 4, nil)], text
+  end
+
+  def test_book_only_after_full_passage
+    text = 'Matt 3,4; Mar; Joh 3,16'
+    t1, t2, t3 = text.split(semi)
+    assert_parsed_ast_for_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)], text
+  end
+
+  def test_chapter_only_after_full_passage
+    text = 'Matt 3,4; 8; Joh 3,16'
+    t1, t2, t3 = text.split(semi)
+    assert_parsed_ast_for_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)], text
+  end
+
   ######################################################################
   # complex variants of references
   ######################################################################

data/test/test_passage.rb

@@ -14,10 +14,75 @@ class TestPassage < Test::Unit::TestCase
     assert_equal [41, 1, 2, 42, 3, 4], pass.to_a
   end
 
-  def test_ordering
+  def test_spaceship_operator
+    ast = @parser.parse('Mar 2,3; Joh 1,5')
+    p1, p2 = ast[0], ast[2]
+    assert_nil p1 <=> :other_value
+    assert_nil :other_value <=> p1
+    assert_equal (-1), p1 <=> p2
+    assert_equal 0, p1 <=> p1
+    assert_equal 1, p2 <=> p1
+  end
+
+  def test_comparable_with_sort
     ast = @parser.parse('Joh 8,1-9,11; 8,2-9,12; 8,2-9,11; 8,1-9,12; Joh 8')
-    passages = ast.select {|e| Scripref::Passage === e}
-    assert_equal ["Joh 8", "Joh 8,1-9,11", "8,1-9,12", "8,2-9,11", "8,2-9,12"], passages.sort.map(&:text)
+    passages = ast.grep(Scripref::Passage)
+    expect = ['Joh 8',
+              'Joh 8,1-9,11',
+              '8,1-9,12',
+              '8,2-9,11',
+              '8,2-9,12']
+    assert_equal expect, passages.sort.map(&:text)
+
+    ast = @parser.parse('Mar 1; 1,1; 1,1f; 1,1ff; 1,2; 1,1-2,2; Mar 1-2; Markus; Markus-Lukas; Mar 1-Luk 2; Mar 1,1-Luk 2,2')
+    passages = ast.grep(Scripref::Passage)
+    formatter = Scripref::Formatter.new(Scripref::German)
+    expect = ['Markus 1,1',
+              'Markus 1,1f',
+              'Markus 1,1ff',
+              'Markus 1',
+              'Markus 1,1-2,2',
+              'Markus 1-2',
+              'Markus',
+              'Markus 1,1-Lukas 2,2',
+              'Markus 1-Lukas 2',
+              'Markus-Lukas',
+              'Markus 1,2']
+    assert_equal expect, passages.sort.map {|e| formatter << e}
+  end
+
+  def test_overlap
+    a = @parser.parse('Joh 8,1-9').first
+    b = @parser.parse('Joh 8,8-11').first
+    c = @parser.parse('Joh 8,12-15').first
+    d = @parser.parse('Joh 8,15-18').first
+    e = @parser.parse('Joh 8').first
+    assert_overlap a, a
+    assert_overlap a, b
+    assert_not_overlap b, c
+    assert_overlap c, d
+    assert_overlap d, e
+  end
+
+  def test_start
+    p = Scripref::Passage.new('', 1, 2, 3, 4, 5, 6)
+    assert_equal [1, 2, 3], p.start
   end
 
+  def test_end
+    p = Scripref::Passage.new('', 1, 2, 3, 4, 5, 6)
+    assert_equal [4, 5, 6], p.end
+  end
+
+  protected
+
+  def assert_overlap a, b
+    assert a.overlap?(b)
+    assert b.overlap?(a)
+  end
+
+  def assert_not_overlap a, b
+    assert !a.overlap?(b)
+    assert !b.overlap?(a)
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scripref
 version: !ruby/object:Gem::Version
-  version: 0.9.1
+  version: 0.10.0
 platform: ruby
 authors:
 - Jan Friedrich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-19 00:00:00.000000000 Z
+date: 2016-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rim
@@ -44,7 +44,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- CHANGELOG
+- Changelog
 - LICENSE
 - README.md
 - Rakefile
@@ -54,6 +54,7 @@ files:
 - lib/scripref/formatter.rb
 - lib/scripref/german.rb
 - lib/scripref/parser.rb
+- lib/scripref/passage.rb
 - lib/scripref/pipelining.rb
 - lib/scripref/processor.rb
 - regtest/formatter.rb
@@ -64,6 +65,7 @@ files:
 - 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
@@ -87,9 +89,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.3
 signing_key: 
 specification_version: 4
 summary: Library for parsing scripture references in real texts.
 test_files: []
-has_rdoc: