gloo 0.3.0 → 0.4.0

data/lib/gloo/persist/file_loader.rb

@@ -7,29 +7,29 @@
 module Gloo
   module Persist
     class FileLoader
-      
-      BEGIN_BLOCK = "BEGIN"
-      END_BLOCK = "END"
-      
+
+      BEGIN_BLOCK = 'BEGIN'.freeze
+      END_BLOCK = 'END'.freeze
+
       attr_reader :obj
-      
+
       # Set up a file storage for an object.
-      def initialize pn
+      def initialize( pn )
         @pn = pn
         @tabs = 0
         @obj = nil
         @in_multiline = false
         @exiting_multiline = false
         @in_block = false
-        @block_value = ""
-				@debug = false
+        @block_value = ''
+        @debug = false
       end
-            
-      # 
+
+      #
       # Load the objects from the file.
-      # 
+      #
       def load
-        unless File.exists?( @pn )
+        unless File.exist?( @pn )
           $log.error "File '#{@pn}' does not exist."
           return
         end
@@ -37,135 +37,134 @@ module Gloo
         @parent_stack = []
         @parent = $engine.heap.root
         @parent_stack.push @parent
-        f = File.open( @pn, "r" ) 
+        f = File.open( @pn, 'r' )
         f.each_line do |line|
           next if skip_line? line
-          if line.strip.end_with? BEGIN_BLOCK
-            @in_block = true
-            @save_line = line
-          elsif @in_block
-            if line.strip == END_BLOCK
-              @in_block = false
-              determine_indent @save_line
-              process_line @save_line
-            else
-              @block_value << line
-            end
+
+          handle_one_line line
+        end
+      end
+
+      #
+      # Process one one of the file we're loading.
+      #
+      def handle_one_line( line )
+        if line.strip.end_with? BEGIN_BLOCK
+          @in_block = true
+          @save_line = line
+        elsif @in_block
+          if line.strip == END_BLOCK
+            @in_block = false
+            determine_indent @save_line
+            process_line @save_line
           else
-            determine_indent line
-            process_line line
+            @block_value << line
           end
+        else
+          determine_indent line
+          process_line line
         end
       end
-      
+
       # Is this line a comment or a blank line?
       # If so we'll skip it.
-      def skip_line? line
+      def skip_line?( line )
         line = line.strip
         return true if line.empty?
-        return true if line[0] == "#"
+        return true if line[ 0 ] == '#'
+
         return false
       end
-      
+
       # Determine the relative indent level for the line.
-      def determine_indent line
+      def determine_indent( line )
         tabs = tab_count( line )
-        @indent = 0  # same level as prior line
-        if tabs > @tabs  # indent
+        @indent = 0 # same level as prior line
+        if tabs > @tabs # indent
           # TODO:  What if indent is more than one more level?
           @tabs = tabs
           @indent = 1
-        elsif tabs < @tabs  # outdent
+        elsif tabs < @tabs # outdent
           while tabs < @tabs
             @tabs -= 1
             @indent -= 1
           end
         end
-				puts "tabs: #{@tabs}, indent: #{@indent}, line: #{line}" if @debug
+        puts "tabs: #{@tabs}, indent: #{@indent}, line: #{line}" if @debug
       end
 
       # Process one line and add objects.
-      def process_line line
+      def process_line( line )
         # reset multiline unless we're actually indented
         if @in_multiline && @multi_indent > @indent
-					puts "Done multiline mi: #{@multi_indent}, i: #{@indent}" if @debug
+          puts "Done multiline mi: #{@multi_indent}, i: #{@indent}" if @debug
           @in_multiline = false
           @exiting_multiline = true
         end
-        
+
         if @in_multiline
           @last.add_line line
         else
+          setup_process_obj_line
           process_obj_line line
         end
       end
-      
-      # Process one line and add objects.
-      def process_obj_line line
+
+      #
+      # Setup and get ready to process an object line.
+      #
+      def setup_process_obj_line
         if @exiting_multiline
           @exiting_multiline = false
-        elsif @indent > 0
+        elsif @indent.positive?
           @parent = @last
           @parent_stack.push @parent
-        elsif @indent < 0
+        elsif @indent.negative?
           @indent.abs.times do
             @parent_stack.pop
             @parent = @parent_stack.last
           end
         end
