alexandria-book-collection-manager 0.7.1 → 0.7.6

data/lib/alexandria/ui/{dialogs/new_book_dialog.rb → new_book_dialog.rb}

@@ -1,60 +1,29 @@
-# Copyright (C) 2004-2006 Laurent Sansonetti
-# Copyright (C) 2011, 2015, 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
-# published by the Free Software Foundation; either version 2 of the
-# License, or (at your option) any later version.
-#
-# Alexandria is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
-# General Public License for more details.
+# frozen_string_literal: true
+
+# This file is part of Alexandria.
 #
-# You should have received a copy of the GNU General Public
-# License along with Alexandria; see the file COPYING.  If not,
-# write to the Free Software Foundation, Inc., 51 Franklin Street,
-# Fifth Floor, Boston, MA 02110-1301 USA.
+# See the file README.md for authorship and licensing information.
 
-require 'gdk_pixbuf2'
+require "gdk_pixbuf2"
+require "alexandria/ui/builder_base"
+require "alexandria/ui/error_dialog"
+require "alexandria/ui/keep_bad_isbn_dialog"
 
 module Alexandria
   class DuplicateBookException < NameError
   end
 
   module UI
-    class KeepBadISBNDialog < AlertDialog
-      include GetText
-      GetText.bindtextdomain(Alexandria::TEXTDOMAIN, charset: 'UTF-8')
-
-      def initialize(parent, book)
-        super(parent, _("Invalid ISBN '%s'") % book.isbn,
-              Gtk::Stock::DIALOG_QUESTION,
-              [[Gtk::Stock::CANCEL, :cancel],
-               [_('_Keep'), :ok]],
-              _("The book titled '%s' has an invalid ISBN, but still " \
-                'exists in the providers libraries.  Do you want to ' \
-                'keep the book but change the ISBN or cancel the addition?') % book.title)
-        self.default_response = Gtk::ResponseType::OK
-        show_all && (@response = run)
-        destroy
-      end
-
-      def keep?
-        @response == :ok
-      end
-    end
-
     class NewBookDialog < BuilderBase
       include Logging
       include GetText
       extend GetText
-      GetText.bindtextdomain(Alexandria::TEXTDOMAIN, charset: 'UTF-8')
+      GetText.bindtextdomain(Alexandria::TEXTDOMAIN, charset: "UTF-8")
       @@last_criterion_was_not_isbn = false
 
       def initialize(parent, selected_library = nil, &block)
-        super('new_book_dialog__builder.glade', widget_names)
-        log.info { 'New Book Dialog' }
+        super("new_book_dialog__builder.glade", widget_names)
+        log.info { "New Book Dialog" }
         @new_book_dialog.transient_for = @parent = parent
         @block = block
         @destroyed = false
@@ -63,34 +32,33 @@ module Alexandria
         @progressbar.hide
       end
 
+      def show
+        @new_book_dialog.show
+      end
+
       def widget_names
-        [:liststore1, :liststore2, :new_book_dialog, :dialog_vbox1,
-         :dialog_action_area1, :button_help, :button_cancel,
-         :button_add, :table1, :keep_open, :combo_libraries,
-         :cellrenderertext1, :eventbox_entry_isbn, :entry_isbn,
-         :label3, :hbox2, :eventbox_combo_search, :combo_search,
-         :cellrenderertext2, :eventbox_entry_search, :entry_search,
-         :button_find, :scrolledwindow, :treeview_results,
-         :title_radiobutton, :isbn_radiobutton, :progressbar]
+        [:new_book_dialog, :button_add, :button_cancel, :button_find,
+         :button_help, :combo_libraries, :combo_search, :entry_isbn,
+         :entry_search, :eventbox_combo_search, :eventbox_entry_isbn,
+         :eventbox_entry_search, :isbn_radiobutton, :keep_open, :progressbar,
+         :scrolledwindow, :title_radiobutton, :treeview_results]
       end
 
       def setup_dialog_gui
