scripref 0.15.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9424ceb062e9f3a2aa526c65f567b0bcf701c50fef3179f62e3ebe379cbae657
-  data.tar.gz: 6743fc2a2e22cadc78ab32a58ae0886e9f99d72ae8e53c1902130b81b72f3cbf
+  metadata.gz: 18851c425f1c4a9504ede784a43a46d80a668c9059bc000d6f866b6ce3a5ffe2
+  data.tar.gz: e7cdaa42c34785fd755dc747247ea100ca757c9fed062cca691060c8c5288c3b
 SHA512:
-  metadata.gz: 6213a3eafeacb7f56ae929f7d09b083e9eaffd92b09115492cebfd2b343761dac77899d2e2d2394a4e84c72a82ae60abf84811eee5f32a5fdfcfa1a068089265
-  data.tar.gz: 820bb49d040ca7b05c9a6367f6f30b0aeb09737362a3303ce498c306b98ac4015e6e7e25817666a33cefd674a21d8d4522cb74816a20942c00df8a699d5548bb
+  metadata.gz: 01c5874544e15524587022c02e5e3002fa170f07889248f1937410671f94e03db239ec8fd5cfd47db8dee687c7b41b9ba56a4fb8fd12ebffb6f050b3a64eb2c3
+  data.tar.gz: 1745d52b620f5b71e9f12627a9b797f668f160e914de8869ab05c692218b87567aa08ff4eae6b2d04e9cad36dd43c1d868d5c8ac4f4b47cfcfeb19e41eea1063

data/Changelog

@@ -1,3 +1,12 @@
+1.1.0
+Adapt German abbreviations.
+
+1.0.0
+Major release with following two incompatible changes:
+Use OSIS abbreviations for books.
+Remove Passage#+ and Passage#-. This methods seems not to be so useful.
+Further a new module Bookorder is introduced.
+
 0.15.0
 Add some more abbreviations for German book names.
 

data/Rakefile

@@ -2,19 +2,9 @@ require 'rim/tire'
 require 'rim/regtest'
 require 'rim/version'
 
-$:.unshift File.dirname(__FILE__) + '/lib'
-require 'scripref'
-
 Rim.setup do
-  name 'scripref'
-  authors 'Jan Friedrich'
-  email 'janfri26@gmail.com'
-  homepage 'https://github.com/janfri/scripref'
-  version Scripref::VERSION
-  summary 'Library for parsing scripture references in real texts.'
   if feature_loaded? 'rim/irb'
     irb_requires %w(scripref scripref/include scripref/pipelining)
   end
-  ruby_version '>=2.5.0'
   test_warning false
 end

data/lib/scripref/basic_methods.rb

@@ -1,4 +1,6 @@
-# - encoding: utf-8 -
+# encoding: utf-8
+# frozen_string_literal: false
+
 module Scripref
 
   # Mixin with methods of basic functionality

data/lib/scripref/bookname.rb

@@ -1,12 +1,14 @@
-# - encoding: utf-8 -
+# encoding: utf-8
+# frozen_string_literal: true
 
 module Scripref
 
   class Bookname
 
-    attr_reader :names, :abbrevs
+    attr_reader :osis_id, :names, :abbrevs
 
-    def initialize names, abbrevs
+    def initialize osis_id:, names:, abbrevs:
+      @osis_id = osis_id
       @names = Array(names)
       @abbrevs = Array(abbrevs)
     end
@@ -20,7 +22,7 @@ module Scripref
     end
 
     def to_s
-      @names.first
+      @osis_id
     end
 
     alias to_str to_s

data/lib/scripref/bookorder.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+module Scripref
+
+  # Constants of different orderings of bible books using standardized IDs
+  # (see https://wiki.crosswire.org/OSIS_Book_Abbreviations)
+  module Bookorder
+
+    # Canonical order (the default order without any apocryphal books)
+    CANONICAL = %i[
+      Gen Exod Lev Num Deut Josh Judg Ruth 1Sam 2Sam 1Kgs 2Kgs 1Chr 2Chr Ezra
+      Neh Esth Job Ps Prov Eccl Song Isa Jer Lam Ezek Dan Hos Joel Amos Obad
+      Jonah Mic Nah Hab Zeph Hag Zech Mal Matt Mark Luke John Acts Rom 1Cor
+      2Cor Gal Eph Phil Col 1Thess 2Thess 1Tim 2Tim Titus Phlm Heb Jas 1Pet
+      2Pet 1John 2John 3John Jude Rev
+    ]
+  end
+
+end

