Class: Sqlbible

Inherits:
Object
  • Object
show all
Defined in:
lib/sqlbible.rb,
lib/sqlbible/convert.rb,
lib/sqlbible/version.rb

Defined Under Namespace

Classes: Verse

Constant Summary collapse

VERSION = 
'1.3.4'

Class Attribute Summary collapse

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(db_name) ⇒ Sqlbible

Returns a new instance of Sqlbible.



14
15
16
17
18
19
20
21
 
# File 'lib/sqlbible.rb', line 14

def initialize db_name
  @db_filename = Sqlbible.resolve_db_filename(db_name, check_existence: true)
  @db = SQLite3::Database.new(@db_filename)
  @db.enable_load_extension(true)
  pcre_extension_file = ENV['SQLITE_PCRE_EXTENSION']
  @db.load_extension(pcre_extension_file) if pcre_extension_file
  check_schema_version
end

Class Attribute Details

.bibles_dir ⇒ Object (readonly)

Returns the value of attribute bibles_dir.



77
78
79
 
# File 'lib/sqlbible.rb', line 77

def bibles_dir
  @bibles_dir
end

Instance Attribute Details

#db_filename ⇒ Object (readonly)

Returns the value of attribute db_filename.



12
13
14
 
# File 'lib/sqlbible.rb', line 12

def db_filename
  @db_filename
end

Class Method Details

.bible_names ⇒ Object

Get a list of the names of the bibles in bibles_dir



85
86
87
 
# File 'lib/sqlbible.rb', line 85

def bible_names
  Dir[File.join(bibles_dir, '*.sqlbible')].map {|fn| File.basename(fn, '.sqlbible')}.sort
end

.convert(osis_fn, sqlite_fn) ⇒ Object

Convert a bible file in OSIS XML format to another file in SQLite format for Sqlbible



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/sqlbible/convert.rb', line 13

def self.convert osis_fn, sqlite_fn
  last_bookid = nil
  booknumber = 0

  doc = Nokogiri.XML(File.read(osis_fn))
  db = SQLite3::Database.new(sqlite_fn)
  db.execute_batch(Sqlbible.db_schema)

  doc.css('verse').each do |v|
    osisid = v['osisID']
    bookid, chapter, verse = osisid.split('.')
    unless bookid == last_bookid
      booknumber += 1
      db.execute "insert into books (bookid, booknumber) values (?, ?)", [bookid, booknumber]
      last_bookid = bookid
    end
    xml = v.children.to_xml
    plaintext = ''
    v.children.each do |e|
      case e.name
      when 'note'
        # ignore
      when 'divineName'
        plaintext << e.text.upcase
      when 'lb'
        plaintext << "\n"
      else
        plaintext << e.text
      end
    end
    plaintext.strip!
    db.execute "insert into text (osisid, bookid, booknumber, chapter, verse, xml, plaintext) values (?, ?, ?, ?, ?, ?, ?)", [osisid, bookid, booknumber, chapter, verse, xml, plaintext]
  end
end

.db_schema ⇒ Object

Get the database schema as string



80
81
82
 
# File 'lib/sqlbible.rb', line 80

def db_schema
  File.read(File.join(__dir__, '../schema.sql'))
end

.resolve_db_filename(db_name, check_existence: false) ⇒ Object 



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/sqlbible.rb', line 112

def resolve_db_filename db_name, check_existence: false
  db_name = db_name.to_s
  if File.basename(db_name, '.sqlbible') == db_name
    fn = File.join(bibles_dir, format('%s.sqlbible', db_name))
    if check_existence && !File.exist?(fn)
      msg = format('database %s not found, file %s does not exist', db_name, fn)
      sc = DidYouMean::SpellChecker.new(dictionary: bible_names)
      res = sc.correct(db_name)
      unless res.empty?
        msg = format("%s\ndid you mean %s", msg, res.join(', '))
      end
      fail ArgumentError, msg
    end
  else
    fn = db_name
    if check_existence && !File.exist?(fn)
      fail ArgumentError, format('file %s does not exist', fn)
    end
  end
  fn
end

.schema_major_minor ⇒ Object

Get an array of the major and minor version of the database schema of the actual version of the lib



91
92
93
94
95
 
# File 'lib/sqlbible.rb', line 91

def schema_major_minor
  lib_db = SQLite3::Database.new(':memory:')
  lib_db.execute_batch(Sqlbible.db_schema)
  select_schema_major_minor(lib_db)
end

.schema_version ⇒ Object

Get the version of the database schema of the actual version of the lib



98
99
100
 
# File 'lib/sqlbible.rb', line 98

def schema_version
  schema_major_minor.join('.')
end

.select_schema_major_minor(db) ⇒ Object

Get an array of the major and minor version of an Sqlbible database



103
104
105
 
# File 'lib/sqlbible.rb', line 103

def select_schema_major_minor db
  db.execute("select major, minor from schema_version").first
end

.select_schema_version(db) ⇒ Object

Get the version of an Sqlbible database



108
109
110
 
# File 'lib/sqlbible.rb', line 108

def select_schema_version db
  select_schema_major_minor(db).join('.')
end

Instance Method Details

#passage(pass) ⇒ Object

Get an array of Verse instances for a Scripref::Passage



24
25
26
27
28
 
# File 'lib/sqlbible.rb', line 24

def passage pass
  rowid1, rowid2 = passage2rowids(pass)
  res = select_text(where: 'rowid between ? and ?', args: [rowid1, rowid2])
  parse_verse_list(res)
end

#reference(ref) ⇒ Object

Get an array of arrays of Verse instances for a Scripref reference (array of Scripref::Passage instances)



32
33
34
 
# File 'lib/sqlbible.rb', line 32

def reference ref
  ref.select {|e| e.kind_of?(Scripref::Passage)}.map {|pass| passage(pass)}
end

#schema_version ⇒ Object

Get the schema version of the SQLite database of the instance



62
63
64
 
# File 'lib/sqlbible.rb', line 62

def schema_version
  Sqlbible.select_schema_version(@db)
end

#search(*searches, range: nil) ⇒ Object

Get an array of Verse instances for a search with one ore more regular expressions (optional a search range of a Scripref reference is possible)



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/sqlbible.rb', line 38

def search *searches, range: nil
  where_arr = []
  args = []
  if range
    passages = Array(range).select {|e| e.kind_of? Scripref::Passage}
    passages.size.times {where_arr << 'rowid between ? and ?'}
    where_arr = [or_join_where(where_arr)]
    args = passages.map {|p| passage2rowids(p)}.flatten
  end
  searches.flatten.each do |o|
    case o
    when Regexp
      where_arr << 'plaintext regexp ?'
      args << o.to_s
    else
      fail format('search objects of class %s are not (yet) supported', o.class)
    end
  end
  where = and_join_where(where_arr)
  res = select_text(where: where, args: args)
  parse_verse_list(res)
end