gloo 0.6.1 → 0.7.0

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

@@ -37,7 +37,9 @@ module Gloo
         return o ? o.value : 0
       end
 
+      #
       # Run the do script once.
+      #
       def run_do
         o = find_child DO
         return unless o
@@ -45,7 +47,9 @@ module Gloo
         Gloo::Exec::Dispatch.message 'run', o
       end
 
+      #
       # Set the index of the current iteration.
+      #
       def set_index( index )
         o = find_child INDEX
         return unless o
@@ -57,16 +61,20 @@ module Gloo
       #    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_int TIMES, 0, self
@@ -95,35 +103,6 @@ module Gloo
         end
       end
 
-      # ---------------------------------------------------------------------
-      #    Help
-      # ---------------------------------------------------------------------
-
-      #
-      # Get help for this object type.
-      #
-      def self.help
-        return <<~TEXT
-          REPEAT OBJECT TYPE
-            NAME: repeat
-            SHORTCUT: repeat
-
-          DESCRIPTION
-            Run a script a given number of times.
-
-          CHILDREN
-            times integer - 0
-              The number of times to run the script.
-            index integer - 0
-              The current iteration when the repeat loop is running.
-            do - script - none
-              The action we want to perform for iteration of the loop.
-
-          MESSAGES
-            run - Run the script for the given number of times.
-        TEXT
-      end
-
     end
   end
 end

data/lib/gloo/objs/data/markdown.rb

@@ -79,31 +79,6 @@ module Gloo
         pager.page( md )
       end
 
-      # ---------------------------------------------------------------------
-      #    Help
-      # ---------------------------------------------------------------------
-
-      #
-      # Get help for this object type.
-      #
-      def self.help
-        return <<~TEXT
-          MARKDOWN OBJECT TYPE
-            NAME: markdown
-            SHORTCUT: md
-
-          DESCRIPTION
-            Markdown data in a text string.
-
-          CHILDREN
-            None
-
-          MESSAGES
-            show - Show the markdown data in the terminal.
-            page - Show the markdown data in the terminal, paginated.
-        TEXT
-      end
-
     end
   end
 end

data/lib/gloo/objs/data/table.rb

@@ -70,16 +70,20 @@ module Gloo
       #    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_can HEADERS, self
@@ -131,38 +135,6 @@ module Gloo
         puts "#{rendered}\n\n"
       end
 
-      # ---------------------------------------------------------------------
-      #    Help
-      # ---------------------------------------------------------------------
-
-      #
-      # Get help for this object type.
-      #
-      def self.help
-        return <<~TEXT
-          TABLE OBJECT TYPE
-            NAME: table
-            SHORTCUT: tbl
-
-          DESCRIPTION
-            A data table.
-
-          CHILDREN
-            headers - container
-              A list of headers.
-              The name of the header object needs to be the same as the
-              name of the object in the data container.
-              The value of the header is what will be displayed.
-            data - container
-              The table's data.
-              The data container will have one or more containers, each
-              of which represents one row of data.
-
-          MESSAGES
-            show - Show the contents of the table in the CLI.
-        TEXT
-      end
-
     end
   end
 end

data/lib/gloo/objs/dev/git.rb

@@ -43,7 +43,9 @@ module Gloo
         return super + %w[validate check_changes get_changes commit get_branch]
       end
 
+      #
       # Get the current working branch.
+      #
       def msg_get_branch
         branch = ''
         path = path_value
@@ -55,7 +57,9 @@ module Gloo
         $engine.heap.it.set_to branch
       end
 
+      #
       # Commit pending changes.
+      #
       def msg_commit
         msg = 'Commit'
         path = path_value
@@ -74,7 +78,9 @@ module Gloo
         $engine.heap.it.set_to msg
       end
 
+      #
       # Get the pending changes.
+      #
       def msg_get_changes
         path = path_value
         result = `cd #{path}; git status -s` if path_is_dir?( path )
@@ -82,12 +88,16 @@ module Gloo
         $engine.heap.it.set_to result
       end
 
+      #
       # Is the given path non nil and is it a directory?
+      #
       def path_is_dir?( path )
         return path && File.directory?( path )
       end
 
+      #
       # Check to see if the repo has changes.
+      #
       def msg_check_changes
         result = false
         path = path_value
@@ -99,7 +109,9 @@ module Gloo
         $engine.heap.it.set_to result
       end
 
+      #
       # Check to make sure this is a valide git repo.
+      #
       def msg_validate
         result = false
         path = path_value
@@ -111,36 +123,6 @@ module Gloo
         $engine.heap.it.set_to result
       end
 
-      # ---------------------------------------------------------------------
-      #    Help
-      # ---------------------------------------------------------------------
-
-      #
-      # Get help for this object type.
-      #
-      def self.help
-        return <<~TEXT
-          GIT OBJECT TYPE
-            NAME: git_repo
-            SHORTCUT: git
-
-          DESCRIPTION
-            Reference to a git repository in the file system.
-            The value of the git_repo objectd is a string.
-            There are no children needed.
-
-          CHILDREN
-            None
-
-          MESSAGES
-            validate - Validate that this is a git repo.
-            check_changes - Check to see if there are any pending changes.
-            get_changes - Get the list of pending changes.
-            commit - Commit changes.
-            get_branch - Get the current branch.
-        TEXT
-      end
-
     end
   end
 end