-        
+      end
+
+      #
+      # Process one line and add objects.
+      #
+      def process_obj_line( line )
         name, type, value = split_line( line )
-        unless @block_value == ""
+        unless @block_value == ''
           value = @block_value
-          @block_value = ""
+          @block_value = ''
         end
-        @last = $engine.factory.create( name, type, value, @parent )
-        if @last && @last.has_multiline_value?
+        params = { name: name, type: type, value: value, parent: @parent }
+        @last = $engine.factory.create( params )
+
+        if @last&.multiline_value?
           @multi_indent = 0
           @in_multiline = true
-					puts "*** Start multiline. multi_indent: #{@multi_indent}" if @debug
+          puts "*** Start multiline. multi_indent: #{@multi_indent}" if @debug
         end
-        
+
         @obj = @last if @obj.nil?
       end
-      
+
+      #
       # Get the number of leading tabs.
-      def tab_count line
+      #
+      def tab_count( line )
         i = 0
-        while line[i] == "\t"
-          i += 1
-        end
+        i += 1 while line[ i ] == "\t"
         return i
       end
-      
+
+      #
       # Split the line into 3 parts.
-      def split_line line
-				puts "splitting line: #{line}" if @debug
-        line = line[ @tabs..-1]
-				line = line[0..-2] if line[-1] == "\n"
-        i = line.index( ' ' )
-        name = line[0..i-1]
-        
-        line = line[i+1..-1]
-        i = line.index( ' ' )
-        type = line[0..(i ? i-1 : -1)]
-        type = type[1..-1] if type[0] == '['
-        type = type[0..-2] if type[-1] == ']'
-        
-				if i
-	        value = line[i+1..-1]
-					if value[0..1] == ': '
-						value = value[2..-1] 
-					elsif value[0] == ':'
-	        	value = value[1..-1] 
-					end
-				else
-					value = nil
-				end
-				# puts "'#{value}'".yellow
-        return name, type, value
+      #
+      def split_line( line )
+        o = LineSplitter.new( line, @tabs )
+        return o.split
       end
-      
+
     end
   end
 end

data/lib/gloo/persist/file_saver.rb

@@ -7,33 +7,33 @@
 module Gloo
   module Persist
     class FileSaver
-      
+
       # Set up a file storage for an object.
-      def initialize pn, obj
+      def initialize( pn, obj )
         @pn = pn
         @obj = obj
       end
-      
-      # 
+
+      #
       # Save the object to the file.
-      # 
+      #
       def save
         data = get_obj( @obj )
         File.write( @pn, data )
       end
-      
+
       # Get string of tabs for indentation.
-      def tabs indent=0
+      def tabs( indent = 0 )
         return "\t" * indent
       end
-      
+
       # Convert an object to textual representation.
       # This is a recursive function.
-      def get_obj o, indent=0
+      def get_obj( obj, indent = 0 )
         t = tabs( indent )
-        str = "#{t}#{o.name} [#{o.type_display}] : #{o.value_display}\n"
-        o.children.each do |child|
-          str << get_obj( child, indent+1 )
+        str = "#{t}#{obj.name} [#{obj.type_display}] : #{obj.value_display}\n"
+        obj.children.each do |child|
+          str << get_obj( child, indent + 1 )
         end
         return str
       end

data/lib/gloo/persist/file_storage.rb

@@ -7,37 +7,37 @@
 module Gloo
   module Persist
     class FileStorage
-      
+
       attr_reader :obj, :pn
-      
+
       # Set up a file storage for an object.
-      def initialize pn, obj=nil
+      def initialize( pn, obj = nil )
         @obj = obj
         @pn = pn
       end
-      
-      # 
+
+      #
       # Save the object to the file.
-      # 
+      #
       def save
         fs = FileSaver.new @pn, @obj
         fs.save
       end
-      
-      # 
+
+      #
       # Load the object from the file.
-      # 
+      #
       def load
         fl = FileLoader.new @pn
         fl.load
         @obj = fl.obj
-				if @obj
-					$log.debug "Loaded object: #{@obj.name}"
-				else
-					$log.error "Error loading file at #{@pn}"
-				end
+        if @obj
+          $log.debug "Loaded object: #{@obj.name}"
+        else
+          $log.error "Error loading file at #{@pn}"
+        end
       end