data/lib/scripref/const_reader.rb

@@ -1,4 +1,5 @@
-# - encoding: utf-8 -
+# encoding: utf-8
+# frozen_string_literal: false
 
 # Mixin to generate instance methods to access of mixin constants.
 #

data/lib/scripref/english.rb

@@ -1,5 +1,6 @@
-# - encoding: utf-8 -
-require 'scripref/bookname'
+# encoding: utf-8
+# frozen_string_literal: true
+
 require 'scripref/const_reader'
 
 module Scripref
@@ -31,7 +32,10 @@ module Scripref
     END
 
     # Array of book names.
-    BOOK_NAMES = book_names.zip(book_abbrevs).map {|name, abbrev| Bookname.new(name, abbrev)}
+    BOOK_NAMES = Bookorder::CANONICAL.zip(book_names, book_abbrevs).map {|osis_book_id, names, abbrevs| Bookname.new(osis_id: osis_book_id, names: names, abbrevs: abbrevs)}
+
+    # Map of OSIS book ID to instance of Bookname
+    OSIS_BOOK_ID_TO_BOOK_NAME = Bookorder::CANONICAL.zip(BOOK_NAMES).map {|id, n| [id, n]}.to_h
 
     # Separator between chapter and verse.
     CV_SEPARATOR = ':'
@@ -73,9 +77,9 @@ module Scripref
     POSTFIX_MORE_FOLLOWING_VERSES_RE = /ff\b\s*/o
 
     # Check if book has only one chapter
-    # @param book book as number
-    def book_has_only_one_chapter? book
-      [31, 57, 63, 64, 65].include?(book)
+    # @param osis_id OSIS-ID of the book
+    def book_has_only_one_chapter? osis_id
+      %i[Obad Phlm 2John 3John Jude].include?(osis_id)
     end
 
     # Regular expression to match punctuation marks

data/lib/scripref/formatter.rb

@@ -1,4 +1,5 @@
-# - encoding: utf-8 -
+# encoding: utf-8
+# frozen_string_literal: true
 
 module Scripref
 
@@ -27,9 +28,9 @@ module Scripref
     end
 
     # Formats a book
-    # @param num number of book (starting at 1)
-    def format_book num
-      book_names[num - 1].send @bookformat
+    # @param osis_book_id OSIS-ID for book
+    def format_book osis_book_id
+      osis_book_id_to_book_name[osis_book_id].send @bookformat
     end
 
     # Formats a chapter

data/lib/scripref/german.rb

@@ -1,5 +1,6 @@
-# - encoding: utf-8 -
-require 'scripref/bookname'
+# encoding: utf-8
+# frozen_string_literal: true
+
 require 'scripref/const_reader'
 
 module Scripref
@@ -19,19 +20,22 @@ module Scripref
     END
 
     book_abbrevs = <<-END.strip.split(/,\s*/).map {|e| e.split('|')}
-      1.Mo|1Mo|1M, 2.Mo|2Mo|2M, 3.Mo|3Mo|3M, 4.Mo|4Mo|4M, 5.Mo|5Mo|5M, Jos, Ri,
-      Ruth, 1.Sam|1Sam|1Sm, 2.Sam|2Sam|2Sm, 1.Kön|1Kön|1Kö, 2.Kön|2Kön|2Kö,
-      1.Chr|1Chr|1Ch, 2.Chr|2Chr|2Ch, Esr, Neh, Est, Hi, Ps, Spr, Pred,
+      1. Mos|1Mo|1M, 2. Mos|2Mo|2M, 3. Mos|3Mo|3M, 4. Mos|4Mo|4M, 5. Mos|5Mo|5M, Jos, Ri,
+      Ruth, 1. Sam|1Sam|1Sm, 2. Sam|2Sam|2Sm, 1. Kön|1Kön|1Kö, 2. Kön|2Kön|2Kö,
+      1. Chr|1Chr|1Ch, 2. Chr|2Chr|2Ch, Esr, Neh, Est, Hi, Ps, Spr, Pred,
       Hohel|Hoh|Hl, Jes, Jer, Klag, Hes, Dan, Hos, Joel, Amos|Am, Obad|Ob,
       Jona|Jon, Mich|Mi, Nah, Hab, Zef, Hag, Sach, Mal, Mat|Mt, Mar|Mr, Luk|Lk,
