open 0.1.30 → 0.2.13

data/lib/open/base/base.rb

@@ -2,56 +2,127 @@
 # Encoding: UTF-8
 # frozen_string_literal: true
 # =========================================================================== #
+# === Open::Base
+#
+# Usage example:
+#
+#   Open::Base.new(ARGV)
+#
+# =========================================================================== #
 # require 'open/base/base.rb'
-# < Base
+# < ::Open::Base
 # =========================================================================== #
 module Open
 
 class Base # === Open::Base
 
-  require 'yaml'
+  alias e puts
 
   require 'fileutils'
-
-  begin
-    require 'colours'
-    include Colours::E
-  rescue LoadError; end
-
-  begin
-    require 'beautiful_url'
-  rescue LoadError
-    # puts 'BeautifulUrl is not available.'
-  end
+  require 'open/requires/require_yaml.rb'
+  require 'open/constants/constants.rb'
+  require 'open/project/project.rb'
+  require 'open/toplevel_methods/delay.rb'
+  require 'open/toplevel_methods/misc.rb'
+  require 'open/toplevel_methods/host_os.rb'
 
   begin
     require 'opn'
   rescue LoadError; end
 
   begin
-    require 'convert_global_env'
+    require 'roebe/classes/find_expanded_alias.rb'
   rescue LoadError; end
 
   begin
-    require 'roebe/classes/find_expanded_alias.rb'
+    require 'colours'
+    include Colours::E
   rescue LoadError; end
 
-  require 'open/constants/constants.rb'
-  require 'open/toplevel_code/toplevel_code.rb'
-
   # ========================================================================= #
   # === NAMESPACE
   # ========================================================================= #
   NAMESPACE = inspect
 
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(i = ARGV)
+    set_commandline_arguments(i)
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    # ======================================================================= #
+    # === @namespace
+    # ======================================================================= #
+    @namespace = NAMESPACE
+    # ======================================================================= #
+    # === @be_verbose
+    # ======================================================================= #
+    @be_verbose = true
+  end
+
+  require 'open/toplevel_methods/is_on_windows.rb'
+  # ========================================================================= #
+  # === is_on_windows?
+  # ========================================================================= #
+  def is_on_windows?(
+      i = ::Open.host_os?
+    )
+    ::Open.is_on_windows?(i)
+  end; alias on_windows? is_on_windows? # === on_windows?
+
+  # ========================================================================= #
+  # === esystem                                                 (esystem tag)
+  #
+  # This method contains a bit of an ad-hoc fix to make this work on
+  # windows as well.
+  #
+  # Eventually may have to rewrite the method a little bit, but for now
+  # (September 2021) this has to suffice.
+  # ========================================================================= #
+  def esystem(
+      i,
+      do_show_the_command_that_will_be_used = true # This is the default.
+    )
+    if is_on_windows?
+      # i = i.to_s.sub(/\\/,'\\') if i.include?("\\")
+      i = '"'+i.to_s+'"' if i.include?(' ')
+    end
+    e i if do_show_the_command_that_will_be_used
+    system(i)
+  end
+
+  # ========================================================================= #
+  # === return_pwd
+  # ========================================================================= #
+  def return_pwd
+    "#{Dir.pwd}/".squeeze('/')
+  end
+
+  # ========================================================================= #
+  # == snakecase
+  # ========================================================================= #
+  def snakecase(i)
+    i.gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+      gsub(/([a-z\d])([A-Z])/,'\1_\2').
+      tr('-', '_').
+      gsub(/\s/, '_').
+      gsub(/__+/, '_').
+      downcase
+  end
+
   # ========================================================================= #
   # === rev
   # ========================================================================= #
   def rev
     if Object.const_defined? :Colours
-      ::Colours.rev
+      return ::Colours.rev
     else
-      ''
+      return ''
     end
   end
 
@@ -125,78 +196,68 @@ class Base # === Open::Base
   end
 
   # ========================================================================= #
-  # === esystem
-  #
-  # This is a bit of an ad-hoc fix to make this work on windows as well.
+  # === host_os?
   #
-  # Eventually may have to rewrite the method a little bit, but for now
-  # (September 2021) this has to suffice.
+  # Return the host-operating system via this method.
   # ========================================================================= #
