eac_ruby_utils 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4129bee0e89112a9f51bbc007eaafe34ef061917568a27f25b7c92cb91a80e9
-  data.tar.gz: f57abb8130a5de7c77087912fe417cc93cc4ff83ec3db6fa3bfeba9f889c2791
+  metadata.gz: 11c321836d0bd034a1ebd2c4835cbd97bcb423edf7a96c362a18259c2eeb698f
+  data.tar.gz: 4601661dd0057f7e2bd1dbe7b5adae2463f8419370848dd33bf48b2f8ab55860
 SHA512:
-  metadata.gz: 7d867c393e6c63584767a81deabbf8f3752d70cc03970383f20e9f1f3afc4aa26fad71d91c535670bb5a73d9cf7b0c392a176eb2c4201640c47217499150d151
-  data.tar.gz: fc385e0f681284d55edb35a33a2fa4b474b3112de67504102219106648ae8bd46e1acc653f9a834ab1eda492f4bdf72355331270256592fac2f32e95a035b4ed
+  metadata.gz: 0eeb4ee5d8f011a9a4607dbb94932092969465a1b530e8712df7b955b553d0d465dfbeb8427a5820e6262609be3f30b2f38f8850579839f4d0b7c3126e9f2979
+  data.tar.gz: 79e0b183401615aeb3f16d92c4b3505eca0d6569f8fa5b6eeabbe6d7e5853cab7cdad24eac03401e6083cf8d8c2cb7693df6c196e42f554f158de8facfb2cbcf

data/lib/eac_ruby_utils.rb

@@ -1,20 +1,12 @@
 # frozen_string_literal: true
 
-require 'colorize'
-require 'docopt'
-require 'open3'
-require 'pp'
-require 'net/ssh'
-
 module EacRubyUtils
-  require 'eac_ruby_utils/options_consumer'
-  require 'eac_ruby_utils/console/docopt_runner'
-  require 'eac_ruby_utils/console/speaker'
+  require 'eac_ruby_utils/arguments_consumer'
+  require 'eac_ruby_utils/console'
+  require 'eac_ruby_utils/contextualizable'
   require 'eac_ruby_utils/envs'
-  require 'eac_ruby_utils/envs/base_env'
-  require 'eac_ruby_utils/envs/command'
-  require 'eac_ruby_utils/envs/local_env'
-  require 'eac_ruby_utils/envs/process'
-  require 'eac_ruby_utils/envs/ssh_env'
+  require 'eac_ruby_utils/options_consumer'
+  require 'eac_ruby_utils/patches'
+  require 'eac_ruby_utils/simple_cache'
   require 'eac_ruby_utils/yaml'
 end

data/lib/eac_ruby_utils/arguments_consumer.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require 'active_support/hash_with_indifferent_access'
+require 'ostruct'
+
+module EacRubyUtils
+  class ArgumentsConsumer
+    class << self
+      def parse(args, positional = [], options = {})
+        new(args, positional, options).data
+      end
+    end
+
+    attr_reader :positional, :default_options
+
+    def initialize(positional, default_options)
+      @positional = positional.dup.freeze
+      @default_options = default_options.dup.freeze
+    end
+
+    def parse(args)
+      Parser.new(self, args).data
+    end
+
+    def initialize2(args, positional, _default_options)
+      @positional = positional.dup
+      @positional.freeze
+      @args = args
+
+      @options_found = false
+    end
+
+    class Parser
+      attr_reader :data, :arguments_consumer
+
+      def initialize(arguments_consumer, args)
+        @arguments_consumer = arguments_consumer
+        @data = ::ActiveSupport::HashWithIndifferentAccess.new
+        @options_found = false
+        arguments_consumer.positional.each { |key| data[key] = nil }
+        data.merge!(arguments_consumer.default_options)
+        args.each_with_index { |value, index| add_arg(value, index) }
+        data.freeze
+      end
+
+      private
+
+      def add_arg(value, index)
+        arg = ::OpenStruct.new(value: value, index: index)
+        if arg.value.is_a?(::Hash)
+          add_hash_arg(arg)
+        else
+          add_positional_arg(arg)
+        end
+      end
+
+      def add_hash_arg(arg)
+        check_no_more_arguments(arg)
+        data.merge!(arg.value)
+        @options_found = true
+      end
+
+      def add_positional_arg(arg)
+        check_no_more_arguments(arg)
+        invalid_argument arg, 'No more valid positional' if
+          arg.index >= arguments_consumer.positional.count
+        data[arguments_consumer.positional[arg.index]] = arg.value
+      end
+
+      def check_no_more_arguments(arg)
+        return unless @options_found
+        invalid_argument arg, 'Hash already found - no more positional allowed'
+      end
+
+      def invalid_argument(arg, message)
+        raise InvalidArgumentError, self, arg, message
+      end
+    end
+
+    class InvalidArgumentError < StandardError
+      def initialize(args_consumer, arg, message)
+        @args_consumer = args_consumer
+        @arg = arg
+        super "#{message} (Arg: #{arg}, Args Consumer: #{args_consumer})"
+      end
+    end
+  end
+end

