alexandria-book-collection-manager 0.7.1 → 0.7.6

data/lib/alexandria/ui.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright (C) 2004-2006 Laurent Sansonetti
 #
 # Alexandria is free software; you can redistribute it and/or
@@ -15,35 +17,35 @@
 # write to the Free Software Foundation, Inc., 51 Franklin Street,
 # Fifth Floor, Boston, MA 02110-1301 USA.
 
-require 'gdk_pixbuf2'
-require 'gtk3'
+require "gdk_pixbuf2"
+require "gtk3"
 
-require 'alexandria/ui/icons'
-require 'alexandria/ui/builder_base'
-require 'alexandria/ui/completion_models'
-require 'alexandria/ui/libraries_combo'
-require 'alexandria/ui/multi_drag_treeview'
-require 'alexandria/ui/main_app'
+require "alexandria/ui/icons"
+require "alexandria/ui/builder_base"
+require "alexandria/ui/completion_models"
+require "alexandria/ui/libraries_combo"
+require "alexandria/ui/multi_drag_treeview"
+require "alexandria/ui/main_app"
 
 module Alexandria
   module UI
     include Logging
     def self.init_icons
-      log.info { 'Initializing Icons...' }
+      log.info { "Initializing Icons" }
       Icons.init
     end
 
     def self.start_main_app
-      puts '==========================' if $DEBUG
-      log.info { 'Starting MainApp...' }
-      puts '==========================' if $DEBUG
+      log.debug { "==========================" }
+      log.info { "Starting MainApp" }
+      log.debug { "==========================" }
       MainApp.instance
     end
 
     def self.start_gtk
-      puts '====================================' if $DEBUG
-      log.info { 'Starting Gtk...' }
-      puts '====================================' if $DEBUG
+      log.debug { "====================================" }
+      log.info { "Starting Gtk" }
+      log.debug { "====================================" }
       Gtk.main
     end
 

data/lib/alexandria/ui/about_dialog.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+# This file is part of Alexandria.
+#
+# See the file README.md for authorship and licensing information.
+
+module Alexandria
+  module UI
+    class AboutDialog
+      GPL = <<~EOL # rubocop:disable GetText/DecorateString
+        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.
+
+        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.
+      EOL
+
+      def initialize(parent)
+        @dialog = Gtk::AboutDialog.new
+        @dialog.name = Alexandria::TITLE
+        @dialog.version = Alexandria::DISPLAY_VERSION
+        @dialog.copyright = Alexandria::COPYRIGHT
+        @dialog.comments = Alexandria::DESCRIPTION
+        @dialog.authors = Alexandria::AUTHORS
+        @dialog.documenters = Alexandria::DOCUMENTERS
+        @dialog.artists = Alexandria::ARTISTS
+        @dialog.translator_credits = Alexandria::TRANSLATORS.join("\n")
+        @dialog.logo = Icons::ALEXANDRIA
+        @dialog.website = Alexandria::WEBSITE_URL
+        @dialog.license = GPL
+        @dialog.transient_for = parent
+        @dialog.signal_connect("response") { @dialog.destroy }
+      end
+
+      def show
+        @dialog.show
+      end
+    end
+  end
+end

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

@@ -1,34 +1,20 @@
-# Copyright (C) 2004-2006 Laurent Sansonetti
-# Copyright (C) 2007 Cathal Mc Ginley
-# Copyright (C) 2011, 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 'monitor'
-require 'alexandria/scanners/cuecat'
-require 'alexandria/scanners/keyboard'
+require "monitor"
+require "alexandria/scanners/cue_cat"
+require "alexandria/scanners/keyboard"
 
-require 'alexandria/ui/sound'
-require 'alexandria/ui/dialogs/barcode_animation'
+require "alexandria/ui/builder_base"
+require "alexandria/ui/barcode_animation"
+require "alexandria/ui/error_dialog"
+require "alexandria/ui/sound"
 
 module Alexandria
   module UI
-    require 'thread'
-    require 'monitor'
-
     # assists in turning on progress bar when searching
     # and turning it off when all search threads have completed...
     class SearchThreadCounter < Monitor
@@ -56,17 +42,15 @@ module Alexandria
       include GetText
       include Logging
       extend GetText
-      GetText.bindtextdomain(Alexandria::TEXTDOMAIN, charset: 'UTF-8')
+      GetText.bindtextdomain(Alexandria::TEXTDOMAIN, charset: "UTF-8")
 
       def initialize(parent, selected_library = nil, &block)
-        super('acquire_dialog__builder.glade', widget_names)
+        super("acquire_dialog__builder.glade", widget_names)
         @acquire_dialog.transient_for = @parent = parent
         @block = block
 
-        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)
 
@@ -80,25 +64,22 @@ module Alexandria
         @search_threads_running = @search_thread_counter.new_cond
       end
 
+      def show
+        @acquire_dialog.show
+      end
+
       def widget_names
-        [:acquire_dialog, :dialog_vbox1, :dialog_action_area1,
-         :help_button, :cancel_button, :add_button, :vbox1,
-         :barcode_label, :scan_area, :scan_frame, :scrolledwindow1,
-         :barcodes_treeview, :hbox1, :label1, :combo_libraries]
+        [:acquire_dialog, :add_button, :barcodes_treeview, :barcode_label,
+         :scan_area, :scan_frame, :combo_libraries]
       end
 
       def book_in_library(isbn10, library)
         isbn13 = Library.canonicalise_ean(isbn10)
-        # puts "new book #{isbn10} (or #{isbn13})"
         match = library.find do |book|
-          # puts "testing #{book.isbn}"
           (book.isbn == isbn10 || book.isbn == isbn13)
-          # puts "book #{book.isbn}"
-          # book == new_book
         end
-        # puts "book_in_library match #{match.inspect}"
         !match.nil?
-      rescue
+      rescue StandardError
         log.warn { "Failed to check for book #{isbn10} in library #{library}" }
         true
       end
@@ -106,7 +87,7 @@ module Alexandria
       def on_add
         model = @barcodes_treeview.model
 
-        libraries = Libraries.instance.all_libraries
+        libraries = LibraryCollection.instance.all_libraries
         library, is_new_library =
           @combo_libraries.selection_from_libraries(libraries)
 
@@ -208,9 +189,7 @@ module Alexandria
             book = result[0]
             cover_uri = result[1]
 
-            unless cover_uri.nil?
-              library.save_cover(book, cover_uri)
-            end
+            library.save_cover(book, cover_uri) unless cover_uri.nil?
             books << book
             library << book
             library.save(book)
@@ -220,13 +199,13 @@ module Alexandria
         if isbn_duplicates.empty?
           @acquire_dialog.destroy unless adding_a_selection
         else
-          message = n_('There was %d duplicate',
-                       'There were %d duplicates',
+          message = n_("There was %d duplicate",
+                       "There were %d duplicates",
                        isbn_duplicates.size) % isbn_duplicates.size
           title = n_("Couldn't add this book",
                      "Couldn't add these books",
                      isbn_duplicates.size)
-          ErrorDialog.new(@parent, title, message)
+          ErrorDialog.new(@acquire_dialog, title, message).display
         end
 
         @block.call(books, library, is_new_library)
@@ -240,7 +219,7 @@ module Alexandria
 
       def read_barcode_scan
         @animation.start
-        play_sound('scanning') if @test_scan
+        play_sound("scanning") if @test_scan
         log.debug { "reading scanner data #{@scanner_buffer}" }
         barcode_text = nil
         isbn = nil
@@ -250,25 +229,25 @@ module Alexandria
           isbn = Library.canonicalise_isbn(barcode_text)
           # TODO: : use an AppFacade
           # isbn =  LookupBook.get_isbn(barcode_text)
-        rescue StandardError => err
-          log.error { "Bad scan:  #{@scanner_buffer} #{err}" }
+        rescue StandardError => ex
+          log.error { "Bad scan:  #{@scanner_buffer} #{ex}" }
         ensure
-          @scanner_buffer = ''
+          @scanner_buffer = ""
         end
         if isbn
           log.debug { "Got ISBN #{isbn}" }
-          play_sound('good_scan')
+          play_sound("good_scan")
 
           @barcodes_treeview.model.freeze_notify do
             iter = @barcodes_treeview.model.append
             iter[0] = isbn
             iter[1] = Icons::BOOK
-            iter[2] = ''
+            iter[2] = ""
           end
           lookup_book(isbn)
         else
-          log.debug { 'was not an ISBN barcode' }
-          play_sound('bad_scan')
+          log.debug { "was not an ISBN barcode" }
+          play_sound("bad_scan")
         end
       end
 
@@ -320,8 +299,11 @@ module Alexandria
 
       def start_search
         @search_thread_counter.synchronize do
-          if @search_thread_counter.count.zero?
-            @search_thread_counter.new_search
+          first_search = @search_thread_counter.count.zero?
+
+          @search_thread_counter.new_search
+
+          if first_search
             @progress_bar_thread = Thread.new do
               notify_start_add_by_isbn
               Alexandria::BookProviders.instance.add_observer(self)
@@ -333,8 +315,6 @@ module Alexandria
               notify_end_add_by_isbn
               Alexandria::BookProviders.instance.add_observer(self)
             end
-          else
-            @search_thread_counter.new_search
           end
         end
       end
@@ -348,88 +328,82 @@ module Alexandria
 
       def lookup_book(isbn)
         Thread.new do
-          begin
-            start_search
-            results = Alexandria::BookProviders.isbn_search(isbn)
-            book = results[0]
-            cover_uri = results[1]
-            @book_results[isbn] = results
-            set_cover_image_async(isbn, cover_uri)
-
-            @barcodes_treeview.model.freeze_notify do
-              @barcodes_treeview.model.each do |model, path, iter|
-                if iter[0] == isbn
-                  iter[2] = book.title
-                  model.row_changed(path, iter)
-                end
+          start_search
+          results = Alexandria::BookProviders.isbn_search(isbn)
+          book = results[0]
+          cover_uri = results[1]
+          @book_results[isbn] = results
+          set_cover_image_async(isbn, cover_uri)
+
+          @barcodes_treeview.model.freeze_notify do
+            @barcodes_treeview.model.each do |model, path, iter|
+              if iter[0] == isbn
+                iter[2] = book.title
+                model.row_changed(path, iter)
               end
             end
-
-            @add_button.sensitive = true
-          rescue StandardError => err
-            log.error { "Book Search failed: #{err.message}" }
-            log << err if log.error?
-          ensure
-            stop_search
           end
+
+          @add_button.sensitive = true
+        rescue StandardError => ex
+          log.error { "Book Search failed: #{ex.message}" }
+          log << ex if log.error?
+        ensure
+          stop_search
         end
       end
 
       def set_cover_image_async(isbn, cover_uri)
         Thread.new do
-          begin
-            pixbuf = nil
-            if cover_uri
-              image_data = nil
-              if URI.parse(cover_uri).scheme.nil?
-                File.open(cover_uri, 'r') do |io|
-                  image_data = io.read
-                end
-              else
-                image_data = URI.parse(cover_uri).read
+          pixbuf = nil
+          if cover_uri
+            image_data = nil
+            if URI.parse(cover_uri).scheme.nil?
+              File.open(cover_uri, "r") do |io|
+                image_data = io.read
               end
-              loader = GdkPixbuf::PixbufLoader.new
-              loader.last_write(image_data)
-              pixbuf = loader.pixbuf
             else
-              pixbuf = Icons::BOOK
+              image_data = URI.parse(cover_uri).read
             end
+            loader = GdkPixbuf::PixbufLoader.new
+            loader.last_write(image_data)
+            pixbuf = loader.pixbuf
+          else
+            pixbuf = Icons::BOOK
+          end
 
-            @barcodes_treeview.model.freeze_notify do
-              @barcodes_treeview.model.each do |model, path, iter|
-                if iter[0] == isbn
-                  iter[1] = pixbuf
-                  model.row_changed(path, iter)
-                end
+          @barcodes_treeview.model.freeze_notify do
+            @barcodes_treeview.model.each do |model, path, iter|
+              if iter[0] == isbn
+                iter[1] = pixbuf
+                model.row_changed(path, iter)
               end
             end
-
-          rescue StandardError => err
-            log.error {
-              "Failed to load cover image icon: #{err.message}"
-            }
-            log << err if log.error?
-
           end
+        rescue StandardError => ex
+          log.error do
+            "Failed to load cover image icon: #{ex.message}"
+          end
+          log << ex if log.error?
         end
       end
 
       def on_destroy
-        MainApp.instance.ui_manager.set_status_label('')
+        MainApp.instance.ui_manager.set_status_label("")
         notify_end_add_by_isbn
         # TODO: possibly make sure all threads have stopped running
         @animation.destroy
       end
 
       def setup_scanner_area
-        @scanner_buffer = ''
+        @scanner_buffer = ""
         scanner_name = @prefs.barcode_scanner
 
-        @scanner = Alexandria::Scanners.find_scanner scanner_name ||
+        @scanner = Alexandria::Scanners.find_scanner(scanner_name) ||
           Alexandria::Scanners.default_scanner # CueCat is default
 
         log.debug { "Using #{@scanner.name} scanner" }
-        message = _('Ready to use %s barcode scanner') % @scanner.name
+        message = _("Ready to use %s barcode scanner") % @scanner.name
         MainApp.instance.ui_manager.set_status_label(message)
 
         @prev_time = 0
@@ -439,40 +413,41 @@ module Alexandria
         @scan_frame.add(@animation.canvas)
 
         # attach signals
-        @scan_area.signal_connect('button-press-event') do |_widget, _event|
+        @scan_area.signal_connect("button-press-event") do |_widget, _event|
           @scan_area.grab_focus
         end
-        @scan_area.signal_connect('focus-in-event') do |_widget, _event|
-          @barcode_label.label = _('%s _Barcode Scanner Ready' % _(@scanner.display_name))
-          @scanner_buffer = ''
+        @scan_area.signal_connect("focus-in-event") do |_widget, _event|
+          @barcode_label.label =
+            _(format("%s _Barcode Scanner Ready", _(@scanner.display_name)))
+          @scanner_buffer = ""
           begin
             @animation.set_active
-          rescue StandardError => err
-            log << err if log.error?
+          rescue StandardError => ex
+            log << ex if log.error?
           end
         end
-        @scan_area.signal_connect('focus-out-event') do |_widget, _event|
-          @barcode_label.label = _('Click below to scan _barcodes')
-          @scanner_buffer = ''
+        @scan_area.signal_connect("focus-out-event") do |_widget, _event|
+          @barcode_label.label = _("Click below to scan _barcodes")
+          @scanner_buffer = ""
           @animation.set_passive
           # @scanner_background.destroy
         end
 
         @@debug_index = 0
-        @scan_area.signal_connect('key-press-event') do |_button, event|
+        @scan_area.signal_connect("key-press-event") do |_button, event|
           # log.debug { event.keyval }
           # event.keyval == 65293 means Enter key
           # HACK, this disallows numeric keypad entry of data...
           if event.keyval < 255
             if @scanner_buffer.empty?
-              if event.keyval.chr == '`' # backtick key for devs
+              if event.keyval.chr == "`" # backtick key for devs
                 developer_test_scan
                 next
               else
                 # this is our first character, notify user
-                log.debug { 'Scanning! Received first character.' }
+                log.debug { "Scanning! Received first character." }
               end
-              play_sound('scanning')
+              play_sound("scanning")
             end
             @scanner_buffer << event.keyval.chr
 
@@ -496,7 +471,7 @@ module Alexandria
             if @scanner.match? @scanner_buffer
 
               Thread.new(@interval, @scanner_buffer) do |interval, buffer|
-                log.debug { 'Waiting for more scanner input...' }
+                log.debug { "Waiting for more scanner input" }
                 GLib::Idle.add do
                   @animation.manual_input
                   false
@@ -504,7 +479,7 @@ module Alexandria
                 time_to_wait = [3, interval * 4].min
                 sleep(time_to_wait)
                 if buffer == @scanner_buffer
-                  log.debug { 'Buffer unchanged; scanning complete' }
+                  log.debug { "Buffer unchanged; scanning complete" }
                   GLib::Idle.add do
                     @animation.scanner_input
                     false
@@ -515,7 +490,9 @@ module Alexandria
                   @interval = 0
 
                 else
-                  log.debug { 'Buffer has changed while waiting, reading more characters...' }
+                  log.debug do
+                    "Buffer has changed while waiting; reading more characters"
+                  end
                 end
               end
 
@@ -525,36 +502,38 @@ module Alexandria
 
         # @sound_player = SoundEffectsPlayer.new
         @sound_players = {}
-        @sound_players['scanning'] = SoundEffectsPlayer.new
-        @sound_players['good_scan'] = SoundEffectsPlayer.new
-        @sound_players['bad_scan'] = SoundEffectsPlayer.new
+        @sound_players["scanning"] = SoundEffectsPlayer.new
+        @sound_players["good_scan"] = SoundEffectsPlayer.new
+        @sound_players["bad_scan"] = SoundEffectsPlayer.new
         @test_scan = false
       end
 
       def play_sound(effect)
-        if effect == 'scanning'
-          puts "Effect: #{effect}, playing: #{@prefs.play_scanning_sound}" if $DEBUG
+        if effect == "scanning"
+          log.debug { "Effect: #{effect}, playing: #{@prefs.play_scanning_sound}" }
           return unless @prefs.play_scanning_sound
-          @sound_players['scanning'].play('scanning')
+
+          @sound_players["scanning"].play("scanning")
         else
-          puts "Effect: #{effect}, playing: #{@prefs.play_scan_sound}" if $DEBUG
+          log.debug { "Effect: #{effect}, playing: #{@prefs.play_scan_sound}" }
           return unless @prefs.play_scan_sound
+
           # sleep(0.5) # "scanning" effect lasts 0.5 seconds, wait for it to end
           @sound_players[effect].play(effect)
         end
       end
 
       def developer_test_scan
-        log.info { 'Developer test scan.' }
-        scans = ['.C3nZC3nZC3n2ChnWENz7DxnY.cGen.ENr7C3j3C3f1Dxj3Dq.',
-                 '.C3nZC3nZC3n2ChnWENz7DxnY.cGen.ENr7C3z0CNj3Dhj1EW.',
-                 '.C3nZC3nZC3n2ChnWENz7DxnY.cGen.ENr7C3r2DNbXCxTZCW.',
-                 '.C3nZC3nZC3n2ChnWENz7DxnY.cGf2.ENr7C3z0DNn0ENnWE3nZDhP6.',
-                 '.C3nZC3nZC3n2ChnWENz7DxnY.cGen.ENr7CNT2CxT2ChP0Dq.',
-                 '.C3nZC3nZC3n2ChnWENz7DxnY.cGen.ENr7CNT6E3f7CNbWDa.',
-                 '.C3nZC3nZC3n2ChnWENz7DxnY.cGen.ENr7C3b3ENjYDxv3EW.',
-                 '.C3nZC3nZC3n2ChnWENz7DxnY.cGen.ENr7C3b2DxjZE3b3Dq.',
-                 '.C3nZC3nZC3n2ChnWENz7DxnY.cGen.ENr7C3n6CNr6DxvYDa.']
+        log.info { "Developer test scan" }
+        scans = [".C3nZC3nZC3n2ChnWENz7DxnY.cGen.ENr7C3j3C3f1Dxj3Dq.",
+                 ".C3nZC3nZC3n2ChnWENz7DxnY.cGen.ENr7C3z0CNj3Dhj1EW.",
+                 ".C3nZC3nZC3n2ChnWENz7DxnY.cGen.ENr7C3r2DNbXCxTZCW.",
+                 ".C3nZC3nZC3n2ChnWENz7DxnY.cGf2.ENr7C3z0DNn0ENnWE3nZDhP6.",
+                 ".C3nZC3nZC3n2ChnWENz7DxnY.cGen.ENr7CNT2CxT2ChP0Dq.",
+                 ".C3nZC3nZC3n2ChnWENz7DxnY.cGen.ENr7CNT6E3f7CNbWDa.",
+                 ".C3nZC3nZC3n2ChnWENz7DxnY.cGen.ENr7C3b3ENjYDxv3EW.",
+                 ".C3nZC3nZC3n2ChnWENz7DxnY.cGen.ENr7C3b2DxjZE3b3Dq.",
+                 ".C3nZC3nZC3n2ChnWENz7DxnY.cGen.ENr7C3n6CNr6DxvYDa."]
         @scanner_buffer = scans[@@debug_index % scans.size]
         @@debug_index += 1
         @test_scan = true
@@ -573,12 +552,12 @@ module Alexandria
         text_renderer.editable = false
 
         # Add column using our renderer
-        col = Gtk::TreeViewColumn.new('ISBN', text_renderer, text: 0)
+        col = Gtk::TreeViewColumn.new("ISBN", text_renderer, text: 0)
         @barcodes_treeview.append_column(col)
 
         # Middle colulmn is cover-image renderer
         pixbuf_renderer = Gtk::CellRendererPixbuf.new
-        col = Gtk::TreeViewColumn.new('Cover', pixbuf_renderer)
+        col = Gtk::TreeViewColumn.new("Cover", pixbuf_renderer)
 
         col.set_cell_data_func(pixbuf_renderer) do |_column, cell, _model, iter|
           pixbuf = iter[1]
@@ -597,13 +576,11 @@ module Alexandria
         @barcodes_treeview.append_column(col)
 
         # Add column using the second renderer
-        col = Gtk::TreeViewColumn.new('Title', text_renderer, text: 2)
+        col = Gtk::TreeViewColumn.new("Title", text_renderer, text: 2)
         @barcodes_treeview.append_column(col)
 
-        @barcodes_treeview.model.signal_connect('row-deleted') do |model, _path|
-          unless model.iter_first
-            @add_button.sensitive = false
-          end
+        @barcodes_treeview.model.signal_connect("row-deleted") do |model, _path|
+          @add_button.sensitive = false unless model.iter_first
         end
       end
     end