gloo 2.1.0 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20774ab083e3f97894367f2e5ab0ede6ae65edeb72e8153af73df130da3a728c
-  data.tar.gz: 9225ba79729353ed2a21966dfdf380ad1d6b081615895d6bef1eec83720d428b
+  metadata.gz: f34d7102d0ca036b885dc482a76bd9e2e69056fd1fc24a94f85b019ad93ae2ec
+  data.tar.gz: b40a76f7f123e27bfa97e4d027cff20f520fecb46c2b11a7f4514817f31a6bfa
 SHA512:
-  metadata.gz: 1c4d53f40b31c60a0d32f45bf5ab8a3a6489325f34fb4f488333a3fdc5c67b876b13bd7cf9ad7daa388124386ba866033b5c96357d6621239f9b02e466db13c4
-  data.tar.gz: c3326a3b85ca3996cf5a0ecee1dbf4d49ada7f8ae37815bdfa053ba9c593bf1a01e508870ebff7b263e159d48472a37c874baddba78d2dfce52ba1aabe9dee99
+  metadata.gz: b70d8504a1fee2ce79639f4dc6e10e51195f5900a92e32666bf26f3233e61d14818346886c818d11c87f0738476f1e994a27742e019adef6bbc8b5f6f0845e83
+  data.tar.gz: 959b01d16677ad6e6e8a873ccea468a3da5c54c15da4734e611bdac188b4f686f187f32d2d29fc49f33af3c13f12f04dbbea8e0a4030bf7c1ee9ac1fbf78bd11

data/lib/VERSION

@@ -1 +1 @@
-2.1.0
+2.3.1

data/lib/VERSION_NOTES

@@ -0,0 +1,20 @@
+2.3.1 - 2023.06.26
+ - Fixes version number stuff.
+
+
+2.3.0 - 2023.06.26
+ - Adds version notes as option on the version verb.
+
+
+2.2 - 2023.06.23
+ - Adds color to list output.
+ - Updates in-app help with verb and object lists and shows settings.
+ - Expanded settings with list indent and levels.
+ - Fixes bug with the debug flag from settings.
+
+2.1 - 2023.05.24
+ - Updates menu to provide convention for simplified usage.
+
+2.0 - 2023.05.22
+ - Version 2 merges gloo-lang back into a single gloo gem.
+

data/lib/gloo/app/info.rb

@@ -10,18 +10,31 @@ module Gloo
   module App
     class Info
 
+      APP_NAME = 'Gloo'.freeze
+      VERSION_FILE = 'VERSION'.freeze
+      VERSION_NOTES_FILE = 'VERSION_NOTES'.freeze
+
       #
       # Load the version from the VERSION file.
       #
       def self.get_version
         f = File.dirname( File.absolute_path( __FILE__ ) )
         f = File.dirname( File.dirname( f ) )
-        f = File.join( f, 'VERSION' )
+        f = File.join( f, VERSION_FILE )
         return File.read( f )
       end
 
       VERSION = Gloo::App::Info.get_version
-      APP_NAME = 'Gloo'.freeze
+
+      #
+      # Load the version notes from the VERSION_NOTES file.
+      #
+      def self.get_version_notes
+        f = File.dirname( File.absolute_path( __FILE__ ) )
+        f = File.dirname( File.dirname( f ) )
+        f = File.join( f, VERSION_NOTES_FILE )
+        return File.read( f )
+      end
 
       #
       # Get the application display title.

data/lib/gloo/app/log.rb

@@ -26,6 +26,7 @@ module Gloo
       def initialize( engine, quiet=true )
         @engine = engine
         @quite = quiet
+        @debug = engine.settings.debug
 
         create_logger
 
@@ -60,6 +61,8 @@ module Gloo
       # Write a debug message to the log.
       #
       def debug( msg )
+        return unless @debug
+
         @logger.debug msg
       end
 

data/lib/gloo/app/settings.rb

@@ -12,7 +12,7 @@ module Gloo
 
       attr_reader :user_root, :log_path,
         :config_path, :project_path,
-        :start_with, :list_indent, :tmp_path,
+        :start_with, :list_indent, :list_levels, :tmp_path,
         :debug_path, :debug
 
       #
@@ -33,51 +33,28 @@ module Gloo
       # Can be seen in app with 'help settings'
       #
       def show
-        puts "\nApplication Settings:"
-        puts '  Startup with:  ' + @start_with
-        puts '  Indent in Listing:  ' + @list_indent.to_s
-        puts '  Screen Lines:  ' + Gloo::App::Settings.lines( @engine ).to_s
-        puts '  Page Size:  ' + Gloo::App::Settings.page_size( @engine ).to_s
-        puts ''
+        puts "\n Application Settings:".blue
+        puts '   Startup with:  '.yellow + @start_with.white
+        puts '   Indent in Listing:  '.yellow + @list_indent.to_s.white
+        puts '   List Levels:  '.yellow + @list_levels.to_s.white
+        puts '   Debug?  '.yellow + @debug.to_s.white
+        puts '   Screen Lines:  '.yellow + Gloo::App::Settings.lines( @engine ).to_s.white
+        puts '   Page Size:  '.yellow + Gloo::App::Settings.page_size( @engine ).to_s.white
         self.show_paths
