eac_tools 0.89.0 → 0.90.0

data/sub/eac_templates/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/sub/eac_templates/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/sub/eac_templates/lib/eac_templates/variables/providers/base.rb

@@ -0,0 +1,24 @@
+# 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 ::EacTemplates::Variables::NotFoundError,
+                "Variable \"#{name}\" not found in #{source}"
+        end
+      end
+    end
+  end
+end

data/sub/eac_templates/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/sub/eac_templates/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/sub/eac_templates/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/sub/eac_templates/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/sub/eac_templates/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/sub/{avm/lib/avm/entries.rb → eac_templates/lib/eac_templates/variables.rb}

@@ -2,8 +2,8 @@
 
 require 'eac_ruby_utils/core_ext'
 
-module Avm
-  module Entries
+module EacTemplates
+  module Variables
     require_sub __FILE__
   end
 end

data/sub/eac_templates/lib/eac_templates/version.rb

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

data/sub/{avm/lib/avm.rb → eac_templates/lib/eac_templates.rb}

@@ -2,6 +2,6 @@
 
 require 'eac_ruby_utils/core_ext'
 
-module Avm
+module EacTemplates
   require_sub __FILE__
 end

data/sub/eac_templates/spec/lib/eac_templates/modules/base_spec.rb

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+require 'eac_templates/modules/base'
+require 'eac_templates/abstract/not_found_error'
+require 'eac_templates/sources/set'
+
+RSpec.describe EacTemplates::Modules::Base do
+  def self.on_node_specs(node_name, &block)
+    context "when object is \"#{node_name}\"" do
+      let(:node) { send(node_name) }
+
+      instance_eval(&block)
+    end
+  end
+
+  def self.dir_specs(node_name, expected_children)
+    on_node_specs(node_name) do
+      it do
+        expect(node.children.map { |child| child.basename.to_path }.sort).to(
+          eq(expected_children.sort)
+        )
+      end
+    end
+  end
+
+  def self.file_specs_ok(node_name, expected_content, expected_apply, # rubocop:disable Metrics/AbcSize
+                         expected_variables)
+    on_node_specs(node_name) do
+      it { expect(node.content).to eq(expected_content) }
+      it { expect(node.variables).to eq(Set.new(expected_variables)) }
+      it { expect(node.apply(variables_source)).to eq(expected_apply) }
+
+      it do
+        target_file = temp_file
+        node.apply_to_file(variables_source, target_file)
+        expect(target_file.read).to eq(expected_apply)
+      end
+    end
+  end
+
+  def self.file_specs_error(node_name)
+    on_node_specs(node_name) do
+      it do
+        expect { node }.to raise_error(EacTemplates::Abstract::NotFoundError)
+      end
+    end
+  end
+
+  let(:a_module) do
+    Module.new do
+      def self.name
+        'AModule'
+      end
+    end
+  end
+  let(:super_class) do
+    r = Class.new do
+      def self.name
+        'SuperClass'
+      end
+    end
+    r.include a_module
+    r
+  end
+  let(:prepended_module) do
+    Module.new do
+      def self.name
+        'PrependedModule'
+      end
+    end
+  end
+  let(:sub_class) do
+    r = Class.new(super_class) do
+      def self.name
+        'SubClass'
+      end
+    end
+    r.prepend(prepended_module)
+    r
+  end
+  let(:files_dir) { __dir__.to_pathname.join('base_spec_files') }
+  let(:variables_source) { { vx: '_X_', vy: '_Y_' } }
+  let(:source_set) do
+    r = EacTemplates::Sources::Set.new
+    %w[path1 path2].each do |sub|
+      r.included_paths << files_dir.join(sub)
+    end
+    r
+  end
+
+  let(:a) { instance.child('a') }
+  let(:a_a) { a.child('a_a') }
+  let(:a_b) { a.child('a_b') }
+  let(:a_c) { a.child('a_c') }
+  let(:b) { instance.child('b') }
+  let(:c) { instance.child('c') }
+
+  context 'when module is AModule' do # rubocop:disable RSpec/EmptyExampleGroup
+    let(:instance) { described_class.new(a_module, source_set: source_set) }
+
+    dir_specs(:a, %w[a_a a_b])
+    file_specs_ok(:a_a, "A_MODULE_A_A\n", "A_MODULE_A_A\n", [])
+    file_specs_ok(:a_b, "A_MODULE_A_B\n", "A_MODULE_A_B\n", [])
+    file_specs_error(:a_c)
+    file_specs_ok(:b, "A_MODULE_B%%vy%%\n", "A_MODULE_B_Y_\n", %w[vy])
+    file_specs_ok(:c, "A_MODULE_C%%vx%%\n", "A_MODULE_C_X_\n", %w[vx])
+  end
+
+  context 'when module is SuperClass' do # rubocop:disable RSpec/EmptyExampleGroup
+    let(:instance) { described_class.new(super_class, source_set: source_set) }
+
+    dir_specs(:a, %w[a_a a_b])
+    file_specs_ok(:a_a, "A_MODULE_A_A\n", "A_MODULE_A_A\n", [])
+    file_specs_ok(:a_b, "SUPER_CLASS_A_B\n", "SUPER_CLASS_A_B\n", [])
+    file_specs_error(:a_c)
+    file_specs_ok(:b, "SUPER_CLASS_B\n", "SUPER_CLASS_B\n", [])
+    file_specs_ok(:c, "A_MODULE_C%%vx%%\n", "A_MODULE_C_X_\n", %w[vx])
+  end
+
+  context 'when module is SubClass' do # rubocop:disable RSpec/EmptyExampleGroup
+    let(:instance) { described_class.new(sub_class, source_set: source_set) }
+
+    dir_specs(:a, %w[a_a a_b a_c])
+    file_specs_ok(:a_a, "A_MODULE_A_A\n", "A_MODULE_A_A\n", [])
+    file_specs_ok(:a_b, "SUPER_CLASS_A_B\n", "SUPER_CLASS_A_B\n", [])
+    file_specs_ok(:a_c, "SUB_CLASS_A_C\n", "SUB_CLASS_A_C\n", [])
+    file_specs_ok(:b, "SUB_CLASS_B\n", "SUB_CLASS_B\n", [])
+    file_specs_ok(:c, "PREPENDED_MODULE_C%%vy%%%%vx%%\n", "PREPENDED_MODULE_C_Y__X_\n", %w[vy vx])
+  end
+
+  context 'when module is PrependedModule' do # rubocop:disable RSpec/EmptyExampleGroup
+    let(:instance) { described_class.new(prepended_module, source_set: source_set) }
+
+    file_specs_error(:a)
+    file_specs_error(:a_a)
+    file_specs_error(:a_b)
+    file_specs_error(:a_c)
+    file_specs_error(:b)
+    file_specs_ok(:c, "PREPENDED_MODULE_C%%vy%%%%vx%%\n", "PREPENDED_MODULE_C_Y__X_\n", %w[vy vx])
+  end
+end

