opn 1.0.59

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '0391287178d37d13dcd9b1014f038e910b61e8ca6fa4cc7d5324e14455c47965'
+  data.tar.gz: 4baa2c6beb0407a1f288b135aeb175ca6c0b0247bed883d5b8af50b1d314fb07
+SHA512:
+  metadata.gz: 308a505976d2b505ef1b341a34ab008331dcc5811bb4197fc5e40405491498f6a347031eb1bc5413b9f9ce61afdda8d95c14d933512294050b0ee99a5fbc3d14
+  data.tar.gz: 50d2494b020994e5718bf5040dbc066a01f5192c7ae7dff5ff009ec8462da1fe260aaa399a6e904ccd016411f1fde92246192c465da8c4ebfe81d37cfae83a21

data/lib/opn/colours.rb

@@ -0,0 +1,30 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+module Opn
+
+  # ========================================================================= #
+  # === @use_colours
+  #
+  # Whether to use colours.
+  # ========================================================================= #
+  @use_colours = true
+
+  # ========================================================================= #
+  # === Opn.use_colours?
+  # ========================================================================= #
+  def self.use_colours?
+    @use_colours
+  end
+
+  # ========================================================================= #
+  # === Opn.disable_colours
+  #
+  # We can disable colours too.
+  # ========================================================================= #
+  def self.disable_colours
+    @use_colours = false
+  end
+
+end

data/lib/opn/module.rb

