Class: Id3Taginator::Frames::Count::PopularityFrame

Inherits:
Id3v2Frame
  • Object
show all
Includes:
HasId
Defined in:
lib/id3taginator/frames/count/popm_popularimeter_frame.rb

Constant Summary

Constants inherited from Id3v2Frame

Id3v2Frame::HEADER_SIZE_V_2, Id3v2Frame::HEADER_SIZE_V_3_4

Constants included from Extensions::Encodable

Extensions::Encodable::ISO8859_1, Extensions::Encodable::UNICODE_ZERO, Extensions::Encodable::UTF_16, Extensions::Encodable::UTF_16BE, Extensions::Encodable::UTF_8, Extensions::Encodable::ZERO

Instance Attribute Summary collapse

Attributes inherited from Id3v2Frame

#frame_id, #options

Class Method Summary collapse

Instance Method Summary collapse

Methods included from HasId

#frame_info, included, #supported?

Methods inherited from Id3v2Frame

build_id3_flags, build_v2_frame, build_v3_frame, build_v4_frame, #compression?, #encryption?, #file_alter_preservation?, #frame_size, #group_identity?, #initialize, #re_calc_payload_size, #read_only?, #tag_alter_preservation?, #to_bytes

Methods included from Extensions::ArgumentCheck

#argument_between_num, #argument_boolean, #argument_exactly_chars, #argument_less_than_chars, #argument_more_than_chars, #argument_not_empty, #argument_not_nil, #argument_sym, included

Methods included from Extensions::Encodable

#decode, #decode_using_encoding_byte, #default_encoding_destination_byte, #encode, #encode_and_add_encoding_byte, #encode_string, #find_encoding, #find_encoding_byte, included, #merge, #pad_left, #pad_right, #read_stream_until, #remove_trailing_zeros, #zero_byte

Constructor Details

This class inherits a constructor from Id3Taginator::Frames::Id3v2Frame

Instance Attribute Details

#counter ⇒ Object

Returns the value of attribute counter.



11
12
13
 
# File 'lib/id3taginator/frames/count/popm_popularimeter_frame.rb', line 11

def counter
  @counter
end

#email ⇒ Object

Returns the value of attribute email.



11
12
13
 
# File 'lib/id3taginator/frames/count/popm_popularimeter_frame.rb', line 11

def email
  @email
end

#rating ⇒ Object

Returns the value of attribute rating.



11
12
13
 
# File 'lib/id3taginator/frames/count/popm_popularimeter_frame.rb', line 11

def rating
  @rating
end

Class Method Details

.build_frame(email, rating, counter, options = nil, id3_version: 3) ⇒ Id3v2Frame

builds the popularimeter frame

Parameters:

  • email (String) —

    email of the user

  • rating (Integer) —

    the rating between 0 and 255

  • counter (Integer) —

    the counter, default 32 bit integer, but can be higher too

  • options (Options::Options) (defaults to: nil) —

    options to use

  • id3_version (Integer) (defaults to: 3) —

    the id3 version to build the frame for

Returns:



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/id3taginator/frames/count/popm_popularimeter_frame.rb', line 22

def self.build_frame(email, rating, counter, options = nil, id3_version: 3)
  supported?('POPM', id3_version, options)

  argument_not_nil(email, 'email')
  argument_not_nil(counter, 'counter')

  rating ||= 0
  argument_between_num(rating, 'rating', 0, 255)

  frame = new(frame_id(id3_version, options), 0, build_id3_flags(id3_version), '')
  frame.email = email
  frame.rating = rating
  frame.counter = counter
  frame
end

Instance Method Details

#content_to_bytes ⇒ Object 



45
46
47
48
 
# File 'lib/id3taginator/frames/count/popm_popularimeter_frame.rb', line 45

def content_to_bytes
  counter = Util::MathUtil.from_number(@counter, 8, '0')
  merge(@email, "\x00", @rating.chr, counter)
end

#process_content(content) ⇒ Object 



38
39
40
41
42
43
 
# File 'lib/id3taginator/frames/count/popm_popularimeter_frame.rb', line 38

def process_content(content)
  stream = StringIO.new(content)
  @email = read_stream_until(stream, ZERO)
  @rating = stream.readbyte
  @counter = Util::MathUtil.to_number(stream.read&.bytes)
end