Class: Id3Taginator::Frames::Text::CopyrightFrame

Inherits:
Id3v2Frame
  • Object
show all
Includes:
HasId
Defined in:
lib/id3taginator/frames/text/tcop_copyright_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

#holder ⇒ Object

Returns the value of attribute holder.



11
12
13
 
# File 'lib/id3taginator/frames/text/tcop_copyright_frame.rb', line 11

def holder
  @holder
end

#year ⇒ Object

Returns the value of attribute year.



11
12
13
 
# File 'lib/id3taginator/frames/text/tcop_copyright_frame.rb', line 11

def year
  @year
end

Class Method Details

.build_frame(year, holder, options = nil, id3_version: 3) ⇒ Id3v2Frame

builds the copyright frame

Parameters:

  • year (String) —

    the 4 character year e.g. 2020

  • holder (String) —

    the copyright holder

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

    options to use

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

    the id3 version to build the frame for

Returns:



21
22
23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/id3taginator/frames/text/tcop_copyright_frame.rb', line 21

def self.build_frame(year, holder, options = nil, id3_version: 3)
  supported?('TCOP', id3_version, options)

  year = year.to_s unless year.nil?

  argument_exactly_chars(year, 'year', 4)
  argument_not_nil(holder, 'holder')

  frame = new(frame_id(id3_version, options), 0, build_id3_flags(id3_version), '')
  frame.year = year
  frame.holder = holder
  frame
end

Instance Method Details

#content_to_bytes ⇒ Object 



48
49
50
51
 
# File 'lib/id3taginator/frames/text/tcop_copyright_frame.rb', line 48

def content_to_bytes
  content = "#{@year} #{@holder} Copyright ©"
  encode_and_add_encoding_byte(content)
end

#process_content(content) ⇒ Object 



35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/id3taginator/frames/text/tcop_copyright_frame.rb', line 35

def process_content(content)
  content = decode_using_encoding_byte(content)
  if content[4] == ' '
    @year = content[0..3]
    content = content[4..-1]
  else
    @year = 1970
  end

  content = content.gsub('Copyright ©', '')
  @holder = content.strip
end