alexandria-book-collection-manager 0.7.5 → 0.7.9

data/lib/alexandria/import_library.rb

@@ -11,6 +11,7 @@ module Alexandria
   class ImportFilter
     attr_reader :name, :patterns, :message
 
+    include Logging
     include GetText
     extend GetText
     bindtextdomain(Alexandria::TEXTDOMAIN, charset: "UTF-8")
@@ -34,7 +35,7 @@ module Alexandria
     end
 
     def invoke(library_name, filename)
-      puts "Selected: #{@message} -- #{library_name} -- #{filename}"
+      log.debug { "Selected: #{@message} -- #{library_name} -- #{filename}" }
       Library.send(@message, library_name, filename,
                    @on_iterate_cb, @on_error_cb)
     end
@@ -50,30 +51,24 @@ module Alexandria
 
   class Library
     def self.import_autodetect(*args)
-      puts args.inspect
+      log.debug { args.inspect }
       filename = args[1]
-      puts "Filename is #{filename} and ext is #{filename[-4..-1]}"
-      puts "Beginning import: #{args[0]}, #{args[1]}"
-      if filename[-4..-1] == ".txt"
+      log.debug { "Filename is #{filename} and ext is #{filename[-4..]}" }
+      log.debug { "Beginning import: #{args[0]}, #{args[1]}" }
+      if filename[-4..] == ".txt"
         import_as_isbn_list(*args)
-      elsif [".tc", ".bc"].include? filename[-3..-1]
-        begin
-          import_as_tellico_xml_archive(*args)
-        rescue StandardError => ex
-          puts ex.message
-          puts ex.backtrace.join("\n>> ")
-        end
-      elsif [".csv"].include? filename[-4..-1]
+      elsif [".tc", ".bc"].include? filename[-3..]
+        import_as_tellico_xml_archive(*args)
+      elsif [".csv"].include? filename[-4..]
         import_as_csv_file(*args)
       else
-        puts "Bailing on this import!"
-        raise "Not supported type"
+        raise _("Unsupported type")
       end
     end
 
     def self.import_as_tellico_xml_archive(name, filename,
                                            on_iterate_cb, _on_error_cb)
-      puts "Starting import_as_tellico_xml_archive... "
+      log.debug { "Starting import_as_tellico_xml_archive... " }
       return nil unless system("unzip -qqt \"#{filename}\"")
 
       tmpdir = File.join(Dir.tmpdir, "tellico_export")
@@ -102,34 +97,21 @@ module Alexandria
           keys = ["isbn", "publisher", "pub_year", "binding"]
 
           book_elements = [neaten(elements["title"].text)]
-          book_elements += if !elements["authors"].nil?
+          book_elements += if elements["authors"].nil?
+                             [[]]
+                           else
                              [elements["authors"].elements.to_a.map \
                                                { |x| neaten(x.text) }]
-                           else
-                             [[]]
                            end
           book_elements += keys.map do |key|
             neaten(elements[key].text) if elements[key]
           end
-          # isbn
-          if book_elements[2].nil? || book_elements[2].strip.empty?
-            book_elements[2] = nil
-          else
-            begin
-              book_elements[2] = book_elements[2].strip
-              book_elements[2] = Library.canonicalise_ean(book_elements[2])
-            rescue StandardError => ex
-              puts book_elements[2]
-              puts ex.message
-              puts ex.backtrace.join("\n> ")
-              raise ex
-            end
-          end
+          book_elements[2] = Library.canonicalise_ean(book_elements[2])
           # publishing_year
           book_elements[4] = book_elements[4].to_i unless book_elements[4].nil?
-          puts book_elements.inspect
+          log.debug { book_elements.inspect }
           cover = (neaten(elements["cover"].text) if elements["cover"])
-          puts cover
+          log.debug { cover }
           book = Book.new(*book_elements)
           if elements["rating"]
             rating = elements["rating"].text.to_i
@@ -140,19 +122,16 @@ module Alexandria
           on_iterate_cb&.call(n + 1, total)
         end
 
-        library = Library.load(name)
+        # TODO: Pass in library store as an argument
+        library = LibraryCollection.instance.library_store.load_library name
         content.each do |book, cover|
-          unless cover.nil?
-            library.save_cover(book,
-                               File.join(Dir.pwd, "images",
-                                         cover))
-          end
+          library.save_cover(book, File.join(Dir.pwd, "images", cover)) unless cover.nil?
           library << book
           library.save(book)
         end
         return [library, []]
       rescue StandardError => ex
-        puts ex.message
+        log.info { ex.message }
         return nil
       end
     end
@@ -160,7 +139,7 @@ module Alexandria
     def self.import_as_csv_file(name, filename, on_iterate_cb, _on_error_cb)
       require "alexandria/import_library_csv"
       books_and_covers = []
-      line_count = IO.readlines(filename).reduce(0) { |count, _line| count + 1 }
+      line_count = File.readlines(filename).reduce(0) { |count, _line| count + 1 }
 
       import_count = 0
       max_import = line_count - 1
@@ -177,7 +156,7 @@ module Alexandria
           if book.isbn
             # if we can search by ISBN, try to grab the cover
             begin
-              dl_book, dl_cover = Alexandria::BookProviders.isbn_search(book.isbn)
+              dl_book, dl_cover = BookProviders.isbn_search(book.isbn)
               if dl_book.authors.size > book.authors.size
                 # LibraryThing only supports a single author, so
                 # attempt to include more author information if it's
@@ -187,8 +166,7 @@ module Alexandria
               book.edition = dl_book.edition unless book.edition
               cover = dl_cover
             rescue StandardError
-              puts "failed to get cover for #{book.title} #{book.isbn}" if $DEBUG
-              # note failure
+              log.debug { "Failed to get cover for #{book.title} #{book.isbn}" }
             end
           end
 
@@ -203,7 +181,7 @@ module Alexandria
           # probably Goodreads' wonky ISBN fields ,,="043432432X",
           # this is a hack to fix up such files
           data = File.read(filename)
-          data.gsub!(/\,\=\"/, ',"')
+          data.gsub!(/,="/, ',"')
           csv_fixed = Tempfile.new("alexandria_import_csv_fixed_")
           csv_fixed.write(data)
           csv_fixed.close
@@ -216,12 +194,13 @@ module Alexandria
         end
       end
 
-      library = Library.load(name)
+      # TODO: Pass in library store as an argument
+      library = LibraryCollection.instance.library_store.load_library name
 
       books_and_covers.each do |book, cover_uri|
-        puts "Saving #{book.isbn} cover..." if $DEBUG
+        log.debug { "Saving #{book.isbn} cover" }
         library.save_cover(book, cover_uri) unless cover_uri.nil?
-        puts "Saving #{book.isbn}..." if $DEBUG
+        log.debug { "Saving #{book.isbn}" }
         library << book
         library.save(book)
       end
@@ -230,18 +209,12 @@ module Alexandria
 
     def self.import_as_isbn_list(name, filename, on_iterate_cb,
                                  on_error_cb)
-      puts "Starting import_as_isbn_list... "
-      isbn_list = IO.readlines(filename).map do |line|
-        puts "Trying line #{line}" if $DEBUG
-        # Let's preserve the failing isbns so we can report them later.
-        begin
-          [line.chomp, canonicalise_isbn(line.chomp)] unless line == "\n"
-        rescue StandardError => ex
-          puts ex.message
-          [line.chomp, nil]
-        end
+      log.debug { "Starting import_as_isbn_list... " }
+      isbn_list = File.readlines(filename).map do |line|
+        log.debug { "Trying line #{line}" }
+        [line.chomp, canonicalise_isbn(line.chomp)] unless line == "\n"
       end
-      puts "Isbn list: #{isbn_list.inspect}"
+      log.debug { "Isbn list: #{isbn_list.inspect}" }
       isbn_list.compact!
       return nil if isbn_list.empty?
 
@@ -253,27 +226,30 @@ module Alexandria
       isbn_list.each do |isbn|
         begin
           if isbn[1]
-            books << Alexandria::BookProviders.isbn_search(isbn[1])
+            books << BookProviders.isbn_search(isbn[1])
           else
             bad_isbns << isbn[0]
           end
-        rescue StandardError => ex
-          puts ex.message
+        rescue BookProviders::SearchEmptyError => ex
+          log.debug { ex.message }
           failed_lookup_isbns << isbn[1]
-          puts "NOTE : ignoring on_error_cb #{on_error_cb}"
+          log.debug { "NOTE : ignoring on_error_cb #{on_error_cb}" }
           # return nil unless
           #  (on_error_cb and on_error_cb.call(e.message))
         end
 
         on_iterate_cb&.call(current_iteration += 1, max_iterations)
       end
-      puts "Bad Isbn list: #{bad_isbns.inspect}" if bad_isbns
-      library = load(name)
-      puts "Going with these #{books.length} books: #{books.inspect}" if $DEBUG
+      log.debug { "Bad Isbn list: #{bad_isbns.inspect}" } if bad_isbns
+
+      # TODO: Pass in library store as an argument
+      library = LibraryCollection.instance.library_store.load_library name
+
+      log.debug { "Going with these #{books.length} books: #{books.inspect}" }
       books.each do |book, cover_uri|
-        puts "Saving #{book.isbn} cover..." if $DEBUG
+        log.debug { "Saving #{book.isbn} cover..." }
         library.save_cover(book, cover_uri) unless cover_uri.nil?
-        puts "Saving #{book.isbn}..." if $DEBUG
+        log.debug { "Saving #{book.isbn}..." }
         library << book
         library.save(book)
         on_iterate_cb&.call(current_iteration += 1, max_iterations)

data/lib/alexandria/import_library_csv.rb

@@ -72,8 +72,7 @@ module Alexandria
       additional.split(",").each do |add|
         authors << normalize(add)
       end
-      isbn = row[@isbn] # TODO: canonicalize_ean...
-      isbn = Library.canonicalise_ean(isbn) if isbn
+      isbn = Library.canonicalise_ean(row[@isbn])
       publisher = normalize(row[@publisher])
       year = row[@publishing_year].to_i
       edition = normalize(row[@edition])
@@ -95,12 +94,13 @@ module Alexandria
         book.redd = true
       end
       if row[@mainshelf]
-        if row[@mainshelf] == "read"
+        case row[@mainshelf]
+        when "read"
           book.redd = true
-        elsif row[@mainshelf] == "to-read"
+        when "to-read"
           book.redd = false
           book.tags = ["to read"]
-        elsif row[@mainshelf] == "currently-reading"
+        when "currently-reading"
           book.redd = false
           book.tags = ["currently reading"]
         end
@@ -112,7 +112,7 @@ module Alexandria
           book.tags << tag unless book.tags.include? tag
         end
       end
-      puts "Goodreads loading #{book.title}" if $DEBUG
+      log.debug { "Goodreads loading #{book.title}" }
       book
     end
   end
@@ -146,7 +146,7 @@ module Alexandria
       # sometimes "Publisher (YEAR), Edition: NUM, Binding, NUM pages"
       publisher_info = normalize(row[@publisher_info])
       publisher = publisher_info
-      publisher = Regexp.last_match[1] if publisher_info =~ /([^\(]+)\(/
+      publisher = Regexp.last_match[1] if publisher_info =~ /([^(]+)\(/
       edition = publisher_info # binding
       edition_info = publisher_info.split(",")
       edition = publisher_info.split(",")[-2] if edition_info.size >= 3
@@ -169,7 +169,7 @@ module Alexandria
         end
       end
 
-      puts "LibraryThing loading #{book.title}" if $DEBUG
+      log.debug { "LibraryThing loading #{book.title}" }
       book
     end
   end
@@ -183,20 +183,20 @@ module Alexandria
       is_librarything = false
       is_goodreads = false
       header.each do |head|
-        if head == "'PUBLICATION INFO'"
+        case head
+        when "'PUBLICATION INFO'"
           is_librarything = true
           break
-        elsif head == "Year Published"
+        when "Year Published"
           is_goodreads = true
           break
         end
       end
-      if is_librarything
-        return LibraryThingCSVImport.new(header)
-      elsif is_goodreads
-        return GoodreadsCSVImport.new(header)
-      end
-      raise "Not Recognized" unless is_librarything || is_goodreads
+
+      return LibraryThingCSVImport.new(header) if is_librarything
+      return GoodreadsCSVImport.new(header) if is_goodreads
+
+      raise _("Not Recognized") unless is_librarything || is_goodreads
     end
   end
 end

data/lib/alexandria/library_sort_order.rb

@@ -29,7 +29,9 @@ module Alexandria
     end
 
     class Unsorted < LibrarySortOrder
-      def initialize; end
+      def initialize
+        super(nil, nil)
+      end
 
       def sort(library)
         library

data/lib/alexandria/library_store.rb

@@ -9,7 +9,7 @@ module Alexandria
     include Logging
 
     FIX_BIGNUM_REGEX =
-      %r{loaned_since:\s*(\!ruby/object\:Bignum\s*)?(\d+)\n}.freeze
+      %r{loaned_since:\s*(!ruby/object:Bignum\s*)?(\d+)\n}.freeze
 
     include GetText
     bindtextdomain(Alexandria::TEXTDOMAIN, charset: "UTF-8")
@@ -23,7 +23,7 @@ module Alexandria
       begin
         Dir.entries(library_dir).each do |file|
           # Skip hidden files.
-          next if /^\./.match?(file)
+          next if file.start_with?(".")
           # Skip non-directory files.
           next unless File.stat(File.join(library_dir, file)).directory?
 
@@ -64,7 +64,7 @@ module Alexandria
           old_isbn = book.isbn
           old_pub_year = book.publishing_year
           begin
-            raise "Not a book: #{book.inspect}" unless book.is_a?(Book)
+            raise format(_("Not a book: %<book>s"), book.inspect) unless book.is_a?(Book)
 
             ean = Library.canonicalise_ean(book.isbn)
             book.isbn = ean if ean
@@ -74,16 +74,18 @@ module Alexandria
             end
 
             # Or if isbn has changed
-            raise "#{test[1]} isbn is not okay" unless book.isbn == old_isbn
+            unless book.isbn == old_isbn
+              raise format(_("%<file>s isbn is not okay"), file: test[1])
+            end
 
             # Re-save book if Alexandria::DATA_VERSION changes
             unless book.version == Alexandria::DATA_VERSION
-              raise "#{test[1]} version is not okay"
+              raise format(_("%<file>s version is not okay"), file: test[1])
             end
 
             # Or if publishing year has changed
             unless book.publishing_year == old_pub_year
-              raise "#{test[1]} pub year is not okay"
+              raise format(_("%<file>s pub year is not okay"), file: test[1])
             end
 
             # ruined_books << [book, book.isbn, library]
@@ -92,13 +94,11 @@ module Alexandria
             ## TODO copy cover image file, if necessary
             # due to #26909 cover files for books without ISBN are re-saved as
             # "g#{ident}.cover"
-            if book.isbn.nil? || book.isbn.empty?
-              if File.exist? library.old_cover(book)
-                log.debug do
-                  "#{library.name}; book #{book.title} has no ISBN, fixing cover image"
-                end
-                FileUtils::Verbose.mv(library.old_cover(book), library.cover(book))
+            if (book.isbn.nil? || book.isbn.empty?) && File.exist?(library.old_cover(book))
+              log.debug do
+                "#{library.name}; book #{book.title} has no ISBN, fixing cover image"
               end
+              FileUtils::Verbose.mv(library.old_cover(book), library.cover(book))
             end
 
             library << book
@@ -152,7 +152,7 @@ module Alexandria
             # Skip non-regular files.
             next unless File.stat(filename).file?
 
-            text = IO.read(filename)
+            text = File.read(filename)
             hash = YAML.safe_load(text, permitted_classes: [Symbol])
             smart_library = SmartLibrary.from_hash(hash, self)
             a << smart_library
@@ -181,7 +181,7 @@ module Alexandria
     private
 
     def regularize_book_from_yaml(name)
-      text = IO.read(name)
+      text = File.read(name)
 
       # Code to remove the mystery string in books imported from Amazon
       # (In the past, still?) To allow ruby-amazon to be removed.
@@ -198,14 +198,13 @@ module Alexandria
       if (md = FIX_BIGNUM_REGEX.match(text))
         new_yaml = Time.at(md[2].to_i).to_yaml
         # Remove the "---" prefix.
-        new_yaml.sub!(/^\s*\-+\s*/, "")
+        new_yaml.sub!(/^\s*-+\s*/, "")
         text.sub!(md[0], "loaned_since: #{new_yaml}\n")
       end
 
-      # TODO: Ensure book loading passes through Book#initialize
-      book = YAML.safe_load(text, permitted_classes: [Book, Time])
+      book = Book.from_yaml(text)
 
-      unless book.isbn.class == String
+      unless book.isbn.instance_of? String
         # HACK
         md = /isbn: (.+)/.match(text)
         if md
@@ -215,7 +214,7 @@ module Alexandria
       end
 
       # another HACK of the same type as above
-      unless book.saved_ident.class == String
+      unless book.saved_ident.instance_of? String
 
         md2 = /saved_ident: (.+)/.match(text)
         if md2
@@ -224,7 +223,7 @@ module Alexandria
           book.saved_ident = string_saved_ident
         end
       end
-      if (book.isbn.class == String) && book.isbn.empty?
+      if (book.isbn.instance_of? String) && book.isbn.empty?
         book.isbn = nil # save trouble later
       end
       book

data/lib/alexandria/logging.rb

@@ -25,13 +25,13 @@ module Alexandria
   # A Logger subclass which accepts a source for log messages
   # in order to improve legibility of the logs.
   # The source should usually be +self+, whether that be a Class, Module
-  # or Object. A LoggerWrapper can be used to simplify this procedure.
+  # or Object. A LogWrapper can be used to simplify this procedure.
   class Logger < ::Logger
     def add(severity, message = nil, source = nil, progname = nil, &block)
       return super(severity, message, progname, &block) if source.nil?
 
       category = self.class.category(source)
-      return super(severity, progname, category) unless block_given?
+      return super(severity, progname, category) unless block
 
       category = "#{category} #{progname}" if progname
       super(severity, message, category, &block)
@@ -118,7 +118,7 @@ module Alexandria
   module Logging
     module ClassMethods
       def log
-        @log_wrapper ||= LogWrapper.new(Alexandria.log, self)
+        @log ||= LogWrapper.new(Alexandria.log, self)
       end
     end
 
@@ -127,15 +127,13 @@ module Alexandria
     end
 
     def log
-      @log_wrapper ||= LogWrapper.new(Alexandria.log, self)
+      @log ||= LogWrapper.new(Alexandria.log, self)
     end
   end
 
-  private
-
   # Creates the Logger for Alexandria
   def self.create_logger
-    logger = Alexandria::Logger.new(STDERR)
+    logger = Alexandria::Logger.new($stderr)
 
     level = ENV["LOGLEVEL"] ? ENV["LOGLEVEL"].intern : nil
     if [:FATAL, :ERROR, :WARN, :INFO, :DEBUG].include? level
@@ -150,8 +148,6 @@ module Alexandria
 
   @@logger = create_logger
 
-  public
-
   # Returns the Logger for Alexandria
   def self.log
     @@logger

data/lib/alexandria/models/book.rb

@@ -64,12 +64,25 @@ module Alexandria
       own || false
     end
 
-    def ==(obj)
-      obj.is_a?(self.class) && (ident == obj.ident)
+    def ==(other)
+      other.is_a?(self.class) && (ident == other.ident)
     end
 
     def inspect
       "#<Alexandria::Book title: #{@title}>"
     end
+
+    def self.from_yaml(text)
+      node = YAML.parse_stream text
+      doc = node.children.first
+      mapping = doc.children.first
+      mapping.children.each_slice(2) do |_k, v|
+        v.tag = nil if v.tag == "!ruby/array:Alexandria:Library"
+      end
+      yaml = node.to_yaml
+
+      # TODO: Ensure book loading passes through Book#initialize
+      YAML.safe_load(yaml, permitted_classes: [Book, Time])
+    end
   end
 end