eac_templates 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc9aafcd773770ed687e7ba11baa553e5968e18c9f124f71a446430d387e18a5
-  data.tar.gz: '096625ceb82074fbf40278cb545602726e33848488b734fd4ff86ab199bc5637'
+  metadata.gz: 6760f4ce4cf38f54efeecca766e9c0871e8c25b2243f08a538456732c5f5ff83
+  data.tar.gz: 4bc5d3c58bf1a5e99f8bd577a75588caef089aad7d3f10d94d2659d1986a8baf
 SHA512:
-  metadata.gz: c42ec59495782f16ecba7f27a05a89fd096900baeb30745806bdb5262b8d5057d2100339cdf3f11ea7bd503a42567fef0bf489ba0a4e7dd25648b6da8d616512
-  data.tar.gz: 106e1e173c5adc5e448514009616f6760ae7053cc05e2c2aa44c35b3963dc14e28b1edbd3d2bf8cc124753337ab91808787b175fc89116fa852df967ee68e10e
+  metadata.gz: c15346833718e092f413eed81e1370bcbc61595ad0a935c985be8ecb37589b10941a6b2e952c7ab06a55c8bb590caaa60bf31801153307e107c07bc3060f5898
+  data.tar.gz: fa8ce19ec361c461f8d3182477bec458566cca407c21d647da4255b6dd06b86c60d75c4bfd29086633bad4084ed4915bd11487675fe3ed05e9ce9fed8bcc1532

data/lib/eac_templates/abstract/directory.rb

@@ -12,7 +12,7 @@ module EacTemplates
       delegate(*::EacTemplates::InterfaceMethods::DIRECTORY - %i[child chidren], to: :applier)
 
       # @param basename [Pathname]
-      # @return [EacTemplates::Abstract::FsObject
+      # @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)

data/lib/eac_templates/abstract/fs_object.rb

@@ -2,7 +2,7 @@
 
 require 'eac_ruby_utils/core_ext'
 require 'eac_templates/abstract/fs_object_by_pathname'
-require 'eac_templates/abstract/not_found_error'
+require 'eac_templates/errors/not_found'
 
 module EacTemplates
   module Abstract
@@ -72,7 +72,7 @@ module EacTemplates
       end
 
       def raise_not_found(message)
-        raise ::EacTemplates::Abstract::NotFoundError, message
+        raise ::EacTemplates::Errors::NotFound, message
       end
 
       # @return [EacTemplates::Sources::Set]

data/lib/eac_templates/abstract/with_directory_file_methods.rb

@@ -1,10 +1,14 @@
 # frozen_string_literal: true
 
-require 'eac_templates/abstract/not_found_error'
+require 'eac_templates/errors/not_found'
 
 module EacTemplates
   module Abstract
     module WithDirectoryFileMethods
+      common_concern do
+        enable_simple_cache
+      end
+
       def build_fs_object(type)
         fs_object_class(type).by_subpath(self, nil, subpath, source_set: source_set)
       end
@@ -15,14 +19,24 @@ module EacTemplates
         subpath.if_present(child_basename) { |v| v.join(child_basename) }.to_pathname
       end
 
-      # @return [EacTemplates::Abstract::Directory]
-      def directory
-        build_fs_object(:directory)
+      # @return [Boolean]
+      def directory?
+        directory.found?
       end
 
-      # @return [EacTemplates::Abstract::File]
-      def file
-        build_fs_object(:file)
+      # @return [Boolean]
+      def file?
+        file.found?
+      end
+
+      # @return [Boolean]
+      def file_template?
+        file? && file.template?
+      end
+
+      # @return [Boolean]
+      def found?
+        directory? || file?
       end
 
       # @param type [Symbol]
@@ -33,13 +47,22 @@ module EacTemplates
 
       # @return [EacTemplates::Abstract::Directory, EacTemplates::Abstract::File]
       def sub_fs_object
-        file_search = file
-        return file_search if file_search.found?
+        return file if file.found?
+        return directory if directory.found?
+
+        raise ::EacTemplates::Errors::NotFound, "No template found: #{self}"
+      end
 
