open 0.1.30

data/lib/open/project/project.rb

@@ -0,0 +1,46 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'open/project/project.rb'
+# Open.project_base_directory?
+# =========================================================================== #
+module Open
+
+  # ========================================================================= #
+  # === Open::PROJECT_BASE_DIRECTORY
+  # ========================================================================= #
+  PROJECT_BASE_DIRECTORY = 
+    File.absolute_path("#{__dir__}/..")+'/'
+
+  # ========================================================================= #
+  # === Open.project_base_directory?
+  # ========================================================================= #
+  def self.project_base_directory?
+    PROJECT_BASE_DIRECTORY
+  end; self.instance_eval { alias project_base_dir? project_base_directory? } # === Open.project_base_dir?
+       self.instance_eval { alias project_dir?      project_base_directory? } # === Open.project_dir?
+       self.instance_eval { alias base_dir?         project_base_directory? } # === Open.base_dir?
+       self.instance_eval { alias base_directory?   project_base_directory? } # === Open.base_directory?
+
+  # ========================================================================= #
+  # === Open::PROJECT_YAML_DIRECTORY
+  # ========================================================================= #
+  PROJECT_YAML_DIRECTORY = "#{Open.project_base_dir?}yaml/"
+
+  # ========================================================================= #
+  # === Open.project_yaml_dir?
+  #
+  # This is a query-method for the constant PROJECT_YAML_DIRECTORY.
+  # ========================================================================= #
+  def self.project_yaml_dir?
+    PROJECT_YAML_DIRECTORY
+  end; self.instance_eval { alias yaml_directory?           project_yaml_dir? } # === Open.yaml_directory?
+       self.instance_eval { alias project_yaml_directory?   project_yaml_dir? } # === Open.project_yaml_directory?
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  puts Open.project_base_dir?
+  puts Open.project_yaml_dir?
+end

data/lib/open/requires/require_the_project.rb

@@ -0,0 +1,15 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'open/constants/constants.rb'
+require 'open/toplevel_code/toplevel_code.rb'
+require 'open/version/version.rb'
+require 'open/in_browser/in_browser.rb'
+require 'open/in_editor/in_editor.rb'
+require 'open/last/last.rb'
+require 'open/last_url/last_url.rb'
+require 'open/with_delay/with_delay.rb'
+require 'open/open.rb'
+require 'open/nano_open/nano_open.rb'
+require 'open/these_files/these_files.rb'

data/lib/open/these_files/these_files.rb

@@ -0,0 +1,120 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Open::TheseFiles
+#
+# Usage example:
+#
+#   require 'open/these_files/these_files.rb'
+#   Open.these_files(ARGV)
+#
+# =========================================================================== #
+# require 'open/these_files/these_files.rb'
+# =========================================================================== #
+require 'open/base/base.rb'
+
+module Open
+
+class TheseFiles < Base # === Open::TheseFiles
+
+  require 'open/in_editor/in_editor.rb'
+
+  # ========================================================================= #
+  # === initialize
+  #
+  # The first argument should be the name of the file that we wish to open.
+  # ========================================================================= #
+  def initialize(
+      i           = nil,
+      run_already = true
+    )
+    register_sigint
+    reset
+    set_input(i)
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    super()
+    # ========================================================================= #
+    # === @use_this_delay
+    # ========================================================================= #
+    @use_this_delay = ::Open.use_which_delay?.to_f
+  end
+
+  # ========================================================================= #
+  # === set_input
+  # ========================================================================= #
+  def set_input(i = '')
+    if i and i.is_a?(String) and i.include?("\n")
+      i = i.split("\n")
+    end
+    i = [i].flatten.compact.map {|entry|
+      if entry.include? ':'
+        entry = entry.split(':').first.strip
+      end
+      entry
+    }
+    @input = i # Must be an Array.
+  end
+
+  # ========================================================================= #
+  # === input?
+  # ========================================================================= #
+  def input?
+    @input
+  end
+
+  # ========================================================================= #
+  # === consider_opening_these_files
+  # ========================================================================= #
+  def consider_opening_these_files(
+      i = input?
+    )
+    i.each {|entry|
+      Open.in_editor(i)
+      sleep(@use_this_delay)
+    }
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    consider_opening_these_files
+  end
+
+  # ========================================================================= #
+  # === Open::TheseFiles[]
+  # ========================================================================= #
+  def self.[](i, &block)
+    new(i, &block)
+  end
+
+end
+
+# =========================================================================== #
+# === Open.these_files
+# =========================================================================== #
+def self.these_files(
+    i = ARGV, &block
+  )
+  ::Open::TheseFiles.new(i, &block)
+end
+
+end
+
+# =========================================================================== #
+# === open_these_files
+# =========================================================================== #
+def open_these_files(i = ARGV, &block)
+  Open.these_files(i, &block)
+end
+
+if __FILE__ == $PROGRAM_NAME
+  Open::TheseFiles.new(ARGV)  
+end # openthesefiles

