gloo 0.3.0 → 0.4.0

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

@@ -12,50 +12,45 @@
 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
+      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
+        o.send_message( 'run' ) if o.can_receive_message? 'run'
       end
 
-      
-
       # ---------------------------------------------------------------------
       #    Children
       # ---------------------------------------------------------------------
@@ -66,29 +61,37 @@ 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( { :name => 'word',
+                      :type => 'string',
+                      :value => '',
+                      :parent => self } )
+        fac.create( { :name => 'in',
+                      :type => 'string',
+                      :value => '',
+                      :parent => self } )
+        fac.create( { :name => 'do',
+                      :type => 'script',
+                      :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
         if each_word?
@@ -99,8 +102,7 @@ module Gloo
           run_each_repo
         end
       end
-      
-      
+
       # ---------------------------------------------------------------------
       #    Word
       # ---------------------------------------------------------------------
@@ -109,28 +111,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 +143,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.split( '\n' ).each 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 +175,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 +192,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 +202,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
+            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

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

@@ -7,106 +7,140 @@
 module Gloo
   module Objs
     class Git < Gloo::Core::Obj
-      
-      KEYWORD = 'git_repo'
-      KEYWORD_SHORT = 'git'
 
-      # 
+      KEYWORD = 'git_repo'.freeze
+      KEYWORD_SHORT = 'git'.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 path to the git repo (locally).
-      # 
-      def get_path
+      #
+      def path_value
         return value
       end
 
-      
       # ---------------------------------------------------------------------
       #    Messages
       # ---------------------------------------------------------------------
 
-      # 
+      #
       # Get a list of message names that this object receives.
-      # 
+      #
       def self.messages
-        return super + [ "validate", "check_changes", "get_changes",
-				 	"commit", "get_branch" ]
+        return super + %w[validate check_changes get_changes commit get_branch]
       end
-			
-			# Get the current working branch.
-			def msg_get_branch
-				branch = ""
-				path = get_path
-				if path and File.directory?( path )
-					branch = `cd #{path}; git rev-parse --abbrev-ref HEAD`
-					branch = branch.strip
-				end
 
-				$engine.heap.it.set_to branch        
-			end
+      # Get the current working branch.
+      def msg_get_branch
+        branch = ''
+        path = path_value
+        if path_is_dir?( path )
+          branch = `cd #{path}; git rev-parse --abbrev-ref HEAD`
+          branch = branch.strip
+        end
 
+        $engine.heap.it.set_to branch
+      end
 
-			# Check to see if the repo has changes.
+      # Commit pending changes.
       def msg_commit
-				msg = "Commit"
-        path = get_path
-        if path && File.directory?( path )
-					if @params && @params.token_count > 0
-						expr = Gloo::Expr::Expression.new( @params.tokens )
-						msg = expr.evaluate
-	        end
-					branch = `cd #{path}; git rev-parse --abbrev-ref HEAD`
-					branch = branch.strip
-					result = `cd #{path}; git add .; git commit -m "#{msg}";git push origin #{branch}`
-				end
-				$engine.heap.it.set_to msg
+        msg = 'Commit'
+        path = path_value
+        if path_is_dir?( path )
+          if @params&.token_count&.positive?
+            expr = Gloo::Expr::Expression.new( @params.tokens )
+            msg = expr.evaluate
+          end
+          branch = `cd #{path}; git rev-parse --abbrev-ref HEAD`
+          branch = branch.strip
+          add = 'git add .'
+          cmt = 'git commit -m '
+          psh = 'git push origin '
+          `cd #{path};#{add};#{cmt}"#{msg}";#{psh}#{branch}`
+        end
+        $engine.heap.it.set_to msg
       end
 
-			# Check to see if the repo has changes.
+      # Get the pending changes.
       def msg_get_changes
-        path = get_path
-        if path and File.directory?( path )
-					result = `cd #{path}; git status -s`
-				end
-				result = result ? result : ""
-				$engine.heap.it.set_to result        
+        path = path_value
+        result = `cd #{path}; git status -s` if path_is_dir?( path )
+        result ||= ''
+        $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.
+      # Check to see if the repo has changes.
       def msg_check_changes
-				result = false
-        path = get_path
-        if path and File.directory?( path )
-					data = `cd #{path}; git status -s`
-				  result = true unless ( data.strip.length == 0 )
-				end
-
-				$engine.heap.it.set_to result        
+        result = false
+        path = path_value
+        if path_is_dir?( path )
+          data = `cd #{path}; git status -s`
+          result = true unless data.strip.empty?
+        end
+
+        $engine.heap.it.set_to result
       end
-      
+
       # Check to make sure this is a valide git repo.
       def msg_validate
-				result = false
-        path = get_path
-        if path and File.directory?( path )
-					result = File.exists? File.join( path, '.git' )
-				end
+        result = false
+        path = path_value
+        if path_is_dir?( path )
+          pn = File.join( path, '.git' )
+          result = File.exist? pn
+        end
+
+        $engine.heap.it.set_to result
+      end
+
+      # ---------------------------------------------------------------------
+      #    Help
+      # ---------------------------------------------------------------------
 
-				$engine.heap.it.set_to result        
+      #
+      # 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