data/lib/gloo/objs/dt/date.rb

@@ -36,37 +36,15 @@ module Gloo
         return super + %w[now]
       end
 
-      # Get the current working branch.
+      #
+      # Set to the current date.
+      #
       def msg_now
         t = DateTime.now.strftime( '%Y.%m.%d' )
         self.value = t
         $engine.heap.it.set_to t
       end
 
-      # ---------------------------------------------------------------------
-      #    Help
-      # ---------------------------------------------------------------------
-
-      #
-      # Get help for this object type.
-      #
-      def self.help
-        return <<~TEXT
-          DATE OBJECT TYPE
-            NAME: date
-            SHORTCUT: date
-
-          DESCRIPTION
-            A reference to a date, but without time.
-
-          CHILDREN
-            None
-
-          MESSAGES
-            now - Set to the current system date.
-        TEXT
-      end
-
     end
   end
 end

data/lib/gloo/objs/dt/datetime.rb

@@ -30,7 +30,7 @@ module Gloo
       #
       def set_value( new_value )
         unless new_value.is_a? DateTime
-          self.value = $engine.convert( new_value, 'DateTime', nil )
+          self.value = $engine.converter.convert( new_value, 'DateTime', nil )
           return
         end
 
@@ -48,37 +48,15 @@ module Gloo
         return super + %w[now]
       end
 
-      # Get the current working branch.
+      #
+      # Set to the current date and time.
+      #
       def msg_now
         t = DateTime.now.strftime( '%Y.%m.%d %I:%M:%S %P' )
         self.value = t
         $engine.heap.it.set_to t
       end
 
-      # ---------------------------------------------------------------------
-      #    Help
-      # ---------------------------------------------------------------------
-
-      #
-      # Get help for this object type.
-      #
-      def self.help
-        return <<~TEXT
-          DATETIME OBJECT TYPE
-            NAME: datetime
-            SHORTCUT: dt
-
-          DESCRIPTION
-            A reference to a date and time.
-
-          CHILDREN
-            None
-
-          MESSAGES
-            now - Set to the current system date and time.
-        TEXT
-      end
-
     end
   end
 end

data/lib/gloo/objs/dt/time.rb

@@ -36,37 +36,15 @@ module Gloo
         return super + %w[now]
       end
 
-      # Get the current working branch.
+      #
+      # Set to the current time.
+      #
       def msg_now
         t = DateTime.now.strftime( '%I:%M:%S %P' )
         self.value = t
         $engine.heap.it.set_to t
       end
 
-      # ---------------------------------------------------------------------
-      #    Help
-      # ---------------------------------------------------------------------
-
-      #
-      # Get help for this object type.
-      #
-      def self.help
-        return <<~TEXT
-          TIME OBJECT TYPE
-            NAME: time
-            SHORTCUT: time
-
-          DESCRIPTION
-            A reference to a time, but without a date.
-
-          CHILDREN
-            None
-
-          MESSAGES
-            now - Set to the current system time.
-        TEXT
-      end
-
     end
   end
 end

data/lib/gloo/objs/ror/erb.rb

@@ -40,7 +40,7 @@ module Gloo
       end
 
       #
-      # Set the result of the system call.
+      # Set the result of the ERB template conversion.
       #
       def set_result( data )
         r = find_child RESULT
@@ -68,30 +68,25 @@ module Gloo
       #    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( { :name => 'template',
-                      :type => 'text',
-                      :value => '',
-                      :parent => self } )
-        fac.create( { :name => 'params',
-                      :type => 'container',
-                      :value => nil,
-                      :parent => self } )
-        fac.create( { :name => 'result',
-                      :type => 'text',
-                      :value => nil,
-                      :parent => self } )
+        fac.create_text TEMPLATE, '', self
+        fac.create_can PARAMS, self
+        fac.create_text RESULT, '', self
       end
 
       # ---------------------------------------------------------------------
@@ -105,7 +100,9 @@ module Gloo
         return super + [ 'run' ]
       end
 
-      # Run the system command.
+      #
+      # Run the ERB template conversion.
+      #
       def msg_run
         tmpl = template_value
         return unless tmpl
@@ -114,37 +111,6 @@ module Gloo
         set_result render.result_with_hash( param_hash )
       end
 
-      # ---------------------------------------------------------------------
-      #    Help
-      # ---------------------------------------------------------------------
-
-      #
-      # Get help for this object type.
-      #
-      def self.help
-        return <<~TEXT
-          ERB OBJECT TYPE
-            NAME: erb
-            SHORTCUT: erb
-
-          DESCRIPTION
-            Use the ERB templating system to generate content.
-
-          CHILDREN
-            template - text
-              The template that will be used the the ERB object is run.
-            params - container
-              The collection of children values that will be used
-              when the template object is rendered.
-            result - text
-              The result of the template rendering.
-
-          MESSAGES
-            run - Render the result based on the template and the
-                  parameter values.
-        TEXT
-      end
-
     end
   end
 end