bible_ref 1.4.0 → 1.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b66f31665e878b3a71f4c334f43ed5a26c972f15989e8569fab62aa557df191
-  data.tar.gz: 9e7d5a746bf49b140963dfcc945eeaee58fcf68633828892447519841d656f5f
+  metadata.gz: cfd107c033d80842c4439b6b1b051494c2159b9a09ff8b37f8619dddc7047c05
+  data.tar.gz: 6c89efe81988afabc86f8cc59dabc9761b902a25cf87d2666f3d1325ff18780c
 SHA512:
-  metadata.gz: 460cb9fc1df0ae490c46607ed010b21986d636dc63c2a5783ca3343589a58351570c15df9deca603a309108ca59ac74c70b89e994da1e45eec939f648fb2b27f
-  data.tar.gz: 88462cdbb3dc94dc66c1470455ea5b0de6605da4d1df45a2b1be761fc7ee2262aa8558173df036686f1f8bc2ab329995b7bf64e430bc411bae982591b3032154
+  metadata.gz: 8a2606c594f7b74000a47c109155f5db6dd91a0d584d350daf0b6747ec4dbdc201d553cc9765d62d2323d20d351037ab43dae6f20af5952199464d9bc05203f6
+  data.tar.gz: 4cdd24de24e1cd85edcd726917afa60fabc317b5dd0c9757a00b9b257f16a40ea4698d3e8cc4db3869f2e8172a0d5f9534f36178f890e524f2be86dd0f951861

data/README.md