data/lib/eac_ruby_utils/console.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/console/docopt_runner'
+require 'eac_ruby_utils/console/speaker'

data/lib/eac_ruby_utils/console/docopt_runner.rb

@@ -1,25 +1,38 @@
 # frozen_string_literal: true
 
+require 'active_support/core_ext/hash/indifferent_access'
+require 'active_support/core_ext/hash/slice'
+require 'docopt'
+require 'eac_ruby_utils/contextualizable'
+require 'eac_ruby_utils/patches/hash/sym_keys_hash'
+Dir["#{__dir__}/#{::File.basename(__FILE__, '.*')}/_*.rb"].each do |partial|
+  require partial
+end
+
 module EacRubyUtils
   module Console
     class DocoptRunner
-      attr_reader :options
+      include ::EacRubyUtils::Contextualizable
+
+      attr_reader :settings
 
-      def initialize
-        @options = Docopt.docopt(doc)
-        run
-      rescue Docopt::Exit => e
-        puts e.message
+      def initialize(settings = {})
+        @settings = settings.with_indifferent_access.freeze
+        check_subcommands
       end
 
-      private
+      def options
+        @options ||= Docopt.docopt(target_doc, docopt_options)
+      end
 
-      def doc
-        self.class.const_get('DOC').gsub('__PROGRAM__', program)
+      def parent
+        settings[:parent]
       end
 
-      def program
-        ENV['MYSELF_PROGRAM'] || $PROGRAM_NAME
+      protected
+
+      def docopt_options
+        settings.slice(:version, :argv, :help, :options_first).to_sym_keys_hash
       end
     end
   end

data/lib/eac_ruby_utils/console/docopt_runner/_class_methods.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module EacRubyUtils
+  module Console
+    class DocoptRunner
+      DOCOPT_ERROR_EXIT_CODE = 0x22220000
+
+      class << self
+        def run(options = {})
+          new(options).send(:run)
+        rescue Docopt::Exit => e
+          STDERR.write(e.message + "\n")
+          ::Kernel.exit(DOCOPT_ERROR_EXIT_CODE)
+        end
+      end
+    end
+  end
+end

data/lib/eac_ruby_utils/console/docopt_runner/_doc.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module EacRubyUtils
+  module Console
+    class DocoptRunner
+      PROGRAM_MACRO = '__PROGRAM__'
+
+      def source_doc
+        setting_value(:doc)
+      end
+
+      def target_doc
+        source_doc.gsub(PROGRAM_MACRO, program_name).strip + "\n"
+      end
+
+      def program_name
+        setting_value(:program_name, false) || ENV['PROGRAM_NAME'] || $PROGRAM_NAME
+      end
+    end
+  end
+end

data/lib/eac_ruby_utils/console/docopt_runner/_settings.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module EacRubyUtils
+  module Console
+    class DocoptRunner
+      attr_reader :settings
+
+      private
+
+      def setting_value(key, required = true)
+        %i[setting_from_argument setting_from_constant].each do |method|
+          value = send(method, key)
+          return value if value
+        end
+        return nil unless required
+        raise "Setting \"#{key}\" not found. Declare #{setting_constant(key, true)} constant, " \
+          "pass #{key.to_sym} option to #{self.class.name}.new() method."
+      end
+
+      def setting_from_argument(key)
+        settings[key]
+      end
+
+      def setting_from_constant(key)
+        constant_name = setting_constant(key)
+        begin
+          self.class.const_get(constant_name)
+        rescue NameError
+          nil
+        end
+      end
+
+      def setting_constant(key, _fullname = false)
+        name = key.to_s.underscore.upcase
+        name = "#{self.class.name}::#{name}"
+        name
+      end
+    end
+  end
+end

data/lib/eac_ruby_utils/console/docopt_runner/_subcommands.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/string/inflections'
+require 'shellwords'
+
+module EacRubyUtils
+  module Console
+    class DocoptRunner
+      SUBCOMMAND_ARG = '<subcommand>'
+      SUBCOMMAND_ARGS_ARG = '<subcommand-args>'
+      SUBCOMMANDS_MACRO = '__SUBCOMMANDS__'
+
+      def subcommands?
+        source_doc.include?(SUBCOMMANDS_MACRO)
+      end
+
+      def check_subcommands
+        return unless subcommands?
+        singleton_class.include(SubcommandsSupport)
+        check_subcommands_arg
+        return if singleton_class.method_defined?(:run)
+        singleton_class.send(:alias_method, :run, :run_with_subcommand)
+      end
+
+      module SubcommandsSupport
+        def check_subcommands_arg
+          if subcommand_arg_as_list?
+            singleton_class.include(SubcommandsSupport::SubcommandArgAsList)
+          else
+            singleton_class.include(SubcommandsSupport::SubcommandArgAsArg)
+          end
+        end
+
+        def run_with_subcommand
+          if options.fetch(SUBCOMMAND_ARG)
+            check_valid_subcommand
+            subcommand.run
+          else
+            run_without_subcommand
+          end
+        end
+
+        def subcommand
+          @subcommand ||= subcommand_class_name(subcommand_name).constantize.new(
+            argv: subcommand_args,
+            program_name: subcommand_program,
+            parent: self
+          )
+        end
+
+        def target_doc
+          super.gsub(SUBCOMMANDS_MACRO,
+                     "#{target_doc_subcommand_arg} [#{SUBCOMMAND_ARGS_ARG}...]") +
+            "\n" + subcommands_target_doc
+        end
+
+        def docopt_options
+          super.merge(options_first: true)
+        end
+
+        def subcommand_class_name(subcommand)
+          "#{self.class.name}::#{subcommand.underscore.camelize}"
+        end
+
+        def subcommand_arg_as_list?
+          setting_value(:subcommand_arg_as_list, false) || false
+        end
+
+        def subcommand_args
+          options.fetch(SUBCOMMAND_ARGS_ARG)
+        end
+
+        def subcommand_program
+          subcommand_name
+        end
+
+        def subcommand_name
+          options.fetch(SUBCOMMAND_ARG)
+        end
+
+        def available_subcommands
+          (setting_value(:subcommands, false) || auto_available_subcommands).sort
+        end
+
+        def auto_available_subcommands
+          self.class.constants
+              .map { |name| self.class.const_get(name) }
+              .select { |c| c.instance_of? Class }
+              .select { |c| c < ::EacRubyUtils::Console::DocoptRunner }
+              .map { |c| c.name.demodulize.underscore.dasherize }
+        end
+
+        def run_without_subcommand
+          "Method #{__method__} should be overrided in #{self.class.name}"
+        end
+
+        protected
+
+        def check_valid_subcommand
+          return if available_subcommands.include?(subcommand_name)
+          raise ::Docopt::Exit, "\"#{subcommand_name}\" is not a valid subcommand" \
+            " (Valid: #{available_subcommands.join(', ')})"
+        end
+
+        module SubcommandArgAsArg
+          def target_doc_subcommand_arg
+            SUBCOMMAND_ARG
+          end
+
+          def subcommand_name
+            options.fetch(SUBCOMMAND_ARG)
+          end
+
+          def subcommands_target_doc
+            available_subcommands.inject("Subcommands:\n") do |a, e|
+              a + "  #{e}\n"
+            end
+          end
+        end
+
+        module SubcommandArgAsList
+          def target_doc_subcommand_arg
+            '(' + available_subcommands.join('|') + ')'
+          end
+
+          def subcommand_name
+            available_subcommands.each do |subcommand|
+              return subcommand if options.fetch(subcommand)
+            end
+            nil
+          end
+
+          def subcommands_target_doc
+            "\n"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/eac_ruby_utils/console/speaker.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'colorize'
+
 module EacRubyUtils
   module Console
     # https://github.com/fazibear/colorize

data/lib/eac_ruby_utils/contextualizable.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module EacRubyUtils
+  # Provides the method context which search and call a method in self and ancestor objects.
+  module Contextualizable
+    def context(method)
+      current = self
+      while current
+        return current.send(method) if current.respond_to?(method)
+        current = current.respond_to?(:parent) ? current.parent : nil
+      end
+      raise "Context method \"#{method}\" not found for #{self.class}"
+    end
+  end
+end

data/lib/eac_ruby_utils/envs.rb

@@ -1,5 +1,11 @@
 # frozen_string_literal: true
 
+require 'eac_ruby_utils/envs/base_env'
+require 'eac_ruby_utils/envs/command'
+require 'eac_ruby_utils/envs/local_env'
+require 'eac_ruby_utils/envs/process'
+require 'eac_ruby_utils/envs/ssh_env'
+
 module EacRubyUtils
   module Envs
     class << self

data/lib/eac_ruby_utils/envs/base_env.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'eac_ruby_utils/envs/command'
+
 module EacRubyUtils
   module Envs
     class BaseEnv

data/lib/eac_ruby_utils/envs/command.rb

@@ -1,6 +1,11 @@
 # frozen_string_literal: true
 
-require_relative 'command/extra_options'
+require 'active_support/core_ext/hash/indifferent_access'
+require 'eac_ruby_utils/console/speaker'
+require 'eac_ruby_utils/envs/command/extra_options'
+require 'eac_ruby_utils/envs/process'
+require 'pp'
+require 'shellwords'
 
 module EacRubyUtils
   module Envs

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

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

data/lib/eac_ruby_utils/envs/local_env.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'eac_ruby_utils/envs/base_env'
+
 module EacRubyUtils
   module Envs
     class LocalEnv < ::EacRubyUtils::Envs::BaseEnv

data/lib/eac_ruby_utils/envs/process.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'open3'
+
 module EacRubyUtils
   module Envs
     class Process

data/lib/eac_ruby_utils/envs/ssh_env.rb

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
+require 'addressable'
+require 'eac_ruby_utils/envs/base_env'
+require 'net/ssh'
+require 'shellwords'
+
 module EacRubyUtils
   module Envs
     class SshEnv < ::EacRubyUtils::Envs::BaseEnv

data/lib/eac_ruby_utils/options_consumer.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'active_support/core_ext/hash/indifferent_access'
+
 module EacRubyUtils
   class OptionsConsumer
     def initialize(data)

data/lib/eac_ruby_utils/patches.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+Dir["#{File.dirname(__FILE__)}/#{::File.basename(__FILE__, '.*')}/*.rb"].each do |path|
+  require path
+end

