stat_file 1.0.18

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 05d456bb5611af8a04ee050f8f37bba5dd2b81c7e1d7833dfc4dc9085380893b
+  data.tar.gz: 5207fc33de2f8fca603a0a617449630fef76f67ed1e433d80936062cc725f99f
+SHA512:
+  metadata.gz: 3b9f16acc34dcb01794852ee9ba9d2c9f39d65fa2905332957b8603f9b8b3eefaadc8cf566351c8f10ae71b60c781983e8e87e507c3b868ea9e592932526c1d8
+  data.tar.gz: 8aa691805ac73572831f38c97ee4d538a343ca7f935eca5ab5962d1a23bb3d70f6402d91d1f2225308084b81e6e0a5bbf46233963c8cfae3b053d1f08e70dce6

data/lib/stat_file/stat_file.rb

@@ -0,0 +1,276 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+# === StatFile
+#
+# require 'stat_file/stat_file.rb'
+# =========================================================================== #
+# Bug:
+#   The access entry is not completely correct - the number is ok but 
+#   the rxw--- format is wrong.
+# =========================================================================== #
+class StatFile
+
+  require 'etc'
+
+  begin
+    require 'colours'
+    include Colours
+  rescue LoadError; end
+
+  begin
+    require 'opn'
+  rescue LoadError; end
+
+  N = "\n" unless defined? N
+
+  # ========================================================================= #
+  # === SHALL_WE_DEBUG
+  # ========================================================================= #
+  SHALL_WE_DEBUG = false unless defined? SHALL_WE_DEBUG
+
+  # ========================================================================= #
+  # === RED_ON_BLACK
+  # ========================================================================= #
+  RED_ON_BLACK   = "\e[31;48m" unless defined? RED_ON_BLACK
+
+  # ========================================================================= #
+  # === REVERT
+  # ========================================================================= #
+  REVERT         = '\e[0m' unless defined? REVERT  
+
+  # ========================================================================= #
+  # === initialize
+  # ========================================================================= #
+  def initialize(
+      this_file,
+      be_verbose  = true,
+      run_already = true
+    )
+    reset # This must be called before set_be_verbose()
+    be_verbose = false if be_verbose == :dont_be_verbose
+    set_be_verbose if be_verbose
+    set_file(this_file)
+    run if run_already
+  end
+
+  # ========================================================================= #
+  # === reset                                                     (reset tag)
+  # ========================================================================= #
+  def reset
+    # ======================================================================= #
+    # === @be_verbose
+    # ======================================================================= #
+    @be_verbose = false # Default.
+    # ======================================================================= #
+    # === @debug
+    # ======================================================================= #
+    @debug = SHALL_WE_DEBUG
+    # ======================================================================= #
+    # === @padding_left
+    # ======================================================================= #
+    @padding_left = '  '
+  end
+
+  # ========================================================================= #
+  # === file?
+  # ========================================================================= #
+  def file?
+    @file
+  end
+
+  # ========================================================================= #
+  # === set_file
+  # ========================================================================= #
+  def set_file(i, get_rid_of_slashdot = false)
+    if get_rid_of_slashdot
+      i.delete!('/') if i.include? '/' # Since 06.12.2011 we try to get rid of possible '/' in the string.
+    end
+    i = i.first if i.is_a? Array
+    i = i.to_s.dup
+    @file = i
+  end
+
+  # ========================================================================= #
+  # === set_be_verbose
+  # ========================================================================= #
+  def set_be_verbose
+    @be_verbose = true
+  end
+
+  # ========================================================================= #
+  # === stat_file
+  # ========================================================================= #
+  def stat_file(f = @file)
+    if f.to_s.empty?
+      opn; e 'No such file could be found. Perhaps you '
+      opn; e 'forgot to pass in a valid filename?'
+    end
+    if f
+      if f.is_a? Array
+        f.each { |this_file| stat_file(this_file) }
+      else
+        @is_symlink = File.symlink?(f) ? true : false
+        if @debug
+          e "Debugging in stat_file.rb: Is `#{f}` a symlink or not? #{@is_symlink}"
+        end
+        if is_on_roebe? and !File.exist?(f)
+          begin
+            require 'beautiful_url'
+            f = BeautifulUrl[f]
+            f = f.first if f.is_a? Array
+          rescue LoadError; end
+        end
+        string = '    File: `'+f+"`"
+        # =================================================================== #
+        # If it is a symlink we have to check whether the target exists
+        # or not.
+        # =================================================================== #
+        if @is_symlink
+          f = File.readlink(f)
+          string << ' → `'+f+"`"
+        end
+        # =================================================================== #
+        # Now we can retrieve the information.
+        # =================================================================== #
+        if File.exist?(f)
+          _ = File.stat(f)
+          file_type = File.ftype(f)
+          case file_type
+          when 'directory'
+            target_type = 'directory'
+          when 'file'
+            target_type = 'regular file'
+          when 'symlink','link'
+            target_type = 'symlink'
+          end
+          # ================================================================= #
+          # Prepend a newline to it. I think it looks better that way.
+          # ================================================================= #
+          if are_the_colours_available?
+            use_this_regex = /`(.+)`/ # See: https://rubular.com/r/EnETP5vkCYgGEB
+            string.prepend(::Colours.rev)
+            string.sub!(
+              use_this_regex,
+              ::Colours.steelblue('\1')
+            )
+          end
+          @result = N+string+N # reset again here.
+          @result << @padding_left+'  Size: '+
+                     (@size = _.size.to_s).to_s+'         Blocks: '+_.blocks.to_s+'   '+target_type.to_s+N
+          @result << @padding_left+
+                     return_device_string+'  Inode: '+_.ino.to_s+N
+          begin
+            gid = File.stat(f).gid.to_s
+            gid_name = Etc.getgrgid(File.stat(f).gid).name # i.e. "root"
+            uid = File.stat(f).uid.to_s
+            uid_name = Etc.getpwuid(File.stat(f).uid).name # i.e. "root"
+            # =============================================================== #
+            # Next we will add the access entry. The Access entry may
+            # have a leading 0 or 1.
+            # =============================================================== #
+            access_mode = File.stat(f).mode.to_s(8)[-4,4] # Get the last 4 chars only.
+            access_entry = 'Access: ('+access_mode+'/-rwxr-xr-x)  Uid: ( '+uid+'/   '+uid_name+')   Gid: ( '+gid+'/   '+gid_name+')'
+            @result << @padding_left+access_entry+N
+          rescue Exception => error; pp error; end
+          @result << "#{@padding_left}Created at:    #{File.ctime(f)}#{N}"
+          @result << "#{@padding_left}Last accessed: #{File.atime(f)}#{N}"
+          @result << "#{@padding_left}Last modified: #{File.mtime(f)}#{N}"
+          @result << N
+          e @result if @be_verbose
+        else # Else the file does not exit.
+          if be_verbose?
+            opn; ewarn "No target file exists at: `#{sfile(f)}"
+                 # File.readlink(@file)
+          end
+        end
+      end
+    end
+  end
+
+  # ========================================================================= #
+  # === result?
+  # ========================================================================= #
+  def result?
+    @result
+  end; alias result result? # === result
+       alias text?  result? # === text?
+
+  # ========================================================================= #
+  # === be_verbose?
+  # ========================================================================= #
+  def be_verbose?
+    @be_verbose
+  end
+
+  # ========================================================================= #
+  # === size?
+  # ========================================================================= #
+  def size?
+    @size
+  end; alias size size? # === size()
+
+  # ========================================================================= #
+  # === is_on_roebe?
+  # ========================================================================= #
+  def is_on_roebe?
+    ENV['IS_ROEBE'].to_s == '1'
+  end
+
+  # ========================================================================= #
+  # === are_the_colours_available?
+  # ========================================================================= #
+  def are_the_colours_available?
+    Object.const_defined? :Colours
+  end
+
+  # ========================================================================= #
+  # === return_device_string
+  #
+  # This method is assumed to return an entry such as the following one:
+  #
+  #   Device: 801h/2049d
+  #
+  # Note that this may differ from systemd to non-systemd systems.
+  # ========================================================================= #
+  def return_device_string
+    result = 'Device: '.dup
+    # ======================================================================= #
+    # First, find out the current device:
+    # ======================================================================= #
+    base_dir = File.dirname(file?)
+    cmd = `df #{base_dir} 2>&1` # The 2>&1 is necessary for windows.
+    device_number = cmd.split(N)[1].split(' ')[0]
+    # ======================================================================= #
+    # device_number now has something like /dev/sda1
+    # In order to obtain the major and minor version,
+    # we must do this:
+    # ======================================================================= #
+    cmd = "ls -al #{device_number} 2>&1"
+    major_minor  = `#{cmd}` # To get major/minor = 8/1
+    # ======================================================================= #
+    # This may however had fail. We assume that it will fail when it
+    # includes the string "by-uuid".
+    # ======================================================================= #
+    applied_match = major_minor.match(/disk (\d, \d)/)
+    if applied_match # Protect against nil values.
+      major, minor = applied_match[1].split(',').map(&:strip)
+      major_and_minor = "#{major}0#{minor}"
+      result << major_and_minor+'h/'+major_and_minor.to_i(16).to_s+'d '
+    end
+    result
+  end
+
+  # ========================================================================= #
+  # === run
+  # ========================================================================= #
+  def run
+    stat_file
+  end
+
+end
+
+if __FILE__ == $PROGRAM_NAME
+  StatFile.new(ARGV.first, true)
+end # sfile $SYSBIN/ruby

