sqlbible 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 96109d81bd585cf38052c95bada0cb07f8c67796e9dd9c9123b26f9f2f2977f7
-  data.tar.gz: e73d3ddb3b30911468000e9b86c35ac5e9826b496cb2e15f27e20fb14d6553ab
+  metadata.gz: 0db4b2a65f0c016b81b2d1ec4c0cb45c85bb619eacf7aa802cea2fcfda88048c
+  data.tar.gz: 61e97c6905189eec0a5cfc6ef1b02a8cc91dd1d4ecd1fe1d9250db1c9c93c423
 SHA512:
-  metadata.gz: 7146abd51b0b4ff2e9da21cbd17c2a94f2e0ea67c62ce3315429bc1047d1b6c8e219d72c4564c41f353182fada41c4d84a67620ea8b0caca6cba56478f30e02e
-  data.tar.gz: 6dc22bbaadb8d512edcf3c2e2e710653cdcd26864c30517f1d2226407ec03f20f5071815184e163413e95f9bee901a33676a47a4d62cd042bc8b6942abf5027d
+  metadata.gz: 7ba9e92407bc21109d36538b6932b04790a0d6082ca6131260280b6aaaf2b96e3bf42872d352637c8846ebb4d28999da222b0130a30ac41e47414d36684bd09a
+  data.tar.gz: c5250da5c011c5e4fb1e5f3536be717a84c550f9f10dd8c03d2665cdb369982aaa4fbab4d83a183010245621dda4cf092f05746f05f61c4349507dd96d1a4b5d

data/README.md

@@ -35,11 +35,14 @@ bible.reference(ref)
 
 ### Sqlbible as command-line application
 
+It is possible to convert bibles in OSIS XML format to SQLite databases for
+Sqlbible, to search for regular expressions and show text for references.
+
 See help of the command-line application:
 
 ```shell
 sqlbible -h
-``
+```
 
 ## Requirements
 

data/bin/sqlbible

@@ -2,18 +2,93 @@
 # encoding: utf-8
 # frozen_string_literal: false
 
-require 'optimist'
+require 'optimist_xl'
+require 'scripref'
+require 'sqlbible'
 
-opts = Optimist.options do
-  opt :convert, 'Convert a bible from OSIS-XML to Sqlbible format', type: String
+result = OptimistXL.options do
+  synopsis 'Usage: sqlitebible [options] [<command> [suboptions] <filename>]'
+  subcmd :convert, 'Convert a bible from OSIS-XML to Sqlbible format' do
+    opt :output, 'Output filename of the generated Sqlbible file', type: String
+  end
+  subcmd :search, 'Search with regular expressions' do
+    opt :search, 'Regular expression to search (multiple allowed)', type: String, multi: true, required: true
+    opt :lang, 'Language for parsing and formatting scripture references', type: String, permitted: %w(de en), default: 'en'
+    opt :output, 'Output filename', type: String
+    opt :range, 'Search range, example: "John 1-10"', type: String
+  end
+  subcmd :text, 'Show text of references' do
+    opt :lang, 'Language for parsing and formatting scripture references', type: String, permitted: %w(de en), default: 'en'
+    opt :output, 'Output filename', type: String
+    opt :reference, 'Reference to show, example: "John 3:16; 10:27-30"', type: String, required: true
+  end
+  version format("sqlbible %s\nschema version %s", Sqlbible::VERSION, Sqlbible.schema_version)
+end
+
+unless filename = result.leftovers.first
+  $stderr.puts 'no filename given'
+  exit 1
+end
+
+def determine_lang_mod subopts
+  case l = subopts[:lang]
+  when 'en', nil
+    Scripref::English
+  when 'de'
+    Scripref::German
+  else
+    fail format("lang option #{l} is not supported")
+  end
+end
+
+def determine_out subopts
+  if fn = subopts[:output]
+    out = File.open(opts[:output], 'w')
+  else
+    out = $stdout
+  end
 end
 
-if osis_fn = opts[:convert]
+def format_verse f, v
+  format('%s: %s', f.format(v.scripref_passage), v.plaintext)
+end
+
+subopts = result.subcommand_options
+
+case result.subcommand
+when 'convert'
   require 'sqlbible/convert'
-  sqlite_fn = osis_fn.sub(/\.xml/i, '') << '.sqlite'
+  osis_fn = filename
+  sqlite_fn = subopts[:output] || osis_fn.sub(/\.xml/i, '') << '.sqlite'
   if $stdout.tty?
     puts "convert #{osis_fn} to #{sqlite_fn} ..."
   end
   Sqlbible.convert osis_fn, sqlite_fn
+  exit
+when 'search'
+  searches = subopts[:search]
+  lang_mod = determine_lang_mod(subopts)
+  if r = subopts[:range]
+    p = Scripref::Parser.new(lang_mod)
+    range = p.parse(r)
+  else
+    range = nil
+  end
+  out = determine_out subopts
+  bible = Sqlbible.new(filename)
+  regexes = searches.map {|s| Regexp.new(s)}
+  f = Scripref::Formatter.new(lang_mod, bookformat: :abbrev)
+  bible.search(regexes, range: range).each do |v|
+    out.puts format_verse(f, v)
+  end
+when 'text'
+  lang_mod = determine_lang_mod(subopts)
+  p = Scripref::Parser.new(lang_mod)
+  f = Scripref::Formatter.new(lang_mod, bookformat: :abbrev)
+  ref = p.parse(subopts[:reference])
+  bible = Sqlbible.new(filename)
+  out = determine_out subopts
+  bible.reference(ref).flatten.each do |v|
+    out.puts format_verse(f, v)
+  end
 end
