eac_templates 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4693c8bc468202051ac7c3ea070b1c3d11d29de84f009caa168a11a5dd85bb7a
-  data.tar.gz: b247d9ce2cb2b5959e9a3f18a7f9f6ddd62e2ce21c7d8a47001ecc1f67527d14
+  metadata.gz: a7a7b07116547967179751347b5600225f96205ee1b1da0fc7bb35d795439fdc
+  data.tar.gz: 04cbf8ec7ee2fd753d25a171925bf1d45f61850c2c0ae5f794894f1494be60c6
 SHA512:
-  metadata.gz: 8742d8c59890381772209cbbda1c7b5aa07145279c3eb37767c786be91b13a5a403b36f85b00e33157b63d4b39f8d6f5e2142ece147235da20546a4c83d3bfe5
-  data.tar.gz: 8d8269d321709f68bfa6adee7cda5969076cf26688b7f0265fac48f985e3efb16590aff6f0b80eee9ef38192ccc07986029ca67fbbae3d24250f8e9906814ca3
+  metadata.gz: 003734ea51a3c498ee9a49413c0d59a08f48be07183b88491f283eee82cae5beae103a307eb1e7d4c98cfb48c8c720cdf0f4c1b32ebf7ea5861de76d4aeeed16
+  data.tar.gz: 48876f4adbbb31f1e34d1593b931c5ac6c62b3525cd626c05aecb1a64adc7eacde058fb46a6a74038de2b3de0a0b866b4c9ba6199f7cde355856fb48e59f831d

data/lib/eac_templates/abstract/directory.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+require 'eac_templates/interface_methods'
+require 'eac_templates/abstract/fs_object'
+require 'eac_templates/variables/directory'
+
+module EacTemplates
+  module Abstract
+    class Directory < ::EacTemplates::Abstract::FsObject
+      enable_abstract_methods
+      delegate(*::EacTemplates::InterfaceMethods::DIRECTORY - %i[child chidren], to: :applier)
+
+      # @param basename [Pathname]
+      # @return [EacTemplates::Abstract::FsObject
+      def build_child(child_basename, child_type)
+        child_basename = child_basename.to_pathname
+        child_type = type_list.value_validate!(child_type)
+        category_module.const_get(child_type.to_s.camelize)
+          .new(owner, self, child_basename, options)
+      end
+
+      # @param basename [Pathname]
+      # @return [EacTemplates::Abstract::FsObject]
+      def child(basename)
+        basename = basename.to_pathname
+        children.find { |c| c.basename == basename } ||
+          raise_not_found("No child found with basename \"#{basename}\"")
+      end
+
+      # @return [Enumerable<EacTemplates::Abstract::FsObject>]
+      def children
+        children_basenames.map { |c_basename, c_type| build_child(c_basename, c_type) }
+      end
+
+      # @return [Hash<Pathname, Symbol>]
+      def children_basenames
+        raise_abstract_method __method__
+      end
+    end
+  end
+end

data/lib/eac_templates/abstract/file.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+require 'eac_templates/interface_methods'
+require 'eac_templates/abstract/fs_object'
+require 'eac_templates/variables/file'
+
+module EacTemplates
+  module Abstract
+    class File < ::EacTemplates::Abstract::FsObject
+      enable_abstract_methods
+      delegate(*::EacTemplates::InterfaceMethods::FILE - %i[content path], to: :applier)
+
+      # @return [String]
+      def content
+        path.read
+      end
+
+      # @return [Pathname]
+      def path
+        raise_abstract_method __method__
+      end
+    end
+  end
+end