-        directory_search = directory
-        return directory_search if directory_search.found?
+      private
 
-        raise ::EacTemplates::Abstract::NotFoundError, "No template found: #{self}"
+      # @return [EacTemplates::Abstract::Directory]
+      def directory_uncached
+        build_fs_object(:directory)
+      end
+
+      # @return [EacTemplates::Abstract::File]
+      def file_uncached
+        build_fs_object(:file)
       end
     end
   end

data/lib/eac_templates/{abstract/not_found_error.rb → errors/not_found.rb}

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

data/lib/eac_templates/errors/type_mismatch.rb

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

data/lib/eac_templates/errors.rb

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

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

@@ -10,7 +10,27 @@ module EacTemplates
     class Ancestor
       class Directory < ::EacTemplates::Abstract::Directory
         include ::EacTemplates::Modules::Ancestor::FsObject
-        delegate :children_basenames, to: :source_object
+        delegate :found?, :path, to: :source_object
+
+        # @return [Hash<Pathname, Symbol>]
+        def children_basenames
+          source_object.children_basenames.to_h { |k, v| parse_child_basename(k, v) }
+        end
+
+        protected
+
+        # @param basename [Pathname]
+        # @param type [Symbol]
+        # @return [Array]
+        def parse_child_basename(basename, type)
+          return [basename, type] unless type == :file
+
+          new_basename = ::EacTemplates::Modules::Ancestor::File.parse_basename(basename)
+
+          return [basename, type] if new_basename == basename
+
+          [new_basename, :file_template]
+        end
       end
     end
   end

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

@@ -10,6 +10,54 @@ module EacTemplates
     class Ancestor
       class File < ::EacTemplates::Abstract::File
         include ::EacTemplates::Modules::Ancestor::FsObject
+
+        TEMPLATE_EXTNAME_PATTERN =
+          /#{::Regexp.quote(::EacTemplates::Variables::FsObject::TEMPLATE_EXTNAME)}\z/.freeze
+
+        class << self
+          def parse_basename(basename)
+            basename.if_present do |v|
+              v.to_pathname
+                .to_path
+                .gsub(TEMPLATE_EXTNAME_PATTERN, '')
+                .to_pathname
+            end
+          end
+        end
+
+        # @return [Boolean]
+        def found?
+          source_object.found? || template?
+        end
+
+        # @return [Pathname]
+        def path
+          template? ? template_source_object.path : source_object.path
+        end
+
+        # @return [Pathname]
+        def basename
+          self.class.parse_basename(super)
+        end
+
+        # @return [Boolean]
+        def template?
+          template_source_object.found?
+        end
+
+        protected
+
+        # @return [EacTemplates::Sources::File]
+        def template_source_object_uncached
+          owner.source_set.send(type, template_source_object_path_for_search)
+        end
+
+        # @return [Pathname]
+        def template_source_object_path_for_search
+          path_for_search.basename_sub do |b|
+            "#{b}#{::EacTemplates::Variables::FsObject::TEMPLATE_EXTNAME}"
+          end
+        end
       end
     end
   end

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

@@ -7,8 +7,6 @@ module EacTemplates
   module Modules
     class Ancestor
       module FsObject
-        delegate :found?, :path, to: :source_object
-
         # @return [Pathname]
         delegate :path_for_search, to: :owner
 

data/lib/eac_templates/modules/ancestor.rb

@@ -19,7 +19,7 @@ module EacTemplates
 
       common_constructor :base, :ancestor
       delegate :subpath, :source_set, to: :base
-      delegate(*::EacTemplates::InterfaceMethods::ALL, to: :sub_fs_object)
+      delegate(*::EacTemplates::InterfaceMethods::ALL + [:children_basenames], to: :sub_fs_object)
 
       def ancestor_path_for_search
         self.class.path_for_search(ancestor)

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

@@ -10,15 +10,28 @@ module EacTemplates
     class Base
       class Directory < ::EacTemplates::Abstract::Directory
         include ::EacTemplates::Modules::Base::FsObject
-        delegate(*(EacTemplates::InterfaceMethods::DIRECTORY - %i[children]), to: :self_ancestor)
+        delegate(*(EacTemplates::InterfaceMethods::DIRECTORY - %i[apply child children]),
+                 to: :self_ancestor)
 
-        # @param basename [Pathname]
-        # @return [EacTemplates::Abstract::FsObject]
-        delegate :child, to: :owner
+        # @param variables_source [Object]
+        # @param target_path [Pathname]
+        def apply(variables_source, target_path)
+          target_path = target_path.to_pathname
+          target_path.mkpath
+          children.each do |child|
+            child_apply(child, variables_source, target_path.join(child.basename))
+          end
+        end
+
+        # @!method build_child(child_basename, child_type)
+        #   @param child_basename [Pathname]
+        #   @param child_type [Symbol]
+        #   @return [EacTemplates::Modules::Base]
+        delegate :build_child, to: :owner
 
         # @return [Hash<Pathname, Symbol>]
         def children_basenames
-          owner.ancestors.each_with_object({}) do |e, a|
+          owner.ancestors.select(&:directory?).each_with_object({}) do |e, a|
             ancestor_children_names(e, a)
           end
         end
@@ -34,10 +47,25 @@ module EacTemplates
         # @param result [Hash<Pathname, Symbol>]
         # @return [void]
         def ancestor_children_names(ancestor, result)
-          ancestor.directory.source_object.children_basenames.each do |path, type|
+          ancestor.children_basenames.each do |path, type|
             result[path] = type
           end
         end
+
+        # @param child [EacTemplates::Modules::Base]
+        # # @param variables_source [Object]
+        # @param target_path [Pathname]
+        def child_apply(child, variables_source, target_path)
+          if child.directory?
+            child.apply(variables_source, target_path)
+          elsif child.file_template?
+            child.apply_to_file(variables_source, target_path)
+          elsif child.file?
+            ::FileUtils.cp(child.path, target_path)
+          else
+            ibr
+          end
+        end
       end
     end
   end

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

@@ -10,7 +10,11 @@ module EacTemplates
     class Base
       class File < ::EacTemplates::Abstract::File
         include ::EacTemplates::Modules::Base::FsObject
-        delegate(*EacTemplates::InterfaceMethods::FILE, to: :ancestor_found)
+        delegate(*EacTemplates::InterfaceMethods::FILE + [:template?], to: :ancestor_found)
+
+        def basename
+          ancestor_found.if_present(&:basename)
+        end
 
         def found?
           ancestor_found.present?

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

@@ -10,8 +10,6 @@ module EacTemplates
         def self_ancestor
           owner.self_ancestor.send(type)
         end
-
-        delegate :found?, to: :self_ancestor
       end
     end
   end

data/lib/eac_templates/modules/base.rb

@@ -5,6 +5,7 @@ require 'eac_templates/interface_methods'
 require 'eac_templates/abstract/with_directory_file_methods'
 require 'eac_templates/modules/ancestor'
 require 'eac_templates/sources/set'
+require 'eac_templates/errors/type_mismatch'
 
 module EacTemplates
   module Modules
@@ -18,19 +19,20 @@ module EacTemplates
       end
       delegate(*::EacTemplates::InterfaceMethods::ONLY_DIRECTORY, to: :directory)
       delegate(*::EacTemplates::InterfaceMethods::ONLY_FILE, to: :file)
-      delegate(*::EacTemplates::InterfaceMethods::COMMON, :path_for_search, :source_object,
-               to: :sub_fs_object)
+      delegate(*::EacTemplates::InterfaceMethods::COMMON, :basename, :path_for_search,
+               :source_object, :type, to: :sub_fs_object)
 
-      # @param basename [Pathname]
-      # @return [EacTemplates::Abstract::FsObject]
-      def child(basename)
+      # @param child_basename [Pathname]
+      # @param child_type [Symbol]
+      # @return [EacTemplates::Modules::Base]
+      def build_child(child_basename, child_type)
         r = ::EacTemplates::Modules::Base.new(
-          the_module, subpath: child_subpath(basename), source_set: source_set
+          the_module, subpath: child_subpath(child_basename), source_set: source_set
         )
-        return r if r.found?
+        return r.validate_type(child_type) if r.found?
 
-        raise ::EacTemplates::Abstract::NotFoundError,
-              "No child for #{self} found with basename \"#{basename}\""
+        raise ::EacTemplates::Errors::NotFound,
+              "No child for #{self} found with basename \"#{child_basename}\""
       end
 
       # @return [Boolean]
@@ -48,6 +50,21 @@ module EacTemplates
         options[OPTION_SUBPATH].if_present(&:to_pathname)
       end
 
+      # @return [String]
+      def to_s
+        "#{self.class}[#{the_module.name}#\"#{subpath}\"]"
+      end
+
+      # @param required_type [Symbol]
+      # @return [self]
+      # @raise [EacTemplates::Errors::TypeMismatch]
+      def validate_type(required_type)
+        return self if valid_type?(required_type)
+
+        raise ::EacTemplates::Errors::TypeMismatch, "A #{required_type} type was expected, but a " \
+                                                    "#{type} was builded"
+      end
+
       private
 
       # @return [Enumerable<EacTemplates::Modules::Ancestor>]
@@ -60,6 +77,16 @@ module EacTemplates
         ancestors.find { |a| a.ancestor == the_module } || ibr
       end
 
+      # @return [Boolean]
+      def valid_type?(required_type)
+        file_types = %i[file file_template]
+        if file_types.include?(required_type)
+          file_types.include?(type)
+        else
+          type == required_type
+        end
+      end
+
       require_sub __FILE__
     end
   end

data/lib/eac_templates/sources/fs_object.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'eac_ruby_utils/core_ext'
-require 'eac_templates/abstract/not_found_error'
+require 'eac_templates/errors/not_found'
 
 module EacTemplates
   module Sources

data/lib/eac_templates/sources/set.rb

@@ -4,7 +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'
+require 'eac_templates/errors/not_found'
 
 module EacTemplates
   module Sources
@@ -47,7 +47,7 @@ module EacTemplates
       private
 
       def raise_template_not_found(subpath)
-        raise ::EacTemplates::Abstract::NotFoundError,
+        raise ::EacTemplates::Errors::NotFound,
               'Template not found for subpath ' \
               "\"#{subpath}\" (Included paths: #{included_paths.to_a.join(::File::PATH_SEPARATOR)})"
       end

data/lib/eac_templates/variables/directory.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'eac_templates/abstract/not_found_error'
+require 'eac_templates/errors/not_found'
 require 'eac_templates/abstract/directory'
 require 'eac_templates/variables/file'
 require 'eac_templates/variables/fs_object'
@@ -22,7 +22,7 @@ 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 ::EacTemplates::Abstract::NotFoundError,
+        raise ::EacTemplates::Errors::NotFound,
               "Child \"#{subpath}\" from \"#{path}\" not found"
       end
 

data/lib/eac_templates/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: eac_templates
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Put here the authors
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-05-18 00:00:00.000000000 Z
+date: 2024-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eac_config
@@ -44,6 +44,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.122'
+- !ruby/object:Gem::Dependency
+  name: eac_fs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
 - !ruby/object:Gem::Dependency
   name: eac_ruby_gem_support
   requirement: !ruby/object:Gem::Requirement
@@ -69,9 +83,11 @@ files:
 - 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/abstract/with_directory_file_methods.rb
 - lib/eac_templates/core_ext.rb
+- lib/eac_templates/errors.rb
+- lib/eac_templates/errors/not_found.rb
+- lib/eac_templates/errors/type_mismatch.rb
 - lib/eac_templates/interface_methods.rb
 - lib/eac_templates/modules.rb
 - lib/eac_templates/modules/ancestor.rb