bomdb 0.0.1

data/lib/bomdb/import/books.rb

@@ -0,0 +1,36 @@
+require 'json'
+
+module BomDB
+  module Import
+    class Books < Import::Base
+
+      def reset
+        schema.reset(:books)
+      end
+
+      # Expected data format is:
+      # [
+      #   [book_name:String, book_group:String, book_sort:Integer],
+      #   ...
+      # ]
+      def json(data)
+        if !schema.has_tables?(:books)
+          return Import::Result.new(
+            success: false,
+            error: "Database table 'books' not present."
+          )
+        end
+        ensure_parsed_json(data).each do |name, group, sort|
+          @db[:books].insert(
+            book_name: name,
+            book_group: group,
+            book_sort: sort
+          )
+        end
+        Import::Result.new(success: true)
+      rescue Sequel::UniqueConstraintViolation => e
+        Import::Result.new(success: false, error: e)
+      end
+    end
+  end
+end

data/lib/bomdb/import/result.rb

@@ -0,0 +1,24 @@
+module BomDB
+  module Import
+    class Result
+      attr_reader :success, :error
+
+      def initialize(success:, error: nil)
+        @success = success
+        @error = error
+      end
+
+      def success?
+        @success
+      end
+
+      def message
+        if @success
+          "Succeeded"
+        else
+          @error.to_s
+        end
+      end
+    end
+  end
+end

data/lib/bomdb/import/verses.rb

@@ -0,0 +1,62 @@
+module BomDB
+  module Import
+    class Verses < Import::Base
+      TABLES = [:books, :verses, :versions, :contents]
+
+      def reset
+        schema.reset(*(TABLES - [:books]))
+      end
+
+      def json(data)
+        if schema.has_tables?(*TABLES)
+          ensure_parsed_json(data).each_pair do |book_name, year_versions|
+            year_versions.each do |year_version|
+              year_version.each_pair do |year, d|
+                m = d["meta"]
+
+                book = @db[:books].where(:book_name => book_name).first
+                if book.nil?
+                  return Import::Result.new(success: false, error: "Unable to find book '#{book_name}'")
+                end
+
+                verse = @db[:verses].where(
+                  :book_id => book[:book_id],
+                  :verse_chapter => m["chapter"],
+                  :verse_number  => m["verse"],
+                  :verse_heading => m["heading"] ? 0 : nil
+                ).first
+                verse_id = (verse && verse[:verse_id]) || @db[:verses].insert(
+                  book_id: book[:book_id],
+                  verse_chapter: m["chapter"],
+                  verse_number:  m["verse"],
+                  verse_heading: m["heading"] ? 0 : nil
+                )
+
+                version = @db[:versions].where(:version_year => year).first
+                version_id =  (version && version[:version_id]) || @db[:versions].insert(
+                  version_name: year.to_s,
+                  version_year: year
+                )
+
+                @db[:contents].insert(
+                  version_id:   version_id,
+                  verse_id:     verse_id,
+                  content_body: d["content"]
+                )
+              end
+            end
+          end
+          Import::Result.new(success: true)
+        else
+          Import::Result.new(
+            success: false,
+            error: "Database tables #{TABLES.join(', ')} not ready. Try again with --reset."
+          )
+        end
+      rescue Sequel::UniqueConstraintViolation => e
+        Import::Result.new(success: false, error: e)
+      end
+
+    end
+  end
+end

data/lib/bomdb/query.rb

@@ -0,0 +1,40 @@
+module BomDB
+  class Query
+    def initialize(edition:, exclude: nil)
+      @edition = edition
+      @exclude = exclude
+    end
+
+    def query(headings: false)
+      db = BomDB.db
+      q = db[:verses].
+        join(:books, :book_id => :book_id).
+        join(:versions).
+        join(:contents, :version_id => :version_id, :verse_id => :verses__verse_id).
+        order(:book_sort, :verse_heading, :verse_chapter, :verse_number).
+        select(:book_name, :verse_chapter, :verse_number, :content_body)
+      q.where!(:version_name => @edition) if @edition
+      q.where!(:verse_heading => nil) unless headings
+      q.exclude!(:verses__verse_id => db[:refs].select(:verse_id).where(:ref_name => @exclude)) if @exclude
+      # require 'byebug'; byebug
+      # p q
+      q
+    end
+
+    def print(book: true, chapter: true, verse: true, sep: ' ')
+      shown = false
+      query.each do |row|
+        shown = true
+        puts [
+          book && row[:book_name] || nil,
+          (chapter || verse) && [
+            chapter && row[:verse_chapter] || nil,
+            verse && row[:verse_number] || nil
+          ].compact.join(":") || nil,
+          row[:content_body]
+        ].compact.join(sep)
+      end
+      puts "Nothing found" unless shown
+    end
+  end
+end

data/lib/bomdb/range.rb

@@ -0,0 +1,12 @@
+module BomDB
+  # A range of verses of the Book of Mormon
+  class Range
+    def initialize(str)
+      @str = str
+    end
+
+    def parse
+      
+    end
+  end
+end

data/lib/bomdb/schema.rb

