eac_ruby_utils 0.16.0 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c932e97f7a56a87ac479e6897edc7726b810e7031c88049bcdaa674e3a47d8c
-  data.tar.gz: cf4eb48992f065f1ba1bc0fbd5c76951679c30f8133b3f2c36f7d82e162e27fb
+  metadata.gz: bb7610983cbff65f045d8b281a7bb753f715dcdc7c5e4025852d8e44752f09d9
+  data.tar.gz: d496ac3d43969ac58e14a4e4f57f47bae6e5c07ccc721b440dc3095f5f34c290
 SHA512:
-  metadata.gz: dde3dde0b173519bc0fcd6d799cd6896895087cce78310bd733fde0848b137674d5d11ff4cda4cc523a917ce7a0ca4228727c8c7e3d660c68ecbee13da02c93c
-  data.tar.gz: 9f4e4f8f8a9f48d2817f0496be6617860256888fc2a50abb37306837872e3f23aef35eb1f4bf654667b352379d90cd6312f64177e700d06670439772dbfb643e
+  metadata.gz: 74516a7e43ac2a023a9e94c9f898b9ff2a8841778535225b0876707a7008ea46463ceb31296b67fb059d457afe5a5076b7eca03a7125cdeb753d90d059c4a2d4
+  data.tar.gz: 1d3c7f9c36ea92386781aab18ee5cf92e80e6f92305fa54a663f467b857b24f786ee55c1eff1e8d33cacf0f8c01f92c643df79c1aa0443b5dc4583150310de42

data/lib/eac_ruby_utils/configs.rb

@@ -19,6 +19,10 @@ module EacRubyUtils
       load
     end
 
+    def clear
+      self.data = ::EacRubyUtils::PathsHash.new({})
+    end
+
     def save
       ::File.write(storage_path, data.to_h.to_yaml)
     end

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/string/inflections'
+require 'eac_ruby_utils/templates/searcher'
+
+class Object
+  class << self
+    def template
+      @template ||= ::EacRubyUtils::Templates::Searcher.default.template(name.underscore)
+    end
+  end
+
+  def template
+    self.class.template
+  end
+end

data/lib/eac_ruby_utils/templates.rb

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