-        puts ''
       end
-
+      
       #
       # Show path settings
       #
       def show_paths
-        puts '  User Root Path is here:  ' + @user_root
-        puts '  Projects Path:  ' + @project_path
-        puts '  Tmp Path:  ' + @tmp_path
-        puts '  Debug Path:  ' + @debug_path
+        puts "\n Application Paths:".blue
+        puts '   User Root Path is here:  '.yellow + @user_root.white
+        puts '   Projects Path:  '.yellow + @project_path.white
+        puts '   Tmp Path:  '.yellow + @tmp_path.white
+        puts '   Debug Path:  '.yellow + @debug_path.white
+        puts "\n"
       end
 
-      # #
-      # # Show the current application settings.
-      # # Can be seen in app with 'help settings'
-      # #
-      # def show
-      #   puts "\nApplication Settings:".blue
-      #   puts '  Startup with:  '.yellow + @start_with.white
-      #   puts '  Indent in Listing:  '.yellow + @list_indent.to_s.white
-      #   puts '  Screen Lines:  '.yellow + Gloo::App::Settings.lines.to_s.white
-      #   puts '  Page Size:  '.yellow + Gloo::App::Settings.page_size.to_s.white
-      #   puts ''
-      #   self.show_paths
-      #   puts ''
-      # end
-      #
-      # #
-      # # Show path settings
-      # #
-      # def show_paths
-      #   puts '  User Root Path is here:  '.yellow + @user_root.white
-      #   puts '  Projects Path:  '.yellow + @project_path.white
-      #   puts '  Tmp Path:  '.yellow + @tmp_path.white
-      #   puts '  Debug Path:  '.yellow + @debug_path.white
-      # end
-
       #
       # Get the number of vertical lines on screen.
       #
@@ -162,6 +139,7 @@ module Gloo
 
         @start_with = settings[ 'gloo' ][ 'start_with' ]
         @list_indent = settings[ 'gloo' ][ 'list_indent' ]
+        @list_levels = settings[ 'gloo' ][ 'list_levels' ]
 
         @debug = settings[ 'gloo' ][ 'debug' ]
       end
@@ -191,7 +169,8 @@ module Gloo
           gloo:
             project_path: #{projects}
             start_with:
-            list_indent: 1
+            list_indent: 2
+            list_levels: 3
             debug: false
         TEXT
         return str

data/lib/gloo/verbs/help.rb

@@ -14,24 +14,29 @@ module Gloo
       HELP_NOT_FOUND_ERR = 'Help command could not be found:'.freeze
 
       DISPATCH = {
+        s: 'show_settings',
         settings: 'show_settings',
-        keywords: 'show_keywords',
         verb: 'show_verbs',
         verbs: 'show_verbs',
         v: 'show_verbs',
+        o: 'show_objs',
         obj: 'show_objs',
         object: 'show_objs',
-        objects: 'show_objs',
-        o: 'show_objs',
-        topics: 'show_topics'
+        objects: 'show_objs'
       }.freeze
 
       #
       # Run the verb.
       #
       def run
-        data = "\n For documentation use the gloo website. \n\n"
-        @engine.log.show data
+        opts = @tokens.second if @tokens
+        opts = opts.strip.downcase if opts
+
+        if opts
+          dispatch opts
+        else
+          show_default_help
+        end
       end
 
       #
@@ -77,6 +82,105 @@ module Gloo
         @engine.dictionary.show_keywords
       end
 
+      # 
+      # Show default help.
+      # No parameters were given.
+      # 
+      def show_default_help
+        data = "\n"
+        data << " Help Options:\n"
+        data << "   ? objects (obj, o) \n"
+        data << "   ? verbs (v) \n"
+        data << "   ? settings (s) \n"
+        data << "\n For detailed documentation use the gloo website. \n"
+        data << "\n     https://gloo.ecrane.us/doc/. \n\n"
+        @engine.log.show data
+      end
+
+      #
+      # Dispatch the help to the right place.
+      #
+      def dispatch( opts )
+      #   return if dispatch_help_page( opts )
+
+        @engine.log.debug 'looking for help topic'
+        cmd = DISPATCH[ opts.to_sym ]
+        if cmd
+          @engine.log.debug 'found help command'
+          send cmd
+        else
+          report_help_error opts
+        end
+      end
+
+      #
+      # Show application settings.
+      #
+      def show_settings
+        @engine.settings.show
+      end
+
+      #
+      # Report an error with the inline help.
+      #
+      def report_help_error( opts )
+        @engine.err "#{HELP_NOT_FOUND_ERR} '#{opts}'"
+      end
+
+      #
+      # List the verbs
+      #
+      def show_verbs
+        data = "\n"
+        data << " Verbs (shortcut, name)\n".blue
+        data << "#{get_verbs}\n\n"
+        @engine.log.show data
+      end
+
+      #
+      # List the object types
+      #
+      def show_objs
+        data = "\n"
+        data << " Objects \n".blue
+        data << "#{get_objects}\n\n"
+        @engine.log.show data
+      end
+
+      #
+      # Get the text for the list of verbs.
+      #
+      def get_verbs
+        str = ''
+        verbs = @engine.dictionary.get_verbs.sort_by( &:keyword )
+        verbs.each_with_index do |v, i|
+          cut = v.keyword_shortcut.ljust( 5, ' ' ).yellow
+          name = v.keyword.ljust( 20, ' ' ).white
+          str << "   #{cut}  #{name} \n"
+        end
+
+        return str
+      end
+
+      #
+      # Get the text for the list of objects.
+      #
+      def get_objects
+        str = ''
+        objs = @engine.dictionary.get_obj_types.sort_by( &:typename )
+        objs.each_with_index do |o, i|          
+          if o.short_typename != o.typename
+            short = "(#{o.short_typename})".yellow
+            name = "#{o.typename.white}  #{short}"
+          else
+            name = o.typename.white
+          end
+          str << "   #{name.ljust( 30, ' ' )}\n"
+        end
+
+        return str
+      end
+
     end
   end
 end

data/lib/gloo/verbs/list.rb

@@ -18,9 +18,11 @@ module Gloo
       def run
         levels = determine_levels
         target = self.determine_target
+        indent = self.determine_indent
+
         obj = target.resolve
         if obj
-          show_target( obj, levels )
+          show_target( obj, levels, indent )
         else
           @engine.err "#{TARGET_MISSING_ERR} #{target}"
         end
@@ -63,7 +65,7 @@ module Gloo
         return if levels.zero?
 
         obj.children.each do |o|
-          show_target( o, levels - 1, "#{indent}  " )
+          show_target( o, levels - 1, "#{indent}#{determine_indent}" )
         end
       end
 
@@ -72,12 +74,17 @@ module Gloo
       #
       def show_obj( obj, indent = '  ' )
         if obj.multiline_value? && obj.value_is_array?
-          @engine.log.show "#{indent}#{obj.name} [#{obj.type_display}] :"
+          str = "#{indent}#{obj.name}".white
+          str << " [#{obj.type_display}] : ".yellow
+          @engine.log.show str
           obj.value.each do |line|
             @engine.log.show "#{indent}  #{line}"
           end
         else
-          @engine.log.show "#{indent}#{obj.name} [#{obj.type_display}] : #{obj.value}"
+          str = "#{indent}#{obj.name}".white
+          str << " [#{obj.type_display}] : ".yellow
+          str << "#{obj.value}"
+          @engine.log.show str
         end
       end
 
@@ -86,13 +93,27 @@ module Gloo
       #
       def determine_levels
         # Check settings for the default value.
-        levels = @engine.settings.list_indent
+        levels = @engine.settings.list_levels
         return levels if levels
 
         # Last chance: use the default
         return 1
       end
 
+      #
+      # Determine the level of indentation in the outline.
+      #
+      def determine_indent
+        # Check settings for the default value.
+        indent = @engine.settings.list_indent
+        if indent
+          return ( ' ' * indent )
+        end
+
+        # Last chance: use the default
+        return 2
+      end
+
     end
   end
 end

data/lib/gloo/verbs/version.rb

@@ -10,12 +10,14 @@ module Gloo
 
       KEYWORD = 'version'.freeze
       KEYWORD_SHORT = 'v'.freeze
+      NOTES = 'notes'.freeze
+      NOTES_SHORT = 'n'.freeze
 
       #
       # Run the verb.
       #
       def run
-        @engine.log.show Gloo::App::Info.full_version
+        vers_notes? ? show_vers_notes : show_vers
       end
 
       #
@@ -32,6 +34,42 @@ module Gloo
         return KEYWORD_SHORT
       end
 
+
+      # ---------------------------------------------------------------------
+      #    Private functions
+      # ---------------------------------------------------------------------
+
+      private
+
+      # 
+      # Show basic version numbers.
+      # 
+      def show_vers
+        @engine.log.show Gloo::App::Info.full_version
+        @engine.log.show "\nUse `#{KEYWORD} #{NOTES}` to see version notes."
+      end
+
+      # 
+      # Show version notes.
+      # 
+      def show_vers_notes
+        @engine.log.show "Gloo version notes..."
+        notes = Gloo::App::Info.get_version_notes
+        @engine.platform.show( notes, false, true )
+      end
+
+      # 
+      # Is the request to show version notes?
+      # 
+      def vers_notes?
+        if ( @tokens.token_count > 1 ) && ( 
+          ( @tokens.last == NOTES ) || ( @tokens.last == NOTES_SHORT ) )
+          return true
+        end
+
+        return false
+      end
+
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gloo
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.3.1
 platform: ruby
 authors:
 - Eric Crane
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-05-24 00:00:00.000000000 Z
+date: 2023-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -270,6 +270,7 @@ files:
 - exe/o
 - gloo.gemspec
 - lib/VERSION
+- lib/VERSION_NOTES
 - lib/dependencies.rb
 - lib/gloo.rb
 - lib/gloo/app/args.rb