data/sub/eac_templates/spec/lib/eac_templates/modules/base_spec_files/path1/a_module/a/a_a

@@ -0,0 +1 @@
+A_MODULE_A_A

data/sub/eac_templates/spec/lib/eac_templates/modules/base_spec_files/path1/a_module/b

@@ -0,0 +1 @@
+A_MODULE_B%%vy%%

data/sub/eac_templates/spec/lib/eac_templates/modules/base_spec_files/path1/sub_class/a/a_c

@@ -0,0 +1 @@
+SUB_CLASS_A_C

data/sub/eac_templates/spec/lib/eac_templates/modules/base_spec_files/path1/super_class/a/a_b

@@ -0,0 +1 @@
+SUPER_CLASS_A_B

data/sub/eac_templates/spec/lib/eac_templates/modules/base_spec_files/path1/super_class/b

@@ -0,0 +1 @@
+SUPER_CLASS_B

data/sub/eac_templates/spec/lib/eac_templates/modules/base_spec_files/path2/a_module/a/a_b

@@ -0,0 +1 @@
+A_MODULE_A_B

data/sub/eac_templates/spec/lib/eac_templates/modules/base_spec_files/path2/a_module/b

@@ -0,0 +1 @@
+A_MODULE_B

data/sub/eac_templates/spec/lib/eac_templates/modules/base_spec_files/path2/a_module/c

@@ -0,0 +1 @@
+A_MODULE_C%%vx%%

data/sub/eac_templates/spec/lib/eac_templates/modules/base_spec_files/path2/prepended_module/c

@@ -0,0 +1 @@
+PREPENDED_MODULE_C%%vy%%%%vx%%

data/sub/eac_templates/spec/lib/eac_templates/modules/base_spec_files/path2/sub_class/b

@@ -0,0 +1 @@
+SUB_CLASS_B

data/sub/eac_templates/spec/lib/eac_templates/modules/base_spec_files/path2/super_class/a/a_b

@@ -0,0 +1 @@
+SUPER_CLASS_A_B_PATH_2

data/sub/eac_templates/spec/lib/eac_templates/modules/base_spec_files/path2/super_class/b

@@ -0,0 +1 @@
+SUB_CLASS_B

data/sub/eac_templates/spec/lib/eac_templates/patches/object/template_spec.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'eac_templates/interface_methods'
+require 'eac_templates/patches/object/template'
+
+RSpec.describe Object, '#template' do
+  class MyStubWithTemplate # rubocop:disable Lint/ConstantDefinitionInBlock, Lint/EmptyClass, RSpec/LeakyConstantDeclaration
+  end
+
+  let(:instance) { MyStubWithTemplate.new }
+  let(:templates_path) { File.join(__dir__, 'template_spec_files', 'path') }
+
+  before do
+    EacTemplates::Sources::Set.default.included_paths.add(templates_path)
+  end
+
+  after do
+    EacTemplates::Sources::Set.default.included_paths.delete(templates_path)
+  end
+
+  describe '#template' do
+    EacTemplates::InterfaceMethods::FILE.each do |method_name|
+      it { expect(instance.template).to respond_to(method_name) }
+    end
+  end
+end

data/sub/eac_templates/spec/lib/eac_templates/patches/object/template_spec_files/path/my_stub_with_template

@@ -0,0 +1 @@
+

data/sub/eac_templates/spec/lib/eac_templates/sources/set_spec.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'eac_templates/interface_methods'
+require 'eac_templates/sources/set'
+
+RSpec.describe EacTemplates::Sources::Set do
+  let(:files_dir) { File.join(__dir__, 'set_spec_files') }
+  let(:instance) do
+    r = described_class.new
+    r.included_paths << File.join(files_dir, 'path1')
+    r.included_paths << File.join(files_dir, 'path2')
+    r
+  end
+
+  describe '#template' do
+    {
+      'subdir1' => :directory,
+      'subdir1/file1.template' => :file,
+      'subdir1/file2' => :file,
+      'subdir1/file3.template' => :file,
+      'does_not_exist' => :nil
+    }.each do |subpath, type|
+      context "when subpath is \"#{subpath}\"" do
+        let(:result) { instance.template(subpath, false) }
+
+        case type
+        when :nil
+          it { expect(result).to be_nil }
+        when :directory
+          EacTemplates::InterfaceMethods::DIRECTORY.each do |method_name|
+            it { expect(result).to respond_to(method_name) } # rubocop:disable RSpec/RepeatedExample
+          end
+        when :file
+          EacTemplates::InterfaceMethods::FILE.each do |method_name|
+            it { expect(result).to respond_to(method_name) } # rubocop:disable RSpec/RepeatedExample
+          end
+        else ibr
+        end
+      end
+    end
+  end
+end

data/sub/eac_templates/spec/lib/eac_templates/sources/set_spec_files/path1/subdir1/file1.template

@@ -0,0 +1 @@
+

data/sub/eac_templates/spec/lib/eac_templates/sources/set_spec_files/path1/subdir1/file2

@@ -0,0 +1 @@
+

data/sub/eac_templates/spec/lib/eac_templates/sources/set_spec_files/path2/subdir1/file3.template

@@ -0,0 +1 @@
+

data/sub/eac_templates/spec/lib/eac_templates/variables/content_spec.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'eac_config/old_configs'
+require 'eac_templates/variables/file'
+
+RSpec.describe EacTemplates::Variables::Content do
+  let(:files_dir) { File.join(__dir__, 'content_spec_files').to_pathname }
+  let(:source_path) { files_dir.join('source.template') }
+  let(:instance) { described_class.from_file(source_path) }
+  let(:expected_content) { File.read(File.join(files_dir, 'expected_content')) }
+
+  describe '#apply' do
+    context 'when config is a hash' do
+      let(:config) { { name: 'Fulano de Tal', age: 33 } }
+
+      it { expect(instance.apply(config)).to eq(expected_content) }
+    end
+
+    context 'when config responds to read_entry' do
+      let(:config) { EacConfig::OldConfigs.new('rspec_describe_eac_ruby_utils_templates_file') }
+
+      before do
+        config.clear
+        config['name'] = 'Fulano de Tal'
+        config['age'] = '33'
+      end
+
+      it { expect(instance.apply(config)).to eq(expected_content) }
+    end
+  end
+
+  describe '#variables' do
+    it { expect(instance.variables).to eq(Set.new(%w[name age])) }
+  end
+end

data/sub/eac_templates/spec/lib/eac_templates/variables/content_spec_files/expected_content

@@ -0,0 +1,2 @@
+Name: Fulano de Tal
+Age: 33

data/sub/eac_templates/spec/lib/eac_templates/variables/content_spec_files/source.template

@@ -0,0 +1,2 @@
+Name: %%NAME%%
+Age: %%AGE%%

data/sub/eac_templates/spec/rubocop_spec.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+EacRubyUtils::Rspec.default_setup.describe_rubocop

data/sub/{avm → eac_templates}/spec/spec_helper.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
 
 require 'eac_ruby_utils/rspec/default_setup'
-EacRubyUtils::Rspec.default_setup_create(File.expand_path('..', __dir__)).stub_avm_contexts
-EacRubyUtils.require_sub(__FILE__)
+EacRubyUtils::Rspec.default_setup_create(File.expand_path('..', __dir__))