open 0.1.30 → 0.2.13

data/lib/open/project/project.rb

@@ -41,6 +41,7 @@ module Open
 end
 
 if __FILE__ == $PROGRAM_NAME
-  puts Open.project_base_dir?
-  puts Open.project_yaml_dir?
+  alias e puts
+  e Open.project_base_dir?
+  e Open.project_yaml_dir?
 end

data/lib/open/requires/failsafe_require_of_beautiful_url.rb

@@ -0,0 +1,9 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'open/requires/failsafe_require_of_beautiful_url.rb'
+# =========================================================================== #
+begin
+  require 'beautiful_url'
+rescue LoadError; end

data/lib/open/requires/require_the_project.rb

@@ -3,13 +3,13 @@
 # frozen_string_literal: true
 # =========================================================================== #
 require 'open/constants/constants.rb'
-require 'open/toplevel_code/toplevel_code.rb'
+require 'open/toplevel_methods/misc.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/open/open.rb'
 require 'open/nano_open/nano_open.rb'
 require 'open/these_files/these_files.rb'

data/lib/open/requires/require_yaml.rb

@@ -0,0 +1,13 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'open/requires/require_yaml.rb'
+# =========================================================================== #
+module Open
+
+  begin
+    require 'yaml'
+  rescue LoadError; end
+
+end

data/lib/open/these_files/these_files.rb

@@ -76,7 +76,7 @@ class TheseFiles < Base # === Open::TheseFiles
       i = input?
     )
     i.each {|entry|
-      Open.in_editor(i)
+      ::Open.in_editor(i)
       sleep(@use_this_delay)
     }
   end

data/lib/open/toplevel_methods/browser.rb

@@ -0,0 +1,71 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'open/toplevel_methods/browser.rb'
+# =========================================================================== #
+module Open
+
+  require 'open/constants/constants.rb'
+
+  # ========================================================================= #
+  # === @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.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 = "#{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
+  alias e puts
+  e Open.use_which_browser?
+end

data/lib/open/toplevel_methods/delay.rb

@@ -0,0 +1,23 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'open/toplevel_methods/delay.rb'
+# =========================================================================== #
+module Open
+
+  # ========================================================================= #
+  # === Open.use_which_delay?
+  # ========================================================================= #
+  def self.use_which_delay?
+    require 'open/project/project.rb'
+    require 'open/requires/require_yaml.rb'
+    _ = "#{project_base_directory?}yaml/use_this_delay.yml"
+    if File.exist? _
+      YAML.load_file(_)
+    else
+      '1.0'
+    end
+  end
+
+end

data/lib/open/toplevel_methods/e.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+module Open
+
+  # ========================================================================= #
+  # === Open.e
+  # ========================================================================= #
+  def self.e(i = '')
+    puts i
+  end
+
+end

data/lib/open/toplevel_methods/editor.rb

@@ -0,0 +1,41 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'open/toplevel_methods/editor.rb'
+# =========================================================================== #
+module Open
+
+  require 'open/constants/constants.rb'
+
+  # ========================================================================= #
+  # === @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; self.instance_eval { alias editor? use_which_editor? } # === Open.editor?
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  alias e puts
+  e Open.use_which_editor?  
+end

data/lib/open/toplevel_methods/host_os.rb

@@ -0,0 +1,25 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'open/toplevel_methods/host_os.rb'
+# =========================================================================== #
+module Open
+
+  # ========================================================================= #
+  # === Open.host_os?
+  #
+  # Return the host-operating system via this method.
+  #
+  # On linux this method would yield the String "linux".
+  # ========================================================================= #
+  def self.host_os?
+    ::RbConfig::CONFIG['host_os']
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  alias e puts
+  e Open.host_os?
+end

data/lib/open/toplevel_methods/is_on_roebe.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'open/toplevel_methods/is_on_roebe.rb'
+# =========================================================================== #
+module Open
+
+  # ========================================================================= #
+  # === Roebe.is_on_roebe?
+  # ========================================================================= #
+  def self.is_on_roebe?
+    ENV['IS_ROEBE'].to_s == '1'
+  end
+
+end

data/lib/open/toplevel_methods/is_on_windows.rb

@@ -0,0 +1,26 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'open/toplevel_methods/is_on_windows.rb'
+# =========================================================================== #
+module Open
+
+  require 'open/toplevel_methods/host_os.rb'
+
+  # ========================================================================= #
+  # === 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
+
+end

data/lib/open/toplevel_methods/misc.rb

@@ -0,0 +1,50 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'open/toplevel_methods/misc.rb'
+# =========================================================================== #
+module Open
+
+  require 'open/constants/constants.rb'
+
+  # ========================================================================= #
+  # === 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
+
+end

data/lib/open/version/version.rb

@@ -9,11 +9,11 @@ module Open
   # ========================================================================= #
   # === VERSION
   # ========================================================================= #
-  VERSION = '0.1.30'
+  VERSION = '0.2.13'
 
   # ========================================================================= #
   # === LAST_UPDATE
   # ========================================================================= #
-  LAST_UPDATE = '16.05.2023'
+  LAST_UPDATE = '19.07.2023'
 
 end

data/lib/open/with_delay/with_delay.rb

@@ -54,13 +54,10 @@ class WithDelay < Base # === Open::WithDelay
   # ========================================================================= #
   def reset
     super()
+    infer_the_namespace
     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
@@ -139,14 +136,15 @@ class WithDelay < Base # === Open::WithDelay
   # === report_the_delay_in_use
   # ========================================================================= #
   def report_the_delay_in_use