@@ -0,0 +1,381 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+module Opn
+
+  require 'opn/version/version.rb'
+  require 'opn/colours.rb'
+
+  # ========================================================================= #
+  # === @be_verbose
+  #
+  # Whether we will be verbose or whether we will be not.
+  # ========================================================================= #
+  @be_verbose = true
+
+  # ========================================================================= #
+  # === Opn.be_verbose?
+  # ========================================================================= #
+  def self.be_verbose?
+    @be_verbose
+  end
+
+  # ========================================================================= #
+  # === Opn.namespace
+  #
+  # This is a simplified variant, if you just need the namespace.
+  #
+  # If you need more flexibility, then use Opn.opn() directly - it will
+  # support more arguments.
+  # ========================================================================= #
+  def self.namespace(
+      input, optional_extra_arguments = nil
+    )
+    Opn.opn(namespace: input) { optional_extra_arguments }
+  end
+
+  # ========================================================================= #
+  # === Opn.opn
+  #
+  # This is the main method of this project.
+  #
+  # If we wish to be silent or set other options, we can do this:
+  #
+  #   Opn.opn :be_silent
+  #   Opn.opn :no_newline
+  #   Opn.opn :no_colours
+  #   Opn.opn(namespace: 'YoThere')
+  #   Opn.opn(namespace: '→')
+  #   Opn.opn(namespace: 'YoThere', be_verbose: false)
+  #
+  # Since as of September 2017, we can also pad the output if a key called
+  # :padding is passed. The argument should be like this:
+  #
+  #   padding: 18
+  #
+  # This means to use up to 18 characters, padding via ' '. 
+  # ========================================================================= #
+  def self.opn(
+      use_colours           = Opn.use_colours?,
+      be_verbose            = be_verbose?,
+      use_this_as_namespace = ''
+    )
+    # ======================================================================= #
+    # === Default values
+    #
+    # First, some default variables for intrinsic behaviour of this method.
+    # ======================================================================= #
+    shall_we_append_a_colon_character = true # By default, we append ':'.
+    append_newline = false
+    use_padding = false
+    may_we_display_anything = true # If true then we will show output.
+    # ======================================================================= #
+    # Hardcoded colours follow next - grey and green are the current options.
+    # ======================================================================= #
+    grey  = "\e[1;30m"
+    green = "\e[0;32m"
+    # ======================================================================= #
+    # Next keep a link towards the colour that we will use.
+    # ======================================================================= #
+    use_this_colour = grey
+    reset_terminal = "\e[0;37m"
+
+    # ======================================================================= #
+    # Work on the first argument given to this method next:
+    # ======================================================================= #
+    case use_colours
+    when :default
+      use_colours = Opn.use_colours?
+    when :use_colours
+      use_colours = true
+    when :no_colours
+      use_colours = false
+      be_verbose  = be_verbose?
+    when :no_newline # This is the default anyway.
+    when :newline
+      append_newline = true
+    when :be_silent, :be_quiet
+      use_colours = @use_colours # This is the default. We restore it here.
+      be_verbose  = false
+    when :be_verbose
+      use_colours = Opn.use_colours?
+      be_verbose  = be_verbose?
+    end
+    case be_verbose
+    when nil
+      be_verbose = be_verbose?
+    when :be_quiet
+      be_verbose = false
+    end
+    # ======================================================================= #
+    # use_this_as_namespace = File.basename(__FILE__) # Could use this here.
+    # use_this_as_namespace = caller[0]
+    # ======================================================================= #
+    the_caller = caller
+    if use_this_as_namespace.empty? # This is the default case then.
+      if the_caller.size > 1
+        use_this_as_namespace = the_caller[1]
+      else
+        use_this_as_namespace = the_caller.first
+      end
+    end
+    # ======================================================================= #
+    # === use_colours
+    #
+    # Next, we will handle the case when use_colours is a Hash. This may
+    # quite often be the case, as a Hash is more flexible than most other
+    # "types" in Ruby.
+    #
+    # This can be used for e. g. namespace: 'RBT::Compile'
+    # ======================================================================= #
+    if use_colours.is_a? Hash
+      copy = use_colours.dup # Keep a reference copy here.
+      # =================================================================== #
+      # === :append_colon
+      # =================================================================== #
+      if use_colours.has_key? :append_colon
+        shall_we_append_a_colon_character = use_colours.delete(:append_colon)
+      end
+      # =================================================================== #
+      # === :use_this_as_namespace
+      # =================================================================== #
+      if use_colours.has_key? :use_this_as_namespace
+        use_this_as_namespace = use_colours.fetch(:use_this_as_namespace)
+      # =================================================================== #
+      # === :use_this_namespace
+      # =================================================================== #
+      elsif use_colours.has_key? :use_this_namespace
+        use_this_as_namespace = use_colours.fetch(:use_this_namespace)
+      # =================================================================== #
+      # === :namespace
+      # =================================================================== #
+      elsif use_colours.has_key? :namespace
+        use_this_as_namespace = use_colours.fetch(:namespace)
+      end
+      # =================================================================== #
+      # === :use_opn
+      # =================================================================== #
+      if use_colours.has_key? :use_opn
+        may_we_display_anything = use_colours.fetch(:use_opn)
+      end
+      # =================================================================== #
+      # === :be_verbose
+      # =================================================================== #
+      if use_colours.has_key? :be_verbose
+        be_verbose = use_colours.delete(:be_verbose)
+      end
+      use_colours = true # Restore the default again here, since it was a Hash before.
+      # ===================================================================== #
+      # === :use_colours
+      #
+      # Check for more keys though:
+      # ===================================================================== #
+      if copy.has_key? :use_colours
+        use_colours = copy.delete(:use_colours)
+      end
+      # ===================================================================== #
+      # === :trailing_colon
+      # ===================================================================== #
+      if copy.has_key? :trailing_colon
+        shall_we_append_a_colon_character = copy.delete(:trailing_colon)
+      # ===================================================================== #
+      # === :trailing_token
+      # ===================================================================== #
+      elsif copy.has_key? :trailing_token
+        shall_we_append_a_colon_character = copy.delete(:trailing_token)
+      # ===================================================================== #
+      # === :no_trailing
+      # ===================================================================== #
+      elsif copy.has_key? :no_trailing
+        shall_we_append_a_colon_character = copy.delete(:no_trailing)
+      end
+      # ===================================================================== #
+      # === Check for :padding value
+      # ===================================================================== #
+      if copy.has_key? :padding
+        use_padding = true
+        use_this_padding = copy.delete(:padding).to_i # Must be an Integer.
+      end
+    end
+    # ======================================================================= #
+    # Check for Hash as namespace.
+    # ======================================================================= #
+    if use_this_as_namespace.is_a?(Hash) and
+       use_this_as_namespace.has_key?(:namespace)
+      use_this_as_namespace = use_this_as_namespace.delete(:namespace)
+    end
+    # ======================================================================= #
+    # Next we split on the namespace, but this may be problematic when
+    # our input contains more than one ':' such as 'RBT::Compile'.
+    # In this case, we assume that the user is smarter than we are,
+    # and we will NOT split on such input provided.
+    # ======================================================================= #
+    if use_this_as_namespace.is_a? String
+      unless use_this_as_namespace.include? '::' # ^^^ See above for the explanation.
+        use_this_as_namespace = File.basename(use_this_as_namespace.split(':').first)
+      end
+      if use_this_as_namespace.include? '_' # Assume Camelcase provided here.
+        use_this_as_namespace = use_this_as_namespace.split('_').map(&:capitalize).join
+      else # Else upcase the first argument always.
+        if use_this_as_namespace.frozen?
+          use_this_as_namespace = use_this_as_namespace.dup
+        end
+        use_this_as_namespace[0,1] = use_this_as_namespace[0,1].upcase
+      end
+      # ======================================================================= #
+      # Do some sanitizing next, by getting rid of .rb entries.
+      # ======================================================================= #
+      use_this_as_namespace = use_this_as_namespace.sub(/\.rb/,'')
+    end
+    # ======================================================================= #
+    # === Handle blocks next.
+    # ======================================================================= #
+    if block_given?
+      yielded = yield
+      case yielded
+      when :no_trailing_colon,
+           :no_trailing_character,
+           :no_trailing_char,
+           :no_trailing,
+           :no_colon,
+           :no_semicolon,
+           :short
+        shall_we_append_a_colon_character = false
+      when :show_only_the_name_of_the_class,
+           :display_only_last_name
+        # =================================================================== #
+        # In this case, show only the name of the main class. But only
+        # if the namespace includes a '::'.
+        # =================================================================== #
+        if use_this_as_namespace.include? '::'
+          use_this_as_namespace = use_this_as_namespace.split('::').last
+        end
+      # ===================================================================== #
+      # === :no_colours
+      # ===================================================================== #
+      when :no_colours, :disable_colours
+        Opn.disable_colours
+      # ===================================================================== #
+      # Next, we ought to handle Hashes passed to this method via a block.
+      # ===================================================================== #
+      when Hash
+        # =================================================================== #
+        # === :append_colon
+        # =================================================================== #
+        if yielded.has_key? :append_colon
+          shall_we_append_a_colon_character = yielded.delete(:append_colon)
+        end
+        # =================================================================== #
+        # === :use_this_as_namespace
+        # =================================================================== #
+        if    yielded.has_key?(:use_this_as_namespace)
+          use_this_as_namespace = yielded.delete :use_this_as_namespace
+        # =================================================================== #
+        # === :use_this_namespace
+        # =================================================================== #
+        elsif yielded.has_key?(:use_this_namespace)
+          use_this_as_namespace = yielded.delete :use_this_namespace
+        elsif yielded.has_key?(:namespace)
+          use_this_as_namespace = yielded.delete :namespace
+        elsif yielded.has_key?(:trailing_colon)
+          shall_we_append_a_colon_character = yielded.delete(:trailing_colon)
+        elsif yielded.has_key?(:use_colours)
+          use_colours = yielded.delete(:use_colours)
+        end
+        # =================================================================== #
+        # === :use_this_colour
+        #
+        # The user can override the colour here.
+        # =================================================================== #
+        if yielded.has_key? :use_this_colour
+          use_this_colour = return_escape_sequence_for_this_colour(
+            yielded[:use_this_colour]
+          )
+        end
+      end
+    end
+    _ = ''.dup
+    if use_colours
+      if use_this_colour.is_a? Symbol
+        # In this case we need to query the colour-code.
+        use_this_colour = Colours.remove_trailing_end_from(Colours.send(use_this_colour))
+      end
+      _ << use_this_colour
+    end
+    # ======================================================================= #
+    # Determine whether we shall append a colon character next:
+    # ======================================================================= #
+    if shall_we_append_a_colon_character and use_this_as_namespace.respond_to?(:end_with?)
+      unless use_this_as_namespace.end_with? '→' # The → is a general exception.
+        use_this_as_namespace << ':'
+      end
+    end
+    if use_this_as_namespace.is_a?(Hash) and use_this_as_namespace.empty?
+      use_this_as_namespace = ''.dup
+    end
+    if use_this_as_namespace
+      use_this_as_namespace << ' ' if use_this_as_namespace.end_with? ':'
+    end
+    # ======================================================================= #
+    # Honour padding-operations onto the main Namespace next.
+    # ======================================================================= #
+    if use_padding
+      use_this_as_namespace = use_this_as_namespace.ljust(use_this_padding)
+    end
+    # ======================================================================= #
+    # Add the separator here.
+    # ======================================================================= #
+    _ << use_this_as_namespace.to_s
+    _ << green+reset_terminal if use_colours
+    _ << "\n" if append_newline
+    if may_we_display_anything
+      print _ if be_verbose
+    end
+    return _
+  end
+
+  # ========================================================================= #
+  # === Opn.opne
+  #
+  # To test this, do:
+  #   Opn.opne 'Hello world!'
+  # ========================================================================= #
+  def self.opne(i = '')
+    Opn.opn
+    puts i
+  end
+
+  # ========================================================================= #
+  # === opne
+  # ========================================================================= #
+  def opne(i = '')
+    Opn.opne(i)
+  end
+
+  # ========================================================================= #
+  # === Opn.return_escape_sequence_for_this_colour
+  #
+  # This method can return the proper colour code.
+  # ========================================================================= #
+  def self.return_escape_sequence_for_this_colour(
+      i = :green
+    )
+    i = i.to_sym
+    case i
+    when :grey
+      i = "\e[0;30m"
+    when :green
+      i = "\e[0;32m"
+    end
+    i
+  end
+
+  # ========================================================================= #
+  # === Opn.cadetblue
+  # ========================================================================= #
+  def self.cadetblue(i)
+    "\e[38;2;70;130;180m#{i}\e[0;37m"
+  end
+
+end

