mountpoints 1.0.13

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a6ff0a164ec1b673135a911e81a3ec5648cff9b736f297aa087160245e13093c
+  data.tar.gz: c61a3240c419aa4598240dfc95e36db9ce372e3369b6eb014aabd04f2c81ea46
+SHA512:
+  metadata.gz: 1e70743c2d4769ae3e9a211324c49ef298f8f430708ab57ac6d018b657543323ad915dd416416747ed5e62e23a7dc7841b58aed400e2548fe636be1eb42dbda8
+  data.tar.gz: 34c0c875dd9411458d76cde4a5f905475aae8173fe1fadd03b29048efd8b213def357ffedcdaf796623609a34ef71621415623ddebfee558b1647bf663ab469d

data/USAGE.md

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

data/lib/mountpoints.rb

@@ -0,0 +1 @@
+require 'mountpoints/mountpoints.rb'

data/lib/mountpoints/mountpoints.rb

@@ -0,0 +1,251 @@
+#!/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

data/lib/mountpoints/version/version.rb

@@ -0,0 +1,12 @@
+#!/System/Index/bin/ruby -w
+# Encoding: ISO-8859-1
+# frozen_string_literal: true
+# =========================================================================== #
+class Mountpoints
+
+  # ========================================================================= #
+  # === Mountpoints::VERSION
+  # ========================================================================= #
+  VERSION = '1.0.13'
+
+end

data/mountpoints.gemspec

@@ -0,0 +1,59 @@
+# =========================================================================== #
+# Gemspec for Project Mountpoints.
+# =========================================================================== #
+require 'mountpoints/version/version.rb'
+
+Gem::Specification.new { |s|
+
+  s.name    = 'mountpoints'
+  s.version = Mountpoints::VERSION
+  s.date    = Time.now.strftime('%Y-%m-%d')
+  
+  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".
+
+    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.
+
+  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.required_rubygems_version = '>= '+Gem::VERSION
+  s.rubygems_version          = '>= '+Gem::VERSION
+
+  # ========================================================================= #
+  # Dependencies
+  # ========================================================================= #
+  s.add_dependency 'colours'
+  s.add_dependency 'opn'
+
+}

data/test/testing_mountpoints.rb

@@ -0,0 +1,4 @@
+require 'pp'
+require 'mountpoints'
+
+pp Mountpoints[]

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: mountpoints
+version: !ruby/object:Gem::Version
+  version: 1.0.13
+platform: ruby
+authors:
+- Robert A. Heiler
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-05-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colours
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: opn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        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".
+
+      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.
+
+email: shevegen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- USAGE.md
+- lib/mountpoints.rb
+- lib/mountpoints/mountpoints.rb
+- lib/mountpoints/version/version.rb
+- mountpoints.gemspec
+- test/testing_mountpoints.rb
+homepage: http://rubygems.org/gems/mountpoints
+licenses:
+- GPL-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.3
+requirements: []
+rubygems_version: 3.0.3
+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.'
+test_files: []