data/lib/eac_templates/abstract/fs_object.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+require 'eac_templates/abstract/fs_object_by_pathname'
+require 'eac_templates/abstract/not_found_error'
+
+module EacTemplates
+  module Abstract
+    class FsObject
+      class << self
+        # @param obj [Object]
+        # @return [EacTemplates::Abstract::FsObject, EacTemplates::Abstracts::FsObjectByPathname]
+        def assert(obj)
+          if obj.is_a?(self)
+            obj
+          else
+            ::EacTemplates::Abstract::FsObjectByPathname.new(obj)
+          end
+        end
+
+        # @param owner [Object]
+        # @param parent_object [Object, nil]
+        # @param subpath [Pathname]
+        # @return [EacTemplates::Abstract::FsObject]
+        def by_subpath(owner, parent_object, subpath, options = {})
+          r = nil
+          subpath.to_pathname.each_filename do |basename|
+            r = new(owner, parent_object, basename, options)
+            parent_object = r
+          end
+          r || raise("Subpath is empty: #{subpath}")
+        end
+      end
+
+      enable_abstract_methods
+      enable_simple_cache
+      enable_listable
+      lists.add_symbol :option, :source_set
+      lists.add_symbol :type, :directory, :file
+      common_constructor :owner, :parent_object, :basename, :options, default: [{}] do
+        self.basename = basename.present? ? basename.to_pathname : ::Pathname.new('')
+        self.options = ::EacTemplates::Abstract::FsObject.lists.option.hash_keys_validate!(options)
+      end
+
+      # @return [EacTemplates::Variables::Directory, EacTemplates::Variables::File]
+      def applier
+        applier_class.new(self)
+      end
+
+      # @return [Class]
+      def applier_class
+        ::EacTemplates::Variables.const_get(type.to_s.camelize)
+      end
+
+      # @return [Module]
+      def category_module
+        self.class.module_parent
+      end
+
+      # @return [Pathname]
+      def path_for_search
+        if parent_object.present?
+          parent_object.path_for_search.join(basename)
+        else
+          path_for_search_prefix.join(basename)
+        end
+      end
+
+      # @return [Pathname]
+      def path_for_search_prefix
+        raise_abstract_method __method__
+      end
+
+      def raise_not_found(message)
+        raise ::EacTemplates::Abstract::NotFoundError, message
+      end
+
+      # @return [EacTemplates::Sources::Set]
+      def source_set
+        options[OPTION_SOURCE_SET] || ::EacTemplates::Sources::Set.default
+      end
+
+      # @return [Symbol]
+      def type
+        type_list.value_validate!(self.class.name.demodulize.underscore.to_sym)
+      end
+
+      # @return [EacRubyUtils::Listable::SymbolList]
+      def type_list
+        ::EacTemplates::Abstract::FsObject.lists.type
+      end
+    end
+  end
+end

data/lib/eac_templates/abstract/fs_object_by_pathname.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module EacTemplates
+  module Abstract
+    class FsObjectByPathname
+      common_constructor :path do
+        self.path = path.to_pathname
+      end
+    end
+  end
+end

data/lib/eac_templates/abstract/not_found_error.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module EacTemplates
+  module Abstract
+    class NotFoundError < ::RuntimeError
+    end
+  end
+end

data/lib/eac_templates/interface_methods.rb

@@ -2,10 +2,10 @@
 
 module EacTemplates
   module InterfaceMethods
-    COMMON = %w[apply path].freeze
-    ONLY_DIRECTORY = %w[child children].freeze
+    COMMON = %i[apply path].freeze
+    ONLY_DIRECTORY = %i[child children].freeze
     DIRECTORY = COMMON + ONLY_DIRECTORY
-    ONLY_FILE = %w[apply_to_file content variables].freeze
+    ONLY_FILE = %i[apply_to_file content variables].freeze
     FILE = COMMON + ONLY_FILE
     ALL = COMMON + ONLY_DIRECTORY + ONLY_FILE
   end

data/lib/eac_templates/modules/ancestor/directory.rb

@@ -1,14 +1,16 @@
 # frozen_string_literal: true
 
 require 'eac_ruby_utils/core_ext'
+require 'eac_templates/abstract/directory'
 require 'eac_templates/interface_methods'
 require 'eac_templates/modules/ancestor/fs_object'
 
 module EacTemplates
   module Modules
     class Ancestor
-      class Directory < ::EacTemplates::Modules::Ancestor::FsObject
-        delegate(*::EacTemplates::InterfaceMethods::ONLY_DIRECTORY, to: :source_object)
+      class Directory < ::EacTemplates::Abstract::Directory
+        include ::EacTemplates::Modules::Ancestor::FsObject
+        delegate :children_basenames, to: :source_object
       end
     end
   end

data/lib/eac_templates/modules/ancestor/file.rb