-        libraries = Libraries.instance.all_regular_libraries
-        if @selected_library.is_a?(SmartLibrary)
-          @selected_library = libraries.first
-        end
+        libraries = LibraryCollection.instance.all_regular_libraries
+        @selected_library = libraries.first if @selected_library.is_a?(SmartLibrary)
         @combo_libraries.populate_with_libraries(libraries,
                                                  @selected_library)
 
         @treeview_results.model = Gtk::ListStore.new(String, String,
                                                      GdkPixbuf::Pixbuf)
-        @treeview_results.selection.mode = Gtk::SELECTION_MULTIPLE
-        @treeview_results.selection.signal_connect('changed') do
+        @treeview_results.selection.mode = :multiple
+        @treeview_results.selection.signal_connect("changed") do
           @button_add.sensitive = true
         end
 
         renderer = Gtk::CellRendererPixbuf.new
-        col = Gtk::TreeViewColumn.new('', renderer)
+        col = Gtk::TreeViewColumn.new("", renderer)
         col.set_cell_data_func(renderer) do |_column, cell, _model, iter|
           pixbuf = iter[2]
           max_height = 25
@@ -104,7 +72,7 @@ module Alexandria
         end
         @treeview_results.append_column(col)
 
-        col = Gtk::TreeViewColumn.new('', Gtk::CellRendererText.new,
+        col = Gtk::TreeViewColumn.new("", Gtk::CellRendererText.new,
                                       text: 0)
         @treeview_results.append_column(col)
 
@@ -123,14 +91,14 @@ module Alexandria
         @find_thread = nil
         @image_thread = nil
 
-        @new_book_dialog.signal_connect('destroy') {
+        @new_book_dialog.signal_connect("destroy") do
           @new_book_dialog.destroy
           @destroyed = true
-        }
+        end
       end
 
       def on_criterion_toggled(item)
-        log.debug { 'on_criterion_toggled' }
+        log.debug { "on_criterion_toggled" }
         return unless item.active?
 
         # There used to be a strange effect here (pre SVN r1022).
@@ -175,19 +143,19 @@ module Alexandria
 
       def on_changed(entry)
         ok = !entry.text.strip.empty?
-        decode_cuecat?(@entry_isbn) if entry == @entry_isbn
+        decode_cuecat(@entry_isbn) if entry == @entry_isbn
         (entry == @entry_isbn ? @button_add : @button_find).sensitive = ok
       end
 
       def image_error_dialog(error)
         ErrorDialog.new(
           @parent,
-          _('A problem occurred while downloading images'),
+          _("A problem occurred while downloading images"),
           error)
       end
 
       def get_images_async
-        log.info { 'get_images_async' }
+        log.info { "get_images_async" }
         @images = {}
         @image_error = nil
         @image_thread = Thread.new do
@@ -197,7 +165,7 @@ module Alexandria
               uri = result[1]
               if uri
                 if URI.parse(uri).scheme.nil?
-                  File.open(uri, 'r') do |io|
+                  File.open(uri, "r") do |io|
                     @images[i] = io.read
                   end
                 else
@@ -205,33 +173,32 @@ module Alexandria
                 end
               end
             end
-          rescue => e
-            @image_error = e.message
+          rescue StandardError => ex
+            @image_error = ex.message
           end
         end
 
         GLib::Timeout.add(100) do
           if @image_error
-            image_error_dialog(@image_error)
+            image_error_dialog(@image_error).display
           else
             @images.each_pair do |key, value|
-              begin
-                loader = GdkPixbuf::PixbufLoader.new
-                loader.last_write(value)
-                pixbuf = loader.pixbuf
-
-                if pixbuf.width > 1
-                  iter = @treeview_results.model.get_iter(key.to_s)
-                  unless @treeview_results.model.iter_is_valid?(iter)
-                    raise 'Iter is invalid! %s' % iter
-                  end
-                  iter[2] = pixbuf # I bet you this is it!
+              loader = GdkPixbuf::PixbufLoader.new
+              loader.last_write(value)
+              pixbuf = loader.pixbuf
+
+              if pixbuf.width > 1
+                iter = @treeview_results.model.get_iter(key.to_s)
+                unless @treeview_results.model.iter_is_valid?(iter)
+                  raise format(_("Iter is invalid! %s"), iter)
                 end
 
-                @images.delete(key)
-              rescue => e
-                image_error_dialog(e.message)
+                iter[2] = pixbuf # I bet you this is it!
               end
+
+              @images.delete(key)
+            rescue StandardError => ex
+              image_error_dialog(ex.message).display
             end
           end
 
@@ -247,7 +214,7 @@ module Alexandria
       end
 
       def on_find
-        log.info { 'on_find' }
+        log.info { "on_find" }
         mode = case @combo_search.active
                when 0
                  BookProviders::SEARCH_BY_TITLE
@@ -257,28 +224,19 @@ module Alexandria
                  BookProviders::SEARCH_BY_KEYWORD
                end
 
-        # @progressbar.show
-        # progress_pulsing = GLib::Timeout.add(100) do
-        #  if @destroyed
-        #    false
-        #  else
-        #    @progressbar.pulse
-        #    true
-        #  end
-        # end
-
         criterion = @entry_search.text.strip
         @treeview_results.model.clear
-        log.info {
-          'TreeStore Model: %s columns; ref_counts: %s' %
-            [@treeview_results.model.n_columns, @treeview_results.model.ref_count]
-        }
+        log.info do
+          format("TreeStore Model: %s columns; ref_counts: %s",
+                 @treeview_results.model.n_columns,
+                 @treeview_results.model.ref_count)
+        end
 
         @find_error = nil
         @results = nil
 
-        @find_thread.kill if @find_thread
-        @image_thread.kill if @image_thread
+        @find_thread&.kill
+        @image_thread&.kill
 
         notify_start_add_by_isbn
         GLib::Idle.add do
@@ -289,8 +247,8 @@ module Alexandria
               @results = Alexandria::BookProviders.search(criterion, mode)
 
               log.info { "got #{@results.length} results" }
-            rescue => e
-              @find_error = e.message
+            rescue StandardError => ex
+              @find_error = ex.message
             ensure
               Alexandria::BookProviders.instance.delete_observer(self)
               # notify_end_add_by_isbn
@@ -305,28 +263,13 @@ module Alexandria
 
           # Err... continue == false if @find_error
           continue = if @find_error
-                       ErrorDialog.new(@parent,
-                                       _('Unable to find matches for your search'),
-                                       @find_error)
+                       ErrorDialog.new(@new_book_dialog,
+                                       _("Unable to find matches for your search"),
+                                       @find_error).display
                        false
                      elsif @results
                        log.info { "Got results: #{@results[0]}..." }
-                       @results.each do |book, _cover|
-                         s = _('%s, by %s') % [book.title,
-                                               book.authors.join(', ')]
-                         similar_books = @results.find { |book2, _cover2|
-                           (book.title == book2.title) &&
-                             (book.authors == book2.authors)
-                         }
-                         if similar_books.length > 1
-                           s += " (#{book.edition}, #{book.publisher})"
-                         end
-                         log.info { 'Copying %s into tree view.' % book.title }
-                         iter = @treeview_results.model.append
-                         iter[0] = s
-                         iter[1] = book.ident
-                         iter[2] = Icons::BOOK
-                       end
+                       copy_results_to_treeview_model(@results, @treeview_results.model)
 
                        # Kick off the image download thread.
                        if @find_thread.alive?
@@ -345,48 +288,55 @@ module Alexandria
           # continue == false if @find_error OR if results are returned
           # timeout ends if continue is false!
 
-          unless continue
-            unless @find_thread.alive? # This happens after find_thread is done
-              unless @destroyed
-                # GLib::Source.remove(progress_pulsing)
-                # @progressbar.hide
-                notify_end_add_by_isbn
-                @button_add.sensitive = false
-              end
-            end
+          # @find_thread.alive? happens after find_thread is done
+          unless continue || @find_thread.alive? || @destroyed
+            notify_end_add_by_isbn
+            @button_add.sensitive = false
           end
 
           continue # timeout loop condition
         end
       end
 
-      def decode_cuecat?(entry) # srsly?
-        if entry.text =~ /^\..*?\..*?\.(.*?)\.$/
-          tmp = Regexp.last_match[1].tr('a-zA-Z0-9+-', ' -_')
-          tmp = ((32 + tmp.length * 3 / 4).to_i.chr << tmp).unpack('u')[0]
-          tmp.chomp!("\000")
-          entry.text = tmp.gsub!(/./) { |c| (c[0] ^ 67).chr }
-          if entry.text.count('^ -~') > 0
-            entry.text = 'Bad scan result'
+      def copy_results_to_treeview_model(results, model)
+        results.each do |book, _cover_url|
+          s = format(_("%s, by %s"), book.title, book.authors.join(", "))
+          similar_books = results.find do |book2, _cover2|
+            (book.title == book2.title) &&
+              (book.authors == book2.authors)
           end
+          s += " (#{book.edition}, #{book.publisher})" if similar_books.length > 1
+          log.info { format(_("Copying %s into tree view."), book.title) }
+          iter = model.append
+          iter[0] = s
+          iter[1] = book.ident
+          iter[2] = Icons::BOOK
         end
       end
 
+      def decode_cuecat(entry)
+        return unless entry.text =~ /^\..*?\..*?\.(.*?)\.$/
+
+        tmp = Regexp.last_match[1].tr("a-zA-Z0-9+-", " -_")
+        tmp = ((32 + tmp.length * 3 / 4).to_i.chr << tmp).unpack1("u")
+        tmp.chomp!("\000")
+        entry.text = tmp.gsub!(/./) { |c| (c[0] ^ 67).chr }
+        entry.text = "Bad scan result" if entry.text.count("^ -~") > 0
+      end
+
       def on_results_button_press_event(_widget, event)
         # double left click
-        if (event.event_type == :'2button_press') && (event.button == 1)
-          on_add
-        end
+        on_add if (event.event_type == :'2button_press') && (event.button == 1)
       end
 
       def add_single_book_by_isbn(library, is_new)
         # Perform the ISBN search via the providers.
         isbn = begin
                  Library.canonicalise_isbn(@entry_isbn.text)
-               rescue
+               rescue StandardError
                  raise _("Couldn't validate the EAN/ISBN you " \
-                         'provided.  Make sure it is written ' \
-                         'correctly, and try again.')
+                         "provided.  Make sure it is written " \
+                         "correctly, and try again.")
                end
         assert_not_exist(library, @entry_isbn.text)
         @button_add.sensitive = false
