wahwah 1.1.1 → 1.2.0

data/lib/wahwah/helper.rb

@@ -2,12 +2,12 @@
 
 module WahWah
   module Helper
-    def self.encode_to_utf8(string, source_encoding: '')
+    def self.encode_to_utf8(string, source_encoding: "")
       encoded_string = source_encoding.empty? ?
-        string.force_encoding('utf-8') :
-        string.encode('utf-8', source_encoding, invalid: :replace, undef: :replace, replace: '')
+        string.force_encoding("utf-8") :
+        string.encode("utf-8", source_encoding, invalid: :replace, undef: :replace, replace: "")
 
-      encoded_string.valid_encoding? ? encoded_string.strip : ''
+      encoded_string.valid_encoding? ? encoded_string.strip : ""
     end
 
     # ID3 size is encoded with four bytes where may the most significant
@@ -15,7 +15,7 @@ module WahWah
     # making a total of 28 bits. The zeroed bits are ignored
     def self.id3_size_caculate(bits_string, has_zero_bit: true)
       if has_zero_bit
-        bits_string.scan(/.{8}/).map { |byte_string| byte_string[1..-1] }.join.to_i(2)
+        bits_string.scan(/.{8}/).map { |byte_string| byte_string[1..] }.join.to_i(2)
       else
         bits_string.to_i(2)
       end
@@ -26,12 +26,12 @@ module WahWah
     end
 
     def self.file_format(file_path)
-      File.extname(file_path).downcase.delete('.')
+      File.extname(file_path).downcase.delete(".")
     end
 
     def self.byte_string_to_guid(byte_string)
-      guid = byte_string.unpack('NnnA*').pack('VvvA*').unpack('H*').first
-      [guid[0..7], guid[8..11], guid[12..15], guid[16..19], guid[20..-1]].join('-').upcase
+      guid = byte_string.unpack("NnnA*").pack("VvvA*").unpack1("H*")
+      [guid[0..7], guid[8..11], guid[12..15], guid[16..19], guid[20..]].join("-").upcase
     end
   end
 end

data/lib/wahwah/id3/comment_frame_body.rb

@@ -10,7 +10,7 @@ module WahWah
       # Short content description <textstring> $00 (00)
       # The actual text           <textstring>
       def parse
-        encoding_id, _language, reset_content = @content.unpack('CA3a*')
+        encoding_id, _language, reset_content = @content.unpack("CA3a*")
         encoding = ENCODING_MAPPING[encoding_id]
         _description, comment_text = Helper.split_with_terminator(reset_content, ENCODING_TERMINATOR_SIZE[encoding])
 

data/lib/wahwah/id3/frame.rb

@@ -95,7 +95,7 @@ module WahWah
         # So skip those 4 byte.
         if compressed? || data_length_indicator?
           @file_io.seek(4, IO::SEEK_CUR)
-          @size = @size - 4
+          @size -= 4
         end
       end
 
@@ -120,56 +120,57 @@ module WahWah
       end
 
       private
-        # ID3v2.2 frame header structure:
-        #
-        # Frame ID      $xx xx xx(tree characters)
-        # Size          3 * %xxxxxxxx
-        #
-        # ID3v2.3 frame header structure:
-        #
-        # Frame ID      $xx xx xx xx (four characters)
-        # Size          4 * %xxxxxxxx
-        # Flags         $xx xx
-        #
-        # ID3v2.4 frame header structure:
-        #
-        # Frame ID      $xx xx xx xx (four characters)
-        # Size          4 * %0xxxxxxx
-        # Flags         $xx xx
-        def parse_frame_header
-          header_size = @version == 2 ? 6 : 10
-          header_formate = @version == 2 ? 'A3B24' : 'A4B32B16'
-          id, size_bits, flags_bits = @file_io.read(header_size).unpack(header_formate)
-
-          @name = ID_MAPPING[id.to_sym]
-          @size = Helper.id3_size_caculate(size_bits, has_zero_bit: @version == 4)
-          @flags = parse_flags(flags_bits)
-        end
 
