alexandria-book-collection-manager 0.7.1 → 0.7.6

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

@@ -1,46 +1,36 @@
-# Copyright (C) 2004-2006 Laurent Sansonetti
-# 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 "alexandria/ui/smart_library_rule_box"
 
 module Alexandria
   module UI
-    class SmartLibraryPropertiesDialogBase < Gtk::Dialog
+    class SmartLibraryPropertiesDialogBase
       include Logging
       include GetText
-      GetText.bindtextdomain(Alexandria::TEXTDOMAIN, charset: 'UTF-8')
+      GetText.bindtextdomain(Alexandria::TEXTDOMAIN, charset: "UTF-8")
 
-      attr_reader :predicate_operator_rule
+      attr_reader :predicate_operator_rule, :dialog
 
       def initialize(parent)
-        super(title: '',
-              parent: parent,
-              flags: :modal,
-              buttons: [[Gtk::Stock::HELP, :help]])
+        @dialog = Gtk::Dialog.new(title: "",
+                                  parent: parent,
+                                  flags: :modal,
+                                  buttons: [[Gtk::Stock::HELP, :help]])
 
-        self.window_position = :center
-        self.resizable = true
-        self.border_width = 4
-        child.border_width = 12
+        @dialog.window_position = :center
+        @dialog.resizable = true
+        @dialog.border_width = 4
+        @dialog.child.border_width = 12
 
         main_box = Gtk::Box.new :vertical
         main_box.border_width = 4
         main_box.spacing = 8
 
-        child << main_box
+        @dialog.child << main_box
 
         @smart_library_rules = []
 
@@ -62,36 +52,58 @@ module Alexandria
         setup_calendar_widgets
       end
 
-      protected
+      def handle_date_icon_press(widget, primary, _icon)
+        display_calendar_popup(widget) if primary.nick == "primary"
+      end
 
-      def smart_library_rules
-        fill_smart_library_rules_values
-        @smart_library_rules
+      def handle_add_rule_clicked
+        insert_new_rule
+      end
+
+      def handle_remove_rule_clicked(box_controller)
+        remove_rule_box(box_controller.rule_box)
+      end
+
+      # TODO: Move logic to SmartLibraryRuleBox
+      def apply_smart_rule_for_rule_box(rule_box, operand, operation)
+        idx = @rules_box.children.index(rule_box)
+        smart_library_rules[idx] ||= SmartLibrary::Rule.new(operand,
+                                                            operation.first,
+                                                            nil)
+        new_rule = smart_library_rules[idx]
+        new_rule.operand = operand
+        new_rule.operation = operation.first
+        new_rule.value = nil
       end
 
+      protected
+
+      attr_reader :smart_library_rules
+
       def has_weirdnesses?
         fill_smart_library_rules_values
         smart_library_rules.each do |rule|
-          return true if rule.value == ''
+          return true if rule.value == ""
         end
         false
       end
 
       def user_confirms_possible_weirdnesses_before_saving?
         return true unless has_weirdnesses?
+
         dialog = AlertDialog.new(
-          self,
-          _('Empty or conflictive condition'),
+          @dialog,
+          _("Empty or conflictive condition"),
           Gtk::Stock::DIALOG_QUESTION,
-          [[Gtk::Stock::CANCEL, :cancel],
-           [_('_Save However'), :yes]],
-          _('This smart library contains one or more conditions ' \
-            'which are empty or conflict with each other. This is ' \
-            'likely to result in never matching a book. Are you ' \
-            'sure you want to save this library?'))
+          [[Gtk::Stock::CANCEL, Gtk::ResponseType::CANCEL],
+           [_("_Save However"), Gtk::ResponseType::YES]],
+          _("This smart library contains one or more conditions " \
+            "which are empty or conflict with each other. This is " \
+            "likely to result in never matching a book. Are you " \
+            "sure you want to save this library?"))
         dialog.default_response = Gtk::ResponseType::CANCEL
         dialog.show_all
-        confirmed = dialog.run == :yes
+        confirmed = dialog.run == Gtk::ResponseType::YES
         dialog.destroy
         confirmed
       end
@@ -102,19 +114,20 @@ module Alexandria
         if @rules_box.children.length > 1
           label1 = Gtk::Label.new
           label1.set_alignment(0.0, 0.5)
-          label1.text = _('Match')
+          label1.text = _("Match")
 
           cb = Gtk::ComboBoxText.new
