open 0.1.30 → 0.2.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e4eff5815591683e6976282591579cd498be53e5b2c2159a0126b636a98eef0
-  data.tar.gz: d48d7c9749e89819b821ae9de54e7e8630025415a82294dcafbb9052361aa67b
+  metadata.gz: b1c3425ed79b565564194a1b67e534077e529212ffb2ee72110db2986863f663
+  data.tar.gz: 93378a5eb50713e002cc5f3487b7006349bbe0e325680b22473c4167264a09e5
 SHA512:
-  metadata.gz: be4686662a3c32e3db742e02179f846ca7fd4a8b1c8c0f9e17be69feec48a9292643411795a35245490850205fc2401b9057ddb163dd8454f0da15c247f6417b
-  data.tar.gz: 5047cc0c99fea50c40951f04977358f5e39795054b9bbe4eecb55c001bd3ca75210a65c1de89bd8c29ae5b5b1d780e21a5e327bc5db88ff293313ca9c9504729
+  metadata.gz: be20389b78324047bfe10e566e6aab2db33b8fc3aab7dea8e704702a9145c3d8ab0df78bd1a73ef2277c415cc358b5e148bb2fabb815aba08bdc0f1f46c31dd3
+  data.tar.gz: 6b489e0365780d7af127c287367476c9d598c87877feb034cfabe79044cbaf13627c9baf1773be61adc1129ec4de0fb8351d2bbc45dfc01e73d3e3720410f9d7

data/README.md

