alexandria-book-collection-manager 0.7.5 → 0.7.9

data/lib/alexandria/ui/iconview_tooltips.rb

@@ -1,25 +1,8 @@
 # frozen_string_literal: true
 
-# -*- ruby -*-
+# This file is part of Alexandria.
 #
-# Copyright (C) 2007 kksou
-# Copyright (C) 2008,2009 Cathal Mc Ginley
-# Copyright (C) 2011, 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
-# 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.
+# See the file README.md for authorship and licensing information.
 
 # Please retain the following note:
 #
@@ -31,47 +14,51 @@
 
 require "cgi"
 
-class IconViewTooltips
-  include Alexandria::Logging
+module Alexandria
+  module UI
+    class IconViewTooltips
+      include Logging
 
-  def initialize(view)
-    set_view(view)
-  end
+      def initialize(view)
+        set_view(view)
+      end
 
-  def set_view(view)
-    view.has_tooltip = true
-    view.signal_connect("query-tooltip") do |_widget, x, y, _keyboard_mode, tooltip|
-      tree_path = view.get_path_at_pos(x, y)
-      if tree_path
-        iter = view.model.get_iter(tree_path)
+      def set_view(view)
+        view.has_tooltip = true
+        view.signal_connect("query-tooltip") do |_widget, x, y, _keyboard_mode, tooltip|
+          tree_path = view.get_path_at_pos(x, y)
+          if tree_path
+            iter = view.model.get_iter(tree_path)
 
-        title = iter[2] # HACK: hardcoded, should use column names...
-        authors = iter[4]
-        publisher = iter[6]
-        year = iter[7]
-        tooltip.set_markup label_for_book(title, authors, publisher, year)
+            title = iter[2] # HACK: hardcoded, should use column names...
+            authors = iter[4]
+            publisher = iter[6]
+            year = iter[7]
+            tooltip.set_markup label_for_book(title, authors, publisher, year)
+          end
+        end
       end
-    end
-  end
 
-  def label_for_book(title, authors, publisher, year)
-    # This is much too complex... but it works for now!
-    html = ""
-    unless title.empty?
-      html += "<b>#{CGI.escapeHTML(title)}</b>"
-      html += "\n" unless authors.empty?
-    end
-    html += "<i>#{CGI.escapeHTML(authors)}</i>" unless authors.empty?
-    html += "\n" if !title.empty? || !authors.empty?
+      def label_for_book(title, authors, publisher, year)
+        # This is much too complex... but it works for now!
+        html = ""
+        unless title.empty?
+          html += "<b>#{CGI.escapeHTML(title)}</b>"
+          html += "\n" unless authors.empty?
+        end
+        html += "<i>#{CGI.escapeHTML(authors)}</i>" unless authors.empty?
+        html += "\n" if !title.empty? || !authors.empty?
 
-    html += "<small>"
-    html += CGI.escapeHTML(publisher).to_s if publisher && !publisher.empty?
+        html += "<small>"
+        html += CGI.escapeHTML(publisher).to_s if publisher && !publisher.empty?
 
-    if year && !year.empty?
-      html += " " if publisher && !publisher.empty?
-      html += "(#{year})"
-    end
+        if year && !year.empty?
+          html += " " if publisher && !publisher.empty?
+          html += "(#{year})"
+        end
 
-    html + "</small>"
+        html + "</small>"
+      end
+    end
   end
 end

data/lib/alexandria/ui/import_dialog.rb

@@ -7,18 +7,9 @@
 require "alexandria/ui/error_dialog"
 require "alexandria/ui/skip_entry_dialog"
 
-class Alexandria::ImportFilter
-  def to_filefilter
-    filefilter = Gtk::FileFilter.new
-    filefilter.name = name
-    patterns.each { |x| filefilter.add_pattern(x) }
-    filefilter
-  end
-end
-
 module Alexandria
   module UI
-    class ImportDialog < SimpleDelegator
+    class ImportDialog
       include GetText
       include Logging
 
@@ -26,55 +17,56 @@ module Alexandria
 
       FILTERS = Alexandria::ImportFilter.all
 
+      attr_reader :dialog
+
       def initialize(parent)
         title = _("Import a Library")
-        dialog = Gtk::FileChooserDialog.new title: title, parent: parent, action: :open
-        super(dialog)
-        puts "ImportDialog opened." if $DEBUG
+        @dialog = Gtk::FileChooserDialog.new title: title, parent: parent, action: :open
+        log.debug { "ImportDialog opened" }
         @destroyed = false
         @running = false
