eac_ruby_utils 0.107.1 → 0.109.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eeb6daf99db3dddb24c607bd5e7dc957075ec1988015aa6871d5cc52df66e6cd
-  data.tar.gz: 0d7126d4dbd98c296fdfa13c7e398cba361540fc46ed6a491eb5461cf9791666
+  metadata.gz: f49997c361144d891925c3596cdc2ca37bcc485aa26aa287c4f7bfe529f3c553
+  data.tar.gz: 50f784d1c96e7432f5bcec9823899cb4407d1e2fe7465aee7bd605a6dfbfe6ea
 SHA512:
-  metadata.gz: 5dbbb58d1c41ea8e5cbbffcd01f5d7c2c51fc3abe83e615bcec30b3360e66ba24e8d7311b81b49a9d8ef3a43f3ae73e4396303efa84e6810fd4f9f615cd8b84f
-  data.tar.gz: 8a11abf8ab6d9c3c817b7df22ec6e2b3f449c371b595852e19ed12605b97ba1f4a8ffed449a0c122ec45c193980c3acf2245c9424e258c5b8f0d5347f51c822b
+  metadata.gz: 2cee869d6232e3b1b7027dc0a0927c9d3ae272e0177d4c90718ebaa279374b60cf42171006eae06df51a0c09967019ba7e9b175fd5635051ed196c4cc012bed8
+  data.tar.gz: fc6b4ed8fb837382ed816326d8930ce6fbb04a90fad68d5c48acf3516bd30f51eb4570ae04216129aa870627c8551500f480855a11981726e4dbb1ff05023cff

data/lib/eac_ruby_utils/envs/base_command/append_command_options.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+require 'shellwords'
+
+module EacRubyUtils
+  module Envs
+    module BaseCommand
+      class AppendCommandOptions
+        enable_method_class
+        common_constructor :command, :command_line, :options
+
+        def result
+          r = command_line
+          r = input.command + ' | ' + r if input
+          r = "cat #{Shellwords.escape(input_file)} | #{r}" if input_file
+          r += ' > ' + Shellwords.escape(output_file) if output_file
+          r
+        end
+
+        # @return [EacRubyUtils::Envs::Command, nil]
+        def input
+          options[:input]
+        end
+
+        # @return [Pathname,  nil]
+        def input_file
+          options[:input_file].if_present(&:to_pathname)
+        end
+
+        # @return [Pathname, nil]
+        def output_file
+          options[:output_file].if_present(&:to_pathname)
+        end
+      end
+    end
+  end
+end

data/lib/eac_ruby_utils/envs/base_command/concat.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/struct'
+
+module EacRubyUtils
+  module Envs
+    module BaseCommand
+      module Concat
+        AND_OPERATOR = '&&'
+        BEFORE_OPERATOR = ';'
+        OR_OPERATOR = '||'
+        PIPE_OPERATOR = '|'
+
+        # @param operator [Symbol]
+        # @return [EacRubyUtils::Envs::CompositeCommand]
+        def concat(operator, other_command)
+          require 'eac_ruby_utils/envs/composite_command'
+          ::EacRubyUtils::Envs::CompositeCommand.new(operator, self, other_command)
+        end
+
+        # @return [EacRubyUtils::Envs::Command]
+        def and(other_command)
+          concat(AND_OPERATOR, other_command)
+        end
+
+        # @return [EacRubyUtils::Envs::Command]
+        def before(other_command)
+          concat(BEFORE_OPERATOR, other_command)
+        end
+
+        def or(other_command)
+          concat(OR_OPERATOR, other_command)
+        end
+
+        def pipe(other_command)
+          concat(PIPE_OPERATOR, other_command)
+        end
+      end
+    end
+  end
+end

