gloo 0.3.0 → 0.5.3

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

@@ -0,0 +1,120 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2020 Eric Crane.  All rights reserved.
+#
+# Show colorized output with the pastel gem.
+#
+require 'pastel'
+
+module Gloo
+  module Objs
+    class Pastel < Gloo::Core::Obj
+
+      KEYWORD = 'pastel'.freeze
+      KEYWORD_SHORT = 'pastel'.freeze
+      TEXT = 'text'.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 text from the child object.
+      #
+      def text_value
+        o = find_child TEXT
+        return '' unless o
+
+        return o.value
+      end
+
+      #
+      # Get the 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 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
+        pastel = ::Pastel.new
+        c = self.color_value.split( ' ' ).map( &:to_sym )
+        puts pastel.decorate( self.text_value, *c )
+      end
+
+      # ---------------------------------------------------------------------
+      #    Help
+      # ---------------------------------------------------------------------
+
+      #
+      # Get help for this object type.
+      #
+      def self.help
+        return <<~TEXT
+          PASTEL OBJECT TYPE
+            NAME: pastel
+            SHORTCUT: pastel
+
+          DESCRIPTION
+            Show colorized text with the pastel gem.
+
+          CHILDREN
+            text - string
+              The text that will be colorized.
+            color - string
+              The colors.  See pastel for options.
+
+          MESSAGES
+            show - Show the colorized text.
+        TEXT
+      end
+
+    end
+  end
+end

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

@@ -7,45 +7,46 @@
 module Gloo
   module Objs
     class Prompt < Gloo::Core::Obj
-      
-      KEYWORD = 'prompt'
-      KEYWORD_SHORT = 'ask'
-      PROMPT = 'prompt'
-      RESULT = 'result'
 
-      # 
+      KEYWORD = 'prompt'.freeze
+      KEYWORD_SHORT = 'ask'.freeze
+      PROMPT = 'prompt'.freeze
+      RESULT = 'result'.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 URI from the child object.
+
+      #
+      # Get the prompt from the child object.
       # Returns nil if there is none.
-      # 
-      def get_prompt
+      #
+      def prompt_value
         o = find_child PROMPT
         return nil unless o
+
         return o.value
       end
-      
-      # 
+
+      #
       # Set the result of the system call.
-      # 
-      def set_result data
+      #
+      def set_result( data )
         r = find_child RESULT
         return nil unless r
+
         r.set_value data
       end
-            
 
       # ---------------------------------------------------------------------
       #    Children
@@ -57,36 +58,77 @@ 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 "prompt", "string", "> ", self
-        fac.create "result", "string", nil, self
+        fac.create_string PROMPT, '>', self
+        fac.create_string RESULT, nil, self
       end
 
-      
       # ---------------------------------------------------------------------
       #    Messages
       # ---------------------------------------------------------------------
 
-      # 
+      #
       # Get a list of message names that this object receives.
-      # 
+      #
       def self.messages
-        return super + [ "run" ]
+        return super + %w[run multiline]
       end
-      
-      # Run the system command.
+
+      #
+      # Show a multiline prompt and get the user's input.
+      #
+      def msg_multiline
+        prompt = prompt_value
+        return unless prompt
+
+        result = $prompt.multiline( prompt )
+        set_result result.join
+      end
+
+      #
+      # Show the prompt and get the user's input.
+      #
       def msg_run
-        prompt = get_prompt
+        prompt = prompt_value
         return unless prompt
+
         result = $prompt.ask( prompt )
         set_result result
       end
-      
+
+      # ---------------------------------------------------------------------
+      #    Help
+      # ---------------------------------------------------------------------
+
+      #
+      # Get help for this object type.
+      #
+      def self.help
+        return <<~TEXT
+          PROMPT OBJECT TYPE
+            NAME: prompt
+            SHORTCUT: ask
+
+          DESCRIPTION
+            CLI prompt for user input.
+
+          CHILDREN
+            prompt - string - '> '
+              The prompt displayed to the user.
+            result - string - none
+              The result with the user's input.
+
+          MESSAGES
+            run - Prompt the user and then set the result.
+            multiline - Show a multiline prompt.
+        TEXT
+      end
+
     end
   end
 end

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