data/lib/open/toplevel_code/toplevel_code.rb

@@ -0,0 +1,189 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'open/toplevel_code/toplevel_code.rb'
+# =========================================================================== #
+module Open
+
+  require 'open/project/project.rb'
+
+  begin
+    require 'yaml'
+  rescue LoadError; end
+
+  require 'open/constants/constants.rb'
+
+  # ========================================================================= #
+  # === Open.use_which_delay?
+  # ========================================================================= #
+  def self.use_which_delay?
+    _ = "#{project_base_directory?}yaml/use_this_delay.yml"
+    if File.exist? _
+      YAML.load_file(_)
+    else
+      '1.0'
+    end
+  end
+
+  # ========================================================================= #
+  # === Open.e
+  # ========================================================================= #
+  def self.e(i = '')
+    puts i
+  end
+
+  # ========================================================================= #
+  # === Open.host_os?
+  #
+  # Return the host-operating system via this method.
+  # ========================================================================= #
+  def self.host_os?
+    ::RbConfig::CONFIG['host_os']
+  end
+
+  # ========================================================================= #
+  # === Open.is_on_windows?
+  # ========================================================================= #
+  def self.is_on_windows?(i = host_os?)
+    case i # or: RUBY_PLATFORM
+    when /win/,
+         /mingw/
+      true
+    else
+      false
+    end
+  end
+
+  # ========================================================================= #
+  # === @use_this_editor
+  # ========================================================================= #
+  @use_this_editor = nil
+
+  # ========================================================================= #
+  # === Open.set_use_this_editor
+  #
+  # Modify the toplevel variable @use_this_editor through this method.
+  # ========================================================================= #
+  def self.set_use_this_editor(
+      i = USE_THIS_EDITOR
+    )
+    @use_this_editor = i
+  end
+
+  set_use_this_editor # Initialize it at once.
+
+  # ========================================================================= #
+  # === Open.use_which_editor?
+  # ========================================================================= #
+  def self.use_which_editor?
+    @use_this_editor
+  end
+
+  # ========================================================================= #
+  # === @use_this_browser
+  # ========================================================================= #
+  @use_this_browser = nil
+
+  # ========================================================================= #
+  # === Open.set_use_this_browser
+  #
+  # This method can be used to assign a different browser.
+  # ========================================================================= #
+  def self.set_use_this_browser(
+      i = USE_THIS_BROWSER
+    )
+    @use_this_browser = i
+  end; self.instance_eval { alias use_this_browser= set_use_this_browser } # === Open.use_this_browser=
+
+  set_use_this_browser # Initialize it at once.
+
+  # ========================================================================= #
+  # === Open.use_which_browser?
+  #
+  # Query-method to determine which browser is currently designated to be
+  # the main browser, as far as the open-gem is concerned.
+  # ========================================================================= #
+  def self.use_which_browser?
+    @use_this_browser
+  end; self.instance_eval { alias browser? use_which_browser? } # === Open.browser?
+
+  # ========================================================================= #
+  # === Open.write_what_into
+  #
+  # Delegate towards SaveFile.
+  # ========================================================================= #
+  def self.write_what_into(what, into)
+    ::SaveFile.write_what_into(what, into)
+  end
+
+  # ========================================================================= #
+  # === Open[]
+  #
+  # This method defaults to Open.in_editor(), but if the input starts
+  # with "http" then we will use Open.in_browser() instead.
+  #
+  # In January 2023 this was deprecated. It now resides in another file.
+  #
+  # Usage example:
+  #
+  #   Open[TEST_THIS_FILE]
+  #
+  # ========================================================================= #
+  # def self.[](i = ARGV, &block)
+  #   unless Open.respond_to? :in_browser
+  #     require 'open/in_browser/in_browser.rb'
+  #   end
+  #   unless Open.respond_to? :in_editor
+  #     require 'open/in_editor/in_editor.rb'
+  #   end
+  #   if i.is_a? Array
+  #     i = i.join(' ').strip
+  #   end
+  #   if i.start_with? 'http'
+  #     ::Open.in_browser(i, &block)
+  #   else # this is the default
+  #     ::Open.in_editor(i, &block)
+  #   end
+  # end
+
+  # ========================================================================= #
+  # === Roebe.is_on_roebe?
+  # ========================================================================= #
+  def self.is_on_roebe?
+    ENV['IS_ROEBE'].to_s == '1'
+  end
+
+  # ========================================================================= #
+  # === Open.permanently_use_this_browser
+  #
+  # This method can be used to permanently store a new browser, for the
+  # open gem.
+  # ========================================================================= #
+  def self.permanently_use_this_browser(
+      this_browser         = 'thorium',
+      store_into_this_file = ::Open::LOCATION_OF_BROWSER_YAML_FILE
+    )
+    case this_browser # Symbols are treated a bit differently here.
+    # ======================================================================= #
+    # === :firefox
+    # ======================================================================= #
+    when :firefox
+      this_browser = '/usr/bin/firefox'
+    end
+    this_browser = this_browser.to_s # We need a String.
+    e "Storing into `#{store_into_this_file}`."
+    write_what_into(this_browser, store_into_this_file)
+    if is_on_roebe?
+      store_into_this_file = '/home/x/programming/ruby/src/open/lib/open/yaml/use_this_browser.yml'
+      e "Storing into `#{store_into_this_file}`."
+      write_what_into(this_browser, store_into_this_file)
+    end 
+  end; self.instance_eval { alias permanently_use_this_browser= permanently_use_this_browser } # === Open.permanently_use_this_browser=
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  puts Open.use_which_editor?
+  puts Open.use_which_browser?
+end