data/lib/opn/opn.rb

@@ -0,0 +1,19 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'opn/module.rb'
+
+# =========================================================================== #
+# === opn                                                           (opn tag)
+#
+# This method will give the name of this script, with (optionally)
+# colours.
+# =========================================================================== #
+def opn(
+    use_colours = :default,
+    be_verbose  = true,
+    namespace   = ''
+  )
+  Opn.opn(use_colours, be_verbose, namespace)
+end; alias output_program_name opn # === output_program_name

data/lib/opn/version/version.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+module Opn
+
+  # ========================================================================= #
+  # === VERSION
+  # ========================================================================= #
+  VERSION = '1.0.59'
+
+  # ========================================================================= #
+  # === LAST_UPDATE
+  # ========================================================================= #
+  LAST_UPDATE = '07.02.2023'
+
+end

data/lib/opn.rb

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

data/opn.gemspec

@@ -0,0 +1,71 @@
+# =========================================================================== #
+# Gemspec for Project Opn.
+# =========================================================================== #
+require 'opn/version/version.rb'
+require 'roebe/toplevel_methods/misc.rb'
+require 'roebe'
+
+Gem::Specification.new { |s|
+
+  s.name        = 'opn'
+  s.version     = Opn::VERSION
+  s.date        = Time.now.strftime('%Y-%m-%d')
+  
+  s.summary = <<-EOF
+
+    This library is called opn. It will simply output the
+    name of the class. Optionally, you can assign another
+    namespace to report with. For an explanation, just
+    look at the few examples under the test/ directory.
+
+    Why did I write it?
+
+    I wrote many different ruby classes, and sometimes they will
+    report information to me, but I don't know which file wrote
+    this. So I wanted to simply have output prefaced with the
+    name of the class in question, optionally to be colourized
+    as well, since that helps me on the commandline.
+    
+    The name "opn" stands for "output program name".
+
+    Version 1.0.2 now has a proper module, called Opn,
+    and Opn has only one method called opn().
+
+
+  EOF
+  
+  s.description = <<-EOF
+
+    This library is called opn. It will simply output the
+    name of the class. Optionally, you can assign another
+    namespace to report with. For an explanation, just
+    look at the few examples under the test/ directory.
+
+    Why did I write it?
+
+    I wrote many different ruby classes, and sometimes they will
+    report information to me, but I don't know which file wrote
+    this. So I wanted to simply have output prefaced with the
+    name of the class in question, optionally to be colourized
+    as well, since that helps me on the commandline.
+
+    The name "opn" stands for "output program name".
+
+    Version 1.0.2 now has a proper module, called Opn,
+    and Opn has only one method called opn().
+
+  EOF
+  require 'roebe'
+  s.extra_rdoc_files = %w()
+  
+  s.authors  = ['Robert A. Heiler']
+  s.email    = Roebe.email?
+  s.files    = Dir['**/*']
+  s.license  = 'MIT'
+  s.homepage = 'https://rubygems.org/gems/opn'
+
+  s.required_ruby_version     = '>= '+Roebe.third_most_stable_version_of_ruby
+  s.required_rubygems_version = '>= '+Gem::VERSION
+  s.rubygems_version          = '>= '+Gem::VERSION
+
+}

