mountpoints 1.0.13 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a6ff0a164ec1b673135a911e81a3ec5648cff9b736f297aa087160245e13093c
-  data.tar.gz: c61a3240c419aa4598240dfc95e36db9ce372e3369b6eb014aabd04f2c81ea46
+  metadata.gz: 8b0855050bed99b01644fa83a4ea8f15330234b30c6a79622968a1c07f4b5a71
+  data.tar.gz: 4970dd1d922f8e42ebc43e1912025d13512978c8604a7d9d3f5c525ab4738000
 SHA512:
-  metadata.gz: 1e70743c2d4769ae3e9a211324c49ef298f8f430708ab57ac6d018b657543323ad915dd416416747ed5e62e23a7dc7841b58aed400e2548fe636be1eb42dbda8
-  data.tar.gz: 34c0c875dd9411458d76cde4a5f905475aae8173fe1fadd03b29048efd8b213def357ffedcdaf796623609a34ef71621415623ddebfee558b1647bf663ab469d
+  metadata.gz: ef6336f27b1a1883fdd5881ea16d13a9f32b2e3eaf4ba868451fcac4d47ede3972d86471fb1fadd773021e684850aad2765af6d33c258d6537f5c380b209fbe7
+  data.tar.gz: 297b56feeab21918d8707c589ce6b5c16c169b7b14328c8ca384f5a247f8829ab4731be73fde617fd7df16bf38a3c307d9511812d03e76e80981c94de1554b6f

data/README.md

@@ -0,0 +1,101 @@
+[![forthebadge](http://forthebadge.com/images/badges/built-with-love.svg)](https://www.gobolinux.org/)
+[![forthebadge](http://forthebadge.com/images/badges/made-with-ruby.svg)](https://www.ruby-lang.org/en/)
+[![Gem Version](https://badge.fury.io/rb/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">23:56:46</span> o'clock.
+
+<img src="https://i.imgur.com/Oi4pNNi.png" style="margin: 1em">
+
+## The goals for the mountpoints project
+
+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 (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 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 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**.
+
+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, 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
+
+If your creative mind has ideas and specific suggestions to make this
+gem more useful in general, feel free to drop me an email at any
+time, via:
+
+    shevy@inbox.lt
+
+Before that email I used an email account at Google gmail, but in **2021** I
+decided to slowly abandon gmail for various reasons. In part this is because
+the UI annoys me (on non-chrome browser loading takes too long), but also
+because of Google's attempt to establish mass surveillance via its
+federated cohorts sniffing (FLoC). I do not know what happened at Google,
+but enough is enough - there is only so much you can take while supporting
+greed. When it comes to data mining done by private groups, ultimately
+the user became the product.
+
+Do keep in mind that responding to emails may take some time,
+depending on the amount of work I may have at that moment, due
+to reallife time constraints. I will, however had, read feedback
+eventually. Patches and code changes are welcome too, of course,
+as long as they are in the spirit of the project at hand, e. g.
+fitting to the general theme. For this I may make use of github
+as a discussion site, but this has a low priority right now.
+

data/bin/mountpoints

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

data/doc/README.gen

@@ -0,0 +1,72 @@
+ADD_RUBY_LOGO_AND_TIMESTAMP
+
+<img src="https://i.imgur.com/Oi4pNNi.png" style="margin: 1em">
+
+## The goals for the mountpoints project
+
+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 (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 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 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**.
+
+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, 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

@@ -1,5 +1,5 @@
-#!/System/Index/bin/ruby -w
-# Encoding: ISO-8859-1
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
 # frozen_string_literal: true
 # =========================================================================== #
 class Mountpoints
@@ -7,6 +7,11 @@ class Mountpoints
   # ========================================================================= #
   # === Mountpoints::VERSION
   # ========================================================================= #
-  VERSION = '1.0.13'
+  VERSION = '1.2.3'
+
+  # ========================================================================= #
+  # === Mountpoints::LAST_UPDATE
+  # ========================================================================= #
+  LAST_UPDATE = '15.05.2022'
 
 end

data/lib/mountpoints.rb

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

data/mountpoints.gemspec

@@ -2,6 +2,7 @@
 # Gemspec for Project Mountpoints.
 # =========================================================================== #
 require 'mountpoints/version/version.rb'
+require 'roebe/toplevel_methods/misc.rb'
 
 Gem::Specification.new { |s|
 
@@ -11,42 +12,36 @@ Gem::Specification.new { |s|
   
   DESCRIPTION = <<-EOF
 
-    This class will give you back all mountpoints on a Linux
-    System. Please do note that this works only via "fdisk",
-    and even then not always. It was mostly a "throw-away"
-    gem that I can use, rather than having to parse the
-    output of "fdisk -l".
+  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".
 
-    Also do note that we are only interested in external
-    devices that are mounted that way, NOT other
-    mountpoints.
+  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).
 
-    To use this in Ruby, do:
+  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.
 
-      require 'mountpoints'
-      Mountpoints.show
-
-    If you have specific suggestions to make this gem more
-    useful for others, please drop me an email at:
-
-      shevegen@gmail.com
-
-    Thank you.
+  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     = 'shevegen@gmail.com'
-  s.files     = Dir['**/*']
-  s.files    << 'USAGE.md'
-  s.license   = 'GPL-2.0'
-  s.homepage  = 'http://rubygems.org/gems/mountpoints'
-
-  s.required_ruby_version     = '>= '+RUBY_VERSION
+
+  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
   s.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,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mountpoints
 version: !ruby/object:Gem::Version
-  version: 1.0.13
+  version: 1.2.3
 platform: ruby
 authors:
 - Robert A. Heiler
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-05-03 00:00:00.000000000 Z
+date: 2022-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: colours
@@ -40,44 +40,44 @@ dependencies:
         version: '0'
 description: |2+
 
-      This class will give you back all mountpoints on a Linux
-      System. Please do note that this works only via "fdisk",
-      and even then not always. It was mostly a "throw-away"
-      gem that I can use, rather than having to parse the
-      output of "fdisk -l".
+    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".
 
-      Also do note that we are only interested in external
-      devices that are mounted that way, NOT other
-      mountpoints.
+    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).
 
-      To use this in Ruby, do:
+    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.
 
-        require 'mountpoints'
-        Mountpoints.show
+    For more information pertaining to this gem have a look
+    at the official homepage of this gem.
 
-      If you have specific suggestions to make this gem more
-      useful for others, please drop me an email at:
-
-        shevegen@gmail.com
-
-      Thank you.
-
-email: shevegen@gmail.com
+email: shevy@inbox.lt
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- USAGE.md
+- README.md
+- bin/mountpoints
+- doc/README.gen
 - lib/mountpoints.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
-homepage: http://rubygems.org/gems/mountpoints
+homepage: https://rubygems.org/gems/mountpoints
 licenses:
 - GPL-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -85,21 +85,24 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.3
+      version: 2.5.8
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.3
+      version: 3.3.13
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.3.13
+signing_key:
 specification_version: 4
-summary: 'This class will give you back all mountpoints on a Linux System. Please
-  do note that this works only via "fdisk", and even then not always. It was mostly
-  a "throw-away" gem that I can use, rather than having to parse the output of "fdisk
-  -l".  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  If you have specific suggestions to make this gem more useful
-  for others, please drop me an email at:  shevegen@gmail.com  Thank you.'
+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. 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/mountpoints.rb

@@ -1,251 +0,0 @@
-#!/System/Index/bin/ruby -w
-# Encoding: ISO-8859-1
-# frozen_string_literal: true
-# =========================================================================== #
-# === Mountpoints
-#
-# This class will scan for all mounted USB-devices first. Then it will
-# try to find a specific entry, if you give an argument to .find().
-#
-# Arguments to find() could be:
-#
-#   '*'
-#
-# The above will return an array of all found entries.
-#
-# We may also store the target device in attr_reader :mounted_here
-#
-# Additionally, this class may use colours to provide easier to
-# read information.
-#
-# Usage examples:
-#   Mountpoints.new
-#   Mountpoints.show
-#   Mountpoints.is_any_mountpoint_available?
-# =========================================================================== #
-# require 'mountpoints'
-# =========================================================================== #
-begin
-  require 'colours'
-rescue LoadError; end
-require 'opn'
-require 'mountpoints/version/version.rb'
-
-class Mountpoints # === Mountpoints.new
-
-  include Colours
-
-  N = "\n"
-
-  # ========================================================================= #
-  # === LJUST
-  # ========================================================================= #
-  LJUST = 15
-
-  # ========================================================================= #
-  # === DF_COMMAND
-  # ========================================================================= #
-  DF_COMMAND    = 'df -T -ah'
-
-  # ========================================================================= #
-  # === FDISK_COMMAND
-  # ========================================================================= #
-  FDISK_COMMAND = 'fdisk -l'
-
-  # ========================================================================= #
-  # === DEBUG
-  # ========================================================================= #
-  DEBUG = false # If true then we will debug.
-
-  # ========================================================================= #
-  # === initialize
-  #
-  # If the first argument is :be_extra_verbose then we will show more
-  # information.
-  # ========================================================================= #
-  def initialize(
-      run_already = true
-    )
-    reset
-    case run_already
-    when :be_extra_verbose
-      @be_extra_verbose = true 
-      run_already = true
-    when :normal_verbosity # Simply pass through here.
-    end
-    run if run_already
-  end
-
-  # ========================================================================= #
-  # === reset
-  # ========================================================================= #
-  def reset
-    @be_extra_verbose = false
-    @command_to_run = DF_COMMAND # This command will be run.
-  end
-
-  # ========================================================================= #
-  # === set_result
-  # ========================================================================= #
-  def set_result(i)
-    if i.is_a? String
-      i << '/' unless i.end_with? '/'
-    elsif i.is_a? Array
-      # ===================================================================== #
-      # Do not flatten here as we may have more than one Array-entry.
-      # ===================================================================== #
-      i.map! {|entry|
-        entry[0] = rds(entry.first+'/')
-        entry
-      } # We want directories to end in a '/'.
-    end
-    if i.is_a? Array
-      i.sort_by! {|entry| entry }
-    end
-    @result = i # Will include trailing /.
-    determine_mountpoints
-  end
-
-  # ========================================================================= #
-  # === rds
-  # ========================================================================= #
-  def rds(i)
-    i.squeeze('/')
-  end
-
-  # ========================================================================= #
-  # === determine_mountpoints
-  #
-  # The @array_mountpoints will keep all directory-names with a trailing
-  # '/'. In other words, the mountpoints will be stored there.
-  # ========================================================================= #
-  def determine_mountpoints
-    @array_mountpoints = @result.map {|entry| entry.first }
-  end
-
-  # ========================================================================= #
-  # === determine_result
-  #
-  # This method will run the df-command.
-  # ========================================================================= #
-  def determine_result
-    if debug?
-      e "Now running this command: #{sfancy(@command_to_run)}"
-    end
-    @result = `#{@command_to_run}`.split(N) # This will keep the main result.
-    _ = @result.reject {|entry| !entry.include? '/Mount' }.
-                reject {|entry| !entry.include? 'USB' }
-    # ======================================================================= #
-    # At this point, we have only the entries that have /Mount as part
-    # of their name.
-    # ======================================================================= #
-    _.map! {|entry|
-      splitted = entry.split(' ')
-      # filesize = 
-      entry = [ splitted[-1], splitted.first, splitted[2] ] 
-    }
-    set_result _ # Now contains the mountpoints here.
-  end
-
-  # ========================================================================= #
-  # === report_result
-  # ========================================================================= #
-  def report_result
-    if @be_extra_verbose
-      if result?.empty?
-        opn; e 'We did not find any mount point. We conclude that '\
-               'no USB device is mounted.'
-      else
-        opn; e 'We did find these mount points:'
-        e
-        result?.each {|line|
-          filesize       = line[2]
-          name_of_device = line[1]
-          mounted_here   = line[0]
-          efancy '  '+mounted_here.ljust(LJUST)+'   '+
-                 swarn(name_of_device)+' '+
-                 '('+Colours.green(filesize)+')'
-        }
-        e
-      end 
-    else # else we report "normally.
-      e result?.join(N)
-    end
-  end; alias report_colourized_result report_result # Not sure what to do with this here.
-
-  # ========================================================================= #
-  # === result?
-  # ========================================================================= #
-  def result?
-    @result
-  end; alias result result? # === result
-
-  # ========================================================================= #
-  # === debug?
-  # ========================================================================= #
-  def debug?
-    DEBUG
-  end
-
-  # ========================================================================= #
-  # === array_mountpoints?
-  # ========================================================================= #
-  def array_mountpoints? # This should always be an Array.
-    @array_mountpoints
-  end; alias array_mountpoints array_mountpoints? # === array_mountpoints
-
-  # ========================================================================= #
-  # === run                                                         (run tag)
-  # ========================================================================= #
-  def run
-    determine_result
-  end
-
-  # ========================================================================= #
-  # === Mountpoints.report
-  # ========================================================================= #
-  def self.report
-    Mountpoints[:be_extra_verbose]
-  end
-
-  # ========================================================================= #
-  # === Mountpoints[]
-  #
-  # This method will return an array such as:
-  #   ["/Mount/USB1/"]
-  #
-  # In other words, it will be a silent result.
-  #
-  # Mountpoints[]
-  # Mountpoints[:be_extra_verbose]
-  # ========================================================================= #
-  def self.[](be_extra_verbose = :normal_verbosity)
-    if be_extra_verbose == :be_extra_verbose
-      _ = Mountpoints.new(be_extra_verbose)
-      _.report_result
-    else
-      Mountpoints.new(be_extra_verbose).array_mountpoints
-    end
-  end
-
-  # ========================================================================= #
-  # === Mountpoints.is_any_mountpoint_available?
-  # ========================================================================= #
-  def self.is_any_mountpoint_available?
-    !Mountpoints.new(:be_quiet).array_mountpoints.empty?
-  end
-
-  # ========================================================================= #
-  # === Mountpoints.show
-  # ========================================================================= #
-  def self.show
-    Mountpoints.new :be_extra_verbose
-  end
-
-end
-
-if __FILE__ == $PROGRAM_NAME
-  _ = Mountpoints.new :be_extra_verbose
-  _.report_result
-  # p _.result?
-end # mountpoints