@@ -2,7 +2,9 @@
 [![forthebadge](https://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)
 
-This gem was <b>last updated</b> on the <span style="color: darkblue; font-weight: bold">16.05.2023</span> (dd.mm.yyyy notation), at <span style="color: steelblue; font-weight: bold">15:26:58</span> o'clock.
+This gem was <b>last updated</b> on the <span style="color: darkblue; font-weight: bold">19.07.2023</span> (dd.mm.yyyy notation), at <span style="color: steelblue; font-weight: bold">15:41:56</span> o'clock.
+
+<img src="https://i.imgur.com/JFJ1PGz.png" style="margin: 0.5em">
 
 ## History of this project
 
@@ -41,22 +43,24 @@ 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
+Toplevel-methods can be found under **open/toplevel_methods/** 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, and **can subsequently be found in that .rb file where the
-class is defined** (or the directory, if this class is split up 
+toplevel-methods directly; in that case the toplevel may be modified by
+such a class, and **can subsequently be found in that .rb file where
+the class is defined** (or the directory, if this class is split up 
 into several different .rb files).
 
 So, for instance, **class Open::Browser** may define a toplevel
-method called **Open.in_browser()**. You can also **grep** (on Linux)
-for where the source code resides specifically, of course.
+method called **Open.in_browser()**.
+
+You can also **grep** (on Linux) for where the source code resides
+specifically, of course.
 
 ## 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:
+However had, you are <b>encouraged</b> to install various gems, such as:
 
 - colours
 - convert_global_env
@@ -68,7 +72,49 @@ 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.
+in the end. (If you find some part of the project that makes
+any of these external dependencies mandatory rather than optional,
+consider it a bug. Feel free to report it, to see it changed - 
+but I should have covered all these cases already, so it should
+be highly unlikely that you can find **external** dependencies
+that are not guarded via a begin/rescue clause.)
+
+## The various open-related activities in this gem
+
+You can "open" many different things: a local file or a remote
+URL (in the browser). When it comes to opening local files we
+can also distinguish whether you want to open in your primary
+editor, open in a a video-player, open a .pdf file in a pdf-viewer
+and so on and so forth, so we want to be able to distinguish
+between these <b>different use cases</b>.
+
+The primary activity for this gem is to open a remote URL. In
+fact: this was the reason why this gem was initially created.
+I wanted to be able to open all registered URLs from another
+gem, called BeautifulUrl, in the web browser. Then I can, for
+instance, do this:
+
+    rf local_sitemap
+
+And the local sitemap (a .cgi or .sinatra fila) will be
+opened in my browser (thorium usually), on the commandline.
+
+This allows me to quickly navigate to all my local web-pages
+and I can use them as-is. For instance, I had in the past
+used one webpage that would inform me about upcoming
+exams at universities. It is quite convenient to view this
+in the browser. So, this is the functionality covered by
+Open.in_browser() specifically.
+
+The next use case, the secondary use case, is Open.in_editor().
+Here I wanted to be able to open a local file in my favourite
+editor - a modified variant of the <b>bluefish</b> editor.
+
+<b>Every other open-related functionality</b>, such as opening a 
+local .pdf file, is bundled into the "<b>remaining</b>" use cases
+herein. In other words: these other use cases are not as relevant
+and important as the two other use cases described above
+this paragraph.
 
 ## class Open::InEditor
 
@@ -139,6 +185,14 @@ is, simply issue <b>the following command</b>:
 
     open --browser?
 
+At the least on my home system, if a certain environment
+variable is set to 1, class Open::InBrowser will
+prepend a localhost string. If this is unwanted
+then <b>--do-not-use-localhost</b> can be used to
+avoid that. For most users of this project this is
+irrelevant, as there is a check anyway for that
+environment variable.
+
 ## class Open::LastUrl
 
 This small class can be used to specifically open the content
@@ -266,6 +320,16 @@ own use cases. I needed this functionality to batch-open a
 "project", based on individual files, so this functionality
 was added in <b>March 2023</b>.
 
+## Handling .pdf files
+
+You can call this method to find out which PDF viewer will be
+used:
+
+    Open.pdf_viewer?
+
+I recommend to install the gem <b>pdf_paradise</b> - it handles
+all my .pdf related needs.
+
 
 ## Contact information and mandatory 2FA coming up in 2022
 

data/bin/open

@@ -2,6 +2,6 @@
 # Encoding: UTF-8
 # frozen_string_literal: true
 # =========================================================================== #
-require 'open/open.rb' # Only require the minimal code for this.
+require 'open/open/open.rb' # Only require the minimal code for this.
 
 Open::Open.new(ARGV)

data/bin/open_in_browser

@@ -4,4 +4,4 @@
 # =========================================================================== #
 require 'open/in_browser/in_browser.rb'
 
-open_in_browser(ARGV)
+Open.in_browser(ARGV)

data/doc/README.gen

@@ -1,5 +1,7 @@
 DEFAULT_HEADER
 
+<img src="https://i.imgur.com/JFJ1PGz.png" style="margin: 0.5em">
+
 ## History of this project
 
 In the past I used separate projects / gems, such as **OpenInEditor** or
@@ -37,22 +39,24 @@ 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
+Toplevel-methods can be found under **open/toplevel_methods/** 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, and **can subsequently be found in that .rb file where the
-class is defined** (or the directory, if this class is split up 
+toplevel-methods directly; in that case the toplevel may be modified by
+such a class, and **can subsequently be found in that .rb file where
+the class is defined** (or the directory, if this class is split up 
 into several different .rb files).
 
 So, for instance, **class Open::Browser** may define a toplevel
-method called **Open.in_browser()**. You can also **grep** (on Linux)
-for where the source code resides specifically, of course.
+method called **Open.in_browser()**.
+
+You can also **grep** (on Linux) for where the source code resides
+specifically, of course.
 
 ## 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:
+However had, you are <b>encouraged</b> to install various gems, such as:
 
 - colours
 - convert_global_env
@@ -64,7 +68,49 @@ 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.
+in the end. (If you find some part of the project that makes
+any of these external dependencies mandatory rather than optional,
+consider it a bug. Feel free to report it, to see it changed - 
+but I should have covered all these cases already, so it should
+be highly unlikely that you can find **external** dependencies
+that are not guarded via a begin/rescue clause.)
+
+## The various open-related activities in this gem
+
+You can "open" many different things: a local file or a remote
+URL (in the browser). When it comes to opening local files we
+can also distinguish whether you want to open in your primary
+editor, open in a a video-player, open a .pdf file in a pdf-viewer
+and so on and so forth, so we want to be able to distinguish
+between these <b>different use cases</b>.
+
+The primary activity for this gem is to open a remote URL. In
+fact: this was the reason why this gem was initially created.
+I wanted to be able to open all registered URLs from another
+gem, called BeautifulUrl, in the web browser. Then I can, for
+instance, do this:
+
+    rf local_sitemap
+
+And the local sitemap (a .cgi or .sinatra fila) will be
+opened in my browser (thorium usually), on the commandline.
+
+This allows me to quickly navigate to all my local web-pages
+and I can use them as-is. For instance, I had in the past
+used one webpage that would inform me about upcoming
+exams at universities. It is quite convenient to view this
+in the browser. So, this is the functionality covered by
+Open.in_browser() specifically.
+
+The next use case, the secondary use case, is Open.in_editor().
+Here I wanted to be able to open a local file in my favourite
+editor - a modified variant of the <b>bluefish</b> editor.
+
+<b>Every other open-related functionality</b>, such as opening a 
+local .pdf file, is bundled into the "<b>remaining</b>" use cases
+herein. In other words: these other use cases are not as relevant
+and important as the two other use cases described above
+this paragraph.
 
 ## class Open::InEditor
 
@@ -135,6 +181,14 @@ is, simply issue <b>the following command</b>:
 
     open --browser?
 
+At the least on my home system, if a certain environment
+variable is set to 1, class Open::InBrowser will
+prepend a localhost string. If this is unwanted
+then <b>--do-not-use-localhost</b> can be used to
+avoid that. For most users of this project this is
+irrelevant, as there is a check anyway for that
+environment variable.
+
 ## class Open::LastUrl
 
 This small class can be used to specifically open the content
@@ -262,4 +316,14 @@ own use cases. I needed this functionality to batch-open a
 "project", based on individual files, so this functionality
 was added in <b>March 2023</b>.
 
+## Handling .pdf files
+
+You can call this method to find out which PDF viewer will be
+used:
+
+    Open.pdf_viewer?
+
+I recommend to install the gem <b>pdf_paradise</b> - it handles
+all my .pdf related needs.
+
 ADD_CONTACT_INFORMATION

data/doc/deprecated_code/deprecated_code.md

@@ -0,0 +1,26 @@
+Since as of June 2023, class Open::InBrowser
+contained this code chunk:
+
+    if File.exist?(real_filename) and
+       !real_filename.start_with?('file://') and
+       !entry.include?('http://localhost/')
+      entry = entry.dup
+      entry.prepend('file://')
+    end
+
+So we just prepended 'file://'. I do not think we need
+this anymore, though.
+
+Since as of June 2023, the following code was removed
+as well:
+
+    if Object.const_defined? :Studium
+      possible_link = Studium.return_remote_homepage_of_this_lecture(entry)
+      if possible_link == entry
+      else
+        entry = possible_link
+      end
+    end
+
+I believe we already handle this case, without needing
+to re-check it again.