alexandria-book-collection-manager 0.7.2 → 0.7.7

data/lib/alexandria/ui/alert_dialog.rb

@@ -0,0 +1,64 @@
+# 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 AlertDialog
+      def initialize(parent, title, stock_icon, buttons, message = nil)
+        @dialog = Gtk::Dialog.new(title: "", parent: parent, flags: :destroy_with_parent,
+                                  buttons: buttons)
+        @dialog.border_width = 6
+        @dialog.resizable = false
+        @dialog.child.spacing = 12
+
+        hbox = Gtk::Box.new(:horizontal, 12)
+        hbox.homogeneous = false
+        hbox.border_width = 6
+
+        image = Gtk::Image.new(stock: stock_icon,
+                               size: Gtk::IconSize::DIALOG)
+        image.set_alignment(0.5, 0)
+        hbox.pack_start(image)
+
+        vbox = Gtk::Box.new(:vertical, 6)
+        vbox.homogeneous = false
+        vbox.pack_start make_label("<b><big>#{title}</big></b>")
+        vbox.pack_start make_label(message.strip) unless message
+        hbox.pack_start(vbox)
+
+        @dialog.child.pack_start(hbox)
+      end
+
+      def show_all
+        dialog.show_all
+      end
+
+      def run
+        dialog.run
+      end
+
+      def destroy
+        dialog.destroy
+      end
+
+      def default_response=(response)
+        dialog.default_response = response
+      end
+
+      private
+
+      attr_reader :dialog
+
+      def make_label(markup)
+        label = Gtk::Label.new
+        label.set_alignment(0, 0)
+        label.wrap = label.selectable = true
+        label.markup = markup
+        label
+      end
+    end
+  end
+end

data/lib/alexandria/ui/bad_isbns_dialog.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+# This file is part of Alexandria.
+#
+# See the file README.md for authorship and licensing information.
+
+module Alexandria
+  module UI
+    # Generalized Dialog for lists of bad isbns. Used for on_import. Can also
+    # be used for on_load library conversions.
+    class BadIsbnsDialog
+      def initialize(parent, message, list)
+        @dialog = Gtk::MessageDialog.new(parent: parent,
+                                         flags: :modal,
+                                         type: :warning,
+                                         buttons: :close,
+                                         message: message)
+        the_vbox = @dialog.children.first
+
+        isbn_container = Gtk::Box.new :horizontal
+        the_vbox.pack_start(isbn_container)
+        the_vbox.reorder_child(isbn_container, 3)
+        scrolley = Gtk::ScrolledWindow.new
+        isbn_container.pack_start(scrolley)
+        textview = Gtk::TextView.new(Gtk::TextBuffer.new)
+        textview.editable = false
+        textview.cursor_visible = false
+        scrolley.add(textview)
+        list.each do |li|
+          textview.buffer.insert_at_cursor("#{li}\n")
+        end
+
+        @dialog.signal_connect("response") { @dialog.destroy }
+      end
+
+      def show
+        @dialog.show_all
+      end
+    end
+  end
+end

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

@@ -23,7 +23,7 @@
 # Boston, MA 02110-1301 USA.
 #++
 
-require 'gobject-introspection'
+require "gobject-introspection"
 
 module GooCanvas
   class << self
@@ -42,7 +42,7 @@ module GooCanvas
         remove_method(:const_missing)
       end
       loader = GObjectIntrospection::Loader.new(self)
-      loader.load('GooCanvas')
+      loader.load("GooCanvas")
     end
   end
 end
@@ -91,16 +91,16 @@ module Alexandria
       end
 
       def set_active
-        @canvas.set_property(:background_color, 'white')
-        @barcode_bars.each { |rect| rect.set_property(:fill_color, 'white') }
+        @canvas.set_property(:background_color, "white")
+        @barcode_bars.each { |rect| rect.set_property(:fill_color, "white") }
       end
 
       def set_passive
-        if @canvas
-          passive_bg = '#F4F4F4'
-          @canvas.set_property(:background_color, passive_bg)
-          @barcode_bars.each { |rect| rect.set_property(:fill_color, passive_bg) }
-        end
+        @canvas or return
+
+        passive_bg = "#F4F4F4"
+        @canvas.set_property(:background_color, passive_bg)
+        @barcode_bars.each { |rect| rect.set_property(:fill_color, passive_bg) }
       end
 
       def manual_input
@@ -116,7 +116,7 @@ module Alexandria
       private
 
       def create_ean_barcode_data
-        d = '211113123121112331122131113211111123122211132321112311231111'
+        d = "211113123121112331122131113211111123122211132321112311231111"
         # ####911113... but that's too much padding on the left...
         until d.empty?
           space_width = d[0].chr.to_i
@@ -129,11 +129,12 @@ module Alexandria
       def draw_barcode_bars
         @barcode_data.each do |space_width, bar_width|
           @hpos += space_width
-          rect_item = GooCanvas::CanvasRect.new(parent: @root,
-                                                x: @bar_left_edge + @scale * @hpos, y: @bar_top,
-                                                width: @scale * bar_width, height: @bar_height,
-                                                line_width: 0,
-                                                fill_color: 'white')
+          rect_item =
+            GooCanvas::CanvasRect.new(parent: @root,
+                                      x: @bar_left_edge + @scale * @hpos, y: @bar_top,
+                                      width: @scale * bar_width, height: @bar_height,
+                                      line_width: 0,
+                                      fill_color: "white")
           @hpos += bar_width
           @barcode_bars << rect_item
         end

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

@@ -1,22 +1,10 @@
 # frozen_string_literal: true
 
-# Copyright (C) 2004-2006 Laurent Sansonetti
-# Copyright (C) 2016 Matijs van Zuijlen
+# This file is part of Alexandria.
 #
-# 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.
+
+require "alexandria/ui/error_dialog"
 
 module Alexandria
   module UI
@@ -24,51 +12,51 @@ module Alexandria
       include Logging
       include GetText
       extend GetText
-      GetText.bindtextdomain(Alexandria::TEXTDOMAIN, charset: 'UTF-8')
+      GetText.bindtextdomain(Alexandria::TEXTDOMAIN, charset: "UTF-8")
 
       def initialize(parent, library, book)
         super(parent, library.cover(book))
-        puts 'Initializing Book Properties Dialog...' if $DEBUG
+        log.debug { "Initializing Book Properties Dialog" }
 
         cancel_button = Gtk::Button.new(stock_id: Gtk::Stock::CANCEL)
-        cancel_button.signal_connect('clicked') { on_cancel }
+        cancel_button.signal_connect("clicked") { on_cancel }
         cancel_button.show
         @button_box << cancel_button
 
         close_button = Gtk::Button.new(stock_id: Gtk::Stock::SAVE)
-        close_button.signal_connect('clicked') { on_close }
+        close_button.signal_connect("clicked") { on_close }
         close_button.show
         @button_box << close_button
 
         help_button = Gtk::Button.new(stock_id: Gtk::Stock::HELP)
-        help_button.signal_connect('clicked') { on_help }
+        help_button.signal_connect("clicked") { on_help }
         help_button.show
         @button_box << help_button
         @button_box.set_child_secondary(help_button, true)
 
         @entry_title.text = @book_properties_dialog.title = book.title
-        @entry_isbn.text = (book.isbn || '')
+        @entry_isbn.text = (book.isbn || "")
         @entry_publisher.text = book.publisher
         @entry_publish_date.text = book.publishing_year.to_s
-        @entry_publish_date.signal_connect('focus-out-event') do
+        @entry_publish_date.signal_connect("focus-out-event") do
           text = @entry_publish_date.text
           if text.empty?
             false
           else
             year = text.to_i
             if year.zero? || year > (Time.now.year + 10) || year < 10
-              @entry_publish_date.text = ''
+              @entry_publish_date.text = ""
               @entry_publish_date.grab_focus
               true
             elsif year < 100
-              @entry_publish_date.text = '19' + year.to_s
+              @entry_publish_date.text = "19" + year.to_s
               false
             end
           end
         end
         @entry_edition.text = book.edition
         if book.tags
-          @entry_tags.text = book.tags.join(',') # tags are comma-separated
+          @entry_tags.text = book.tags.join(",") # tags are comma-separated
         end
 
         book.authors.each do |author|
@@ -78,7 +66,7 @@ module Alexandria
         end
 
         buffer = Gtk::TextBuffer.new
-        buffer.text = (book.notes || '')
+        buffer.text = (book.notes || "")
         @textview_notes.buffer = buffer
 
         @library = library
@@ -87,7 +75,7 @@ module Alexandria
         self.rating = (book.rating || Book::DEFAULT_RATING)
 
         if (@checkbutton_loaned.active = book.loaned?)
-          @entry_loaned_to.text = (book.loaned_to || '')
+          @entry_loaned_to.text = (book.loaned_to || "")
           self.loaned_since = book.loaned_since
           @date_loaned_since.sensitive = true
         else
@@ -98,7 +86,7 @@ module Alexandria
         if (@checkbutton_redd.active = book.redd?)
           @redd_date.sensitive = true
           if book.redd_when.nil?
