eac_ruby_utils 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b885c805971bcee518de5de56939c08616539d6855742c69e20f70dfd787c552
-  data.tar.gz: 6abd9b7bce1bd9eac4efee4966ffc4b177dea1ddc88e82e613125b79587a68c4
+  metadata.gz: e4e9aaa9db1ea584a76fe7fb476973764399a6fd7d4ffb483b63c40a8c89100d
+  data.tar.gz: 5590733b0bacc61fe6cf2b76ce8f2a5e91bcf219218fcb01ed776b9023d10d88
 SHA512:
-  metadata.gz: b4600e778c91f1a038fe457e1afb61ac8a7aba5b23e8c77c166afe8b922c872cecffaa8850f6863eb5e11497fd45c84fcc287df4977e9dd0ddfe3e5dffb6a578
-  data.tar.gz: 1288c11637181bc9fd90cab0be1f9fcefcb9a16562d710676bdb022534835af5e200543df5af7d56f17e636b83f05758cd40d237eb5bf80b8e4f5833d652caec
+  metadata.gz: 24104d0f916e17006d40da24b98852c1277f3311782db63f90c0cf4cb50cad5baea4994734a519b6ce685f03d0961ad86579d47d28ed49d1311e4711ad02d6cb
+  data.tar.gz: d5be47cc44aaa1927ca3c09760cbc3b1faf113c4b740c228c5ef056810c5fbde6992e91f9f23224855780d361b91850d316f9de60a7782ac40c5086f47b7775a

data/lib/eac_ruby_utils.rb

@@ -7,12 +7,14 @@ module EacRubyUtils
   require 'eac_ruby_utils/contextualizable'
   require 'eac_ruby_utils/core_ext'
   require 'eac_ruby_utils/envs'
+  require 'eac_ruby_utils/filesystem_cache'
   require 'eac_ruby_utils/listable'
   require 'eac_ruby_utils/options_consumer'
   require 'eac_ruby_utils/patch'
   require 'eac_ruby_utils/patches'
   require 'eac_ruby_utils/paths_hash'
   require 'eac_ruby_utils/require_sub'
+  require 'eac_ruby_utils/rspec'
   require 'eac_ruby_utils/simple_cache'
   require 'eac_ruby_utils/yaml'
 end

data/lib/eac_ruby_utils/arguments_consumer.rb

@@ -69,6 +69,7 @@ module EacRubyUtils
 
       def check_no_more_arguments(arg)
         return unless @options_found
+
         invalid_argument arg, 'Hash already found - no more positional allowed'
       end
 

data/lib/eac_ruby_utils/configs.rb

@@ -55,6 +55,7 @@ module EacRubyUtils
     def storage_path_uncached
       path = options[:storage_path] || default_storage_path
       return path if ::File.exist?(path)
+
       ::FileUtils.mkdir_p(::File.dirname(path))
       ::File.write(path, {}.to_yaml)
       path

data/lib/eac_ruby_utils/console/configs.rb

@@ -45,15 +45,16 @@ module EacRubyUtils
         stored_value = configs.read_entry(entry_key)
         return stored_value if stored_value
         return read_entry_from_console(entry_key, options) unless options[:noinput]
+
         raise "No value found for entry \"#{entry_key}\""
       end
 
       def store_passwords?
-        'yes' == read_entry(
+        read_entry(
           STORE_PASSWORDS_KEY,
           before_input: -> { store_password_banner },
           validator: ->(entry_value) { %w[yes no].include?(entry_value) }
-        )
+        ) == 'yes'
       end
 
       protected
@@ -80,6 +81,7 @@ module EacRubyUtils
           entry_value = entry_value_from_input(entry_key, options)
           next unless entry_value.present?
           next if options[:validator] && !options[:validator].call(entry_value)
+
           return entry_value
         end
       end

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

@@ -13,6 +13,7 @@ module EacRubyUtils
           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

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

