pstree 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d8de7f08591e54e2af49ad0d5c779735a0f1c7979137b1b4dc21420b43e3d952
-  data.tar.gz: b3ea7e35f07949e14f6cb8ca9909b1f0cfed59ca041d5e82a5362a6436ea486f
+  metadata.gz: 47afd4e4734bfc1207cc7ac432880efd4a15689bf2cf9b25f50ab3583a748e98
+  data.tar.gz: 4825f7854d8e02ac38451804209ddc6c61378c5c35d3139700fa8b1bbd30d49c
 SHA512:
-  metadata.gz: 0add077fd833f7437d3453ec0b56fe66d17adf366d7db98b6b4b6fb52110c3688bc5dd4c7ba20a100ae2a88b139f95c013e1f2e07f9ab43e885632cebf87d462
-  data.tar.gz: 1e2f5243524f03346f3eb1d450c21c59b79573146afb1c787924e1bad5e33d659cdc6aa3b92cd796cc0a56de7aa912fed5d3aac82193aa051b94e48155818b6f
+  metadata.gz: 65425a386c1966d95f70137c3eca9d59d9d2f48b944e23bcea44072de7639b12d137700d708bd13c24be0c111b9b3305c4d09ac0243d2e308b02e69f97e69760
+  data.tar.gz: 21b6b6df89ed649cea68509e8c2e96d87fdcf81f4d5d5f6ae9cb28d4a45165a1acab3ce09c6a79f916a8e08d9ded5c3582742afb2107d2b6b1d51cb18cb7b3e0

data/CHANGES.md

@@ -1,5 +1,14 @@
 # Changes
 
+## 2025-08-19 v0.5.0
+
+- **Documentation**: Comprehensive YARD documentation added to all classes and
+  methods, with improved README containing installation instructions and usage
+  examples
+- **Licensing**: Full GPL-2.0 license file included in gem package
+- **Packaging**: Refined gemspec and Rakefile configurations to exclude
+  unnecessary files
+
 ## 2024-09-24 v0.4.0
 
 + Supports display of forrest now if more than one `PID` was given as arguments.
@@ -12,39 +21,39 @@
 ## 2024-03-15 v0.3.1
 
 * **Changes for version **1.0**:
-	+ Use `github` as homepage.
-	+ Create `codeql-analysis.yml`.
-	+ Update `gemspec`.
-	+ Configure `asdf`.
+  + Use `github` as homepage.
+  + Create `codeql-analysis.yml`.
+  + Update `gemspec`.
+  + Configure `asdf`.
 
 ## 2019-04-15 v0.3.0
 
 * Convert `rdoc README` to markdown
 * Only recurse into this one subtree correctly
 * Merge changes from `github.com:flori/pstree`
-	+ Support UTF-8 output and use it by default (default encoding changed to **UTF-8**)
-	+ Update code to use new default encoding (**UTF-8**)
+  + Support UTF-8 output and use it by default (default encoding changed to **UTF-8**)
+  + Update code to use new default encoding (**UTF-8**)
 
 ## 2017-11-07 v0.2.0
 
 * **Support UTF-8 output and use it by default**
-	+ Added support for UTF-8 output
-	+ Changed default output encoding to UTF-8
+  + Added support for UTF-8 output
+  + Changed default output encoding to UTF-8
 * **Cleanup code**
-	+ Improved code organization and structure
+  + Improved code organization and structure
 * **stop ruby 1.9 from whining**
-	+ Updated code to be compatible with Ruby 1.9
+  + Updated code to be compatible with Ruby 1.9
 
 ## 2014-02-06 v0.1.0
 
 * **Bumped gem_hadar dependency**:
-	+ Updated `gem_hadar` dependency to use the latest version
+  + Updated `gem_hadar` dependency to use the latest version
 * **Dependency on new version of gem_hadar**:
-	+ Updated `gem_hadar` dependency to use a new version (**1.0.0**)
+  + Updated `gem_hadar` dependency to use a new version (**1.0.0**)
 * **Cleanup code**:
-	+ Improved code organization and readability
+  + Improved code organization and readability
 * **Fix stupid ruby warning**:
-	+ Resolved a Ruby warning issue
+  + Resolved a Ruby warning issue
 
 ## 2013-05-15 v0.0.0
 

data/LICENSE

@@ -0,0 +1,338 @@
+                    GNU GENERAL PUBLIC LICENSE
+                       Version 2, June 1991
+
+ Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
+ <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The licenses for most software are designed to take away your
+freedom to share and change it.  By contrast, the GNU General Public
+License is intended to guarantee your freedom to share and change free
+software--to make sure the software is free for all its users.  This
+General Public License applies to most of the Free Software
+Foundation's software and to any other program whose authors commit to
+using it.  (Some other Free Software Foundation software is covered by
+the GNU Lesser General Public License instead.)  You can apply it to
+your programs, too.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+this service if you wish), that you receive source code or can get it
+if you want it, that you can change the software or use pieces of it
+in new free programs; and that you know you can do these things.
+
+  To protect your rights, we need to make restrictions that forbid
+anyone to deny you these rights or to ask you to surrender the rights.
+These restrictions translate to certain responsibilities for you if you
+distribute copies of the software, or if you modify it.
+
+  For example, if you distribute copies of such a program, whether
+gratis or for a fee, you must give the recipients all the rights that
+you have.  You must make sure that they, too, receive or can get the
+source code.  And you must show them these terms so they know their
+rights.
+
+  We protect your rights with two steps: (1) copyright the software, and
+(2) offer you this license which gives you legal permission to copy,
+distribute and/or modify the software.
+
+  Also, for each author's protection and ours, we want to make certain
+that everyone understands that there is no warranty for this free
+software.  If the software is modified by someone else and passed on, we
+want its recipients to know that what they have is not the original, so
+that any problems introduced by others will not reflect on the original
+authors' reputations.
+
+  Finally, any free program is threatened constantly by software
+patents.  We wish to avoid the danger that redistributors of a free
+program will individually obtain patent licenses, in effect making the
+program proprietary.  To prevent this, we have made it clear that any
+patent must be licensed for everyone's free use or not licensed at all.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                    GNU GENERAL PUBLIC LICENSE
+   TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
+
+  0. This License applies to any program or other work which contains
+a notice placed by the copyright holder saying it may be distributed
+under the terms of this General Public License.  The "Program", below,
+refers to any such program or work, and a "work based on the Program"
+means either the Program or any derivative work under copyright law:
+that is to say, a work containing the Program or a portion of it,
+either verbatim or with modifications and/or translated into another
+language.  (Hereinafter, translation is included without limitation in
+the term "modification".)  Each licensee is addressed as "you".
+
+Activities other than copying, distribution and modification are not
+covered by this License; they are outside its scope.  The act of
+running the Program is not restricted, and the output from the Program
+is covered only if its contents constitute a work based on the
+Program (independent of having been made by running the Program).
+Whether that is true depends on what the Program does.
+
+  1. You may copy and distribute verbatim copies of the Program's
+source code as you receive it, in any medium, provided that you
+conspicuously and appropriately publish on each copy an appropriate
+copyright notice and disclaimer of warranty; keep intact all the
+notices that refer to this License and to the absence of any warranty;
+and give any other recipients of the Program a copy of this License
+along with the Program.
+
+You may charge a fee for the physical act of transferring a copy, and
+you may at your option offer warranty protection in exchange for a fee.
+
+  2. You may modify your copy or copies of the Program or any portion
+of it, thus forming a work based on the Program, and copy and
+distribute such modifications or work under the terms of Section 1
+above, provided that you also meet all of these conditions:
+
+    a) You must cause the modified files to carry prominent notices
+    stating that you changed the files and the date of any change.
+
+    b) You must cause any work that you distribute or publish, that in
+    whole or in part contains or is derived from the Program or any
+    part thereof, to be licensed as a whole at no charge to all third
+    parties under the terms of this License.
+
+    c) If the modified program normally reads commands interactively
+    when run, you must cause it, when started running for such
+    interactive use in the most ordinary way, to print or display an
+    announcement including an appropriate copyright notice and a
+    notice that there is no warranty (or else, saying that you provide
+    a warranty) and that users may redistribute the program under
+    these conditions, and telling the user how to view a copy of this
+    License.  (Exception: if the Program itself is interactive but
+    does not normally print such an announcement, your work based on
+    the Program is not required to print an announcement.)
+
+These requirements apply to the modified work as a whole.  If
+identifiable sections of that work are not derived from the Program,
+and can be reasonably considered independent and separate works in
+themselves, then this License, and its terms, do not apply to those
+sections when you distribute them as separate works.  But when you
+distribute the same sections as part of a whole which is a work based
+on the Program, the distribution of the whole must be on the terms of
+this License, whose permissions for other licensees extend to the
+entire whole, and thus to each and every part regardless of who wrote it.
+
+Thus, it is not the intent of this section to claim rights or contest
+your rights to work written entirely by you; rather, the intent is to
+exercise the right to control the distribution of derivative or
+collective works based on the Program.
+
+In addition, mere aggregation of another work not based on the Program
+with the Program (or with a work based on the Program) on a volume of
+a storage or distribution medium does not bring the other work under
+the scope of this License.
+
+  3. You may copy and distribute the Program (or a work based on it,
+under Section 2) in object code or executable form under the terms of
+Sections 1 and 2 above provided that you also do one of the following:
+
+    a) Accompany it with the complete corresponding machine-readable
+    source code, which must be distributed under the terms of Sections
+    1 and 2 above on a medium customarily used for software interchange; or,
+
+    b) Accompany it with a written offer, valid for at least three
+    years, to give any third party, for a charge no more than your
+    cost of physically performing source distribution, a complete
+    machine-readable copy of the corresponding source code, to be
+    distributed under the terms of Sections 1 and 2 above on a medium
+    customarily used for software interchange; or,
+
+    c) Accompany it with the information you received as to the offer
+    to distribute corresponding source code.  (This alternative is
+    allowed only for noncommercial distribution and only if you
+    received the program in object code or executable form with such
+    an offer, in accord with Subsection b above.)
+
+The source code for a work means the preferred form of the work for
+making modifications to it.  For an executable work, complete source
+code means all the source code for all modules it contains, plus any
+associated interface definition files, plus the scripts used to
+control compilation and installation of the executable.  However, as a
+special exception, the source code distributed need not include
+anything that is normally distributed (in either source or binary
+form) with the major components (compiler, kernel, and so on) of the
+operating system on which the executable runs, unless that component
+itself accompanies the executable.
+
+If distribution of executable or object code is made by offering
+access to copy from a designated place, then offering equivalent
+access to copy the source code from the same place counts as
+distribution of the source code, even though third parties are not
+compelled to copy the source along with the object code.
+
+  4. You may not copy, modify, sublicense, or distribute the Program
+except as expressly provided under this License.  Any attempt
+otherwise to copy, modify, sublicense or distribute the Program is
+void, and will automatically terminate your rights under this License.
+However, parties who have received copies, or rights, from you under
+this License will not have their licenses terminated so long as such
+parties remain in full compliance.
+
+  5. You are not required to accept this License, since you have not
+signed it.  However, nothing else grants you permission to modify or
+distribute the Program or its derivative works.  These actions are
+prohibited by law if you do not accept this License.  Therefore, by
+modifying or distributing the Program (or any work based on the
+Program), you indicate your acceptance of this License to do so, and
+all its terms and conditions for copying, distributing or modifying
+the Program or works based on it.
+
+  6. Each time you redistribute the Program (or any work based on the
+Program), the recipient automatically receives a license from the
+original licensor to copy, distribute or modify the Program subject to
+these terms and conditions.  You may not impose any further
+restrictions on the recipients' exercise of the rights granted herein.
+You are not responsible for enforcing compliance by third parties to
+this License.
+
+  7. If, as a consequence of a court judgment or allegation of patent
+infringement or for any other reason (not limited to patent issues),
+conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot
+distribute so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you
+may not distribute the Program at all.  For example, if a patent
+license would not permit royalty-free redistribution of the Program by
+all those who receive copies directly or indirectly through you, then
+the only way you could satisfy both it and this License would be to
+refrain entirely from distribution of the Program.
+
+If any portion of this section is held invalid or unenforceable under
+any particular circumstance, the balance of the section is intended to
+apply and the section as a whole is intended to apply in other
+circumstances.
+
+It is not the purpose of this section to induce you to infringe any
+patents or other property right claims or to contest validity of any
+such claims; this section has the sole purpose of protecting the
+integrity of the free software distribution system, which is
+implemented by public license practices.  Many people have made
+generous contributions to the wide range of software distributed
+through that system in reliance on consistent application of that
+system; it is up to the author/donor to decide if he or she is willing
+to distribute software through any other system and a licensee cannot
+impose that choice.
+
+This section is intended to make thoroughly clear what is believed to
+be a consequence of the rest of this License.
+
+  8. If the distribution and/or use of the Program is restricted in
+certain countries either by patents or by copyrighted interfaces, the
+original copyright holder who places the Program under this License
+may add an explicit geographical distribution limitation excluding
+those countries, so that distribution is permitted only in or among
+countries not thus excluded.  In such case, this License incorporates
+the limitation as if written in the body of this License.
+
+  9. The Free Software Foundation may publish revised and/or new versions
+of the General Public License from time to time.  Such new versions will
+be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+Each version is given a distinguishing version number.  If the Program
+specifies a version number of this License which applies to it and "any
+later version", you have the option of following the terms and conditions
+either of that version or of any later version published by the Free
+Software Foundation.  If the Program does not specify a version number of
+this License, you may choose any version ever published by the Free Software
+Foundation.
+
+  10. If you wish to incorporate parts of the Program into other free
+programs whose distribution conditions are different, write to the author
+to ask for permission.  For software which is copyrighted by the Free
+Software Foundation, write to the Free Software Foundation; we sometimes
+make exceptions for this.  Our decision will be guided by the two goals
+of preserving the free status of all derivatives of our free software and
+of promoting the sharing and reuse of software generally.
+
+                            NO WARRANTY
+
+  11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
+FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW.  EXCEPT WHEN
+OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
+PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
+OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE ENTIRE RISK AS
+TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU.  SHOULD THE
+PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
+REPAIR OR CORRECTION.
+
+  12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
+REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
+INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
+OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
+TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
+YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
+PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
+POSSIBILITY OF SUCH DAMAGES.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+convey the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software; you can redistribute it and/or modify
+    it under the terms of the GNU General Public License as published by
+    the Free Software Foundation; either version 2 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU General Public License for more details.
+
+    You should have received a copy of the GNU General Public License along
+    with this program; if not, see <https://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+If the program is interactive, make it output a short notice like this
+when it starts in an interactive mode:
+
+    Gnomovision version 69, Copyright (C) year name of author
+    Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
+    This is free software, and you are welcome to redistribute it
+    under certain conditions; type `show c' for details.
+
+The hypothetical commands `show w' and `show c' should show the appropriate
+parts of the General Public License.  Of course, the commands you use may
+be called something other than `show w' and `show c'; they could even be
+mouse-clicks or menu items--whatever suits your program.
+
+You should also get your employer (if you work as a programmer) or your
+school, if any, to sign a "copyright disclaimer" for the program, if
+necessary.  Here is a sample; alter the names:
+
+  Yoyodyne, Inc., hereby disclaims all copyright interest in the program
+  `Gnomovision' (which makes passes at compilers) written by James Hacker.
+
+  <signature of Moe Ghoul>, 1 April 1989
+  Moe Ghoul, President of Vice
+
+This General Public License does not permit incorporating your program into
+proprietary programs.  If your program is a subroutine library, you may
+consider it more useful to permit linking proprietary applications with the
+library.  If this is what you want to do, use the GNU Lesser General
+Public License instead of this License.

data/README.md

@@ -2,14 +2,40 @@
 
 ## Description
 
-This library can be used to create and display a process status tree as a Ruby
-datastructure.
+This library provides a Ruby implementation of the `pstree` utility, enabling
+developers to visualize process hierarchies as tree structures. It parses
+system process information and presents it in an easily readable format with
+proper indentation and Unicode/ASCII tree characters.
+
+The library can be used both programmatically as a data structure and through
+its command-line interface for quick process tree visualization.
 
 ## Installation
 
-Install the gem by typing
+### RubyGems
+
+Install the latest version from RubyGems.org:
+
+```bash
+gem install pstree
+```
+
+### Bundler
+
+Add to your Gemfile:
+```ruby
+gem 'pstree'
+```
+
+Then run:
+```bash
+bundle install
+```
 
-# gem install pstree
+## Requirements
+- Ruby 2.0 or higher
+- UNIX-like operating system (Linux, macOS, BSD)
+- `/bin/ps` utility available in PATH
 
 ## Usage
 
@@ -22,18 +48,38 @@ $ ruby-pstree $$
    └─ 37129 /bin/ps axww -o ppid,pid,user,command (root)
 ```
 
