alexandria-book-collection-manager 0.7.3 → 0.7.8

data/lib/alexandria/library_collection.rb

@@ -4,8 +4,8 @@
 #
 # See the file README.md for authorship and licensing information.
 
-require 'observer'
-require 'singleton'
+require "observer"
+require "singleton"
 
 module Alexandria
   class LibraryCollection
@@ -22,11 +22,12 @@ module Alexandria
 
       ruined = []
       deleted = []
-      all_regular_libraries.each { |library|
+      all_regular_libraries.each do |library|
         ruined += library.ruined_books
-        # make deleted books from each library accessible so we don't crash on smart libraries
+        # make deleted books from each library accessible so we don't crash on
+        # smart libraries
         deleted += library.deleted_books
-      }
+      end
       @ruined_books = ruined
       @deleted_books = deleted
     end

data/lib/alexandria/library_sort_order.rb

@@ -29,14 +29,16 @@ module Alexandria
     end
 
     class Unsorted < LibrarySortOrder
-      def initialize; end
+      def initialize
+        super(nil, nil)
+      end
 
       def sort(library)
         library
       end
 
       def to_s
-        'default order'
+        "default order"
       end
     end
   end

data/lib/alexandria/library_store.rb

@@ -9,10 +9,10 @@ module Alexandria
     include Logging
 
     FIX_BIGNUM_REGEX =
-      /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')
+    bindtextdomain(Alexandria::TEXTDOMAIN, charset: "UTF-8")
 
     def initialize(dir)
       @dir = dir
@@ -23,7 +23,7 @@ module Alexandria
       begin
         Dir.entries(library_dir).each do |file|
           # Skip hidden files.
-          next if file =~ /^\./
+          next if file.start_with?(".")
           # Skip non-directory files.
           next unless File.stat(File.join(library_dir, file)).directory?
 
@@ -34,7 +34,7 @@ module Alexandria
       end
       # Create the default library if there is no library yet.
 
-      a << load_library(_('My Library')) if a.empty?
+      a << load_library(_("My Library")) if a.empty?
 
       a
     end
@@ -45,7 +45,7 @@ module Alexandria
       library = Library.new(name, self)
       FileUtils.mkdir_p(library.path) unless File.exist?(library.path)
       Dir.chdir(library.path) do
-        Dir['*' + Library::EXT[:book]].each do |filename|
+        Dir["*" + Library::EXT[:book]].sort.each do |filename|
           test[1] = filename if (test[0]).zero?
 
           unless File.size? test[1]
@@ -64,32 +64,41 @@ 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
 
-            book.publishing_year = book.publishing_year.to_i unless book.publishing_year.nil?
+            unless book.publishing_year.nil?
+              book.publishing_year = book.publishing_year.to_i
+            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
-            raise "#{test[1]} version is not okay" unless book.version == Alexandria::DATA_VERSION
+            unless book.version == Alexandria::DATA_VERSION
+              raise format(_("%<file>s version is not okay"), file: test[1])
+            end
 
             # Or if publishing year has changed
-            raise "#{test[1]} pub year is not okay" unless book.publishing_year == old_pub_year
+            unless book.publishing_year == old_pub_year
+              raise format(_("%<file>s pub year is not okay"), file: test[1])
+            end
 
             # ruined_books << [book, book.isbn, library]
             book.library = library.name
 
             ## 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 { "#{library.name}; book #{book.title} has no ISBN, fixing cover image" }
-                FileUtils::Verbose.mv(library.old_cover(book), library.cover(book))
+            # due to #26909 cover files for books without ISBN are re-saved as
+            # "g#{ident}.cover"
+            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
@@ -111,21 +120,23 @@ module Alexandria
         # '_medium.jpg' have been deprecated for a single medium
         # cover file named '.cover'.
 
-        Dir['*' + '_medium.jpg'].each do |medium_cover|
+        Dir["*" + "_medium.jpg"].each do |medium_cover|
           FileUtils.mv(medium_cover,
                        medium_cover.sub(/_medium\.jpg$/,
                                         Library::EXT[:cover]))
         end
 
-        Dir['*' + Library::EXT[:cover]].each do |cover|
-          next if cover[0] == 'g'
+        Dir["*" + Library::EXT[:cover]].each do |cover|
+          next if cover[0] == "g"
 
           md = /(.+)\.cover/.match(cover)
           ean = Library.canonicalise_ean(md[1]) || md[1]
-          FileUtils.mv(cover, ean + Library::EXT[:cover]) unless cover == ean + Library::EXT[:cover]
+          unless cover == ean + Library::EXT[:cover]
+            FileUtils.mv(cover, ean + Library::EXT[:cover])
+          end
         end
 
-        FileUtils.rm_f(Dir['*_small.jpg'])
+        FileUtils.rm_f(Dir["*_small.jpg"])
       end
       library.ruined_books = ruined_books
 
@@ -137,7 +148,7 @@ module Alexandria
       begin
         # Deserialize smart libraries.
         Dir.chdir(smart_library_dir) do
-          Dir['*' + SmartLibrary::EXT].each do |filename|
+          Dir["*" + SmartLibrary::EXT].each do |filename|
             # Skip non-regular files.
             next unless File.stat(filename).file?
 
@@ -164,7 +175,7 @@ module Alexandria
     end
 
     def smart_library_dir
-      File.join(@dir, '.smart_libraries')
+      File.join(@dir, ".smart_libraries")
     end
 
     private
@@ -177,9 +188,9 @@ module Alexandria
 
       # The string is removed on load, but can't make it stick, maybe has to do with cache
 
-      if text =~ /!str:Amazon::Search::Response/
+      if /!str:Amazon::Search::Response/.match?(text)
         log.debug { "Removing Ruby/Amazon strings from #{name}" }
-        text.gsub!('!str:Amazon::Search::Response', '')
+        text.gsub!("!str:Amazon::Search::Response", "")
       end
 
       # Backward compatibility with versions <= 0.6.0, where the
@@ -187,14 +198,14 @@ 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])
 
-      unless book.isbn.class == String
+      unless book.isbn.instance_of? String
         # HACK
         md = /isbn: (.+)/.match(text)
         if md
@@ -204,7 +215,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
@@ -213,7 +224,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

@@ -18,20 +18,20 @@
 # write to the Free Software Foundation, Inc., 51 Franklin Street,
 # Fifth Floor, Boston, MA 02110-1301 USA.
 
-require 'logger'
-require 'forwardable'
+require "logger"
+require "forwardable"
 
 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)
@@ -82,9 +82,9 @@ module Alexandria
 
     def <<(msg)
       if msg.respond_to? :backtrace
-        msg.backtrace.each { |line|
+        msg.backtrace.each do |line|
           @logger << "  #{line} \n"
-        }
+        end
       else
         @logger << msg + "\n"
       end
@@ -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,17 +127,15 @@ 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
+    level = ENV["LOGLEVEL"] ? ENV["LOGLEVEL"].intern : nil
     if [:FATAL, :ERROR, :WARN, :INFO, :DEBUG].include? level
       logger.level = Logger.const_get(level)
     else
@@ -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

@@ -8,7 +8,8 @@ module Alexandria
   class Book
     attr_accessor :title, :authors, :isbn, :publisher, :publishing_year,
                   :edition, :notes, :loaned, :loaned_since,
-                  :loaned_to, :saved_ident, :redd, :redd_when, :own, :want, :tags, :version, :library
+                  :loaned_to, :saved_ident, :redd, :redd_when, :own, :want,
+                  :tags, :version, :library
 
     attr_reader :rating
 
@@ -24,7 +25,7 @@ module Alexandria
       @isbn = isbn
       @publisher = publisher
       @edition = edition # actually used for binding! (i.e. paperback or hardback)
-      @notes = ''
+      @notes = ""
       @saved_ident = ident
       @publishing_year = publishing_year
       @redd = false
@@ -63,8 +64,8 @@ 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

data/lib/alexandria/models/library.rb

@@ -4,12 +4,12 @@
 #
 # See the file README.md for authorship and licensing information.
 
-require 'yaml'
-require 'fileutils'
-require 'rexml/document'
-require 'tempfile'
-require 'etc'
-require 'alexandria/library_store'
+require "yaml"
+require "fileutils"
+require "rexml/document"
+require "tempfile"
+require "etc"
+require "alexandria/library_store"
 
 module Alexandria
   class Library < Array
@@ -17,12 +17,13 @@ module Alexandria
 
     attr_reader :name
     attr_accessor :ruined_books, :updating, :deleted_books
-    DEFAULT_DIR = File.join(ENV['HOME'], '.alexandria')
-    EXT = { book: '.yaml', cover: '.cover' }.freeze
+
+    DEFAULT_DIR = File.join(ENV["HOME"], ".alexandria")
+    EXT = { book: ".yaml", cover: ".cover" }.freeze
 
     include GetText
     extend GetText
-    bindtextdomain(Alexandria::TEXTDOMAIN, charset: 'UTF-8')
+    bindtextdomain(Alexandria::TEXTDOMAIN, charset: "UTF-8")
 
     BOOK_ADDED, BOOK_UPDATED, BOOK_REMOVED = (0..3).to_a
     include Observable
@@ -36,7 +37,7 @@ module Alexandria
     end
 
     def self.generate_new_name(existing_libraries,
-                               from_base = _('Untitled'))
+                               from_base = _("Untitled"))
       i = 1
       name = nil
       all_libraries = existing_libraries + @@deleted_libraries
@@ -53,7 +54,9 @@ module Alexandria
       dest = dest_library.path
       books.each do |book|
         FileUtils.mv(source_library.yaml(book), dest)
-        FileUtils.mv(source_library.cover(book), dest) if File.exist?(source_library.cover(book))
+        if File.exist?(source_library.cover(book))
+          FileUtils.mv(source_library.cover(book), dest)
+        end
 
         source_library.changed
         source_library.old_delete(book)
@@ -71,11 +74,11 @@ module Alexandria
     def self.extract_numbers(entry)
       return [] if entry.nil? || entry.empty?
 
-      normalized = entry.delete('- ').upcase
-      return [] unless normalized =~ /\A[\dX]*\Z/
+      normalized = entry.delete("- ").upcase
+      return [] unless /\A[\dX]*\Z/.match?(normalized)
 
-      normalized.split('').map do |char|
-        char == 'X' ? 10 : char.to_i
+      normalized.split("").map do |char|
+        char == "X" ? 10 : char.to_i
       end
     end
 
@@ -84,7 +87,7 @@ module Alexandria
         accumulator + numbers[i] * (i + 1)
       end % 11
 
-      sum == 10 ? 'X' : sum
+      sum == 10 ? "X" : sum
     end
 
     def self.valid_isbn?(isbn)
@@ -93,8 +96,8 @@ module Alexandria
     end
 
     def self.ean_checksum(numbers)
-      -(numbers.values_at(1, 3, 5, 7, 9, 11).reduce(:+) * 3 +
-        numbers.values_at(0, 2, 4, 6, 8, 10).reduce(:+)) % 10
+      -(numbers.values_at(1, 3, 5, 7, 9, 11).sum * 3 +
+        numbers.values_at(0, 2, 4, 6, 8, 10).sum) % 10
     end
 
     def self.valid_ean?(ean)
@@ -106,8 +109,8 @@ module Alexandria
     end
 
     def self.upc_checksum(numbers)
-      -(numbers.values_at(0, 2, 4, 6, 8, 10).reduce(:+) * 3 +
-        numbers.values_at(1, 3, 5, 7, 9).reduce(:+)) % 10
+      -(numbers.values_at(0, 2, 4, 6, 8, 10).sum * 3 +
+        numbers.values_at(1, 3, 5, 7, 9).sum) % 10
     end
 
     def self.valid_upc?(upc)
@@ -117,18 +120,18 @@ module Alexandria
     end
 
     AMERICAN_UPC_LOOKUP = {
-      '014794' => '08041', '018926' => '0445', '02778' => '0449',
-      '037145' => '0812', '042799' => '0785',  '043144' => '0688',
-      '044903' => '0312', '045863' => '0517', '046594' => '0064',
-      '047132' => '0152', '051487' => '08167', '051488' => '0140',
-      '060771' => '0002', '065373' => '0373', '070992' => '0523',
-      '070993' => '0446', '070999' => '0345', '071001' => '0380',
-      '071009' => '0440', '071125' => '088677', '071136' => '0451',
-      '071149' => '0451', '071152' => '0515', '071162' => '0451',
-      '071268' => '08217', '071831' => '0425', '071842' => '08439',
-      '072742' => '0441', '076714' => '0671', '076783' => '0553',
-      '076814' => '0449', '078021' => '0872', '079808' => '0394',
-      '090129' => '0679', '099455' => '0061', '099769' => '0451'
+      "014794" => "08041", "018926" => "0445", "02778" => "0449",
+      "037145" => "0812", "042799" => "0785",  "043144" => "0688",
+      "044903" => "0312", "045863" => "0517", "046594" => "0064",
+      "047132" => "0152", "051487" => "08167", "051488" => "0140",
+      "060771" => "0002", "065373" => "0373", "070992" => "0523",
+      "070993" => "0446", "070999" => "0345", "071001" => "0380",
+      "071009" => "0440", "071125" => "088677", "071136" => "0451",
+      "071149" => "0451", "071152" => "0515", "071162" => "0451",
+      "071268" => "08217", "071831" => "0425", "071842" => "08439",
+      "072742" => "0441", "076714" => "0671", "076783" => "0553",
+      "076814" => "0449", "078021" => "0872", "079808" => "0394",
+      "090129" => "0679", "099455" => "0061", "099769" => "0451"
     }.freeze
 
     def self.upc_convert(upc)
@@ -137,15 +140,15 @@ module Alexandria
     end
 
     def self.canonicalise_ean(code)
-      code = code.to_s.delete('- ')
+      code = code.to_s.delete("- ")
       if valid_ean?(code)
         code
       elsif valid_isbn?(code)
-        code = '978' + code[0..8]
+        code = "978" + code[0..8]
         code + String(ean_checksum(extract_numbers(code)))
       elsif valid_upc?(code)
         isbn10 = canonicalise_isbn
-        code = '978' + isbn10[0..8]
+        code = "978" + isbn10[0..8]
         code + String(ean_checksum(extract_numbers(code)))
       end
     end
@@ -181,12 +184,14 @@ module Alexandria
       book.saved_ident = book.ident if book.saved_ident.nil? || book.saved_ident.empty?
       if book.ident != book.saved_ident
         FileUtils.rm(yaml(book.saved_ident))
-        FileUtils.mv(cover(book.saved_ident), cover(book.ident)) if File.exist?(cover(book.saved_ident))
+        if File.exist?(cover(book.saved_ident))
+          FileUtils.mv(cover(book.saved_ident), cover(book.ident))
+        end
       end
       book.saved_ident = book.ident
 
-      filename = book.saved_ident.to_s + '.yaml'
-      File.open(filename, 'w') { |io| io.puts book.to_yaml }
+      filename = book.saved_ident.to_s + ".yaml"
+      File.open(filename, "w") { |io| io.puts book.to_yaml }
       filename
     end
 
@@ -199,7 +204,9 @@ module Alexandria
 
       if book.ident != book.saved_ident
         FileUtils.rm(yaml(book.saved_ident))
-        FileUtils.mv(cover(book.saved_ident), cover(book.ident)) if File.exist?(cover(book.saved_ident))
+        if File.exist?(cover(book.saved_ident))
+          FileUtils.mv(cover(book.saved_ident), cover(book.ident))
+        end
 
         # Notify before updating the saved identifier, so the views
         # can still use the old one to update their models.
@@ -212,14 +219,14 @@ module Alexandria
 
       temp_book = book.dup
       temp_book.library = nil
-      File.open(yaml(temp_book), 'w') { |io| io.puts temp_book.to_yaml }
+      File.open(yaml(temp_book), "w") { |io| io.puts temp_book.to_yaml }
 
       # Do not notify twice.
-      if changed?
-        notify_observers(self,
-                         already_there ? BOOK_UPDATED : BOOK_ADDED,
-                         book)
-      end
+      return unless changed?
+
+      notify_observers(self,
+                       already_there ? BOOK_UPDATED : BOOK_ADDED,
+                       book)
     end
 
     def transport
@@ -231,7 +238,7 @@ module Alexandria
       Dir.chdir(path) do
         # Fetch the cover picture.
         cover_file = cover(book)
-        File.open(cover_file, 'w') do |io|
+        File.open(cover_file, "w") do |io|
           uri = URI.parse(cover_uri)
           if uri.scheme.nil?
             # Regular filename.
@@ -277,7 +284,10 @@ module Alexandria
       else
         if @deleted_books.include?(book)
           doubles = @deleted_books.select { |b| b.equal?(book) }
-          raise ArgumentError, "Book #{book.isbn} was already deleted" unless doubles.empty?
+          unless doubles.empty?
+            raise ArgumentError, format(_("Book %<isbn>s was already deleted"),
+                                        isbn: book.isbn)
+          end
         end
         @deleted_books << book
         i = index(book)
@@ -340,7 +350,7 @@ module Alexandria
               when Integer
                 something
               else
-                raise "#{something} is a #{something.class}"
+                raise NotImplementedError
               end
       File.join(path, ident.to_s + EXT[:cover])
     end
@@ -354,7 +364,7 @@ module Alexandria
               when Integer
                 something
               else
-                raise "#{something} is #{something.class}"
+                raise NotImplementedError
               end
       File.join(basedir, ident.to_s + EXT[:book])
     end
@@ -372,8 +382,8 @@ module Alexandria
       length - n_rated
     end
 
-    def ==(object)
-      object.is_a?(self.class) && object.name == name
+    def ==(other)
+      other.is_a?(self.class) && other.name == name
     end
 
     def copy_covers(somewhere)
@@ -388,12 +398,12 @@ module Alexandria
     end
 
     def self.jpeg?(file)
-      IO.read(file, 10)[6..9] == 'JFIF'
+      IO.read(file, 10)[6..9] == "JFIF"
     end
 
     def final_cover(book)
       # TODO: what about PNG?
-      book.ident + (Library.jpeg?(cover(book)) ? '.jpg' : '.gif')
+      book.ident + (Library.jpeg?(cover(book)) ? ".jpg" : ".gif")
     end
 
     protected