@@ -0,0 +1,153 @@
+# Author::    Eric Crane  (mailto:eric.crane@mac.com)
+# Copyright:: Copyright (c) 2020 Eric Crane.  All rights reserved.
+#
+# Show a CLI prompt and user selection from a list.
+#
+
+module Gloo
+  module Objs
+    class Select < Gloo::Core::Obj
+
+      KEYWORD = 'select'.freeze
+      KEYWORD_SHORT = 'sel'.freeze
+      PROMPT = 'prompt'.freeze
+      OPTIONS = 'options'.freeze
+      RESULT = 'result'.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 prompt from the child object.
+      # Returns nil if there is none.
+      #
+      def prompt_value
+        o = find_child PROMPT
+        return nil unless o
+
+        return o.value
+      end
+
+      #
+      # Get the list of options for selection.
+      #
+      def options
+        o = find_child OPTIONS
+        return [] unless o
+
+        return o.children.map( &:name )
+      end
+
+      #
+      # Get the value of the selected item.
+      #
+      def key_for_option( selected )
+        o = find_child OPTIONS
+        return nil unless o
+
+        o.children.each do |c|
+          return c.value if c.name == selected
+        end
+
+        return nil
+      end
+
+      #
+      # Set the result of the system call.
+      #
+      def set_result( data )
+        r = find_child RESULT
+        return nil unless r
+
+        r.set_value data
+      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 PROMPT, '>', self
+        fac.create_can OPTIONS, self
+        fac.create_string RESULT, nil, self
+      end
+
+      # ---------------------------------------------------------------------
+      #    Messages
+      # ---------------------------------------------------------------------
+
+      #
+      # Get a list of message names that this object receives.
+      #
+      def self.messages
+        return super + %w[run]
+      end
+
+      #
+      # Show the prompt and get the user's selection.
+      #
+      def msg_run
+        prompt = prompt_value
+        return unless prompt
+
+        per = Gloo::App::Settings.page_size
+        result = $prompt.select( prompt, options, :per_page => per )
+        set_result self.key_for_option( result )
+      end
+
+      # ---------------------------------------------------------------------
+      #    Help
+      # ---------------------------------------------------------------------
+
+      #
+      # Get help for this object type.
+      #
+      def self.help
+        return <<~TEXT
+          SELECT OBJECT TYPE
+            NAME: select
+            SHORTCUT: sel
+
+          DESCRIPTION
+            Prompt for user to select from a list of options.
+
+          CHILDREN
+            prompt - string - '> '
+              The prompt displayed to the user.
+            options - container
+              The list of options for the selection list.
+              The name of each option will be presented to the user, but
+              the value will be put in the result.
+            result - string - none
+              The result with the user's selection.
+
+          MESSAGES
+            run - Prompt the user for a selection and then set the result.
+        TEXT
+      end
+
+    end
+  end
+end

data/lib/gloo/objs/ctrl/each.rb

@@ -12,49 +12,47 @@
 module Gloo
   module Objs
     class Each < Gloo::Core::Obj
-      
-      KEYWORD = 'each'
-      KEYWORD_SHORT = 'each'
-      WORD = 'word'
-      LINE = 'line'
-      FILE = 'file'
-      REPO = 'repo'
-      IN = 'IN'
-      DO = 'do'
-
-      # 
+
+      KEYWORD = 'each'.freeze
+      KEYWORD_SHORT = 'each'.freeze
+      CHILD = 'child'.freeze
+      WORD = 'word'.freeze
+      LINE = 'line'.freeze
+      FILE = 'file'.freeze
+      REPO = 'repo'.freeze
+      IN = 'IN'.freeze
+      DO = 'do'.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 URI from the child object.
       # Returns nil if there is none.
-      # 
-      def get_in
+      #
+      def in_value
         o = find_child IN
-        return nil unless o
-        return o.value
+        return o ? o.value : nil
       end
-      
+
       # Run the do script once.
       def run_do
         o = find_child DO
-        if o.can_receive_message? "run"
-          o.send_message "run"
-        end
-      end
+        return unless o
 
-      
+        Gloo::Exec::Dispatch.message 'run', o
+      end
 
       # ---------------------------------------------------------------------
       #    Children
@@ -66,32 +64,33 @@ 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 "word", "string", "", self
-        fac.create "in", "string", "", self
-        fac.create "do", "script", "", self
+        fac.create_string WORD, '', self
+        fac.create_string IN, '', self
+        fac.create_script DO, '', 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
-        if each_word?
+        if each_child?
+          run_each_child
+        elsif each_word?
           run_each_word
         elsif each_line?
           run_each_line
