bible_ref 1.8.1 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22b821510013daef3716627d59856edc01762529d3c86d03e0ccf444333c6af5
-  data.tar.gz: 4d9bae58173393fa318c2a7cda11840e18f26b31ebfa70a7bf0ca18ca87eaae1
+  metadata.gz: a9f9a5343547b1777a07bb2876bf17b38e31225c1948571a85588758a8f3d915
+  data.tar.gz: 8d1d69e4b6b97bdb6d675ec1584b6abb45b5c2a7b2731ea7647443f7bc5c0138
 SHA512:
-  metadata.gz: f1bb301a9c6a10a0f1d561da1407c87fe3986dd4b668eae6f8eb42c25cdb8bd1d31f0937f9b566db8434faee6956e02235083f9543cf9c5648acc663425a7313
-  data.tar.gz: e25f90e6a2bcb740061d547a3760750a93b699f82c66f4a0fa4e6626480658eb7b95ad1c7b4bde63433c654a798e538e5dd95e0a3dd8898fbf80c2374584b828
+  metadata.gz: fc93394a58615d9f47562e8d30e65c45aa3407b050574ef777994d0ff0775cd5aa7c44996538e56499f8006573ccce9341cc42e162935933ec248d2cb794f76a
+  data.tar.gz: c84fc9f49b17114c55f2178eed9bce81c320a969b41cd3a68519126a3d7d6258b77c6c51dfafd154dc58895b00c131a811734465da1fdcc17a7b8bb1c10e2b68

data/README.md

@@ -53,10 +53,32 @@ verses = ranges.map do |from_ref, to_ref|
 end
 ```
 
-## Note
+## Single-Chapter Book Matching
 
-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.
+Passing `single_chapter_book_matching` keyword to `Reference` changes how single-chapter books are handled.
+It affects how something like `Jude 1` is parsed:
+
+| setting            | input  | result                   |
+|--------------------|--------|--------------------------|
+| :special (default) | jude 1 | single verse of Jude 1:1 |
+| :indifferent       | jude 1 | whole chapter of Jude    |
+
+While the default of `:special` seems to match what most people expect, using the `:indifferent` setting will make `jude 1`
+behave the same as something like `john 1` -- both will return the entire chapter.
+
+```ruby
+BibleRef::Reference.new('jude 1').ranges
+# [
+#   [{ book: 'JUD', chapter: 1, verse: 1 },
+#    { book: 'JUD', chapter: 1, verse: 1 }]
+# ]
+
+BibleRef::Reference.new('jude 1', single_chapter_book_matching: :indifferent).ranges
+# [
+#   [{ book: 'JUD', chapter: 1 },
+#    { book: 'JUD', chapter: 1 }]
+# ]
+```
 
 ## Copyright
 

data/lib/bible_ref/reference.rb

@@ -7,11 +7,13 @@ module BibleRef
     attr_reader :book, :reference, :language, :canon
 
     # Create a new Reference instance by passing in the user-supplied bible reference as a string.
-    def initialize(reference, language: 'eng', canon: 'all')
+    def initialize(reference, language: 'eng', canon: 'all', single_chapter_book_matching: :special)
       @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()
+      @single_chapter_book_matching = single_chapter_book_matching
+      raise 'expected :special or :indifferent' unless %i[special indifferent].include?(@single_chapter_book_matching)
+      standardize_reference
       @details = parse
     end
 
@@ -75,17 +77,20 @@ 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? ':'
+      standardize_single_chapter_book if @language.has_single_chapter?(@reference)
+    end
+
+    def standardize_single_chapter_book
+      return if @single_chapter_book_matching == :indifferent
+      return @reference if @reference.include? ':'
 
-        matches = @reference.match(/^([\d]?[\D\s]*)/)
-        return @reference if matches.length() == 0
+      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}"
+      book = matches[0].strip
+      requested = @reference.sub(book, '').strip
+      @reference = "#{book} 1:#{requested}"
     end
 
     def parse

data/lib/bible_ref/version.rb

@@ -1,3 +1,3 @@
 module BibleRef
-  VERSION = '1.8.1'
+  VERSION = '1.9.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bible_ref
 version: !ruby/object:Gem::Version
-  version: 1.8.1
+  version: 1.9.0
 platform: ruby
 authors:
 - Tim Morgan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-12-27 00:00:00.000000000 Z
+date: 2025-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parslet