-  def esystem(
-      i, do_show_the_command_that_will_be_used = true
-    )
-    if is_on_windows?
-      # i = i.to_s.sub(/\\/,'\\') if i.include?("\\")
-      i = '"'+i.to_s+'"' if i.include?(' ')
-    end
-    e i if do_show_the_command_that_will_be_used
-    system(i)
+  def host_os?
+    ::Open.host_os?
   end
 
+  require 'open/toplevel_methods/is_on_roebe.rb'
   # ========================================================================= #
-  # === sanitize
+  # === is_on_roebe?
   # ========================================================================= #
-  def sanitize(i)
-    return i unless Object.const_defined? :ConvertGlobalEnv
-    begin
-      return ConvertGlobalEnv.convert(i)
-    rescue NoMethodError
-      i
-    end
+  def is_on_roebe?
+    ::Open.is_on_roebe?
   end
 
   # ========================================================================= #
-  # === return_pwd
+  # === namespace?
   # ========================================================================= #
-  def return_pwd
-    "#{Dir.pwd}/".squeeze('/')
+  def namespace?
+    @namespace
   end
 
   # ========================================================================= #
-  # == snakecase
+  # === ecomment
   # ========================================================================= #
-  def snakecase(i)
-    i.gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
-      gsub(/([a-z\d])([A-Z])/,'\1_\2').
-      tr('-', '_').
-      gsub(/\s/, '_').
-      gsub(/__+/, '_').
-      downcase
+  def ecomment(i = '')
+    ::Colours.ecomment(i)
   end
 
+  require 'open/toplevel_methods/browser.rb'
   # ========================================================================= #
-  # === reset                                                     (reset tag)
+  # === use_which_browser?
   # ========================================================================= #
-  def reset
-    # ======================================================================= #
-    # === @namespace
-    # ======================================================================= #
-    @namespace = NAMESPACE
-    # ======================================================================= #
-    # === @be_verbose
-    # ======================================================================= #
-    @be_verbose = true
+  def use_which_browser?
+    ::Open.use_which_browser?
   end
 
   # ========================================================================= #
-  # === opnn
+  # === this_file_was_not_found
+  #
+  # Use this to notify the user, whenever the open-gem was unable to
+  # find a file that was assumed to exist locally.
   # ========================================================================= #
-  def opnn(
-      i = { namespace: @namespace }
-    )
-    if Object.const_defined? :Opn
-      Opn.opn(i)
-    end
+  def this_file_was_not_found(i)
+    e "#{rev}No file called `#{sfile(i)}` was found. It "\
+      "is assumed to not exist."
+  end; alias no_file_exists_at    this_file_was_not_found # === no_file_exists_at
+       alias no_file_was_found_at this_file_was_not_found # === no_file_was_found_at
+
+  # ========================================================================= #
+  # === mkdir                                                     (mkdir tag)
+  # ========================================================================= #
+  def mkdir(i)
+    FileUtils.mkdir_p(i)
+  end
+
+  # ========================================================================= #
+  # === touch                                                     (touch tag)
+  # ========================================================================= #
+  def touch(i)
+    FileUtils.touch(i)
   end
 
   # ========================================================================= #
@@ -208,6 +269,22 @@ class Base # === Open::Base
     @commandline_arguments = [i].flatten.compact
   end
 
+  # ========================================================================= #
+  # === commandline_arguments?
+  # ========================================================================= #
+  def commandline_arguments?
+    @commandline_arguments
+  end
+
+  # ========================================================================= #
+  # === commandline_arguments_without_hyphens
+  # ========================================================================= #
+  def commandline_arguments_without_hyphens
+    @commandline_arguments.reject {|entry|
+      entry.start_with?('--')
+    }
+  end
+
   # ========================================================================= #
   # === first_argument?
   # ========================================================================= #
@@ -215,94 +292,158 @@ class Base # === Open::Base
     @commandline_arguments.first
   end
 
+  require 'open/toplevel_methods/editor.rb'
   # ========================================================================= #
-  # === rds
+  # === use_which_editor?
   # ========================================================================= #
-  def rds(i)
-    i.squeeze('/')
+  def use_which_editor?
+    ::Open.use_which_editor?
   end
 
   # ========================================================================= #
-  # === mkdir
+  # === opnn
   # ========================================================================= #
-  def mkdir(i)
-    FileUtils.mkdir_p(i)
+  def opnn(
+      i = {
+        namespace: @namespace
+      }
+    )
+    if Object.const_defined? :Opn
+      Opn.opn(i)
+    end
   end
 
   # ========================================================================= #