data/lib/eac_ruby_utils/patches/hash.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+Dir["#{File.dirname(__FILE__)}/#{::File.basename(__FILE__, '.*')}/*.rb"].each do |path|
+  require path
+end

data/lib/eac_ruby_utils/patches/hash/options_consumer.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/options_consumer'
+
+class Hash
+  # Returns an <tt>EacRubyUtils::OptionsConsumer</tt> out of its receiver.
+  def to_options_consumer
+    ::EacRubyUtils::OptionsConsumer.new(self)
+  end
+end

data/lib/eac_ruby_utils/patches/hash/sym_keys_hash.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+class Hash
+  def to_sym_keys_hash
+    each_with_object({}) do |(key, value), memo|
+      symbol_key = key.respond_to?(:to_sym) ? key.to_sym : key.to_s.to_sym
+      memo[symbol_key] = value
+    end
+  end
+end

data/lib/eac_ruby_utils/simple_cache.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module EacRubyUtils
+  module SimpleCache
+    UNCACHED_METHOD_PATTERN = /\A(\s+)_uncached\z/
+
+    def method_missing(method, *args, &block)
+      uncached_method = "#{method}_uncached"
+      if respond_to?(uncached_method, true)
+        call_method_with_cache(uncached_method, args, &block)
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(method, include_all = false)
+      if method.to_s.end_with?('_uncached')
+        super
+      else
+        respond_to?("#{method}_uncached", true) || super
+      end
+    end
+
+    def reset_cache
+      @cache_keys = nil
+    end
+
+    private
+
+    def call_method_with_cache(method, args, &block)
+      raise 'Não é possível realizar o cache de métodos com bloco' if block
+      key = ([method] + args).join('@@@')
+      cache_keys[key] = send(method, *args) unless cache_keys.key?(key)
+      cache_keys[key]
+    end
+
+    def cache_keys
+      @cache_keys ||= {}
+    end
+  end
+end

data/lib/eac_ruby_utils/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eac_ruby_utils
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Esquilo Azul Company
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-04 00:00:00.000000000 Z
+date: 2019-07-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
 - !ruby/object:Gem::Dependency
   name: colorize
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
 description: 
 email: 
 executables: []
@@ -74,8 +102,15 @@ extra_rdoc_files: []
 files:
 - README.rdoc
 - lib/eac_ruby_utils.rb
+- lib/eac_ruby_utils/arguments_consumer.rb
+- lib/eac_ruby_utils/console.rb
 - lib/eac_ruby_utils/console/docopt_runner.rb
+- lib/eac_ruby_utils/console/docopt_runner/_class_methods.rb
+- lib/eac_ruby_utils/console/docopt_runner/_doc.rb
+- lib/eac_ruby_utils/console/docopt_runner/_settings.rb
+- lib/eac_ruby_utils/console/docopt_runner/_subcommands.rb
 - lib/eac_ruby_utils/console/speaker.rb
+- lib/eac_ruby_utils/contextualizable.rb
 - lib/eac_ruby_utils/envs.rb
 - lib/eac_ruby_utils/envs/base_env.rb
 - lib/eac_ruby_utils/envs/command.rb
@@ -84,6 +119,11 @@ files:
 - lib/eac_ruby_utils/envs/process.rb
 - lib/eac_ruby_utils/envs/ssh_env.rb
 - lib/eac_ruby_utils/options_consumer.rb
+- lib/eac_ruby_utils/patches.rb
+- lib/eac_ruby_utils/patches/hash.rb
+- lib/eac_ruby_utils/patches/hash/options_consumer.rb
+- lib/eac_ruby_utils/patches/hash/sym_keys_hash.rb
+- lib/eac_ruby_utils/simple_cache.rb
 - lib/eac_ruby_utils/version.rb
 - lib/eac_ruby_utils/yaml.rb
 homepage: