bioroebe 0.12.24 → 0.13.31

data/lib/bioroebe/gui/{gtk3 → universal_widgets}/www_finder/www_finder.rb

@@ -2,84 +2,93 @@
 # Encoding: UTF-8
 # frozen_string_literal: true
 # =========================================================================== #
-# === Bioroebe::GUI::Gtk::WwwFinder
+# === Bioroebe::GUI::UniversalWidgets::WwwFinder
+#
+# Usage example:
+#
+#   Bioroebe::GUI::UniversalWidgets::WwwFinder.new(ARGV)
 #
-# This small widget can be used to "generate" random aminoacids quickly.
 # =========================================================================== #
-# require 'bioroebe/gui/gtk3/gtk3_standalone/gtk3_standalone.rb'
-# Bioroebe::GUI::Gtk::WwwFinder.run
+# require 'bioroebe/gui/universal_widgets/show_codon_usage/show_codon_usage.rb'
 # =========================================================================== #
-require 'gtk_paradise/require_gtk3'
+require 'universal_widgets/base/base.rb'
 
 module Bioroebe
 
 module GUI
 
-module Gtk
+module UniversalWidgets
 
-class WwwFinder < ::Gtk::Box # === Bioroebe::GUI::Gtk::WwwFinder 
+class WwwFinder < ::UniversalWidgets::Base # === Bioroebe::GUI::UniversalWidgets::WwwFinder
 
-  begin
-    require 'open'
-  rescue LoadError; end
+  require 'bioroebe/base/commandline_application/commandline_arguments.rb'
+  include ::Bioroebe::CommandlineArguments
+
+  require 'bioroebe/constants/GUIs.rb'
+  include Bioroebe::GUI
+
+  require 'bioroebe/toplevel_methods/toplevel_methods.rb'
 
   begin
-    require 'colours'
-    include ::Colours
+    require 'open'
   rescue LoadError; end
 
-  require 'bioroebe/constants/GUIs.rb'
-  include ::Bioroebe::GUI
+  # ========================================================================= #
+  # === TITLE
+  #
+  # Specify which title to use for this small widget.
+  # ========================================================================= #
+  TITLE = 'WWW-Finder'
 
-  require 'gtk_paradise/requires/require_the_base_module.rb'
-  include ::Gtk::BaseModule
-  
   # ========================================================================= #
-  # === NAMESPACE
+  # === WIDTH
   # ========================================================================= #
-  NAMESPACE = inspect
+  WIDTH = '65% or 600px minimum'
 
   # ========================================================================= #
-  # === TITLE
+  # === HEIGHT
   # ========================================================================= #
-  TITLE = 'WWW-Finder'
+  HEIGHT = '55% or 400px minimum'
 
   # ========================================================================= #
-  # === BASE_URL_FOR_DBGET
+  # === MONOSPACED_FONT
+  #
+  # When this font is changed, don't forget to also change the font
+  # at SMALLER_FONT.
   # ========================================================================= #
-  BASE_URL_FOR_DBGET =
-    '"https://www.genome.ad.jp/dbget-bin/www_bfind_sub?mode=bfind&max_hit=1200&dbkey=kegg&keywords='.dup
+  MONOSPACED_FONT = :hack_20
+    USE_THIS_FONT = MONOSPACED_FONT
 
   # ========================================================================= #
-  # === BASE_URL_FOR_NCBI
+  # === SMALLER_FONT
   # ========================================================================= #
-  BASE_URL_FOR_NCBI =
-    '"https://www.ncbi.nlm.nih.gov/gquery/gquery.fcgi?term='
+  SMALLER_FONT = :hack_16
 
   # ========================================================================= #
-  # === WIDTH
+  # === USE_THIS_SLIGHTLY_SMALLER_FONT
   # ========================================================================= #
-  WIDTH = 580
+  USE_THIS_SLIGHTLY_SMALLER_FONT = :hack_16
 
   # ========================================================================= #
-  # === HEIGHT
+  # === BASE_URL_FOR_DBGET
   # ========================================================================= #
-  HEIGHT = 720
+  BASE_URL_FOR_DBGET =
+    '"https://www.genome.ad.jp/dbget-bin/www_bfind_sub?mode=bfind&max_hit=1200&dbkey=kegg&keywords='.dup
 
   # ========================================================================= #
-  # === USE_THIS_FONT
+  # === BASE_URL_FOR_NCBI
   # ========================================================================= #
-  USE_THIS_FONT = :dejavu_condensed_22
+  BASE_URL_FOR_NCBI =
+    '"https://www.ncbi.nlm.nih.gov/gquery/gquery.fcgi?term='
 
   # ========================================================================= #
   # === initialize
   # ========================================================================= #
   def initialize(
-      commandline_arguments = ARGV,
+      commandline_arguments = nil,
       run_already           = true
     )
-    super(:vertical)
-    register_sigint
+    determine_the_GUI_to_be_used(commandline_arguments)
     reset
     set_commandline_arguments(
       commandline_arguments
@@ -91,15 +100,19 @@ class WwwFinder < ::Gtk::Box # === Bioroebe::GUI::Gtk::WwwFinder
   # === reset                                                     (reset tag)
   # ========================================================================= #
   def reset
+    super() if respond_to?(:super)
     reset_the_internal_variables
+    reset_the_base_module # This must come after reset_the_internal_variables().
+    infer_the_namespace
     # ======================================================================= #
     # === @configuration
     # ======================================================================= #
-    @configuration = [true, __dir__, NAMESPACE]
+    @configuration = [true, __dir__, namespace?]
+    # ======================================================================= #
+    # === Set the title, width, height and the font in use.
+    # ======================================================================= #
     title_width_height_font(TITLE, WIDTH, HEIGHT, USE_THIS_FONT)
-    use_gtk_paradise_project_css_file
-    append_project_css_file 
-    infer_the_size_automatically
+    handle_CSS if use_gtk3?
     # ======================================================================= #
     # === @button_quit
     # ======================================================================= #
@@ -107,75 +120,25 @@ class WwwFinder < ::Gtk::Box # === Bioroebe::GUI::Gtk::WwwFinder
     # ======================================================================= #
     # === @v_box
     # ======================================================================= #
-    @v_box = gtk_vbox
-    background_colour :slateblue
-  end
-
-  # ========================================================================= #
-  # === padding?
-  # ========================================================================= #
-  def padding?
-    4
-  end
-
-  # ========================================================================= #
-  # === border_size?
-  # ========================================================================= #
-  def border_size?
-    0
+    @v_box = create_vbox
   end
 
   # ========================================================================= #
-  # === create_skeleton                                          (create tag)
-  # ========================================================================= #
-  def create_skeleton
-    create_menu
-    create_check_boxes    
-    create_entries
-    create_buttons
-    create_vbox
-  end
-  
-  # ========================================================================= #
-  # === create_menu
-  #
-  # This creates the menu.
-  # ========================================================================= #
-  def create_menu
-    begin
-      require 'gtk_paradise/widgets/version_agnostic/my_image_menu_item.rb'
-    rescue LoadError => error
-      pp error
-    end
-    @menu_bar = gtk_menu_bar
-    @menu_item = gtk_menu_item('Menu')
-    @first_submenu = gtk_menu
-    @item1 = image_menu_item('foo',nil,0)
-    @item1.signal_connect(:activate) { do_something }
-    @first_submenu << @item1
-    @item2 = image_menu_item('bar',nil,3)
-    @item2.signal_connect(:activate) { e 'test 2' }
-    @first_submenu << @item2
-    @menu_item.set_submenu(@first_submenu)
-    @menu_bar.append(@menu_item) 
-  end
-
-  # ========================================================================= #
-  # === create_check_boxes
+  # === create_the_check_boxes
   #
   # Creates the check boxes. On startup, we synchronize this.
   # ========================================================================= #
-  def create_check_boxes
+  def create_the_check_boxes
     @checkbox_synchronize = check_button('Synchronize On', false)
     @checkbox_synchronize.set_active(true)
   end
 
   # ========================================================================= #
-  # === create_entries
+  # === create_the_entries
   #
   # entries tag.
   # ========================================================================= #
-  def create_entries
+  def create_the_entries
     @entry_dbget   = create_entry_with_text_and_max_length('alzheimer')
     # ======================================================================= #
     # ensembl entry
@@ -208,43 +171,69 @@ class WwwFinder < ::Gtk::Box # === Bioroebe::GUI::Gtk::WwwFinder
   end
 
   # ========================================================================= #
-  # === target_for
+  # === padding?
   # ========================================================================= #
-  def target_for(i)
-    _ = ''.dup
-    case i # case tag
-    # ======================================================================= #
-    # === :ensembl
-    # ======================================================================= #
-    when :ensembl
-      _ << '"https://www.ensembl.org/Human/Search/Results?q='
-      _ << @entry_ensembl.text+';name=Search;facet_species=Human"'
-    # ======================================================================= #
-    # === :dbget
-    # ======================================================================= #
-    when :dbget
-      _ << BASE_URL_FOR_DBGET
-      _ << @entry_dbget.text+'"'
-    # ======================================================================= #
-    # === :ncbi
-    # ======================================================================= #
-    when :ncbi
-      _ << BASE_URL_FOR_NCBI
-      _ << @entry_ncbi.text+'"'
+  def padding?
+    8
+  end
+
+  # ========================================================================= #
+  # === border_size?
+  # ========================================================================= #
+  def border_size?
+    2
+  end
+
+  # ========================================================================= #
+  # === main_font?
+  # ========================================================================= #
+  def main_font?
+    USE_THIS_FONT
+  end
+
+  # ========================================================================= #
+  # === slightly_smaller_font?
+  # ========================================================================= #
+  def slightly_smaller_font?
+    USE_THIS_SLIGHTLY_SMALLER_FONT
+  end
+
+  # ========================================================================= #
+  # === handle_CSS_rules                                   (CSS tag, css tag)
+  # ========================================================================= #
+  def handle_CSS_rules
+    use_gtk_paradise_project_css_file
+    append_project_css_file
+    add_these_custom_CSS_rules '
+
+    '
+    apply_the_CSS_rules
+  end; alias handle_CSS handle_CSS_rules # === handle_CSS
+
+  # ========================================================================= #
+  # === focus_entry
+  #
+  # This helps you to focus an entry.
+  # ========================================================================= #
+  def focus_entry(which_entry)
+    case which_entry.to_s
+    when '1' then @entry_dbget.do_focus
+    when '2' then @entry_ncbi.do_focus
+    when '3' then @entry_nih.do_focus
+    when '4' then @entry_ensembl.do_focus
     end
-    return _
   end
 
   # ========================================================================= #
-  # === create_buttons                              (button tag, buttons tag)
+  # === create_the_buttons                          (button tag, buttons tag)
   # ========================================================================= #
-  def create_buttons
+  def create_the_buttons
     @button_quit = coloured_quit_button(colour: 'honeydew')
     # ======================================================================= #
     # === @button_search_dbget
     # ======================================================================= #
     @button_search_dbget = coloured_button('_DBGET_ivory')
-    @button_search_dbget.signal_connect(:clicked) { |w|
+    @button_search_dbget.on_clicked { |w|
       e rev+'Searching DBGET for: '+sfancy(@entry_dbget.text)
       open_in_browser target_for(:dbget)
     }
@@ -253,7 +242,7 @@ class WwwFinder < ::Gtk::Box # === Bioroebe::GUI::Gtk::WwwFinder
     # === @button_ensembl
     # ======================================================================= #
     @button_ensembl = coloured_button('_Ensembl_lightblue')
-    @button_ensembl.signal_connect(:clicked) { |w|
+    @button_ensembl.on_clicked { |w|
       e rev+'Searching ENSEMBL for: '+sfancy(@entry_ensembl.text)
       open_in_browser target_for(:ensembl)
     }
@@ -261,16 +250,16 @@ class WwwFinder < ::Gtk::Box # === Bioroebe::GUI::Gtk::WwwFinder
     # === @button_search_ncbi
     # ======================================================================= #
     @button_search_ncbi = coloured_button('_NCBISearch_lightblue')
-    @button_search_ncbi.signal_connect(:clicked) { |w|
+    @button_search_ncbi.on_clicked { |w|
       e rev+'Searching ncbi for: '+sfancy(@entry_ncbi.text)
       open_in_browser target_for(:ncbi)
     }
-    @button_search_ncbi.fancy_tooltip = BASE_URL_FOR_NCBI.delete('"')
+    @button_search_ncbi.hint_URL_FOR_NCBI.delete('"')
     # ======================================================================= #
     # === @button_search_nih
     # ======================================================================= #
     @button_search_nih = coloured_button('_NIHSearch_lightblue')
-    @button_search_nih.signal_connect(:clicked) { |w|
+    @button_search_nih.on_clicked { |w|
       e rev+'Searching NIH for: '+sfancy(@entry_nih.text)
       target = '"https://search2.google.cit.nih.gov/search?'
       target << 'client=NIH_frontend&site=NIH_Master&output=xml_no_dtd&'
@@ -286,24 +275,38 @@ class WwwFinder < ::Gtk::Box # === Bioroebe::GUI::Gtk::WwwFinder
   end
 
   # ========================================================================= #
-  # === focus_entry
-  #
-  # This helps you to focus an entry.
+  # === target_for
   # ========================================================================= #
-  def focus_entry(which_entry)
-    case which_entry.to_s
-    when '1' then @entry_dbget.do_focus
-    when '2' then @entry_ncbi.do_focus
-    when '3' then @entry_nih.do_focus
-    when '4' then @entry_ensembl.do_focus
+  def target_for(i)
+    _ = ''.dup
+    case i # case tag
+    # ======================================================================= #
+    # === :ensembl
+    # ======================================================================= #
+    when :ensembl
+      _ << '"https://www.ensembl.org/Human/Search/Results?q='
+      _ << @entry_ensembl.text+';name=Search;facet_species=Human"'
+    # ======================================================================= #
+    # === :dbget
+    # ======================================================================= #
+    when :dbget
+      _ << BASE_URL_FOR_DBGET
+      _ << @entry_dbget.text+'"'
+    # ======================================================================= #
+    # === :ncbi
+    # ======================================================================= #
+    when :ncbi
+      _ << BASE_URL_FOR_NCBI
+      _ << @entry_ncbi.text+'"'
     end
+    return _
   end
 
   # ========================================================================= #
-  # === create_vbox
+  # === create_the_primary_vbox
   # ========================================================================= #
-  def create_vbox
-    @frame = gtk_frame
+  def create_the_primary_vbox
+    @frame = create_frame
     @frame.label_widget = modify_bold_label('Search for BioStuff: ','slateblue')
     @v_box.minimal(@menu_bar,2) 
     @v_box.minimal(@entry_dbget,6)
@@ -317,7 +320,49 @@ class WwwFinder < ::Gtk::Box # === Bioroebe::GUI::Gtk::WwwFinder
     @v_box.minimal(@checkbox_synchronize,6)
     # The quit button can be found on the very bottom.
     @v_box.maximal(@button_quit, 6)
-    @frame = gtk_frame(@v_box) # And this is the main frame.
+    @frame = create_frame(@v_box) # And this is the main frame.
+  end
+
+  # ========================================================================= #
+  # === create_the_menu
+  #
+  # This creates the menu.
+  # ========================================================================= #
+  def create_the_menu
+    begin
+      require 'gtk_paradise/widgets/version_agnostic/my_image_menu_item.rb'
+    rescue LoadError => error
+      pp error
+    end
+    @menu_bar = create_menu_bar
+    @menu_item = create_menu_item('Menu')
+    @first_submenu = create_menu
+    @item1 = image_menu_item('foo',nil,0)
+    @item1.signal_connect(:activate) { do_something }
+    @first_submenu << @item1
+    @item2 = image_menu_item('bar',nil,3)
+    @item2.signal_connect(:activate) { e 'test 2' }
+    @first_submenu << @item2
+    @menu_item.set_submenu(@first_submenu)
+    @menu_bar.append(@menu_item) 
+  end
+
+  # ========================================================================= #
+  # === create_the_skeleton                        (create tag, skeleton tag)
+  # ========================================================================= #
+  def create_the_skeleton
+    create_the_entries
+    create_the_check_boxes
+    create_the_buttons
+    create_the_primary_vbox
+    create_the_menu
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    run_super
   end
 
   # ========================================================================= #
@@ -328,18 +373,32 @@ class WwwFinder < ::Gtk::Box # === Bioroebe::GUI::Gtk::WwwFinder
   end
 
   # ========================================================================= #
-  # === connect_skeleton                                        (connect tag)
+  # === connect_the_skeleton                      (connect tag, skeleton tag)
   # ========================================================================= #
-  def connect_skeleton
+  def connect_the_skeleton
     abort_on_exception
-    pack_start(@frame)
+
+    window = runner_widget(nil, width?, height?, title?)
+    window << @frame
+
+    ::UniversalWidgets.set_main_window(window)
+    upon_delete_event_quit_the_application
+    
+    window.use_this_font = font?
+    window.show_all
+    window.set_size_request(width?, height?)
+    window.set_default_size(width?, height?)
+    window.set_padding(padding?)
+    window.set_border_size(border_size?)
+    window.top_left
+    run_main
   end
 
   # ========================================================================= #
-  # === run                                                         (run tag)
+  # === Bioroebe::GUI::UniversalWidgets::WwwFinder[]
   # ========================================================================= #
-  def run
-    create_skeleton_then_connect_skeleton
+  def self.[](i = ARGV)
+    new(i)
   end
 
   # ========================================================================= #
@@ -348,20 +407,20 @@ class WwwFinder < ::Gtk::Box # === Bioroebe::GUI::Gtk::WwwFinder
   def self.run(
       i = ARGV
     )
-    require 'gtk_paradise/run'
-    _ = ::Bioroebe::GUI::Gtk::WwwFinder.new(i)
-    r = ::Gtk.run
-    r << _
+    r = ::Gtk.runner_factory(
+      ::Bioroebe::GUI::Gtk::WwwFinder.new(i)
+    )
     r.add_shortcut(1, 'focus_entry(1)', :alt)
     r.add_shortcut(2, 'focus_entry(2)', :alt)
     r.add_shortcut(3, 'focus_entry(3)', :alt)
     r.add_shortcut(4, 'focus_entry(4)', :alt)
     r.background_colour :white
-    r.automatic_top_left_then_run
-  end; self.instance_eval { alias start_gui_application run } # === Bioroebe::GUI::Gtk::WwwFinder.start_gui_application
+    return r
+  end; self.instance_eval { alias run_gtk3_widget       run } # === Bioroebe::GUI::Gtk::WwwFinder.run_gtk3_widget
+       self.instance_eval { alias start_gui_application run } # === Bioroebe::GUI::Gtk::WwwFinder.start_gui_application
 
 end; end; end; end
 
 if __FILE__ == $PROGRAM_NAME
-  Bioroebe::GUI::Gtk::WwwFinder.run
-end
+  Bioroebe::GUI::UniversalWidgets::WwwFinder.new(ARGV)
+end # gtkRestrictionEnzymes