ehbrs-tools 0.25.0 → 0.28.0

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/ehbrs_ruby_utils.gemspec

@@ -12,10 +12,15 @@ Gem::Specification.new do |s|
   s.authors     = ['Eduardo H. Bogoni']
   s.summary     = 'Utilities for EHB/RS\'s Ruby projects.'
 
-  s.files = Dir['{lib}/**/*']
+  s.files = Dir['{lib,template}/**/*']
+  s.test_files = Dir['{spec}/**/*', '.rubocop.yml', '.rspec']
 
+  s.add_dependency 'aranha-parsers', '~> 0.8', '>= 0.8.5'
+  s.add_dependency 'avm', '~> 0.3', '>= 0.3.2'
   s.add_dependency 'eac_ruby_utils', '~> 0.70'
   s.add_dependency 'eac_templates', '~> 0.1', '>= 0.1.1'
+  s.add_dependency 'taglib-ruby', '~> 1.1'
+  s.add_dependency 'ultimate_lyrics', '~> 0.1'
 
   s.add_development_dependency 'aranha-parsers', '~> 0.8'
   s.add_development_dependency 'eac_ruby_gem_support', '~> 0.3'

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/{lib/ehbrs → vendor/ehbrs_ruby_utils/lib/ehbrs_ruby_utils}/fs/compressed_package.rb

@@ -3,7 +3,7 @@
 require 'avm/files/info'
 require 'eac_ruby_utils/core_ext'
 
-module Ehbrs
+module EhbrsRubyUtils
   module Fs
     class CompressedPackage < ::Avm::Files::Info
       MIME_TYPES = {

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

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+require 'ehbrs_ruby_utils/fs/selected/build_file'
+
+module EhbrsRubyUtils
+  module Fs
+    class Selected
+      class Build
+        DEFAULT_TARGET_BASENAME_PROC = ::Proc.new { |path| path.basename.to_path }
+
+        attr_reader :selected, :target_dir, :target_basename_proc
+
+        def initialize(selected, target_dir, &target_basename_proc)
+          @selected = selected
+          @target_dir = target_dir.to_pathname
+          @target_basename_proc = target_basename_proc.presence || DEFAULT_TARGET_BASENAME_PROC
+        end
+
+        def perform
+          clear_target_dir
+          link_selected_found
+        end
+
+        private
+
+        def clear_target_dir
+          target_dir.children.each do |c|
+            c.unlink if c.symlink? && c.directory?
+          end
+        end
+
+        def link_selected_found
+          selected.found.each do |found|
+            ::EhbrsRubyUtils::Fs::Selected::BuildFile.new(self, found).perform
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module EhbrsRubyUtils
+  module Fs
+    class Selected
+      class BuildFile
+        common_constructor :build, :path do
+          self.path = path.to_pathname
+        end
+
+        def perform
+          target_path.make_symlink(path)
+        end
+
+        def target_path
+          build.target_dir.join(target_basename)
+        end
+
+        def target_basename
+          build.target_basename_proc.call(path)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module EhbrsRubyUtils
+  module Fs
+    class Selected
+      require_sub __FILE__
+      DEFAULT_FILENAME = '.selected'
+
+      enable_listable
+      enable_simple_cache
+      lists.add_symbol :option, :filename, :target_name_builder
+      common_constructor :root_path, :options, default: [{}] do
+        self.root_path = root_path.to_pathname
+        self.options = self.class.lists.option.hash_keys_validate!(options)
+      end
+
+      def build(target_dir, &directory_target_basename)
+        ::EhbrsRubyUtils::Fs::Selected::Build.new(self, target_dir, &directory_target_basename)
+      end
+
+      def filename
+        options[OPTION_FILENAME].if_present(DEFAULT_FILENAME)
+      end
+
+      private
+
+      # @return [Pathname]
+      def found_uncached
+        root_path.glob("**/#{filename}").map(&:parent).sort
+      end
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module EhbrsRubyUtils
+  # Filesystem utilities.
+  module Fs
+    require_sub __FILE__
+  end
+end

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

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

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require 'ehbrs_ruby_utils/core_ext'
+
+module EhbrsRubyUtils
+  module Music
+    class LyricsBook
+      class Resource
+        class << self
+          def create_list(parent, files)
+            r = files.sort.map { |path| new(parent, path) }.select(&:valid?)
+            previous = parent.first_previous
+            r.map do |e|
+              e.reset_cache
+              e.previous = previous
+              previous = e
+            end
+          end
+        end
+
+        enable_simple_cache
+        include ::Comparable
+        common_constructor :parent, :path
+        attr_accessor :previous
+
+        def filename
+          path.relative_path_from(parent.path)
+        end
+
+        def <=>(other)
+          path <=> other.path
+        end
+
+        def link_to_header
+          "<a href=\"\##{header_id}\" id=\"#{index_id}\">#{header_title}</a>"
+        end
+
+        def index_id
+          "index_#{header_id}"
+        end
+
+        def header_id
+          header_title.variableize
+        end
+
+        def header_index
+          parent.header_index + 1
+        end
+
+        def output_main
+          ::EhbrsRubyUtils::Music::LyricsBook::Resource.erb_template('main.html.erb', binding)
+        end
+
+        def output_index
+          erb_template('index.html.erb')
+        end
+
+        def type
+          self.class.name.demodulize.underscore
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,68 @@
+# 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 Song < ::EhbrsRubyUtils::Music::LyricsBook::Resource
+        enable_simple_cache
+        delegate :book, to: :album
+        delegate :provider, to: :book
+        delegate :tag, :to_s, to: :container
+
+        def album
+          parent
+        end
+
+        def lyrics
+          fetch_lyrics unless lyrics_cached?
+          cached_lyrics
+        end
+
+        def valid?
+          tag.present?
+        end
+
+        def lyrics_cached?
+          lyrics_cache.cached?
+        end
+
+        def cached_lyrics
+          ::YAML.load_file(lyrics_cache.content_path)
+        end
+
+        def header_title
+          "#{number} - #{title}"
+        end
+
+        delegate :title, to: :tag
+
+        private
+
+        def container_uncached
+          ::EhbrsRubyUtils::Videos::Container.new(path)
+        end
+
+        def fetch_lyrics
+          lyrics = fetched_lyrics
+          lyrics_cache.write(lyrics.to_yaml)
+        end
+
+        def fetched_lyrics
+          container.lyrics_by_provider(provider)
+        end
+
+        def lyrics_cache
+          (%w[artist album title].map { |k| tag.send(k) } + [provider.identifier])
+            .inject(fs_cache) { |a, e| a.child(e) }
+        end
+
+        def number_uncached
+          previous.if_present(0, &:number) + 1
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require 'ehbrs_ruby_utils/core_ext'
+
+module EhbrsRubyUtils
+  module Music
+    class LyricsBook
+      require_sub __FILE__
+
+      DEFAULT_PROVIDER_NAME = 'lyrics.com'
+      DEFAULT_TITLE = 'Letras de músicas'
+
+      enable_listable
+      lists.add_symbol :option, :provider_name, :title
+      enable_simple_cache
+      common_constructor :source_dir, :options, default: [{}] do
+        self.source_dir = source_dir.to_pathname
+        self.options = self.class.lists.option.hash_keys_validate!(options)
+      end
+
+      def first_previous
+        nil
+      end
+
+      def header_index
+        1
+      end
+
+      def output
+        erb_template('main.html.erb')
+      end
+
+      def path
+        source_dir
+      end
+
+      def title
+        options[OPTION_TITLE].if_present(DEFAULT_TITLE)
+      end
+
+      private
+
+      def albums_directories_uncached
+        r = []
+        t = ::EacRubyUtils::Fs::Traverser.new
+        t.recursive = true
+        t.check_directory = ->(directory) { r << directory }
+        t.check_path(source_dir)
+        r
+      end
+
+      def albums_uncached
+        ::EhbrsRubyUtils::Music::LyricsBook::Album.create_list(self, albums_directories)
+      end
+
+      def provider_uncached
+        ::UltimateLyrics::Provider.by_name(provider_name)
+      end
+
+      def provider_name
+        options[OPTION_PROVIDER_NAME].if_present(DEFAULT_PROVIDER_NAME)
+      end
+    end
+  end
+end

data/{lib/ehbrs/fs.rb → vendor/ehbrs_ruby_utils/lib/ehbrs_ruby_utils/music.rb}

@@ -2,8 +2,8 @@
 
 require 'eac_ruby_utils/core_ext'
 
-module Ehbrs
-  module Fs
+module EhbrsRubyUtils
+  module Music
     require_sub __FILE__
   end
 end

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

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

data/vendor/ehbrs_ruby_utils/lib/ehbrs_ruby_utils/patches.rb

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

data/vendor/ehbrs_ruby_utils/lib/ehbrs_ruby_utils/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module EhbrsRubyUtils
-  VERSION = '0.8.0'
+  VERSION = '0.12.0'
 end

data/vendor/ehbrs_ruby_utils/lib/ehbrs_ruby_utils/videos/container.rb

@@ -4,23 +4,49 @@ require 'eac_ruby_utils/core_ext'
 require 'ehbrs_ruby_utils/executables'
 require 'ehbrs_ruby_utils/videos/stream'
 require 'json'
+require 'taglib'
+require 'ultimate_lyrics/provider_search'
+require 'ultimate_lyrics/song_metadata'
 
 module EhbrsRubyUtils
   module Videos
     class Container
+      class << self
+        def from_file(path)
+          new(path)
+        end
+      end
+
       enable_simple_cache
       common_constructor :path do
         self.path = path.to_pathname
       end
 
+      delegate :tag, to: :tag_file
+      delegate :to_s, to: :path
+
       ::EhbrsRubyUtils::Videos::Stream.lists.codec_type.each_value do |stream_type|
         define_method stream_type.to_s.pluralize do
           streams.select { |stream| stream.codec_type == stream_type }
         end
       end
 
+      # @param provider [UltimateLyrics::Provider]
+      # @return [UltimateLyrics::Lyrics]
+      def lyrics_by_provider(provider)
+        ::UltimateLyrics::ProviderSearch.new(provider, song_metadata).lyrics
+      end
+
       private
 
+      # @return [UltimateLyrics::SongMetadata]
+      def song_metadata_uncached
+        ::UltimateLyrics::SongMetadata.new(
+          ::UltimateLyrics::SongMetadata::Field.lists.sources.values
+          .map { |source| [source, tag.send(source)] }.to_h
+        )
+      end
+
       def probe_data_uncached
         ::JSON.parse(
           ::EhbrsRubyUtils::Executables.ffprobe.command(
@@ -34,6 +60,11 @@ module EhbrsRubyUtils
           ::EhbrsRubyUtils::Videos::Stream.new(stream_ffprobe_data)
         end
       end
+
+      # @return [TagLib::FileRef]
+      def tag_file_uncached
+        ::TagLib::FileRef.new(path.to_path)
+      end
     end
   end
 end

data/vendor/ehbrs_ruby_utils/lib/ehbrs_ruby_utils/videos/stream.rb

@@ -35,7 +35,7 @@ module EhbrsRubyUtils
         end
       end
 
-      %i[codec_name codec_long_name].each do |method_name|
+      %i[codec_name codec_long_name height width].each do |method_name|
         define_method method_name do
           ffprobe_data[method_name]
         end

data/vendor/ehbrs_ruby_utils/template/ehbrs_ruby_utils/music/lyrics_book/album/inner.html.erb

@@ -0,0 +1,3 @@
+<% songs.each do |song| %>
+  <%= song.output_main %>
+<% end %>

data/vendor/ehbrs_ruby_utils/template/ehbrs_ruby_utils/music/lyrics_book/custom_style.css

@@ -0,0 +1,11 @@
+.album h2 {
+  background-color: lightgoldenrodyellow;
+  text-align: center;
+}
+
+.filename {
+  display: block;
+  font-size: small;
+  text-align: right;
+  font-style: italic;
+}

data/vendor/ehbrs_ruby_utils/template/ehbrs_ruby_utils/music/lyrics_book/index.html.erb

@@ -0,0 +1,14 @@
+<div class="index" >
+  <ul>
+    <% albums.each do |album| %>
+      <li>
+        <%= album.link_to_header %>
+        <ul>
+          <% album.songs.each do |song| %>
+            <li><%= song.link_to_header %></li>
+          <% end %>
+        </ul>
+      </li>
+    <% end %>
+  </ul>
+</div>

data/vendor/ehbrs_ruby_utils/template/ehbrs_ruby_utils/music/lyrics_book/main.html.erb

@@ -0,0 +1,24 @@
+<!doctype html>
+<html>
+  <head>
+    <title><%= title %></title>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <link href="https://cdn.jsdelivr.net/npm/bootstrap@5.0.2/dist/css/bootstrap.min.css" rel="stylesheet" integrity="sha384-EVSTQN3/azprG1Anm3QDgpJLIm9Nao0Yz1ztcQTwFspd3yD65VohhpuuCOmLASjC" crossorigin="anonymous">
+    <script src="https://cdn.jsdelivr.net/npm/bootstrap@5.0.2/dist/js/bootstrap.bundle.min.js" integrity="sha384-MrcW6ZMFYlzcLA8Nl+NtUVF0sA7MsXsP1UyJoMp4YLEuNSfAP+JcXn/tWtIaxVXM" crossorigin="anonymous"></script>
+    <link rel="stylesheet" href="https://cdn.jsdelivr.net/npm/bootstrap-icons@1.5.0/font/bootstrap-icons.css">
+    <style>
+      <%= template.child('custom_style.css').content %>
+    </style>
+  </head>
+  <body>
+    <div class="container" >
+      <h1><%= title %></h1>
+      <h2>Índice</h2>
+      <%= erb_template('index.html.erb')  %>
+      <% albums.each do |album| %>
+        <%= album.output_main %>
+      <% end %>
+    </div>
+  </body>
+</html>

data/vendor/ehbrs_ruby_utils/template/ehbrs_ruby_utils/music/lyrics_book/resource/main.html.erb

@@ -0,0 +1,8 @@
+<div class="<%= type %>">
+  <h<%= header_index %> id='<%= header_id %>' >
+    <%= header_title %>
+    <a href="#<%= index_id %>" ><i class="bi-arrow-up-circle-fill"></i></a>
+  </h<%= header_index %>>
+  <span class="filename"><%= filename %></span>
+  <%= erb_template('inner.html.erb') %>
+</div>

data/vendor/ehbrs_ruby_utils/template/ehbrs_ruby_utils/music/lyrics_book/song/inner.html.erb

@@ -0,0 +1,5 @@
+<% if lyrics.found? %>
+  <pre><%= lyrics.text %></pre>
+<% else %>
+  <p><em>Letra indisponível.</em></p>
+<% end %>

data/vendor/ultimate_lyrics/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec