ultimate_lyrics 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a09ecd6257da805ba95b8448cd62f91dfdcf1e68227da3c8b97ad84827eb0c03
+  data.tar.gz: b3ae4ed332ba011bafb985cfb587a82492e2c067aa4b2a0bc732d6ed53608a04
+SHA512:
+  metadata.gz: 349464014bc5ba69e813edcae115ef5b7b596050b325c4418d1ee02817ceb2b85525c924e95d50195765f713cb5d89bc7f60a48a0b3f0dd1caff4e661f6c6035
+  data.tar.gz: 8976f0c3eb6e9cb079df3c51e418b9468bd660fb8525ec50719988f09b190a37f9af1147440b04d6627f11e283de13d4e6757d062d73a58f23f48b97df36bc0a

data/lib/ultimate_lyrics/field.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module UltimateLyrics
+  class Field
+    DATA = {
+      'artist' => %w[artist lower],
+      'artist2' => %w[artist lower nospace],
+      'album' => %w[album lower],
+      'album2' => %w[album lower nospace],
+      'title' => %w[title lower],
+      'Artist' => %w[artist],
+      'Album' => %w[album],
+      'ARTIST' => %w[artist upper],
+      'year' => %w[year pretty],
+      'Title' => %w[title],
+      'Title2' => %w[title titlecase],
+      'a' => %w[artist firstchar],
+      'track' => %w[track number]
+    }.freeze
+
+    BEGIN_DELIMITER = '{'
+    END_DELIMITER = '}'
+
+    class << self
+      # @return [Array<UltimateLyrics::Field>]
+      def all
+        @all ||= DATA.map do |name, modifiers|
+          source_attr = modifiers.shift
+          new(name, source_attr, modifiers)
+        end
+      end
+
+      # @return [UltimateLyrics::Field]
+      def by_name(name)
+        all.find { |field| field.name == name } ||
+          raise("No field with name \"#{name}\" (Available: #{all.values})")
+      end
+
+      # @return [Array<UltimateLyrics::Field>]
+      def from_string(string)
+        names_from_string(string).map { |name| by_name(name) }
+      end
+
+      # @return [Array<String>]
+      def names_from_string(string)
+        string.scan(/#{::Regexp.quote(BEGIN_DELIMITER)}[^\}]+#{::Regexp.quote(END_DELIMITER)}/)
+              .map { |s| s.delimited_inner(BEGIN_DELIMITER, END_DELIMITER) }
+      end
+    end
+
+    common_constructor :name, :source_attribute, :modifiers
+
+    def apply(string, value)
+      string.gsub(apply_pattern, value)
+    end
+
+    def apply_pattern
+      /#{::Regexp.quote(BEGIN_DELIMITER)}#{::Regexp.quote(name)}#{::Regexp.quote(END_DELIMITER)}/
+    end
+
+    def value(value)
+      modifiers.inject(value.to_s) { |a, e| send(e, a) }
+    end
+
+    def to_s
+      name
+    end
+
+    private
+
+    def firstchar(string)
+      string[0]
+    end
+
+    def lower(string)
+      string.downcase
+    end
+
+    def nospace(string)
+      string.gsub(/\s/, '')
+    end
+  end
+end

data/lib/ultimate_lyrics/lyrics.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module UltimateLyrics
+  class Lyrics
+    common_constructor :song_metadata, :provider_name, :text
+
+    def found?
+      text.present?
+    end
+  end
+end

data/lib/ultimate_lyrics/parser.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module UltimateLyrics
+  class Parser
+    common_constructor :provider, :original_content
+
+    def original_content_invalid?
+      provider.invalid_indicators.any? { |v| original_content.include?(v) }
+    end
+
+    def result
+      return nil if original_content_invalid?
+
+      sanitize_text(provider.rules.inject(original_content) { |a, e| e.apply(a) })
+    end
+
+    def sanitize_text(text)
+      r = text.to_s.gsub("\t", ' ').gsub("\r", '').gsub(/ +/, ' ').gsub(/\n{2,}/m, "\n\n").strip
+      r.present? ? "#{r}\n" : nil
+    end
+
+    def url?
+      provider.extract_rules.any?(&:url?)
+    end
+  end
+end

data/lib/ultimate_lyrics/provider/exclude_item.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'ultimate_lyrics/provider/item'
+
+module UltimateLyrics
+  class Provider
+    class ExcludeItem < ::UltimateLyrics::Provider::Item
+      def apply_from_delimiters(source)
+        source.delimited_without_outer(begin_with, end_with)
+      end
+
+      def apply_from_tag(source)
+        source.delimited_without_outer(tag, "</#{tag_name}>")
+      end
+    end
+  end
+end

data/lib/ultimate_lyrics/provider/extract_item.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require 'ultimate_lyrics/provider/item'
+
+module UltimateLyrics
+  class Provider
+    class ExtractItem < ::UltimateLyrics::Provider::Item
+      def apply_from_delimiters(source)
+        source.delimited_inner(begin_with, end_with)
+      end
+
+      def apply_from_tag(source)
+        source.delimited_inner(tag, "</#{tag_name}>")
+      end
+
+      def apply_from_url(source)
+        url.gsub('{id}', source)
+      end
+    end
+  end
+end

data/lib/ultimate_lyrics/provider/item.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module UltimateLyrics
+  class Provider
+    class Item
+      METHODS_ATTRIBUTES = { tag: :tag, begin_with: :begin, end_with: :end, url: :url }.freeze
+      TAG_NAME_PARSER = /<(\w+).*>/.to_parser { |m| m[1] }
+
+      common_constructor :rule, :node
+
+      METHODS_ATTRIBUTES.each do |method_name, attr|
+        define_method method_name do
+          ::CGI.unescapeHTML(node.attribute(attr.to_s).if_present('', &:text)).presence
+        end
+
+        define_method "#{method_name}?" do
+          send(method_name).present?
+        end
+      end
+
+      def delimiters?
+        begin_with? || end_with?
+      end
+
+      def apply(source)
+        %w[url tag delimiters].each do |m|
+          next unless send("#{m}?")
+
+          return send("apply_from_#{m}", source)
+        end
+
+        raise 'Invalid branch hit'
+      end
+
+      def tag_name
+        TAG_NAME_PARSER.parse(tag)
+      end
+
+      def to_s
+        self.class.name.demodulize + '[' + METHODS_ATTRIBUTES
+                                           .select { |m, _a| send(m).present? }
+                                           .map { |m, a| "#{a}: #{send(m)}" }
+                                           .join(', ') +
+          ']'
+      end
+    end
+  end
+end

data/lib/ultimate_lyrics/provider/replace_fields.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module UltimateLyrics
+  class Provider
+    class ReplaceFields
+      common_constructor :metadata, :source_string
+
+      def result
+        fields_found.inject(source_string) { |a, e| a.gsub("{#{e}}", metadata.send(e)) }
+      end
+    end
+  end
+end

data/lib/ultimate_lyrics/provider/rule.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module UltimateLyrics
+  class Provider
+    class Rule
+      common_constructor :node
+
+      def items
+        node.xpath('./item').map { |v| item_class.new(self, v) }
+      end
+
+      def item_class
+        ::UltimateLyrics::Provider.const_get(type.camelize + 'Item')
+      end
+
+      def apply(string)
+        url? ? apply_with_url(string) : apply_without_url(string)
+      end
+
+      def to_s
+        "Rule[#{type} | #{items.join(', ')}]"
+      end
+
+      def type
+        node.name
+      end
+
+      def url?
+        items.any?(&:url?)
+      end
+
+      private
+
+      def apply_without_url(string)
+        items.inject(string) { |a, e| e.apply(a) }
+      end
+
+      def apply_with_url(string)
+        url_item, id_item = url_items
+        id_item.apply(string).if_present { |v| url_item.apply(v) }
+      end
+
+      def url_items
+        raise "There is more than 2 items in #{rule}" if items.count != 2
+
+        url_item = items.find(&:url?) || raise("No URL item found in #{rule}")
+        id_item = items.find(&:delimiters?) || raise("No ID item found in #{rule}")
+        [url_item, id_item]
+      end
+    end
+  end
+end

data/lib/ultimate_lyrics/provider/url_format.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module UltimateLyrics
+  class Provider
+    class UrlFormat
+      common_constructor :node
+
+      def apply(value)
+        replace_chars.inject(value) { |a, e| a.gsub(e, with) }
+      end
+
+      def replace_chars
+        ::CGI.unescapeHTML(node.attribute('replace').text).each_char.to_a
+      end
+
+      def with
+        node.attribute('with').text
+      end
+    end
+  end
+end

data/lib/ultimate_lyrics/provider.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+require 'nokogiri'
+require 'ultimate_lyrics/field'
+
+module UltimateLyrics
+  class Provider
+    require_sub __FILE__
+
+    class << self
+      # @return [Array<UltimateLyrics::Provider>]
+      def all
+        @all ||= ::Nokogiri::XML(
+          ::File.new(::File.join(__dir__, 'providers_data.xml'))
+        ).xpath('/lyricproviders/provider').map { |node| new(node) }
+      end
+
+      # @return [UltimateLyrics::Provider]
+      def by_name(name)
+        by_attribute('name', name)
+      end
+
+      # @return [UltimateLyrics::Provider]
+      def by_identifier(identifier)
+        by_attribute('identifier', identifier)
+      end
+
+      # @return [UltimateLyrics::Provider]
+      def by_attribute(attribute, value)
+        all.find { |provider| provider.send(attribute) == value } ||
+          raise("No provider with name \"#{value}\" (Available: " +
+            all.map { |p| p.send(attrbute) }.join(', ') + ')')
+      end
+    end
+
+    common_constructor :node
+
+    def extract_rules
+      node.xpath('./extract').map do |v|
+        ::UltimateLyrics::Provider::Rule.new(v)
+      end
+    end
+
+    def exclude_rules
+      node.xpath('./exclude').map do |v|
+        ::UltimateLyrics::Provider::Rule.new(v)
+      end
+    end
+
+    def identifier
+      name.variableize
+    end
+
+    def invalid_indicators
+      node.xpath('/invalidIndicator/@value').map(&:text)
+    end
+
+    # @return [String]
+    def name
+      node.attribute('name').text
+    end
+
+    def rules
+      extract_rules + exclude_rules
+    end
+
+    # @return [String]
+    def url
+      node.attribute('url').text
+    end
+
+    # @return [Array<UltimateLyrics::Field>]
+    def url_fields
+      ::UltimateLyrics::Field.from_string(url)
+    end
+
+    def url_formats
+      node.xpath('./urlFormat').map do |v|
+        ::UltimateLyrics::Provider::UrlFormat.new(v)
+      end
+    end
+
+    def title
+      node.attribute('text').text
+    end
+
+    def to_s
+      name
+    end
+  end
+end

data/lib/ultimate_lyrics/provider_search.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'aranha/parsers/source_address'
+require 'eac_ruby_utils/core_ext'
+require 'ultimate_lyrics/lyrics'
+require 'ultimate_lyrics/parser'
+
+module UltimateLyrics
+  class ProviderSearch
+    common_constructor :provider, :song_metadata
+
+    # @return [String]
+    def url
+      url_fields.inject(provider.url) { |a, e| e.apply(a) }
+    end
+
+    # @return []
+    def url_fields
+      provider.url_fields.map { |provider_url_field| song_metadata.field(provider_url_field) }
+    end
+
+    # @return [UltimateLyrics::Lyrics]
+    def lyrics
+      ::UltimateLyrics::Lyrics.new(song_metadata, provider.name, parser.result)
+    end
+
+    # @return [UltimateLyrics::Parser]
+    def lyrics_original_text
+      ::Aranha::Parsers::SourceAddress.detect_sub(url).content
+    rescue ::Aranha::Parsers::SourceAddress::FetchContentError
+      nil
+    end
+
+    # @return [UltimateLyrics::Parser]
+    def parser
+      ::UltimateLyrics::Parser.new(provider, lyrics_original_text)
+    end
+
+    def to_s
+      "ProviderSearch[#{provider} | #{song_metadata}]"
+    end
+  end
+end

data/lib/ultimate_lyrics/providers_data.xml

@@ -0,0 +1,355 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--
+Copy of https://raw.githubusercontent.com/clementine-player/Clementine/fb93ae4b020014ae38e7ebf51f3d8e333a5b572f/data/lyrics/ultimate_providers.xml.
+-->
+<lyricproviders>
+  <provider name="azlyrics.com" title="{artist} LYRICS - {title}" charset="utf-8"
+  url="http://www.azlyrics.com/lyrics/{artist}/{title}.html">
+    <urlFormat replace="._@,;&amp;\/()'&quot;-" with="" />
+    <extract>
+      <item begin="&lt;!-- Usage of azlyrics.com content by any third-party lyrics provider is prohibited by our licensing agreement. Sorry about that. --&gt;"
+      end="&lt;/div&gt;" />
+    </extract>
+    <exclude>
+      <item tag="&lt;B&gt;" />
+      <item begin="&lt;i&gt;[" end="]&lt;/i&gt;" />
+      <item begin="[" end="]" />
+    </exclude>
+    <invalidIndicator value="&lt;h1&gt;Welcome to AZLyrics!&lt;/h1&gt;" />
+  </provider>
+  <provider name="bollywoodlyrics.com (Bollywood songs)"
+  title="{title} Song Lyrics - BollywoodLyrics.com" charset="utf-8"
+  url="http://www.bollywoodlyrics.com/lyric/{Title}">
+    <urlFormat replace="_@;\/&quot;'()[]" with="-" />
+    <urlFormat replace="?" with="" />
+    <extract>
+      <item begin="&lt;div class=&quot;entry-content&quot;&gt;" end="&lt;/div&gt;" />
+    </extract>
+    <invalidIndicator value="Couldn't find that page." />
+  </provider>
+  <provider name="darklyrics.com" title="{ARTIST} LYRICS - &quot;{title}&quot; ({year}) album"
+  charset="utf-8" url="http://www.darklyrics.com/lyrics/{artist2}/{album2}.html">
+    <extract>
+      <item begin="&lt;h3&gt;&lt;a name=&quot;{track}&quot;&gt;{track}. {Title2}&lt;/a&gt;&lt;/h3&gt;&lt;br /&gt;"
+      end="&lt;h3&gt;" />
+    </extract>
+    <extract>
+      <item begin="&lt;h3&gt;&lt;a name=&quot;{track}&quot;&gt;{track}. {Title2}&lt;/a&gt;&lt;/h3&gt;&lt;br /&gt;"
+      end="&lt;div class=&quot;thanks&quot;&gt;" />
+    </extract>
+    <invalidIndicator value="The page you requested was not found on DarkLyrics.com." />
+  </provider>
+  <provider name="directlyrics.com" title="{artist} - {title} lyrics" charset="iso-8859-1"
+  url="http://www.directlyrics.com/{artist}-{title}-lyrics.html">
+    <urlFormat replace="_@,;&amp;\/'&quot;" with="-" />
+    <urlFormat replace="." with="" />
+    <extract>
+      <item tag="&lt;div id=&quot;lyricsContent&quot;&gt;" />
+      <item tag="&lt;p&gt;" />
+    </extract>
+    <exclude>
+      <item begin="&lt;b&gt;" end="&lt;/b&gt;" />
+    </exclude>
+  </provider>
+  <provider name="elyrics.net" title="{title} Lyrics - {artist}" charset="iso-8859-1"
+  url="http://www.elyrics.net/read/{a}/{artist}-lyrics/{title}-lyrics.html">
+    <urlFormat replace="_@;&amp;\/&quot;" with="-" />
+    <urlFormat replace="'" with="_" />
+    <extract>
+      <item tag="&lt;div class='ly' style='font-size:12px;'&gt;" />
+    </extract>
+    <exclude>
+      <item tag="&lt;strong&gt;" />
+      <item tag="&lt;em&gt;" />
+    </exclude>
+    <invalidIndicator value="Page not Found" />
+  </provider>
+  <provider name="Encyclopaedia Metallum" title="{title Lyrics - {artist}" charset="utf-8"
+  url="http://www.metal-archives.com/search/ajax-advanced/searching/songs/?songTitle={title}&amp;bandName={artist}&amp;ExactBandMatch=1">
+
+    <extract>
+      <item url="http://www.metal-archives.com/release/ajax-view-lyrics/id/{id}" />
+      <item begin="id=\&quot;lyricsLink_" end="&quot;" />
+    </extract>
+    <invalidIndicator value="&quot;iTotalRecords&quot;: 0" />
+    <invalidIndicator value="lyrics not available" />
+  </provider>
+  <provider name="genius.com" charset="utf-8" url="https://www.genius.com/{artist}-{title}-lyrics">
+    <urlFormat replace=",._@!#%^*+;\/&quot;'()[]" with="" />
+    <urlFormat replace=":" with="-" />
+    <!-- When $ is used as the dollar sign it is omitted from the url
+         When $ is used instead of 's',
+         in some cases it is replaced by 's'(Too $hort -> too-short)
+         in other cases it is omitted ($uicideboy$ -> uicideboy)
+         I chose to omit it though, in some cases it's gonna be problematic -->
+    <urlFormat replace="$" with="" />
+    <urlFormat replace="ÄÂÀÁÃäâàáã" with="a" />
+    <urlFormat replace="ËÊÈÉëêèé" with="e" />
+    <urlFormat replace="ÏÌïì" with="i" />
+    <urlFormat replace="ÖÔÒÓÕöôòóõ" with="o" />
+    <urlFormat replace="ÜŪÙÚüūùú" with="u" />
+    <urlFormat replace="ŸÝÿý" with="y" />
+    <urlFormat replace="Ññ" with="n" />
+    <urlFormat replace="Çç" with="c" />
+    <urlFormat replace="ß" with="ss" />
+    <urlFormat replace="&amp;" with="and" />
+    <extract>
+      <item tag="&lt;div class=&quot;lyrics&quot;&gt;" />
+    </extract>
+    <exclude>
+      <item begin="&lt;!--" end="--&gt;" />
+      <item begin="&lt;a href=" end="&gt;" />
+      <item begin="&lt;/a" end="&gt;" />
+    </exclude>
+  </provider>
+  <provider name="hindilyrics.net (Bollywood songs)" title="{title} ({album})" charset="utf-8"
+  url="http://www.hindilyrics.net/lyrics/of-{Title}.html">
+    <urlFormat replace="_@;\/&quot;'()[]" with="%20" />
+    <urlFormat replace="?" with="" />
+    <extract>
+      <item begin="&lt;div class=nm&gt;Movie&lt;/div&gt;:" end="&lt;/pre&gt;" />
+    </extract>
+    <exclude>
+      <item begin="&lt;span class=" end="&quot;&gt;" />
+    </exclude>
+    <invalidIndicator value="Couldn't find that page." />
+  </provider>
+  <provider name="letras.mus.br" title="" charset="utf-8"
+  url="https://www.letras.mus.br/winamp.php?musica={title}&amp;artista={artist}">
+    <urlFormat replace="_@,;&amp;\/&quot;" with="_" />
+    <urlFormat replace="" with="+" />
+    <extract>
+      <item begin="&lt;/div&gt;" end="&lt;/div&gt;" />
+    </extract>
+    <invalidIndicator value="Verifique se o nome do seu arquivo e sua" />
+  </provider>
+  <provider name="lololyrics.com" title="" charset="utf-8"
+  url="http://api.lololyrics.com/0.5/getLyric?artist={artist}&amp;track={title}">
+    <urlFormat replace="_@,;&amp;\/&quot;#" with="_" />
+    <extract>
+      <item tag="&lt;response&gt;" />
+    </extract>
+    <invalidIndicator value="ERROR" />
+  </provider>
+  <provider name="loudson.gs" title="" charset="utf-8"
+  url="http://www.loudson.gs/{a}/{artist}/{album}/{title}">
+    <urlFormat replace="_@,;&amp;\/&quot;" with="-" />
+    <urlFormat replace="." with="" />
+    <extract>
+      <item tag="&lt;div class=&quot;middle_col_TracksLyrics &quot;&gt;" />
+    </extract>
+  </provider>
+  <provider name="lyrics.com" title="{artist} - {title} Lyrics" charset="utf-8"
+  url="http://www.lyrics.com/lyrics/{artist}/{title}.html">
+    <urlFormat replace="_@,;&amp;\/&quot;" with="-" />
+    <urlFormat replace="'." with="" />
+    <extract>
+      <item tag="&lt;div id=&quot;lyrics&quot; class=&quot;SCREENONLY&quot;&gt;" />
+    </extract>
+    <exclude>
+      <item begin="&lt;br&gt;&lt;br&gt;&lt;a target='_blank'" end="&gt;&lt;/a&gt;" />
+    </exclude>
+    <invalidIndicator value="Click to search for the Lyrics on Lyrics.com" />
+    <invalidIndicator value="we do not have the lyric for this song" />
+  </provider>
+  <provider name="lyrics.wikia.com" title="{artist}:{title} Lyrics - " charset="utf-8"
+  url="http://lyrics.wikia.com/{Artist}:{Title}">
+    <urlFormat replace="_@;\&quot;" with="_" />
+    <urlFormat replace="?" with="%3F" />
+    <extract>
+      <item begin="&lt;div class='lyricbox'&gt;" end="&lt;div class='lyricsbreak'" />
+    </extract>
+    <exclude>
+      <item tag="&lt;div class='rtMatcher'&gt;" />
+      <item tag="&lt;span style=&quot;padding:1em&quot;&gt;" />
+    </exclude>
+  </provider>
+  <provider name="lyricsbay.com" title="{title} lyrics {artist}" charset="iso-8859-1"
+  url="http://www.lyricsbay.com/{title}_lyrics-{artist}.html">
+    <urlFormat replace="_@,;&amp;\/'&quot;" with="_" />
+    <urlFormat replace="." with="" />
+    <extract>
+      <item tag="&lt;div id=EchoTopic&gt;" />
+    </extract>
+    <exclude>
+      <item tag="&lt;textarea name=&quot;songscpy&quot; id=&quot;songscpyid&quot; onclick=&quot;callselect('songscpyid','selectswf')&quot; rows=&quot;3&quot; cols=&quot;45&quot; READONLY&gt;" />
+    </exclude>
+  </provider>
+  <provider name="lyricsdownload.com" title="{artist} - {title} LYRICS" charset="utf-8"
+  url="http://www.lyricsdownload.com/{artist}-{title}-lyrics.html">
+    <urlFormat replace="_@,;&amp;\/&quot;" with="-" />
+    <urlFormat replace="." with="" />
+    <extract>
+      <item tag="&lt;div id=&quot;div_customCSS&quot;&gt;" />
+    </extract>
+    <invalidIndicator value="We haven't lyrics of this song" />
+  </provider>
+  <provider name="lyricsmania.com" title="{artist} - {title} Lyrics" charset="iso-8859-1"
+  url="http://www.lyricsmania.com/{title}_lyrics_{artist}.html">
+    <urlFormat replace="_@;&amp;\/&quot;'." with="_" />
+    <extract>
+      <item begin="&lt;span style=&quot;font-size:14px;&quot;&gt;"
+      end="&lt;span style=&quot;font-size:14px;&quot;&gt;" />
+      <item begin="&lt;/center&gt;" end="&lt;a" />
+    </extract>
+    <invalidIndicator value="The lyrics you requested is not in our archive yet," />
+  </provider>
+  <provider name="lyricsmode.com" title="{artist} - {title} lyrics" charset="iso-8859-1"
+  url="http://www.lyricsmode.com/lyrics/{a}/{artist}/{title}.html">
+    <urlFormat replace="._@,;&amp;\/&quot;" with="_" />
+    <extract>
+      <item tag="&lt;div id='songlyrics_h' class='dn'&gt;" />
+    </extract>
+    <invalidIndicator value="Sorry, we have no" />
+  </provider>
+  <provider name="lyricsplugin.com" title="{artist} - {title} Lyrics" charset="utf-8"
+  url="http://www.lyricsplugin.com/winamp03/plugin/?title={title}&amp;artist={artist}">
+    <urlFormat replace="_@;&amp;\/&quot;" with="-" />
+    <urlFormat replace="'" with="" />
+    <urlFormat replace="" with="%20" />
+    <extract>
+      <item tag="&lt;div id=&quot;lyrics&quot;&gt;" />
+    </extract>
+  </provider>
+  <provider name="lyricsreg.com" title="{title} lyrics {artist}" charset="iso-8859-1"
+  url="http://www.lyricsreg.com/lyrics/{artist}/{title}/">
+    <urlFormat replace="_@,;&amp;\/&quot;" with="+" />
+    <urlFormat replace="'." with="" />
+    <extract>
+      <item begin="Ringtone to your Cell" end="Ringtone to your Cell" />
+      <item begin="&lt;div style=&quot;text-align:center;&quot;&gt;" end="&lt;a" />
+    </extract>
+    <invalidIndicator value="Page not Found" />
+  </provider>
+  <provider name="lyricstime.com" title="{artist} - {title} Lyrics" charset="iso-8859-1"
+  url="http://www.lyricstime.com/{artist}-{title}-lyrics.html">
+    <urlFormat replace="_@,;&amp;\/&quot;'" with="-" />
+    <urlFormat replace="." with="" />
+    <extract>
+      <item tag="&lt;div id=&quot;songlyrics&quot; &gt;" />
+      <item tag="&lt;p&gt;" />
+    </extract>
+  </provider>
+  <provider name="lyriki.com" title="" charset="utf-8"
+  url="http://www.lyriki.com/{artist}:{title}">
+    <urlFormat replace="_@,;&amp;\/&quot;" with="_" />
+    <urlFormat replace="." with="" />
+    <extract>
+      <item begin="&lt;/table&gt;" end="&lt;div class=&quot;printfooter&quot;&gt;" />
+      <item tag="&lt;p&gt;" />
+    </extract>
+  </provider>
+  <provider name="metrolyrics.com" title="{artist} - {title} LYRICS" charset="utf-8"
+  url="http://www.metrolyrics.com/{title}-lyrics-{artist}.html">
+    <urlFormat replace="_@,;&amp;\/&quot;" with="-" />
+    <urlFormat replace="'." with="" />
+    <extract>
+      <item tag="&lt;span id=&quot;lyrics&quot;&gt;" />
+    </extract>
+    <extract>
+      <item tag="&lt;div id=&quot;lyrics&quot;&gt;" />
+    </extract>
+    <exclude>
+      <item tag="&lt;h5&gt;" />
+    </exclude>
+    <invalidIndicator value="These lyrics are missing" />
+  </provider>
+  <provider name="mp3lyrics.org" title="{artist} &amp;quot;{title}&amp;quot; Lyrics"
+  charset="utf-8" url="http://www.mp3lyrics.org/{a}/{artist}/{title}/">
+    <urlFormat replace="_@,;&amp;\/&quot;" with="-" />
+    <urlFormat replace="'." with="" />
+    <extract>
+      <item tag="&lt;span id=gn_lyricsB&gt;" />
+    </extract>
+    <extract>
+      <item tag="&lt;div class=&quot;KonaBody&quot; id=&quot;EchoTopic&quot;&gt;" />
+    </extract>
+    <exclude>
+      <item tag="&lt;font size=2&gt;" />
+      <item begin="&lt;b&gt;&lt;i&gt;" end="&lt;/u&gt;&lt;/b&gt;:" />
+      <item begin="&lt;b&gt;Lyrics" end="&lt;/b&gt;" />
+    </exclude>
+    <invalidIndicator value="Something went wrong" />
+  </provider>
+  <provider name="musixmatch.com" title="{artist} - {title} lyrics | Musixmatch" charset="utf-8"
+  url="https://www.musixmatch.com/lyrics/{Artist}/{Title}">
+    <urlFormat replace="_@;\/&quot;'()[]" with="-" />
+    <urlFormat replace="?" with="" />
+    <extract>
+      <item begin="&lt;span id=&quot;lyrics-html&quot;" end="&lt;/span&gt;" />
+    </extract>
+    <exclude>
+      <item begin="data-reactid=&quot;" end="&quot;&gt;" />
+    </exclude>
+    <invalidIndicator value="We couldn't find that page." />
+  </provider>
+  <provider name="seeklyrics.com" title="{artist} - {title} Lyrics" charset="iso-8859-1"
+  url="http://www.seeklyrics.com/lyrics/{Artist}/{Title}.html">
+    <urlFormat replace="_@,;&amp;\/'&quot;" with="-" />
+    <urlFormat replace="." with="" />
+    <extract>
+      <item tag="&lt;div id=&quot;songlyrics&quot;&gt;" />
+    </extract>
+  </provider>
+  <provider name="songlyrics.com" title="{title} LYRICS - {artist}" charset="utf-8"
+  url="http://www.songlyrics.com/{artist}/{title}-lyrics/">
+    <urlFormat replace="._@,;&amp;\/&quot;" with="-" />
+    <urlFormat replace="'" with="_" />
+    <extract>
+      <item tag="&lt;p id=&quot;songLyricsDiv&quot; ondragstart=&quot;return false;&quot; onselectstart=&quot;return false;&quot; oncontextmenu=&quot;return false;&quot; class=&quot;songLyricsV14&quot; style=&quot;font-size: 14px;z-index: 9999;position: absolute;left: -6000px;&quot;&gt;" />
+    </extract>
+    <exclude>
+      <item begin="[" end="]" />
+    </exclude>
+    <invalidIndicator value="Sorry, we have no" />
+    <invalidIndicator value="This is an upcoming album and we do not have the" />
+  </provider>
+  <provider name="tekstowo.pl (Original lyric language)" title="{artist} - {title} - tekst"
+  charset="utf-8" url="http://www.tekstowo.pl/piosenka,{artist},{title}.html">
+    <urlFormat replace="_@,;&amp;\/'&quot;." with="_" />
+    <extract>
+      <item begin="&lt;div class=&quot;song-text&quot;&gt;"
+      end="&lt;a href=&quot;javascript:;&quot;" />
+    </extract>
+    <extract>
+      <item tag="&lt;div class=&quot;tlumaczenie&quot;&gt;" />
+    </extract>
+    <exclude>
+      <item begin="&lt;h2&gt;" end="&lt;/h2&gt;&lt;br /&gt;" />
+    </exclude>
+  </provider>
+  <provider name="tekstowo.pl (Translated to Polish)" title="{artist} - {title} - tekst"
+  charset="utf-8" url="http://www.tekstowo.pl/piosenka,{artist},{title}.html">
+    <urlFormat replace="_@,;&amp;\/'&quot;." with="_" />
+    <extract>
+      <item begin="&lt;div id=&quot;translation&quot; class=" end="&lt;a href=" />
+    </extract>
+    <exclude>
+      <item begin="&quot;id-" end="&quot;&gt;" />
+    </exclude>
+  </provider>
+  <provider name="teksty.org" title="{artist} - {title} - tekst" charset="utf-8"
+  url="http://teksty.org/{artist},{title},tekst-piosenki">
+    <urlFormat replace="_@,;&amp;\/&quot;'" with="-" />
+    <urlFormat replace="." with="" />
+    <extract>
+      <item begin="&lt;div class=&quot;songText&quot; id=&quot;songContent&quot;&gt;"
+      end="&lt;/div&gt;" />
+    </extract>
+  </provider>
+  <provider name="vagalume.com.br" title="{title} de {artist} no VAGALUME" charset="iso-8859-1"
+  url="http://vagalume.com.br/{artist}/{title}.html">
+    <urlFormat replace="_@,;&amp;\/'&quot;." with="-" />
+    <extract>
+      <item tag="&lt;span class=&quot;editable_area&quot;&gt;" />
+    </extract>
+  </provider>
+  <provider name="vagalume.com.br (Portuguese translations)"
+  title="{title} de {artist} no VAGALUME" charset="iso-8859-1"
+  url="http://vagalume.com.br/{artist}/{title}-traducao.html">
+    <urlFormat replace="_@,;&amp;\/'&quot;." with="-" />
+    <extract>
+      <item tag="&lt;div class=&quot;tab_traducao sideBySide lyricArea tab_tra_pt&quot;&gt;" />
+    </extract>
+  </provider>
+</lyricproviders>

data/lib/ultimate_lyrics/song_metadata/field.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module UltimateLyrics
+  class SongMetadata
+    class Field
+      enable_listable
+      lists.add_symbol :sources, :album, :artist, :title, :track, :year
+
+      common_constructor :song_metadata, :field
+
+      def apply(string)
+        field.apply(string, value)
+      end
+
+      def value
+        field.value(song_metadata.send(field.source_attribute))
+      end
+
+      def to_s
+        "[#{song_metadata} | #{field}]"
+      end
+    end
+  end
+end

data/lib/ultimate_lyrics/song_metadata.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'eac_ruby_utils/core_ext'
+
+module UltimateLyrics
+  class SongMetadata
+    require_sub __FILE__
+    common_constructor :data do
+      self.data = ::UltimateLyrics::SongMetadata::Field.lists.sources.hash_keys_validate!(data)
+    end
+
+    ::UltimateLyrics::SongMetadata::Field.lists.sources.each_value do |field|
+      define_method field do
+        data.fetch(field)
+      end
+    end
+
+    # @param field [UltimateLyrics::Field]
+    # @return [UltimateLyrics::SongMetadata::Field]
+    def field(field)
+      UltimateLyrics::SongMetadata::Field.new(self, field)
+    end
+
+    def to_s
+      data.map { |k, v| "#{k}=#{v}" }.join(', ')
+    end
+  end
+end

data/lib/ultimate_lyrics/version.rb

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

data/lib/ultimate_lyrics.rb

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

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: ultimate_lyrics
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Put here the authors
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-09-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aranha-parsers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.8.5
+- !ruby/object:Gem::Dependency
+  name: eac_ruby_utils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.74'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.74'
+- !ruby/object:Gem::Dependency
+  name: eac_ruby_gem_support
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/ultimate_lyrics.rb
+- lib/ultimate_lyrics/field.rb
+- lib/ultimate_lyrics/lyrics.rb
+- lib/ultimate_lyrics/parser.rb
+- lib/ultimate_lyrics/provider.rb
+- lib/ultimate_lyrics/provider/exclude_item.rb
+- lib/ultimate_lyrics/provider/extract_item.rb
+- lib/ultimate_lyrics/provider/item.rb
+- lib/ultimate_lyrics/provider/replace_fields.rb
+- lib/ultimate_lyrics/provider/rule.rb
+- lib/ultimate_lyrics/provider/url_format.rb
+- lib/ultimate_lyrics/provider_search.rb
+- lib/ultimate_lyrics/providers_data.xml
+- lib/ultimate_lyrics/song_metadata.rb
+- lib/ultimate_lyrics/song_metadata/field.rb
+- lib/ultimate_lyrics/version.rb
+homepage: 
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: Put here de description.
+test_files: []