data/lib/open/version/version.rb

@@ -0,0 +1,19 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'open/version/version.rb'
+# =========================================================================== #
+module Open
+
+  # ========================================================================= #
+  # === VERSION
+  # ========================================================================= #
+  VERSION = '0.1.30'
+
+  # ========================================================================= #
+  # === LAST_UPDATE
+  # ========================================================================= #
+  LAST_UPDATE = '16.05.2023'
+
+end

data/lib/open/with_delay/with_delay.rb

@@ -0,0 +1,260 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Open::WithDelay
+#
+# This class will open files in the current working directory, with a 
+# small delay. The idea behind this is that some editors, such as
+# the old bluefish editor, had difficulties opening many large files
+# rapidly. 
+#
+# Usage example:
+#
+#   Open::WithDelay.new(ARGV)
+#
+# =========================================================================== #
+# require 'open/with_delay/_with_delay.rb'
+# Open::WithDelay.new(ARGV)
+# =========================================================================== #
+require 'open/base/base.rb'
+
+module Open
+
+class WithDelay < Base # === Open::WithDelay
+
+  require 'open/in_editor/in_editor'
+
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = inspect
+
+  # ========================================================================= #
+  # === DEFAULT_DELAY
+  # ========================================================================= #
+  DEFAULT_DELAY = ::Open.use_which_delay?.to_f
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      commandline_arguments = DEFAULT_DELAY,
+      run_already           = true
+    )
+    reset
+    set_commandline_arguments(
+      commandline_arguments
+    )
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset
+  # ========================================================================= #
+  def reset
+    super()
+    set_default_delay # We need a default value for the delay to be set.
+    determine_which_files_to_open
+    # ======================================================================= #
+    # === @namespace
+    # ======================================================================= #
+    @namespace = NAMESPACE
+    # ======================================================================= #
+    # === @pattern
+    # ======================================================================= #
+    @pattern = nil
+  end
+
+  # ========================================================================= #
+  # === search_for_this_pattern
+  # ========================================================================= #
+  def search_for_this_pattern(i)
+    @pattern = i
+  end; alias set_pattern search_for_this_pattern # === set_pattern
+
+  # ========================================================================= #
+  # === determine_which_files_to_open
+  # ========================================================================= #
+  def determine_which_files_to_open(
+      i = '*'
+    )
+    i = i.to_s.dup.delete('-')
+    case i
+    # ======================================================================= #
+    # === everything
+    # ======================================================================= #
+    when 'everything',
+         /^really(_|-)?everything$/i
+      @all_files = Dir['**/**'].select {|entry| File.file? entry }
+    else # This is the default entry-clause.
+      @all_files = Dir[i].select {|entry| File.file? entry }
+    end unless File.exist?('everything')
+    # ======================================================================= #
+    # And sort it next:
+    # ======================================================================= #
+    @all_files = @all_files.sort_by {|inner_entry|
+      # ===================================================================== #
+      # Must sort the files by last filename next.
+      # ===================================================================== #
+      File.basename(inner_entry)
+    }
+  end
+
+  # ========================================================================= #
+  # === set_use_this_delay
+  #
+  # Determine which delay to use before file-opening - in n seconds.
+  # ========================================================================= #
+  def set_use_this_delay(
+      i = DEFAULT_DELAY
+    )
+    i = i.first if i.is_a? Array
+    case i
+    # ======================================================================= #
+    # === :default_delay
+    # ======================================================================= #
+    when :default_delay, nil
+      i = DEFAULT_DELAY
+    end
+    i = i.to_f
+    @use_this_delay = i
+  end
+
+  # ========================================================================= #
+  # === set_default_delay
+  # ========================================================================= #
+  def set_default_delay
+    set_use_this_delay(:default_delay)
+  end
+
+  # ========================================================================= #
+  # === use_this_delay?
+  # ========================================================================= #    
+  def use_this_delay?
+    @use_this_delay
+  end; alias delay? use_this_delay? # === delay?
+
+  # ========================================================================= #
+  # === report_the_delay_in_use
+  # ========================================================================= #
+  def report_the_delay_in_use
+    opnn; e "The delay is `#{simp(delay?.to_s)}` seconds."
+  end
+
+  # ========================================================================= #
+  # === menu                                                       (menu tag)
+  # ========================================================================= #
+  def menu(
+      i = @commandline_arguments
+    )
+    if i.is_a? Array
+      i.each {|entry| menu(entry) }
+    else
+      case i
+      # ===================================================================== #
+      # === odelay --pattern=input
+      # ===================================================================== #
+      when /^-?-?pattern=(.+)$/i
+        search_for_this_pattern($1.to_s.dup)
+      # ===================================================================== #
+      # === odelay --help
+      # ===================================================================== #
+      when /^-?-?help$/i
+        show_help
+        exit
+      # ===================================================================== #
+      # === odelay --everything
+      #
+      # This entry point allows us to open every file in all subdirectories
+      # found, under the current working directory (pwd, cwd).
+      # ===================================================================== #
+      when /^-?-?everything$/i
+        determine_which_files_to_open(i)
+      else # we assume this to be the default entry point.
+        if i.include?('.') and !File.exist?(i) and
+           is_there_a_file_with_that_file_end_in_this_directory?(i)
+          set_pattern(i)
+        end
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === show_help                                                  (help tag)
+  # ========================================================================= #
+  def show_help
+    e
+    eparse '  --everything        # Open all files in the current working '\
+           'directory and all subdirectories, via the default delay'
+    eparse '  --pattern=criterium # Search for only files that match the '\
+           'given criterium'
+    e
+  end
+
+  # ========================================================================= #
+  # === is_there_a_file_with_that_file_end_in_this_directory?
+  # ========================================================================= #
+  def is_there_a_file_with_that_file_end_in_this_directory?(i)
+    !Dir['*'].select {|file|
+      file.end_with? file
+    }.empty?
+  end
+
+  # ========================================================================= #
+  # === consider_applying_the_pattern_filter
+  #
+  # The filter is a positive-filter, aka we keep only those files that
+  # fulfil our criterium.
+  # ========================================================================= #
+  def consider_applying_the_pattern_filter
+    if @pattern
+      @all_files.select! {|this_file|
+        this_file.include? @pattern
+      }
+    end
+  end
+
+  # ========================================================================= #
+  # === do_process_all_files
+  # ========================================================================= #
+  def do_process_all_files(
+      i = @all_files
+    )
+    using_this_editor = use_which_editor?
+    delay = delay?.to_s
+    opnn; e "We will open all #{sfancy(i.size.to_s)} files "\
+            "in this directory."
+    i.each {|this_file|
+      opnn; e 'Next opening the file `'+sfile(this_file)+
+              '` via the editor '+sfancy(using_this_editor)+','
+      opnn; e "then sleeping for #{simp(delay)} seconds."
+      Open.in_editor(this_file)
+      sleep(delay.to_f) # Must be treated as a Float.
+    }
+  end
+
+  # ========================================================================= #
+  # === run
+  # ========================================================================= #
+  def run
+    menu
+    report_the_delay_in_use
+    consider_applying_the_pattern_filter
+    do_process_all_files
+  end
+
+end
+
+# =========================================================================== #
+# === Open.with_delay
+# =========================================================================== #
+def self.with_delay(i = ARGV)
+  Open::WithDelay.new(i)
+end; self.instance_eval { alias open_with_delay with_delay } # === Open.open_with_delay
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  Open::WithDelay.new(ARGV)
+end # openwithdelay 3