@@ -16,9 +16,11 @@ module EacRubyUtils
 
       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
 
@@ -94,6 +96,7 @@ module EacRubyUtils
 
         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

data/lib/eac_ruby_utils/console/speaker.rb

@@ -10,7 +10,7 @@ module EacRubyUtils
     # https://github.com/fazibear/colorize
     module Speaker
       def puts(string = '')
-        STDERR.puts(string.to_s)
+        STDERR.puts(string.to_s) # rubocop:disable Style/StderrPuts
       end
 
       def out(string = '')
@@ -96,6 +96,7 @@ module EacRubyUtils
         loop do
           input = request_string("#{question} [#{list.valid_labels.join('/')}]", noecho)
           return list.build_value(input) if list.valid_value?(input)
+
           warn "Invalid input: \"#{input}\" (Valid: #{list.valid_labels.join(', ')})"
         end
       end

data/lib/eac_ruby_utils/console/speaker/list.rb

@@ -11,6 +11,7 @@ module EacRubyUtils
           def build(list)
             return List.new(hash_to_values(list)) if list.is_a?(::Hash)
             return List.new(array_to_values(list)) if list.is_a?(::Array)
+
             raise "Invalid list: #{list} (#{list.class})"
           end
 

data/lib/eac_ruby_utils/contextualizable.rb

@@ -7,6 +7,7 @@ module EacRubyUtils
       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}"

data/lib/eac_ruby_utils/envs.rb

@@ -2,9 +2,11 @@
 
 require 'eac_ruby_utils/envs/base_env'
 require 'eac_ruby_utils/envs/command'
+require 'eac_ruby_utils/envs/file'
 require 'eac_ruby_utils/envs/local_env'
 require 'eac_ruby_utils/envs/process'
 require 'eac_ruby_utils/envs/ssh_env'
+require 'eac_ruby_utils/envs/executable'
 
 module EacRubyUtils
   module Envs

data/lib/eac_ruby_utils/envs/base_env.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require 'eac_ruby_utils/envs/command'
+require 'eac_ruby_utils/envs/executable'
+require 'eac_ruby_utils/envs/file'
 
 module EacRubyUtils
   module Envs
@@ -9,8 +11,17 @@ module EacRubyUtils
         ::EacRubyUtils::Envs::Command.new(self, args)
       end
 
+      # <b>DEPRECATED:</b> Please use <tt>file(file).exist?</tt> instead.
       def file_exist?(file)
-        command(['stat', file]).execute[:exit_code].zero?
+        self.file(file).exist?
+      end
+
+      def executable(*executable_new_args)
+        ::EacRubyUtils::Envs::Executable.new(self, *executable_new_args)
+      end
+
+      def file(path)
+        ::EacRubyUtils::Envs::File.new(self, path)
       end
     end
   end

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'active_support/core_ext/hash/indifferent_access'
+require 'active_support/core_ext/object/blank'
 require 'shellwords'
 
 module EacRubyUtils

data/lib/eac_ruby_utils/envs/executable.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/simple_cache'
+
+module EacRubyUtils
+  module Envs
+    class Executable
+      include ::EacRubyUtils::SimpleCache
+
+      attr_reader :env, :name, :check_args
+
+      def initialize(env, name, *check_args)
+        @env = env
+        @name = name
+        @check_args = check_args
+      end
+
+      def exist?
+        exist
+      end
+
+      def validate
+        return nil if exist?
+
+        "Program \"#{name}\" not found in environment #{env}"
+      end
+
+      def validate!
+        message = validate
+
+        raise ProgramNotFoundError, message if message
+      end
+
+      def command
+        validate!
+        env.command(name)
+      end
+
+      private
+
+      def exist_uncached
+        env.command(name, *check_args).execute!
+        true
+      rescue Errno::ENOENT
+        false
+      end
+
+      class ProgramNotFoundError < ::StandardError; end
+    end
+  end
+end

