open 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6e97b4bf7fefbde0c67eeb92997a65094d055811f5de61b49267c35fcef94bbc
+  data.tar.gz: e98c638baed4bc5746a14e81a79679a83b2a6b664604d3a64cd1387b1ac47458
+SHA512:
+  metadata.gz: ca4aacf66939ed31a9dfc0ade920c91469f62e545d2680a20233dc90dfb3bcd7d0b4c841d6f9a43cae94e0b1a1c53bfcb56850d6a1e2ed92c8157f1df828ae98
+  data.tar.gz: e7356840e738c0549e10a4f18950fd7df205146438376c49810c88ceaefd20b4d62836eb3b01ffcf4763144feea951235376b75ec6462c5fd0978c367d9862fc

data/README.md

@@ -0,0 +1,181 @@
+[![forthebadge](http://forthebadge.com/images/badges/built-with-love.svg)](https://www.gobolinux.org/)
+[![forthebadge](http://forthebadge.com/images/badges/made-with-ruby.svg)](https://www.ruby-lang.org/en/)
+[![Gem Version](https://badge.fury.io/rb/open.svg)](https://badge.fury.io/rb/open)
+
+## History of this project
+
+In the past I used separate projects / gems, such as **OpenInEditor** or
+**OpenInBrowser**, to open files via my favourite editor, or to open
+remote URLs via my favourite browser.
+
+Additionally I also had more code aggregated in **roebe/classes/open/**.
+
+This slightly confusing situation accrued over the years, from 2010 to 2021
+or so.
+
+In early **September 2021** I reconsidered the old approach.
+
+I wanted to not only clean up the old code base, making it more flexible
+as well in the process, but **add a new API** such as:
+
+    Open.in_editor('/home/foobar.md')
+    Open.in_editor(this_file: '/home/foobar.md')
+
+As well as:
+
+    Open.in_browser(url: 'google.de', browser: 'firefox')
+
+That way we can 'think' of "Open" first, and then simply call
+the method name that we want to use. On the commandline we can
+still do:
+
+    open_in_editor foobar.rb
+    open_in_browser google.de
+
+## Layout of the project's structure
+
+This subsection will not include all details, but may serve as a slight
+introduction to how the project is layout.
+
+Most of the constants will reside under **open/constants/constants.rb**.
+
+Toplevel-methods can be found under **open/toplevel_code/** for the
+most part. This may be ignored by some classes if they add
+toplevel-methods; in that case the toplevel may be modified by such
+a class.
+
+## Optional dependencies in this project
+
+Officially there are no hardcoded dependencies in this project.
+
+However had, you are encouraged to install various gems, such as:
+
+- colours
+- convert_global_env
+- beautiful_url
+- opn
+
+These may enhance the ruby code used in this project.
+
+I highly recommend to install the **colours** gem, but ultimately
+the code in this project is written deliberately in a manner to
+make all these add-ons optional, so this is entirely up to you
+in the end.
+
+## class Open::InEditor
+
+This is used for opening a (local) file via the editor.
+
+To open a local file via the open-gem, do:
+
+    require 'open'
+
+    Open.in_editor('FILE_PATH_GOES_IN_HERE')
+    Open.in_editor('/home/x/programming/ruby/src/open/open.gemspec')
+
+## class Open::InBrowser
+
+This is used for opening a remote URL via your favourite
+browser.
+
+Upon requiring the main class, the method called:
+
+    open_in_browser()
+
+will be defined as well, to simplify working with the
+class.
+
+To specify a particular port, use this variant:
+
+    Open.open_in_browser(port: 8080)
+
+This is equivalent to this variant:
+
+    PORT_TO_USE = 8080
+    Open.in_browser(with_localhost: PORT_TO_USE)
+
+So different keywords can be used, however your brain prefers
+this or that variant.
+
+## class Open::LastUrl
+
+This small class can be used to specifically open the content
+of the xorg-buffer via the browser.
+
+## class Open::WithDelay
+
+You can open files via a delay, through class **Open::WithDelay**.
+
+You can specify a delay via:
+
+    openwithdelay 3
+
+Or via the method:
+
+    .set_use_this_delay()
+    .set_use_this_delay(3)
+    .set_use_this_delay(0.5)
+
+## Changing to a different default editor and browser
+
+In **November 2021** I realized that we need a way to more
+easily switch between the default main editor and the
+default main browser. For instance, I abandoned palemoon,
+so I needed to use firefox quickly.
+
+The old code had hardcoded calls to **palemoon**, which was
+not very elegant, and made changes to the code harder.
+
+Thus two new yaml files were added:
+
+    use_this_browser.yml
+    use_this_editor.yml
+
+Now you can modify these yaml files and use a different
+browser or editor. You can even specify the full path
+to these browsers and it should work fine.
+
+## Finding out the current editor and browser in use
+
+Use the following two methods if you wish to find out
+which is the current main editor and the current
+main browser in use.
+
+    puts Open.use_which_editor?
+    puts Open.use_which_browser?
+
+## class Open::Base
+
+This subsection contains just a few pointers to class
+**Open::Base**.
+
+The method **.this_file_was_not_found()** can be
+used to designate that a certain file (the input
+argument to that method) could not be found.
+
+
+## Contact information
+
+If your creative mind has ideas and specific suggestions to make this
+gem more useful in general, feel free to drop me an email at any
+time, via:
+
+    shevy@inbox.lt
+
+Before that email I used an email account at Google gmail, but in **2021** I
+decided to slowly abandon gmail for various reasons. In part this is because
+the UI annoys me (on non-chrome browser loading takes too long), but also
+because of Google's attempt to establish mass surveillance via its
+federated cohorts sniffing (FLoC). I do not know what happened at Google,
+but enough is enough - there is only so much you can take while supporting
+greed. When it comes to data mining done by private groups, ultimately
+the user became the product.
+
+Do keep in mind that responding to emails may take some time,
+depending on the amount of work I may have at that moment, due
+to reallife time constraints. I will, however had, read feedback
+eventually. Patches and code changes are welcome too, of course,
+as long as they are in the spirit of the project at hand, e. g.
+fitting to the general theme. For this I may make use of github
+as a discussion site, but this has a low priority right now.
+

data/bin/open

@@ -0,0 +1,7 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'open/open.rb' # Only require the minimal code for this.
+
+Open::Open.new(ARGV)

data/bin/open_in_browser

@@ -0,0 +1,7 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'open/in_browser/in_browser.rb'
+
+open_in_browser(ARGV)

data/bin/open_these_files

@@ -0,0 +1,7 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'open/these_files/these_files.rb'
+
+Open.these_files(STDIN.read)

data/bin/open_with_delay

@@ -0,0 +1,7 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'open/with_delay/with_delay.rb'
+
+Open::WithDelay.new(ARGV)

data/doc/README.gen

@@ -0,0 +1,154 @@
+ADD_DEFAULT_HEADER
+
+## History of this project
+
+In the past I used separate projects / gems, such as **OpenInEditor** or
+**OpenInBrowser**, to open files via my favourite editor, or to open
+remote URLs via my favourite browser.
+
+Additionally I also had more code aggregated in **roebe/classes/open/**.
+
+This slightly confusing situation accrued over the years, from 2010 to 2021
+or so.
+
+In early **September 2021** I reconsidered the old approach.
+
+I wanted to not only clean up the old code base, making it more flexible
+as well in the process, but **add a new API** such as:
+
+    Open.in_editor('/home/foobar.md')
+    Open.in_editor(this_file: '/home/foobar.md')
+
+As well as:
+
+    Open.in_browser(url: 'google.de', browser: 'firefox')
+
+That way we can 'think' of "Open" first, and then simply call
+the method name that we want to use. On the commandline we can
+still do:
+
+    open_in_editor foobar.rb
+    open_in_browser google.de
+
+## Layout of the project's structure
+
+This subsection will not include all details, but may serve as a slight
+introduction to how the project is layout.
+
+Most of the constants will reside under **open/constants/constants.rb**.
+
+Toplevel-methods can be found under **open/toplevel_code/** for the
+most part. This may be ignored by some classes if they add
+toplevel-methods; in that case the toplevel may be modified by such
+a class.
+
+## Optional dependencies in this project
+
+Officially there are no hardcoded dependencies in this project.
+
+However had, you are encouraged to install various gems, such as:
+
+- colours
+- convert_global_env
+- beautiful_url
+- opn
+
+These may enhance the ruby code used in this project.
+
+I highly recommend to install the **colours** gem, but ultimately
+the code in this project is written deliberately in a manner to
+make all these add-ons optional, so this is entirely up to you
+in the end.
+
+## class Open::InEditor
+
+This is used for opening a (local) file via the editor.
+
+To open a local file via the open-gem, do:
+
+    require 'open'
+
+    Open.in_editor('FILE_PATH_GOES_IN_HERE')
+    Open.in_editor('/home/x/programming/ruby/src/open/open.gemspec')
+
+## class Open::InBrowser
+
+This is used for opening a remote URL via your favourite
+browser.
+
+Upon requiring the main class, the method called:
+
+    open_in_browser()
+
+will be defined as well, to simplify working with the
+class.
+
+To specify a particular port, use this variant:
+
+    Open.open_in_browser(port: 8080)
+
+This is equivalent to this variant:
+
+    PORT_TO_USE = 8080
+    Open.in_browser(with_localhost: PORT_TO_USE)
+
+So different keywords can be used, however your brain prefers
+this or that variant.
+
+## class Open::LastUrl
+
+This small class can be used to specifically open the content
+of the xorg-buffer via the browser.
+
+## class Open::WithDelay
+
+You can open files via a delay, through class **Open::WithDelay**.
+
+You can specify a delay via:
+
+    openwithdelay 3
+
+Or via the method:
+
+    .set_use_this_delay()
+    .set_use_this_delay(3)
+    .set_use_this_delay(0.5)
+
+## Changing to a different default editor and browser
+
+In **November 2021** I realized that we need a way to more
+easily switch between the default main editor and the
+default main browser. For instance, I abandoned palemoon,
+so I needed to use firefox quickly.
+
+The old code had hardcoded calls to **palemoon**, which was
+not very elegant, and made changes to the code harder.
+
+Thus two new yaml files were added:
+
+    use_this_browser.yml
+    use_this_editor.yml
+
+Now you can modify these yaml files and use a different
+browser or editor. You can even specify the full path
+to these browsers and it should work fine.
+
+## Finding out the current editor and browser in use
+
+Use the following two methods if you wish to find out
+which is the current main editor and the current
+main browser in use.
+
+    puts Open.use_which_editor?
+    puts Open.use_which_browser?
+
+## class Open::Base
+
+This subsection contains just a few pointers to class
+**Open::Base**.
+
+The method **.this_file_was_not_found()** can be
+used to designate that a certain file (the input
+argument to that method) could not be found.
+
+ADD_CONTACT_INFORMATION

data/lib/open/base/base.rb

@@ -0,0 +1,268 @@
+#!/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
+
+  # ========================================================================= #
+  # === is_on_roebe?
+  # ========================================================================= #
+  def is_on_roebe?
+    ENV['IS_ROEBE'].to_s == '1'
+  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
+
+  # ========================================================================= #
+  # === is_on_windows?
+  # ========================================================================= #
+  def is_on_windows?
+    ::Open.is_on_windows?
+  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
+
+  # ========================================================================= #
+  # === beautiful_url
+  # ========================================================================= #
+  def beautiful_url(i)
+    result = BeautifulUrl[i] if Object.const_defined? :BeautifulUrl
+    return result
+  end
+
+end; end