eac_ruby_utils 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0119c50e5869164d29e5dc579df784a5e3576a613a4ea5c597a2ee6dcda212fe'
-  data.tar.gz: c69eea7c7587d93d44e82da0b37a110e2ec5fb77dfac4e83ecf2d028fd10657f
+  metadata.gz: 9290fda1cce697dcfd049b6a8085af55f0ca059d64d183b7571a0f5cbfa9a820
+  data.tar.gz: 54679bb172f9c3a2dcac08d642fc0a23dec10142384dff4b6e7f4c72db21622b
 SHA512:
-  metadata.gz: d7890f0ffebd4a457ba27eb4cd5ca5df500d19e74103039c441d4ff5c3a26685c6c5a239652e69b99a7007e4688e2a79c275c78b1b019f1ebbedf8f49a9e0f9a
-  data.tar.gz: 4ed10a42a2b890e6995f67931648029e5f94c6de8b7cc9bf5de57f028169a0e7e122289c53f6b115a37879d2f742acb5b38edd686f93aae62614ffefddcd0102
+  metadata.gz: e0611daf87bdb28ca44827934496a9d546b5f9220a0807d80416b61a9b30b282333cbdd9d6699644c47924704d428f9e2a9f18eba4f1c3eab74dc0c432e6efc8
+  data.tar.gz: 4402ebebc43b4b862951a39c6213c5c13f2f86fc0784deadbf49a78408e36c3827e40c73e66552bb7313c6603421cb65c8cd3c24fbec8f391ee27048496d3692

data/lib/eac_ruby_utils.rb

@@ -2,12 +2,14 @@
 
 module EacRubyUtils
   require 'eac_ruby_utils/arguments_consumer'
+  require 'eac_ruby_utils/configs'
   require 'eac_ruby_utils/console'
   require 'eac_ruby_utils/contextualizable'
   require 'eac_ruby_utils/envs'
   require 'eac_ruby_utils/listable'
   require 'eac_ruby_utils/options_consumer'
   require 'eac_ruby_utils/patches'
+  require 'eac_ruby_utils/paths_hash'
   require 'eac_ruby_utils/simple_cache'
   require 'eac_ruby_utils/yaml'
 end

data/lib/eac_ruby_utils/configs.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/string'
+require 'yaml'
+require 'eac_ruby_utils/patches/hash/sym_keys_hash'
+require 'eac_ruby_utils/paths_hash'
+require 'eac_ruby_utils/simple_cache'
+
+module EacRubyUtils
+  class Configs
+    include ::EacRubyUtils::SimpleCache
+
+    attr_reader :configs_key, :options
+
+    # Valid options: [:storage_path]
+    def initialize(configs_key, options = {})
+      @configs_key = configs_key
+      @options = options.to_sym_keys_hash.freeze
+      load
+    end
+
+    def save
+      ::File.write(storage_path, data.to_h.to_yaml)
+    end
+
+    def load
+      self.data = ::EacRubyUtils::PathsHash.new(YAML.load_file(storage_path))
+    end
+
+    def []=(entry_key, entry_value)
+      write_entry(entry_key, entry_value)
+    end
+
+    def write_entry(entry_key, entry_value)
+      data[entry_key] = entry_value
+      save if autosave?
+    end
+
+    def [](entry_key)
+      read_entry(entry_key)
+    end
+
+    def read_entry(entry_key)
+      data[entry_key]
+    end
+
+    def autosave?
+      options[:autosave] ? true : false
+    end
+
+    private
+
+    attr_accessor :data
+
+    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
+    end
+
+    def options_storage_path
+      options[:storage_path]
+    end
+
+    def default_storage_path
+      ::File.join(ENV['HOME'], '.config', configs_key, 'settings.yml')
+    end
+  end
+end

data/lib/eac_ruby_utils/console.rb

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

data/lib/eac_ruby_utils/console/configs.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/configs'
+require 'eac_ruby_utils/console/speaker'
+
+module EacRubyUtils
+  module Console
+    class Configs
+      include ::EacRubyUtils::Console::Speaker
+
+      STORE_PASSWORDS_KEY = 'core.store_passwords'
+
+      attr_reader :configs
+
+      def initialize(configs_key)
+        @configs = ::EacRubyUtils::Configs.new(configs_key, autosave: true)
+      end
+
+      def request_password(entry_key, options = {})
+        options = options.merge(noecho: true)
+        if store_passwords?
+          read_entry(entry_key, options)
+        else
+          looped_entry_value_from_input(entry_key, options)
+        end
+      end
+
+      def read_entry(entry_key, options = {})
+        stored_value = configs.read_entry(entry_key)
+        return stored_value if stored_value
+        options[:before_input].call if options[:before_input].present?
+        entry_value = looped_entry_value_from_input(entry_key, options)
+        configs.write_entry(entry_key, entry_value)
+        entry_value
+      end
+
+      def store_passwords?
+        'yes' == read_entry(
+          STORE_PASSWORDS_KEY,
+          before_input: -> { store_password_banner },
+          validator: ->(entry_value) { %w[yes no].include?(entry_value) }
+        )
+      end
+
+      protected
+
+      def store_password_banner
+        infom 'Do you wanna to store passwords?'
+        infom "Warning: the passwords will be store in clear text in \"#{configs.storage_path}\""
+        infom 'Enter "yes" or "no"'
+      end
+
+      def looped_entry_value_from_input(entry_key, options)
+        loop do
+          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
+
+      def entry_value_from_input(entry_key, options)
+        entry_value = request_input("Value for entry \"#{entry_key}\"", options)
+        warn('Entered value is blank') if entry_value.blank?
+        entry_value
+      end
+    end
+  end
+end

data/lib/eac_ruby_utils/console/speaker.rb

@@ -39,6 +39,17 @@ module EacRubyUtils
         puts string.to_s.yellow
       end
 
+      def request_input(question, options = {})
+        STDERR.write "#{question}: ".to_s.yellow
+        if options[:noecho]
+          r = STDIN.noecho(&:gets).chomp.strip
+          STDERR.write("\n")
+          r
+        else
+          gets.chomp.strip
+        end
+      end
+
       def infov(*args)
         r = []
         args.each_with_index do |v, i|

data/lib/eac_ruby_utils/patches/object.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/object/asserts.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+class Object
+  def assert_argument(klass, argument_name)
+    return if is_a?(klass)
+    raise ::ArgumentError,
+          "Argument \"#{argument_name}\" is not a #{klass}" \
+          "(Actual class: #{self.class}, actual value: #{self})"
+  end
+end

data/lib/eac_ruby_utils/paths_hash.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/object'
+require 'eac_ruby_utils/patches/object/asserts'
+
+module EacRubyUtils
+  class PathsHash
+    class << self
+      def parse_entry_key(entry_key)
+        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
+
+    attr_reader :root
+
+    def initialize(source_hash = {})
+      @root = Node.new(source_hash)
+    end
+
+    def [](entry_key)
+      root.read_entry(self.class.parse_entry_key(entry_key), [])
+    end
+
+    def []=(entry_key, entry_value)
+      root.write_entry(self.class.parse_entry_key(entry_key), entry_value, [])
+    end
+
+    def to_h
+      root.to_h
+    end
+
+    private
+
+    attr_reader :data
+
+    class EntryKeyError < StandardError
+    end
+
+    class Node
+      def initialize(source_hash)
+        source_hash.assert_argument(Hash, 'source_hash')
+        @data = source_hash.map { |k, v| [k.to_sym, v.is_a?(Hash) ? Node.new(v) : v] }.to_h
+      end
+
+      def to_h
+        data.map { |k, v| [k, v.is_a?(Node) ? v.to_h : v] }.to_h
+      end
+
+      def read_entry(path, current)
+        validate_path(path, current)
+        node_key = path.shift
+        node = data[node_key]
+        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
+
+      def write_entry(path, value, current)
+        validate_path(path, current)
+        node_key = path.shift
+        write_entry_value(path, node_key, value, current)
+      end
+
+      private
+
+      def write_entry_value(path, node_key, value, current)
+        if path.empty?
+          data[node_key] = value.is_a?(Hash) ? Node.new(value) : value
+        else
+          data[node_key] = Node.new({}) unless data[node_key].is_a?(Node)
+          data[node_key].write_entry(path, value, current + [node_key])
+        end
+      end
+
+      def validate_path(path, current)
+        path.assert_argument(Array, 'path')
+        current.assert_argument(Array, 'current')
+        raise EntryKeyError, 'Path is empty' if path.empty?
+      end
+
+      attr_reader :data
+    end
+  end
+end

data/lib/eac_ruby_utils/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eac_ruby_utils
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Esquilo Azul Company
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-07-29 00:00:00.000000000 Z
+date: 2019-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -103,7 +103,9 @@ files:
 - README.rdoc
 - lib/eac_ruby_utils.rb
 - lib/eac_ruby_utils/arguments_consumer.rb
+- lib/eac_ruby_utils/configs.rb
 - lib/eac_ruby_utils/console.rb
+- lib/eac_ruby_utils/console/configs.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
@@ -131,6 +133,9 @@ files:
 - 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/patches/object.rb
+- lib/eac_ruby_utils/patches/object/asserts.rb
+- lib/eac_ruby_utils/paths_hash.rb
 - lib/eac_ruby_utils/simple_cache.rb
 - lib/eac_ruby_utils/version.rb
 - lib/eac_ruby_utils/yaml.rb