-        add_button(Gtk::Stock::HELP, Gtk::ResponseType::HELP)
-        add_button(Gtk::Stock::CANCEL, Gtk::ResponseType::CANCEL)
-        import_button = add_button(_("_Import"),
-                                   Gtk::ResponseType::ACCEPT)
+        dialog.add_button(Gtk::Stock::HELP, Gtk::ResponseType::HELP)
+        dialog.add_button(Gtk::Stock::CANCEL, Gtk::ResponseType::CANCEL)
+        import_button = dialog.add_button(_("_Import"),
+                                          Gtk::ResponseType::ACCEPT)
         import_button.sensitive = false
 
-        signal_connect("destroy") do
+        dialog.signal_connect("destroy") do
           if @running
             @destroyed = true
           else
-            destroy
+            dialog.destroy
           end
         end
 
-        filters = {}
+        @filters = {}
         FILTERS.each do |filter|
-          filefilter = filter.to_filefilter
-          add_filter(filefilter)
-          puts "Added ImportFilter #{filefilter} -- #{filefilter.name}" if $DEBUG
-          filters[filefilter] = filter
+          filefilter = make_filefilter filter
+          dialog.add_filter(filefilter)
+          log.debug { "Added ImportFilter #{filefilter} -- #{filefilter.name}" }
+          @filters[filefilter] = filter
         end
 
-        signal_connect("selection_changed") do
-          import_button.sensitive = !!(filename && File.file?(filename))
+        dialog.signal_connect("selection_changed") do
+          import_button.sensitive = dialog.filename && File.file?(dialog.filename)
         end
 
         # before adding the (hidden) progress bar, we must re-set the
         # packing of the button box (currently packed at the end),
         # because the progressbar will be *after* the button box.
-        buttonbox = child.children.last
-        child.set_child_packing(buttonbox, pack_type: :start)
-        child.reorder_child(buttonbox, 1)
+        buttonbox = dialog.child.children.last
+        dialog.child.set_child_packing(buttonbox, pack_type: :start)
+        dialog.child.reorder_child(buttonbox, 1)
 
-        pbar = Gtk::ProgressBar.new
-        pbar.show_text = true
-        child.pack_start(pbar, expand: false)
+        @pbar = Gtk::ProgressBar.new
+        @pbar.show_text = true
+        dialog.child.pack_start(@pbar, expand: false)
       end
 
       def acquire
         on_progress = proc do |fraction|
-          pbar.show unless pbar.visible?
-          pbar.fraction = fraction
+          @pbar.show unless @pbar.visible?
+          @pbar.fraction = fraction
         end
 
         on_error = proc do |message|
@@ -84,27 +76,27 @@ module Alexandria
         exec_queue = ExecutionQueue.new
 
         while !@destroyed &&
-            ((response = run) != Gtk::ResponseType::CANCEL) &&
+            ((response = dialog.run) != Gtk::ResponseType::CANCEL) &&
             response != Gtk::ResponseType::DELETE_EVENT
 
           if response == Gtk::ResponseType::HELP
             Alexandria::UI.display_help(self, "import-library")
             next
           end
-          file = File.basename(filename, ".*")
+          file = File.basename(dialog.filename, ".*")
           base = GLib.locale_to_utf8(file)
           new_library_name = Library.generate_new_name(
             LibraryCollection.instance.all_libraries,
             base)
 
-          filter = filters[self.filter]
-          puts "Going forward with filter: #{filter.name}" if $DEBUG
-          self.sensitive = false
+          filter = @filters[dialog.filter]
+          log.debug { "Going forward with filter: #{filter.name}" }
+          dialog.sensitive = false
 
           filter.on_iterate do |n, total|
             unless @destroyed
               fraction = n * 1.0 / total
-              puts "#{inspect} fraction: #{fraction}" if $DEBUG
+              log.debug { "#{inspect} fraction: #{fraction}" }
               exec_queue.call(on_progress, fraction)
             end
           end
@@ -112,22 +104,21 @@ module Alexandria
           not_cancelled = true
           filter.on_error do |message|
             not_cancelled = exec_queue.sync_call(on_error, message)
