gloo 0.3.0 → 0.5.3

data/lib/gloo/objs/basic/untyped.rb

@@ -7,36 +7,61 @@
 module Gloo
   module Objs
     class Untyped < Gloo::Core::Obj
-      
-      KEYWORD = 'untyped'
-      KEYWORD_SHORT = 'un'
 
-      # 
+      KEYWORD = 'untyped'.freeze
+      KEYWORD_SHORT = 'un'.freeze
+
+      #
       # The name of the object type.
-      # 
+      #
       def self.typename
         return KEYWORD
       end
 
-      # 
+      #
       # The short name of the object type.
-      # 
+      #
       def self.short_typename
         return KEYWORD_SHORT
       end
 
-      
       # ---------------------------------------------------------------------
       #    Messages
       # ---------------------------------------------------------------------
 
-      # 
+      #
       # Get a list of message names that this object receives.
-      # 
+      #
       def self.messages
         return super # + [ "run" ]
       end
 
+      # ---------------------------------------------------------------------
+      #    Help
+      # ---------------------------------------------------------------------
+
+      #
+      # Get help for this object type.
+      #
+      def self.help
+        return <<~TEXT
+          UNTYPED OBJECT TYPE
+            NAME: untyped
+            SHORTCUT: un
+
+          DESCRIPTION
+            An untyped object.
+            If no type is specified when an object is created it
+            will be of this type.
+
+          CHILDREN
+            None
+
+          MESSAGES
+            None
+        TEXT
+      end
+
     end
   end
 end

data/lib/gloo/objs/cli/banner.rb

@@ -0,0 +1,137 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2020 Eric Crane.  All rights reserved.
+#
+# Show a large-text banner.
+#
+require 'tty-font'
+require 'pastel'
+
+module Gloo
+  module Objs
+    class Banner < Gloo::Core::Obj
+
+      KEYWORD = 'banner'.freeze
+      KEYWORD_SHORT = 'ban'.freeze
+      TEXT = 'text'.freeze
+      STYLE = 'style'.freeze
+      COLOR = 'color'.freeze
+
+      #
+      # The name of the object type.
+      #
+      def self.typename
+        return KEYWORD
+      end
+
+      #
+      # The short name of the object type.
+      #
+      def self.short_typename
+        return KEYWORD_SHORT
+      end
+
+      #
+      # Get the banner text from the child object.
+      #
+      def text_value
+        o = find_child TEXT
+        return '' unless o
+
+        return o.value
+      end
+
+      #
+      # Get the banner style from the child object.
+      #
+      def style_value
+        o = find_child STYLE
+        return '' unless o
+
+        return o.value
+      end
+
+      #
+      # Get the banner color from the child object.
+      #
+      def color_value
+        o = find_child COLOR
+        return '' unless o
+
+        return o.value
+      end
+
+      # ---------------------------------------------------------------------
+      #    Children
+      # ---------------------------------------------------------------------
+
+      # Does this object have children to add when an object
+      # is created in interactive mode?
+      # This does not apply during obj load, etc.
+      def add_children_on_create?
+        return true
+      end
+
+      # Add children to this object.
+      # This is used by containers to add children needed
+      # for default configurations.
+      def add_default_children
+        fac = $engine.factory
+        fac.create_string TEXT, '', self
+        fac.create_string STYLE, '', self
+        fac.create_string COLOR, '', self
+      end
+
+      # ---------------------------------------------------------------------
+      #    Messages
+      # ---------------------------------------------------------------------
+
+      #
+      # Get a list of message names that this object receives.
+      #
+      def self.messages
+        return super + %w[show]
+      end
+
+      #
+      # Show the banner bar
+      #
+      def msg_show
+        font = TTY::Font.new self.style_value
+        t = font.write( self.text_value )
+        pastel = ::Pastel.new
+        c = self.color_value.split( ' ' ).map( &:to_sym )
+        puts pastel.decorate( t, *c )
+      end
+
+      # ---------------------------------------------------------------------
+      #    Help
+      # ---------------------------------------------------------------------
+
+      #
+      # Get help for this object type.
+      #
+      def self.help
+        return <<~TEXT
+          BANNER OBJECT TYPE
+            NAME: banner
+            SHORTCUT: ban
+
+          DESCRIPTION
+            Banner text in large, colored font.
+
+          CHILDREN
+            text - string
+              The text for the banner.
+            style - string
+              The banner style.  See tty-font for options.
+            color - string
+              The color for the banner.  See pastel for options.
+
+          MESSAGES
+            show - Show the text banner.
+        TEXT
+      end
+
+    end
+  end
+end

data/lib/gloo/objs/cli/bar.rb