-      Joh|Jh, Apg, Röm|Rö, 1.Ko|1Ko, 2.Ko|2Ko, Gal, Eph, Phil, Kol,
-      1.Thes|1Thes|1Th, 2.Thes|2Thes|2Th, 1.Tim, 2.Tim, Tit, Philem|Phm, Heb,
-      Jak, 1.Pet|1Pet|1Pe, 2.Pet|2Pet|2Pe, 1.Joh|1Joh|1Jo, 2.Joh|2Joh|2Jo,
-      3.Joh|3Joh|3Jo, Jud, Off
+      Joh|Jh, Apg, Röm|Rö, 1. Kor|1Ko, 2. Kor|2Ko, Gal, Eph, Phil, Kol,
+      1. Thes|1Thes|1Th, 2. Thes|2Thes|2Th, 1. Tim|1Tim, 2. Tim|2Tim, Tit, Philem|Phm, Heb,
+      Jak, 1. Pet|1Pet|1Pe, 2. Pet|2Pet|2Pe, 1. Joh|1Joh|1Jo, 2. Joh|2Joh|2Jo,
+      3. Joh|3Joh|3Jo, Jud, Off
     END
 
     # Array of book names.
-    BOOK_NAMES = book_names.zip(book_abbrevs).map {|name, abbrev| Bookname.new(name, abbrev)}
+    BOOK_NAMES = Bookorder::CANONICAL.zip(book_names, book_abbrevs).map {|osis_book_id, names, abbrevs| Bookname.new(osis_id: osis_book_id, names: names, abbrevs: abbrevs)}
+
+    # Map of OSIS book ID to instance of Bookname
+    OSIS_BOOK_ID_TO_BOOK_NAME = Bookorder::CANONICAL.zip(BOOK_NAMES).map {|id, n| [id, n]}.to_h
 
     # Separator between chapter and verse.
     CV_SEPARATOR = ','
@@ -73,9 +77,9 @@ module Scripref
     POSTFIX_MORE_FOLLOWING_VERSES_RE = /ff\b\s*/o
 
     # Check if book has only one chapter
-    # @param book book as number
-    def book_has_only_one_chapter? book
-      [31, 57, 63, 64, 65].include?(book)
+    # @param osis_id OSIS-ID of the book
+    def book_has_only_one_chapter? osis_id
+      %i[Obad Phlm 2John 3John Jude].include?(osis_id)
     end
 
     # Regular expression to match punctuation marks

data/lib/scripref/include.rb

@@ -1,4 +1,6 @@
-# - encoding: utf-8 -
+# encoding: utf-8
+# frozen_string_literal: true
+
 require 'scripref'
 
 include Scripref

data/lib/scripref/parser.rb

@@ -1,4 +1,6 @@
-# - encoding: utf-8 -
+# encoding: utf-8
+# frozen_string_literal: false
+
 require 'scripref/basic_methods'
 require 'strscan'
 
@@ -35,7 +37,7 @@ module Scripref
     def b1
       s = scan(book_re) or return nil
       @text << s
-      @b1 = @b2 = abbrev2num(s)
+      @b1 = @b2 = abbrev2osis_book_id(s)
       @c1 = @v1 = @c2 = @v2 = nil
 
       if pass_sep
@@ -108,7 +110,7 @@ module Scripref
     def b2
       s = scan(book_re) or return nil
       @text << s
-      @b2 = abbrev2num(s)
+      @b2 = abbrev2osis_book_id(s)
       @c2 = @v2 = nil
 
       if pass_sep
@@ -237,10 +239,10 @@ module Scripref
       @a1 = @a2 = nil
     end
 
-    def abbrev2num str
+    def abbrev2osis_book_id str
       s = str.strip
       s.sub! /\.$/, ''
-      str2book_num(s) or str2book_num(abbrev2book(s))
+      str2osis_book_id(s) or str2osis_book_id(abbrev2book(s))
     end
 
     def abbrev2book str