+### Programmatic Usage
+
+Access process information programmatically:
+
+```ruby
+require 'pstree'
+
+# Create a process tree for PID 1 (init)
+tree = PSTree.new(1)
+
+# Iterate over processes in the tree
+tree.each do |process|
+  puts "#{process.pid}: #{process.cmd}"
+end
+
+# Or get the tree as a string
+puts tree.to_s
+
+# Navigate the tree to find the pids of your favourite processes
+pid_of_shell_parent_of_irb = tree.find { it.cmd =~ /irb/ }&.ppid
+```
+
 ## Download
 
 The homepage of this library is located at
 
-* http://flori.github.com/pstree
+* https://github.com/flori/pstree
 
 ## Author
 
-Florian Frank <flori@ping.de>
+[Florian Frank](mailto:flori@ping.de)
 
 ## License
 
-This is free software; you can redistribute it and/or modify it under the
-terms of the GNU General Public License Version 2 as published by the Free
-Software Foundation: www.gnu.org/copyleft/gpl.html
+[GPLv2 License](./LICENSE)

data/Rakefile

@@ -13,7 +13,10 @@ GemHadar do
   description 'This library uses the output of the ps command to creaste process tree data structure for the current host.'
   licenses    << 'GPL-2'
   test_dir    'tests'
-  ignore      '.*.sw[pon]', 'pkg', 'Gemfile.lock', '.rvmrc', 'coverage'
+  ignore      '.*.sw[pon]', 'pkg', 'Gemfile.lock', '.rvmrc', 'coverage',
+    '.yardoc', 'doc'
+  package_ignore '.all_images', '.utilsrc', '.rspec', '.tool-versions',
+    '.gitignore'
   readme      'README.md'
   executables << 'ruby-pstree'
 end

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.5.0

data/lib/pstree/version.rb

@@ -1,6 +1,6 @@
 class PSTree
   # PSTree version
-  VERSION         = '0.4.0'
+  VERSION         = '0.5.0'
   VERSION_ARRAY   = VERSION.split('.').map(&:to_i) # :nodoc:
   VERSION_MAJOR   = VERSION_ARRAY[0] # :nodoc:
   VERSION_MINOR   = VERSION_ARRAY[1] # :nodoc:

data/lib/pstree.rb

@@ -1,13 +1,68 @@
 require 'pstree/version'
 
+# PSTree is a process status tree implementation that creates and displays
+# hierarchical process information.
+#
+# This class provides functionality to build and visualize process trees
+# starting from a specified root process ID. It encapsulates process data
+# including parent process ID, process ID, user, and command line, and formats
+# this information into a readable tree structure with proper indentation and
+# branch characters.
+#
+# @example Creating and displaying a process tree
+#   tree = PSTree.new($$)
+#   puts tree.to_s
+#
+# @example Iterating over processes in the tree
+#   tree = PSTree.new($$)
+#   tree.each do |process|
+#     puts process.pid
+#   end
 class PSTree
+  # Process structure for storing and formatting process information.
+  #
+  # This class encapsulates the essential details of a process including its
+  # parent process ID, process ID, owning user, and command line.
+  #
+  # @example Creating a new process structure
+  #   proc = PSTree::ProcStruct.new(1234, 5678, 'flori', '/usr/bin/ruby script.rb')
   class ProcStruct
+    # Initializes a new process structure with the given process information.
+    #
+    # @param ppid [ String, Integer ] the parent process ID
+    # @param pid [ String, Integer ] the process ID
+    # @param user [ String ] the user who owns the process
+    # @param cmd [ String ] the command line of the process
     def initialize(ppid, pid, user, cmd)
       @ppid, @pid, @user, @cmd = ppid.to_i, pid.to_i, user, cmd
     end
 
-    attr_reader :ppid, :pid, :user, :cmd
+    # The ppid reader method returns the parent process ID of this process
+    # structure.
+    #
+    # @attr_reader [ Integer ] the parent process identifier
+    attr_reader :ppid
 
+    # The pid reader method returns the process ID of this process structure.
+    #
+    # @attr_reader [ Integer ] the process identifier
+    attr_reader :pid
+
+    # The user reader method returns the username who owns this process
+    #
+    # @attr_reader [ String ] the user identifier who owns the process
+    attr_reader :user
+
+    # The cmd reader method returns the command line of this process structure.
+    #
+    # @attr_reader [ String ] the command line associated with the process
+    attr_reader :cmd
+
+    # The to_s method formats the process information into a string representation
+    # that displays the process ID, command, and user in a standardized format.
+    #
+    # @return [ String ] a formatted string containing the process ID, command,
+    #                    and user separated by spaces and parentheses
     def to_s
      "%05u %s (%s)" % [ pid, cmd, user ]
     end
@@ -15,11 +70,26 @@ class PSTree
 
   include Enumerable
 
+  # Initializes a new PSTree instance with the specified root process ID and character set.
+  #
+  # @param root_pid [ String, Integer, nil ] the process ID of the root process
+  # to start the tree from
+  # @param charset [ String ] the character encoding to use for display
+  # formatting
   def initialize(root_pid = nil, charset: 'UTF-8')
     @charset  = charset.to_s.upcase
     @root_pid = root_pid.to_i
   end
 
+  # Returns the appropriate tree drawing character sequence for a process with
+  # zero children, based on the current charset setting.
+  #
+  # @param last [ TrueClass, FalseClass ] whether this is the last child in a
+  #                                       sequence
+  #
+  # @return [ String ] the character sequence to use for drawing the tree branch
+  #                    line, either UTF-8 or ASCII characters depending on charset
+  #                    configuration
   def children_zero(last)
     if @charset == 'UTF-8'
       last ? '└─ ' : '   '
@@ -28,6 +98,15 @@ class PSTree
     end
   end
 
+  # Returns the appropriate tree drawing character sequence for a process with
+  # children, based on the current charset setting and whether the process is
+  # the last child in a sequence.
+  #
+  # @param last [ TrueClass, FalseClass ] whether this is the last child in a sequence
+  #
+  # @return [ String ] the character sequence to use for drawing the tree
+  #                    branch line, either UTF-8 or ASCII characters depending
+  #                    on charset configuration
   def children_not_zero(last)
     if @charset == 'UTF-8'
       last ? '├─ ' : '│  '
@@ -36,6 +115,14 @@ class PSTree
     end
   end
 
+  # The to_s method generates a string representation of the process tree
+  # starting from the root process ID. It builds the tree structure and formats
+  # each process entry with appropriate tree-drawing characters based on the
+  # process hierarchy and charset configuration. The resulting string includes
+  # process IDs, commands, and users in a hierarchical display format.
+  #
+  # @return [ String ] a formatted string representation of the process tree
+  #                    with proper indentation and tree-drawing characters
   def to_s
     build
     result = ''
@@ -52,6 +139,12 @@ class PSTree
     result
   end
 
+  # The each method iterates over all processes in the process tree by
+  # executing the given block for each process.
+  #
+  # @yield [ ps ]
+  #
+  # @return [ PSTree ] returns itself to allow for method chaining
   def each(&block)
     build
     recurse @root_pid, &block
@@ -60,6 +153,14 @@ class PSTree
 
   private
 
+  # The build method constructs the internal process tree data structure by
+  # parsing output from the ps command.
+  #
+  # It initializes the necessary instance variables and populates them with
+  # process information obtained from executing the /bin/ps command with
+  # specific output format options. The method processes each line of the ps
+  # output to create ProcStruct objects and organizes them into a hierarchical
+  # tree structure based on parent process IDs.
   def build
     @child_count = [ 0 ]
     @process = {}
