open 0.1.23

data/lib/open/base/base.rb

@@ -0,0 +1,311 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'open/base/base.rb'
+# < Base
+# =========================================================================== #
+module Open
+
+class Base # === Open::Base
+
+  require 'yaml'
+
+  require 'fileutils'
+
+  begin
+    require 'colours'
+    include Colours::E
+  rescue LoadError; end
+
+  begin
+    require 'beautiful_url'
+  rescue LoadError
+    # puts 'BeautifulUrl is not available.'
+  end
+
+  begin
+    require 'opn'
+  rescue LoadError; end
+
+  begin
+    require 'convert_global_env'
+  rescue LoadError; end
+
+  begin
+    require 'roebe/classes/find_expanded_alias.rb'
+  rescue LoadError; end
+
+  require 'open/constants/constants.rb'
+  require 'open/toplevel_code/toplevel_code.rb'
+
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = inspect
+
+  # ========================================================================= #
+  # === rev
+  # ========================================================================= #
+  def rev
+    if Object.const_defined? :Colours
+      ::Colours.rev
+    else
+      ''
+    end
+  end
+
+  # ========================================================================= #
+  # === simp
+  # ========================================================================= #
+  def simp(i = '')
+    if Object.const_defined? :Colours
+      return ::Colours.simp(i)
+    else
+      return i
+    end
+  end
+
+  # ========================================================================= #
+  # === sfancy
+  # ========================================================================= #
+  def sfancy(i = '')
+    if Object.const_defined? :Colours
+      return ::Colours.sfancy(i)
+    else
+      return i
+    end
+  end
+
+  # ========================================================================= #
+  # === steelblue
+  # ========================================================================= #
+  def steelblue(i = '')
+    if Object.const_defined? :Colours
+      return ::Colours.steelblue(i)
+    else
+      return i
+    end
+  end
+
+  # ========================================================================= #
+  # === sfile
+  # ========================================================================= #
+  def sfile(i = '')
+    if Object.const_defined? :Colours
+      return ::Colours.sfile(i)
+    else
+      return i
+    end
+  end
+
+  # ========================================================================= #
+  # === register_sigint
+  # ========================================================================= #
+  def register_sigint
+    Signal.trap('SIGINT') { exit }
+  end
+
+  # ========================================================================= #
+  # === esystem
+  #
+  # This is 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
+    )
+    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
+
+  # ========================================================================= #
+  # === sanitize
+  # ========================================================================= #
+  def sanitize(i)
+    return i unless Object.const_defined? :ConvertGlobalEnv
+    begin
+      return ConvertGlobalEnv.convert(i)
+    rescue NoMethodError
+      i
+    end
+  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
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    # ======================================================================= #
+    # === @namespace
+    # ======================================================================= #
+    @namespace = NAMESPACE
+    # ======================================================================= #
+    # === @be_verbose
+    # ======================================================================= #
+    @be_verbose = true
+  end
+
+  # ========================================================================= #
+  # === opnn
+  # ========================================================================= #
+  def opnn(
+      i = { namespace: @namespace }
+    )
+    if Object.const_defined? :Opn
+      Opn.opn(i)
+    end
+  end
+
+  # ========================================================================= #
+  # === set_commandline_arguments
+  # ========================================================================= #
+  def set_commandline_arguments(
+      i = ARGV
+    )
+    @commandline_arguments = [i].flatten.compact
+  end
+
+  # ========================================================================= #
+  # === first_argument?
+  # ========================================================================= #
+  def first_argument?
+    @commandline_arguments.first
+  end
+
+  # ========================================================================= #
+  # === rds
+  # ========================================================================= #
+  def rds(i)
+    i.squeeze('/')
+  end
+
+  # ========================================================================= #
+  # === mkdir
+  # ========================================================================= #
+  def mkdir(i)
+    FileUtils.mkdir_p(i)
+  end
+
+  # ========================================================================= #
+  # === touch
+  # ========================================================================= #
+  def touch(i)
+    FileUtils.touch(i)
+  end
+
+  # ========================================================================= #
+  # === use_which_editor?
+  # ========================================================================= #
+  def use_which_editor?
+    ::Open.use_which_editor?
+  end
+
+  # ========================================================================= #
+  # === use_which_browser?
+  # ========================================================================= #
+  def use_which_browser?
+    ::Open.use_which_browser?
+  end
+
+  # ========================================================================= #
+  # === this_file_was_not_found
+  #
+  # Use this whenever we did not find any file.
+  # ========================================================================= #
+  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
+
+  # ========================================================================= #
+  # === host_os?
+  #
+  # Return the host-operating system via this method.
+  # ========================================================================= #
+  def host_os?
+    ::Open.host_os?
+  end
+
+  # ========================================================================= #
+  # === is_on_windows?
+  # ========================================================================= #
+  def is_on_windows?(i = host_os?)
+    ::Open.is_on_windows?(i)
+  end; alias on_windows? is_on_windows? # === on_windows?
+
+  # ========================================================================= #
+  # === is_on_roebe?
+  # ========================================================================= #
+  def is_on_roebe?
+    ENV['IS_ROEBE'].to_s == '1'
+  end
+
+  # ========================================================================= #
+  # === ecomment
+  # ========================================================================= #
+  def ecomment(i = '')
+    ::Colours.ecomment(i)
+  end
+
+  # ========================================================================= #
+  # === beautiful_url
+  #
+  # Wrapper-method towards BeautifulUrl.
+  # ========================================================================= #
+  def beautiful_url(i)
+    if Object.const_defined? :BeautifulUrl
+      i = BeautifulUrl::BeautifulUrl.new(i).results?
+    end
+    return i
+  end
+
+  # ========================================================================= #
+  # === infer_the_namespace
+  #
+  # This will assume the true namespace from the inspectable name.
+  # ========================================================================= #
+  def infer_the_namespace
+    _ = inspect.to_s.delete('<')
+    if _.include? ' '
+      _ = _.split(' ').first.delete('#')
+      if _.include? ':'
+        _ = _.split(':')[0 .. -2].reject {|entry| entry.empty? }.join('::')
+      end
+    end
+    @namespace = _ # And assign it here.
+  end
+
+  # ========================================================================= #
+  # === namespace?
+  # ========================================================================= #
+  def namespace?
+    @namespace
+  end
+
+end; end

