lib/gloo/core/pn.rb in gloo-0.6.1 vs lib/gloo/core/pn.rb in gloo-0.7.0

@@ -13,91 +13,121 @@
       IT = 'it'.freeze
       ERROR = 'error'.freeze
 
       attr_reader :src, :elements
 
+      #
       # Set up the object given a source string,
       # ie: the full path and name.
+      #
       def initialize( src )
         set_to src
       end
 
+      #
       # Reference to the root object path.
+      #
       def self.root
         return Pn.new( ROOT )
       end
 
+      #
       # Reference to it.
+      #
       def self.it
         return Pn.new( IT )
       end
 
+      #
       # Reference to the error message.
+      #
       def self.error
         return Pn.new( ERROR )
       end
 
+      #
       # Does the pathname reference refer to the root?
+      #
       def root?
         return @src.downcase == ROOT
       end
 
+      #
       # Does the pathname reference refer to it?
+      #
       def it?
         return @src.downcase == IT
       end
 
+      #
       # Does the pathname reference refer to error?
+      #
       def error?
         return @src.downcase == ERROR
       end
 
+      #
       # Does the pathname reference refer to the gloo system object?
+      #
       def gloo_sys?
         return false unless @elements&.count&.positive?
 
         o = @elements.first.downcase
         return true if o == Gloo::Core::GlooSystem.typename
         return true if o == Gloo::Core::GlooSystem.short_typename
 
         return false
       end
 
+      #
       # Get the string representation of the pathname.
+      #
       def to_s
         return @src
       end
 
+      #
       # Set the object pathname to the given value.
+      #
       def set_to( value )
         @src = value.nil? ? nil : value.strip
         @elements = @src.nil? ? [] : @src.split( '.' )
       end
 
+      #
       # Convert the raw string to a list of segments.
+      #
       def segments
         return @elements
       end
 
+      #
       # Get the name element.
+      #
       def name
         return '' unless self.named?
 
         return @elements.last
       end
 
+      #
       # Does the value include path elements?
+      #
       def named?
         return @elements.count.positive?
       end
 
+      #
       # Does the value include a name?
+      #
       def includes_path?
         return @elements.count > 1
       end
 
+      #
       # Get the parent that contains the object referenced.
+      #
       def get_parent
         o = $engine.heap.root
 
         if self.includes_path?
           @elements[ 0..-2 ].each do |e|
@@ -110,11 +140,13 @@
         end
 
         return o
       end
 
+      #
       # Does the object at the path exist?
+      #
       def exists?
         return true if self.root?
         return true if self.it?
         return true if self.error?
 
@@ -122,17 +154,21 @@
         return false unless parent
 
         return parent.contains_child? name
       end
 
+      #
       # Is the reference to a color?
+      #
       def named_color?
         colors = %w[red blue green white black yellow]
         return true if colors.include?( @src.downcase )
       end
 
+      #
       # Resolve the pathname reference.
       # Find the object referenced or return nil if it is not found.
+      #
       def resolve
         return $engine.heap.root if self.root?
         return $engine.heap.it if self.it?
         return $engine.heap.error if self.error?
         return Gloo::Core::GlooSystem.new( self ) if self.gloo_sys?