-  # === touch
+  # === use_which_delay?
   # ========================================================================= #
-  def touch(i)
-    FileUtils.touch(i)
+  def use_which_delay?
+    Open.use_which_delay?.to_f
   end
 
   # ========================================================================= #
-  # === use_which_editor?
+  # === opne
   # ========================================================================= #
-  def use_which_editor?
-    ::Open.use_which_editor?
+  def opne(i = '')
+    opn(namespace: @namespace); e i
   end
 
+  begin
+    require 'beautiful_url'
+  rescue LoadError; end
   # ========================================================================= #
-  # === use_which_browser?
+  # === beautiful_url
+  #
+  # Wrapper-method towards BeautifulUrl.
   # ========================================================================= #
-  def use_which_browser?
-    ::Open.use_which_browser?
+  def beautiful_url(i)
+    if beautiful_url_is_available?
+      i = BeautifulUrl::BeautifulUrl.new(i).results?
+    end
+    return i
   end
 
   # ========================================================================= #
-  # === this_file_was_not_found
-  #
-  # Use this whenever we did not find any file.
+  # === beautiful_url_is_available?
   # ========================================================================= #
-  def this_file_was_not_found(i)
-    e "No file called `#{sfile(i)}` was found. It "\
-      "is assumed that it does not exist."
-  end; alias no_file_exists_at    this_file_was_not_found # === no_file_exists_at
-       alias no_file_was_found_at this_file_was_not_found # === no_file_was_found_at
+  def beautiful_url_is_available?
+    Object.const_defined? :BeautifulUrl
+  end; alias is_beautiful_url_available? beautiful_url_is_available? # === is_beautiful_url_available?
 
   # ========================================================================= #
-  # === host_os?
-  #
-  # Return the host-operating system via this method.
+  # === try_to_require_the_beautiful_url_project
   # ========================================================================= #
-  def host_os?
-    ::Open.host_os?
+  def try_to_require_the_beautiful_url_project
+    unless Object.const_defined? :BeautifulUrl
+      begin
+        require 'open/requires/failsafe_require_of_beautiful_url.rb'
+      rescue LoadError; end
+    end
   end
 
   # ========================================================================= #
-  # === is_on_windows?
+  # === file_load_default_browser?
   # ========================================================================= #
-  def is_on_windows?(i = host_os?)
-    ::Open.is_on_windows?(i)
-  end; alias on_windows? is_on_windows? # === on_windows?
+  def file_load_default_browser?
+    # ======================================================================= #
+    # The .yml file will hold which browser is to be used by default.
+    # ======================================================================= #
+    _ = "#{::Open.project_base_directory?}yaml/use_this_browser.yml"
+    if File.exist? _
+      return YAML.load_file(_)
+    else
+      return 'chrome'
+    end
+  end
 
   # ========================================================================= #
-  # === is_on_roebe?
+  # === file_load_default_editor?
   # ========================================================================= #
-  def is_on_roebe?
-    ENV['IS_ROEBE'].to_s == '1'
+  def file_load_default_editor?
+    # ======================================================================= #
+    # The .yml file will hold which editor is to be used by default.
+    # ======================================================================= #
+    _ = "#{::Open.project_base_directory?}yaml/use_this_editor.yml"
+    if File.exist? _
+      return YAML.load_file(_)
+    else
+      return 'bluefish'
+    end
   end
 
+  begin
+    require 'convert_global_env'
+  rescue LoadError; end
   # ========================================================================= #
-  # === ecomment
+  # === sanitize_global_environment
+  #
+  # This method bundles together functionality that ConvertGlobalEnv
+  # can handle.
   # ========================================================================= #
-  def ecomment(i = '')
-    ::Colours.ecomment(i)
-  end
+  def sanitize_global_environment(i)
+    return i unless Object.const_defined? :ConvertGlobalEnv
+    begin
+      return ConvertGlobalEnv.convert(i)
+    rescue NoMethodError
+      return i
+    end
+  end; alias sanitize sanitize_global_environment # === sanitize
 
   # ========================================================================= #
-  # === beautiful_url
+  # === consider_padding
   #
-  # Wrapper-method towards BeautifulUrl.
+  # Simply add a surrounding '"' to the given input, so that any resulting
+  # system() call will still work if we have awkward filenames.
   # ========================================================================= #
-  def beautiful_url(i)
-    if Object.const_defined? :BeautifulUrl
-      i = BeautifulUrl::BeautifulUrl.new(i).results?
+  def consider_padding(i)
+    if i.include?(' ') or i.include?('(')
+      i = '"'+i+'"'
     end
-    return i
+    return i # Always return the input, no matter if modified or not.
+  end
+
+  # ========================================================================= #
+  # === rds
+  # ========================================================================= #
+  def rds(i)
+    i.squeeze('/')
+  end
+
+  # ========================================================================= #
+  # === append_array_to_commandline_arguments
+  # ========================================================================= #
+  def append_array_to_commandline_arguments(i)
+    i = [i].flatten.compact
+    @commandline_arguments << i
+    @commandline_arguments.flatten!
   end
 
+  # ========================================================================= #
+  # === create_the_internal_hash
+  # ========================================================================= #
+  def create_the_internal_hash
+    @internal_hash = {}
+  end; alias reset_the_internal_hash create_the_internal_hash # === reset_the_internal_hash
+
   # ========================================================================= #
   # === infer_the_namespace
   #
@@ -319,11 +460,10 @@ class Base # === Open::Base
     @namespace = _ # And assign it here.
   end
 
-  # ========================================================================= #
-  # === namespace?
-  # ========================================================================= #
-  def namespace?
-    @namespace
-  end
+end; end
 
-end; end
+if __FILE__ == $PROGRAM_NAME
+  alias e puts
+  base = Open::Base.new(ARGV)
+  e base.host_os?
+end # base.rb

data/lib/open/books/README.md

@@ -0,0 +1,8 @@
+This directory is specifically to enable the functionality of
+"opening books". Books in this context refers to PDF files,
+that is, .pdf files. In order for this functionality to work,
+you need to have .pdf files available locally, and you also
+need to supply a custom file that keeps track of the themes
+of the books, such as "all books that handle the theme
+genetics". Then, once such a file has been made available,
+class Open::Books will simply open all these books.

data/lib/open/books/books.rb

@@ -0,0 +1,99 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Open::Book
+#
+# This class will specifically open "books", that is, .pdf files.
+#
+# Usage example:
+#
+#   Open::Book.new(ARGV)
+#
+# =========================================================================== #
+require 'open/base/base.rb'
+
+module Open
+
+class Book < ::Open::Base # === Open::Book
+
+  # ========================================================================= #
+  # === FILE_TOPICS_PER_BOOK
+  # ========================================================================= #
+  FILE_TOPICS_PER_BOOK = '/home/x/books/topics_per_book.yml'
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      i           = ARGV,
+      run_already = true
+    )
+    reset
+    set_commandline_arguments(i)
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    infer_the_namespace
+    # ======================================================================= #
+    # === @dataset
+    # ======================================================================= #
+    @dataset = nil
+    if File.exist?(FILE_TOPICS_PER_BOOK)
+      @dataset = YAML.load_file(FILE_TOPICS_PER_BOOK)
+    end
+  end
+
+  # ========================================================================= #
+  # === main_file?
+  # ========================================================================= #
+  def main_file?
+    FILE_TOPICS_PER_BOOK
+  end
+
+  # ========================================================================= #
+  # === open_these_files
+  # ========================================================================= #
+  def open_these_files(array)
+    require 'open/open/open.rb'
+    array.map! {|entry|
+      entry = entry.dup
+      unless entry.include?('/home/x/books/')
+        entry.prepend(
+          entry.delete_suffix('.pdf')+'/'
+        )
+        entry.prepend('/home/x/books/')
+      end
+      entry
+    }
+    ::Open::Open.new(array)
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    _ = @dataset
+    commandline_arguments?.each {|this_topic|
+      this_topic = this_topic.dup if this_topic.frozen?
+      this_topic.delete!(':') if this_topic.include? ':'
+      if _.has_key?(this_topic)
+        opne 'Processing the topic '+steelblue(this_topic)+' next.'
+        open_these_files(_[this_topic])
+      else
+        opne 'The topic '+steelblue(this_topic)+' was not '\
+             'found in the file '+main_file?+'.'
+      end
+    }
+  end
+
+end; end
+
+if __FILE__ == $PROGRAM_NAME
+  Open::Book.new(ARGV)
+end # openbooks :java