ehbrs-tools 0.27.0 → 0.28.0

data/vendor/eac_templates/lib/eac_templates/directory.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+require 'eac_templates/file'
+
+module EacTemplates
+  class Directory
+    TEMPLATE_EXTNAME = '.template'
+
+    attr_reader :path
+
+    def initialize(path)
+      @path = path.is_a?(::Pathname) ? path : ::Pathname.new(path.to_s)
+    end
+
+    def apply(variables_source, directory)
+      TemplateNode.new(self, '.', directory, variables_source).apply
+    end
+
+    def child(subpath)
+      child_path = ::File.join(path, subpath)
+      return ::EacTemplates::File.new(child_path) if ::File.file?(child_path)
+      return ::EacTemplates::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
+
+    class TemplateNode
+      attr_reader :source_directory, :source_relative, :target_root_directory, :variables_source
+
+      def initialize(source_directory, source_relative, target_root_directory, variables_source)
+        @source_directory = source_directory
+        @source_relative = source_relative
+        @target_root_directory = target_root_directory
+        @variables_source = variables_source
+      end
+
+      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::File.new(source_absolute).apply_to_file(
+            variables_source, target_absolute
+          )
+        else
+          ::FileUtils.cp(source_absolute, target_absolute)
+        end
+      end
+
+      def child(entry)
+        TemplateNode.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/vendor/eac_templates/lib/eac_templates/file.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+require 'eac_templates/variable_providers'
+
+module EacTemplates
+  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::VariableProviders.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

data/vendor/eac_templates/lib/eac_templates/patches/module/erb_template.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'erb'
+
+class Module
+  def erb_template(subpath, binding_obj)
+    ::ERB.new(template.child(subpath).path.read).result(binding_obj)
+  end
+end

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

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

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

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/require_sub'
+::EacRubyUtils.require_sub __FILE__

data/vendor/eac_templates/lib/eac_templates/patches/object/erb_template.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'eac_templates/patches/module/erb_template'
+
+class Object
+  def erb_template(subpath, binding_obj = nil)
+    self.class.erb_template(subpath, binding_obj || binding)
+  end
+end

data/vendor/eac_templates/lib/eac_templates/patches/object/template.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'eac_templates/patches/module/template'
+
+class Object
+  def template
+    self.class.template
+  end
+end

data/vendor/eac_templates/lib/eac_templates/patches/object.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/require_sub'
+::EacRubyUtils.require_sub __FILE__

data/vendor/eac_templates/lib/eac_templates/patches.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/require_sub'
+::EacRubyUtils.require_sub __FILE__

data/vendor/eac_templates/lib/eac_templates/searcher.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/object/blank'
+require 'eac_templates/directory'
+require 'eac_templates/file'
+
+module EacTemplates
+  class Searcher
+    class << self
+      def default
+        @default ||= new
+      end
+    end
+
+    def template(subpath, required = true)
+      path = template_path(subpath)
+      if path.blank?
+        return nil unless required
+
+        raise_template_not_found(subpath)
+      end
+      return ::EacTemplates::File.new(path) if ::File.file?(path)
+      return ::EacTemplates::Directory.new(path) if ::File.directory?(path)
+
+      raise 'Invalid branching'
+    end
+
+    # @return The absolute path of template if found, +nil+ otherwise.
+    def template_path(subpath)
+      included_paths.each do |included_path|
+        r = search_template_in_included_path(included_path, subpath)
+        return r if r
+      end
+      nil
+    end
+
+    def included_paths
+      @included_paths ||= ::Set.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
+
+    def search_template_in_included_path(included_path, subpath)
+      path = ::File.join(included_path, subpath)
+      ::File.exist?(path) ? path : nil
+    end
+  end
+end

data/vendor/eac_templates/lib/eac_templates/variable_not_found_error.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module EacTemplates
+  class VariableNotFoundError < StandardError; end
+end

data/vendor/eac_templates/lib/eac_templates/variable_providers/base.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'eac_templates/variable_not_found_error'
+
+module EacTemplates
+  module VariableProviders
+    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

data/vendor/eac_templates/lib/eac_templates/variable_providers/config_reader.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'eac_config/node'
+require 'eac_templates/variable_providers/base'
+
+module EacTemplates
+  module VariableProviders
+    class ConfigReader < ::EacTemplates::VariableProviders::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

data/vendor/eac_templates/lib/eac_templates/variable_providers/entries_reader.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'eac_templates/variable_providers/base'
+
+module EacTemplates
+  module VariableProviders
+    class EntriesReader < ::EacTemplates::VariableProviders::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

data/vendor/eac_templates/lib/eac_templates/variable_providers/generic.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'eac_templates/variable_providers/base'
+
+module EacTemplates
+  module VariableProviders
+    class Generic < ::EacTemplates::VariableProviders::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

data/vendor/eac_templates/lib/eac_templates/variable_providers/hash.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'eac_templates/variable_providers/base'
+
+module EacTemplates
+  module VariableProviders
+    class Hash < ::EacTemplates::VariableProviders::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

data/vendor/eac_templates/lib/eac_templates/variable_providers.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module EacTemplates
+  module VariableProviders
+    require_sub __FILE__
+
+    PROVIDERS = %w[config_reader entries_reader hash generic].map do |name|
+      "eac_templates/variable_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

data/vendor/eac_templates/lib/eac_templates/version.rb

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

data/vendor/eac_templates/lib/eac_templates.rb

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

data/vendor/eac_templates/spec/lib/eac_templates/file_spec.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'eac_config/old_configs'
+require 'eac_templates/file'
+
+RSpec.describe ::EacTemplates::File do
+  let(:files_dir) { ::File.join(__dir__, 'file_spec_files') }
+  let(:source_path) { ::File.join(files_dir, 'source.template') }
+  let(:instance) { described_class.new(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/vendor/eac_templates/spec/lib/eac_templates/file_spec_files/expected_content

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

data/vendor/eac_templates/spec/lib/eac_templates/file_spec_files/source.template

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

data/vendor/eac_templates/spec/lib/eac_templates/searcher_spec.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'eac_templates/searcher'
+
+RSpec.describe ::EacTemplates::Searcher do
+  let(:files_dir) { ::File.join(__dir__, 'searcher_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
+    {
+      ::EacTemplates::Directory => %w[subdir1],
+      ::EacTemplates::File => %w[subdir1/file1.template subdir1/file2
+                                 subdir1/file3.template],
+      ::NilClass => %w[does_not_exist]
+    }.each do |klass, subpaths|
+      subpaths.each do |subpath|
+        context "when subpath is \"#{subpath}\"" do
+          it "returns a #{klass}'s instance" do
+            expect(instance.template(subpath, false)).to be_a(klass)
+          end
+        end
+      end
+    end
+  end
+end

data/vendor/eac_templates/spec/lib/eac_templates/searcher_spec_files/path1/subdir1/file1.template

@@ -0,0 +1 @@
+

data/vendor/eac_templates/spec/lib/eac_templates/searcher_spec_files/path1/subdir1/file2

@@ -0,0 +1 @@
+

data/vendor/eac_templates/spec/lib/eac_templates/searcher_spec_files/path2/subdir1/file3.template

@@ -0,0 +1 @@
+

data/vendor/eac_templates/spec/lib/object/template_spec.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require 'eac_templates/patches/object/template'
+
+RSpec.describe ::Object do
+  class MyStubWithTemplate # rubocop:disable RSpec/LeakyConstantDeclaration
+  end
+
+  let(:instance) { ::MyStubWithTemplate.new }
+  let(:templates_path) { ::File.join(__dir__, 'template_spec_files', 'path') }
+
+  before do
+    ::EacTemplates::Searcher.default.included_paths.add(templates_path)
+  end
+
+  after do
+    ::EacTemplates::Searcher.default.included_paths.delete(templates_path)
+  end
+
+  describe '#template' do
+    it { expect(instance.template).to be_a(::EacTemplates::File) }
+  end
+end

data/vendor/eac_templates/spec/lib/object/template_spec_files/path/my_stub_with_template

@@ -0,0 +1 @@
+

data/vendor/eac_templates/spec/rubocop_spec.rb

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

data/vendor/eac_templates/spec/spec_helper.rb

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

data/vendor/ehbrs_ruby_utils/lib/ehbrs_ruby_utils/core_ext.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+require 'eac_templates/patches'
+require 'ehbrs_ruby_utils/patches'

data/vendor/ehbrs_ruby_utils/lib/ehbrs_ruby_utils/fs/selected/build.rb

@@ -7,7 +7,7 @@ module EhbrsRubyUtils
   module Fs
     class Selected
       class Build
-        DEFAULT_TARGET_BASENAME_PROC = ::Proc.new { |basename| basename }
+        DEFAULT_TARGET_BASENAME_PROC = ::Proc.new { |path| path.basename.to_path }
 
         attr_reader :selected, :target_dir, :target_basename_proc
 

data/vendor/ehbrs_ruby_utils/lib/ehbrs_ruby_utils/fs/selected/build_file.rb

@@ -19,7 +19,7 @@ module EhbrsRubyUtils
         end
 
         def target_basename
-          build.target_basename_proc.call(path.basename.to_path)
+          build.target_basename_proc.call(path)
         end
       end
     end

data/vendor/ehbrs_ruby_utils/lib/ehbrs_ruby_utils/fs/selected.rb

@@ -16,8 +16,8 @@ module EhbrsRubyUtils
         self.options = self.class.lists.option.hash_keys_validate!(options)
       end
 
-      def build(target_dir)
-        ::EhbrsRubyUtils::Fs::Selected::Build.new(self, target_dir)
+      def build(target_dir, &directory_target_basename)
+        ::EhbrsRubyUtils::Fs::Selected::Build.new(self, target_dir, &directory_target_basename)
       end
 
       def filename

data/vendor/ehbrs_ruby_utils/lib/ehbrs_ruby_utils/music/lyrics_book/album.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'ehbrs_ruby_utils/core_ext'
+require 'ehbrs_ruby_utils/music/lyrics_book/resource'
+
+module EhbrsRubyUtils
+  module Music
+    class LyricsBook
+      class Album < ::EhbrsRubyUtils::Music::LyricsBook::Resource
+        enable_simple_cache
+
+        def book
+          parent
+        end
+
+        def first_previous
+          previous.if_present { |v| v.songs.last }
+        end
+
+        def valid?
+          songs.any?
+        end
+
+        def header_title
+          "#{songs.first.number}-#{songs.last.number} | #{artist} | #{title}"
+        end
+
+        def artist
+          songs.lazy.map { |v| v.tag.artist }.find(&:present?)
+        end
+
+        def title
+          songs.lazy.map { |v| v.tag.album }.find(&:present?)
+        end
+
+        def songs_uncached
+          ::EhbrsRubyUtils::Music::LyricsBook::Song.create_list(self, path.children)
+        end
+      end
+    end
+  end
+end