alexandria-book-collection-manager 0.7.3 → 0.7.8

data/lib/alexandria/config.rb

@@ -2,7 +2,7 @@
 
 module Alexandria
   module Config
-    SHARE_DIR = File.expand_path('../../share', File.dirname(__FILE__))
+    SHARE_DIR = File.expand_path("../../share", File.dirname(__FILE__))
     SOUNDS_DIR = "#{SHARE_DIR}/sounds/alexandria"
     DATA_DIR = "#{SHARE_DIR}/alexandria"
     MAIN_DATA_DIR = DATA_DIR

data/lib/alexandria/console.rb

@@ -9,11 +9,11 @@ module Alexandria
     collection = Alexandria::LibraryCollection.instance
     collection.reload
     libraries = collection.all_regular_libraries
-    output_string = ''
+    output_string = ""
     @books = libraries.flatten
     @books.each do |book|
-      book_authors = book.authors.join(' & ') if authors
-      output_string += [book.title, book_authors].join(', ') + "\n"
+      book_authors = book.authors.join(" & ") if authors
+      output_string += [book.title, book_authors].join(", ") + "\n"
     end
     output_string
   end

data/lib/alexandria/default_preferences.rb

@@ -0,0 +1,37 @@
+# This file is automatically generated by the alexandria installer.
+# Do not edit it directly.
+
+module Alexandria
+  class Preferences
+    DEFAULT_VALUES = {
+      "position" => [0, 0],
+      "size" => [640, 480],
+      "maximized" => false,
+      "sidepane_position" => 140,
+      "view_as" => 0,
+      "arrange_icons_mode" => 0,
+      "reverse_icons" => false,
+      "selected_library" => "",
+      "barcode_scanner" => "CueCat",
+      "play_scanning_sound" => true,
+      "play_scan_sound" => true,
+      "toolbar_visible" => true,
+      "sidepane_visible" => true,
+      "statusbar_visible" => true,
+      "col_authors_visible" => true,
+      "col_edition_visible" => true,
+      "col_isbn_visible" => true,
+      "col_publisher_visible" => true,
+      "col_publish_date_visible" => true,
+      "col_loaned_to_visible" => true,
+      "col_rating_visible" => true,
+      "col_redd_visible" => true,
+      "col_own_visible" => true,
+      "col_want_visible" => true,
+      "col_tags_visible" => true,
+      "cols_width" => "{}",
+      "providers_priority" => ["Amazon", "BarnesAndNoble", "AdLibris", "Proxis", "Thalia", "Siciliano", "WorldCat", "LOC", "BL", "SBN"],
+      "view_advanced_settings" => false
+    }
+  end
+end

data/lib/alexandria/execution_queue.rb

@@ -63,10 +63,11 @@ module Alexandria
 
       id, procedure, args, need_retval = ary
       retval = procedure.call(*args)
-      if need_retval
-        @protect_pending_retvals.synchronize do
-          @pending_retvals << [id, retval]
-        end
+
+      return unless need_retval
+
+      @protect_pending_retvals.synchronize do
+        @pending_retvals << [id, retval]
       end
     end
 
@@ -81,14 +82,14 @@ module Alexandria
         @id += 1
         @pending_calls << [@id, procedure, args, need_retval]
       end
-      if need_retval
-        loop do
-          @protect_pending_retvals.synchronize do
-            ary = @pending_retvals.find { |id, _retval| id == @id }
-            if ary
-              @pending_retvals.delete(ary)
-              return ary[1]
-            end
+      return unless need_retval
+
+      loop do
+        @protect_pending_retvals.synchronize do
+          ary = @pending_retvals.find { |id, _retval| id == @id }
+          if ary
+            @pending_retvals.delete(ary)
+            return ary[1]
           end
         end
       end

data/lib/alexandria/export_format.rb

@@ -11,17 +11,17 @@ module Alexandria
     include GetText
     include Logging
     extend GetText
-    bindtextdomain(Alexandria::TEXTDOMAIN, charset: 'UTF-8')
+    bindtextdomain(Alexandria::TEXTDOMAIN, charset: "UTF-8")
 
     def self.all
       [
-        new(_('Archived ONIX XML'), 'onix.tbz2', :export_as_onix_xml_archive),
-        new(_('Archived Tellico XML'), 'tc', :export_as_tellico_xml_archive),
-        new(_('BibTeX'), 'bib', :export_as_bibtex),
-        new(_('CSV list'), 'csv', :export_as_csv_list),
-        new(_('ISBN List'), 'txt', :export_as_isbn_list),
-        new(_('iPod Notes'), nil, :export_as_ipod_notes),
-        new(_('HTML Web Page'), nil, :export_as_html, true)
+        new(_("Archived ONIX XML"), "onix.tbz2", :export_as_onix_xml_archive),
+        new(_("Archived Tellico XML"), "tc", :export_as_tellico_xml_archive),
+        new(_("BibTeX"), "bib", :export_as_bibtex),
+        new(_("CSV list"), "csv", :export_as_csv_list),
+        new(_("ISBN List"), "txt", :export_as_isbn_list),
+        new(_("iPod Notes"), nil, :export_as_ipod_notes),
+        new(_("HTML Web Page"), nil, :export_as_html, true)
       ]
     end
 

data/lib/alexandria/export_library.rb

@@ -4,9 +4,9 @@
 #
 # See the file README.md for authorship and licensing information.
 
-require 'csv'
-require 'image_size'
-require 'tmpdir'
+require "csv"
+require "image_size"
+require "tmpdir"
 
 module Alexandria
   class ExportLibrary
@@ -36,41 +36,38 @@ module Alexandria
     end
 
     def export_as_onix_xml_archive(filename)
-      File.open(File.join(Dir.tmpdir, 'onix.xml'), 'w') do |io|
+      dir = Dir.mktmpdir
+      File.open(File.join(dir, "onix.xml"), "w") do |io|
         to_onix_document.write(io, 0)
       end
-      copy_covers(File.join(Dir.tmpdir, 'images'))
-      Dir.chdir(Dir.tmpdir) do
+      copy_covers(File.join(dir, "images"))
+      Dir.chdir(dir) do
         output = `tar -cjf \"#{filename}\" onix.xml images 2>&1`
         raise output unless $CHILD_STATUS.success?
       end
-      FileUtils.rm_rf(File.join(Dir.tmpdir, 'images'))
-      FileUtils.rm(File.join(Dir.tmpdir, 'onix.xml'))
+      FileUtils.rm_rf(File.join(dir, "images"))
+      FileUtils.rm(File.join(dir, "onix.xml"))
+    ensure
+      FileUtils.remove_entry dir
     end
 
     def export_as_tellico_xml_archive(filename)
-      File.open(File.join(Dir.tmpdir, 'tellico.xml'), 'w') do |io|
-        begin
-          to_tellico_document.write(io, 0)
-        rescue StandardError => ex
-          puts ex.message
-          puts ex.backtrace
-          raise ex
-        end
+      File.open(File.join(Dir.tmpdir, "tellico.xml"), "w") do |io|
+        to_tellico_document.write(io, 0)
       end
-      copy_covers(File.join(Dir.tmpdir, 'images'))
+      copy_covers(File.join(Dir.tmpdir, "images"))
       Dir.chdir(Dir.tmpdir) do
         output = `zip -q -r \"#{filename}\" tellico.xml images 2>&1`
         raise output unless $CHILD_STATUS.success?
       end
-      FileUtils.rm_rf(File.join(Dir.tmpdir, 'images'))
-      FileUtils.rm(File.join(Dir.tmpdir, 'tellico.xml'))
+      FileUtils.rm_rf(File.join(Dir.tmpdir, "images"))
+      FileUtils.rm(File.join(Dir.tmpdir, "tellico.xml"))
     end
 
     def export_as_isbn_list(filename)
-      File.open(filename, 'w') do |io|
+      File.open(filename, "w") do |io|
         each do |book|
-          io.puts((book.isbn || ''))
+          io.puts((book.isbn || ""))
         end
       end
     end
@@ -78,17 +75,17 @@ module Alexandria
     def export_as_html(filename, theme)
       FileUtils.mkdir(filename) unless File.exist?(filename)
       Dir.chdir(filename) do
-        copy_covers('pixmaps')
-        FileUtils.cp_r(theme.pixmaps_directory, 'pixmaps') if theme.has_pixmaps?
-        FileUtils.cp(theme.css_file, '.')
-        File.open('index.html', 'w') do |io|
+        copy_covers("pixmaps")
+        FileUtils.cp_r(theme.pixmaps_directory, "pixmaps") if theme.has_pixmaps?
+        FileUtils.cp(theme.css_file, ".")
+        File.open("index.html", "w") do |io|
           io << to_xhtml(File.basename(theme.css_file))
         end
       end
     end
 
     def export_as_bibtex(filename)
-      File.open(filename, 'w') do |io|
+      File.open(filename, "w") do |io|
         io << to_bibtex
       end
     end
@@ -97,27 +94,28 @@ module Alexandria
       FileUtils.mkdir(filename) unless File.exist?(filename)
       tempdir = Dir.getwd
       Dir.chdir(filename)
-      copy_covers('pixmaps')
-      File.open('index.linx', 'w') do |io|
-        io.puts '<TITLE>' + name + '</TITLE>'
+      copy_covers("pixmaps")
+      File.open("index.linx", "w") do |io|
+        io.puts "<TITLE>" + name + "</TITLE>"
         each do |book|
-          io.puts '<A HREF="' + book.ident + '">' + book.title + '</A>'
+          io.puts '<A HREF="' + book.ident + '">' + book.title + "</A>"
         end
         io.close
       end
       each do |book|
-        File.open(book.ident, 'w') do |io|
+        File.open(book.ident, "w") do |io|
           io.puts "<TITLE>#{book.title} </TITLE>"
           # put a link to the book's cover. only works on iPod 5G and above(?).
           if File.exist?(cover(book))
-            io.puts '<A HREF="pixmaps/' + book.ident + '.jpg' + '">' + book.title + '</A>'
+            io.puts '<A HREF="pixmaps/' + book.ident + ".jpg" + '">' + book.title + "</A>"
           else
             io.puts book.title
           end
-          io.puts book.authors.join(', ')
+          io.puts book.authors.join(", ")
           io.puts book.edition
-          io.puts((book.isbn || ''))
-          # we need to close the files so the iPod can be ejected/unmounted without us closing Alexandria
+          io.puts((book.isbn || ""))
+          # we need to close the files so the iPod can be ejected/unmounted
+          # without us closing Alexandria
           io.close
         end
       end
@@ -126,84 +124,83 @@ module Alexandria
     end
 
     def export_as_csv_list(filename)
-      CSV.open(filename, 'w', col_sep: ';') do |csv|
-        csv << ['Title', 'Authors', 'Publisher', 'Edition', 'ISBN', 'Year Published',
-                "Rating(#{Book::DEFAULT_RATING} to #{Book::MAX_RATING_STARS})", 'Notes',
-                'Want?', 'Read?', 'Own?', 'Tags']
+      CSV.open(filename, "w", col_sep: ";") do |csv|
+        csv << ["Title", "Authors", "Publisher", "Edition", "ISBN", "Year Published",
+                "Rating(#{Book::DEFAULT_RATING} to #{Book::MAX_RATING_STARS})", "Notes",
+                "Want?", "Read?", "Own?", "Tags"]
         each do |book|
-          csv << [book.title, book.authors.join(', '), book.publisher, book.edition, book.isbn,
-                  book.publishing_year, book.rating, book.notes,
-                  (book.want ? '1' : '0'), (book.redd ? '1' : '0'), (book.own ? '1' : '0'),
-                  (book.tags ? book.tags.join(', ') : '')]
+          csv << [book.title, book.authors.join(", "), book.publisher, book.edition,
+                  book.isbn, book.publishing_year, book.rating, book.notes,
+                  (book.want ? "1" : "0"), (book.redd ? "1" : "0"), (book.own ? "1" : "0"),
+                  (book.tags ? book.tags.join(", ") : "")]
         end
       end
     end
 
     private
 
-    ONIX_DTD_URL = 'http://www.editeur.org/onix/2.1/reference/onix-international.dtd'
+    ONIX_DTD_URL = "http://www.editeur.org/onix/2.1/reference/onix-international.dtd"
     def to_onix_document
       doc = REXML::Document.new
       doc << REXML::XMLDecl.new
-      doc << REXML::DocType.new('ONIXMessage',
+      doc << REXML::DocType.new("ONIXMessage",
                                 "SYSTEM \"#{ONIX_DTD_URL}\"")
-      msg = doc.add_element('ONIXMessage')
-      header = msg.add_element('Header')
-      header.add_element('FromCompany').text = 'Alexandria'
-      header.add_element('FromPerson').text = Etc.getlogin
+      msg = doc.add_element("ONIXMessage")
+      header = msg.add_element("Header")
+      header.add_element("FromCompany").text = "Alexandria"
+      header.add_element("FromPerson").text = Etc.getlogin
       now = Time.now
-      header.add_element('SentDate').text = format('%.4d%.2d%.2d%.2d%.2d',
-                                                   now.year, now.month, now.day, now.hour, now.min)
-      header.add_element('MessageNote').text = name
+      header.add_element("SentDate").text = now.strftime("%Y%m%d%H%M")
+      header.add_element("MessageNote").text = name
       @sorted.each_with_index do |book, idx|
         # fields that are missing: edition and rating.
-        prod = msg.add_element('Product')
-        prod.add_element('RecordReference').text = idx
-        prod.add_element('NotificationType').text = '03'  # confirmed
-        prod.add_element('RecordSourceName').text =
-          'Alexandria ' + Alexandria::DISPLAY_VERSION
-        prod.add_element('ISBN').text = (book.isbn || '')
-        prod.add_element('ProductForm').text = 'BA'       # book
-        prod.add_element('DistinctiveTitle').text = book.title
+        prod = msg.add_element("Product")
+        prod.add_element("RecordReference").text = idx
+        prod.add_element("NotificationType").text = "03"  # confirmed
+        prod.add_element("RecordSourceName").text =
+          "Alexandria " + Alexandria::DISPLAY_VERSION
+        prod.add_element("ISBN").text = (book.isbn || "")
+        prod.add_element("ProductForm").text = "BA"       # book
+        prod.add_element("DistinctiveTitle").text = book.title
         unless book.authors.empty?
           book.authors.each do |author|
-            elem = prod.add_element('Contributor')
+            elem = prod.add_element("Contributor")
             # author
-            elem.add_element('ContributorRole').text = 'A01'
-            elem.add_element('PersonName').text = author
+            elem.add_element("ContributorRole").text = "A01"
+            elem.add_element("PersonName").text = author
           end
         end
         if book.notes && !book.notes.empty?
-          elem = prod.add_element('OtherText')
+          elem = prod.add_element("OtherText")
           # reader description
-          elem.add_element('TextTypeCode').text = '12'
-          elem.add_element('TextFormat').text = '00' # ASCII
-          elem.add_element('Text').text = book.notes
+          elem.add_element("TextTypeCode").text = "12"
+          elem.add_element("TextFormat").text = "00" # ASCII
+          elem.add_element("Text").text = book.notes
         end
         if File.exist?(cover(book))
-          elem = prod.add_element('MediaFile')
+          elem = prod.add_element("MediaFile")
           # front cover image
-          elem.add_element('MediaFileTypeCode').text = '04'
-          elem.add_element('MediaFileFormatCode').text =
-            (Library.jpeg?(cover(book)) ? '03' : '02')
+          elem.add_element("MediaFileTypeCode").text = "04"
+          elem.add_element("MediaFileFormatCode").text =
+            (Library.jpeg?(cover(book)) ? "03" : "02")
           # filename
-          elem.add_element('MediaFileLinkTypeCode').text = '06'
-          elem.add_element('MediaFileLink').text =
-            File.join('images', final_cover(book))
+          elem.add_element("MediaFileLinkTypeCode").text = "06"
+          elem.add_element("MediaFileLink").text =
+            File.join("images", final_cover(book))
         end
         if book.isbn
-          BookProviders.each do |provider|
-            elem = prod.add_element('ProductWebsite')
-            elem.add_element('ProductWebsiteDescription').text =
+          BookProviders.list.each do |provider|
+            elem = prod.add_element("ProductWebsite")
+            elem.add_element("ProductWebsiteDescription").text =
               provider.fullname
-            elem.add_element('ProductWebsiteLink').text =
+            elem.add_element("ProductWebsiteLink").text =
               provider.url(book)
           end
         end
-        elem = prod.add_element('Publisher')
-        elem.add_element('PublishingRole').text = '01'
-        elem.add_element('PublisherName').text = book.publisher
-        prod.add_element('PublicationDate').text = book.publishing_year
+        elem = prod.add_element("Publisher")
+        elem.add_element("PublishingRole").text = "01"
+        elem.add_element("PublisherName").text = book.publisher
+        prod.add_element("PublicationDate").text = book.publishing_year
       end
       doc
     end
@@ -213,49 +210,51 @@ module Alexandria
       # http://periapsis.org/tellico/doc/hacking.html
       doc = REXML::Document.new
       doc << REXML::XMLDecl.new
-      doc << REXML::DocType.new('tellico',
+      doc << REXML::DocType.new("tellico",
                                 'PUBLIC "-//Robby Stephenson/DTD Tellico V7.0//EN"' \
                                 ' "http://periapsis.org/tellico/dtd/v7/tellico.dtd"')
-      tellico = doc.add_element('tellico')
-      tellico.add_attribute('syntaxVersion', '7')
-      tellico.add_namespace('http://periapsis.org/tellico/')
-      collection = tellico.add_element('collection')
-      collection.add_attribute('title', name)
-      collection.add_attribute('type', '2')
-      fields = collection.add_element('fields')
-      field1 = fields.add_element('field')
+      tellico = doc.add_element("tellico")
+      tellico.add_attribute("syntaxVersion", "7")
+      tellico.add_namespace("http://periapsis.org/tellico/")
+      collection = tellico.add_element("collection")
+      collection.add_attribute("title", name)
+      collection.add_attribute("type", "2")
+      fields = collection.add_element("fields")
+      field1 = fields.add_element("field")
       # a field named _default implies adding all default book
       # collection fields
-      field1.add_attribute('name', '_default')
-      images = collection.add_element('images')
+      field1.add_attribute("name", "_default")
+      images = collection.add_element("images")
       @sorted.each_with_index do |book, idx|
-        entry = collection.add_element('entry')
+        entry = collection.add_element("entry")
         new_index = (idx + 1).to_s
-        entry.add_attribute('id', new_index)
+        entry.add_attribute("id", new_index)
         # translate the binding
-        entry.add_element('title').text = book.title
-        entry.add_element('isbn').text = (book.isbn || '')
-        entry.add_element('pub_year').text = book.publishing_year
-        entry.add_element('binding').text = book.edition
-        entry.add_element('publisher').text = book.publisher
+        entry.add_element("title").text = book.title
+        entry.add_element("isbn").text = (book.isbn || "")
+        entry.add_element("pub_year").text = book.publishing_year
+        entry.add_element("binding").text = book.edition
+        entry.add_element("publisher").text = book.publisher
         unless book.authors.empty?
-          authors = entry.add_element('authors')
+          authors = entry.add_element("authors")
           book.authors.each do |author|
-            authors.add_element('author').text = author
+            authors.add_element("author").text = author
           end
         end
-        entry.add_element('read').text = book.redd.to_s if book.redd
-        entry.add_element('loaned').text = book.loaned.to_s if book.loaned
-        entry.add_element('rating').text = book.rating unless book.rating == Book::DEFAULT_RATING
-        entry.add_element('comments').text = book.notes if book.notes && !book.notes.empty?
+        entry.add_element("read").text = book.redd.to_s if book.redd
+        entry.add_element("loaned").text = book.loaned.to_s if book.loaned
+        unless book.rating == Book::DEFAULT_RATING
+          entry.add_element("rating").text = book.rating
+        end
+        entry.add_element("comments").text = book.notes if book.notes && !book.notes.empty?
         if File.exist?(cover(book))
-          entry.add_element('cover').text = final_cover(book)
-          image = images.add_element('image')
-          image.add_attribute('id', final_cover(book))
+          entry.add_element("cover").text = final_cover(book)
+          image = images.add_element("image")
+          image.add_attribute("id", final_cover(book))
           image_s = ImageSize.new(IO.read(cover(book)))
-          image.add_attribute('height', image_s.height.to_s)
-          image.add_attribute('width', image_s.width.to_s)
-          image.add_attribute('format', image_s.format)
+          image.add_attribute("height", image_s.height.to_s)
+          image.add_attribute("width", image_s.width.to_s)
+          image.add_attribute("format", image_s.format)
         end
       end
       doc
@@ -264,16 +263,16 @@ module Alexandria
     def xhtml_escape(str)
       escaped = str.dup
       # used to occasionally use CGI.escapeHTML
-      escaped.gsub!(/&/, '&amp;')
-      escaped.gsub!(/</, '&lt;')
-      escaped.gsub!(/>/, '&gt;')
-      escaped.gsub!(/\"/, '&quot;')
+      escaped.gsub!(/&/, "&amp;")
+      escaped.gsub!(/</, "&lt;")
+      escaped.gsub!(/>/, "&gt;")
+      escaped.gsub!(/"/, "&quot;")
       escaped
     end
 
     def to_xhtml(css)
-      generator = 'Alexandria ' + Alexandria::DISPLAY_VERSION
-      xhtml = +''
+      generator = "Alexandria " + Alexandria::DISPLAY_VERSION
+      xhtml = +""
       xhtml << <<~EOS
         <?xml version="1.0" encoding="UTF-8"?>
         <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
@@ -326,7 +325,7 @@ module Alexandria
               <li class="book_author">#{xhtml_escape(author)}</li>
             EOS
           end
-          xhtml << '</ul>'
+          xhtml << "</ul>"
         end
 
         unless book.edition.nil?
@@ -356,15 +355,15 @@ module Alexandria
     end
 
     def to_bibtex
-      generator = 'Alexandria ' + Alexandria::DISPLAY_VERSION
-      bibtex = +''
+      generator = "Alexandria " + Alexandria::DISPLAY_VERSION
+      bibtex = +""
       bibtex << "\%Generated on #{Date.today} by: #{generator}\n"
       bibtex << "\%\n"
       bibtex << "\n"
 
       auths = Hash.new(0)
       each do |book|
-        k = (book.authors[0] || 'Anonymous').split[0]
+        k = (book.authors[0] || "Anonymous").split[0]
         if auths.key?(k)
           auths[k] += 1
         else
@@ -382,27 +381,29 @@ module Alexandria
         bibtex << "\",\n"
         bibtex << "title = \"#{latex_escape(book.title)}\",\n"
         bibtex << "publisher = \"#{latex_escape(book.publisher)}\",\n"
-        bibtex << "OPTnote = \"#{latex_escape(book.notes)}\",\n" if book.notes && !book.notes.empty?
+        if book.notes && !book.notes.empty?
+          bibtex << "OPTnote = \"#{latex_escape(book.notes)}\",\n"
+        end
         # year is a required field in bibtex @BOOK
-        bibtex << 'year = ' + (book.publishing_year || '"n/a"').to_s + "\n"
+        bibtex << "year = " + (book.publishing_year || '"n/a"').to_s + "\n"
         bibtex << "}\n\n"
       end
       bibtex
     end
 
     def latex_escape(str)
-      return '' if str.nil?
+      return "" if str.nil?
 
       my_str = str.dup
       my_str.gsub!(/%/, '\\%')
       my_str.gsub!(/~/, '\\textasciitilde')
-      my_str.gsub!(/\&/, '\\\\&')
+      my_str.gsub!(/&/, '\\\\&')
       my_str.gsub!(/\#/, '\\\\#')
       my_str.gsub!(/\{/, '\\{')
       my_str.gsub!(/\}/, '\\}')
       my_str.gsub!(/_/, '\\_')
       my_str.gsub!(/\$/, "\\\$")
-      my_str.gsub!(/\"(.+)\"/, "``\1''")
+      my_str.gsub!(/"(.+)"/, "``\1''")
       my_str
     end
   end