@@ -99,8 +98,40 @@ module Gloo
           run_each_repo
         end
       end
-      
-      
+
+      # ---------------------------------------------------------------------
+      #    Child Object
+      # ---------------------------------------------------------------------
+
+      # Is it set up to run for each word?
+      # If there is a child object by the name "word"
+      # then we will loop for each word in the string.
+      def each_child?
+        return true if contains_child? CHILD
+
+        return false
+      end
+
+      # Run for each word.
+      def run_each_child
+        o = find_child IN
+        return unless o
+
+        o = Gloo::Objs::Alias.resolve_alias( o )
+        o.children.each do |child|
+          set_child child
+          run_do
+        end
+      end
+
+      # Set the child alias.
+      def set_child( obj )
+        o = find_child CHILD
+        return unless o
+
+        o.set_value obj.pn
+      end
+
       # ---------------------------------------------------------------------
       #    Word
       # ---------------------------------------------------------------------
@@ -109,28 +140,29 @@ module Gloo
       # If there is a child object by the name "word"
       # then we will loop for each word in the string.
       def each_word?
-        o = find_child WORD
-        return true if o
+        return true if find_child WORD
+
         return false
       end
 
       # Run for each word.
       def run_each_word
-        str = get_in
+        str = in_value
         return unless str
-        str.split( " " ).each do |word|
+
+        str.split( ' ' ).each do |word|
           set_word word
           run_do
         end
       end
-      
+
       # Set the value of the word.
-      def set_word word
+      def set_word( word )
         o = find_child WORD
         return unless o
+
         o.set_value word
       end
-      
 
       # ---------------------------------------------------------------------
       #    Line
@@ -140,30 +172,30 @@ module Gloo
       # If there is a child object by the name "line"
       # then we will loop for each line in the string.
       def each_line?
-        o = find_child LINE
-        return true if o
+        return true if find_child LINE
+
         return false
       end
-      
+
       # Run for each line.
       def run_each_line
-        str = get_in
+        str = in_value
         return unless str
-        str.split( "\n" ).each do |line|
+
+        str.each_line do |line|
           set_line line
           run_do
         end
       end
-      
+
       # Set the value of the word.
-      def set_line line
+      def set_line( line )
         o = find_child LINE
         return unless o
+
         o.set_value line
       end
 
-
-
       # ---------------------------------------------------------------------
       #    Git Repo
       # ---------------------------------------------------------------------
@@ -172,11 +204,11 @@ module Gloo
       # If there is a child object by the name "repo"
       # then we will loop for each repo in the directory.
       def each_repo?
-        o = find_child REPO
-        return true if o
+        return true if find_child REPO
+
         return false
       end
-      
+
       def find_all_git_projects( path )
         path.children.collect do |f|
           if f.directory? && ( File.basename( f ) == '.git' )
@@ -189,8 +221,9 @@ module Gloo
 
       # Run for each line.
       def run_each_repo
-        path = get_in
+        path = in_value
         return unless path
+
         path = Pathname.new( path )
         repos = find_all_git_projects( path )
         repos.each do |o|
@@ -198,15 +231,49 @@ module Gloo
           run_do
         end
       end
-      
+
       # Set the value of the repo.
       # This is a path to the repo.
-      def set_repo path
+      def set_repo( path )
         o = find_child REPO
         return unless o
+
         o.set_value path
       end
 
+      # ---------------------------------------------------------------------
+      #    Help
+      # ---------------------------------------------------------------------
+
+      #
+      # Get help for this object type.
+      #
+      def self.help
+        return <<~TEXT
+          EACH OBJECT TYPE
+            NAME: each
+            SHORTCUT: each
+
+          DESCRIPTION
+            Perform an action for each item in a collection.
+
+          CHILDREN
+            child | word | line | repo - string - none
+              The entity we want to loop for.
+              It will hold the current value while the script is running.
+            in - string - none
+              The collection we will iterate in.
+              In the case of <word> or <line> this will be a string or text.
+              In the case of <repo> this will be the root path.
+            do - script - none
+              The action we want to perform for each found item.
+
+          MESSAGES
+            run - Look through the collecion and perform this for each
+              found item.
+        TEXT
+      end
+
     end
   end
 end