-            puts "#{inspect} cancel state: #{not_cancelled}" if $DEBUG
+            log.debug { "#{inspect} cancel state: #{not_cancelled}" }
           end
 
           library = nil
           @bad_isbns = nil
           @failed_isbns = nil
           thread = Thread.start do
-            library, @bad_isbns, @failed_isbns = filter.invoke(new_library_name,
-                                                               filename)
+            library, @bad_isbns, @failed_isbns =
+              filter.invoke(new_library_name, dialog.filename)
           rescue StandardError => ex
             trace = ex.backtrace.join("\n> ")
             log.error { "Import failed: #{ex.message} #{trace}" }
           end
 
           while thread.alive? && !@destroyed
-            # puts "Thread #{thread} still alive."
             @running = true
             exec_queue.iterate
             Gtk.main_iteration_do(false)
@@ -138,18 +129,28 @@ module Alexandria
               yield(library, @bad_isbns, @failed_isbns)
               break
             elsif not_cancelled
-              puts "Raising ErrorDialog because not_cancelled is #{not_cancelled}" if $DEBUG
-              ErrorDialog.new(self,
+              log.debug { "Raising ErrorDialog because not_cancelled is #{not_cancelled}" }
+              ErrorDialog.new(dialog,
                               _("Couldn't import the library"),
                               _("The format of the file you " \
                                 "provided is unknown.  Please " \
                                 "retry with another file.")).display
             end
-            pbar.hide
+            @pbar.hide
             self.sensitive = true
           end
         end
-        destroy unless @destroyed
+
+        dialog.destroy unless @destroyed
+      end
+
+      private
+
+      def make_filefilter(import_filter)
+        filefilter = Gtk::FileFilter.new
+        filefilter.name = import_filter.name
+        import_filter.patterns.each { |x| filefilter.add_pattern(x) }
+        filefilter
       end
     end
   end

data/lib/alexandria/ui/init.rb

@@ -8,6 +8,7 @@ require "alexandria/ui/error_dialog"
 
 class CellRendererToggle < Gtk::CellRendererToggle
   attr_accessor :text
+
   type_register
   install_property(GLib::Param::String.new(
                      "text",
@@ -18,33 +19,34 @@ class CellRendererToggle < Gtk::CellRendererToggle
 end
 
 class Gtk::ActionGroup
-  def [](x)
-    get_action(x)
+  def [](index)
+    get_action(index)
   end
 end
 
-class Gtk::IconView
-  def freeze
-    @old_model = model
-    self.model = nil
-  end
-
-  def unfreeze
-    self.model = @old_model
+module Alexandria::UI::FreezeThaw
+  def frozen?
+    @old_model && !model
   end
-end
 
-class Gtk::TreeView
   def freeze
+    return if frozen?
+
     @old_model = model
     self.model = nil
   end
 
   def unfreeze
+    return unless frozen?
+
     self.model = @old_model
+    @old_model = nil
   end
 end
 
+Gtk::IconView.include Alexandria::UI::FreezeThaw
+Gtk::TreeView.include Alexandria::UI::FreezeThaw
+
 class Alexandria::Library
   def action_name
     "MoveIn" + name.gsub(/\s/, "")

data/lib/alexandria/ui/keep_bad_isbn_dialog.rb

@@ -16,13 +16,13 @@ module Alexandria
         title = _("Invalid ISBN '%s'") % book.isbn
         message =
           _("The book titled '%s' has an invalid ISBN, but still " \
-            "exists in the providers libraries.  Do you want to " \
+            "exists in the providers libraries. Do you want to " \
             "keep the book but change the ISBN or cancel the addition?") % book.title
         super(parent, title,
               Gtk::Stock::DIALOG_QUESTION,
               [[Gtk::Stock::CANCEL, Gtk::ResponseType::CANCEL],
                [_("_Keep"), Gtk::ResponseType::OK]], message)
-        self.default_response = Gtk::ResponseType::OK
+        dialog.default_response = Gtk::ResponseType::OK
       end
 
       def keep?

data/lib/alexandria/ui/libraries_combo.rb

@@ -35,16 +35,10 @@ module Alexandria
       clear
       self.model = Gtk::ListStore.new(GdkPixbuf::Pixbuf, String, TrueClass)
       libraries_names.each do |library_name|
-        iter = model.append
-        iter[0] = Alexandria::UI::Icons::LIBRARY_SMALL
-        iter[1] = library_name
-        iter[2] = false
+        append_entry(Alexandria::UI::Icons::LIBRARY_SMALL, library_name, false)
       end
-      model.append[1] = "-"
-      iter = model.append
-      iter[0] = Alexandria::UI::Icons::LIBRARY_SMALL
-      iter[1] = _("New Library")
-      iter[2] = true
+      append_entry(nil, "-", nil)
+      append_entry(Alexandria::UI::Icons::LIBRARY_SMALL, _("New Library"), true)
       renderer = Gtk::CellRendererPixbuf.new
       pack_start(renderer, false)
       set_attributes(renderer, pixbuf: 0)
@@ -79,6 +73,13 @@ module Alexandria
 
       [library, is_new]
     end
+
+    def append_entry(icon, label, is_new)
+      iter = model.append
+      iter[0] = icon
+      iter[1] = label
+      iter[2] = is_new
+    end
   end
 end
 

data/lib/alexandria/ui/listview.rb

@@ -83,9 +83,8 @@ module Alexandria
       end
 
       def setup_tags_column
-        # adding tags column...
         title = _("Tags")
-        log.debug { "Create listview column for tags..." }
+        log.debug { "Create listview column for tags" }
         renderer = Gtk::CellRendererText.new
         renderer.ellipsize = :end
         column = Gtk::TreeViewColumn.new(title, renderer,
@@ -105,7 +104,7 @@ module Alexandria
 
       def setup_rating_column
         title = _("Rating")
-        log.debug { format("Create listview column for %s...", title) }
+        log.debug { format("Create listview column for %s", title) }
         column = Gtk::TreeViewColumn.new(title)
         column.sizing = :fixed
         width = (Icons::STAR_SET.width + 1) * Book::MAX_RATING_STARS
@@ -164,7 +163,7 @@ module Alexandria
         column = Gtk::TreeViewColumn.new(title, renderer, text: iterid)
         column.sort_column_id = iterid
         column.resizable = true
-        log.debug { format("Create listview column for %s...", title) }
+        log.debug { format("Create listview column for %s", title) }
 
         column.add_attribute(renderer, "active", iterid)
         if iterid == Columns::WANT
@@ -176,7 +175,7 @@ module Alexandria
       end
 
       def setup_text_column(title, iterid)
-        log.debug { format("Create listview column for %s...", title) }
+        log.debug { format("Create listview column for %s", title) }
         renderer = Gtk::CellRendererText.new
         renderer.ellipsize = :end
         column = Gtk::TreeViewColumn.new(title, renderer,
@@ -202,9 +201,9 @@ module Alexandria
           @prefs.col_rating_visible,
           @prefs.col_tags_visible
         ]
-        cols = @listview.columns[1..-1] # skip "Title"
+        cols = @listview.columns[1..] # skip "Title"
         cols.each_index do |i|
-          cols[i].visible = !!cols_visibility[i]
+          cols[i].visible = cols_visibility[i]
         end
         log.debug do
           "Columns visibility: " +

data/lib/alexandria/ui/main_app.rb

@@ -50,8 +50,8 @@ module Alexandria
       include Logging
       include GetText
       include Singleton
-      attr_accessor :main_app, :libraries, :actiongroup, :appbar, :prefs
-      attr_accessor :ui_manager
+      attr_accessor :main_app, :libraries, :actiongroup, :appbar, :prefs, :ui_manager
+
       def initialize
         log.info { "Starting MainApp" }
         @ui_manager = UIManager.new self

data/lib/alexandria/ui/multi_drag_treeview.rb

@@ -6,16 +6,14 @@
 
 module Alexandria
   module EventOverrides
-    def ==(obj)
-      obj.is_a?(self.class) &&
-        (time == obj.time) && (x == obj.x) && (y == obj.y) &&
-        (button == obj.button)
+    def ==(other)
+      other.is_a?(self.class) &&
+        (time == other.time) && (x == other.x) && (y == other.y) &&
+        (button == other.button)
     end
   end
 
   module TreeViewOverrides
-    # include Alexandria::Logging
-
     Context = Struct.new(:pressed_button,
                          :x,
                          :y,
@@ -101,7 +99,7 @@ module Alexandria
         return true
       end
 
-      return false if event.event_type == :'2button_press'
+      return false if event.event_type == :"2button_press"
 
       path, _, cell_x, cell_y = get_path_at_pos(event.x, event.y)
       return false if path.nil?