-          [_('all'), _('any')].each { |x| cb.append_text(x) }
-          cb.signal_connect('changed') do
-            @predicate_operator_rule = cb.active.zero? ? SmartLibrary::ALL_RULES : SmartLibrary::ANY_RULE
+          [_("all"), _("any")].each { |x| cb.append_text(x) }
+          cb.signal_connect("changed") do
+            @predicate_operator_rule =
+              cb.active.zero? ? SmartLibrary::ALL_RULES : SmartLibrary::ANY_RULE
           end
           cb.active =
             predicate_operator_rule == SmartLibrary::ALL_RULES ? 0 : 1
 
           label2 = Gtk::Label.new
           label2.set_alignment(0.0, 0.5)
-          label2.text = _('of the following rules:')
+          label2.text = _("of the following rules:")
 
           @rules_header_box.pack_start(label1, expand: false, fill: false)
           @rules_header_box.pack_start(cb, expand: false, fill: false)
@@ -122,7 +135,7 @@ module Alexandria
         else
           label = Gtk::Label.new
           label.set_alignment(0.0, 0.5)
-          label.text = _('Match the following rule:')
+          label.text = _("Match the following rule:")
           @rules_header_box << label
           @predicate_operator_rule = SmartLibrary::ALL_RULES
         end
@@ -130,149 +143,59 @@ module Alexandria
         @rules_header_box.show_all
       end
 
-      def insert_new_rule(rule = nil)
-        rule_box = Gtk::Box.new :horizontal
-        rule_box.spacing = 8
-
-        left_operand_combo = Gtk::ComboBoxText.new
-        operator_combo = Gtk::ComboBoxText.new
-
-        value_entry = Gtk::Entry.new
-
-        date_entry = Gtk::Entry.new
-        date_entry.primary_icon_name = Gtk::Stock::EDIT
-        date_entry.primary_icon_activatable = true
-        date_entry.signal_connect('icon-press') do |entry, primary, _icon|
-          if primary.nick == 'primary'
-            display_calendar_popup(entry)
-          end
-        end
-
-        # Really hide the time part of the date entry, as the constructor
-        # does not seem to do it...
-        # ##date_entry.children[2..3].each { |x| date_entry.remove(x) }
-        # ##date_entry.spacing = 8
-        entry_label = Gtk::Label.new('')
-
-        add_button = Gtk::Button.new(label: '')
-        add_button.remove(add_button.children.first)
-        add_button << Gtk::Image.new(stock: Gtk::Stock::ADD,
-                                     size: Gtk::IconSize::BUTTON)
-
-        add_button.signal_connect('clicked') { insert_new_rule }
-
-        remove_button = Gtk::Button.new(label: '')
-        remove_button.remove(remove_button.children.first)
-        remove_button << Gtk::Image.new(stock: Gtk::Stock::REMOVE,
-                                        size: Gtk::IconSize::BUTTON)
-
-        remove_button.signal_connect('clicked') do |_button|
-          idx = @rules_box.children.index(rule_box)
-          raise if idx.nil?
-          @smart_library_rules.delete_at(idx)
-          @rules_box.remove(rule_box)
-          sensitize_remove_rule_buttons
-          update_rules_header_box
-        end
-
-        operands = SmartLibrary::Rule::Operands::LEFT
-        operands.each do |operand|
-          left_operand_combo.append_text(operand.name)
-        end
-        operator_combo.signal_connect('changed') do
-          operand = operands[left_operand_combo.active]
-          operations = SmartLibrary::Rule.operations_for_operand(operand)
-          operation = operations[operator_combo.active]
-
-          value_entry.visible = date_entry.visible = entry_label.visible = false
-          right_operand = operation.last
-          unless right_operand.nil?
-            entry = case right_operand.klass.name
-                    when 'Time'
-                      date_entry
-                    else
-                      value_entry
-                    end
-            entry.visible = true
-            unless right_operand.name.nil?
-              entry_label.text = right_operand.name
-              entry_label.visible = true
-            end
-          end
-
-          idx = @rules_box.children.index(rule_box)
-          new_rule = @smart_library_rules[idx]
-          if new_rule.nil?
-            new_rule = SmartLibrary::Rule.new(operand,
-                                              operation.first,
-                                              nil)
-            @smart_library_rules << new_rule
-          end
-          new_rule.operand = operand
-          new_rule.operation = operation.first
-          new_rule.value = nil
-        end
-        left_operand_combo.signal_connect('changed') do
-          operand = operands[left_operand_combo.active]
-          operator_combo.freeze_notify do
-            operator_combo.remove_all
-            operations = SmartLibrary::Rule.operations_for_operand(operand)
-            operations.each do |operation|
-              operator = operation.first
-              operator_combo.append_text(operator.name)
-            end
-            operator_combo.active = 0
-          end
-        end
-
-        rule_box.pack_start(left_operand_combo, expand: false, fill: false)
-        rule_box.pack_start(operator_combo, expand: false, fill: false)
-        rule_box.pack_start(value_entry)
-        rule_box.pack_start(date_entry)
-        rule_box.pack_start(entry_label, expand: false, fill: false)
-        rule_box.pack_end(remove_button, expand: false, fill: false)
-        rule_box.pack_end(add_button, expand: false, fill: false)
-
+      def make_rule_box(rule = nil)
+        box_controller = SmartLibraryRuleBox.new self
+        rule_box = box_controller.rule_box
         rule_box.show_all