-            puts 'no redd_when'
+            log.debug { "no redd_when" }
           else
             @redd_date.text = format_date(book.redd_when)
           end
@@ -114,28 +102,30 @@ module Alexandria
       private
 
       def on_close
-        if @entry_isbn.text == ''
+        if @entry_isbn.text == ""
           # If set to nil .to_yaml in library.save causes crash
-          @book.isbn = ''
+          @book.isbn = ""
         else
-          ary = @library.select { |book| book.ident == @entry_isbn.text }
+          isbn = Library.canonicalise_ean(@entry_isbn.text)
+          unless isbn
+            ErrorDialog.new(@book_properties_dialog,
+                            _("Couldn't modify the book"),
+                            _("Couldn't validate the EAN/ISBN you " \
+                              "provided.  Make sure it is written " \
+                              "correcty, and try again.")).display
+            return
+          end
+
+          ary = @library.select { |book| book.ident == isbn }
           unless ary.empty? || ((ary.length == 1) && (ary.first == @book))
-            ErrorDialog.new(@parent,
+            ErrorDialog.new(@book_properties_dialog,
                             _("Couldn't modify the book"),
-                            _('The EAN/ISBN you provided is already ' \
-                              'used in this library.'))
+                            _("The EAN/ISBN you provided is already " \
+                              "used in this library.")).display
             return
           end
-          @book.isbn = begin
-                         Library.canonicalise_ean(@entry_isbn.text)
-                       rescue Alexandria::Library::InvalidISBNError
-                         ErrorDialog.new(@parent,
-                                         _("Couldn't modify the book"),
-                                         _("Couldn't validate the EAN/ISBN you " \
-                                           'provided.  Make sure it is written ' \
-                                           'correcty, and try again.'))
-                         return
-                       end
+
+          @book.isbn = isbn
         end
         @book.title = @entry_title.text
         @book.publisher = @entry_publisher.text
@@ -153,11 +143,8 @@ module Alexandria
         if loaned_since.strip.empty?
           @book.loaned_since = nil
         else
-          begin
-            t = parse_date(loaned_since)
-            @book.loaned_since = t
-          rescue
-          end
+          t = parse_date(loaned_since)
+          @book.loaned_since = t
         end
 
         @book.redd = @checkbutton_redd.active?
@@ -174,7 +161,7 @@ module Alexandria
         end
         @book.own = @checkbutton_own.active?
         @book.want = @checkbutton_want.active?
-        @book.tags = @entry_tags.text.split(',') # tags are comma separated
+        @book.tags = @entry_tags.text.split(",") # tags are comma separated
 
         FileUtils.rm_f(@cover_file) if @delete_cover_file
 
@@ -192,7 +179,7 @@ module Alexandria
 
       def on_help
         Alexandria::UI.display_help(@preferences_dialog,
-                                    'editing-book-properties')
+                                    "editing-book-properties")
       end
     end
   end

data/lib/alexandria/ui/book_properties_dialog_base.rb