@@ -1,14 +1,15 @@
 # frozen_string_literal: true
 
 require 'eac_ruby_utils/core_ext'
+require 'eac_templates/abstract/file'
 require 'eac_templates/interface_methods'
 require 'eac_templates/modules/ancestor/fs_object'
 
 module EacTemplates
   module Modules
     class Ancestor
-      class File < ::EacTemplates::Modules::Ancestor::FsObject
-        delegate(*::EacTemplates::InterfaceMethods::ONLY_FILE, to: :source_object)
+      class File < ::EacTemplates::Abstract::File
+        include ::EacTemplates::Modules::Ancestor::FsObject
       end
     end
   end

data/lib/eac_templates/modules/ancestor/fs_object.rb

@@ -6,25 +6,18 @@ require 'eac_templates/interface_methods'
 module EacTemplates
   module Modules
     class Ancestor
-      class FsObject
-        enable_simple_cache
-        common_constructor :base
-        delegate(*::EacTemplates::InterfaceMethods::COMMON, :found?, to: :source_object)
+      module FsObject
+        delegate :found?, :path, to: :source_object
 
-        # @return [Symbol]
-        def object_type
-          self.class.name.demodulize.underscore.to_sym
-        end
-
-        # @return [Pathname, nil]
-        def path
-          source_object.found? ? source_object.send(:real_paths).first : nil
+        # @return [Pathname]
+        def path_for_search_prefix
+          owner.path_for_search
         end
 
         private
 
         def source_object_uncached
-          base.source_set.send(object_type, base.path_for_search)
+          owner.source_set.send(type, path_for_search)
         end
       end
     end

data/lib/eac_templates/modules/ancestor.rb

@@ -2,6 +2,7 @@
 
 require 'eac_ruby_utils/core_ext'
 require 'eac_templates/interface_methods'
+require 'eac_templates/abstract/not_found_error'
 
 module EacTemplates
   module Modules
@@ -20,12 +21,14 @@ module EacTemplates
 
       # @return [EacTemplates::Modules::Directory]
       def directory
-        ::EacTemplates::Modules::Ancestor::Directory.new(self)
+        @directory ||= ::EacTemplates::Modules::Ancestor::Directory
+                         .new(self, nil, nil, source_set: source_set)
       end
 
       # @return [EacTemplates::Modules::File]
       def file
-        @file ||= ::EacTemplates::Modules::Ancestor::File.new(self)
+        @file ||= ::EacTemplates::Modules::Ancestor::File
+                    .new(self, nil, nil, source_set: source_set)
       end
 
       # @return [Pathname]
@@ -39,7 +42,7 @@ module EacTemplates
         return file if file.found?
         return directory if directory.found?
 
-        raise "No template found: #{path_for_search}"
+        raise ::EacTemplates::Abstract::NotFoundError, "No template found: #{path_for_search}"
       end
 
       require_sub __FILE__

data/lib/eac_templates/sources/directory.rb

@@ -1,23 +1,36 @@
 # frozen_string_literal: true
 
 require 'eac_ruby_utils/core_ext'
+require 'eac_templates/abstract/directory'
 require 'eac_templates/sources/fs_object'
-require 'eac_templates/variables/directory'
 
 module EacTemplates
   module Sources
-    class Directory < ::EacTemplates::Sources::FsObject
-      delegate :apply, :child, :children, :path, to: :applier
+    class Directory < ::EacTemplates::Abstract::Directory
+      include ::EacTemplates::Sources::FsObject
 
-      # @return [Class]
-      def applier_class
-        ::EacTemplates::Variables::Directory
+      # @return [Hash<Pathname, Symbol>]
+      def children_basenames
+        r = {}
+        real_paths.each do |real_path|
+          real_path.children.each do |child|
+            next if r.key?(child.basename)
+
+            r[child.basename] = real_path_type(child)
+          end
+        end
+        r
       end
 
-      # @param path [Pathname]
-      # @return [Boolean]
-      def select_path?(path)
-        super && path.directory?
+      # @return [Pathname]
+      def real_path_type(path)
+        if path.file?
+          :file
+        elsif path.directory?
+          :directory
+        else
+          raise "Path \"#{path}\" is not a file nor a directory"
+        end
       end
     end
   end

data/lib/eac_templates/sources/file.rb

@@ -1,24 +1,13 @@
 # frozen_string_literal: true
 
 require 'eac_ruby_utils/core_ext'
+require 'eac_templates/abstract/file'
 require 'eac_templates/sources/fs_object'
-require 'eac_templates/variables/file'
 
 module EacTemplates
   module Sources
-    class File < ::EacTemplates::Sources::FsObject
-      delegate :apply, :apply_to_file, :content, :path, :variables, to: :applier
-
-      # @return [Class]
-      def applier_class
-        ::EacTemplates::Variables::File
-      end
-
-      # @param path [Pathname]
-      # @return [Boolean]
-      def select_path?(path)
-        super && path.file?
-      end
+    class File < ::EacTemplates::Abstract::File
+      include ::EacTemplates::Sources::FsObject
     end
   end
 end

data/lib/eac_templates/sources/fs_object.rb

@@ -1,14 +1,16 @@
 # frozen_string_literal: true
 
 require 'eac_ruby_utils/core_ext'
+require 'eac_templates/abstract/not_found_error'
 
 module EacTemplates
   module Sources
-    class FsObject
-      enable_abstract_methods
-      enable_simple_cache
-      common_constructor :source_set, :subpath do
-        self.subpath = subpath.to_pathname
+    module FsObject
+      PATH_FOR_SEARCH_PREFIX = ::Pathname.new('')
+
+      common_concern do
+        enable_abstract_methods
+        enable_simple_cache
       end
 
       # @return [Boolean]
@@ -16,20 +18,18 @@ module EacTemplates
         real_paths.any?
       end
 
-      protected
-
-      # @return [Class]
-      def applier_class
-        raise_abstract_method __method__
+      # @return [Pathname]
+      def path
+        real_paths.first
       end
 
-      # @return [EacTemplates::Variables::SourceFile]
-      def applier_uncached
-        raise "No #{self.class.name.downcase} found for \"#{subpath}\"" unless found?
-
-        applier_class.new(real_paths.first)
+      # @return [Pathname]
+      def path_for_search_prefix
+        PATH_FOR_SEARCH_PREFIX
       end
 
+      protected
+
       # @return [Array<Pathname>]
       def real_paths_uncached
         source_set.included_paths.lazy.map { |source_single| source_single_search(source_single) }
@@ -39,13 +39,13 @@ module EacTemplates
       # @param path [Pathname]
       # @return [Boolean]
       def select_path?(path)
-        path.present?
+        path.present? && path.send("#{type}?")
       end
 
       # @param source_single [EacTemplates::Sources::Single]
       # @return [Pathname, nil]
       def source_single_search(source_single)
-        r = source_single.search(subpath)
+        r = source_single.search(path_for_search)
         select_path?(r) ? r : nil
       end
     end

data/lib/eac_templates/sources/set.rb

@@ -4,6 +4,7 @@ require 'active_support/core_ext/object/blank'
 require 'eac_templates/sources/directory'
 require 'eac_templates/sources/file'
 require 'eac_templates/sources/internal_set'
+require 'eac_templates/abstract/not_found_error'
 
 module EacTemplates
   module Sources
@@ -17,13 +18,13 @@ module EacTemplates
       # @param subpath [Pathname]
       # @return [EacTemplates::Sources::Directory]
       def directory(subpath)
-        ::EacTemplates::Sources::Directory.new(self, subpath)
+        ::EacTemplates::Sources::Directory.by_subpath(self, nil, subpath, source_set: self)
       end
 
       # @param subpath [Pathname]
       # @return [EacTemplates::Sources::Directory]
       def file(subpath)
-        ::EacTemplates::Sources::File.new(self, subpath)
+        ::EacTemplates::Sources::File.by_subpath(self, nil, subpath, source_set: self)
       end
 
       def template(subpath, required = true)
@@ -46,8 +47,8 @@ module EacTemplates
       private
 
       def raise_template_not_found(subpath)
-        raise "Template not found for subpath \"#{subpath}\"" \
-          " (Included paths: #{included_paths.to_a.join(::File::PATH_SEPARATOR)})"
+        raise ::EacTemplates::Abstract::NotFoundError, 'Template not found for subpath ' \
+          "\"#{subpath}\" (Included paths: #{included_paths.to_a.join(::File::PATH_SEPARATOR)})"
       end
     end
   end

data/lib/eac_templates/variables/content.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+require 'eac_templates/variables/providers'
+
+module EacTemplates
+  module Variables
+    class Content
+      VARIABLE_DELIMITER = ::Regexp.quote('%%')
+      VARIABLE_PATTERN = /#{VARIABLE_DELIMITER}([a-z0-9\._]*)#{VARIABLE_DELIMITER}/i.freeze
+
+      class << self
+        # @param path [Pathname]
+        # @return [EacTemplates::Variables::Content]
+        def from_file(path)
+          new(path.to_pathname.read)
+        end
+      end
+
+      enable_simple_cache
+      common_constructor :content
+
+      # +variables_provider+ A [Hash] or object which responds to +read_entry(entry_name)+.
+      def apply(variables_source)
+        variables_provider = ::EacTemplates::Variables::Providers.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 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
+end

data/lib/eac_templates/variables/directory.rb

@@ -1,16 +1,17 @@
 # frozen_string_literal: true
 
+require 'eac_templates/abstract/not_found_error'
+require 'eac_templates/abstract/directory'
 require 'eac_templates/variables/file'
 require 'eac_templates/variables/fs_object'
 
 module EacTemplates
   module Variables
     class Directory
-      attr_reader :path
-
-      def initialize(path)
-        @path = path.is_a?(::Pathname) ? path : ::Pathname.new(path.to_s)
+      common_constructor :abstract_directory do
+        self.abstract_directory = ::EacTemplates::Abstract::Directory.assert(abstract_directory)
       end
+      delegate :path, to: :abstract_directory
 
       def apply(variables_source, directory)
         ::EacTemplates::Variables::FsObject.new(self, '.', directory, variables_source).apply
@@ -21,7 +22,8 @@ module EacTemplates
         return ::EacTemplates::Variables::File.new(child_path) if ::File.file?(child_path)
         return ::EacTemplates::Variables::Directory.new(child_path) if ::File.directory?(child_path)
 
-        raise "Child \"#{subpath}\" from \"#{path}\" not found"
+        raise ::EacTemplates::Abstract::NotFoundError,
+              "Child \"#{subpath}\" from \"#{path}\" not found"
       end
 
       def children

data/lib/eac_templates/variables/file.rb

@@ -1,49 +1,25 @@
 # frozen_string_literal: true
 
 require 'eac_ruby_utils/core_ext'
+require 'eac_templates/abstract/file'
+require 'eac_templates/variables/content'
 require 'eac_templates/variables/providers'
 
 module EacTemplates
   module Variables
     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::Variables::Providers.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))
+      common_constructor :abstract_file do
+        self.abstract_file = ::EacTemplates::Abstract::File.assert(abstract_file)
       end
+      delegate :path, to: :abstract_file
+      delegate :apply, :apply_to_file, :content, :variables, to: :content_applier
 
       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
+      # @return [EacTemplates::Variables::Content]
+      def content_applier_uncached
+        ::EacTemplates::Variables::Content.from_file(path)
       end
     end
   end

data/lib/eac_templates/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eac_templates
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Put here the authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-30 00:00:00.000000000 Z
+date: 2023-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eac_config
@@ -59,6 +59,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/eac_templates.rb
+- lib/eac_templates/abstract/directory.rb
+- lib/eac_templates/abstract/file.rb
+- lib/eac_templates/abstract/fs_object.rb
+- lib/eac_templates/abstract/fs_object_by_pathname.rb
+- lib/eac_templates/abstract/not_found_error.rb
 - lib/eac_templates/core_ext.rb
 - lib/eac_templates/interface_methods.rb
 - lib/eac_templates/modules.rb
@@ -84,6 +89,7 @@ files:
 - lib/eac_templates/sources/set.rb
 - lib/eac_templates/sources/single.rb
 - lib/eac_templates/variables.rb
+- lib/eac_templates/variables/content.rb
 - lib/eac_templates/variables/directory.rb
 - lib/eac_templates/variables/file.rb
 - lib/eac_templates/variables/fs_object.rb