bomdb 0.5.0 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f7fbd83f638d94be3f15c4cf8442e2cdeccf8b1e
-  data.tar.gz: 2625af19b7be4478cd1abf1a39900ff41d21e10c
+  metadata.gz: 6045b00d06ff5e4d4ae162ef54fe995df71ab90b
+  data.tar.gz: f252a2454c9a02f8db6e45ebcded298c1a52ef57
 SHA512:
-  metadata.gz: 3c3d9acb48871cf5676c901c3d45b233a4d7e208da3d873b5b63930a2dbbe3d8456472b3045597f61493f8181b468f7d9a82defe4354d4252857ad2ded14ddcd
-  data.tar.gz: 58c3914913e18e8aa645997b13599d33e4c5876ce9fbf0e0928fd17e8603baf20ef87dd50f20822922fc2761fe2e6db5907fe58f0d8350012ffff667c62d8e48
+  metadata.gz: 40de7880d7173f51e6505b5ca829ffdd056a81122b30561cd931f49f70c970800cbcbdf88fbd7835adc4ff90eabd50d43fb51020dc9a997ca2babf630b3cfa83
+  data.tar.gz: c9f8a9bcae9d097675516cea81320f18c22b3f605ab3401b1222675d15a600301ebeffc5eb5b41b28ed44621fbb23887d3654e6733550a630f990d40f8600eb6

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    bomdb (0.5.0)
+    bomdb (0.6.0)
       colorize (~> 0.7)
       constellation (~> 0.1)
       levenshtein-ffi (~> 1.1)

data/README.md

@@ -8,7 +8,7 @@ BomDB is a command-line tool (packaged as a Ruby gem) that provides multiple edi
 Let's show the 1992 edition of the Book of Mormon:
 
 ```bash
-$ bomdb show 1992
+$ bomdb show --edition=1992
 
 1 Nephi 1:1 I, Nephi, having been born of goodly parents, therefore I was taught somewhat in all the learning of my father...
 # ... etc ...
@@ -18,7 +18,7 @@ Moroni 10:34 And now I bid unto all, farewell.  I soon go to rest in the paradis
 Or the 1829 printer's manuscript:
 
 ```bash
-$ bomdb show 1829
+$ bomdb show --edition=1829
 
 1 Nephi 1:1 I Nephi having been born of goodly parents, therefore I was taught somewhat in all the learning of my father...
 # ... etc ...
@@ -27,7 +27,7 @@ Moroni 10:34 And now I bid unto all farewell. I soon go to rest in the paradise
 Suppose we want to remove the book, chapter, and verse headings from the output:
 
 ```bash
-$ bomdb show 1829 --no-verses
+$ bomdb show --edition=1829 --no-verses
 
 I Nephi having been born of goodly parents, therefore I was taught somewhat in all the learning of my father...
 # ... etc ...
@@ -37,16 +37,32 @@ And now I bid unto all farewell. I soon go to rest in the paradise of God...
 Exclude verses in the Book of Mormon that are biblical inclusions:
 
 ```bash
-$ bomdb show 1829 --exclude Bible-OT
+$ bomdb show --edition=1829 --exclude Bible-OT
 # ... shows 6080 verses instead of the usual 6604
 ```
 
+Or, show only 1 Nephi, without Old Testament references:
+
+```bash
+$ bomdb show '1 Nephi 1-22' --exclude Bible-OT
+# ... shows 563 verses in 1st Nephi (1st Nephi has 618 verses,
+# but some are from the Old Testament)
+```
+
+BomDB uses the [Mericope](https://github.com/wordtreefoundation/mericope) gem to parse scriptural ranges ("pericopes"), so it is quite flexible:
+
+```bash
+$ bomdb show 'Mosiah 5:1-2,6'
+Mosiah 5:1 And now it came to pass that when king Benjamin had thus spoken...
+Mosiah 5:2 And they all cried with one voice, saying: Yea, we believe...
+Mosiah 5:6 And now these are the words which king Benjamin desired of them...
+```
 
 ### IMPORT and EXPORT portions of the database
 
 You can import and export any part of the database, such as the books, verses, editions, and contents (text) of the database.
 
-The github repository contains a set of "starter" json file that are used to seed the database with some reasonable structure and data; however, these json files are absent in the packaged Gem. If you've cloned the github repo, you can re-create the database from scratch:
+The github repository contains a set of "starter" json files that are used to seed the database with some reasonable structure and data; however, these json files are absent in the packaged Gem. If you've cloned the github repo, you can use these files to re-create the database from scratch:
 
 ```bash
 $ bundle exec bin/bomdb create
@@ -141,13 +157,17 @@ Note that `align` requires the [dwdiff](http://linux.die.net/man/1/dwdiff) comma
 
 ### Custom Queries
 
-Here's a simple way to analyze the Book of Mormon to see the wherefore/therefore divergence leading to the [Mosiah Priority](http://signaturebookslibrary.org/new-approaches-to-the-book-of-mormon-10/) (Mosiah was written before 1 Nephi) hypothesis:
+Here's a simple way to analyze the Book of Mormon to see the wherefore/therefore divergence leading to the [Mosiah Priority](http://signaturebookslibrary.org/new-approaches-to-the-book-of-mormon-10/) hypothesis (Mosiah was written before 1 Nephi):
 
 ```ruby
 $ bundle exec irb -rbomdb
 irb(main):001:0> q = BomDB::Query.new(exclude: 'Bible-OT')
 => #<BomDB::Query:0x007f90ad1cb408 @edition=1829, @exclude="Bible-OT", @headings=false>
-irb(main):002:0> q.books.map{ |book,content| [book, content.scan(/wherefore/i).size, content.scan(/therefore/i).size] }
+irb(main):002:0> q.books.map do |book,content|
+  [book,
+   content.scan(/wherefore/i).size,
+   content.scan(/therefore/i).size]
+end
 => [
      ["1 Nephi", 99, 13], ["2 Nephi", 126, 6], ["Jacob", 53, 1],
      ["Enos", 6, 0], ["Jarom", 3, 0], ["Omni", 6, 0], ["Words of Mormon", 5, 0],
@@ -187,12 +207,48 @@ end
 # Moroni            WWWWWWWWWWWW
 ```
 
-Other possible enumerables on a Query include:
+Other possible enumerables on a Query object include:
 
 - books: enumerate on each book of the Book of Mormon
 - chapters: enumerate on each book and chapter of the Book of Mormon
 - wordgroups(N): enumerate on consecutive N words, e.g. each 1000 words
 
+### Custom Queries and Charts
+
+Let's zoom in on the interesting book, Ether, where the Wherefore/Therefore crossover occurs:
+
+```ruby
+require 'bomdb'
+require 'google_chart' # gem is called 'gchartrb'
+
+q = BomDB::Query.new(range: 'Ether 1-15')
+
+data = q.chapters.map do |(book, chapter), content|
+  words = content.scan(/ +/).size
+  wh = content.scan(/wherefore/i).size.to_f / words
+  th = content.scan(/therefore/i).size.to_f / words
+  [chapter, wh, th]
+end
+
+axis_labels = data.map(&:first)
+wherefores = data.map{ |d| d[1] }
+therefores = data.map{ |d| d[2] }
+y_max = [wherefores.max, therefores.max].max
+title = 'Wherefores/Therefores Per Word in Ether'
+
+GoogleChart::LineChart.new('600x400', title, false) do |chart|
+  chart.data "Wherefores", wherefores, '2200ff'
+  chart.show_legend = true
+  chart.data "Therefores", therefores, 'ff2200'
+  chart.axis :y, range: [0.0, y_max], font_size: 16
+  chart.axis :x, range: axis_labels, font_size: 16
+  chart.grid x_step: 20.0, y_step: 30.0, length_segment: 1, length_blank: 0
+  puts chart.to_url
+end
+```
+
+![Wherefore/Therefores in Ether](http://chart.apis.google.com/chart?chs=600x400&cht=lc&chco=2200ff,ff2200&chxt=y,x&chxr=0,0.0,0.009721322099805573|1,1,15&chg=20.0,30.0,1.0,0.0&chd=s:AJOOcFpeRaQ8eWX,UJiVcRGFNAAEAAE&chdl=Wherefores|Therefores&chtt=Wherefores/Therefores+Per+Word+in+Ether+by+Chapter)
+
 ## Installation
 
 Ruby 2.1 is required. You should also have a normal build environment set up, e.g. command line tools on the mac, or GCC on Linux.
@@ -201,6 +257,8 @@ To install BomDB for use on the command line, use `gem install`:
 
     $ gem install bomdb
 
+To install `dwdiff` on your Mac OS X system: `brew install dwdiff`, or on Ubuntu: `sudo apt-get install dwdiff`.
+
 To include bomdb in another Ruby app, add this line to your application's `Gemfile`:
 
 ```ruby

data/lib/bomdb/cli/application.rb

@@ -10,9 +10,12 @@ module BomDB
 
 
       desc "import FILE", "import data from FILE into database, e.g. books.json"
-      option :type,    :type => :string, :default => nil
-      option :format,  :type => :string, :default => 'json'
-      option :edition, :type => :string, :default => nil
+      option :type,    :type => :string, :default => nil,
+             :description => "type of data to import, i.e. one of: books, verses, editions, contents, refs"
+      option :format,  :type => :string, :default => 'json',
+             :description => "format of the data being imported. One of: json, text"
+      option :edition, :type => :string, :default => nil,
+             :description => "edition of the Book of Mormon in which to import (assumes type=contents) (required when format=text)"
       def import(file)
         type   = (options[:type]   || type_from_file(file)).downcase
         format = (options[:format] || format_from_file(file)).downcase
@@ -40,9 +43,11 @@ module BomDB
 
 
 
-      desc "export TYPE", "export data from the database, e.g. books"
-      option :format, :type => :string,  :default => 'json'
-      option :editions, :type => :string, :default => :all
+      desc "export TYPE", "export data from the database, i.e. one of: books, verses, editions, contents"
+      option :format, :type => :string,  :default => 'json',
+             :description => "format of the data being imported. One of: json, text"
+      option :editions, :type => :string, :default => :all,
+             :description => "edition(s) of the Book of Mormon to export. Defaults to 'all' editions."
       def export(type)
         format = options[:format].downcase
 
@@ -116,11 +121,13 @@ module BomDB
 
 
 
-      desc "show EDITION RANGE", "show an edition of the Book of Mormon, or a RANGE of verses"
+      desc "show RANGE", "show a RANGE of verses in the Book of Mormon (defaults to 1829 edition)"
       option :verses,  :type => :boolean, :default => true,
              :description => "show book, chapter, verse annotations"
       option :exclude, :type => :string, :aliases => [:x],
              :description => "exclude verses that are references, e.g. Bible-OT references"
+      option :"exclude-only-quotations", :type => :boolean, :aliases => [:q],
+             :description => "don't exclude verses with references that are non-quotations"
       option :sep,     :type => :string,  :default => " ",
              :description => "separator between annotations and content, defaults to ' '"
       option :linesep, :type => :string,  :default => "\n",
@@ -131,7 +138,11 @@ module BomDB
              :description => "show output in 'alignment' mode. Useful for debugging 'align' subcommand issues."
       option :clean,   :type => :boolean, :default => false,
              :description => "remove punctuation and normalize text by sentence"
-      def show(edition = '1992', range = nil)
+      option :edition, :type => :string, :default => '1829',
+             :description => "show verses from a specific edition (see 'editions' command for list)"
+      option :search,  :type => :string, :default => nil,
+             :description => "show only verses that contain the search term"
+      def show(range = nil)
         body_format = nil
         wordsep = options[:sep]
         linesep = options[:linesep]
@@ -161,9 +172,11 @@ module BomDB
           end
         end
         BomDB::Query.new(
-          edition: edition,
-          exclude: options[:exclude]
-          # range: range
+          edition: options[:edition],
+          range: range,
+          search: options[:search],
+          exclude: options[:exclude],
+          exclude_only_quotations: options[:"exclude-only-quotations"]
         ).print(
           verse_format: verse_format,
           body_format: body_format,
@@ -222,8 +235,16 @@ module BomDB
             map { |r| "#{r[:ref_name]} (#{r[:count]} refs)" }
           puts rts.join("\n")
         else
-          rts = BomDB.db[:refs].where(:ref_name => type).
-            map{ |r| "#{r[:ref_book]} #{r[:ref_chapter]}:#{r[:ref_verse]}" }
+          rts = BomDB.db[:refs].
+            where(:ref_name => type).
+            join(:verses, :verse_id => :verse_id).
+            join(:books, :book_id => :book_id).
+            map do |r|
+              asterisk = r[:ref_is_quotation] ? '*' : ''
+              "#{r[:ref_book]} #{r[:ref_chapter]}:#{r[:ref_verse]} => " +
+              "#{r[:book_name]} #{r[:verse_chapter]}:#{r[:verse_number]}" +
+              "#{asterisk}"
+            end
           puts rts.join("\n")
         end
       end

data/lib/bomdb/query.rb

@@ -2,9 +2,12 @@ require 'bomdb/models/edition'
 
 module BomDB
   class Query
-    def initialize(edition: 1829, exclude: nil, headings: false)
+    def initialize(edition: 1829, range: nil, search: nil, exclude: nil, exclude_only_quotations: false, headings: false)
       @edition = edition
+      @range = range
+      @search = search
       @exclude = exclude
+      @exclude_only_quotations = exclude_only_quotations
       @headings = headings
     end
 
@@ -23,9 +26,20 @@ module BomDB
         select(:book_name, :verse_chapter, :verse_number, :content_body)
       q.where!(:editions__edition_id => edition[:edition_id]) if @edition
       q.where!(:verse_heading => nil) unless @headings
+      if @range
+        pericope = Mericope.new(@range)
+        pairs = pericope.ranges.map{ |r| [:verse_range_id, r] }
+        q.where!(Sequel::SQL::BooleanExpression.from_value_pairs(pairs, :OR))
+      end
+      if @search
+        q.where!(Sequel.like(Sequel.function(:LOWER, :content_body), "%#{@search.downcase}%"))
+      end
       if @exclude
         excluded_verse_ids = db[:refs].select(:verse_id).
           where(:ref_name => @exclude.split(/\s*,\s*/))
+        if @exclude_only_quotations
+          excluded_verse_ids.where!(ref_is_quotation: true)
+        end
         q.exclude!(:verses__verse_id => excluded_verse_ids)
       end
       q
@@ -83,12 +97,16 @@ module BomDB
           io.print sep
         end
         begin
-          io.print body_format[ row[:content_body] ]
+          content_body = row[:content_body]
+          if @search
+            content_body.gsub!(@search, @search.red)
+          end
+          io.print body_format[ content_body ]
         rescue TypeError
           next
         end
       end
-      io.puts "Nothing shown" unless shown
+      io.puts "Nothing to show" unless shown
     end
   end
 end

data/lib/bomdb/version.rb

@@ -1,3 +1,3 @@
 module BomDB
-  VERSION = "0.5.0"
+  VERSION = "0.6.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bomdb
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.1
 platform: ruby
 authors:
 - Duane Johnson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-15 00:00:00.000000000 Z
+date: 2015-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sequel