@@ -250,7 +252,7 @@ module Scripref
       pattern = s.chars.map {|c| Regexp.escape(c) << '[^#]*'}.join
       re = /(?<=#)#{pattern}(?=#)/
       names = @books_str.scan(re)
-      uniq_numbers = names.map {|n| str2book_num(n)}.uniq
+      uniq_numbers = names.map {|n| str2osis_book_id(n)}.uniq
       if uniq_numbers.size != 1
         unscan
         give_up format("Abbreviation %s is ambiguous it matches %s!", s, names.join(', '))
@@ -258,23 +260,23 @@ module Scripref
       names.first
     end
 
-    def init_str2book_num
-      unless @str2book_num
-        @str2book_num = {}
-        book_names.each_with_index do |bn, i|
+    def init_str2osis_book_id
+      unless @str2osis_book_id
+        @str2osis_book_id = {}
+        book_names.each do |bn|
           bn.names.each do |n|
-            @str2book_num[n] = i+1
+            @str2osis_book_id[n] = bn.osis_id
           end
           bn.abbrevs.each do |n|
-            @str2book_num[n] = i+1
+            @str2osis_book_id[n] = bn.osis_id
           end
         end
       end
     end
 
-    def str2book_num str
-      init_str2book_num
-      @str2book_num[str]
+    def str2osis_book_id str
+      init_str2osis_book_id
+      @str2osis_book_id[str]
     end
 
     def inspect

data/lib/scripref/passage.rb

@@ -1,66 +1,27 @@
-# - encoding: utf-8 -
+# encoding: utf-8
+# frozen_string_literal: true
+
 module Scripref
 
   Passage = Struct.new(:text, :b1, :c1, :v1, :b2, :c2, :v2, :a1, :a2, keyword_init: true) do
 
     include Comparable
 
-    def + other
-      to_a.zip(other.to_a).map {|a, b| a + b}
-    end
-
-    def - other
-      to_a.zip(other.to_a).map {|a, b| b - a}
-    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]
+      self.to_numeric_array <=> other.to_numeric_array
     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 = self.to_numeric_array
+      b = passage.to_numeric_array
       [a[0..2] <=> b[3..5], b[0..2] <=> a[3..5]].max < 1
     end
 
@@ -74,7 +35,40 @@ module Scripref
       [b2, c2, v2]
     end
 
+    def to_numeric_array max: 999, ff: 3
+      _b1 = Passage.book_id2num[b1]
+      _c1 = c1 || 1
+      _v1 = v1 || 1
+      _b2 = Passage.book_id2num[b2]
+      _c2 = c2 || max
+      _v2 = v2 || max
+      if _v2 == :f
+        _v2 = _v1 + 1
+      end
+      if _v2 == :ff
+        _v2 = _v1 + ff
+      end
+      [_b1, _c1, _v1, _b2, _c2, _v2]
+    end
+
     alias to_s text
+
+    @book_id2num = {}
+    osis_book_ids = %i[
+      Gen Exod Lev Num Deut Josh Judg Ruth 1Sam 2Sam 1Kgs 2Kgs 1Chr 2Chr Ezra
+      Neh Esth Job Ps Prov Eccl Song Isa Jer Lam Ezek Dan Hos Joel Amos Obad
+      Jonah Mic Nah Hab Zeph Hag Zech Mal Matt Mark Luke John Acts Rom 1Cor
+      2Cor Gal Eph Phil Col 1Thess 2Thess 1Tim 2Tim Titus Phlm Heb Jas 1Pet
+      2Pet 1John 2John 3John Jude Rev
+    ]
+    osis_book_ids.each_with_index do |book_id, i|
+      @book_id2num[book_id] = i+1
+    end
+
+    class << self
+      attr_reader :book_id2num
+    end
+
   end
 
 end

data/lib/scripref/pipelining.rb

@@ -1,4 +1,5 @@
-# - encoding: utf-8 -
+# encoding: utf-8
+# frozen_string_literal: true
 
 module Scripref
 

data/lib/scripref/processor.rb

@@ -1,7 +1,8 @@
-# - encoding: utf-8 -
+# encoding: utf-8
+# frozen_string_literal: true
+
 require 'strscan'
 require 'scripref/basic_methods'
-require 'scripref/parser'
 
 module Scripref
 

data/lib/scripref.rb

@@ -1,11 +1,14 @@
-# - encoding: utf-8 -
+# encoding: utf-8
+# frozen_string_literal: true
+
 require 'delegate'
 
 module Scripref
 
-  VERSION = '0.15.0'
+  VERSION = '1.1.0'
 
   autoload :Bookname, 'scripref/bookname'
+  autoload :Bookorder, 'scripref/bookorder'
   autoload :English, 'scripref/english'
   autoload :Formatter, 'scripref/formatter'
   autoload :German, 'scripref/german'

data/regtest/formatter.rb

@@ -5,10 +5,10 @@ require 'scripref'
 include Scripref
 
 o = OpenStruct.new
-o.b1 = [42]
+o.b1 = [:Luke]
 o.c1 = [1, nil]
 o.v1 = [2, nil]
-o.b2 = [43, nil]
+o.b2 = [:John, nil]
 o.c2 = [3, nil]
 o.v2 = [4, nil]