data/lib/stat_file/version/version.rb

@@ -0,0 +1,17 @@
+#!/usr/bin/ruby -w
+# Encoding: UTF-8
+# frozen_string_literal: true
+# =========================================================================== #
+class StatFile
+
+  # ========================================================================= #
+  # === VERSION
+  # ========================================================================= #
+  VERSION = '1.0.18'
+
+  # ========================================================================= #
+  # === LAST_UPDATE
+  # ========================================================================= #
+  LAST_UPDATE = '18.09.2022'
+
+end

data/lib/stat_file.rb

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

data/stat_file.gemspec

@@ -0,0 +1,40 @@
+# =========================================================================== #
+# Gemspec for Project StatFile.
+# =========================================================================== #
+require 'stat_file/version/version.rb'
+require 'roebe'
+
+Gem::Specification.new { |s|
+
+  s.name    = 'stat_file'
+  s.version = StatFile::VERSION
+  s.date    = Time.now.strftime('%Y-%m-%d')
+  
+  s.summary = <<-EOF
+
+    This library is called stat_file. It allows you to
+    do basic stat functionality, like the Unix Tool.
+
+  EOF
+  
+  s.description = <<-EOF
+
+    This library is called stat_file. It allows you to
+    do basic stat functionality, like the Unix Tool.
+
+  EOF
+
+  s.authors   = ['Robert A. Heiler']
+  s.email     = Roebe.email?
+  s.files     = Dir['**/*']
+  s.license   = 'MIT'
+  s.homepage  = 'https://rubygems.org/gems/stat_file'
+
+  s.required_ruby_version     = '>= '+RUBY_VERSION
+  s.required_rubygems_version = '>= '+Gem::VERSION
+  s.rubygems_version          = '>= '+Gem::VERSION
+
+  s.add_dependency 'opn'
+  s.add_dependency 'colours'
+
+}

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: stat_file
+version: !ruby/object:Gem::Version
+  version: 1.0.18
+platform: ruby
+authors:
+- Robert A. Heiler
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2022-09-18 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !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'
+description: |2+
+
+      This library is called stat_file. It allows you to
+      do basic stat functionality, like the Unix Tool.
+
+email: shevy@inbox.lt
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/stat_file.rb
+- lib/stat_file/stat_file.rb
+- lib/stat_file/version/version.rb
+- stat_file.gemspec
+homepage: https://rubygems.org/gems/stat_file
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.3.22
+requirements: []
+rubygems_version: 3.3.22
+signing_key:
+specification_version: 4
+summary: This library is called stat_file. It allows you to do basic stat functionality,
+  like the Unix Tool.
+test_files: []
+...