eac_templates 0.3.2 → 0.4.0

data/lib/eac_templates/variables/providers/config_reader.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'eac_config/node'
+require 'eac_templates/variables/providers/base'
+
+module EacTemplates
+  module Variables
+    module Providers
+      class ConfigReader < ::EacTemplates::Variables::Providers::Base
+        class << self
+          def accept?(variables_source)
+            return false unless variables_source.respond_to?(:entry)
+
+            entry = variables_source.entry(:any_value)
+            entry.respond_to?(:value) && entry.respond_to?(:found?)
+          end
+        end
+
+        def variable_exist?(name)
+          source.entry(name).found?
+        end
+
+        def variable_fetch(name)
+          source.entry(name).value
+        end
+      end
+    end
+  end
+end

data/lib/eac_templates/variables/providers/entries_reader.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'eac_templates/variables/providers/base'
+
+module EacTemplates
+  module Variables
+    module Providers
+      class EntriesReader < ::EacTemplates::Variables::Providers::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
+end

data/lib/eac_templates/variables/providers/generic.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'eac_templates/variables/providers/base'
+
+module EacTemplates
+  module Variables
+    module Providers
+      class Generic < ::EacTemplates::Variables::Providers::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
+end

data/lib/eac_templates/variables/providers/hash.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'eac_templates/variables/providers/base'
+
+module EacTemplates
+  module Variables
+    module Providers
+      class Hash < ::EacTemplates::Variables::Providers::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
+end

data/lib/eac_templates/variables/providers.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module EacTemplates
+  module Variables
+    module Providers
+      require_sub __FILE__
+
+      PROVIDERS = %w[config_reader entries_reader hash generic].map do |name|
+        "eac_templates/variables/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
+end

data/lib/eac_templates/variables.rb

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

data/lib/eac_templates/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eac_templates
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Put here the authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-09-04 00:00:00.000000000 Z
+date: 2023-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eac_config
@@ -16,40 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.11.1
+        version: '0.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.11.1
+        version: '0.12'
 - !ruby/object:Gem::Dependency
   name: eac_ruby_utils
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.102'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.102.1
+        version: '0.112'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.102'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.102.1
+        version: '0.112'
 - !ruby/object:Gem::Dependency
   name: eac_ruby_gem_support
   requirement: !ruby/object:Gem::Requirement
@@ -72,10 +60,13 @@ extra_rdoc_files: []
 files:
 - lib/eac_templates.rb
 - lib/eac_templates/core_ext.rb
-- lib/eac_templates/directory.rb
-- lib/eac_templates/file.rb
-- lib/eac_templates/from_all_gems.rb
-- lib/eac_templates/from_gem.rb
+- lib/eac_templates/interface_methods.rb
+- lib/eac_templates/modules.rb
+- lib/eac_templates/modules/ancestor.rb
+- lib/eac_templates/modules/ancestor/directory.rb
+- lib/eac_templates/modules/ancestor/file.rb
+- lib/eac_templates/modules/ancestor/fs_object.rb
+- lib/eac_templates/modules/base.rb
 - lib/eac_templates/patches.rb
 - lib/eac_templates/patches/module.rb
 - lib/eac_templates/patches/module/erb_template.rb
@@ -83,14 +74,26 @@ files:
 - lib/eac_templates/patches/object.rb
 - lib/eac_templates/patches/object/erb_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/config_reader.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/sources.rb
+- lib/eac_templates/sources/directory.rb
+- lib/eac_templates/sources/file.rb
+- lib/eac_templates/sources/from_all_gems.rb
+- lib/eac_templates/sources/from_gem.rb
+- lib/eac_templates/sources/fs_object.rb
+- lib/eac_templates/sources/internal_set.rb
+- lib/eac_templates/sources/set.rb
+- lib/eac_templates/sources/single.rb
+- lib/eac_templates/variables.rb
+- lib/eac_templates/variables/directory.rb
+- lib/eac_templates/variables/file.rb
+- lib/eac_templates/variables/fs_object.rb
+- lib/eac_templates/variables/not_found_error.rb
+- lib/eac_templates/variables/providers.rb
+- lib/eac_templates/variables/providers/base.rb
+- lib/eac_templates/variables/providers/config_reader.rb
+- lib/eac_templates/variables/providers/entries_reader.rb
+- lib/eac_templates/variables/providers/generic.rb
+- lib/eac_templates/variables/providers/hash.rb
 - lib/eac_templates/version.rb
 homepage: 
 licenses: []

data/lib/eac_templates/directory.rb

@@ -1,108 +0,0 @@
-# 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

@@ -1,48 +0,0 @@
-# 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/from_all_gems.rb

@@ -1,4 +0,0 @@
-# frozen_string_literal: true
-
-require 'eac_templates/from_gem'
-::EacTemplates::FromGem.include_all

data/lib/eac_templates/from_gem.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-require 'eac_templates/searcher'
-
-module EacTemplates
-  class FromGem
-    class << self
-      def include_all(searcher = nil)
-        ::Gem::Specification.each { |gemspec| new(gemspec, searcher).include }
-      end
-    end
-
-    TEMPLATES_DIR_SUBPATH = 'template'
-
-    common_constructor :gemspec, :searcher, default: [nil] do
-      self.searcher ||= ::EacTemplates::Searcher.default
-    end
-
-    # @return [Boolean]
-    delegate :exist?, to: :path
-
-    # @return [Pathname]
-    def include
-      return nil unless exist?
-
-      searcher.included_paths << path
-      path
-    end
-
-    # @return [Pathname]
-    def path
-      gemspec.gem_dir.to_pathname.join(TEMPLATES_DIR_SUBPATH)
-    end
-  end
-end

data/lib/eac_templates/searcher.rb

@@ -1,53 +0,0 @@
-# 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

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

data/lib/eac_templates/variable_providers/base.rb

@@ -1,21 +0,0 @@
-# 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/config_reader.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-require 'eac_config/node'
-require 'eac_templates/variable_providers/base'
-
-module EacTemplates
-  module VariableProviders
-    class ConfigReader < ::EacTemplates::VariableProviders::Base
-      class << self
-        def accept?(variables_source)
-          return false unless variables_source.respond_to?(:entry)
-
-          entry = variables_source.entry(:any_value)
-          entry.respond_to?(:value) && entry.respond_to?(:found?)
-        end
-      end
-
-      def variable_exist?(name)
-        source.entry(name).found?
-      end
-
-      def variable_fetch(name)
-        source.entry(name).value
-      end
-    end
-  end
-end

data/lib/eac_templates/variable_providers/entries_reader.rb

@@ -1,23 +0,0 @@
-# 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

@@ -1,23 +0,0 @@
-# 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

@@ -1,27 +0,0 @@
-# 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/variable_providers.rb

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-require 'eac_ruby_utils/core_ext'
-
-module EacTemplates
-  module VariableProviders
-    require_sub __FILE__
-
-    PROVIDERS = %w[config_reader 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