eac_templates 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63916b49b6fe5333356bcfa18ed5b3118fb784ffad1ba65d14312a2eafad7a54
-  data.tar.gz: 0a5e61d751f1bf2194f24623c958134f36f27548bbe0b6e956fe1c80e0f0d024
+  metadata.gz: 4693c8bc468202051ac7c3ea070b1c3d11d29de84f009caa168a11a5dd85bb7a
+  data.tar.gz: b247d9ce2cb2b5959e9a3f18a7f9f6ddd62e2ce21c7d8a47001ecc1f67527d14
 SHA512:
-  metadata.gz: df42a3b2ec8c86b5b71d0f9713c56e04efa9b8da6533c9858debb610bc1a2a4be6d15dd970ff2b52f10cfc2c18850cfaa1762951b69737a22f7befe0045b7e34
-  data.tar.gz: 299b5c3aa4ac068d4c598990e41d367c8803cd47fed01a7efa8e49f8372fea4acd20d8b03a7dc4da9394949e87e204d839c39ce03de61b7e39cd7647c22092d3
+  metadata.gz: 8742d8c59890381772209cbbda1c7b5aa07145279c3eb37767c786be91b13a5a403b36f85b00e33157b63d4b39f8d6f5e2142ece147235da20546a4c83d3bfe5
+  data.tar.gz: 8d8269d321709f68bfa6adee7cda5969076cf26688b7f0265fac48f985e3efb16590aff6f0b80eee9ef38192ccc07986029ca67fbbae3d24250f8e9906814ca3

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 = %w[apply path].freeze
+    ONLY_DIRECTORY = %w[child children].freeze
+    DIRECTORY = COMMON + ONLY_DIRECTORY
+    ONLY_FILE = %w[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,15 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+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)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+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)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+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)
+
+        # @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
+        end
+
+        private
+
+        def source_object_uncached
+          base.source_set.send(object_type, base.path_for_search)
+        end
+      end
+    end
+  end
+end

data/lib/eac_templates/modules/ancestor.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+require 'eac_templates/interface_methods'
+
+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
+        ::EacTemplates::Modules::Ancestor::Directory.new(self)
+      end
+
+      # @return [EacTemplates::Modules::File]
+      def file
+        @file ||= ::EacTemplates::Modules::Ancestor::File.new(self)
+      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 "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,24 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+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
+
+      # @return [Class]
+      def applier_class
+        ::EacTemplates::Variables::Directory
+      end
+
+      # @param path [Pathname]
+      # @return [Boolean]
+      def select_path?(path)
+        super && path.directory?
+      end
+    end
+  end
+end

data/lib/eac_templates/sources/file.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+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
+    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'
+
+module EacTemplates
+  module Sources
+    class FsObject
+      enable_abstract_methods
+      enable_simple_cache
+      common_constructor :source_set, :subpath do
+        self.subpath = subpath.to_pathname
+      end
+
+      # @return [Boolean]
+      def found?
+        real_paths.any?
+      end
+
+      protected
+
+      # @return [Class]
+      def applier_class
+        raise_abstract_method __method__
+      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)
+      end
+
+      # @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?
+      end
+
+      # @param source_single [EacTemplates::Sources::Single]
+      # @return [Pathname, nil]
+      def source_single_search(source_single)
+        r = source_single.search(subpath)
+        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,54 @@
+# 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'
+
+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.new(self, subpath)
+      end
+
+      # @param subpath [Pathname]
+      # @return [EacTemplates::Sources::Directory]
+      def file(subpath)
+        ::EacTemplates::Sources::File.new(self, subpath)
+      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 "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

data/lib/eac_templates/variables/directory.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+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)
+      end
+
+      def apply(variables_source, directory)
+        ::EacTemplates::Variables::FsObject.new(self, '.', directory, variables_source).apply
+      end
+
+      def child(subpath)
+        child_path = ::File.join(path, subpath)
+        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"
+      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
+    end
+  end
+end

data/lib/eac_templates/variables/file.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+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))
+      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
+end

data/lib/eac_templates/variables/fs_object.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require 'eac_templates/variables/file'
+
+module EacTemplates
+  module Variables
+    class FsObject
+      TEMPLATE_EXTNAME = '.template'
+
+      common_constructor :source_directory, :source_relative, :target_root_directory,
+                         :variables_source
+
+      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::Variables::File.new(source_absolute).apply_to_file(
+            variables_source, target_absolute
+          )
+        else
+          ::FileUtils.cp(source_absolute, target_absolute)
+        end
+      end
+
+      def child(entry)
+        self.class.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/variables/not_found_error.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module EacTemplates
+  module Variables
+    class NotFoundError < StandardError; end
+  end
+end

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'eac_templates/variables/not_found_error'
+
+module EacTemplates
+  module Variables
+    module Providers
+      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
+end