@@ -398,24 +348,20 @@ module Alexandria
               # MAJOR HACK, add this again...
               Alexandria::BookProviders.instance.add_observer(self)
               book, cover_url = Alexandria::BookProviders.isbn_search(isbn)
-              # prov = FakeBookProviders.new()
-              # prov.add_observer(self)
-              # book, cover_url = prov.isbn_search(isbn)
 
               notify_end_add_by_isbn
 
               if book
-
-                puts "adding book #{book} to library"
+                log.debug { "adding book #{book} to library" }
                 add_book_to_library(library, book, cover_url)
-                @entry_isbn.text = ''
+                @entry_isbn.text = ""
 
                 post_addition([book], library, is_new)
               else
                 post_addition([], library, is_new)
               end
-            rescue Alexandria::BookProviders::NoResultsError => e
-              @find_error = e.message
+            rescue Alexandria::BookProviders::NoResultsError => ex
+              @find_error = ex.message
               @button_add.sensitive = true
               notify_end_add_by_isbn
             ensure
@@ -430,22 +376,28 @@ module Alexandria
 
       def add_selected_books(library, _is_new)
         books_to_add = []
-        @treeview_results.selection.selected_each do |_model, _path, iter|
+        @treeview_results.selection.each do |_model, _path, iter|
           @results.each do |book, cover|
             next unless book.ident == iter[1]
-            begin
-              next unless assert_not_exist(library, book.isbn)
-            rescue Alexandria::Library::NoISBNError
-              puts 'noisbn'
+
+            isbn = book.isbn
+            if isbn.nil? || isbn.empty?
+              log.debug { "noisbn" }
               book.isbn = book.saved_ident = nil
               books_to_add << [book, cover]
               next
-            rescue Alexandria::Library::InvalidISBNError
-              puts "invalidisbn #{book.isbn}"
-              next unless
-              KeepBadISBNDialog.new(@parent, book).keep?
+            end
+
+            isbn = Library.canonicalise_ean(isbn)
+            unless isbn
+              log.debug { "invalidisbn #{book.isbn}" }
+              next unless KeepBadISBNDialog.new(@new_book_dialog, book).keep?
+
               book.isbn = book.saved_ident = nil
             end
+
+            book.isbn = isbn
+            assert_not_exist(library, isbn)
             books_to_add << [book, cover]
           end
         end
@@ -456,15 +408,13 @@ module Alexandria
       end
 
       def add_book_to_library(library, book, cover_uri)
-        unless cover_uri.nil?
-          library.save_cover(book, cover_uri)
-        end
+        library.save_cover(book, cover_uri) unless cover_uri.nil?
         library << book
         library.save(book)
       end
 
       def post_addition(books, library, is_new_library)