data/test/testing_opn.rb

@@ -0,0 +1,74 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# =========================================================================== #
+require 'colours/autoinclude'
+require 'opn/module'
+require 'cliner'
+
+NAMESPACE = inspect
+
+# =========================================================================== #
+# === palegoldenrod
+# =========================================================================== #
+def palegoldenrod(i)
+  ::Colours.palegoldenrod(i)
+end
+MAIN_NAMESPACE = { namespace: 'RBT::Compile' }
+e ::Colours.slateblue('Seven (7)')+' examples for Opn.opn will come next -'
+e 'and one example for Opn.namespace():'
+cliner
+e "(1) First, we test "+palegoldenrod("Opn.opn(namespace: 'YoThere')")
+Opn.opn(namespace: 'YoThere'); e
+cliner
+e '(2) Next, we test '+palegoldenrod('Opn.opn(:no_colours)')
+Opn.opn(:no_colours); e
+cliner
+e '(3) Next, we test '+palegoldenrod('Opn.opn')
+Opn.opn; e
+cliner
+e '(4) Next, we test '+palegoldenrod('Opn.opn(use_colours: false)')
+Opn.opn(use_colours: false); e
+cliner
+e '(5) Next, we test '+palegoldenrod('Opn.opn(MAIN_NAMESPACE)')+' - 4 times in total'
+Opn.opn(MAIN_NAMESPACE); e
+cliner
+Opn.opn(MAIN_NAMESPACE); e
+Opn.opn(MAIN_NAMESPACE); e
+Opn.opn(MAIN_NAMESPACE); e
+cliner
+e '(6) Next, we will use the main namespace again but without '\
+  'colours.'
+e '    So: '+palegoldenrod('Opn.opn(namespace: MAIN_NAMESPACE, use_colours: false)')
+Opn.opn(namespace: MAIN_NAMESPACE, use_colours: false); e
+cliner
+e '(7) Next, testing '+palegoldenrod('Opn.namespace NAMESPACE')
+Opn.namespace NAMESPACE; e
+cliner
+e '(8) Next, testing '+palegoldenrod('Opn.namespace("→")')
+Opn.namespace('→'); e 'Hello there!'
+cliner
+e '(9) Next, testing '+palegoldenrod('Opn.namespace("John→Doe")')
+Opn.namespace('John→Doe'); e 'Hello there!'
+cliner
+e '(10) Next, testing '+palegoldenrod('Opn.opn(padding: 18)')
+Opn.opn(padding: 18); e 'Hello there!'
+Opn.opn(padding: 12); e 'Hello there!'
+Opn.opn(padding: 22); e 'Hello there!'
+cliner
+e '(11) Next, testing '+palegoldenrod('Opn.opn({:namespace=>"RBT::CreateAppDirSkeleton", :use_colours=>true, :use_opn=>false})')
+Opn.opn(
+  {:namespace=>"RBT::CreateProgram", :use_colours=>true, :use_opn=>false}
+)
+cliner
+e '(12) Next testing '+palegoldenrod('Opn.opn {{ use_this_colour: :green }}')+':'
+Opn.opn {{ use_this_colour: :green }}; e
+cliner
+e '(13) Next testing '+whitesmoke('Opn.opn {{ use_this_colour: :whitesmoke }}')+':'
+Opn.opn {{ use_this_colour: :whitesmoke }}; e
+cliner
+e '(14) Next testing '+palegoldenrod('Opn.opn {{ use_this_colour: :palegoldenrod }}')+':'
+Opn.opn {{ use_this_colour: :palegoldenrod }}; e
+cliner
+e '(15) Next testing '+mediumpurple('Opn.opn {{ use_this_colour: :mediumpurple }}')+':'
+Opn.opn {{ use_this_colour: :mediumpurple }}; e
+

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: opn
+version: !ruby/object:Gem::Version
+  version: 1.0.59
+platform: ruby
+authors:
+- Robert A. Heiler
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-02-07 00:00:00.000000000 Z
+dependencies: []
+description: |2+
+
+      This library is called opn. It will simply output the
+      name of the class. Optionally, you can assign another
+      namespace to report with. For an explanation, just
+      look at the few examples under the test/ directory.
+
+      Why did I write it?
+
+      I wrote many different ruby classes, and sometimes they will
+      report information to me, but I don't know which file wrote
+      this. So I wanted to simply have output prefaced with the
+      name of the class in question, optionally to be colourized
+      as well, since that helps me on the commandline.
+
+      The name "opn" stands for "output program name".
+
+      Version 1.0.2 now has a proper module, called Opn,
+      and Opn has only one method called opn().
+
+email: shevy@inbox.lt
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/opn.rb
+- lib/opn/colours.rb
+- lib/opn/module.rb
+- lib/opn/opn.rb
+- lib/opn/version/version.rb
+- opn.gemspec
+- test/testing_opn.rb
+homepage: https://rubygems.org/gems/opn
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.6
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.4.5
+requirements: []
+rubygems_version: 3.4.5
+signing_key:
+specification_version: 4
+summary: This library is called opn. It will simply output the name of the class.
+  Optionally, you can assign another namespace to report with. For an explanation,
+  just look at the few examples under the test/ directory.  Why did I write it?  I
+  wrote many different ruby classes, and sometimes they will report information to
+  me, but I don't know which file wrote this. So I wanted to simply have output prefaced
+  with the name of the class in question, optionally to be colourized as well, since
+  that helps me on the commandline.  The name "opn" stands for "output program name".  Version
+  1.0.2 now has a proper module, called Opn, and Opn has only one method called opn().
+test_files: []
+...