data/lib/eac_ruby_utils/envs/base_command/debugging.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module EacRubyUtils
+  module Envs
+    module BaseCommand
+      module Debugging
+        def debug?
+          ENV['DEBUG'].to_s.strip != ''
+        end
+
+        # Print a message if debugging is enabled.
+        def debug_print(message)
+          message = message.to_s
+          puts message.if_respond(:light_red, message) if debug?
+        end
+      end
+    end
+  end
+end

data/lib/eac_ruby_utils/envs/base_command/execution.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/envs/execution_error'
+require 'eac_ruby_utils/envs/execution_result'
+require 'eac_ruby_utils/envs/process'
+require 'eac_ruby_utils/envs/spawn'
+require 'pp'
+
+module EacRubyUtils
+  module Envs
+    module BaseCommand
+      module Execution
+        def execute!(options = {})
+          options[:exit_outputs] = status_results.merge(options[:exit_outputs].presence || {})
+          er = ::EacRubyUtils::Envs::ExecutionResult.new(execute(options), options)
+          return er.result if er.success?
+
+          raise ::EacRubyUtils::Envs::ExecutionError,
+                "execute! command failed: #{self}\n#{er.r.pretty_inspect}"
+        end
+
+        def execute(options = {})
+          c = command(options)
+          debug_print("BEFORE: #{c}")
+          t1 = Time.now
+          r = ::EacRubyUtils::Envs::Process.new(c).to_h
+          i = Time.now - t1
+          debug_print("AFTER [#{i}]: #{c}")
+          r
+        end
+
+        def spawn(options = {})
+          c = command(options)
+          debug_print("SPAWN: #{c}")
+          ::EacRubyUtils::Envs::Spawn.new(c)
+        end
+
+        def system!(options = {})
+          return if system(options)
+
+          raise ::EacRubyUtils::Envs::ExecutionError, "system! command failed: #{self}"
+        end
+
+        def system(options = {})
+          c = command(options)
+          debug_print(c)
+          Kernel.system(c)
+        end
+      end
+    end
+  end
+end

data/lib/eac_ruby_utils/envs/base_command/extra_options.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/hash/indifferent_access'
+require 'active_support/core_ext/object/blank'
+require 'shellwords'
+
+module EacRubyUtils
+  module Envs
+    module BaseCommand
+      module ExtraOptions
+        # @return [ActiveSupport::HashWithIndifferentAccess]
+        def extra_options
+          @extra_options ||= {}.with_indifferent_access
+        end
+
+        def status_result(status_code, result)
+          duplicate_by_extra_options(status_results: status_results.merge(status_code => result))
+        end
+
+        private
+
+        def status_results
+          extra_options[:status_results] ||= {}.with_indifferent_access
+        end
+      end
+    end
+  end
+end

data/lib/eac_ruby_utils/envs/base_command.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+require 'shellwords'
+
+module EacRubyUtils
+  module Envs
+    module BaseCommand
+      require_sub __FILE__
+
+      common_concern do
+        enable_abstract_methods
+        include ::EacRubyUtils::Envs::BaseCommand::Concat
+        include ::EacRubyUtils::Envs::BaseCommand::Debugging
+        include ::EacRubyUtils::Envs::BaseCommand::Execution
+        include ::EacRubyUtils::Envs::BaseCommand::ExtraOptions
+      end
+
+      # @return [EacRubyUtils::Envs::BaseEnv]
+      def env
+        raise_abstract_method __method__
+      end
+
+      def command(options = {})
+        append_command_options(
+          env.command_line(command_line_without_env),
+          options
+        )
+      end
+
+      # @return [String]
+      def command_line_without_env(_options = {})
+        raise_abstract_method __method__
+      end
+
+      private
+
+      def escape(arg)
+        arg = arg.to_s
+        m = /^\@ESC_(.+)$/.match(arg)
+        m ? m[1] : Shellwords.escape(arg)
+      end
+    end
+  end
+end

data/lib/eac_ruby_utils/envs/command/envvars.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require 'eac_ruby_utils/core_ext'
+require 'shellwords'
+
 module EacRubyUtils
   module Envs
     class Command

