lib/faster_path.rb in faster_path-0.3.8 vs lib/faster_path.rb in faster_path-0.3.9

@@ -3,10 +3,13 @@
 require 'thermite/config'
 require 'faster_path/thermite_initialize'
 require 'fiddle'
 require 'fiddle/import'
 
+# FasterPath module behaves as a singleton object with the alternative method
+# implementations for Pathname, and some for File, available directly on it.
+#
 module FasterPath
   FFI_LIBRARY = begin
     toplevel_dir = File.dirname(__dir__)
     config = Thermite::Config.new(cargo_project_path: toplevel_dir,
                                   ruby_project_path: toplevel_dir)
@@ -21,33 +24,53 @@
     private_class_method :basename
     private_class_method :children
     private_class_method :children_compat
   end
 
+  # The Rust architecture bit width: 64bits or 32bits
+  # @return [Integer]
   def self.rust_arch_bits
     Rust.rust_arch_bits
   end
 
+  # The Ruby architecture bit width: 64bits or 32bits
+  # @return [Integer]
   def self.ruby_arch_bits
     1.size * 8
   end
 
+  # A very fast way to check if a string is blank
+  # @param str [#to_s]
+  # @return [true, false]
   def self.blank?(str)
     "#{str}".strip.empty?
   end
 
+  # Rust implementation of File.basename
+  # @param pth [String] the path to evaluate
+  # @param ext [String] any extension to remove
+  # @return [String]
   def self.basename(pth, ext="")
     Public.send(:basename, pth, ext)
   end
 
+  # Rust implementation of Pathname.children
+  # @param pth [String] the path to evaluate
+  # @param with_directory [true, false] whether to include directory in results
+  # @return [Array<String>]
   def self.children(pth, with_directory=true)
     Public.send(:children, pth, with_directory)
   end
 
+  # Rust implementation of Pathname.children
+  # @param pth [String] the path to evaluate
+  # @param with_directory [true, false] whether to include directory in results
+  # @return [Array<Pathname>]
   def self.children_compat(pth, with_directory=true)
     Public.send(:children_compat, pth, with_directory)
   end
 
+  # @private
   module Rust
     extend Fiddle::Importer
     dlload FFI_LIBRARY
     extern 'int rust_arch_bits()'
   end