-        value_entry.visible = date_entry.visible = entry_label.visible = false
-
         @rules_box.pack_start(rule_box, expand: false, fill: true)
 
         if rule
+          operands = SmartLibrary::Rule::Operands::LEFT
           operand_idx = operands.index(rule.operand)
           operations =
             SmartLibrary::Rule.operations_for_operand(rule.operand)
           operation_idx = operations.map(&:first).index(rule.operation)
 
           if !operand_idx.nil? && !operation_idx.nil?
-            left_operand_combo.active = operand_idx
-            operator_combo.active = operation_idx
+            box_controller.left_operand_combo.active = operand_idx
+            box_controller.operator_combo.active = operation_idx
             unless rule.value.nil?
               case rule.value
               when String
-                value_entry.text = rule.value
+                box_controller.value_entry.text = rule.value
               when Time
-                date_entry.text = format_date(rule.value)
+                box_controller.date_entry.text = format_date(rule.value)
               end
             end
           end
         else
-          left_operand_combo.active = 0
+          box_controller.left_operand_combo.active = 0
         end
+      end
 
+      def insert_new_rule(rule = nil)
+        make_rule_box(rule)
         @rules_box.check_resize # force a layout
         update_rules_header_box
         sensitize_remove_rule_buttons
       end
 
+      def remove_rule_box(rule_box)
+        idx = @rules_box.children.index(rule_box)
+        raise if idx.nil?
+
+        smart_library_rules.delete_at(idx)
+        @rules_box.remove(rule_box)
+        sensitize_remove_rule_buttons
+        update_rules_header_box
+      end
+
       def sensitize_remove_rule_buttons
         boxes = @rules_box.children
         state = boxes.length > 1
         boxes.each do |box|
           button = box.children[-1]
-          if button.is_a?(Gtk::Button)
-            button.sensitive = state
-          end
+          button.sensitive = state if button.is_a?(Gtk::Button)
         end
       end
 
@@ -285,7 +208,7 @@ module Alexandria
           elsif date.visible?
             begin
               value = parse_date(date.text)
-            rescue => ex
+            rescue StandardError => ex
               trace = ex.backtrace.join("\n > ")
               log.warn { "Possibly invalid date entered #{ex.message}" }
               log.warn { "Date widget returned #{date.text} / #{trace}" }
@@ -294,7 +217,7 @@ module Alexandria
               value = Time.now
             end
           end
-          @smart_library_rules[i].value = value
+          smart_library_rules[i].value = value
         end
       end
 
@@ -309,14 +232,14 @@ module Alexandria
         @calendar_popup.skip_pager_hint = true
         @calendar_popup.events = [:focus_change_mask]
 
-        @calendar_popup.set_transient_for(self)
+        @calendar_popup.set_transient_for(@dialog)
         @calendar_popup.set_type_hint(:dialog)
-        @calendar_popup.name = 'calendar-popup'
+        @calendar_popup.name = "calendar-popup"
         @calendar_popup.resizable = false
         # @calendar_popup.border_width = 4
         # @calendar_popup.app_paintable = true
 
-        @calendar_popup.signal_connect('focus-out-event') do |_popup, _event|
+        @calendar_popup.signal_connect("focus-out-event") do |_popup, _event|
           hide_calendar_popup
           false
         end
@@ -324,7 +247,7 @@ module Alexandria
         @calendar = Gtk::Calendar.new
         @calendar_popup.add(@calendar)
 
-        @calendar.signal_connect('day-selected') do
+        @calendar.signal_connect("day-selected") do
           date_arr = @calendar.date
           year = date_arr[0]
           month = date_arr[1] # + 1 # gtk : months 0-indexed, Time.gm : 1-index
@@ -335,7 +258,7 @@ module Alexandria
           end
         end
 
-        @calendar.signal_connect('day-selected-double-click') do
+        @calendar.signal_connect("day-selected-double-click") do
           date_arr = @calendar.date
           year = date_arr[0]
           month = date_arr[1] # + 1 # gtk : months 0-indexed, Time.gm : 1-index
@@ -404,18 +327,19 @@ module Alexandria
       end
 
       def parse_date(datestring)
-        date_format = '%d/%m/%Y' # or '%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
+        # '%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
+        rescue StandardError
           nil
         end
       end
 
       def format_date(datetime)
-        datetime.strftime('%d/%m/%Y')
+        datetime.strftime("%d/%m/%Y")
       end
     end
   end

data/lib/alexandria/ui/smart_library_rule_box.rb

@@ -0,0 +1,119 @@
+# 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 SmartLibraryRuleBox
+      attr_accessor :rule_box,
+                    :left_operand_combo, :operator_combo,
+                    :value_entry, :date_entry, :entry_label,
+                    :add_button, :remove_button
+
+      def initialize(parent)
+        @parent = parent
+
+        self.rule_box = Gtk::Box.new :horizontal
+        rule_box.spacing = 8
+
+        self.left_operand_combo = Gtk::ComboBoxText.new
+        self.operator_combo = Gtk::ComboBoxText.new
+
+        self.value_entry = Gtk::Entry.new
+
+        self.date_entry = Gtk::Entry.new.tap do |entry|
+          entry.primary_icon_name = Gtk::Stock::EDIT
+
+          entry.primary_icon_activatable = true
+          entry.signal_connect("icon-press") do |widget, primary, _icon|
+            @parent.handle_date_icon_press(widget, primary, icon)
+          end
+        end
+
+        self.entry_label = Gtk::Label.new("")
+
+        self.add_button = Gtk::Button.new(label: "").tap do |widget|
+          widget.remove(widget.children.first)
+          widget << Gtk::Image.new(stock: Gtk::Stock::ADD,
+                                   size: Gtk::IconSize::BUTTON)
+
+          widget.signal_connect("clicked") { @parent.handle_add_rule_clicked }
+        end
+
+        self.remove_button = Gtk::Button.new(label: "")
+        remove_button.remove(remove_button.children.first)
+        remove_button << Gtk::Image.new(stock: Gtk::Stock::REMOVE,
+                                        size: Gtk::IconSize::BUTTON)
+
+        remove_button.signal_connect("clicked") do |_button|
+          @parent.handle_remove_rule_clicked(self)
+        end
+
+        operands.each do |operand|
+          left_operand_combo.append_text(operand.name)
+        end
+
+        operator_combo.signal_connect("changed") do
+          handle_operator_changed
+        end
+
+        left_operand_combo.signal_connect("changed") do
+          handle_left_operand_changed
+        end
+
+        rule_box.pack_start(left_operand_combo, expand: false, fill: false)
+        rule_box.pack_start(operator_combo, expand: false, fill: false)
+        rule_box.pack_start(value_entry)
+        rule_box.pack_start(date_entry)
+        rule_box.pack_start(entry_label, expand: false, fill: false)
+        rule_box.pack_end(remove_button, expand: false, fill: false)
+        rule_box.pack_end(add_button, expand: false, fill: false)
+
+        value_entry.visible = date_entry.visible = entry_label.visible = false
+      end
+
+      def operands
+        SmartLibrary::Rule::Operands::LEFT
+      end
+
+      def handle_operator_changed
+        operand = operands[left_operand_combo.active]
+        operations = SmartLibrary::Rule.operations_for_operand(operand)
+        operation = operations[operator_combo.active]
+
+        value_entry.visible = date_entry.visible = entry_label.visible = false
+        right_operand = operation.last
+        unless right_operand.nil?
+          entry = case right_operand.klass.name
+                  when "Time"
+                    date_entry
+                  else
+                    value_entry
+                  end
+          entry.visible = true
+          unless right_operand.name.nil?
+            entry_label.text = right_operand.name
+            entry_label.visible = true
+          end
+        end
+
+        @parent.apply_smart_rule_for_rule_box(rule_box, operand, operation)
+      end
+
+      def handle_left_operand_changed
+        operand = operands[left_operand_combo.active]
+        operator_combo.freeze_notify do
+          operator_combo.remove_all
+          operations = SmartLibrary::Rule.operations_for_operand(operand)
+          operations.each do |operation|
+            operator = operation.first
+            operator_combo.append_text(operator.name)
+          end
+          operator_combo.active = 0
+        end
+      end
+    end
+  end
+end