@@ -0,0 +1,318 @@
+# frozen_string_literal: true
+
+# This file is part of Alexandria.
+#
+# See the file README.md for authorship and licensing information.
+
+require "alexandria/ui/builder_base"
+require "alexandria/ui/calendar_popup"
+require "alexandria/ui/error_dialog"
+
+module Alexandria
+  module UI
+    class BookPropertiesDialogBase < BuilderBase
+      include CalendarPopup
+      include GetText
+      extend GetText
+      GetText.bindtextdomain(Alexandria::TEXTDOMAIN, charset: "UTF-8")
+
+      COVER_MAXWIDTH = 140 # pixels
+
+      COVER_ABSOLUTE_MAXHEIGHT = 250 # pixels, above this we scale down...
+
+      def initialize(parent, cover_file)
+        super("book_properties_dialog__builder.glade", widget_names)
+        @setup_finished = false
+        @book_properties_dialog.transient_for = parent
+        @parent = parent
+        @cover_file = cover_file
+        @original_cover_file = nil
+        @delete_cover_file = false # fixing bug #16707
+
+        @entry_title.complete_titles
+        @entry_title.grab_focus
+        @entry_publisher.complete_publishers
+        @entry_edition.complete_editions
+        @entry_loaned_to.complete_borrowers
+
+        @entry_tags.complete_tags
+
+        @treeview_authors.model = Gtk::ListStore.new(String, TrueClass)
+        @treeview_authors.selection.mode = :single
+        renderer = Gtk::CellRendererText.new
+        renderer.signal_connect("edited") do |_cell, path_string, new_text|
+          path = Gtk::TreePath.new(path_string)
+          iter = @treeview_authors.model.get_iter(path)
+          iter[0] = new_text
+        end
+        renderer.signal_connect("editing_started") do |_cell, entry, _path_string|
+          entry.complete_authors
+        end
+        col = Gtk::TreeViewColumn.new("", renderer,
+                                      text: 0,
+                                      editable: 1)
+        @treeview_authors.append_column(col)
+
+        setup_date_widgets
+        GLib::Timeout.add(150) do
+          @setup_finished = true
+
+          false
+        end
+      end
+
+      def show
+        @book_properties_dialog.show
+      end
+
+      def setup_date_widgets
+        @redd_date.signal_connect("icon-press") do |entry, primary, _icon|
+          case primary.nick
+          when "primary"
+            display_calendar_popup(entry)
+          when "secondary"
+            clear_date_entry(entry)
+          end
+        end
+
+        @date_loaned_since.signal_connect("icon-press") do |entry, primary, _icon|
+          case primary.nick
+          when "primary"
+            display_calendar_popup(entry)
+          when "secondary"
+            clear_date_entry(entry)
+            @label_loaning_duration.label = ""
+          end
+        end
+      end
+
+      def widget_names
+        [:book_properties_dialog, :button_box, :button_cover,
+         :checkbutton_loaned, :checkbutton_own, :checkbutton_redd,
+         :checkbutton_want, :date_loaned_since, :entry_edition,
+         :entry_loaned_to, :entry_publish_date, :entry_publisher, :entry_isbn,
+         :entry_tags, :entry_title, :image_cover, :image_rating1,
+         :image_rating2, :image_rating3, :image_rating4, :image_rating5,
+         :label_loaning_duration, :notebook, :redd_date, :textview_notes,
+         :treeview_authors]
+      end
+
+      def on_title_changed
+        title = @entry_title.text.strip
+        @book_properties_dialog.title = if title.empty?
+                                          _("Properties")
+                                        else
+                                          _("Properties for '%s'") % title
+                                        end
+      end
+
+      def on_add_author
+        iter = @treeview_authors.model.append
+        iter[0] = _("Author")
+        iter[1] = true
+        @treeview_authors.set_cursor(iter.path,
+                                     @treeview_authors.get_column(0),
+                                     true)
+      end
+
+      def on_remove_author
+        iter = @treeview_authors.selection.selected
+        @treeview_authors.model.remove(iter) if iter
+      end
+
+      def on_image_rating1_press
+        self.rating = 1
+      end
+
+      def on_image_rating2_press
+        self.rating = 2
+      end
+
+      def on_image_rating3_press
+        self.rating = 3
+      end
+
+      def on_image_rating4_press
+        self.rating = 4
+      end
+
+      def on_image_rating5_press
+        self.rating = 5
+      end
+
+      def on_image_no_rating_press
+        self.rating = 0
+      end
+
+      def own_toggled
+        @checkbutton_want.inconsistent = if @checkbutton_own.active?
+                                           true
+                                         else
+                                           false
+                                         end
+      end
+
+      def want_toggled; end
+
+      @@latest_filechooser_directory = ENV["HOME"]
+      def on_change_cover
+        backend = `uname`.chomp == "FreeBSD" ? "neant" : "gnome-vfs"
+        dialog = Gtk::FileChooserDialog.new(_("Select a cover image"),
+                                            @book_properties_dialog,
+                                            Gtk::FileChooser::ACTION_OPEN,
+                                            backend,
+                                            [_("No Cover"), Gtk::ResponseType::REJECT],
+                                            [Gtk::Stock::CANCEL, Gtk::ResponseType::CANCEL],
+                                            [Gtk::Stock::OPEN, Gtk::ResponseType::ACCEPT])
+        dialog.current_folder = @@latest_filechooser_directory
+        response = dialog.run
+        case response
+        when Gtk::ResponseType::ACCEPT
+          begin
+            @delete_cover_file = false
+            cover = GdkPixbuf::Pixbuf.new(file: dialog.filename)
+            # At this stage the file format is recognized.
+
+            if File.exist?(@cover_file) && !@original_cover_file
+              # make a back up, but only of the original
+              @original_cover_file = "#{@cover_file}~"
+              FileUtils.cp(@cover_file, @original_cover_file)
+            end
+            if cover.height > COVER_ABSOLUTE_MAXHEIGHT
+              FileUtils.cp(dialog.filename, "#{@cover_file}.orig")
+              new_width = cover.width / (cover.height / COVER_ABSOLUTE_MAXHEIGHT.to_f)
+              log.info do
+                "Scaling large cover image to" \
+                  " #{new_width.to_i} x #{COVER_ABSOLUTE_MAXHEIGHT}"
+              end
+              cover = cover.scale(new_width.to_i, COVER_ABSOLUTE_MAXHEIGHT)
+              cover.save(@cover_file, "jpeg")
+            else
+              FileUtils.cp(dialog.filename, @cover_file)
+            end
+
+            self.cover = cover
+            @@latest_filechooser_directory = dialog.current_folder
+          rescue RuntimeError => ex
+            ErrorDialog.new(@book_properties_dialog, ex.message).display
+          end
+        when Gtk::ResponseType::REJECT
+          ## FileUtils.rm_f(@cover_file) # fixing bug #16707
+          @delete_cover_file = true
+
+          self.cover = Icons::BOOK_ICON
+        end
+        dialog.destroy
+      end
+
+      def on_destroy
+        @book_properties_dialog.hide
+        # Stop notebook trying to set tab labels at this time
+        @notebook.show_tabs = false
+      end
+
+      def on_loaned
+        loaned = @checkbutton_loaned.active?
+        @entry_loaned_to.sensitive = loaned
+        @date_loaned_since.sensitive = loaned
+        @label_loaning_duration.visible = loaned
+      end
+
+      def on_loaned_date_changed
+        date_regexes =  [%r{[0123]?[0-9]/[0123]?[0-9]/[0-9]{4}},
+                         /[0-9]{4}-[0123]?[0-9]-[0123]?[0-9]/]
+        matches_regex = false
+        date_regexes.each do |regex|
+          matches_regex = regex.match(@date_loaned_since.text)
+          break if matches_regex
+        end
+        return unless matches_regex
+
+        t = parse_date(@date_loaned_since.text)
+        if t.nil?
+          @label_loaning_duration.label = ""
+          return
+        end
+        loaned_time = Time.at(t)
+        n_days = ((Time.now - loaned_time) / (3600 * 24)).to_i
+        if n_days > 365_250 # 1,000 years
+          @label_loaning_duration.label = ""
+          return
+        end
+        @label_loaning_duration.label = if n_days > 0
+                                          n_("%d day", "%d days", n_days) % n_days
+                                        else
+                                          ""
+                                        end
+      end
+
+      def redd_toggled
+        redd_yes = @checkbutton_redd.active?
+        @redd_date.sensitive = redd_yes
+
+        return unless redd_yes && @redd_date.text.strip.empty?
+
+        # don't do this when popping up the dialog for the first time
+        display_calendar_popup(@redd_date) if @setup_finished
+      end
+
+      private
+
+      def rating=(rating)
+        images = [
+          @image_rating1,
+          @image_rating2,
+          @image_rating3,
+          @image_rating4,
+          @image_rating5
+        ]
+        raise _("out of range") if rating < 0 || rating > images.length
+
+        images[0..rating - 1].each { |x| x.pixbuf = Icons::STAR_SET }
+        images[rating..-1].each { |x| x.pixbuf = Icons::STAR_UNSET }
+        @current_rating = rating
+      end
+
+      def cover=(pixbuf)
+        if pixbuf.width > COVER_MAXWIDTH
+          new_height = pixbuf.height / (pixbuf.width / COVER_MAXWIDTH.to_f)
+          # We don't want to modify in place the given pixbuf,
+          # that's why we make a copy.
+          pixbuf = pixbuf.scale(COVER_MAXWIDTH, new_height)
+        end
+        @image_cover.pixbuf = pixbuf
+      end
+
+      def loaned_since=(time)
+        if time.nil?
+          @date_loaned_since.text = ""
+          @label_loaning_duration.label = ""
+        else
+          @date_loaned_since.text = format_date(time)
+          on_loaned_date_changed
+        end
+        # XXX 'date_changed' signal not automatically called after #time=.
+      end
+
+      def redd_when=(time)
+        @redd_date.text = format_date(time)
+      end
+
+      def parse_date(datestring)
+        # '%m/%d/%Y' for USA and Canada ; or '%Y-%m-%d' for most of Asia
+        # http://en.wikipedia.org/wiki/Calendar_date#Middle_endian_forms.2C_starting_with_the_month
+        date_format = "%d/%m/%Y"
+        begin
+          d = Date.strptime(datestring, date_format)
+          Time.gm(d.year, d.month, d.day)
+        rescue StandardError
+          nil
+        end
+      end
+
+      def format_date(datetime)
+        datetime.strftime("%d/%m/%Y")
+      end
+    end
+  end
+end