-        def parse_flags(flags_bits)
-          return [] if flags_bits.nil?
+      # ID3v2.2 frame header structure:
+      #
+      # Frame ID      $xx xx xx(tree characters)
+      # Size          3 * %xxxxxxxx
+      #
+      # ID3v2.3 frame header structure:
+      #
+      # Frame ID      $xx xx xx xx (four characters)
+      # Size          4 * %xxxxxxxx
+      # Flags         $xx xx
+      #
+      # ID3v2.4 frame header structure:
+      #
+      # Frame ID      $xx xx xx xx (four characters)
+      # Size          4 * %0xxxxxxx
+      # Flags         $xx xx
+      def parse_frame_header
+        header_size = @version == 2 ? 6 : 10
+        header_formate = @version == 2 ? "A3B24" : "A4B32B16"
+        id, size_bits, flags_bits = @file_io.read(header_size).unpack(header_formate)
+
+        @name = ID_MAPPING[id.to_sym]
+        @size = Helper.id3_size_caculate(size_bits, has_zero_bit: @version == 4)
+        @flags = parse_flags(flags_bits)
+      end
+
+      def parse_flags(flags_bits)
+        return [] if flags_bits.nil?
 
-          frame_flags_indications = @version == 4 ?
-            V4_HEADER_FLAGS_INDICATIONS :
-            V3_HEADER_FLAGS_INDICATIONS
+        frame_flags_indications = @version == 4 ?
+          V4_HEADER_FLAGS_INDICATIONS :
+          V3_HEADER_FLAGS_INDICATIONS
 
-          flags_bits.split('').map.with_index do |flag_bit, index|
-            frame_flags_indications[index] if flag_bit == '1'
-          end.compact
-        end
+        flags_bits.chars.map.with_index do |flag_bit, index|
+          frame_flags_indications[index] if flag_bit == "1"
+        end.compact
+      end
 
-        def frame_body_class
-          case @name
-          when :comment
-            CommentFrameBody
-          when :genre
-            GenreFrameBody
-          when :image
-            ImageFrameBody
-          else
-            TextFrameBody
-          end
+      def frame_body_class
+        case @name
+        when :comment
+          CommentFrameBody
+        when :genre
+          GenreFrameBody
+        when :image
+          ImageFrameBody
+        else
+          TextFrameBody
         end
+      end
     end
   end
 end

data/lib/wahwah/id3/frame_body.rb

@@ -9,16 +9,15 @@ module WahWah
       # $01   UTF-16 [UTF-16] encoded Unicode [UNICODE] with BOM.
       # $02   UTF-16BE [UTF-16] encoded Unicode [UNICODE] without BOM.
       # $03   UTF-8 [UTF-8] encoded Unicode [UNICODE].
-      ENCODING_MAPPING = %w(ISO-8859-1 UTF-16 UTF-16BE UTF-8)
+      ENCODING_MAPPING = %w[ISO-8859-1 UTF-16 UTF-16BE UTF-8]
 
       ENCODING_TERMINATOR_SIZE = {
-        'ISO-8859-1' => 1,
-        'UTF-16' => 2,
-        'UTF-16BE' => 2,
-        'UTF-8' => 1
+        "ISO-8859-1" => 1,
+        "UTF-16" => 2,
+        "UTF-16BE" => 2,
+        "UTF-8" => 1
       }
 
-
       attr_reader :value
 
       def initialize(content, version)
@@ -29,7 +28,7 @@ module WahWah
       end
 
       def parse
-        raise WahWahNotImplementedError, 'The parse method is not implemented'
+        raise WahWahNotImplementedError, "The parse method is not implemented"
       end
     end
   end

data/lib/wahwah/id3/image_frame_body.rb

@@ -3,7 +3,7 @@
 module WahWah
   module ID3
     class ImageFrameBody < FrameBody
-      TYPES = %i(
+      TYPES = %i[
         other
         file_icon
         other_file_icon
@@ -25,10 +25,10 @@ module WahWah
         illustration
         band_logotype
         publisher_logotype
-      )
+      ]
 
       def mime_type
-        mime_type = @mime_type.downcase.yield_self { |type| type == 'jpg' ? 'jpeg' : type }
+        mime_type = @mime_type.downcase.yield_self { |type| type == "jpg" ? "jpeg" : type }
         @version > 2 ? mime_type : "image/#{mime_type}"
       end
 
@@ -48,12 +48,12 @@ module WahWah
       # Description   <text string according to encoding> $00 (00)
       # Picture data  <binary data>
       def parse
-        frame_format = @version > 2 ? 'CZ*Ca*' : 'Ca3Ca*'
+        frame_format = @version > 2 ? "CZ*Ca*" : "Ca3Ca*"
         encoding_id, @mime_type, type_index, reset_content = @content.unpack(frame_format)
         encoding = ENCODING_MAPPING[encoding_id]
         _description, data = Helper.split_with_terminator(reset_content, ENCODING_TERMINATOR_SIZE[encoding])
 
-        @value = { data: data, mime_type: mime_type, type: TYPES[type_index] }
+        @value = {data: data, mime_type: mime_type, type: TYPES[type_index]}
       end
     end
   end

data/lib/wahwah/id3/text_frame_body.rb

@@ -8,7 +8,7 @@ module WahWah
       # Text encoding  $xx
       # Information    <text string according to encoding>
       def parse
-        encoding_id, text = @content.unpack('Ca*')
+        encoding_id, text = @content.unpack("Ca*")
         @value = Helper.encode_to_utf8(text, source_encoding: ENCODING_MAPPING[encoding_id])
       end
     end

data/lib/wahwah/id3/v1.rb

@@ -4,44 +4,44 @@ module WahWah
   module ID3
     class V1 < Tag
       TAG_SIZE = 128
-      TAG_ID = 'TAG'
-      DEFAULT_ENCODING = 'iso-8859-1'
+      TAG_ID = "TAG"
+      DEFAULT_ENCODING = "iso-8859-1"
       GENRES = [
         # Standard Genres
-        'Blues', 'Classic Rock', 'Country', 'Dance', 'Disco', 'Funk', 'Grunge',
-        'Hip-Hop', 'Jazz', 'Metal', 'New Age', 'Oldies', 'Other', 'Pop',
-        'R&B', 'Rap', 'Reggae', 'Rock', 'Techno', 'Industrial', 'Alternative',
-        'Ska', 'Death Metal', 'Pranks', 'Soundtrack', 'Euro-Techno', 'Ambient', 'Trip-Hop',
-        'Vocal', 'Jazz+Funk', 'Fusion', 'Trance', 'Classical', 'Instrumental', 'Acid',
-        'House', 'Game', 'Sound Clip', 'Gospel', 'Noise', 'AlternRock', 'Bass',
-        'Soul', 'Punk', 'Space', 'Meditative', 'Instrumental Pop', 'Instrumental Rock', 'Ethnic',
-        'Gothic', 'Darkwave', 'Techno-Industrial', 'Electronic', 'Pop-Folk', 'Eurodance', 'Dream',
-        'Southern Rock', 'Comedy', 'Cult', 'Gangsta', 'Top 40', 'Christian Rap', 'Pop/Funk',
-        'Jungle', 'Native American', 'Cabaret', 'New Wave', 'Psychadelic', 'Rave', 'Showtunes',
-        'Trailer', 'Lo-Fi', 'Tribal', 'Acid Punk', 'Acid Jazz', 'Polka', 'Retro',
-        'Musical', 'Rock & Roll', 'Hard Rock',
+        "Blues", "Classic Rock", "Country", "Dance", "Disco", "Funk", "Grunge",
+        "Hip-Hop", "Jazz", "Metal", "New Age", "Oldies", "Other", "Pop",
+        "R&B", "Rap", "Reggae", "Rock", "Techno", "Industrial", "Alternative",
+        "Ska", "Death Metal", "Pranks", "Soundtrack", "Euro-Techno", "Ambient", "Trip-Hop",
+        "Vocal", "Jazz+Funk", "Fusion", "Trance", "Classical", "Instrumental", "Acid",
+        "House", "Game", "Sound Clip", "Gospel", "Noise", "AlternRock", "Bass",
+        "Soul", "Punk", "Space", "Meditative", "Instrumental Pop", "Instrumental Rock", "Ethnic",
+        "Gothic", "Darkwave", "Techno-Industrial", "Electronic", "Pop-Folk", "Eurodance", "Dream",
+        "Southern Rock", "Comedy", "Cult", "Gangsta", "Top 40", "Christian Rap", "Pop/Funk",
+        "Jungle", "Native American", "Cabaret", "New Wave", "Psychadelic", "Rave", "Showtunes",
+        "Trailer", "Lo-Fi", "Tribal", "Acid Punk", "Acid Jazz", "Polka", "Retro",
+        "Musical", "Rock & Roll", "Hard Rock",
 
         # Winamp Extended Genres
-        'Folk', 'Folk-Rock', 'National Folk', 'Swing', 'Fast Fusion', 'Bebob', 'Latin',
-        'Revival', 'Celtic', 'Bluegrass', 'Avantgarde', 'Gothic Rock', 'Progressive Rock', 'Psychedelic Rock',
-        'Symphonic Rock', 'Slow Rock', 'Big Band', 'Chorus', 'Easy Listening', 'Acoustic', 'Humour',
-        'Speech', 'Chanson', 'Opera', 'Chamber Music', 'Sonata', 'Symphony', 'Booty Bass',
-        'Primus', 'Porn Groove', 'Satire', 'Slow Jam', 'Club', 'Tango', 'Samba',
-        'Folklore', 'Ballad', 'Power Ballad', 'Rhythmic Soul', 'Freestyle', 'Duet', 'Punk Rock',
-        'Drum Solo', 'A capella', 'Euro-House', 'Dance Hall', 'Goa', 'Drum & Bass', 'Club-House',
-        'Hardcore Techno', 'Terror', 'Indie', 'BritPop', 'Negerpunk', 'Polsk Punk', 'Beat',
-        'Christian Gangsta Rap', 'Heavy Metal', 'Black Metal', 'Contemporary Christian', 'Christian Rock',
+        "Folk", "Folk-Rock", "National Folk", "Swing", "Fast Fusion", "Bebob", "Latin",
+        "Revival", "Celtic", "Bluegrass", "Avantgarde", "Gothic Rock", "Progressive Rock", "Psychedelic Rock",
+        "Symphonic Rock", "Slow Rock", "Big Band", "Chorus", "Easy Listening", "Acoustic", "Humour",
+        "Speech", "Chanson", "Opera", "Chamber Music", "Sonata", "Symphony", "Booty Bass",
+        "Primus", "Porn Groove", "Satire", "Slow Jam", "Club", "Tango", "Samba",
+        "Folklore", "Ballad", "Power Ballad", "Rhythmic Soul", "Freestyle", "Duet", "Punk Rock",
+        "Drum Solo", "A capella", "Euro-House", "Dance Hall", "Goa", "Drum & Bass", "Club-House",
+        "Hardcore Techno", "Terror", "Indie", "BritPop", "Negerpunk", "Polsk Punk", "Beat",
+        "Christian Gangsta Rap", "Heavy Metal", "Black Metal", "Contemporary Christian", "Christian Rock",
 
         # Added on WinAmp 1.91
-        'Merengue', 'Salsa', 'Thrash Metal', 'Anime', 'Jpop', 'Synthpop',
+        "Merengue", "Salsa", "Thrash Metal", "Anime", "Jpop", "Synthpop",
 
         # Added on WinAmp 5.6
-        'Abstract', 'Art Rock', 'Baroque', 'Bhangra', 'Big Beat', 'Breakbeat', 'Chillout',
-        'Downtempo', 'Dub', 'EBM', 'Eclectic', 'Electro', 'Electroclash', 'Emo',
-        'Experimental', 'Garage', 'Illbient', 'Industro-Goth', 'Jam Band', 'Krautrock', 'Leftfield',
-        'Lounge', 'Math Rock', 'New Romantic', 'Nu-Breakz', 'Post-Punk', 'Post-Rock', 'Psytrance',
-        'Shoegaze', 'Space Rock', 'Trop Rock', 'World Music', 'Neoclassical', 'Audiobook', 'Audio Theatre',
-        'Neue Deutsche Welle', 'Podcast', 'Indie Rock', 'G-Funk', 'Dubstep', 'Garage Rock', 'Psybient'
+        "Abstract", "Art Rock", "Baroque", "Bhangra", "Big Beat", "Breakbeat", "Chillout",
+        "Downtempo", "Dub", "EBM", "Eclectic", "Electro", "Electroclash", "Emo",
+        "Experimental", "Garage", "Illbient", "Industro-Goth", "Jam Band", "Krautrock", "Leftfield",
+        "Lounge", "Math Rock", "New Romantic", "Nu-Breakz", "Post-Punk", "Post-Rock", "Psytrance",
+        "Shoegaze", "Space Rock", "Trop Rock", "World Music", "Neoclassical", "Audiobook", "Audio Theatre",
+        "Neue Deutsche Welle", "Podcast", "Indie Rock", "G-Funk", "Dubstep", "Garage Rock", "Psybient"
       ]
 
       def size
@@ -49,7 +49,7 @@ module WahWah
       end
 
       def version
-        'v1'
+        "v1"
       end
 
       def valid?
@@ -57,40 +57,41 @@ module WahWah
       end
 
       private
-        # For ID3v1 info, see here https://en.wikipedia.org/wiki/ID3#ID3v1
-        #
-        # header    3         "TAG"
-        # title     30        30 characters of the title
-        # artist    30        30 characters of the artist name
-        # album     30        30 characters of the album name
-        # year      4         A four-digit year
-        # comment   28 or 30  The comment.
-        # zero-byte 1         If a track number is stored, this byte contains a binary 0.
-        # track     1         The number of the track on the album, or 0. Invalid, if previous byte is not a binary 0.
-        # genre     1         Index in a list of genres, or 255
-        def parse
-          return unless @file_io.size >= TAG_SIZE
 
-          @file_io.seek(-TAG_SIZE, IO::SEEK_END)
-          @id = Helper.encode_to_utf8(@file_io.read(3), source_encoding: DEFAULT_ENCODING)
+      # For ID3v1 info, see here https://en.wikipedia.org/wiki/ID3#ID3v1
+      #
+      # header    3         "TAG"
+      # title     30        30 characters of the title
+      # artist    30        30 characters of the artist name
+      # album     30        30 characters of the album name
+      # year      4         A four-digit year
+      # comment   28 or 30  The comment.
+      # zero-byte 1         If a track number is stored, this byte contains a binary 0.
+      # track     1         The number of the track on the album, or 0. Invalid, if previous byte is not a binary 0.
+      # genre     1         Index in a list of genres, or 255
+      def parse
+        return unless @file_io.size >= TAG_SIZE
 
-          return unless valid?
+        @file_io.seek(-TAG_SIZE, IO::SEEK_END)
+        @id = Helper.encode_to_utf8(@file_io.read(3), source_encoding: DEFAULT_ENCODING)
 
-          @title = Helper.encode_to_utf8(@file_io.read(30), source_encoding: DEFAULT_ENCODING)
-          @artist = Helper.encode_to_utf8(@file_io.read(30), source_encoding: DEFAULT_ENCODING)
-          @album = Helper.encode_to_utf8(@file_io.read(30), source_encoding: DEFAULT_ENCODING)
-          @year = Helper.encode_to_utf8(@file_io.read(4), source_encoding: DEFAULT_ENCODING)
+        return unless valid?
 
-          comment = @file_io.read(30)
+        @title = Helper.encode_to_utf8(@file_io.read(30), source_encoding: DEFAULT_ENCODING)
+        @artist = Helper.encode_to_utf8(@file_io.read(30), source_encoding: DEFAULT_ENCODING)
+        @album = Helper.encode_to_utf8(@file_io.read(30), source_encoding: DEFAULT_ENCODING)
+        @year = Helper.encode_to_utf8(@file_io.read(4), source_encoding: DEFAULT_ENCODING)
 
-          if comment.getbyte(-2) == 0
-            @track = comment.getbyte(-1)
-            comment = comment.byteslice(0..-3)
-          end
+        comment = @file_io.read(30)
 
-          @comments.push(Helper.encode_to_utf8(comment, source_encoding: DEFAULT_ENCODING))
-          @genre = GENRES[@file_io.getbyte] || ''
+        if comment.getbyte(-2) == 0
+          @track = comment.getbyte(-1)
+          comment = comment.byteslice(0..-3)
         end
+
+        @comments.push(Helper.encode_to_utf8(comment, source_encoding: DEFAULT_ENCODING))
+        @genre = GENRES[@file_io.getbyte] || ""
+      end
     end
   end
 end