data/lib/open/constants/constants.rb

@@ -0,0 +1,110 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'open/constants/constants.rb'
+# =========================================================================== #
+module Open
+
+  require 'yaml'
+  require 'open/project/project.rb'
+
+  # ========================================================================= #
+  # === IN_BACKGROUND
+  # ========================================================================= #
+  IN_BACKGROUND = ' &'
+
+  # ========================================================================= #
+  # === HOME_DIRECTORY_OF_USER_X
+  #
+  # This constant is only useful on my home system.
+  # ========================================================================= #
+  HOME_DIRECTORY_OF_USER_X = '/home/x/'
+
+  # ========================================================================= #
+  # === RUBY_SRC
+  # ========================================================================= #
+  RUBY_SRC = "#{HOME_DIRECTORY_OF_USER_X}programming/ruby/src/"
+
+  # ========================================================================= #
+  # === PROGRAMMING_LANGUAGES_DIRECTORY_AT_HOME
+  # ========================================================================= #
+  PROGRAMMING_LANGUAGES_DIRECTORY_AT_HOME =
+    "#{HOME_DIRECTORY_OF_USER_X}programming/"
+
+  # ========================================================================= #
+  # === USERFIND
+  # ========================================================================= #
+  USERFIND = "find #{HOME_DIRECTORY_OF_USER_X}data -name"
+
+  # ========================================================================= #
+  # === MY_DATA
+  #
+  # This is functionality equivalent to the String '/home/x/data/'.
+  # ========================================================================= #
+  MY_DATA = "#{HOME_DIRECTORY_OF_USER_X}data/"
+    DATA_DIRECTORY_AT_HOME = MY_DATA # === DATA_DIRECTORY_AT_HOME
+
+  # ========================================================================= #
+  # === N_DELAY
+  #
+  # This delay is specifically used for delaying before batch-opening
+  # files via the Open.in_editor() functionality.
+  # ========================================================================= #
+  N_DELAY = 0.48
+
+  # ========================================================================= #
+  # === Open::LOCATION_OF_BROWSER_YAML_FILE
+  #
+  # Here we must define where we store the location for our browser.
+  #
+  # That file will tell us which browser to use.
+  #
+  # Most users will not have this file, so the code will have to remain
+  # flexible in this regard.
+  #
+  # On my home system this will point towards the following file:
+  #
+  #   /home/Programs/Ruby/3.1.2/lib/ruby/site_ruby/3.1.0/open/yaml/use_this_browser.yml
+  #
+  # ========================================================================= #
+  LOCATION_OF_BROWSER_YAML_FILE =
+    "#{project_yaml_directory?}use_this_browser.yml"
+
+  # ========================================================================= #
+  # === LOCATION_OF_EDITOR_YAML_FILE
+  # ========================================================================= #
+  LOCATION_OF_EDITOR_YAML_FILE =
+    "#{project_yaml_directory?}use_this_editor.yml"
+
+  # ========================================================================= #
+  # === USE_THIS_EDITOR
+  #
+  # This variant is hardcoded, but there are class-methods that can be used
+  # to overrule the setting. 
+  # ========================================================================= #
+  if File.exist?(LOCATION_OF_EDITOR_YAML_FILE)
+    USE_THIS_EDITOR = YAML.load_file(LOCATION_OF_EDITOR_YAML_FILE)
+  else # else use a hardcoded default
+    USE_THIS_EDITOR = 'bluefish' # geany
+  end
+
+  # ========================================================================= #
+  # === USE_THIS_BROWSER
+  # ========================================================================= #
+  if File.exist?(Dir.home+'/use_this_browser.yml') # First check the home directory of the user.
+    USE_THIS_BROWSER = YAML.load_file(Dir.home+'/use_this_browser.yml')
+  elsif File.exist?(LOCATION_OF_BROWSER_YAML_FILE)
+    USE_THIS_BROWSER = YAML.load_file(LOCATION_OF_BROWSER_YAML_FILE)
+  else # else use a hardcoded default
+    USE_THIS_BROWSER = 'firefox' # palemoon or chrome may be options too
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  puts Open::MY_DATA
+  puts Open::LOCATION_OF_BROWSER_YAML_FILE
+  puts Open::USE_THIS_EDITOR
+  puts Open::USE_THIS_BROWSER
+end