-    opnn; e "The delay is `#{simp(delay?.to_s)}` seconds."
+    opne "#{steelblue('The delay is `')}"\
+         "#{simp(delay?.to_s)}#{steelblue('` seconds.')}"
   end
 
   # ========================================================================= #
   # === menu                                                       (menu tag)
   # ========================================================================= #
   def menu(
-      i = @commandline_arguments
+      i = commandline_arguments?
     )
     if i.is_a? Array
       i.each {|entry| menu(entry) }
@@ -223,12 +221,12 @@ class WithDelay < Base # === Open::WithDelay
     )
     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."
+    opne "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."
+      opne 'Next opening the file `'+sfile(this_file)+
+           '` via the editor '+sfancy(using_this_editor)+','
+      opne "then sleeping for #{simp(delay)} seconds."
       Open.in_editor(this_file)
       sleep(delay.to_f) # Must be treated as a Float.
     }

data/open.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new { |s|
   DESCRIPTION = <<-EOF
 
 This project can be used to open an URL in a browser, usually
-via a browser such as firefo, palemoon or vivaldi. It can also be used
+via a browser such as firefox, palemoon or vivaldi. It can also be used
 to open a local file in an editor. The latter has been a reason
 why the API was created in the first place, via Open.in_editor()
 or Open.in_browser().

data/test/testing_open.rb

@@ -21,7 +21,7 @@ open_in_browser 'linux', '?pdf'
 open_in_browser 'http://localhost/programming/ruby/src/chemistry_paradise/lib/chemistry_paradise/www/chemistry/chemistry.cgi',
                 'Absolutkonfiguration'
 e
-e 'Next testing the project called '+sfancy('open')+'.'
+e "Next testing the project called #{sfancy('open')}."
 e
 
 e

data/test/testing_open_in_browser.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'open/in_browser/in_browser.rb'
+
+alias e puts
+
+e 'Testing various aspects of Open.in_browser() next.'
+e
+_ = '/home/x/Temp/studium/html/timetable.html#today'
+e 'First, we need to test `'+_+'`.'
+e
+Open.in_browser(_)
+Open.in_browser(:default_sinatra_port)
+Open.in_browser(port: 8080) { :use_launchy } # This one will test "launchy".

data/test/testing_open_via_launchy.rb

@@ -0,0 +1,3 @@
+require 'open'
+
+Open.in_browser('https://blog.fefe.de/') { :use_launchy }

data/test/testing_shortcuts.rb

@@ -0,0 +1,3 @@
+require 'open'
+
+Open::Open[:gamebooks]

metadata

@@ -1,19 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: open
 version: !ruby/object:Gem::Version
-  version: 0.1.30
+  version: 0.2.13
 platform: ruby
 authors:
 - Robert A. Heiler
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-16 00:00:00.000000000 Z
+date: 2023-07-19 00:00:00.000000000 Z
 dependencies: []
 description: |2+
 
   This project can be used to open an URL in a browser, usually
-  via a browser such as firefo, palemoon or vivaldi. It can also be used
+  via a browser such as firefox, palemoon or vivaldi. It can also be used
   to open a local file in an editor. The latter has been a reason
   why the API was created in the first place, via Open.in_editor()
   or Open.in_browser().
@@ -30,19 +30,32 @@ files:
 - bin/open_these_files
 - bin/open_with_delay
 - doc/README.gen
+- doc/deprecated_code/deprecated_code.md
+- img/open_logo.png
 - lib/open.rb
 - lib/open/base/base.rb
+- lib/open/books/README.md
+- lib/open/books/books.rb
 - lib/open/constants/constants.rb
 - lib/open/in_browser/in_browser.rb
 - lib/open/in_editor/in_editor.rb
 - lib/open/last/last.rb
 - lib/open/last_url/last_url.rb
 - lib/open/nano_open/nano_open.rb
-- lib/open/open.rb
+- lib/open/open/open.rb
 - lib/open/project/project.rb
+- lib/open/requires/failsafe_require_of_beautiful_url.rb
 - lib/open/requires/require_the_project.rb
+- lib/open/requires/require_yaml.rb
 - lib/open/these_files/these_files.rb
-- lib/open/toplevel_code/toplevel_code.rb
+- lib/open/toplevel_methods/browser.rb
+- lib/open/toplevel_methods/delay.rb
+- lib/open/toplevel_methods/e.rb
+- lib/open/toplevel_methods/editor.rb
+- lib/open/toplevel_methods/host_os.rb
+- lib/open/toplevel_methods/is_on_roebe.rb
+- lib/open/toplevel_methods/is_on_windows.rb
+- lib/open/toplevel_methods/misc.rb
 - lib/open/version/version.rb
 - lib/open/with_delay/with_delay.rb
 - lib/open/yaml/shortcuts.yml
@@ -51,6 +64,9 @@ files:
 - lib/open/yaml/use_this_editor.yml
 - open.gemspec
 - test/testing_open.rb
+- test/testing_open_in_browser.rb
+- test/testing_open_via_launchy.rb
+- test/testing_shortcuts.rb
 homepage: https://rubygems.org/gems/open_in_browser
 licenses:
 - MIT
@@ -68,13 +84,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.4.13
+      version: 3.4.15
 requirements: []
-rubygems_version: 3.4.13
+rubygems_version: 3.4.15
 signing_key:
 specification_version: 4
 summary: This project can be used to open an URL in a browser, usually via a browser
-  such as firefo, palemoon or vivaldi. It can also be used to open a local file in
+  such as firefox, palemoon or vivaldi. It can also be used to open a local file in
   an editor. The latter has been a reason why the API was created in the first place,
   via Open.in_editor() or Open.in_browser().
 test_files: []