data/lib/wahwah/id3/v2.rb

@@ -12,50 +12,56 @@ module WahWah
       end
 
       private
-        def parse
-          @file_io.rewind
-          @header = V2Header.new(@file_io)
 
-          return unless valid?
+      def parse
+        @file_io.rewind
+        @header = V2Header.new(@file_io)
 
-          until end_of_tag? do
-            frame = ID3::Frame.new(@file_io, major_version)
-            (frame.skip; next) unless frame.valid?
+        return unless valid?
 
-            update_attribute(frame)
-          end
-        end
+        until end_of_tag?
+          frame = ID3::Frame.new(@file_io, major_version)
 
-        def update_attribute(frame)
-          name = frame.name
-
-          case name
-          when :comment
-            # Because there may be more than one comment frame in each tag,
-            # so push it into a array.
-            @comments.push(frame.value)
-          when :image
-            # Because there may be more than one image frame in each tag,
-            # so push it into a array.
-            @images_data.push(frame); frame.skip
-          when :track, :disc
-            # Track and disc value may be extended with a "/" character
-            # and a numeric string containing the total numer.
-            count, total_count = frame.value.split('/', 2)
-            instance_variable_set("@#{name}", count)
-            instance_variable_set("@#{name}_total", total_count) unless total_count.nil?
-          else
-            instance_variable_set("@#{name}", frame.value)
+          unless frame.valid?
+            frame.skip
+            next
           end
-        end
 
-        def end_of_tag?
-          size <= @file_io.pos || file_size <= @file_io.pos
+          update_attribute(frame)
         end
+      end
+
+      def update_attribute(frame)
+        name = frame.name
 
-        def parse_image_data(image_frame)
-          image_frame.value
+        case name
+        when :comment
+          # Because there may be more than one comment frame in each tag,
+          # so push it into a array.
+          @comments.push(frame.value)
+        when :image
+          # Because there may be more than one image frame in each tag,
+          # so push it into a array.
+          @images_data.push(frame)
+          frame.skip
+        when :track, :disc
+          # Track and disc value may be extended with a "/" character
+          # and a numeric string containing the total numer.
+          count, total_count = frame.value.split("/", 2)
+          instance_variable_set("@#{name}", count)
+          instance_variable_set("@#{name}_total", total_count) unless total_count.nil?
+        else
+          instance_variable_set("@#{name}", frame.value)
         end
+      end
+
+      def end_of_tag?
+        size <= @file_io.pos || file_size <= @file_io.pos
+      end
+
+      def parse_image_data(image_frame)
+        image_frame.value
+      end
     end
   end
 end

data/lib/wahwah/id3/v2_header.rb

@@ -10,9 +10,9 @@ module WahWah
     # ID3v2 flags             %abc00000
     # ID3v2 size              4 * %0xxxxxxx
     class V2Header
-      TAG_ID = 'ID3'
+      TAG_ID = "ID3"
       HEADER_SIZE = 10
-      HEADER_FORMAT = 'A3CxB8B*'
+      HEADER_FORMAT = "A3CxB8B*"
 
       attr_reader :major_version, :size
 
@@ -34,7 +34,7 @@ module WahWah
           # Size of padding        $xx xx xx xx
 
           # Skip extended_header
-          extended_header_size = Helper.id3_size_caculate(file_io.read(4).unpack('B32').first)
+          extended_header_size = Helper.id3_size_caculate(file_io.read(4).unpack1("B32"))
           file_io.seek(extended_header_size - 4, IO::SEEK_CUR)
         end
       end
@@ -46,7 +46,7 @@ module WahWah
       # The second bit in flags byte indicates whether or not the header
       # is followed by an extended header.
       def has_extended_header?
-        @flags[1] == '1'
+        @flags[1] == "1"
       end
     end
   end

data/lib/wahwah/lazy_read.rb

@@ -31,9 +31,10 @@ module WahWah
     end
 
     private
-      def get_data
-        @file_io.seek(@position)
-        @file_io.read(size)
-      end
+
+    def get_data
+      @file_io.seek(@position)
+      @file_io.read(size)
+    end
   end
 end