data/lib/open/yaml/shortcuts.yml

@@ -0,0 +1,22 @@
+# =========================================================================== #
+# === shortcuts.yml
+#
+# This file can be used if you want to open several files, such as in
+# a specific project.
+#
+# For instance, if I do this on the commandline:
+#
+#   open :gamebooks
+#
+# Then the open-gem will open all local files that belong to the
+# gamebooks (or are useful pertaining to that project).
+#
+# In the past this functionality was, in part, stored in the gem called
+# beautiful_url, but I think it is easier to keep this a bit separate
+# from beautiful-url. At a later point in time this may change, though.
+# =========================================================================== #
+gamebooks:
+- $RUBY_SRC/rpg_paradise/lib/rpg_paradise/gamebooks/lone_wolf/character.rb
+- $RUBY_SRC/rpg_paradise/lib/rpg_paradise/gamebooks/lone_wolf/statistics.rb
+- $RUBY_SRC/rpg_paradise/lib/rpg_paradise/gui/shared_code/gamebook/gamebook_module.rb
+- $RUBY_SRC/rpg_paradise/lib/rpg_paradise/gui/gtk3/gamebook/gamebook.rb

data/lib/open/yaml/use_this_browser.yml

@@ -0,0 +1 @@
+thorium # chrome # firefox

data/lib/open/yaml/use_this_delay.yml

@@ -0,0 +1 @@
+0.8 # seconds

data/lib/open/yaml/use_this_editor.yml

@@ -0,0 +1 @@
+bluefish

data/lib/open.rb

@@ -0,0 +1,5 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'open/requires/require_the_project.rb'