@@ -0,0 +1,92 @@
+require 'set'
+
+module BomDB
+  class Schema
+    def initialize(db)
+      @db = db
+    end
+
+    def has_tables?(*table_names)
+      Set.new(@db.tables) >= Set.new(table_names)
+    end
+
+    def reset(*table_names)
+      drop_tables(table_names)
+      create_tables(table_names)
+    end
+
+    def drop_tables(table_names = nil)
+      (table_names || @db.tables).each do |name|
+        @db.drop_table(name) if @db.tables.include?(name)
+      end
+    end
+
+    def create_tables(table_names = nil)
+      @db.create_table(:books) do
+        primary_key :book_id
+
+        string  :book_name, :unique => true
+        string  :book_group
+        integer :book_sort
+      end if include?(table_names, :books)
+
+      @db.create_table(:verses) do
+        primary_key :verse_id
+        foreign_key :book_id, :books
+
+        integer :verse_chapter, :null => true
+        integer :verse_number,   :null => true
+        integer :verse_heading, :null => true
+
+        index [:book_id, :verse_chapter, :verse_number, :verse_heading], :unique => true
+      end if include?(table_names, :verses)
+
+      @db.create_table(:versions) do
+        primary_key :version_id
+
+        string      :version_name
+        integer     :version_year
+      end if include?(table_names, :versions)
+
+      @db.create_table(:contents) do
+        primary_key :content_id
+        foreign_key :version_id, :versions
+        foreign_key :verse_id, :verses
+
+        string :content_body
+
+        index [:version_id, :verse_id], :unique => true
+      end if include?(table_names, :contents)
+
+      @db.create_table(:refs) do
+        primary_key :ref_id
+        foreign_key :verse_id, :verses
+
+        string  :ref_name
+
+        string  :ref_book
+        integer :ref_chapter
+        integer :ref_verse
+        integer :ref_page_start
+        integer :ref_page_end
+        boolean :ref_is_parallel
+        boolean :ref_is_quotation
+      end if include?(table_names, :refs)
+
+      @db.create_table(:notes) do
+        primary_key :note_id
+        foreign_key :verse_id, :verses
+
+        string :note_highlight
+        string :note_body
+      end if include?(table_names, :notes)
+    end
+
+    protected
+
+    def include?(table_names, name)
+      table_names.nil? ||
+      table_names.map{ |n| n.to_sym }.include?(name.to_sym)
+    end
+  end
+end

data/lib/bomdb/version.rb

@@ -0,0 +1,3 @@
+module BomDB
+  VERSION = "0.0.1"
+end

data/spec/bomdb/config_spec.rb

@@ -0,0 +1,27 @@
+require_relative '../spec_helper'
+
+# Temporarily set env during block
+def set_env(dict = {}, &block)
+  restore = {}
+  dict.each_pair{ |k,v| restore[k.to_s] = ENV[k.to_s]; ENV[k.to_s] = v }
+  block.call
+  restore.each_pair{ |k,v| ENV[k.to_s] = v }
+end
+
+describe BomDB::Config do
+  let(:config) { BomDB::Config.new(data_dir: '/tmp') }
+
+  it "reads ENV vars" do
+    set_env(BOMDB_DB_PATH: '/tmp/test') do
+      expect(BomDB::Config.new.db_path).to eq('/tmp/test')
+    end
+  end
+
+  it "loads config from .bomdb" do
+    expect(config.db_file).to eq("book_of_mormon.db")
+  end
+
+  it "combines data_dir to make db_path" do
+    expect(config.db_path).to eq("/tmp/book_of_mormon.db")
+  end
+end

data/spec/bomdb_spec.rb

@@ -0,0 +1,30 @@
+require_relative 'spec_helper'
+require 'tmpdir'
+
+describe BomDB do
+  it "has a version" do
+    expect(BomDB::VERSION).to be_a(String)
+  end
+
+  it "has configuration" do
+    expect(BomDB.config).to be_a(BomDB::Config)
+  end
+
+  context "with db path" do
+    let(:path) { File.join(@dir, "bom.db") }
+    before { @dir = Dir.mktmpdir }
+    after { FileUtils.remove_entry_secure @dir }
+
+    it "connects to sqlite db" do
+      db = BomDB.db(path)
+      expect(db).to be_a(Sequel::SQLite::Database)
+    end
+
+    it "creates a database file" do
+      db = BomDB.db(path)
+      db.create_table(:test) { primary_key :id }
+      expect(File.exist?(path)).to be_truthy
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'rspec'
+require 'byebug'
+
+require_relative '../lib/bomdb'

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: bomdb
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Duane Johnson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-04-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sequel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.21'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.21'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.19'
+- !ruby/object:Gem::Dependency
+  name: constellation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: A command-line queryable database of multiple editions of the Book of
+  Mormon
+email:
+- duane.johnson@gmail.com
+executables:
+- bomdb
+extensions: []
+extra_rdoc_files: []
+files:
+- ".bomdb"
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/bomdb
+- bomdb.gemspec
+- data/book_of_mormon.db
+- data/books.json
+- data/verses.json
+- lib/bomdb.rb
+- lib/bomdb/cli/application.rb
+- lib/bomdb/config.rb
+- lib/bomdb/import/base.rb
+- lib/bomdb/import/biblical_refs.rb
+- lib/bomdb/import/books.rb
+- lib/bomdb/import/result.rb
+- lib/bomdb/import/verses.rb
+- lib/bomdb/query.rb
+- lib/bomdb/range.rb
+- lib/bomdb/schema.rb
+- lib/bomdb/version.rb
+- spec/bomdb/config_spec.rb
+- spec/bomdb_spec.rb
+- spec/spec_helper.rb
+homepage: http://bomdb.wordtree.org
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Book of Mormon Database
+test_files:
+- spec/bomdb/config_spec.rb
+- spec/bomdb_spec.rb
+- spec/spec_helper.rb