scripref 0.7.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e65b203f6111b6313c92ed4fc32753ffcf084e0f
-  data.tar.gz: 362dddef75cfb666e6e287428fcf2e4e911d3881
+  metadata.gz: 373b4b572bcb6fadc58872590bc98e75f5bebe3c
+  data.tar.gz: be215c400b76c7327bdeb63b1bff52917c854eca
 SHA512:
-  metadata.gz: 705ab5f7fbbce60d4d1dcc8bf4f046a5b1e0f943dd30172a89dbede3685ca9b141b485ac01329bc51d70fa25418daa5c494bded5246a9b876256629c70d823fe
-  data.tar.gz: 0e5de450e1a2e2d2f267e01f33476959f8cff1d9966e312ff6d01ffbb45b9a94a12df41c0a482467ef821f29edbf1453943d3545749daa6ebfee5acd16604216
+  metadata.gz: fc24a4742a42477c252edd1c06fb52f2b41bb6411479556921b39e2512082accc7ce9270d0d87dc6b86032ba13847f3bf9074268b18ac0cce789cd90faf8918c
+  data.tar.gz: 31e56ca2e1000abc2a8bdcdf6b7af0c99b6c49e604dbdd0f530dd02416b4e1d188884ff4428e466c3b367439357876c4b66d4244ca61e42e6bfb4a59de283608

data/CHANGELOG

@@ -1,3 +1,11 @@
+0.8.0
+Formatting of verse addons implemented.
+Refactoring: Rename methods in Formatter to distinguish between format_* and process_*.
+Refactoring: Move method Scripref.book_has_only_one_chapter to mixins.
+New methods Parser#chapter_re and #verse_re.
+New method Parser#special_abbrev_mapping to allow to parse special abbreviations, for example "Phil" to "Philipper" in German.
+Some bugs fixed.
+
 0.7.1
 Add Psalmen as alternative German book name.
 Add E-Mail address.

data/lib/scripref/const_reader.rb

@@ -37,7 +37,14 @@ module ConstReader
     consts.flatten.each do |c|
       class_exec(c.to_s, c.to_s.downcase) do |c_name, m_name|
         define_method m_name do
-          self.singleton_class.const_get c_name
+          ivar = '@' << m_name
+          if instance_variable_defined? ivar
+            return instance_variable_get(ivar)
+          else
+            val = self.singleton_class.const_get c_name
+            instance_variable_set ivar, val
+            return val
+          end
         end
       end
     end

data/lib/scripref/english.rb

@@ -50,6 +50,16 @@ module Scripref
     # Regular expression to parse a reference
     REFERENCE_RE = /#{pass}(;\s*#{pass})*/o
 
+    # Check if book has only one chapter
+    # @param book book as number
+    def book_has_only_one_chapter? book
+      [31, 63, 64, 65].include?(book)
+    end
+
+    # Generate attr_reader methods for all constants
+    extend ConstReader
+    const_reader constants
+
   end
 
 end

data/lib/scripref/formatter.rb

@@ -4,16 +4,13 @@ module Scripref
 
   class Formatter
 
+    attr_accessor :cv_separator, :hyphen_separator, :pass_separator
+
+
     # @param mods one or more modules to include
     def initialize *mods
       @mods = mods
-      mods.each do |m|
-        m.class_eval do
-          extend ConstReader
-          const_accessor constants
-        end
-        extend m
-      end
+      mods.each {|m| extend m}
     end
 
     # Formats a reference (array of passages)
@@ -22,56 +19,64 @@ module Scripref
       @result = ''
       reference.flatten.each do |pass|
         @pass = pass
-        format_passage
+        process_passage
       end
       @result
     end
 
-    def format_passage
-      @changed = false
-      format_b1
-    end
-
     def format_book num
       Array(book_names[num - 1]).first
     end
 
-    def format_b1
+    private
+
+    def process_passage
+      @changed = false
+      process_b1
+    end
+
+    def process_b1
       b1 = @pass.b1
       if @last_b != b1
         @result << format_book(b1)
         @last_b = b1
         @changed = true
       end
-      format_c1
+      process_c1
     end
 
-    def format_c1
+    def process_c1
       c1 = @pass.c1
       if c1 && (@changed || @last_c != c1)
         @result << ' '
-        if ! Scripref.book_has_only_one_chapter?(@pass.b1)
+        if ! book_has_only_one_chapter?(@pass.b1)
           @result << c1.to_s
         end
         @last_c = c1
         @changed = true
       end
-      format_v1
+      process_v1
     end
 
-    def format_v1
+    def process_v1
       v1 = @pass.v1
       if v1 && (@changed || @last_v != v1)
-        if ! Scripref.book_has_only_one_chapter?(@pass.b1)
+        if ! book_has_only_one_chapter?(@pass.b1)
           @result << cv_separator
         end
         @result << v1.to_s
         @last_v = v1