data/lib/eac_ruby_utils/envs/command/extra_options.rb

@@ -12,18 +12,8 @@ module EacRubyUtils
           duplicate_by_extra_options(chdir: dir)
         end
 
-        def status_result(status_code, result)
-          duplicate_by_extra_options(status_results: status_results.merge(status_code => result))
-        end
-
         private
 
-        attr_reader :extra_options
-
-        def status_results
-          extra_options[:status_results] ||= {}.with_indifferent_access
-        end
-
         def append_chdir(command)
           extra_options[:chdir].present? ? "(cd '#{extra_options[:chdir]}' ; #{command} )" : command
         end

data/lib/eac_ruby_utils/envs/command.rb

@@ -1,134 +1,66 @@
 # frozen_string_literal: true
 
 require 'eac_ruby_utils/core_ext'
-require 'eac_ruby_utils/envs/process'
-require 'eac_ruby_utils/envs/spawn'
-require 'pp'
-require 'shellwords'
+require 'eac_ruby_utils/envs/base_command'
 
 module EacRubyUtils
   module Envs
     class Command
-      require_sub __FILE__, include_modules: true
-
-      def initialize(env, command, extra_options = {})
-        @env = env
-        @extra_options = extra_options.with_indifferent_access
-        if command.count == 1 && command.first.is_a?(Array)
-          @command = command.first
-        elsif command.is_a?(Array)
-          @command = command
-        else
-          raise "Invalid argument command: #{command}|#{command.class}"
+      require_sub __FILE__, include_modules: true, require_dependency: true
+      include ::EacRubyUtils::Envs::BaseCommand
+
+      class << self
+        # @param command [Array]
+        # @return [Array]
+        def sanitize_initialize_arguments(arguments)
+          if arguments.count == 1 && arguments.first.is_a?(Array)
+            arguments.first
+          elsif arguments.is_a?(Array)
+            arguments
+          else
+            raise "Invalid argument command: #{arguments}|#{arguments.class}"
+          end
         end
       end
 
-      def args
-        @command
+      common_constructor :env, :args, :extra_options, default: [{}] do
+        self.extra_options = extra_options.with_indifferent_access
+        self.args = self.class.sanitize_initialize_arguments(args)
       end
 
       def append(args)
-        duplicate_by_command(@command + args)
+        duplicate_by_command(self.args + args)
       end
 
       def prepend(args)
-        duplicate_by_command(args + @command)
+        duplicate_by_command(args + self.args)
       end
 
       def to_s
-        "#{@command} [ENV: #{@env}]"
+        "#{args} [ENV: #{env}]"
       end
 
-      def command(options = {})
-        c = @command
+      # @return [String]
+      def command_line_without_env
+        c = args
         c = c.map { |x| escape(x) }.join(' ') if c.is_a?(Enumerable)
-        append_command_options(
-          @env.command_line(
-            append_chdir(append_concat(append_envvars(c)))
-          ),
-          options
-        )
-      end
-
-      def execute!(options = {})
-        options[:exit_outputs] = status_results.merge(options[:exit_outputs].presence || {})
-        er = ExecuteResult.new(execute(options), options)
-        return er.result if er.success?
-
-        raise ::EacRubyUtils::Envs::Command::ExecError,
-              "execute! command failed: #{self}\n#{er.r.pretty_inspect}"
-      end
-
-      def execute(options = {})
-        c = command(options)
-        debug_print("BEFORE: #{c}")
-        t1 = Time.now
-        r = ::EacRubyUtils::Envs::Process.new(c).to_h
-        i = Time.now - t1
-        debug_print("AFTER [#{i}]: #{c}")
-        r
-      end
-
-      def spawn(options = {})
-        c = command(options)
-        debug_print("SPAWN: #{c}")
-        ::EacRubyUtils::Envs::Spawn.new(c)
-      end
-
-      def system!(options = {})
-        return if system(options)
-
-        raise ::EacRubyUtils::Envs::Command::ExecError, "system! command failed: #{self}"
-      end
-
-      def system(options = {})
-        c = command(options)
-        debug_print(c)
-        Kernel.system(c)
+        append_chdir(append_envvars(c))
       end
 
       protected
 
       def duplicate(command, extra_options)
-        self.class.new(@env, command, extra_options)
+        self.class.new(env, command, extra_options)
       end
 
       private
 
-      attr_reader :extra_options
-
       def duplicate_by_command(new_command)
-        duplicate(new_command, @extra_options)
+        duplicate(new_command, extra_options)
       end
 
       def duplicate_by_extra_options(set_extra_options)
-        duplicate(@command, @extra_options.merge(set_extra_options))
-      end
-
-      def debug?
-        ENV['DEBUG'].to_s.strip != ''
-      end
-
-      # Print a message if debugging is enabled.
-      def debug_print(message)
-        message = message.to_s
-        puts message.if_respond(:light_red, message) if debug?
-      end
-
-      def append_command_options(command, options)
-        command = options[:input].command + ' | ' + command if options[:input]
-        if options[:input_file]
-          command = "cat #{Shellwords.escape(options[:input_file])}" \
-            " | #{command}"
-        end
-        command += ' > ' + Shellwords.escape(options[:output_file]) if options[:output_file]
-        command
-      end
-
-      def escape(arg)
-        arg = arg.to_s
-        m = /^\@ESC_(.+)$/.match(arg)
-        m ? m[1] : Shellwords.escape(arg)
+        duplicate(args, extra_options.merge(set_extra_options))
       end
     end
   end

data/lib/eac_ruby_utils/envs/composite_command.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+require 'eac_ruby_utils/envs/base_command'
+
+module EacRubyUtils
+  module Envs
+    class CompositeCommand
+      include ::EacRubyUtils::Envs::BaseCommand
+
+      enable_listable
+      lists.add_string :operator, '&&' => :and, ';' => :before, '||' => :or, '|' => :pipe
+
+      common_constructor :operator, :left_command, :right_command do
+        self.operator = self.class.lists.operator.value_validate!(operator.to_s)
+      end
+
+      # @return [EacRubyUtils::Envs::BaseEnv]
+      delegate :env, to: :left_command
+
+      # @return [String]
+      def command_line_without_env(_options = {})
+        ::Shellwords.join(['bash', '-c', bash_command])
+      end
+
+      # @return [String]
+      def bash_command
+        ['set', '-euo', 'pipefail', OPERATOR_BEFORE, left_command.command, operator,
+         right_command.command].join(' ')
+      end
+    end
+  end
+end

data/lib/eac_ruby_utils/envs/{command/exec_error.rb → execution_error.rb}

@@ -2,9 +2,7 @@
 
 module EacRubyUtils
   module Envs
-    class Command
-      class ExecError < ::RuntimeError
-      end
+    class ExecutionError < ::RuntimeError
     end
   end
 end

data/lib/eac_ruby_utils/envs/execution_result.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/envs/execution_error'
+
+module EacRubyUtils
+  module Envs
+    class ExecutionResult
+      attr_reader :r, :options
+
+      def initialize(result, options)
+        @r = result
+        @options = options
+      end
+
+      def result
+        return exit_code_zero_result if exit_code_zero?
+        return expected_error_result if expected_error?
+
+        raise ::EacRubyUtils::Envs::ExecutionError, 'Failed!'
+      end
+
+      def success?
+        exit_code_zero? || expected_error?
+      end
+
+      private
+
+      def exit_code_zero?
+        r[:exit_code]&.zero?
+      end
+
+      def exit_code_zero_result
+        r[options[:output] || :stdout]
+      end
+
+      def expected_error_result
+        options[:exit_outputs][r[:exit_code]]
+      end
+
+      def expected_error?
+        options[:exit_outputs].is_a?(Hash) && options[:exit_outputs].key?(r[:exit_code])
+      end
+    end
+  end
+end