@@ -53,6 +53,11 @@ verses = ranges.map do |from_ref, to_ref|
 end
 ```
 
+## Note
+
+When searching a book that contains a single chapter (ie. Obadiah, Philemon, Jude, 2 John, 3 John), you can use either Jude 1 or Jude 1:1 to retrieve verse 1.
+This is quite different from searching a book with multiple chapters.  **John 1** will return all of chapter 1, where as **Jude 1** only returns the first verse.
+
 ## Copyright
 
 Copyright [Tim Morgan](http://timmorgan.org). Licensed MIT.

data/lib/bible_ref/languages/base.rb

@@ -5,6 +5,11 @@ module BibleRef
         fail NotImplementedError, "You must override #books in your language class."
       end
 
+      # Is it a single chapter book?
+      def has_single_chapter?(reference)
+        fail NotImplementedError, "You must override #has_single_chapter? in your language class."
+      end
+
       def book_id(book_name, canon)
         book_name = replace_roman_numerals(book_name)
         return book_name.upcase if books[book_name.upcase] # already normalized

data/lib/bible_ref/languages/cherokee.rb

@@ -4,6 +4,13 @@ require_relative 'base'
 module BibleRef
   module Languages
     class Cherokee < Base
+
+      # Is it a single chapter book?
+      def has_single_chapter?(reference)
+          matches = ['ᏉᎳ ᏆᎵᎹᏂ ᎤᏬᏪᎳᏁᎸᎯ', 'ᏣᏂ ᏔᎵᏁ ᎤᏬᏪᎳᏅᎯ', 'ᏣᏂ ᏦᎢᏁ ᎤᏬᏪᎳᏅᎯ', 'ᏧᏓᏏ ᎤᏬᏪᎳᏅᎯ']
+          return matches.any? { |e| reference.include?(e)  }
+      end
+
       def books
         {
           'MAT' => { name: 'ᎣᏍᏛ ᎧᏃᎮᏛ ᎹᏚ ᎤᏬᏪᎳᏅᎯ' },

data/lib/bible_ref/languages/english.rb

@@ -4,6 +4,12 @@ require_relative 'base'
 module BibleRef
   module Languages
     class English < Base
+      # Is it a single chapter book?
+      def has_single_chapter?(reference)
+        matches = [/^ob/, /^(jud|jd|jude)\b/, /^2 ?jo?h?n/, /^3 ?jo?h?n/, /^(philem|phm|pm)/]
+        return Regexp.union(matches).match?(reference.downcase)
+      end
+
       def books
         {
           'GEN' => { match: /^gen/,              name: 'Genesis'                },
@@ -46,7 +52,7 @@ module BibleRef
           'ZEC' => { match: /^zec/,              name: 'Zechariah'              },
           'MAL' => { match: /^mal/,              name: 'Malachi'                },
           'TOB' => { match: /^tob/,              name: 'Tobit'                  },
-          'JDT' => { match: /^(jth|jdth?|judith)/, name: 'Judith'                 },
+          'JDT' => { match: /^(jth|jdth?|judith)/, name: 'Judith'               },
           'ESG' => { match: /^(est.*greek|esg)/, name: 'Esther (Greek)'         },
           'WIS' => { match: /^wis(dom)?/,        name: 'Wisdom of Solomon'      },
           'SIR' => { match: /^sir/,              name: 'Sirach'                 },
@@ -63,7 +69,7 @@ module BibleRef
           '3MA' => { match: /^3 ?mac?/,          name: '3 Maccabees'            },
           '2ES' => { match: /^2 ?esd?/,          name: '2 Esdras'               },
           '4MA' => { match: /^4 ?mac?/,          name: '4 Maccabees'            },
-          'MAT' => { match: /^mat/,              name: 'Matthew'                },
+          'MAT' => { match: /^ma?t/,             name: 'Matthew'                },
           'MRK' => { match: /^(ma?rk|mk)/,       name: 'Mark'                   },
           'LUK' => { match: /^lu?k/,             name: 'Luke'                   },
           'JHN' => { match: /^(john|jn|jhn)/,    name: 'John'                   },
@@ -73,14 +79,14 @@ module BibleRef
           '2CO' => { match: /^2 ?cor?/,          name: '2 Corinthians'          },
           'GAL' => { match: /^gal/,              name: 'Galatians'              },
           'EPH' => { match: /^eph/,              name: 'Ephesians'              },
-          'PHP' => { match: /^(phill?i|php)/,    name: 'Philippians'            },
+          'PHP' => { match: /^(phil|php|pp)/,    name: 'Philippians'            },
           'COL' => { match: /^col/,              name: 'Colossians'             },
           '1TH' => { match: /^1 ?the?s?/,        name: '1 Thessalonians'        },
           '2TH' => { match: /^2 ?the?s?/,        name: '2 Thessalonians'        },
           '1TI' => { match: /^1 ?tim?/,          name: '1 Timothy'              },
           '2TI' => { match: /^2 ?tim?/,          name: '2 Timothy'              },
           'TIT' => { match: /^tit/,              name: 'Titus'                  },
-          'PHM' => { match: /^ph(i?l|m)/,        name: 'Philemon'               },
+          'PHM' => { match: /^(philem|phm|pm)/,  name: 'Philemon'               },
           'HEB' => { match: /^heb/,              name: 'Hebrews'                },
           'JAS' => { match: /^ja(m|s)/,          name: 'James'                  },
           '1PE' => { match: /^1 ?pet?/,          name: '1 Peter'                },
@@ -88,7 +94,7 @@ module BibleRef
           '1JN' => { match: /^1 ?jo?h?n/,        name: '1 John'                 },
           '2JN' => { match: /^2 ?jo?h?n/,        name: '2 John'                 },
           '3JN' => { match: /^3 ?jo?h?n/,        name: '3 John'                 },
-          'JUD' => { match: /^(jud$|jd$|jude$)/, name: 'Jude'                   },
+          'JUD' => { match: /^(jud|jd|jude)$/,   name: 'Jude'                   },
           'REV' => { match: /^re?v/,             name: 'Revelation'             }
         }
       end

data/lib/bible_ref/languages/latin.rb

@@ -4,6 +4,12 @@ require_relative 'base'
 module BibleRef
   module Languages
     class Latin < Base
+      # Is it a single chapter book?
+      def has_single_chapter?(reference)
+        matches = ['Abdias', 'ad Philemonem', 'Joannis II', 'Joannis III', 'Judæ']
+        return matches.any? { |e| reference.include?(e)  }
+      end
+
       def books
         {
           'GEN' => { name: 'Genesis' },

data/lib/bible_ref/languages/portuguese.rb

@@ -4,6 +4,13 @@ require_relative 'base'
 module BibleRef
   module Languages
     class Portuguese < Base
+
+      # Is it a single chapter book?
+      def has_single_chapter?(reference)
+          matches = [/^ob/, /^jud/, /^2 jo/, /^3 jo/, /^fil/]
+          return Regexp.union(matches).match?(reference.downcase)
+      end
+
       def books
         {
           'GEN' => { match: /^g[eê]n/,          name: 'Gênesis'           },

data/lib/bible_ref/languages/romanian.rb

@@ -4,6 +4,13 @@ require_relative 'base'
 module BibleRef
   module Languages
     class Romanian < Base
+
+      # Is it a single chapter book?
+      def has_single_chapter?(reference)
+          matches = [/^ob/, /^iud/, /^2 io/, /^3 io/, /^fil/]
+          return Regexp.union(matches).match?(reference.downcase)
+      end
+
       def books
         {
           'GEN' => { match: /^gen/,             name: 'Geneza'                },

data/lib/bible_ref/reference.rb

@@ -8,10 +8,11 @@ module BibleRef
 
     # Create a new Reference instance by passing in the user-supplied bible reference as a string.
     def initialize(reference, language: 'eng', canon: 'all')
-      @reference = reference
-      @details = parse
       @language = language.respond_to?(:book_id) ? language : LANGUAGES.fetch(language.to_s).new
       @canon = canon.respond_to?(:books) ? canon : CANONS.fetch(canon.to_s).new
+      @reference = reference
+      standardize_reference()
+      @details = parse
     end
 
     # Returns an array of pairs, each one being the from and to for a range.
@@ -22,7 +23,6 @@ module BibleRef
     def ranges
       return nil unless valid?
       @chapter = nil
-      fix_chapter_for_jude if book_id == 'JUD'
       [@details[:refs]].flatten.map do |ref|
         normalize_range(ref) || normalize_ref(ref)
       end
@@ -75,6 +75,19 @@ module BibleRef
       end
     end
 
+    # standardize the reference so it can be handed to the parser.
+    def standardize_reference
+        return @reference unless @language.has_single_chapter?(@reference)
+        return @reference if @reference.include? ':'
+
+        matches = @reference.match(/^([\d]?[\D\s]*)/)
+        return @reference if matches.length() == 0
+
+        book = matches[0].strip
+        requested = @reference.sub(book, '').strip
+        @reference = "#{book} 1:#{requested}"
+    end
+
     def parse
       begin
         parsed = Parser.new.parse(@reference)
@@ -102,23 +115,5 @@ module BibleRef
       end
     end
 
-    def fix_chapter_for_jude
-      (start, finish) = @details[:refs]
-      finish ||= start
-      @details[:refs] = [
-        {
-          range: {
-            from: {
-              chapter: 1,
-              verse: start[:chapter]
-            },
-            to: {
-              chapter: 1,
-              verse: finish[:chapter]
-            }
-          }
-        }
-      ]
-    end
   end
 end

data/lib/bible_ref/version.rb

@@ -1,3 +1,3 @@
 module BibleRef
-  VERSION = '1.4.0'
+  VERSION = '1.5.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bible_ref
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.3
 platform: ruby
 authors:
 - Tim Morgan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-08-16 00:00:00.000000000 Z
+date: 2021-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parslet
@@ -93,7 +93,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.22
 signing_key:
 specification_version: 4
 summary: Bible reference parser