+        process_a1
       end
-      format_b2
+      process_b2
     end
 
-    def format_b2
+    def process_a1
+      a1 = @pass.a1
+      @result << a1.to_s if a1
+    end
+
+    def process_b2
       @changed = false
       @hyphen = false
       b2 = @pass.b2
@@ -82,10 +87,10 @@ module Scripref
         @changed = true
         @hyphen = true
       end
-      format_c2
+      process_c2
     end
 
-    def format_c2
+    def process_c2
       c2 = @pass.c2
       if c2 && (@changed || @last_c != c2)
         if @hyphen
@@ -94,20 +99,20 @@ module Scripref
           @result << hyphen_separator
           @hyphen = true
         end
-        if ! Scripref.book_has_only_one_chapter?(@pass.b2)
+        if ! book_has_only_one_chapter?(@pass.b2)
           @result << c2.to_s
         end
         @last_c = c2
         @changed = true
       end
-      format_v2
+      process_v2
     end
 
-    def format_v2
+    def process_v2
       v2 = @pass.v2
       if v2 && (@changed || @last_v != v2)
         if @hyphen
-          if ! Scripref.book_has_only_one_chapter?(@pass.b2)
+          if ! book_has_only_one_chapter?(@pass.b2)
             @result << cv_separator
           end
         else
@@ -117,9 +122,15 @@ module Scripref
         @result << v2.to_s
         @last_v = @v2
         @changed = true
+        process_a2
       end
     end
 
+    def process_a2
+      a2 = @pass.a2
+      @result << a2.to_s if a2
+    end
+
     alias << format
 
   end

data/lib/scripref/german.rb

@@ -47,6 +47,19 @@ module Scripref
     # Regular expression to parse a reference
     REFERENCE_RE = /#{pass}(;\s*#{pass})*/o
 
+    # Check if book has only one chapter
+    # @param book book as number
+    def book_has_only_one_chapter? book
+      [31, 63, 64, 65].include?(book)
+    end
+
+    # Hash with special abbreviations
+    SPECIAL_ABBREV_MAPPING = {'Phil' => 'Philipper'}
+
+    # Generate attr_reader methods for all constants
+    extend ConstReader
+    const_reader constants
+
   end
 
 end

data/lib/scripref/parser.rb

@@ -7,18 +7,29 @@ module Scripref
 
     attr_reader :error
 
-    NUMBER_RE = /\d+\s*/
+    NUMBER_RE = /\d+\s*/o
 
     # @param mods one or more modules to include
     def initialize *mods
       @mods = mods
-      mods.each do |m|
-        m.class_eval do
-          extend ConstReader
-          const_reader constants
-        end
-        extend m
-      end
+      mods.each {|m| extend m}
+    end
+
+    # Regular expression to match a chapter
+    def chapter_re
+      NUMBER_RE
+    end
+
+    # Regular expression to match a verse
+    def verse_re
+      NUMBER_RE
+    end
+
+    # Hash with special abbreviations
+    # for example {'Phil' => 'Philipper'}
+    # usual overwritten in Mixins
+    def special_abbrev_mapping
+      Hash.new
     end
 
     # Parsing a string of a scripture reference
@@ -42,12 +53,12 @@ module Scripref
       @text << s
       @b1 = @b2 = abbrev2num(s)
 
-      if check(Regexp.new(NUMBER_RE.source + cv_sep_re.source))
+      if check(Regexp.new(chapter_re.source + cv_sep_re.source))
         @c1 = @v1 = nil
         @c2 = @v2 = nil
         c1
       else
-        if Scripref.book_has_only_one_chapter?(@b1)
+        if book_has_only_one_chapter?(@b1)
           @c1 = @c2 = 1
           epsilon or (hyphen and b2) or v1 or give_up 'EOS or hyphen and book or verse expected!'
         else
@@ -60,7 +71,7 @@ module Scripref
 
     # try parse first chapter
     def c1
-      s = scan(NUMBER_RE) or return nil
+      s = scan(chapter_re) or return nil
       @text << s
       @c1 = @c2 = s.to_i
 
@@ -77,7 +88,7 @@ module Scripref
 
     # try to parse first verse
     def v1
-      s = scan(NUMBER_RE) or return nil
+      s = scan(verse_re) or return nil
       @text << s
       @v1 = @v2 = s.to_i
 
@@ -92,7 +103,7 @@ module Scripref
 
       if hyphen
         b2 or (
-        if check(Regexp.new(NUMBER_RE.source + cv_sep_re.source))
+        if check(Regexp.new(chapter_re.source + cv_sep_re.source))
           c2
         else
           v2 or give_up 'Chapter or verse expected!'
@@ -113,10 +124,10 @@ module Scripref
       @b2 = abbrev2num(s)
       @c2 = @v2 = nil
 
-      if check(Regexp.new(NUMBER_RE.source + cv_sep_re.source))
+      if check(Regexp.new(chapter_re.source + cv_sep_re.source))
         c2
       else
-        if Scripref.book_has_only_one_chapter?(@b2)
+        if book_has_only_one_chapter?(@b2)
           @c2 = 1
           epsilon or v2 or give_up 'EOS or chapter or verse expected!'
         else
@@ -127,7 +138,7 @@ module Scripref
 
     # try to parse second chapter
     def c2
-      s = scan(NUMBER_RE) or return nil
+      s = scan(chapter_re) or return nil
       @text << s
       @c2 = s.to_i
 
@@ -140,7 +151,7 @@ module Scripref
 
     # try to parse second verse
     def v2
-      s = scan(NUMBER_RE) or return nil
+      s = scan(verse_re) or return nil
       @text << s
       @v2 = s.to_i
 
@@ -241,11 +252,18 @@ module Scripref
     end
 
     def abbrev2book str
+      s = str.strip
+      if name = special_abbrev_mapping[s]
+        return name
+      end
       @books_str ||= ('#' << book_names.flatten.join('#') << '#')
-      pattern = str.strip.chars.map {|c| Regexp.escape(c) << '[^#]*'}.join
+      pattern = s.chars.map {|c| Regexp.escape(c) << '[^#]*'}.join
       re = /(?<=#)#{pattern}(?=#)/
       names = @books_str.scan(re)
-      give_up format("Abbreviation %s is ambiguous it matches %s!", str, names.join(', ')) unless names.size == 1
+      if names.size != 1
+        unscan
+        give_up format("Abbreviation %s is ambiguous it matches %s!", s, names.join(', '))
+      end
       names.first
     end
 

data/lib/scripref/processor.rb

@@ -15,9 +15,7 @@ module Scripref
     def initialize text=nil, *mods
       @text = text
       @mods = mods
-      mods.each do |m|
-        extend m
-      end
+      mods.each {|m| extend m}
       @parser = Parser.new(*mods)
     end
 

data/lib/scripref.rb

@@ -8,7 +8,7 @@ require 'scripref/german'
 
 module Scripref
 
-  VERSION = '0.7.1'
+  VERSION = '0.8.0'
 
   Passage = Struct.new(:text, :b1, :c1, :v1, :b2, :c2, :v2, :a1, :a2) do
 
@@ -39,9 +39,4 @@ module Scripref
   class PassSep < Sep; end
   class VerseSep < Sep; end
 
-  # check if the book has only one chapter
-  def self.book_has_only_one_chapter? book
-    [31, 63, 64, 65].include?(book)
-  end
-
 end

data/test/test_formatter.rb

@@ -89,7 +89,7 @@ class TestFormatter < Test::Unit::TestCase
     check_formatting
   end
 
-  def test_changed_hyphen_separator
+  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 = ' - '
@@ -102,6 +102,24 @@ class TestFormatter < Test::Unit::TestCase
     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
+
   private
 
   def check_formatting

data/test/test_german.rb

@@ -36,6 +36,7 @@ class TestGerman < Test::Unit::TestCase
     assert_book_num 1, '1.Mo'
     assert_book_num 1, '1M'
     assert_book_num 40, 'Mat'
+    assert_book_num 50, 'Phil'
     assert_book_num 66, 'Off'
   end
 

data/test/test_parser.rb

@@ -229,4 +229,28 @@ class TestParser < Test::Unit::TestCase
     assert_equal formated_error, @parser.format_error
   end
 
+  def test_error_message_for_unambiguous_book
+    text = 'Ruth 2,4; M 3,8'
+    begin
+      @parser.parse text
+    rescue Scripref::ParserError
+    end
+    assert_match /^Abbreviation M is ambiguous/, @parser.error
+    formated_error = "Abbreviation M is ambiguous it matches Micha, Maleachi, Matthäus, Markus!\nRuth 2,4; M 3,8\n          ^"
+    assert_equal formated_error, @parser.format_error
+  end
+
+  ######################################################################
+  # special things
+  ######################################################################
+
+  def test_special_book_abbrev
+    # Abbrev "Phil" would technical match "Philipper" and "Philemon"
+    # and therefore throw a ParserError because it's ambiguous,
+    # but in German the abbrev "Phil" is generally used for "Philipper",
+    # so the parser should be able to support such behaviour.
+    text = 'Phil 4,4'
+    assert_parsed_ast_for_text [pass(text, 50, 4, 4, 50, 4, 4)], text
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scripref
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.8.0
 platform: ruby
 authors:
 - Jan Friedrich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-06 00:00:00.000000000 Z
+date: 2016-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rim