-

data/lib/sqlbible/convert.rb

@@ -8,6 +8,8 @@ require_relative '../sqlbible'
 
 class Sqlbible
 
+  # Convert a bible file in OSIS XML format to another file in SQLite format
+  # for Sqlbible
   def self.convert osis_fn, sqlite_fn
     last_bookid = nil
     booknumber = 0

data/lib/sqlbible/version.rb

@@ -0,0 +1,6 @@
+# encoding: utf-8
+# frozen_string_literal: true
+
+class Sqlbible
+  VERSION = '1.1.0'
+end

data/lib/sqlbible.rb

@@ -1,12 +1,12 @@
-# encooding: utf-8
+# encoding: utf-8
 # frozen_string_literal: true
 
 require 'scripref'
 require 'sqlite3'
 
-class Sqlbible
+require_relative 'sqlbible/version'
 
-  VERSION = '1.0.0'
+class Sqlbible
 
   def initialize db_filename
     @db = SQLite3::Database.new(db_filename)
@@ -16,17 +16,22 @@ class Sqlbible
     check_schema_version
   end
 
+  # Get an array of Verse instances for a Scripref::Passage
   def passage pass
     rowid1, rowid2 = passage2rowids(pass)
     res = select_text(where: 'rowid between ? and ?', args: [rowid1, rowid2])
     parse_verse_list(res)
   end
 
+  # Get an array of arrays of Verse instances for a Scripref reference (array
+  # of Scripref::Passage instances)
   def reference ref
     ref.select {|e| e.kind_of?(Scripref::Passage)}.map {|pass| passage(pass)}
   end
 
-  def search obj, range: nil
+  # 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)
+  def search *searches, range: nil
     where_arr = []
     args = []
     if range
@@ -35,17 +40,26 @@ class Sqlbible
       where_arr == [or_join_where(where_arr)]
       args = passages.map {|p| passage2rowids(p)}.flatten
     end
-    case obj
-    when Regexp
-      where_arr << 'plaintext regexp ?'
-      args << obj.source
-      res = select_text(where: and_join_where(where_arr), args: args)
-    else
-      fail 'unknown search object'
+    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
 
+  # Get the schema version of the SQLite database of the instance
+  def schema_version
+    Sqlbible.select_schema_version(@db)
+  end
+
+  # Representation of a verse
   Verse = Struct.new :osisid, :bookid, :chapter, :verse, :xml, :plaintext, keyword_init: true do
     def scripref_passage
       Scripref::Passage.new(b1: bookid, c1: chapter, v1: verse, b2: bookid, c2: chapter, v2: verse)
@@ -54,23 +68,41 @@ class Sqlbible
 
   class << self
 
+    # Get the database schema as string
     def db_schema
       File.read(File.join(__dir__, '../schema.sql'))
     end
 
-  end
+    # Get an array of the major and minor version of the database schema of the
+    # actual version of the lib
+    def schema_major_minor
+      lib_db = SQLite3::Database.new(':memory:')
+      lib_db.execute_batch(Sqlbible.db_schema)
+      select_schema_major_minor(lib_db)
+    end
 
-  private
+    # Get the version of the database schema of the actual version of the lib
+    def schema_version
+      schema_major_minor.join('.')
+    end
+
+    # Get an array of the major and minor version of an Sqlbible database
+    def select_schema_major_minor db
+      db.execute("select major, minor from schema_version").first
+    end
+
+    # Get the version of an Sqlbible database
+    def select_schema_version db
+      select_schema_major_minor(db).join('.')
+    end
 
-  def select_schema_version db
-    db.execute("select major, minor from schema_version").first
   end
 
+  private
+
   def check_schema_version
-    lib_db = SQLite3::Database.new(':memory:')
-    lib_db.execute_batch(Sqlbible.db_schema)
-    major_lib, minor_lib = select_schema_version(lib_db)
-    major_bible, minor_bible = select_schema_version(@db)
+    major_lib, minor_lib = Sqlbible.schema_major_minor
+    major_bible, minor_bible = Sqlbible.select_schema_major_minor(@db)
     if major_bible < major_lib || major_bible == major_lib && minor_bible < minor_lib
       fail 'database schema of bible database is too old'
     end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: sqlbible
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Jan Friedrich
 bindir: bin
 cert_chain: []
-date: 2024-10-31 00:00:00.000000000 Z
+date: 2024-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -24,19 +24,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.16'
 - !ruby/object:Gem::Dependency
-  name: optimist
+  name: optimist_xl
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: scripref
   requirement: !ruby/object:Gem::Requirement
@@ -90,6 +90,7 @@ files:
 - bin/sqlbible
 - lib/sqlbible.rb
 - lib/sqlbible/convert.rb
+- lib/sqlbible/version.rb
 - schema.sql
 homepage: https://bitbucket.org/janfri/sqlbible
 licenses: