alexandria-book-collection-manager 0.6.9 → 0.7.0

data/lib/alexandria/book_providers/z3950.rb

@@ -1,6 +1,6 @@
 # Copyright (C) 2005-2006 Laurent Sansonetti
 # Copyright (C) 2007 Laurent Sansonetti and Marco Costantini
-# Copyright (C) 2014 Matijs van Zuijlen
+# Copyright (C) 2014, 2016 Matijs van Zuijlen
 #
 # Alexandria is free software; you can redistribute it and/or
 # modify it under the terms of the GNU General Public License as
@@ -47,21 +47,19 @@ module Alexandria
 
       def search(criterion, type)
         prefs.read
-        criterion = criterion.convert(prefs['charset'], 'UTF-8')
+        criterion = criterion.encode(prefs['charset'])
 
         # We only decode MARC at the moment.
         # SUTRS needs to be decoded separately, because each Z39.50 server has a
         # different one.
-        unless marc?
-          raise NoResultsError
-        end
+        raise NoResultsError unless marc?
 
         isbn = type == SEARCH_BY_ISBN ? criterion : nil
         criterion = Library.canonicalise_isbn(criterion) if type == SEARCH_BY_ISBN
         conn_count = type == SEARCH_BY_ISBN ? 1 : 10 # results to retrieve
         resultset = search_records(criterion, type, conn_count)
         log.debug { "total #{resultset.length}" }
-        raise NoResultsError if resultset.length == 0
+        raise NoResultsError if resultset.empty?
         results = books_from_marc(resultset, isbn)
         type == SEARCH_BY_ISBN ? results.first : results
       end
@@ -80,10 +78,10 @@ module Alexandria
           log.error { ex.backtrace.join("> \n") }
           begin
             marc = MARC::Record.new(marc_txt)
-            rescue => ex2
-              log.error { ex2.message }
-              log.error { ex2.backtrace.join("> \n") }
-              raise ex2
+          rescue => ex2
+            log.error { ex2.message }
+            log.error { ex2.backtrace.join("> \n") }
+            raise ex2
           end
         end
 
@@ -100,14 +98,14 @@ module Alexandria
 
         return if marc.title.nil? # or marc.authors.empty?
 
-        isbn = isbn or marc.isbn
+        (isbn = isbn) || marc.isbn
         isbn = Library.canonicalise_ean(isbn)
 
         book = Book.new(marc.title, marc.authors,
                         isbn,
-                        (marc.publisher or ''),
+                        (marc.publisher || ''),
                         marc.respond_to?(:publish_year) ? marc.publish_year.to_i : nil,
-                        (marc.edition or ''))
+                        (marc.edition || ''))
         book
       end
 
@@ -116,7 +114,6 @@ module Alexandria
         resultset[0..9].each do |record|
           marc_txt = record.render(prefs['charset'], 'UTF-8') # (prefs['record_syntax'], 'USMARC')
           log.debug { marc_txt }
-          # marc_txt = marc_txt.convert("UTF-8", prefs['charset'])
           if $DEBUG
             File.open(',marc.txt', 'wb') do |f| # DEBUG
               f.write(marc_txt)
@@ -151,7 +148,7 @@ module Alexandria
 
       def search_records(criterion, type, conn_count)
         options = {}
-        unless prefs['username'].empty? or prefs['password'].empty?
+        unless prefs['username'].empty? || prefs['password'].empty?
           options['user'] = prefs['username']
           options['password'] = prefs['password']
         end
@@ -161,7 +158,7 @@ module Alexandria
         conn = ZOOM::Connection.new(options).connect(hostname, port)
         conn.database_name = prefs['database']
 
-        # HACK turn off piggybacking, just to see CMcG
+        # HACK: turn off piggybacking, just to see CMcG
         # #conn.piggyback = false
 
         conn.preferred_record_syntax = prefs['record_syntax']
@@ -175,7 +172,7 @@ module Alexandria
                end
         pqf = ''
         attr.each { |att| pqf += "@attr 1=#{att} " }
-        pqf += "\"" + criterion.upcase + "\""
+        pqf += '"' + criterion.upcase + '"'
         log.debug { "pqf is #{pqf}, syntax #{prefs['record_syntax']}" }
 
         begin
@@ -188,7 +185,7 @@ module Alexandria
           conn.search(pqf)
         rescue => ex
           if /1005/ =~ ex.message
-            if prefs.variable_named('piggyback') and prefs['piggyback']
+            if prefs.variable_named('piggyback') && prefs['piggyback']
               log.error { "Z39.50 search failed:: #{ex.message}" }
               log.info { 'Turning off piggybacking for this provider' }
               prefs.variable_named('piggyback').new_value = false
@@ -260,7 +257,7 @@ module Alexandria
         conn_count = type == SEARCH_BY_ISBN ? 1 : 10 # results to retrieve
         resultset = search_records(criterion, type, conn_count)
         log.debug { "total #{resultset.length}" }
-        raise NoResultsError if resultset.length == 0
+        raise NoResultsError if resultset.empty?
         results = books_from_sutrs(resultset)
         type == SEARCH_BY_ISBN ? results.first : results
       end
@@ -280,7 +277,6 @@ module Alexandria
           text = record.render(prefs['charset'], 'UTF-8')
           # File.open(',bl.marc', 'wb') {|f| f.write(text) }
           log.debug { text }
-          # text = text.convert("UTF-8", prefs['charset'])
 
           title = isbn = publisher = publish_year = edition = nil
           authors = []
@@ -310,7 +306,7 @@ module Alexandria
           }
 
           if title # and !authors.empty?
-            book = Book.new(title, authors, isbn, (publisher or nil), (publish_year or nil), (edition or nil))
+            book = Book.new(title, authors, isbn, (publisher || nil), (publish_year || nil), (edition || nil))
             results << [book]
           end
         end
@@ -344,7 +340,7 @@ module Alexandria
         criterion = canonicalise_isbn_with_dashes(criterion)
         resultset = search_records(criterion, type, 0)
         log.debug { "total #{resultset.length}" }
-        raise NoResultsError if resultset.length == 0
+        raise NoResultsError if resultset.empty?
         results = books_from_marc(resultset, isbn)
         type == SEARCH_BY_ISBN ? results.first : results
       end
@@ -371,7 +367,7 @@ module Alexandria
 
         if isbn[0..1] == '88'
           # Italian speaking area
-          if isbn > '8895000' and isbn <= '8899999996'
+          if isbn > '8895000' && (isbn <= '8899999996')
             return isbn[0..1] + '-' + isbn[2..6] + '-' + isbn[7..8] + '-' + isbn[9..9]
           elsif isbn > '88900000'
             return isbn[0..1] + '-' + isbn[2..7] + '-' + isbn[8..8] + '-' + isbn[9..9]

data/lib/alexandria/config.rb

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

data/lib/alexandria/execution_queue.rb

@@ -40,7 +40,9 @@ module Alexandria
     end
 
     def self.current
-      @@current_queue rescue nil
+      @@current_queue
+    rescue
+      nil
     end
 
     # For the requesting thread.

data/lib/alexandria/export_library.rb

@@ -1,6 +1,6 @@
 # Copyright (C) 2004-2006 Laurent Sansonetti
 # Copyright (C) 2007 Cathal Mc Ginley
-# Copyright (C) 2014 Matijs van Zuijlen
+# Copyright (C) 2014, 2016 Matijs van Zuijlen
 #
 # Alexandria is free software; you can redistribute it and/or
 # modify it under the terms of the GNU General Public License as
@@ -22,7 +22,7 @@
 # iPod Notes support added 20 January 2008 by Tim Malone
 # require 'cgi'
 
-begin        # image_size is optional
+begin # image_size is optional
   $IMAGE_SIZE_LOADED = true
   require 'image_size'
 rescue LoadError
@@ -43,13 +43,10 @@ module Alexandria
       sorted = library.sort_by do |book|
         book.send(@book_attribute)
       end
-      unless @ascending
-        sorted.reverse!
-      end
+      sorted.reverse! unless @ascending
       sorted
     rescue => ex
-      trace = ex.backtrace.join("\n> ")
-      log.warn { "Could not sort library by #{@book_attribute} #{ex.message} #{trace}" }
+      log.warn { "Could not sort library by #{@book_attribute.inspect}: #{ex.message}" }
       library
     end
 
@@ -174,7 +171,7 @@ module Alexandria
     def export_as_isbn_list(filename)
       File.open(filename, 'w') do |io|
         each do |book|
-          io.puts((book.isbn or ''))
+          io.puts((book.isbn || ''))
         end
       end
     end
@@ -221,7 +218,7 @@ module Alexandria
           end
           io.puts book.authors.join(', ')
           io.puts book.edition
-          io.puts((book.isbn or ''))
+          io.puts((book.isbn || ''))
           # we need to close the files so the iPod can be ejected/unmounted without us closing Alexandria
           io.close
         end
@@ -234,14 +231,14 @@ module Alexandria
       File.open(filename, 'w') do |io|
         io.puts 'Title' + ';' + 'Authors' + ';' + 'Publisher' + ';' + 'Edition' + ';' + 'ISBN' + ';' + 'Year Published' + ';' + 'Rating' + "(0 to #{UI::MainApp::MAX_RATING_STARS})" + ';' + 'Notes' + ';' + 'Want?' + ';' + 'Read?' + ';' + 'Own?' + ';' + 'Tags'
         each do |book|
-          io.puts book.title + ';' + book.authors.join(', ') + ';' + (book.publisher or '') + ';' + (book.edition or '') + ';' + (book.isbn or '') + ';' + (book.publishing_year.to_s or '') + ';' + (book.rating.to_s or '0') + ';' + (book.notes or '') + ';' + (book.want ? '1' : '0') + ';' + (book.redd ? '1' : '0') + ';' + (book.own ? '1' : '0') + ';' + (book.tags ? book.tags.join(', ') : '')
+          io.puts book.title + ';' + book.authors.join(', ') + ';' + (book.publisher || '') + ';' + (book.edition || '') + ';' + (book.isbn || '') + ';' + (book.publishing_year.to_s || '') + ';' + (book.rating.to_s || '0') + ';' + (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'.freeze
     def to_onix_document
       doc = REXML::Document.new
       doc << REXML::XMLDecl.new
@@ -263,7 +260,7 @@ module Alexandria
         prod.add_element('NotificationType').text = '03'  # confirmed
         prod.add_element('RecordSourceName').text =
           'Alexandria ' + Alexandria::DISPLAY_VERSION
-        prod.add_element('ISBN').text = (book.isbn or '')
+        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?
@@ -274,11 +271,11 @@ module Alexandria
             elem.add_element('PersonName').text = author
           end
         end
-        if book.notes and !book.notes.empty?
+        if book.notes && !book.notes.empty?
           elem = prod.add_element('OtherText')
           # reader description
           elem.add_element('TextTypeCode').text = '12'
-          elem.add_element('TextFormat').text = '00'  # ASCII
+          elem.add_element('TextFormat').text = '00' # ASCII
           elem.add_element('Text').text = book.notes
         end
         if File.exist?(cover(book))
@@ -314,7 +311,7 @@ module Alexandria
       # http://periapsis.org/tellico/doc/hacking.html
       doc = REXML::Document.new
       doc << REXML::XMLDecl.new
-      doc << REXML::DocType.new('tellico', "PUBLIC \"-//Robby Stephenson/DTD Tellico V7.0//EN\" \"http://periapsis.org/tellico/dtd/v7/tellico.dtd\"")
+      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/')
@@ -333,7 +330,7 @@ module Alexandria
         entry.add_attribute('id', new_index)
         # translate the binding
         entry.add_element('title').text = book.title
-        entry.add_element('isbn').text = (book.isbn or '')
+        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
@@ -348,7 +345,7 @@ module Alexandria
         unless book.rating == Book::DEFAULT_RATING
           entry.add_element('rating').text = book.rating
         end
-        if book.notes and !book.notes.empty?
+        if book.notes && !book.notes.empty?
           entry.add_element('comments').text = book.notes
         end
         if File.exist?(cover(book))
@@ -434,7 +431,7 @@ EOS
         end
 
         unless book.authors.empty?
-          xhtml << "<ul class=\"book_authors\">"
+          xhtml << '<ul class="book_authors">'
           book.authors.each do |author|
             xhtml << <<EOS
 <li class="book_author">#{xhtml_escape(author)}</li>
@@ -477,7 +474,7 @@ EOS
 
       auths = Hash.new(0)
       each do |book|
-        k = (book.authors[0] or 'Anonymous').split[0]
+        k = (book.authors[0] || 'Anonymous').split[0]
         if auths.key?(k)
           auths[k] += 1
         else
@@ -485,7 +482,7 @@ EOS
         end
         cite_key = k + auths[k].to_s
         bibtex << "@BOOK{#{cite_key},\n"
-        bibtex << "author = \""
+        bibtex << 'author = "'
         if book.authors != []
           bibtex << book.authors[0]
           book.authors[1..-1].each do |author|
@@ -495,11 +492,11 @@ EOS
         bibtex << "\",\n"
         bibtex << "title = \"#{latex_escape(book.title)}\",\n"
         bibtex << "publisher = \"#{latex_escape(book.publisher)}\",\n"
-        if book.notes and !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 or "\"n/a\"").to_s + "\n"
+        bibtex << 'year = ' + (book.publishing_year || '"n/a"').to_s + "\n"
         bibtex << "}\n\n"
       end
       bibtex

data/lib/alexandria/import_library.rb

@@ -100,7 +100,7 @@ module Alexandria
           collection = xml.root.elements[1]
           raise unless collection.name == 'collection'
           type = collection.attribute('type').value.to_i
-          raise unless type == 2 or type == 5
+          raise unless (type == 2) || (type == 5)
 
           content = []
           entries = collection.elements.to_a('entry')
@@ -111,19 +111,17 @@ module Alexandria
             keys = ['isbn', 'publisher', 'pub_year', 'binding']
 
             book_elements = [neaten(elements['title'].text)]
-            if !elements['authors'].nil?
-              book_elements += [elements['authors'].elements.to_a.map \
-                                { |x| neaten(x.text) }]
-            else
-              book_elements += [[]]
-            end
-            book_elements += keys.map {|key|
-              if elements[key]
-                neaten(elements[key].text)
-              end
+            book_elements += if !elements['authors'].nil?
+                               [elements['authors'].elements.to_a.map \
+                                                 { |x| neaten(x.text) }]
+                             else
+                               [[]]
+                             end
+            book_elements += keys.map { |key|
+              neaten(elements[key].text) if elements[key]
             }
             # isbn
-            if book_elements[2].nil? or book_elements[2].strip.empty?
+            if book_elements[2].nil? || book_elements[2].strip.empty?
               book_elements[2] = nil
             else
               begin
@@ -138,14 +136,12 @@ module Alexandria
             end
             book_elements[4] = book_elements[4].to_i unless book_elements[4].nil? # publishing_year
             puts book_elements.inspect
-            if elements['cover']
-              cover = neaten(elements['cover'].text)
-            else
-              cover = nil
-            end
+            cover = if elements['cover']
+                      neaten(elements['cover'].text)
+                    end
             puts cover
             book = Book.new(*book_elements)
-            if elements['rating'] and (0..UI::MainApp::MAX_RATING_STARS).map.member? elements['rating'].text.to_i
+            if elements['rating'] && (0..UI::MainApp::MAX_RATING_STARS).map.member?(elements['rating'].text.to_i)
               book.rating = elements['rating'].text.to_i
             end
             book.notes = neaten(elements['comments'].text) if elements['comments']

data/lib/alexandria/import_library_csv.rb

@@ -32,9 +32,7 @@ module Alexandria
 
     def index_of(header_name)
       @header.each_with_index do |h, i|
-        if h == header_name
-          return i
-        end
+        return i if h == header_name
       end
       -1
     end
@@ -57,7 +55,7 @@ module Alexandria
 
       # optional extras
       @notes = index_of('Private Notes')
-      @rating =  index_of('My Rating')
+      @rating = index_of('My Rating')
       @read_count = index_of('Read Count')
       @date_read = index_of('Date Read')
       @bookshelves = index_of('Bookshelves') # save names as tags
@@ -72,10 +70,8 @@ module Alexandria
       additional.split(',').each do |add|
         authors << normalize(add)
       end
-      isbn = row[@isbn] # TODO canonicalize_ean...
-      if isbn
-        isbn = Library.canonicalise_ean(isbn)
-      end
+      isbn = row[@isbn] # TODO: canonicalize_ean...
+      isbn = Library.canonicalise_ean(isbn) if isbn
       publisher = normalize(row[@publisher])
       year = row[@publishing_year].to_i
       edition = normalize(row[@edition])
@@ -85,17 +81,11 @@ module Alexandria
                                   publisher,
                                   year,
                                   edition)
-      if row[@notes]
-        book.notes = normalize(row[@notes])
-      end
-      if row[@rating]
-        book.rating = row[@rating].to_i
-      end
+      book.notes = normalize(row[@notes]) if row[@notes]
+      book.rating = row[@rating].to_i if row[@rating]
       if row[@read_count]
         count = row[@read_count].to_i
-        if count > 0
-          book.redd = true
-        end
+        book.redd = true if count > 0
       end
       if row[@date_read]
         begin
@@ -120,10 +110,8 @@ module Alexandria
       if row[@bookshelves]
         shelves = normalize(row[@bookshelves]).split
         shelves.each do |shelf|
-          tag = shelf.gsub(/-/, ' ')
-          unless book.tags.include? tag
-            book.tags << tag
-          end
+          tag = shelf.tr('-', ' ')
+          book.tags << tag unless book.tags.include? tag
         end
       end
       puts "Goodreads loading #{book.title}" if $DEBUG
@@ -179,19 +167,13 @@ module Alexandria
                                   publisher,
                                   year,
                                   edition)
-      if row[@notes]
-        book.notes = normalize(row[@notes])
-      end
+      book.notes = normalize(row[@notes]) if row[@notes]
 
-      if row[@rating]
-        book.rating = row[@rating].to_i
-      end
+      book.rating = row[@rating].to_i if row[@rating]
       if row[@tags]
         tags = normalize(row[@tags]).split(',')
         tags.each do |tag|
-          unless book.tags.include? tag
-            book.tags << tag
-          end
+          book.tags << tag unless book.tags.include? tag
         end
       end