eac_templates 0.3.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63916b49b6fe5333356bcfa18ed5b3118fb784ffad1ba65d14312a2eafad7a54
-  data.tar.gz: 0a5e61d751f1bf2194f24623c958134f36f27548bbe0b6e956fe1c80e0f0d024
+  metadata.gz: a7a7b07116547967179751347b5600225f96205ee1b1da0fc7bb35d795439fdc
+  data.tar.gz: 04cbf8ec7ee2fd753d25a171925bf1d45f61850c2c0ae5f794894f1494be60c6
 SHA512:
-  metadata.gz: df42a3b2ec8c86b5b71d0f9713c56e04efa9b8da6533c9858debb610bc1a2a4be6d15dd970ff2b52f10cfc2c18850cfaa1762951b69737a22f7befe0045b7e34
-  data.tar.gz: 299b5c3aa4ac068d4c598990e41d367c8803cd47fed01a7efa8e49f8372fea4acd20d8b03a7dc4da9394949e87e204d839c39ce03de61b7e39cd7647c22092d3
+  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/core_ext.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 
 require 'eac_templates/patches'
-require 'eac_templates/from_all_gems'
+require 'eac_templates/sources/from_all_gems'

data/lib/eac_templates/interface_methods.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module EacTemplates
+  module InterfaceMethods
+    COMMON = %i[apply path].freeze
+    ONLY_DIRECTORY = %i[child children].freeze
+    DIRECTORY = COMMON + ONLY_DIRECTORY
+    ONLY_FILE = %i[apply_to_file content variables].freeze
+    FILE = COMMON + ONLY_FILE
+    ALL = COMMON + ONLY_DIRECTORY + ONLY_FILE
+  end
+end

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

@@ -0,0 +1,17 @@
+# 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::Abstract::Directory
+        include ::EacTemplates::Modules::Ancestor::FsObject
+        delegate :children_basenames, to: :source_object
+      end
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+# 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::Abstract::File
+        include ::EacTemplates::Modules::Ancestor::FsObject
+      end
+    end
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+require 'eac_templates/interface_methods'
+
+module EacTemplates
+  module Modules
+    class Ancestor
+      module FsObject
+        delegate :found?, :path, to: :source_object
+
+        # @return [Pathname]
+        def path_for_search_prefix
+          owner.path_for_search
+        end
+
+        private
+
+        def source_object_uncached
+          owner.source_set.send(type, path_for_search)
+        end
+      end
+    end
+  end
+end

data/lib/eac_templates/modules/ancestor.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+require 'eac_templates/interface_methods'
+require 'eac_templates/abstract/not_found_error'
+
+module EacTemplates
+  module Modules
+    class Ancestor
+      class << self
+        # @param a_module [Module]
+        # @return [Pathname]
+        def path_for_search(a_module)
+          a_module.name.underscore.to_pathname
+        end
+      end
+
+      common_constructor :base, :ancestor
+      delegate :subpath, :source_set, to: :base
+      delegate(*::EacTemplates::InterfaceMethods::ALL, to: :source_object)
+
+      # @return [EacTemplates::Modules::Directory]
+      def directory
+        @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, nil, nil, source_set: source_set)
+      end
+
+      # @return [Pathname]
+      def path_for_search
+        r = self.class.path_for_search(ancestor)
+        subpath.if_present(r) { |v| r.join(v) }
+      end
+
+      # @return [EacTemplates::Modules::Ancestor::FsObject]
+      def source_object
+        return file if file.found?
+        return directory if directory.found?
+
+        raise ::EacTemplates::Abstract::NotFoundError, "No template found: #{path_for_search}"
+      end
+
+      require_sub __FILE__
+    end
+  end
+end

data/lib/eac_templates/modules/base.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+require 'eac_templates/interface_methods'
+require 'eac_templates/modules/ancestor'
+require 'eac_templates/sources/set'
+
+module EacTemplates
+  module Modules
+    class Base
+      enable_listable
+      lists.add_symbol :option, :source_set, :subpath
+      common_constructor :the_module, :options, default: [{}] do
+        self.options = self.class.lists.option.hash_keys_validate!(options)
+      end
+      delegate(*::EacTemplates::InterfaceMethods::ALL, :path_for_search, :source_object,
+               to: :self_ancestor)
+
+      # @return [EacTemplates::Modules::Ancestor]
+      def self_ancestor
+        @self_ancestor ||= ::EacTemplates::Modules::Ancestor.new(self, the_module)
+      end
+
+      # @return [EacTemplates::SourceSet]
+      def source_set
+        options[OPTION_SOURCE_SET] || ::EacTemplates::Sources::Set.default
+      end
+
+      # @return [Pathname, nil]
+      def subpath
+        options[OPTION_SUBPATH].if_present(&:to_pathname)
+      end
+    end
+  end
+end

data/lib/eac_templates/modules.rb

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

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

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

data/lib/eac_templates/sources/directory.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+require 'eac_templates/abstract/directory'
+require 'eac_templates/sources/fs_object'
+
+module EacTemplates
+  module Sources
+    class Directory < ::EacTemplates::Abstract::Directory
+      include ::EacTemplates::Sources::FsObject
+
+      # @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
+
+      # @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
+end

data/lib/eac_templates/sources/file.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+require 'eac_templates/abstract/file'
+require 'eac_templates/sources/fs_object'
+
+module EacTemplates
+  module Sources
+    class File < ::EacTemplates::Abstract::File
+      include ::EacTemplates::Sources::FsObject
+    end
+  end
+end

data/lib/eac_templates/sources/from_all_gems.rb

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

data/lib/eac_templates/sources/from_gem.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require 'eac_templates/sources/set'
+
+module EacTemplates
+  module Sources
+    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::Sources::Set.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
+end

data/lib/eac_templates/sources/fs_object.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+require 'eac_templates/abstract/not_found_error'
+
+module EacTemplates
+  module Sources
+    module FsObject
+      PATH_FOR_SEARCH_PREFIX = ::Pathname.new('')
+
+      common_concern do
+        enable_abstract_methods
+        enable_simple_cache
+      end
+
+      # @return [Boolean]
+      def found?
+        real_paths.any?
+      end
+
+      # @return [Pathname]
+      def path
+        real_paths.first
+      end
+
+      # @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) }
+          .select(&:present?)
+      end
+
+      # @param path [Pathname]
+      # @return [Boolean]
+      def select_path?(path)
+        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(path_for_search)
+        select_path?(r) ? r : nil
+      end
+    end
+  end
+end

data/lib/eac_templates/sources/internal_set.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+require 'eac_templates/sources/single'
+
+module EacTemplates
+  module Sources
+    class InternalSet < ::Set
+      # @param single [EacTemplates::Sources::Single]
+      # @return [self]
+      def add(single)
+        super(::EacTemplates::Sources::Single.assert(single))
+      end
+
+      # @param single [EacTemplates::Sources::Single]
+      # @return [self]
+      def <<(single)
+        add(single)
+      end
+    end
+  end
+end

data/lib/eac_templates/sources/set.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+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
+    class Set
+      class << self
+        def default
+          @default ||= new
+        end
+      end
+
+      # @param subpath [Pathname]
+      # @return [EacTemplates::Sources::Directory]
+      def directory(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.by_subpath(self, nil, subpath, source_set: self)
+      end
+
+      def template(subpath, required = true)
+        found_file = file(subpath)
+        return found_file if found_file.found?
+
+        found_directory = directory(subpath)
+        return found_directory if found_directory.found?
+
+        return nil unless required
+
+        raise_template_not_found(subpath)
+      end
+
+      # @return [EacTemplates::Sources::InternalSet]
+      def included_paths
+        @included_paths ||= ::EacTemplates::Sources::InternalSet.new
+      end
+
+      private
+
+      def raise_template_not_found(subpath)
+        raise ::EacTemplates::Abstract::NotFoundError, 'Template not found for subpath ' \
+          "\"#{subpath}\" (Included paths: #{included_paths.to_a.join(::File::PATH_SEPARATOR)})"
+      end
+    end
+  end
+end

data/lib/eac_templates/sources/single.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module EacTemplates
+  module Sources
+    class Single
+      class << self
+        # @param object [EacTemplates::Sources::Single, Pathname]
+        # @return [EacTemplates::Sources::Single]
+        def assert(object)
+          return object if object.is_a?(self)
+
+          new(object.to_pathname)
+        end
+      end
+
+      common_constructor :path do
+        self.path = path.to_pathname.expand_path
+      end
+
+      # @return [Pathname, nil]
+      def search(subpath)
+        r = path.join(subpath)
+        r.exist? ? r : nil
+      end
+    end
+  end
+end

data/lib/eac_templates/sources.rb

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