data/lib/eac_ruby_utils/templates/directory.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/templates/file'
+
+module EacRubyUtils
+  module Templates
+    class Directory
+      TEMPLATE_EXTNAME = '.template'
+
+      attr_reader :path
+
+      def initialize(path)
+        @path = path
+      end
+
+      def apply(variables_source, directory)
+        TemplateNode.new(self, '.', directory, variables_source).apply
+      end
+
+      def child(subpath)
+        child_path = ::File.join(path, subpath)
+        return ::EacRubyUtils::Templates::File.new(child_path) if ::File.file?(child_path)
+        return ::EacRubyUtils::Templates::Directory.new(child_path) if ::File.directory?(child_path)
+
+        raise "Child \"#{subpath}\" from \"#{path}\" not found"
+      end
+
+      private
+
+      def apply_fs_object(source_relative, target)
+        if ::File.directory?(source_absolute(source_relative))
+          apply_directory(source_relative, target)
+        elsif ::File.file?(source_absolute(source_relative))
+        end
+      end
+
+      def source_absolute(source_relative)
+        ::File.expand_path(source_relative, path)
+      end
+
+      class TemplateNode
+        attr_reader :source_directory, :source_relative, :target_root_directory, :variables_source
+
+        def initialize(source_directory, source_relative, target_root_directory, variables_source)
+          @source_directory = source_directory
+          @source_relative = source_relative
+          @target_root_directory = target_root_directory
+          @variables_source = variables_source
+        end
+
+        def apply
+          if file?
+            apply_file
+          elsif directory?
+            apply_directory
+          else
+            raise "Unknown filesystem type: #{source_absolute}"
+          end
+        end
+
+        private
+
+        def apply_directory
+          ::FileUtils.mkdir_p(target_absolute)
+          Dir.entries(source_absolute).each do |entry|
+            child(entry).apply unless %w[. ..].include?(entry)
+          end
+        end
+
+        def apply_file
+          if ::File.extname(source_absolute) == TEMPLATE_EXTNAME
+            ::EacRubyUtils::Templates::File.new(source_absolute).apply_to_file(
+              variables_source, target_absolute
+            )
+          else
+            ::FileUtils.cp(source_absolute, target_absolute)
+          end
+        end
+
+        def child(entry)
+          TemplateNode.new(source_directory, ::File.join(source_relative, entry),
+                           target_root_directory, variables_source)
+        end
+
+        def file?
+          ::File.file?(source_absolute)
+        end
+
+        def directory?
+          ::File.directory?(source_absolute)
+        end
+
+        def source_absolute
+          ::File.expand_path(source_relative, source_directory.path)
+        end
+
+        def target_absolute
+          ::File.expand_path(source_relative, target_root_directory)
+                .gsub(/#{::Regexp.quote(TEMPLATE_EXTNAME)}\z/, '')
+        end
+      end
+    end
+  end
+end

data/lib/eac_ruby_utils/templates/file.rb

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/hash/indifferent_access'
+require 'eac_ruby_utils/simple_cache'
+
+module EacRubyUtils
+  module Templates
+    class File
+      include ::EacRubyUtils::SimpleCache
+
+      VARIABLE_DELIMITER = ::Regexp.quote('%%')
+      VARIABLE_PATTERN = /#{VARIABLE_DELIMITER}([a-z0-9\._]*)#{VARIABLE_DELIMITER}/i.freeze
+
+      attr_reader :path
+
+      def initialize(path)
+        @path = path
+      end
+
+      # +variables_provider+ A [Hash] or object which responds to +read_entry(entry_name)+.
+      def apply(variables_source)
+        variables_provider = build_variables_provider(variables_source)
+        variables.inject(content) do |a, e|
+          a.gsub(variable_pattern(e), variables_provider.variable_value(e).to_s)
+        end
+      end
+
+      def apply_to_file(variables_source, output_file_path)
+        ::File.write(output_file_path, apply(variables_source))
+      end
+
+      private
+
+      def variables_uncached
+        content.scan(VARIABLE_PATTERN).map(&:first).map do |name|
+          sanitize_variable_name(name)
+        end.to_set
+      end
+
+      def content_uncached
+        ::File.read(path)
+      end
+
+      def sanitize_variable_name(variable_name)
+        variable_name.to_s.downcase
+      end
+
+      def build_variables_provider(variables_source)
+        return HashVariablesProvider.new(variables_source) if variables_source.is_a?(::Hash)
+        return EntriesReaderVariablesProvider.new(variables_source) if
+        variables_source.respond_to?(:read_entry)
+
+        raise "Variables provider not found for #{variables_source}"
+      end
+
+      def variable_pattern(name)
+        /#{VARIABLE_DELIMITER}#{::Regexp.quote(name)}#{VARIABLE_DELIMITER}/i
+      end
+
+      class BaseVariablesProvider
+        attr_reader :source
+
+        def initialize(source)
+          @source = source
+        end
+
+        def variable_value(name)
+          return variable_fetch(name) if variable_exist?(name)
+
+          raise VariableNotFoundError, "Variable \"#{name}\" not found in #{source}"
+        end
+      end
+
+      class HashVariablesProvider < BaseVariablesProvider
+        def initialize(source)
+          super(source.with_indifferent_access)
+        end
+
+        def variable_exist?(name)
+          source.key?(name)
+        end
+
+        def variable_fetch(name)
+          source.fetch(name)
+        end
+      end
+
+      class EntriesReaderVariablesProvider < BaseVariablesProvider
+        def variable_exist?(_name)
+          true
+        end
+
+        def variable_fetch(name)
+          source.read_entry(name)
+        end
+      end
+
+      class VariableNotFoundError < StandardError; end
+    end
+  end
+end

data/lib/eac_ruby_utils/templates/searcher.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/object/blank'
+require 'eac_ruby_utils/templates/directory'
+require 'eac_ruby_utils/templates/file'
+
+module EacRubyUtils
+  module Templates
+    class Searcher
+      class << self
+        def default
+          @default ||= new
+        end
+      end
+
+      def template(subpath, required = true)
+        path = template_path(subpath)
+        if path.blank?
+          return nil unless required
+
+          raise_template_not_found(subpath)
+        end
+        return ::EacRubyUtils::Templates::File.new(path) if ::File.file?(path)
+        return ::EacRubyUtils::Templates::Directory.new(path) if ::File.directory?(path)
+
+        raise 'Invalid branching'
+      end
+
+      # @return The absolute path of template if found, +nil+ otherwise.
+      def template_path(subpath)
+        included_paths.each do |included_path|
+          r = search_template_in_included_path(included_path, subpath)
+          return r if r
+        end
+        nil
+      end
+
+      def included_paths
+        @included_paths ||= ::Set.new
+      end
+
+      private
+
+      def raise_template_not_found(subpath)
+        raise "Template not found for subpath \"#{subpath}\"" \
+          " (Included paths: #{included_paths.to_a.join(::File::PATH_SEPARATOR)})"
+      end
+
+      def search_template_in_included_path(included_path, subpath)
+        path = ::File.join(included_path, subpath)
+        ::File.exist?(path) ? path : nil
+      end
+    end
+  end
+end

data/lib/eac_ruby_utils/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eac_ruby_utils
 version: !ruby/object:Gem::Version
-  version: 0.16.0
+  version: 0.17.0
 platform: ruby
 authors:
 - Esquilo Azul Company
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-05 00:00:00.000000000 Z
+date: 2019-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -166,12 +166,17 @@ files:
 - lib/eac_ruby_utils/patches/object.rb
 - lib/eac_ruby_utils/patches/object/asserts.rb
 - lib/eac_ruby_utils/patches/object/if_present.rb
+- lib/eac_ruby_utils/patches/object/template.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/templates.rb
+- lib/eac_ruby_utils/templates/directory.rb
+- lib/eac_ruby_utils/templates/file.rb
+- lib/eac_ruby_utils/templates/searcher.rb
 - lib/eac_ruby_utils/version.rb
 - lib/eac_ruby_utils/yaml.rb
 homepage: