mountpoints 1.1.3 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c85d47f97cbafda0facc4764b4edade704a5b6fca8e8789c8cea3ecf8e2ceefb
-  data.tar.gz: 8c96e1778f10f7e12feb708b3823a9a18525db577e6ff2cd455c426f1f7afec5
+  metadata.gz: 8b0855050bed99b01644fa83a4ea8f15330234b30c6a79622968a1c07f4b5a71
+  data.tar.gz: 4970dd1d922f8e42ebc43e1912025d13512978c8604a7d9d3f5c525ab4738000
 SHA512:
-  metadata.gz: df3c8b23e3ce1b8417b1423f532aac1ba6840a87b3d6d14a957155701fc438f31a8f95603809eefc5a639096296683f92f0cef4e5a57902e0ed45af883ec4920
-  data.tar.gz: 3982fecdeee18c74999b5b884d3a16e4123cfde2dbcbb192e4ed3dcf97ae570b8cdd71560af88f84e5a2028baa71f66ed770be88e9392b721751477490a674f5
+  metadata.gz: ef6336f27b1a1883fdd5881ea16d13a9f32b2e3eaf4ba868451fcac4d47ede3972d86471fb1fadd773021e684850aad2765af6d33c258d6537f5c380b209fbe7
+  data.tar.gz: 297b56feeab21918d8707c589ce6b5c16c169b7b14328c8ca384f5a247f8829ab4731be73fde617fd7df16bf38a3c307d9511812d03e76e80981c94de1554b6f

data/README.md