@@ -74,6 +175,20 @@ class PSTree
     end
   end
 
+  # The recurse method performs a recursive traversal of the process tree
+  # starting from a given process ID.
+  #
+  # It processes each node in the tree by executing the provided callback for
+  # the current process, then recursively processes all child processes. The
+  # method handles tree drawing character generation based on the hierarchy
+  # level and whether a process has children.
+  #
+  # @param pid [ Integer ] the process ID to start recursion from
+  # @param shift_callback [ Proc, nil ] optional callback to generate tree drawing characters
+  # @param level [ Integer ] current depth level in the tree hierarchy
+  # @param in_root [ TrueClass, FalseClass ] flag indicating if current node is the root
+  #
+  # @yield [ ps ]
   def recurse(pid, shift_callback = nil, level = 0, in_root = false, &node_callback)
     in_root = in_root || @root_pid == 0 || @root_pid == pid
     @child_count[level] = @pstree[pid].size

data/pstree.gemspec

@@ -1,26 +1,26 @@
 # -*- encoding: utf-8 -*-
-# stub: pstree 0.4.0 ruby lib
+# stub: pstree 0.5.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "pstree".freeze
-  s.version = "0.4.0".freeze
+  s.version = "0.5.0".freeze
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Florian Frank".freeze]
-  s.date = "2024-09-24"
+  s.date = "1980-01-02"
   s.description = "This library uses the output of the ps command to creaste process tree data structure for the current host.".freeze
   s.email = "flori@ping.de".freeze
   s.executables = ["ruby-pstree".freeze]
   s.extra_rdoc_files = ["README.md".freeze, "lib/pstree.rb".freeze, "lib/pstree/version.rb".freeze]
-  s.files = [".github/workflows/codeql-analysis.yml".freeze, ".gitignore".freeze, "CHANGES.md".freeze, "Gemfile".freeze, "README.md".freeze, "Rakefile".freeze, "VERSION".freeze, "bin/ruby-pstree".freeze, "lib/pstree.rb".freeze, "lib/pstree/version.rb".freeze, "pstree.gemspec".freeze]
+  s.files = [".github/workflows/codeql-analysis.yml".freeze, "CHANGES.md".freeze, "Gemfile".freeze, "LICENSE".freeze, "README.md".freeze, "Rakefile".freeze, "VERSION".freeze, "bin/ruby-pstree".freeze, "lib/pstree.rb".freeze, "lib/pstree/version.rb".freeze, "pstree.gemspec".freeze]
   s.homepage = "https://github.com/flori/pstree".freeze
   s.licenses = ["GPL-2".freeze]
   s.rdoc_options = ["--title".freeze, "Pstree - Ruby library that builds a process tree of this host".freeze, "--main".freeze, "README.md".freeze]
-  s.rubygems_version = "3.5.18".freeze
+  s.rubygems_version = "3.6.9".freeze
   s.summary = "Ruby library that builds a process tree of this host".freeze
 
   s.specification_version = 4
 
-  s.add_development_dependency(%q<gem_hadar>.freeze, ["~> 1.17.1".freeze])
+  s.add_development_dependency(%q<gem_hadar>.freeze, ["~> 2.1".freeze])
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: pstree
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Florian Frank
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-24 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gem_hadar
@@ -16,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.17.1
+        version: '2.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.17.1
+        version: '2.1'
 description: This library uses the output of the ps command to creaste process tree
   data structure for the current host.
 email: flori@ping.de
@@ -36,9 +35,9 @@ extra_rdoc_files:
 - lib/pstree/version.rb
 files:
 - ".github/workflows/codeql-analysis.yml"
-- ".gitignore"
 - CHANGES.md
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - VERSION
@@ -50,7 +49,6 @@ homepage: https://github.com/flori/pstree
 licenses:
 - GPL-2
 metadata: {}
-post_install_message:
 rdoc_options:
 - "--title"
 - Pstree - Ruby library that builds a process tree of this host
@@ -69,8 +67,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.18
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Ruby library that builds a process tree of this host
 test_files: []

data/.gitignore

@@ -1,5 +0,0 @@
-.*.sw[pon]
-.rvmrc
-Gemfile.lock
-coverage
-pkg