data/lib/eac_ruby_utils/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module EacRubyUtils
-  VERSION = '0.107.1'
+  VERSION = '0.109.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eac_ruby_utils
 version: !ruby/object:Gem::Version
-  version: 0.107.1
+  version: 0.109.0
 platform: ruby
 authors:
 - Esquilo Azul Company
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-11-07 00:00:00.000000000 Z
+date: 2022-11-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -139,14 +139,20 @@ files:
 - lib/eac_ruby_utils/custom_format.rb
 - lib/eac_ruby_utils/enum.rb
 - lib/eac_ruby_utils/envs.rb
+- lib/eac_ruby_utils/envs/base_command.rb
+- lib/eac_ruby_utils/envs/base_command/append_command_options.rb
+- lib/eac_ruby_utils/envs/base_command/concat.rb
+- lib/eac_ruby_utils/envs/base_command/debugging.rb
+- lib/eac_ruby_utils/envs/base_command/execution.rb
+- lib/eac_ruby_utils/envs/base_command/extra_options.rb
 - lib/eac_ruby_utils/envs/base_env.rb
 - lib/eac_ruby_utils/envs/command.rb
-- lib/eac_ruby_utils/envs/command/concat.rb
 - lib/eac_ruby_utils/envs/command/envvars.rb
-- lib/eac_ruby_utils/envs/command/exec_error.rb
-- lib/eac_ruby_utils/envs/command/execute_result.rb
 - lib/eac_ruby_utils/envs/command/extra_options.rb
+- lib/eac_ruby_utils/envs/composite_command.rb
 - lib/eac_ruby_utils/envs/executable.rb
+- lib/eac_ruby_utils/envs/execution_error.rb
+- lib/eac_ruby_utils/envs/execution_result.rb
 - lib/eac_ruby_utils/envs/file.rb
 - lib/eac_ruby_utils/envs/local_env.rb
 - lib/eac_ruby_utils/envs/process.rb

data/lib/eac_ruby_utils/envs/command/concat.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-require 'eac_ruby_utils/struct'
-
-module EacRubyUtils
-  module Envs
-    class Command
-      module Concat
-        def concat(operator, other_command)
-          duplicate_by_extra_options(concat: ::EacRubyUtils::Struct.new(
-            operator: operator, command: other_command
-          ))
-        end
-
-        def or(other_command)
-          concat('||', other_command)
-        end
-
-        def pipe(other_command)
-          concat('|', other_command)
-        end
-
-        private
-
-        def append_concat(command)
-          extra_options[:concat].if_present(command) do |v|
-            "#{command} #{v.operator} #{v.command.command}"
-          end
-        end
-      end
-    end
-  end
-end

data/lib/eac_ruby_utils/envs/command/execute_result.rb

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-require 'eac_ruby_utils/envs/command/exec_error'
-
-module EacRubyUtils
-  module Envs
-    class Command
-      class ExecuteResult
-        attr_reader :r, :options
-
-        def initialize(result, options)
-          @r = result
-          @options = options
-        end
-
-        def result
-          return exit_code_zero_result if exit_code_zero?
-          return expected_error_result if expected_error?
-
-          raise ::EacRubyUtils::Envs::Command::ExecError, 'Failed!'
-        end
-
-        def success?
-          exit_code_zero? || expected_error?
-        end
-
-        private
-
-        def exit_code_zero?
-          r[:exit_code]&.zero?
-        end
-
-        def exit_code_zero_result
-          r[options[:output] || :stdout]
-        end
-
-        def expected_error_result
-          options[:exit_outputs][r[:exit_code]]
-        end
-
-        def expected_error?
-          options[:exit_outputs].is_a?(Hash) && options[:exit_outputs].key?(r[:exit_code])
-        end
-      end
-    end
-  end
-end