@@ -2,37 +2,76 @@
 [![forthebadge](http://forthebadge.com/images/badges/made-with-ruby.svg)](https://www.ruby-lang.org/en/)
 [![Gem Version](https://badge.fury.io/rb/mountpoints.svg)](https://badge.fury.io/rb/mountpoints)
 
-This gem was <b>last updated</b> on the <span style="color: darkblue; font-weight: bold">15.05.2022</span> (dd.mm.yyyy notation), at <span style="color: steelblue; font-weight: bold">03:48:52</span> o'clock.
+This gem was <b>last updated</b> on the <span style="color: darkblue; font-weight: bold">15.05.2022</span> (dd.mm.yyyy notation), at <span style="color: steelblue; font-weight: bold">23:56:46</span> o'clock.
 
-## Goals of this project
+<img src="https://i.imgur.com/Oi4pNNi.png" style="margin: 1em">
 
-This project shall simply display the available mountpoints for
-USB devices.
+## The goals for the mountpoints project
 
-Usage example:
+The mountpoints project shall simply display the available mountpoints
+for USB devices. This should ideally work on Linux as well on Windows -
+and, if possible, on other operating systems as well.
+
+## Simple usage example
+
+Consider using the mountpoints gem like this, after installation:
 
     require 'mountpoints'
-    pp Mountpoints[] # This will return an Array, which contains the mounted devices.
+    pp Mountpoints[] # This will (quietly) return an Array, which contains the mounted devices.
+
+Alternative you can use it from the commandline, in which case it
+will report to you (the user) what it has found, such as "Discovered
+mountpoint /mnt/usb1/." or something like that.
 
 ## Commandline flags
 
 The flag **--extra-verbose** can be used to report more information about
-the mounpoints (on Linux).
+the mountpoints (on **Linux**).
+
+## Storing the mountpoints internally
+
+The current policy is to store all mountpoints as **directories**, that
+is via a trailing **/**. So if the mountpoint is normally **/Mount/USB1**
+then this will be stored as **/Mount/USB1/**.
+
+The reason I document this here is so that I can refer to this policy
+in case anything changes - and if this document is updated. As of **May
+2022 this is the case**. This may be subject to change one day, but
+I expect this to remain as long as the mountpoints gem will be made
+available here on **rubygems.org**.
 
 ## Using the project on windows
 
-On linux we can use "fdisk -l" and this should work fine.
+On **Linux** we can simply use "**fdisk -l**" and this should work
+fine. If **fdisk** is not available then **df** may suffice. (Since
+as of the rewrite in **May 2022** the mountpoints gem now defaults
+to df on linux, actually.)
 
-On Windows we have to use another way. I picked **wmic**.
+On **Windows** we have to use another way. I picked **wmic**.
 
-Example:
+Usage example for **wmic**:
 
     wmic logicaldisk where "drivetype=3" get DeviceID
 
 This then gets parsed and the last line is assumed to be the
 currently inserted USB harddisc. This evidently may break for
-many use cases, which is why I document it here - but for
-my own simple use cases this actually works.
+many use cases, in particular when there are several USB
+devices mount, which is why I document this here - but for
+my own simple use cases this actually works, and I verified
+that this indeed does work for simple use cases.
+
+In **May 2022* two ad-hoc methods were added called:
+
+    Mountpoints.windows1
+    Mountpoints.windows2
+
+These will run the corresponding wmic commands via `` backticks
+as well as output the command that is run.
+
+Regular users won't really need to run this, but in the event
+that something isn't right you can use these two methods
+conveniently. It's mostly for debugging, though, so most users
+will not need to run this.
 
 
 ## Contact information

data/bin/mountpoints

@@ -0,0 +1,7 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+require 'mountpoints'
+
+Mountpoints.new

data/doc/README.gen

@@ -1,34 +1,72 @@
-ADD_RUBY_HEAD
-ADD_MAIN_TIMESTAMP
+ADD_RUBY_LOGO_AND_TIMESTAMP
 
-## Goals of this project
+<img src="https://i.imgur.com/Oi4pNNi.png" style="margin: 1em">
 
-This project shall simply display the available mountpoints for
-USB devices.
+## The goals for the mountpoints project
 
-Usage example:
+The mountpoints project shall simply display the available mountpoints
+for USB devices. This should ideally work on Linux as well on Windows -
+and, if possible, on other operating systems as well.
+
+## Simple usage example
+
+Consider using the mountpoints gem like this, after installation:
 
     require 'mountpoints'
-    pp Mountpoints[] # This will return an Array, which contains the mounted devices.
+    pp Mountpoints[] # This will (quietly) return an Array, which contains the mounted devices.
+
+Alternative you can use it from the commandline, in which case it
+will report to you (the user) what it has found, such as "Discovered
+mountpoint /mnt/usb1/." or something like that.
 
 ## Commandline flags
 
 The flag **--extra-verbose** can be used to report more information about
-the mounpoints (on Linux).
+the mountpoints (on **Linux**).
+
+## Storing the mountpoints internally
+
+The current policy is to store all mountpoints as **directories**, that
+is via a trailing **/**. So if the mountpoint is normally **/Mount/USB1**
+then this will be stored as **/Mount/USB1/**.
+
+The reason I document this here is so that I can refer to this policy
+in case anything changes - and if this document is updated. As of **May
+2022 this is the case**. This may be subject to change one day, but
+I expect this to remain as long as the mountpoints gem will be made
+available here on **rubygems.org**.
 
 ## Using the project on windows
 
-On linux we can use "fdisk -l" and this should work fine.
+On **Linux** we can simply use "**fdisk -l**" and this should work
+fine. If **fdisk** is not available then **df** may suffice. (Since
+as of the rewrite in **May 2022** the mountpoints gem now defaults
+to df on linux, actually.)
 
-On Windows we have to use another way. I picked **wmic**.
+On **Windows** we have to use another way. I picked **wmic**.
 
-Example:
+Usage example for **wmic**:
 
     wmic logicaldisk where "drivetype=3" get DeviceID
 
 This then gets parsed and the last line is assumed to be the
 currently inserted USB harddisc. This evidently may break for
-many use cases, which is why I document it here - but for
-my own simple use cases this actually works.
+many use cases, in particular when there are several USB
+devices mount, which is why I document this here - but for
+my own simple use cases this actually works, and I verified
+that this indeed does work for simple use cases.
+
+In **May 2022* two ad-hoc methods were added called:
+
+    Mountpoints.windows1
+    Mountpoints.windows2
+
+These will run the corresponding wmic commands via `` backticks
+as well as output the command that is run.
+
+Regular users won't really need to run this, but in the event
+that something isn't right you can use these two methods
+conveniently. It's mostly for debugging, though, so most users
+will not need to run this.
 
 ADD_CONTACT_INFORMATION

data/lib/mountpoints/class/mountpoints.rb

@@ -0,0 +1,425 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === Mountpoints
+#
+# The primary objective of this class is to scan for all mounted USB-devices.
+#
+# Note that toplevel-methods, that is in the form of Mountpoints.foobar(),
+# will be stored in another .rb file, aptly named "toplevel_methods.rb".
+#
+# Colours may be used on the commandline if the .report() method is
+# called and if use_colours? returns true (which is the default).
+#
+# Usage examples:
+#
+#   Mountpoints.new(ARGV)
+#   Mountpoints.new
+#   Mountpoints.show
+#   Mountpoints.is_any_mountpoint_available?
+#
+# =========================================================================== #
+# require 'mountpoints/class/mountpoints.rb'
+# =========================================================================== #
+class Mountpoints # === Mountpoints
+
+  begin
+    require 'colours'
+  rescue LoadError; end
+
+  begin
+    require 'opn'
+  rescue LoadError; end
+
+  require 'mountpoints/constants/constants.rb'
+  require 'mountpoints/toplevel_methods/toplevel_methods.rb'
+  require 'mountpoints/version/version.rb'
+
+  # ========================================================================= #
+  # === NAMESPACE
+  # ========================================================================= #
+  NAMESPACE = inspect
+
+  # ========================================================================= #
+  # === N
+  # ========================================================================= #
+  N = "\n"
+
+  # ========================================================================= #
+  # === LJUST
+  # ========================================================================= #
+  LJUST = 15
+
+  # ========================================================================= #
+  # === DF_COMMAND
+  # ========================================================================= #
+  DF_COMMAND = 'df -T -ah 2>&1'
+
+  # ========================================================================= #
+  # === DEBUG
+  #
+  # If true then we will debug this class.
+  # ========================================================================= #
+  DEBUG = false
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      commandline_arguments = nil,
+      run_already           = true
+    )
+    reset
+    set_commandline_arguments(
+      commandline_arguments
+    )
+    if block_given?
+      yielded = yield
+      case yielded
+      # ===================================================================== #
+      # === :be_quiet
+      # ===================================================================== #
+      when :be_quiet
+        set_be_quiet
+        run_already = true
+      # ===================================================================== #
+      # === :be_verbose
+      # ===================================================================== #
+      when :be_verbose,
+           :be_extra_verbose
+        set_be_verbose
+        run_already = true
+      # ===================================================================== #
+      # === :normal_verbosity
+      # ===================================================================== #
+      when :normal_verbosity # Simply pass through here. No longer that important as of 2022, though.
+      end
+    end
+    if commandline_arguments.is_a? Array
+      case commandline_arguments.first
+      # ===================================================================== #
+      # === --extra-verbose
+      # ===================================================================== #
+      when /^-?-?extra(-|_)?verbose$/
+        set_be_verbose 
+        run_already = true
+      end
+    end
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    # ======================================================================= #
+    # === @namespace
+    # ======================================================================= #
+    @namespace = NAMESPACE
+    # ======================================================================= #
+    # === @internal_hash
+    # ======================================================================= #
+    @internal_hash = {}
+    # ======================================================================= #
+    # === :array_available_mountpoints
+    # ======================================================================= #
+    @internal_hash[:array_available_mountpoints] = []
+    # ======================================================================= #
+    # === :use_colours
+    # ======================================================================= #
+    @internal_hash[:use_colours] = true
+    # ======================================================================= #
+    # === :be_verbose
+    # ======================================================================= #
+    @internal_hash[:be_verbose] = true
+    # ======================================================================= #
+    # === :command_to_run
+    #
+    # This is the command that will be run via ``.
+    # ======================================================================= #
+    @internal_hash[:command_to_run] = ''.dup
+  end
+
+  # ========================================================================= #
+  # === set_command_to_run
+  # ========================================================================= #
+  def set_command_to_run(
+      i = :default_command_on_linux
+    )
+    case i
+    # ======================================================================= #
+    # === :default_command_on_linux
+    # ======================================================================= #
+    when :default_command_on_linux,
+         :default
+      i = DF_COMMAND
+    end
+    @internal_hash[:command_to_run] = i
+  end
+
+  # ========================================================================= #
+  # === run_the_system_command
+  # ========================================================================= #
+  def run_the_system_command
+    return `#{command_to_run?}`
+  end
+
+  # ========================================================================= #
+  # === command_to_run?
+  # ========================================================================= #
+  def command_to_run?
+    @internal_hash[:command_to_run]
+  end
+
+  # ========================================================================= #
+  # === set_be_quiet
+  # ========================================================================= #
+  def set_be_quiet
+    @internal_hash[:be_verbose] = false
+  end
+
+  # ========================================================================= #
+  # === set_be_verbose
+  # ========================================================================= #
+  def set_be_verbose
+    @internal_hash[:be_verbose] = true
+  end
+
+  # ========================================================================= #
+  # === set_commandline_arguments
+  # ========================================================================= #
+  def set_commandline_arguments(i = '')
+    i = [i].flatten.compact
+    @commandline_arguments = i
+  end
+
+  # ========================================================================= #
+  # === commandline_arguments?
+  # ========================================================================= #
+  def commandline_arguments?
+    @commandline_arguments
+  end
+
+  # ========================================================================= #
+  # === first_argument?
+  # ========================================================================= #
+  def first_argument?
+    @commandline_arguments.first
+  end; alias first? first_argument? # === first?
+
+  # ========================================================================= #
+  # === available_mountpoints?
+  # ========================================================================= #
+  def available_mountpoints?
+    @internal_hash[:array_available_mountpoints]
+  end; alias mountpoints?       available_mountpoints? # === mountpoints?
+       alias array?             available_mountpoints? # === array?
+       alias array_mountpoints? available_mountpoints? # === array_mountpoints?
+       alias array_mountpoints  available_mountpoints? # === array_mountpoints
+       alias mounted_here       available_mountpoints? # === mounted_here
+       alias result?            available_mountpoints? # === result?
+       alias result             available_mountpoints? # === result
+
+  # ========================================================================= #
+  # === add_this_entry_to_the_available_mountpoints                 (add tag)
+  # ========================================================================= #
+  def add_this_entry_to_the_available_mountpoints(i)
+    unless i == '/' # Ignore the root entry here.
+      unless i.end_with? '/'
+        i = i.dup if i.frozen?
+        i << '/'
+      end
+      @internal_hash[:array_available_mountpoints] << i
+    end
+  end; alias add add_this_entry_to_the_available_mountpoints # === add
+
+  # ========================================================================= #
+  # === e
+  # ========================================================================= #
+  def e(i = '')
+    if use_colours?
+      ::Colours.e(i)
+    else
+      puts i
+    end
+  end
+
+  # ========================================================================= #
+  # === debug?
+  # ========================================================================= #
+  def debug?
+    DEBUG
+  end
+
+  # ========================================================================= #
+  # === rds
+  # ========================================================================= #
+  def rds(i)
+    i.squeeze('/')
+  end
+
+  # ========================================================================= #
+  # === use_colours?
+  # ========================================================================= #
+  def use_colours?
+    @internal_hash[:use_colours]
+  end
+
+  # ========================================================================= #
+  # === be_verbose?
+  # ========================================================================= #
+  def be_verbose?
+    @internal_hash[:be_verbose]
+  end; alias be_extra_verbose? be_verbose? # === be_extra_verbose?
+
+  # ========================================================================= #
+  # === report_the_determined_mountpoints                        (report tag)
+  # ========================================================================= #
+  def report_the_determined_mountpoints(
+      available_mountpoints = available_mountpoints?,
+      be_verbose            = be_verbose?
+    )
+    if be_verbose
+      if available_mountpoints.empty?
+        opn; e 'No mount point was found. Thus, it is assumed '\
+               'that no USB device is currently mounted.'
+      else # else report the mountpoints here.
+        opn; e 'The following mount points were found:'
+        e
+        available_mountpoints.each {|entry|
+          e "  #{forestgreen(entry)}".ljust(LJUST)
+        }
+        e
+      end
+    end
+  end; alias report                   report_the_determined_mountpoints # === report
+       alias report_colourized_result report_the_determined_mountpoints # === report_colourized_result
+       alias report_result            report_the_determined_mountpoints # === report_result
+       alias determine_result         report_the_determined_mountpoints # === determine_result
+
+  # ========================================================================= #
+  # === forestgreen
+  # ========================================================================= #
+  def forestgreen(i)
+    return ::Colours.forestgreen(i) if use_colours?
+    return i
+  end
+
+  # ========================================================================= #
+  # === determine_the_available_mountpoints
+  #
+  # This method will branch into a linux-specific clause and a
+  # windows-specific clause.
+  # ========================================================================= #
+  def determine_the_available_mountpoints
+    clear_the_mountpoints # First clear the mountpoints - we don't want old entries.
+    # ======================================================================= #
+    # === Handle windows next
+    # ======================================================================= #
+    if use_windows?
+      determine_the_mountpoints_on_windows
+    # ======================================================================= #
+    # === Handle linux next
+    # ======================================================================= #
+    else # This branch is specifically for linux
+      determine_the_mountpoints_on_linux
+    end
+  end
+
+  # ========================================================================= #
+  # === determine_the_mountpoints_on_linux          (linux tag, linux branch)
+  # ========================================================================= #
+  def determine_the_mountpoints_on_linux
+    set_command_to_run(:default_command_on_linux)
+    if debug?
+      e "Now running this command: #{sfancy(command_to_run?)}"
+    end
+    result = run_the_system_command.split(N)
+    # ======================================================================= #
+    # Next parse it for results such as:
+    #
+    #   /dev/sdc1   2048 3907029134 3907027087  1.8T Linux filesystem
+    #   /dev/sdc1   459G  436G     0 100% /Mount/USB3
+    #
+    # This stands for:
+    #
+    #   Device     Start        End    Sectors  Size Type
+    #
+    # ======================================================================= #
+    matches = result.select {|entry| entry =~ /^\/dev\// } # Or check for: '/dev/sd'
+    matches.each {|line|
+      splitted = line.split(' ').map(&:strip)
+      last_entry = splitted.last.strip
+      add_this_entry_to_the_available_mountpoints(last_entry)
+    }
+  end
+
+  # ========================================================================= #
+  # === set_mountpoints
+  #
+  # Note that all directories will be stored via a trailing '/' in this
+  # method.
+  # ========================================================================= #
+  def set_mountpoints(i)
+    i = [i].flatten.compact
+    i.map! {|entry|
+      if File.directory? entry
+        entry = rds(entry)
+      end
+      if File.directory?(entry) and !entry.end_with?('/')
+        entry << '/'
+      end
+      entry
+    }
+    @internal_hash[:array_mountpoints] = i
+  end
+
+  # ========================================================================= #
+  # === clear_the_mountpoints
+  # ========================================================================= #
+  def clear_the_mountpoints
+    @internal_hash[:array_available_mountpoints].clear
+  end
+
+  # ========================================================================= #
+  # === use_windows?
+  # ========================================================================= #
+  def use_windows?
+    return Mountpoints.use_windows?
+  end; alias is_on_windows? use_windows? # === is_on_windows?
+
+  # ========================================================================= #
+  # === determine_the_mountpoints_on_windows
+  # ========================================================================= #
+  def determine_the_mountpoints_on_windows
+    result = ''.dup
+    set_command_to_run(WINDOWS_COMMAND1)
+    result << `#{command_to_run?}`.split(N).reject {|line| line.to_s.strip.empty? }.join(N) # This will keep the main result.
+    set_command_to_run(WINDOWS_COMMAND2)
+    result << `#{command_to_run?}`.split(N).reject {|line| line.to_s.strip.empty? }.join(N) # This will keep the main result.
+    result = result.split(N).reverse.select {|entry|
+      entry.include? ':'
+    }.map {|entry|
+      entry.strip
+    }.reject {|entry| entry.include? 'DeviceID' } .uniq
+    set_mountpoints(result)
+  end
+
+  # ========================================================================= #
+  # === run                                                         (run tag)
+  # ========================================================================= #
+  def run
+    determine_the_available_mountpoints
+    report_the_determined_mountpoints
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  Mountpoints.new(ARGV)
+  # To query the mountpoints do:
+  #
+  #   pp _.mountpoints?
+  #
+end # rawmountpoints

data/lib/mountpoints/constants/constants.rb

@@ -0,0 +1,19 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'mountpoints/constants/constants.rb'
+# =========================================================================== #
+class Mountpoints 
+
+  # ========================================================================= #
+  # === WINDOWS_COMMAND1
+  # ========================================================================= #
+  WINDOWS_COMMAND1 = 'wmic logicaldisk where "drivetype=3" get DeviceID'
+
+  # ========================================================================= #
+  # === WINDOWS_COMMAND2
+  # ========================================================================= #
+  WINDOWS_COMMAND2 = 'wmic logicaldisk where "drivetype=2" get DeviceID'
+
+end

data/lib/mountpoints/toplevel_methods/toplevel_methods.rb

@@ -0,0 +1,92 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# require 'mountpoints/toplevel_methods/toplevel_methods.rb'
+# =========================================================================== #
+class Mountpoints # === Mountpoints
+
+  require 'mountpoints/constants/constants.rb'
+
+  # ========================================================================= #
+  # === Mountpoints.use_windows?
+  #
+  # This boolean method will return true if we are on windows, and
+  # false otherwise.
+  # ========================================================================= #
+  def self.use_windows?
+    case RUBY_PLATFORM
+    when /win/,
+         /mingw/,
+         /msys/
+      return true
+    else
+      return false
+    end
+  end; self.instance_eval { alias is_on_windows? use_windows? } # === Mountpoints.is_on_windows?
+
+  # ========================================================================= #
+  # === Mountpoints[]
+  #
+  # This method will return an Array, such as:
+  #
+  #   ["/Mount/USB1/"]
+  #
+  # It will be quiet by default.
+  
+  # Usage example:
+  #
+  #   x = Mountpoints # => ["/Mount/USB3/"]
+  #
+  # ========================================================================= #
+  def self.[](i = ARGV)
+    new(i) { :be_quiet }.array_mountpoints # The Array will be returned as well.
+  end
+
+  # ========================================================================= #
+  # === Mountpoints.array?
+  #
+  # This variant will only return the mountpoints, as Array.
+  # ========================================================================= #
+  def self.array?(i = ARGV)
+    new(i) { :be_quiet }.array?
+  end; self.instance_eval { alias mountpoints_as_array array? } # === Mountpoints.mountpoints_as_array
+       self.instance_eval { alias array_mountpoints    array? } # === Mountpoints.mountpoints_as_array
+       self.instance_eval { alias mountpoints?         array? } # === Mountpoints.mountpoints_as_array
+
+  # ========================================================================= #
+  # === Mountpoints.report
+  # ========================================================================= #
+  def self.report
+    new(i) { :be_verbose }
+  end; self.instance_eval { alias show report } # === Mountpoints.show
+
+  # ========================================================================= #
+  # === Mountpoints.is_any_mountpoint_available?
+  # ========================================================================= #
+  def self.is_any_mountpoint_available?
+    !new { :be_quiet }.array_mountpoints.empty?
+  end
+
+  # ========================================================================= #
+  # === Mountpoints.windows1
+  # ========================================================================= #
+  def self.windows1(cmd_to_run = WINDOWS_COMMAND1)
+    e cmd_to_run
+    `#{cmd_to_run}`
+  end
+
+  # ========================================================================= #
+  # === Mountpoints.windows2
+  # ========================================================================= #
+  def self.windows2(cmd_to_run = WINDOWS_COMMAND2)
+    e cmd_to_run
+    `#{cmd_to_run}`
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  require 'mountpoints/class/mountpoints.rb'
+  pp Mountpoints.array?
+end # rawmountpoints

data/lib/mountpoints/version/version.rb

@@ -7,7 +7,7 @@ class Mountpoints
   # ========================================================================= #
   # === Mountpoints::VERSION
   # ========================================================================= #
-  VERSION = '1.1.3'
+  VERSION = '1.2.3'
 
   # ========================================================================= #
   # === Mountpoints::LAST_UPDATE

data/lib/mountpoints.rb

@@ -1 +1 @@
-require 'mountpoints/mountpoints.rb'
+require 'mountpoints/class/mountpoints.rb'

data/mountpoints.gemspec

@@ -2,7 +2,7 @@
 # Gemspec for Project Mountpoints.
 # =========================================================================== #
 require 'mountpoints/version/version.rb'
-require 'roebe'
+require 'roebe/toplevel_methods/misc.rb'
 
 Gem::Specification.new { |s|
 
@@ -12,40 +12,34 @@ Gem::Specification.new { |s|
   
   DESCRIPTION = <<-EOF
 
-  This class will give you back all mountpoints on a Linux
-  System. It may also work on Windows, using "wmic".
+  This class will yield to the user the information about all
+  mountpoints on a Linux System. It may also work on Windows,
+  by making use of "wmic".
 
   Please do note that on Linux this works only via "fdisk",
-  and even then not always. It was mostly a "throw-away"
-  gem that I can use quickly, rather than having to parse
-  the output of "fdisk -l".
+  and even then not always. This gem was initially started
+  as a "throw-away" gem that can be used quickly, rather
+  than having to parse the output of "fdisk -l" manually
+  (or by eyes only).
 
-  Also do note that we are only interested in external
-  devices that are mounted that way, NOT other
-  mountpoints.
+  Also do note that we are only interested in external devices
+  that are mounted that way, NOT other mountpoints. The
+  reason for this is because this gem here serves as a
+  foundation for backing up data onto external USB devices.
 
-  To use this in Ruby, do:
-
-    require 'mountpoints'
-    Mountpoints.show
-
-    # or this variant:
-
-    require 'mountpoints'
-    Mountpoints[]
+  For more information pertaining to this gem have a look
+  at the official homepage of this gem.
 
   EOF
+
   s.summary     = DESCRIPTION
   s.description = DESCRIPTION
-  
-  s.extra_rdoc_files = %w()
-  
-  s.authors   = ['Robert A. Heiler']
-  s.email     = Roebe.email?
-  s.files     = Dir['**/*']
-  s.files    << 'USAGE.md'
-  s.license   = 'GPL-2.0'
-  s.homepage  = 'https://rubygems.org/gems/mountpoints'
+
+  s.authors  = ['Robert A. Heiler']
+  s.email    = Roebe.email?
+  s.files    = Dir['**/*']
+  s.license  = 'GPL-2.0'
+  s.homepage = 'https://rubygems.org/gems/mountpoints'
 
   s.required_ruby_version     = '>= '+Roebe.third_most_stable_version_of_ruby
   s.required_rubygems_version = '>= '+Gem::VERSION

data/test/testing_mountpoints.rb

@@ -1,4 +1,7 @@
-require 'pp'
 require 'mountpoints'
 
-pp Mountpoints[]
+alias e puts
+
+e '='*80
+pp Mountpoints[]
+e '='*80

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mountpoints
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.2.3
 platform: ruby
 authors:
 - Robert A. Heiler
@@ -40,27 +40,23 @@ dependencies:
         version: '0'
 description: |2+
 
-    This class will give you back all mountpoints on a Linux
-    System. It may also work on Windows, using "wmic".
+    This class will yield to the user the information about all
+    mountpoints on a Linux System. It may also work on Windows,
+    by making use of "wmic".
 
     Please do note that on Linux this works only via "fdisk",
-    and even then not always. It was mostly a "throw-away"
-    gem that I can use quickly, rather than having to parse
-    the output of "fdisk -l".
+    and even then not always. This gem was initially started
+    as a "throw-away" gem that can be used quickly, rather
+    than having to parse the output of "fdisk -l" manually
+    (or by eyes only).
 
-    Also do note that we are only interested in external
-    devices that are mounted that way, NOT other
-    mountpoints.
+    Also do note that we are only interested in external devices
+    that are mounted that way, NOT other mountpoints. The
+    reason for this is because this gem here serves as a
+    foundation for backing up data onto external USB devices.
 
-    To use this in Ruby, do:
-
-      require 'mountpoints'
-      Mountpoints.show
-
-      # or this variant:
-
-      require 'mountpoints'
-      Mountpoints[]
+    For more information pertaining to this gem have a look
+    at the official homepage of this gem.
 
 email: shevy@inbox.lt
 executables: []
@@ -68,11 +64,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - README.md
-- USAGE.md
+- bin/mountpoints
 - doc/README.gen
 - lib/mountpoints.rb
-- lib/mountpoints/misc.rb
-- lib/mountpoints/mountpoints.rb
+- lib/mountpoints/class/mountpoints.rb
+- lib/mountpoints/constants/constants.rb
+- lib/mountpoints/toplevel_methods/toplevel_methods.rb
 - lib/mountpoints/version/version.rb
 - mountpoints.gemspec
 - test/testing_mountpoints.rb
@@ -98,12 +95,14 @@ requirements: []
 rubygems_version: 3.3.13
 signing_key:
 specification_version: 4
-summary: 'This class will give you back all mountpoints on a Linux System. It may
-  also work on Windows, using "wmic".  Please do note that on Linux this works only
-  via "fdisk", and even then not always. It was mostly a "throw-away" gem that I can
-  use quickly, rather than having to parse the output of "fdisk -l".  Also do note
+summary: This class will yield to the user the information about all mountpoints on
+  a Linux System. It may also work on Windows, by making use of "wmic".  Please do
+  note that on Linux this works only via "fdisk", and even then not always. This gem
+  was initially started as a "throw-away" gem that can be used quickly, rather than
+  having to parse the output of "fdisk -l" manually (or by eyes only).  Also do note
   that we are only interested in external devices that are mounted that way, NOT other
-  mountpoints.  To use this in Ruby, do:  require ''mountpoints'' Mountpoints.show  #
-  or this variant:  require ''mountpoints'' Mountpoints[]'
+  mountpoints. The reason for this is because this gem here serves as a foundation
+  for backing up data onto external USB devices.  For more information pertaining
+  to this gem have a look at the official homepage of this gem.
 test_files: []
 ...

data/USAGE.md

@@ -1,14 +0,0 @@
-= Usage of this Library
-
-== Requiring it
-
-  require 'mountpoints'
-
-== Using it in a project
-
-  _ = Mountpoints.new("science_news")
-  _.run
-
-or
-
-  Mountpoints.show

data/lib/mountpoints/misc.rb

@@ -1,146 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-# require 'mountpoints/misc.rb'
-# =========================================================================== #
-class Mountpoints
-
-  # ========================================================================= #
-  # === debug?
-  # ========================================================================= #
-  def debug?
-    DEBUG
-  end
-
-  # ========================================================================= #
-  # === rds
-  # ========================================================================= #
-  def rds(i)
-    i.squeeze('/')
-  end
-
-  # ========================================================================= #
-  # === determine_the_mountpoints_on_linux
-  # ========================================================================= #
-  def determine_the_mountpoints_on_linux
-    set_command_to_run(DF_COMMAND)
-    if debug?
-      e "Now running this command: #{sfancy(command_to_run?)}"
-    end
-    result = `#{command_to_run?}`.split("\n").select {|entry|
-      entry.include?('/dev/sd')
-    }.reject {|line|
-      splitted = line.split(' ').map {|inner_entry| inner_entry.strip }
-      splitted.last == '/'
-    }
-    result.map! {|entry|
-      # =================================================================== #
-      # The line may look like this:
-      #
-      #   "/dev/sdc1       459G  436G     0 100% /Mount/USB3"
-      #
-      # =================================================================== #
-      entry.split(' ').last.strip
-    }
-    set_mountpoints(result)
-  end
-
-  # ========================================================================= #
-  # === determine_the_mountpoints_on_windows
-  # ========================================================================= #
-  def determine_the_mountpoints_on_windows
-    result = ''.dup
-    set_command_to_run('wmic logicaldisk where "drivetype=3" get DeviceID')
-    result << `#{command_to_run?}`.split(N).reject {|line| line.to_s.strip.empty? }.join(N) # This will keep the main result.
-    set_command_to_run('wmic logicaldisk where "drivetype=2" get DeviceID')
-    result << `#{command_to_run?}`.split(N).reject {|line| line.to_s.strip.empty? }.join(N) # This will keep the main result.
-    result = result.split(N).reverse.select {|entry|
-      entry.include? ':'
-    }.map {|entry|
-      entry.strip
-    }.reject {|entry| entry.include? 'DeviceID' } .uniq
-    set_mountpoints(result)
-  end
-
-  # ========================================================================= #
-  # === use_windows?
-  # ========================================================================= #
-  def use_windows?
-    return Mountpoints.use_windows?
-  end; alias is_on_windows? use_windows? # === is_on_windows?
-
-  # ========================================================================= #
-  # === Mountpoints.use_windows?
-  # ========================================================================= #
-  def self.use_windows?
-    case RUBY_PLATFORM
-    when /win/,
-         /mingw/,
-         /msys/
-      return true
-    else
-      return false
-    end
-  end; self.instance_eval { alias is_on_windows? use_windows? } # === Mountpoints.is_on_windows?
-
-  # ========================================================================= #
-  # === Mountpoints.report
-  # ========================================================================= #
-  def self.report
-    Mountpoints[:be_extra_verbose]
-  end
-
-  # ========================================================================= #
-  # === Mountpoints.is_any_mountpoint_available?
-  # ========================================================================= #
-  def self.is_any_mountpoint_available?
-    !new(:be_quiet).array_mountpoints.empty?
-  end
-
-  # ========================================================================= #
-  # === Mountpoints.show
-  # ========================================================================= #
-  def self.show
-    new :be_extra_verbose
-  end
-
-  # ========================================================================= #
-  # === Mountpoints[]
-  #
-  # This method will return an array such as:
-  #
-  #   ["/Mount/USB1/"]
-  #
-  # In other words, it will be a silent result.
-  #
-  # Usage examples:
-  #
-  #   Mountpoints[]
-  #   Mountpoints[:be_extra_verbose]
-  #
-  # ========================================================================= #
-  def self.[](
-      be_extra_verbose = :normal_verbosity
-    )
-    case be_extra_verbose
-    # ======================================================================= #
-    # === :be_extra_verbose
-    # ======================================================================= #
-    when :be_extra_verbose
-      _ = new(be_extra_verbose)
-      _.report_result
-      return _.array_mountpoints
-    else
-      return new(be_extra_verbose).array_mountpoints
-    end
-  end
-
-  # ========================================================================= #
-  # === Mountpoints.array_mountpoints
-  # ========================================================================= #
-  def self.array_mountpoints
-    new { :be_quiet }.array_mountpoints
-  end; self.instance_eval { alias mountpoints_as_array array_mountpoints } # === Mountpoints.mountpoints_as_array
-
-end

data/lib/mountpoints/mountpoints.rb

@@ -1,270 +0,0 @@
-#!/usr/bin/ruby -w
-# Encoding: UTF-8
-# frozen_string_literal: true
-# =========================================================================== #
-# === Mountpoints
-#
-# The primary goal for this class is to scan for all mounted USB-devices.
-#
-# Colours may be used on the commandline if the .report() method is
-# called.
-#
-# Usage examples:
-#
-#   Mountpoints.new(ARGV)
-#   Mountpoints.new
-#   Mountpoints.show
-#   Mountpoints.is_any_mountpoint_available?
-#
-# =========================================================================== #
-# require 'mountpoints/mountpoints.rb'
-# Mountpoints[]
-# =========================================================================== #
-class Mountpoints # === Mountpoints
-
-  require 'mountpoints/misc.rb'
-  require 'mountpoints/version/version.rb'
-
-  begin
-    require 'colours'
-    include Colours
-  rescue LoadError; end
-
-  begin
-    require 'opn'
-  rescue LoadError; end
-
-  # ========================================================================= #
-  # === NAMESPACE
-  # ========================================================================= #
-  NAMESPACE = inspect
-
-  # ========================================================================= #
-  # === N
-  # ========================================================================= #
-  N = "\n"
-
-  # ========================================================================= #
-  # === LJUST
-  # ========================================================================= #
-  LJUST = 15
-
-  # ========================================================================= #
-  # === DF_COMMAND
-  # ========================================================================= #
-  DF_COMMAND = 'df -T -ah'
-
-  # ========================================================================= #
-  # === DEBUG
-  #
-  # If true then we will debug this class.
-  # ========================================================================= #
-  DEBUG = false
-
-  # ========================================================================= #
-  # === initialize
-  #
-  # If the first argument to this method is :be_extra_verbose then the
-  # class will show more information on the commandline.
-  # ========================================================================= #
-  def initialize(
-      commandline_arguments = ARGV,
-      run_already           = true
-    )
-    reset
-    case run_already
-    # ======================================================================= #
-    # === :be_quiet
-    # ======================================================================= #
-    when :be_quiet
-      @internal_hash[:be_extra_verbose] = false
-      run_already = true
-    # ======================================================================= #
-    # === :be_extra_verbose
-    # ======================================================================= #
-    when :be_extra_verbose
-      @internal_hash[:be_extra_verbose] = true 
-      run_already = true
-    # ======================================================================= #
-    # === :normal_verbosity
-    # ======================================================================= #
-    when :normal_verbosity # Simply pass through here.
-    end
-    if commandline_arguments.is_a? Array
-      first = commandline_arguments.first
-      case first
-      when /^-?-?extra(-|_)?verbose$/
-        @internal_hash[:be_extra_verbose] = true 
-        run_already = true
-      end
-    end
-    run if run_already
-  end
-
-  # ========================================================================= #
-  # === reset                                                     (reset tag)
-  # ========================================================================= #
-  def reset
-    # ======================================================================= #
-    # === @namespace
-    # ======================================================================= #
-    @namespace = NAMESPACE
-    # ======================================================================= #
-    # === @internal_hash
-    # ======================================================================= #
-    @internal_hash = {}
-    # ======================================================================= #
-    # === :array_mountpoints
-    # ======================================================================= #
-    @internal_hash[:array_mountpoints] = []
-    # ======================================================================= #
-    # === :be_extra_verbose
-    # ======================================================================= #
-    @internal_hash[:be_extra_verbose] = false
-    # ======================================================================= #
-    # === :command_to_run
-    #
-    # This is the command that will be run via ``.
-    # ======================================================================= #
-    @internal_hash[:command_to_run] = ''.dup
-  end
-
-  # ========================================================================= #
-  # === be_extra_verbose?
-  # ========================================================================= #
-  def be_extra_verbose?
-    @internal_hash[:be_extra_verbose]
-  end
-
-  # ========================================================================= #
-  # === set_command_to_run
-  # ========================================================================= #
-  def set_command_to_run(i)
-    @internal_hash[:command_to_run] = i
-  end
-
-  # ========================================================================= #
-  # === command_to_run?
-  # ========================================================================= #
-  def command_to_run?
-    @internal_hash[:command_to_run]
-  end
-
-  # ========================================================================= #
-  # === run_the_system_command
-  # ========================================================================= #
-  def run_the_system_command
-    return `#{command_to_run?}`
-  end
-
-  # ========================================================================= #
-  # === set_mountpoints
-  #
-  # Note that all directories will be stored via a trailing '/' in this
-  # method.
-  # ========================================================================= #
-  def set_mountpoints(i)
-    i = [i].flatten.compact
-    i.map! {|entry|
-      if File.directory? entry
-        entry = rds(entry)
-      end
-      if File.directory?(entry) and !entry.end_with?('/')
-        entry << '/'
-      end
-      entry
-    }
-    @internal_hash[:array_mountpoints] = i
-  end
-
-  # ========================================================================= #
-  # === mountpoints?
-  # ========================================================================= #
-  def mountpoints?
-    @internal_hash[:array_mountpoints]
-  end; alias array_mountpoints? mountpoints? # === array_mountpoints?
-       alias array_mountpoints  mountpoints? # === array_mountpoints
-       alias mounted_here       mountpoints? # === mounted_here
-       alias result?            mountpoints? # === result?
-       alias result             mountpoints? # === result
-
-  # ========================================================================= #
-  # === report_result                                            (report tag)
-  # ========================================================================= #
-  def report_result(
-      be_verbose = be_extra_verbose?
-    )
-    if be_verbose
-      if mountpoints?.empty?
-        opn; e 'No mount point was found. Thus, it is included '\
-               'that no USB device is currently mounted.'
-      else
-        opn; e 'The following mount points were found:'
-        e
-        mountpoints = mountpoints?
-        result = run_the_system_command.split("\n").select {|line|
-          # ================================================================= #
-          # The line may look like this:
-          #
-          #   "/dev/sdc1      ext4        459G  436G     0 100% /Mount/USB3\n" +
-          #
-          # ================================================================= #
-          mountpoints.any? {|discovered_mountpoint|
-            line.include? discovered_mountpoint
-          }
-        }
-
-        mountpoints.each {|line|
-          if is_on_windows?
-            e line.ljust(LJUST)
-          else
-            line           = result.select {|entry|
-              entry.include? entry
-            }.first
-            line = result.select {|inner_line|
-              inner_line.end_with? line
-            }.first
-            line           = line.split(' ').map(&:strip)
-            filesize       = line[2]
-            name_of_device = line[1]
-            mounted_here   = line[0]
-            efancy '  '+
-                   mounted_here.ljust(LJUST)+
-                   '   '+
-                   swarn(name_of_device)+' '+
-                   '('+Colours.green(filesize)+')'
-          end          
-        }
-        e
-      end 
-    end
-  end; alias report_colourized_result report_result # === report_colourized_result
-       alias report                   report_result # === report
-       alias determine_result         report_result # === determine_result
-
-  # ========================================================================= #
-  # === run                                                         (run tag)
-  # ========================================================================= #
-  def run
-    # ======================================================================= #
-    # === Handle windows next
-    # ======================================================================= #
-    if use_windows?
-      determine_the_mountpoints_on_windows
-    # ======================================================================= #
-    # === Handle linux next
-    # ======================================================================= #
-    else # This branch is specifically for linux
-      determine_the_mountpoints_on_linux
-    end
-  end
-
-end
-
-if __FILE__ == $PROGRAM_NAME
-  _ = Mountpoints.new :be_extra_verbose
-  # pp _
-  #_.report
-  pp _.mountpoints?
-  # p _.result?
-end # rubymountpoints --extra-verbose