gloo 0.5.4 → 0.7.2

data/lib/gloo/objs/web/http_post.rb

@@ -72,16 +72,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_string URL, 'https://web.site/', self
@@ -99,7 +103,9 @@ module Gloo
         return super + [ 'run' ]
       end
 
+      #
       # Post the content to the endpoint.
+      #
       def msg_run
         uri = uri_value
         return unless uri
@@ -116,7 +122,9 @@ module Gloo
       #    Static functions
       # ---------------------------------------------------------------------
 
+      #
       # Post the content to the endpoint.
+      #
       def self.post_json( url, body, use_ssl = true )
         # Structure the request
         uri = URI.parse( url )
@@ -133,37 +141,6 @@ module Gloo
         return result.body
       end
 
-      # ---------------------------------------------------------------------
-      #    Help
-      # ---------------------------------------------------------------------
-
-      #
-      # Get help for this object type.
-      #
-      def self.help
-        return <<~TEXT
-          HTTP_POST OBJECT TYPE
-            NAME: http_post
-            SHORTCUT: post
-
-          DESCRIPTION
-            Perform an HTTP Post.
-
-          CHILDREN
-            uri - string - 'https://web.site/'
-              The URI for the HTTP Post.
-            body - container
-              Collection of parameters for the HTTP Post.
-            result - string - Optional parameter
-              The result of the request.  Whatever was returned in the body
-              of the HTTP POST.
-
-          MESSAGES
-            run - Run the HTTP Post sending the body data to the
-              endpoint specified in the URI.
-        TEXT
-      end
-
     end
   end
 end

data/lib/gloo/objs/web/json.rb

@@ -38,7 +38,7 @@ module Gloo
       # Initially only true for scripts.
       #
       def multiline_value?
-        return false
+        return true
       end
 
       #
@@ -56,7 +56,16 @@ module Gloo
       # Get a list of message names that this object receives.
       #
       def self.messages
-        return super + %w[get parse]
+        return super + %w[get parse pretty]
+      end
+
+      #
+      # Make the JSON pretty.
+      #
+      def msg_pretty
+        pretty = JSON.pretty_generate( self.value )
+        puts pretty
+        set_value pretty
       end
 
       #
@@ -121,35 +130,6 @@ module Gloo
         end
       end
 
-      # ---------------------------------------------------------------------
-      #    Help
-      # ---------------------------------------------------------------------
-
-      #
-      # Get help for this object type.
-      #
-      def self.help
-        return <<~TEXT
-          JSON OBJECT TYPE
-            NAME: json
-            SHORTCUT: json
-
-          DESCRIPTION
-            JSON data in a text string.
-
-          CHILDREN
-            None
-
-          MESSAGES
-            get - get a value from the JSON data
-              Example: tell myjson to get ("title")
-              The additional parameter is the path to the value.
-            parse - parse the JSON data and put values in the
-              object specified by the additional parameter
-              Example: tell myjson to parse ("path.to.objects")
-        TEXT
-      end
-
     end
   end
 end

data/lib/gloo/objs/web/slack.rb

@@ -81,16 +81,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_string URL, 'https://hooks.slack.com/services/...', self
@@ -111,7 +115,9 @@ module Gloo
         return super + [ 'run' ]
       end
 
-      # Post the content to the endpoint.
+      #
+      # Post the content to the Slack channel.
+      #
       def msg_run
         uri = uri_value
         return unless uri
@@ -119,39 +125,6 @@ module Gloo
         Gloo::Objs::HttpPost.post_json uri, body_as_json, true
       end
 
-      # ---------------------------------------------------------------------
-      #    Help
-      # ---------------------------------------------------------------------
-
-      #
-      # Get help for this object type.
-      #
-      def self.help
-        return <<~TEXT
-          SLACK OBJECT TYPE
-            NAME: slack
-            SHORTCUT: slack
-
-          DESCRIPTION
-            Send message to channel in Slack.
-
-          CHILDREN
-            uri - string - 'https://hooks.slack.com/services/...'
-              The URI with access to the Slack channel.
-            message - string - 'textual message'
-              Message to send to Slack.
-            username - string - 'Slack Bot'
-              Attribute the message to this user.
-            channel - string - 'general'
-              The name of the channel for the post.
-            icon_emoji - string - ':ghost:'
-              The emoji to use for the attribution.
-
-          MESSAGES
-            run - Post the message to Slack.
-        TEXT
-      end
-
     end
   end
 end

data/lib/gloo/objs/web/teams.rb

@@ -14,9 +14,11 @@ module Gloo
       KEYWORD = 'teams'.freeze
       KEYWORD_SHORT = 'team'.freeze
       URL = 'uri'.freeze
+      DEFAULT_URL = 'https://outlook.office.com/webhook/...'.freeze
       MSG = 'message'.freeze
       TITLE = 'title'.freeze
       COLOR = 'color'.freeze
+      DEFAULT_COLOR = '008000'.freeze
 
       #
       # The name of the object type.
@@ -67,34 +69,26 @@ 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 => URL,
-                      :type => 'string',
-                      :value => 'https://outlook.office.com/webhook/...',
-                      :parent => self } )
-        fac.create( { :name => TITLE,
-                      :type => 'string',
-                      :value => '',
-                      :parent => self } )
-        fac.create( { :name => COLOR,
-                      :type => 'color',
-                      :value => '008000',
-                      :parent => self } )
-        fac.create( { :name => MSG,
-                      :type => 'string',
-                      :value => '',
-                      :parent => self } )
+        fac.create_string URL, DEFAULT_URL, self
+        fac.create_string TITLE, '', self
+        fac.create_string COLOR, DEFAULT_COLOR, self
+        fac.create_string MSG, '', self
       end
 
       # ---------------------------------------------------------------------
@@ -108,7 +102,9 @@ module Gloo
         return super + [ 'run' ]
       end
 
-      # Post the content to the endpoint.
+      #
+      # Post the content to Microsoft Teams.
+      #
       def msg_run
         uri = uri_value
         return unless uri
@@ -116,37 +112,6 @@ module Gloo
         Gloo::Objs::HttpPost.post_json uri, body_as_json, true
       end
 
-      # ---------------------------------------------------------------------
-      #    Help
-      # ---------------------------------------------------------------------
-
-      #
-      # Get help for this object type.
-      #
-      def self.help
-        return <<~TEXT
-          TEAMS OBJECT TYPE
-            NAME: teams
-            SHORTCUT: team
-
-          DESCRIPTION
-            Send message to channel in Teams.
-
-          CHILDREN
-            uri - string - 'https://outlook.office.com/webhook/...'
-              The URI with access to the Teams channel.
-            title - string
-              Message title; header.
-            color - string - '008000'
-              Color theme for the message.
-            message - string
-              The message to post in Teams.
-
-          MESSAGES
-            run - Post the message to Teams.
-        TEXT
-      end
-
     end
   end
 end

data/lib/gloo/objs/web/uri.rb

@@ -126,35 +126,6 @@ module Gloo
         `#{cmd_with_param}`
       end
 
-      # ---------------------------------------------------------------------
-      #    Help
-      # ---------------------------------------------------------------------
-
-      #
-      # Get help for this object type.
-      #
-      def self.help
-        return <<~TEXT
-          URI OBJECT TYPE
-            NAME: uri
-            SHORTCUT: url
-
-          DESCRIPTION
-            A URI or URL.
-
-          CHILDREN
-            None
-
-          MESSAGES
-            open - open the URL in the default browser
-            get_scheme - get the URI scheme; example:  http
-            get_host - get the URI host; example:  google.com
-            get_path - get the URI resource path; example:  /post
-            get_query - get the URI query parameterse; example:  id=121
-            get_fragment - get the URI fragment
-        TEXT
-      end
-
     end
   end
 end

data/lib/gloo/persist/file_loader.rb

@@ -14,7 +14,9 @@ module Gloo
 
       attr_reader :obj
 
+      #
       # Set up a file storage for an object.
+      #
       def initialize( pn )
         @pn = pn
         @tabs = 0
@@ -67,8 +69,10 @@ module Gloo
         end
       end
 
+      #
       # Is this line a comment or a blank line?
       # If so we'll skip it.
+      #
       def skip_line?( line )
         line = line.strip
         return true if line.empty?
@@ -77,7 +81,9 @@ module Gloo
         return false
       end
 
+      #
       # Determine the relative indent level for the line.
+      #
       def determine_indent( line )
         tabs = tab_count( line )
         @indent = 0 # same level as prior line
@@ -93,7 +99,9 @@ module Gloo
         puts "tabs: #{@tabs}, indent: #{@indent}, line: #{line}" if @debug
       end
 
+      #
       # Process one line and add objects.
+      #
       def process_line( line )
         # reset multiline unless we're actually indented
         if @in_multiline && @multi_indent > @indent

data/lib/gloo/persist/file_saver.rb

@@ -8,7 +8,9 @@ module Gloo
   module Persist
     class FileSaver
 
+      #
       # Set up a file storage for an object.
+      #
       def initialize( pn, obj )
         @pn = pn
         @obj = obj
@@ -22,13 +24,17 @@ module Gloo
         File.write( @pn, data )
       end
 
+      #
       # Get string of tabs for indentation.
+      #
       def tabs( indent = 0 )
         return "\t" * indent
       end
 
+      #
       # Convert an object to textual representation.
       # This is a recursive function.
+      #
       def get_obj( obj, indent = 0 )
         t = tabs( indent )
         str = "#{t}#{obj.name} [#{obj.type_display}] : #{obj.value_display}\n"

data/lib/gloo/persist/file_storage.rb

@@ -10,7 +10,9 @@ module Gloo
 
       attr_reader :obj, :pn
 
+      #
       # Set up a file storage for an object.
+      #
       def initialize( pn, obj = nil )
         @obj = obj
         @pn = pn

data/lib/gloo/persist/line_splitter.rb

@@ -14,7 +14,9 @@ module Gloo
 
       attr_reader :obj
 
+      #
       # Set up a line splitter
+      #
       def initialize( line, tabs )
         @line = line
         @tabs = tabs

data/lib/gloo/persist/persist_man.rb

@@ -12,7 +12,9 @@ module Gloo
 
       attr_reader :maps
 
+      #
       # Contructor for the persistence manager.
+      #
       def initialize
         @maps = []
       end
@@ -96,13 +98,17 @@ module Gloo
         return true
       end
 
+      #
       # Get the default file extention.
+      #
       def file_ext
         return '.gloo'
       end
 
+      #
       # Print out all object - persistance mappings.
       # This is a debugging tool.
+      #
       def show_maps
         @maps.each do |o|
           puts " \t #{o.pn} \t #{o.obj.name}"