data/lib/eac_ruby_utils/envs/file.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module EacRubyUtils
+  module Envs
+    class File
+      attr_reader :env, :path
+
+      def initialize(env, path)
+        @env = env
+        @path = path
+      end
+
+      def exist?
+        env.command('stat', path).execute[:exit_code].zero?
+      end
+
+      def read
+        env.command('cat', path).execute!
+      end
+    end
+  end
+end

data/lib/eac_ruby_utils/envs/ssh_env.rb

@@ -8,26 +8,34 @@ require 'shellwords'
 module EacRubyUtils
   module Envs
     class SshEnv < ::EacRubyUtils::Envs::BaseEnv
+      USER_PATTERN = /[a-z_][a-z0-9_-]*/.freeze
+      HOSTNAME_PATTERN = /[^@]+/.freeze
+      USER_HOSTNAME_PATTERN = /\A(?:(#{USER_PATTERN})@)?(#{HOSTNAME_PATTERN})\z/.freeze
+
       class << self
         def parse_uri(uri)
-          r = parse_user_hostname(uri) || ::Addressable::URI.parse(uri)
-          return r if r.scheme == 'ssh'
-
-          raise "URI has no SSH scheme: #{uri}"
+          uri_by_url(uri) || uri_by_user_hostname(uri) || raise("URI has no SSH scheme: #{uri}")
         end
 
         private
 
-        def parse_user_hostname(user_hostname)
-          m = /\A([^@]+)@([^@]+)\z/.match(user_hostname)
+        def uri_by_url(url)
+          r = ::Addressable::URI.parse(url)
+          r.scheme == 'ssh' && r.host.present? ? r : nil
+        end
+
+        def uri_by_user_hostname(user_hostname)
+          m = USER_HOSTNAME_PATTERN.match(user_hostname)
           m ? ::Addressable::URI.new(scheme: 'ssh', host: m[2], user: m[1]) : nil
         rescue Addressable::URI::InvalidURIError
           nil
         end
       end
 
+      attr_reader :uri
+
       def initialize(uri)
-        @uri = self.class.parse_uri(uri)
+        @uri = self.class.parse_uri(uri).freeze
       end
 
       def to_s
@@ -40,13 +48,11 @@ module EacRubyUtils
 
       private
 
-      attr_reader :uri
-
       def ssh_command_line
         r = %w[ssh]
         r += ['-p', uri.port] if uri.port.present?
         r += ssh_command_line_options
-        r << "#{uri.user}@#{uri.host}"
+        r << user_hostname_uri
         r.map { |a| Shellwords.escape(a) }.join(' ')
       end
 
@@ -55,6 +61,12 @@ module EacRubyUtils
         uri.query_values&.each { |k, v| r += ['-o', "#{k}=#{v}"] }
         r
       end
+
+      def user_hostname_uri
+        r = uri.host
+        r = "#{uri.user}@#{r}" if uri.user.present?
+        r
+      end
     end
   end
 end

data/lib/eac_ruby_utils/filesystem_cache.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module EacRubyUtils
+  class FilesystemCache
+    CONTENT_FILE_NAME = '__content__'
+
+    attr_reader :path
+
+    def initialize(*path_parts)
+      raise ArgumentError, "\"#{path_parts}\" is empty" if path_parts.empty?
+
+      @path = ::File.expand_path(::File.join(*path_parts.map(&:to_s)))
+    end
+
+    def clear
+      return unless cached?
+
+      ::File.unlink(content_path)
+    end
+
+    def read
+      return nil unless cached?
+
+      ::File.read(content_path)
+    end
+
+    def write(value)
+      assert_directory_on_path
+      ::File.write(content_path, value)
+      value
+    end
+
+    def child(*child_path_parts)
+      self.class.new(path, *child_path_parts)
+    end
+
+    def cached?
+      ::File.exist?(content_path)
+    end
+
+    def content_path
+      ::File.join(path, CONTENT_FILE_NAME)
+    end
+
+    private
+
+    def assert_directory_on_path
+      raise "#{path} is a file" if ::File.file?(path)
+
+      ::FileUtils.mkdir_p(path)
+    end
+  end
+end

data/lib/eac_ruby_utils/listable/list.rb

@@ -22,7 +22,7 @@ module EacRubyUtils
 
       def method_missing(name, *args, &block)
         list = find_list_by_method(name)
-        list ? list : super
+        list || super
       end
 
       def respond_to_missing?(name, include_all = false)
@@ -36,6 +36,7 @@ module EacRubyUtils
       def instance_value(instance)
         v = instance.send(item)
         return @values[v] if @values.key?(v)
+
         raise "List value unkown: #{v} (Source: #{@lists.source}, Item: #{item})"
       end
 

data/lib/eac_ruby_utils/listable/lists.rb

@@ -30,7 +30,7 @@ module EacRubyUtils
 
       def method_missing(name, *args, &block)
         list = find_list_by_method(name)
-        list ? list : super
+        list || super
       end
 
       def respond_to_missing?(name, include_all = false)
@@ -45,6 +45,7 @@ module EacRubyUtils
 
       def check_acts_as_listable_new_item(item)
         return unless acts_as_listable_items.key?(item)
+
         raise "Item já adicionado anteriormente: #{item} em #{self} " \
           "(#{acts_as_listable_items.keys})"
       end

data/lib/eac_ruby_utils/patch.rb

@@ -4,6 +4,7 @@ module EacRubyUtils
   class << self
     def patch(target, patch)
       return if target.included_modules.include?(patch)
+
       target.send(:include, patch)
     end
   end

data/lib/eac_ruby_utils/patches/object/asserts.rb

@@ -6,6 +6,7 @@ class Object
   # @return +self+
   def assert_argument(klass, argument_name = 'unknown_argument_name')
     return self if is_a?(klass)
+
     raise ::ArgumentError,
           "Argument \"#{argument_name}\" is not a #{klass}" \
           "(Actual class: #{self.class}, actual value: #{self})"

data/lib/eac_ruby_utils/patches/object/if_present.rb

@@ -6,6 +6,7 @@ class Object
   # @return +block.call(self)+ if +self+ is present, +default_value+ otherwise.
   def if_present(default_value = nil)
     return default_value unless present?
+
     block_given? ? yield(self) : self
   end
 end

data/lib/eac_ruby_utils/paths_hash.rb

@@ -10,9 +10,11 @@ module EacRubyUtils
         r = entry_key.to_s.strip
         raise EntryKeyError, 'Entry key cannot start or end with dot' if
         r.start_with?('.') || r.end_with?('.')
+
         r = r.split('.').map(&:strip)
         raise EntryKeyError, "Entry key \"#{entry_key}\" is empty" if r.empty?
         return r.map(&:to_sym) unless r.any?(&:blank?)
+
         raise EntryKeyError, "Entry key \"#{entry_key}\" has at least one blank part"
       end
     end
@@ -59,6 +61,7 @@ module EacRubyUtils
         return (node.is_a?(Node) ? node.to_h : node) if path.empty?
         return nil if node.blank?
         return node.read_entry(path, current + [node_key]) if node.is_a?(Node)
+
         raise(EntryKeyError,
               "Path #{current.join(',')} is not a Node and path continues (#{current + path})")
       end

data/lib/eac_ruby_utils/rspec.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/require_sub'
+::EacRubyUtils.require_sub(__FILE__)
+
+module EacRubyUtils
+  module Rspec
+  end
+end

data/lib/eac_ruby_utils/rspec/conditional.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/object/blank'
+require 'eac_ruby_utils/console/speaker'
+
+module EacRubyUtils
+  module Rspec
+    class Conditional
+      include ::EacRubyUtils::Console::Speaker
+
+      def self.default
+        @default ||= new
+      end
+
+      def initialize
+        @tags = {}
+      end
+
+      def add(tag, &condition)
+        tags[tag] = condition
+      end
+
+      def configure(rspec_config)
+        tags.each do |tag, condition|
+          message = condition.call
+          if message.present?
+            warn("Excluded tag: #{tag}: #{message}")
+            rspec_config.filter_run_excluding tag
+          end
+        end
+      end
+
+      private
+
+      attr_reader :tags
+    end
+  end
+end

data/lib/eac_ruby_utils/rspec/stubbed_ssh.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/object/blank'
+require 'eac_ruby_utils/envs/ssh_env'
+require 'eac_ruby_utils/patches/object/if_present'
+
+module EacRubyUtils
+  module Rspec
+    class StubbedSsh
+      DEFAULT_ENVVAR_NAME = 'STUBBED_SSH_URL'
+
+      class << self
+        def default
+          @default ||= new(DEFAULT_ENVVAR_NAME)
+        end
+      end
+
+      attr_reader :envvar_name
+
+      def initialize(envvar_name)
+        @envvar_name = envvar_name
+      end
+
+      def validate
+        return nil if provided_url.present?
+
+        "Environment variable \"#{envvar_name}\" unprovided or blank"
+      end
+
+      def validate!
+        validate.if_present { |v| raise v }
+      end
+
+      def provided_url
+        ENV[envvar_name]
+      end
+
+      def build_env
+        validate!
+        ::EacRubyUtils::Envs::SshEnv.new(provided_url)
+      end
+    end
+  end
+end

data/lib/eac_ruby_utils/simple_cache.rb

@@ -2,7 +2,7 @@
 
 module EacRubyUtils
   module SimpleCache
-    UNCACHED_METHOD_PATTERN = /\A(\s+)_uncached\z/
+    UNCACHED_METHOD_PATTERN = /\A(\s+)_uncached\z/.freeze
 
     def method_missing(method, *args, &block)
       uncached_method = "#{method}_uncached"
@@ -29,6 +29,7 @@ module EacRubyUtils
 
     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]

data/lib/eac_ruby_utils/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eac_ruby_utils
 version: !ruby/object:Gem::Version
-  version: 0.12.0
+  version: 0.13.0
 platform: ruby
 authors:
 - Esquilo Azul Company
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-25 00:00:00.000000000 Z
+date: 2019-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -94,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.74.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.74.0
 description: 
 email: 
 executables: []
@@ -119,9 +133,12 @@ files:
 - lib/eac_ruby_utils/envs/base_env.rb
 - lib/eac_ruby_utils/envs/command.rb
 - lib/eac_ruby_utils/envs/command/extra_options.rb
+- lib/eac_ruby_utils/envs/executable.rb
+- lib/eac_ruby_utils/envs/file.rb
 - lib/eac_ruby_utils/envs/local_env.rb
 - lib/eac_ruby_utils/envs/process.rb
 - lib/eac_ruby_utils/envs/ssh_env.rb
+- lib/eac_ruby_utils/filesystem_cache.rb
 - lib/eac_ruby_utils/listable.rb
 - lib/eac_ruby_utils/listable/class_methods.rb
 - lib/eac_ruby_utils/listable/instance_methods.rb
@@ -146,6 +163,9 @@ files:
 - lib/eac_ruby_utils/patches/object/if_present.rb
 - lib/eac_ruby_utils/paths_hash.rb
 - lib/eac_ruby_utils/require_sub.rb
+- lib/eac_ruby_utils/rspec.rb
+- lib/eac_ruby_utils/rspec/conditional.rb
+- lib/eac_ruby_utils/rspec/stubbed_ssh.rb
 - lib/eac_ruby_utils/simple_cache.rb
 - lib/eac_ruby_utils/version.rb
 - lib/eac_ruby_utils/yaml.rb