@@ -0,0 +1,141 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2020 Eric Crane.  All rights reserved.
+#
+# Show a CLI progress bar.
+#
+require 'tty-progressbar'
+
+module Gloo
+  module Objs
+    class Bar < Gloo::Core::Obj
+
+      KEYWORD = 'bar'.freeze
+      KEYWORD_SHORT = 'bar'.freeze
+      NAME = 'name'.freeze
+      TOTAL = 'total'.freeze
+
+      #
+      # The name of the object type.
+      #
+      def self.typename
+        return KEYWORD
+      end
+
+      #
+      # The short name of the object type.
+      #
+      def self.short_typename
+        return KEYWORD_SHORT
+      end
+
+      #
+      # Get the bar's name from the child object.
+      #
+      def name_value
+        o = find_child NAME
+        return '' unless o
+
+        return o.value
+      end
+
+      #
+      # Get the bar's total from the child object.
+      #
+      def total_value
+        o = find_child TOTAL
+        return 100 unless o
+
+        return o.value
+      end
+
+      # ---------------------------------------------------------------------
+      #    Children
+      # ---------------------------------------------------------------------
+
+      # Does this object have children to add when an object
+      # is created in interactive mode?
+      # This does not apply during obj load, etc.
+      def add_children_on_create?
+        return true
+      end
+
+      # Add children to this object.
+      # This is used by containers to add children needed
+      # for default configurations.
+      def add_default_children
+        fac = $engine.factory
+        fac.create_string NAME, '', self
+        fac.create_int TOTAL, 100, self
+      end
+
+      # ---------------------------------------------------------------------
+      #    Messages
+      # ---------------------------------------------------------------------
+
+      #
+      # Get a list of message names that this object receives.
+      #
+      def self.messages
+        return super + %w[start advance stop]
+      end
+
+      #
+      # Start the progress bar.
+      #
+      def msg_start
+        msg = "#{name_value} [:bar] :percent"
+        @bar = TTY::ProgressBar.new( msg, total: total_value )
+      end
+
+      #
+      # Finish the progress bar.
+      #
+      def msg_stop
+        @bar.finish
+      end
+
+      #
+      # Advance the progress bar.
+      #
+      def msg_advance
+        x = 1
+        if @params&.token_count&.positive?
+          expr = Gloo::Expr::Expression.new( @params.tokens )
+          x = expr.evaluate.to_i
+        end
+
+        @bar.advance x
+      end
+
+      # ---------------------------------------------------------------------
+      #    Help
+      # ---------------------------------------------------------------------
+
+      #
+      # Get help for this object type.
+      #
+      def self.help
+        return <<~TEXT
+          BAR OBJECT TYPE
+            NAME: bar
+            SHORTCUT: bar
+
+          DESCRIPTION
+            CLI progress bar
+
+          CHILDREN
+            name - string
+              The name of the progress bar.
+            total - integer - 100
+              The total for the bar.
+
+          MESSAGES
+            start - Start the bar.
+            advance <amount> - Advance by the given amount.
+            stop - Complete the bar.
+        TEXT
+      end
+
+    end
+  end
+end

data/lib/gloo/objs/cli/colorize.rb

@@ -1,5 +1,5 @@
 # Author::    Eric Crane  (mailto:eric.crane@mac.com)
-# Copyright:: Copyright (c) 2019 Eric Crane.  All rights reserved.
+# Copyright:: Copyright (c) 2020 Eric Crane.  All rights reserved.
 #
 # Show colorized output.
 #
@@ -8,24 +8,23 @@ require 'colorized_string'
 module Gloo
   module Objs
     class Colorize < Gloo::Core::Obj
-      
-      KEYWORD = 'colorize'
-      KEYWORD_SHORT = 'color'
 
-      # 
+      KEYWORD = 'colorize'.freeze
+      KEYWORD_SHORT = 'color'.freeze
+
+      #
       # The name of the object type.
-      # 
+      #
       def self.typename
         return KEYWORD
       end
 
-      # 
+      #
       # The short name of the object type.
-      # 
+      #
       def self.short_typename
         return KEYWORD_SHORT
       end
-                  
 
       # ---------------------------------------------------------------------
       #    Children
@@ -37,37 +36,68 @@ module Gloo
       def add_children_on_create?
         return true
       end
-      
+
       # Add children to this object.
-      # This is used by containers to add children needed 
+      # This is used by containers to add children needed
       # for default configurations.
       def add_default_children
         fac = $engine.factory
-        fac.create "white", "string", "", self
+        fac.create( { :name => 'white',
+                      :type => 'string',
+                      :value => '',
+                      :parent => self } )
       end
 
-      
       # ---------------------------------------------------------------------
       #    Messages
       # ---------------------------------------------------------------------
 
-      # 
+      #
       # Get a list of message names that this object receives.
-      # 
+      #
       def self.messages
-        return super + [ "run" ]
+        return super + [ 'run' ]
       end
-      
+
       # Run the system command.
       def msg_run
-				msg = ""
-				children.each do |o|
-					msg += ColorizedString[ o.value_display ].colorize( o.name.to_sym )
-				end
-				$log.show msg
-				$engine.heap.it.set_to msg.to_s
+        msg = ''
+        children.each do |o|
+          msg += ColorizedString[ o.value_display ].colorize( o.name.to_sym )
+        end
+        $log.show msg
+        $engine.heap.it.set_to msg.to_s
+      end
+
+      # ---------------------------------------------------------------------
+      #    Help
+      # ---------------------------------------------------------------------
+
+      #
+      # Get help for this object type.
+      #
+      def self.help
+        return <<~TEXT
+          COLORIZE OBJECT TYPE
+            NAME: colorize
+            SHORTCUT: color
+
+          DESCRIPTION
+            The Colorize object can be used to write output in color.
+            The Colorize container can contain multiple strings, each
+            one can have a different color as specified by the names
+            of the children.
+
+          CHILDREN
+            <color> - string - no default value
+              The name of the child or children is the color.
+              The string's value is what will be written out.
+
+          MESSAGES
+            run - Output the string in the color specified.
+        TEXT
       end
-      
+
     end
   end
 end