-    
+
     end
   end
 end

data/lib/gloo/persist/line_splitter.rb

@@ -0,0 +1,74 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2020 Eric Crane.  All rights reserved.
+#
+# Helper class used as part of file loading.
+# It is responsible for splitting a line into components.
+#
+
+module Gloo
+  module Persist
+    class LineSplitter
+
+      BEGIN_BLOCK = 'BEGIN'.freeze
+      END_BLOCK = 'END'.freeze
+
+      attr_reader :obj
+
+      # Set up a line splitter
+      def initialize( line, tabs )
+        @line = line
+        @tabs = tabs
+      end
+
+      #
+      # Split the line into 3 parts.
+      #
+      def split
+        detect_name
+        detect_type
+        detect_value
+
+        return @name, @type, @value
+      end
+
+      #
+      # Detect the object name.
+      #
+      def detect_name
+        @line = @line[ @tabs..-1 ]
+        @line = @line[ 0..-2 ] if @line[ -1 ] == "\n"
+        @idx = @line.index( ' ' )
+        @name = @line[ 0..@idx - 1 ]
+      end
+
+      #
+      # Detect the object type.
+      #
+      def detect_type
+        @line = @line[ @idx + 1..-1 ]
+        @idx = @line.index( ' ' )
+        @type = @line[ 0..( @idx ? @idx - 1 : -1 ) ]
+        @type = @type[ 1..-1 ] if @type[ 0 ] == '['
+        @type = @type[ 0..-2 ] if @type[ -1 ] == ']'
+      end
+
+      #
+      # Detect the object value.
+      # Use nil if there is no value specified.
+      #
+      def detect_value
+        if @idx
+          @value = @line[ @idx + 1..-1 ]
+          if @value[ 0..1 ] == ': '
+            @value = @value[ 2..-1 ]
+          elsif @value[ 0 ] == ':'
+            @value = @value[ 1..-1 ]
+          end
+        else
+          @value = nil
+        end
+      end
+
+    end
+  end
+end

data/lib/gloo/persist/persist_man.rb

@@ -9,74 +9,74 @@
 module Gloo
   module Persist
     class PersistMan
-      
+
       attr_reader :maps
-      
+
       # Contructor for the persistence manager.
       def initialize
         @maps = []
       end
-      
-      # 
+
+      #
       # Save one object to the file.
-      # 
-      def save name=""
+      #
+      def save( name = '' )
         if name.nil? || name.strip.empty?
           save_all
         else
           save_one name
         end
       end
-      
-      # 
+
+      #
       # Save one object to the file.
-      # 
+      #
       def save_all
-        @maps.each do |o|
-          o.save
-        end
+        @maps.each( &:save )
       end
-      
-      # 
+
+      #
       # Save one object to the file.
-      # 
-      def save_one name
+      #
+      def save_one( name )
         ref = Gloo::Core::Pn.new name
         obj = ref.resolve
         pn = get_full_path_name name
         fs = Gloo::Persist::FileStorage.new( pn, obj )
         fs.save
       end
-      
-      # 
+
+      #
       # Load the object from the file.
-      # 
-      def load name
+      #
+      def load( name )
         pn = get_full_path_name name
         return unless pn
-				$log.debug "Load file at: #{pn}"
+
+        $log.debug "Load file at: #{pn}"
         fs = Gloo::Persist::FileStorage.new( pn )
         fs.load
         @maps << fs
         $engine.event_manager.on_load fs.obj
         # show_maps
       end
-      
-      # 
+
+      #
       # Get the full path and name of the file.
-      # 
-      def get_full_path_name name
+      #
+      def get_full_path_name( name )
         return nil if name.strip.empty?
+
         path = $settings.project_path
         full_name = "#{name}#{file_ext}"
         return File.join( path, full_name )
       end
-      
+
       # Get the default file extention.
       def file_ext
-        return ".gloo"
+        return '.gloo'
       end
-      
+
       # Print out all object - persistance mappings.
       # This is a debugging tool.
       def show_maps
@@ -84,7 +84,7 @@ module Gloo
           puts " \t #{o.pn} \t #{o.obj.name}"
         end
       end
-    
+
     end
   end
 end