eac_templates 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: af93be7bf79c5e3ecf4cd7eb1ef371076cff21ee1a3df7a91f87214b4720f4cb
+  data.tar.gz: b52cb1e8a2aa0ccf991c649bc02cd601cb83f26c1d838e7f1046886f17517bc8
+SHA512:
+  metadata.gz: a5950e2d66256f9f89b99419017911ebd66a9242afa40d1b6d107b07e9b006811ae50af006c08fbbf1beb555d5b7365843ecb50214884212f53b869aea72cceb
+  data.tar.gz: dae82810a933ba499b2027833cefb832ce2cb90d8e9e9ec022c6de859829244944f1b6e91f2636691a674037769985e7f090247cc43e00bed3f4c6dfa00574b6

data/lib/eac_templates.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module EacTemplates
+  require_sub __FILE__
+end

data/lib/eac_templates/directory.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+require 'eac_templates/file'
+
+module EacTemplates
+  class Directory
+    TEMPLATE_EXTNAME = '.template'
+
+    attr_reader :path
+
+    def initialize(path)
+      @path = path.is_a?(::Pathname) ? path : ::Pathname.new(path.to_s)
+    end
+
+    def apply(variables_source, directory)
+      TemplateNode.new(self, '.', directory, variables_source).apply
+    end
+
+    def child(subpath)
+      child_path = ::File.join(path, subpath)
+      return ::EacTemplates::File.new(child_path) if ::File.file?(child_path)
+      return ::EacTemplates::Directory.new(child_path) if ::File.directory?(child_path)
+
+      raise "Child \"#{subpath}\" from \"#{path}\" not found"
+    end
+
+    def children
+      path.children.map do |path_child|
+        child(path_child.basename.to_path)
+      end
+    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
+          ::EacTemplates::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

data/lib/eac_templates/file.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+require 'eac_templates/variable_providers'
+
+module EacTemplates
+  class File
+    VARIABLE_DELIMITER = ::Regexp.quote('%%')
+    VARIABLE_PATTERN = /#{VARIABLE_DELIMITER}([a-z0-9\._]*)#{VARIABLE_DELIMITER}/i.freeze
+
+    enable_simple_cache
+    common_constructor :path do
+      self.path = path.to_pathname
+    end
+
+    # +variables_provider+ A [Hash] or object which responds to +read_entry(entry_name)+.
+    def apply(variables_source)
+      variables_provider = ::EacTemplates::VariableProviders.build(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)
+      output_file_path.to_pathname.write(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
+      path.read
+    end
+
+    def sanitize_variable_name(variable_name)
+      variable_name.to_s.downcase
+    end
+
+    def variable_pattern(name)
+      /#{VARIABLE_DELIMITER}#{::Regexp.quote(name)}#{VARIABLE_DELIMITER}/i
+    end
+  end
+end

data/lib/eac_templates/patches/module/template.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/string/inflections'
+require 'eac_templates/searcher'
+
+class Module
+  def template
+    @template ||= ::EacTemplates::Searcher.default.template(name.underscore)
+  end
+end

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

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'eac_templates/patches/module/template'
+
+class Object
+  def template
+    self.class.template
+  end
+end

data/lib/eac_templates/searcher.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/object/blank'
+require 'eac_templates/directory'
+require 'eac_templates/file'
+
+module EacTemplates
+  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 ::EacTemplates::File.new(path) if ::File.file?(path)
+      return ::EacTemplates::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

data/lib/eac_templates/variable_not_found_error.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module EacTemplates
+  class VariableNotFoundError < StandardError; end
+end

data/lib/eac_templates/variable_providers.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module EacTemplates
+  module VariableProviders
+    require_sub __FILE__
+
+    PROVIDERS = %w[entries_reader hash generic].map do |name|
+      "eac_templates/variable_providers/#{name}".camelize.constantize
+    end
+
+    class << self
+      def build(variables_source)
+        PROVIDERS.each do |provider|
+          return provider.new(variables_source) if provider.accept?(variables_source)
+        end
+
+        raise "Variables provider not found for #{variables_source}"
+      end
+    end
+  end
+end

data/lib/eac_templates/variable_providers/base.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'eac_templates/variable_not_found_error'
+
+module EacTemplates
+  module VariableProviders
+    class Base
+      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
+  end
+end

data/lib/eac_templates/variable_providers/entries_reader.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'eac_templates/variable_providers/base'
+
+module EacTemplates
+  module VariableProviders
+    class EntriesReader < ::EacTemplates::VariableProviders::Base
+      class << self
+        def accept?(variables_source)
+          variables_source.respond_to?(:read_entry)
+        end
+      end
+
+      def variable_exist?(_name)
+        true
+      end
+
+      def variable_fetch(name)
+        source.read_entry(name)
+      end
+    end
+  end
+end

data/lib/eac_templates/variable_providers/generic.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'eac_templates/variable_providers/base'
+
+module EacTemplates
+  module VariableProviders
+    class Generic < ::EacTemplates::VariableProviders::Base
+      class << self
+        def accept?(variables_source)
+          variables_source.is_a?(::Object)
+        end
+      end
+
+      def variable_exist?(name)
+        source.respond_to?(name)
+      end
+
+      def variable_fetch(name)
+        source.send(name)
+      end
+    end
+  end
+end

data/lib/eac_templates/variable_providers/hash.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'eac_templates/variable_providers/base'
+
+module EacTemplates
+  module VariableProviders
+    class Hash < ::EacTemplates::VariableProviders::Base
+      class << self
+        def accept?(variables_source)
+          variables_source.is_a?(::Hash)
+        end
+      end
+
+      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
+  end
+end

data/lib/eac_templates/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module EacTemplates
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: eac_templates
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Put here the authors
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-05-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: eac_config
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: eac_ruby_utils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.64'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.64'
+- !ruby/object:Gem::Dependency
+  name: eac_ruby_gem_support
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/eac_templates.rb
+- lib/eac_templates/directory.rb
+- lib/eac_templates/file.rb
+- lib/eac_templates/patches/module/template.rb
+- lib/eac_templates/patches/object/template.rb
+- lib/eac_templates/searcher.rb
+- lib/eac_templates/variable_not_found_error.rb
+- lib/eac_templates/variable_providers.rb
+- lib/eac_templates/variable_providers/base.rb
+- lib/eac_templates/variable_providers/entries_reader.rb
+- lib/eac_templates/variable_providers/generic.rb
+- lib/eac_templates/variable_providers/hash.rb
+- lib/eac_templates/version.rb
+homepage: 
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.9
+signing_key: 
+specification_version: 4
+summary: Put here de description.
+test_files: []