-        puts "post_addition #{books.size}"
+        log.debug { "post_addition #{books.size}" }
         return if books.empty?
 
         # books, a 1d array of Alexandria::Book
@@ -478,7 +428,7 @@ module Alexandria
             @entry_search.grab_focus
           else
             @button_add.sensitive = true #
-            @entry_isbn.text = '' # blank ISBN field
+            @entry_isbn.text = "" # blank ISBN field
             @entry_isbn.grab_focus
           end
 
@@ -491,11 +441,12 @@ module Alexandria
 
       def on_add
         return unless @button_add.sensitive?
-        @find_thread.kill if @find_thread
-        @image_thread.kill if @image_thread
+
+        @find_thread&.kill
+        @image_thread&.kill
 
         begin
-          libraries = Libraries.instance.all_libraries
+          libraries = LibraryCollection.instance.all_libraries
           library, is_new_library =
             @combo_libraries.selection_from_libraries(libraries)
 
@@ -510,16 +461,16 @@ module Alexandria
 
           # Do not destroy if there is no addition.
           #          return unless book_was_added
-
-        rescue => e
-          ErrorDialog.new(@parent, _("Couldn't add the book"), e.message)
+        rescue StandardError => ex
+          # FIXME: Message containing <> should be displayed correctly.
+          ErrorDialog.new(@new_book_dialog, _("Couldn't add the book"), ex.message).display
         end
         # books_to_add
       end
 
       def on_cancel
-        @find_thread.kill if @find_thread
-        @image_thread.kill if @image_thread
+        @find_thread&.kill
+        @image_thread&.kill
         @new_book_dialog.destroy
       end
 
@@ -538,10 +489,10 @@ module Alexandria
 
       def notify_end_add_by_isbn
         MainApp.instance.appbar.children.first.visible = false
-        if @progress_pulsing
-          GLib::Source.remove(@progress_pulsing)
-          @progress_pulsing = nil
-        end
+        return unless @progress_pulsing
+
+        GLib::Source.remove(@progress_pulsing)
+        @progress_pulsing = nil
       end
 
       def update(status, provider)
@@ -557,25 +508,26 @@ module Alexandria
       end
 
       def on_focus
-        if @isbn_radiobutton.active? && @entry_isbn.text.strip.empty?
-          clipboard = Gtk::Clipboard.get(Gdk::Selection::CLIPBOARD)
-          if (text = clipboard.wait_for_text)
-            if Library.valid_isbn?(text) || Library.valid_ean?(text) ||
-                Library.valid_upc?(text)
-              GLib::Idle.add do
-                @entry_isbn.text = text
-                @entry_isbn.grab_focus
-                @entry_isbn.select_region(0, -1) # select all...
-                # @button_add.grab_focus
-                false
-              end
-              log.debug { "Setting ISBN field to #{text}" }
-              puts text # required, strangely, to prevent GUI strangeness
-              # above last checked with ruby-gnome2 0.17.1 2009-12-09
-              # if this puts is commented out, the cursor disappears
-              # from the @entry_isbn box... weird, ne? - CathalMagus
-            end
+        return unless @isbn_radiobutton.active? && @entry_isbn.text.strip.empty?
+
+        clipboard = Gtk::Clipboard.get(Gdk::Selection::CLIPBOARD)
+        text = clipboard.wait_for_text or return
+
+        if Library.valid_isbn?(text) || Library.valid_ean?(text) ||
+            Library.valid_upc?(text)
+          GLib::Idle.add do
+            @entry_isbn.text = text
+            @entry_isbn.grab_focus
+            @entry_isbn.select_region(0, -1) # select all...
+            # @button_add.grab_focus
+            false
           end
+          log.debug { "Setting ISBN field to #{text}" }
+          # FIXME: Get rid of this puts!
+          puts text # required, strangely, to prevent GUI strangeness
+          # above last checked with ruby-gnome2 0.17.1 2009-12-09
+          # if this puts is commented out, the cursor disappears
+          # from the @entry_isbn box... weird, ne? - CathalMagus
         end
       end
 
@@ -583,19 +535,18 @@ module Alexandria
         if (event.event_type == :button_press) &&
             (event.button == 1)
 
-          radio, target_widget, box2, box3 = case widget
-                                             when @eventbox_entry_search
-                                               [@title_radiobutton, @entry_search,
-                                                @eventbox_combo_search, @eventbox_entry_isbn]
-
-                                             when @eventbox_combo_search
-                                               [@title_radiobutton, @combo_search,
-                                                @eventbox_entry_search, @eventbox_entry_isbn]
-
-                                             when @eventbox_entry_isbn
-                                               [@isbn_radiobutton, @entry_isbn,
-                                                @eventbox_entry_search, @eventbox_combo_search]
-                                             end
+          radio, target_widget, box2, box3 =
+            case widget
+            when @eventbox_entry_search
+              [@title_radiobutton, @entry_search,
+               @eventbox_combo_search, @eventbox_entry_isbn]
+            when @eventbox_combo_search
+              [@title_radiobutton, @combo_search,
+               @eventbox_entry_search, @eventbox_entry_isbn]
+            when @eventbox_entry_isbn
+              [@isbn_radiobutton, @entry_isbn,
+               @eventbox_entry_search, @eventbox_combo_search]
+            end
           radio.active = true
           target_widget.grab_focus
           widget.above_child = false
@@ -604,7 +555,7 @@ module Alexandria
       end
 
       def on_help
-        Alexandria::UI.display_help(@preferences_dialog, 'add-book-by-isbn')
+        Alexandria::UI.display_help(@preferences_dialog, "add-book-by-isbn")
       end
 
       private
@@ -612,12 +563,14 @@ module Alexandria
       def assert_not_exist(library, isbn)
         # Check that the book doesn't already exist in the library.
         isbn13 = Library.canonicalise_ean(isbn)
-        puts isbn13
-        if (book = library.find { |bk| bk.isbn == isbn13 })
-          raise DuplicateBookException, _("'%s' already exists in '%s' (titled '%s').") % \
-            [isbn, library.name, book.title.sub('&', '&amp;')]
-        end
-        true
+        return unless isbn13
+
+        book = library.find { |bk| bk.isbn == isbn13 }
+        return unless book
+
+        raise DuplicateBookException,
+              format(_("'%s' already exists in '%s' (titled '%s')."),
+                     isbn, library.name, book.title.sub("&", "&amp;"))
       end
     end
   end