id3tag 0.1.1 → 0.2.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NzNiYTE0YzFlYTA3ZGVhZDVhMDA4ZWUwNTU4ODcxNTc0ODQzMDg4MQ==
-  data.tar.gz: !binary |-
-    ODNiYzM1NTUzNDg4YmJiNGExY2M4YjdkZjg4MjZlODYzMDc1YzNlOA==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    NTc3ZDYzY2FiYWEwNTgzOGU4MjM1NDYxYTU1NDgyNzZlYWVhNGRjOTAzZDk1
-    YmVhMTViOThlYmMxZDRkNzVmMDRkMGViZGU2MWY5ZjViY2IxMTMyOTIwYjUy
-    NmRhZWNkNDliMjA2MDliMGFmNDM3MzI5NWVmZTM0OTNjY2QzMmM=
-  data.tar.gz: !binary |-
-    MGE3NWQwMGM4MmQ3M2E3ZTkxNWMxYzkzODk2MTAxOThjYTc4ODllMGI1Yjgy
-    MGU1ZTdhZTMyYjdlYmFmMzFlMDZiZjIyN2IzMzk0NjYxZTJiNzk3YzdjMzg0
-    OTNmN2EwMWY5NGM3MzZkMmEwZDkwZmI0MmZkYTY2NzNiNjkzNTk=
+SHA1:
+  metadata.gz: d7e015abc718273110bec0cb6fcdb8036de50f37
+  data.tar.gz: 0b3b5d6b9acdd5cf5393fc9a97ef594f393e0101
+SHA512:
+  metadata.gz: 1db6cc3bd2407e2bfc6a172e508adc8b11907bd00903b9006aea4b94d0d1c8c620351dc6f22de95405ea6fb16e0784b42456bbde45121fdc56b1e0b44bb0f6e3
+  data.tar.gz: 3357247645ce3d9c07be8b0633c95a782361471297bc9bfaefc2d1566db2f4f584adba69c0678dab721e2597986fb9aa11e45149e3c4a13fb2df8cd678da6fa5

data/Gemfile.lock

@@ -1,32 +1,63 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    colorize (0.5.8)
+    addressable (2.3.5)
+    builder (3.2.2)
     columnize (0.3.6)
-    coveralls (0.6.7)
-      colorize
+    coveralls (0.7.0)
       multi_json (~> 1.3)
       rest-client
       simplecov (>= 0.7)
+      term-ansicolor
       thor
-    debugger (1.5.0)
+    debugger (1.6.2)
       columnize (>= 0.3.1)
       debugger-linecache (~> 1.2.0)
-      debugger-ruby_core_source (~> 1.2.0)
+      debugger-ruby_core_source (~> 1.2.3)
     debugger-linecache (1.2.0)
-    debugger-ruby_core_source (1.2.0)
-    diff-lcs (1.2.2)
-    git (1.2.5)
-    jeweler (1.8.4)
+    debugger-ruby_core_source (1.2.3)
+    diff-lcs (1.2.4)
+    faraday (0.8.8)
+      multipart-post (~> 1.2.0)
+    git (1.2.6)
+    github_api (0.10.1)
+      addressable
+      faraday (~> 0.8.1)
+      hashie (>= 1.2)
+      multi_json (~> 1.4)
+      nokogiri (~> 1.5.2)
+      oauth2
+    hashie (2.0.5)
+    highline (1.6.19)
+    httpauth (0.2.0)
+    jeweler (1.8.8)
+      builder
       bundler (~> 1.0)
       git (>= 1.2.5)
+      github_api (= 0.10.1)
+      highline (>= 1.6.15)
+      nokogiri (= 1.5.10)
       rake
       rdoc
-    json (1.7.7)
-    json (1.7.7-java)
-    mime-types (1.23)
-    multi_json (1.6.1)
-    rake (10.0.3)
+    json (1.8.0)
+    json (1.8.0-java)
+    jwt (0.1.8)
+      multi_json (>= 1.5)
+    mime-types (1.25)
+    multi_json (1.8.2)
+    multi_xml (0.5.5)
+    multipart-post (1.2.0)
+    nokogiri (1.5.10)
+    nokogiri (1.5.10-java)
+    oauth2 (0.9.2)
+      faraday (~> 0.8)
+      httpauth (~> 0.2)
+      jwt (~> 0.1.4)
+      multi_json (~> 1.0)
+      multi_xml (~> 0.5)
+      rack (~> 1.2)
+    rack (1.5.2)
+    rake (10.1.0)
     rdoc (3.12.2)
       json (~> 1.4)
     rest-client (1.6.7)
@@ -38,12 +69,15 @@ GEM
     rspec-core (2.13.1)
     rspec-expectations (2.13.0)
       diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.13.0)
+    rspec-mocks (2.13.1)
     simplecov (0.7.1)
       multi_json (~> 1.0)
       simplecov-html (~> 0.7.1)
     simplecov-html (0.7.1)
+    term-ansicolor (1.2.2)
+      tins (~> 0.8)
     thor (0.18.1)
+    tins (0.12.0)
 
 PLATFORMS
   java

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.2.0

data/id3tag.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "id3tag"
-  s.version = "0.1.1"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Krists Ozols"]
-  s.date = "2013-05-13"
+  s.date = "2013-10-19"
   s.description = "Native Ruby ID3 tag reader that aims for 100% covarage of ID3v2.x and ID3v1.x standards"
   s.email = "krists@iesals.lv"
   s.extra_rdoc_files = [
@@ -38,6 +38,7 @@ Gem::Specification.new do |s|
     "lib/id3tag/frames/v2/basic_frame.rb",
     "lib/id3tag/frames/v2/comments_frame.rb",
     "lib/id3tag/frames/v2/frame_fabricator.rb",
+    "lib/id3tag/frames/v2/frame_flags.rb",
     "lib/id3tag/frames/v2/genre_frame.rb",
     "lib/id3tag/frames/v2/genre_frame/genre_parser.rb",
     "lib/id3tag/frames/v2/genre_frame/genre_parser_24.rb",
@@ -67,6 +68,7 @@ Gem::Specification.new do |s|
     "spec/lib/id3tag/frames/v2/basic_frame_spec.rb",
     "spec/lib/id3tag/frames/v2/comments_frame_spec.rb",
     "spec/lib/id3tag/frames/v2/frame_fabricator_spec.rb",
+    "spec/lib/id3tag/frames/v2/frame_flags_spec.rb",
     "spec/lib/id3tag/frames/v2/genre_frame/genre_parser_24_spec.rb",
     "spec/lib/id3tag/frames/v2/genre_frame/genre_parser_pre_24_spec.rb",
     "spec/lib/id3tag/frames/v2/genre_frame/genre_parser_spec.rb",
@@ -82,7 +84,12 @@ Gem::Specification.new do |s|
     "spec/lib/id3tag/synchsafe_integer_spec.rb",
     "spec/lib/id3tag/tag_spec.rb",
     "spec/spec_helper.rb",
-    "spec/support/mp3_fixtures.rb"
+    "spec/support/mp3_fixtures.rb",
+    "standard_documents/id3v2-00.txt",
+    "standard_documents/id3v2.3.0.txt",
+    "standard_documents/id3v2.4.0-frames.txt",
+    "standard_documents/id3v2.4.0-structure.txt",
+    "tags"
   ]
   s.homepage = "http://github.com/krists/id3tag"
   s.licenses = ["MIT"]

data/lib/id3tag.rb

@@ -23,6 +23,7 @@ require "id3tag/frames/v2/genre_frame/genre_parser"
 require "id3tag/frames/v2/genre_frame/genre_parser_pre_24"
 require "id3tag/frames/v2/genre_frame/genre_parser_24"
 require "id3tag/frames/v2/frame_fabricator"
+require "id3tag/frames/v2/frame_flags"
 
 module ID3Tag
   def self.read(source, version = :all)

data/lib/id3tag/frame_id_advisor.rb

@@ -47,10 +47,14 @@ module ID3Tag
       version_ids && version_ids[frame_name]
     end
 
+    def version_of_interest
+      "v#{@version}.#{@major_version}"
+    end
+
     private
 
     def version_ids
-      COMMON_FRAME_IDS_BY_VERSION["v#{@version}.#{@major_version}"]
+      COMMON_FRAME_IDS_BY_VERSION.fetch(version_of_interest)
     end
   end
 end

data/lib/id3tag/frames/v2/basic_frame.rb

@@ -2,23 +2,117 @@ module  ID3Tag
   module Frames
     module  V2
       class BasicFrame
-        attr_reader :id
+        DECOMPRESSED_SIZE_BYTE_COUNT = 4
+        GROUP_BYTE_COUNT = 1
+
+        attr_reader :id, :raw_content
+
         def initialize(id, content, flags, major_version_number)
           @id, @raw_content, @flags, @major_version_number = id.to_sym, content, flags, major_version_number
         end
 
         def content
-          @raw_content
+          usable_content
+        end
+
+        def usable_content
+          raw_content_io.seek(additional_info_byte_count)
+          if unsynchronised?
+            StringUtil.undo_unsynchronization(raw_content_io.read)
+          else
+            raw_content_io.read
+          end
+        end
+
+        def group_id
+          read_additional_info_byte(*position_and_count_of_group_id_bytes) if grouped?
+        end
+
+        def encryption_id
+          read_additional_info_byte(*position_and_count_of_encryption_id_bytes) if encrypted?
+        end
+
+        def read_additional_info_byte(position, byte_count)
+          if position && byte_count
+            raw_content_io.seek(position)
+            raw_content_io.read(byte_count).unpack("C").first
+          end
+        end
+
+        def final_size
+          pos, count = position_and_count_of_data_length_bytes
+          if (compressed? || data_length_indicator?) && pos && count
+            raw_content_io.seek(pos)
+            SynchsafeInteger.decode(NumberUtil.convert_string_to_32bit_integer(raw_content_io.read(count)))
+          else
+            raw_content_io.size
+          end
+        end
+
+        def preserve_on_file_alteration?
+          frame_flags.preserve_on_file_alteration?
+        end
+
+        def preserve_on_tag_alteration?
+          frame_flags.preserve_on_tag_alteration?
+        end
+
+        def read_only?
+          frame_flags.read_only?
+        end
+
+        def compressed?
+          frame_flags.compressed?
+        end
+
+        def encrypted?
+          frame_flags.encrypted?
+        end
+
+        def grouped?
+          frame_flags.grouped?
+        end
+
+        def unsynchronised?
+          frame_flags.unsynchronised?
+        end
+
+        def data_length_indicator?
+          frame_flags.data_length_indicator?
         end
 
         def inspect
-          "<#{self.class.name} #{id}: #{inspect_content}>"
+          "<#{self.class.name} #{id}: #{inspectable_content}>"
+        end
+
+        def inspectable_content
+          content
         end
 
         private
 
-        def inspect_content
-          content
+        def additional_info_byte_count
+          frame_flags.additional_info_byte_count
+        end
+
+        def position_and_count_of_data_length_bytes
+          frame_flags.position_and_count_of_data_length_bytes
+        end
+
+        def position_and_count_of_group_id_bytes
+          frame_flags.position_and_count_of_group_id_bytes
+        end
+
+        def position_and_count_of_encryption_id_bytes
+          frame_flags.position_and_count_of_encryption_id_bytes
+        end
+
+        def frame_flags
+          @frame_flags ||= FrameFlags.new(@flags, @major_version_number)
+        end
+
+        def raw_content_io
+          @raw_content_io ||= StringIO.new(raw_content)
         end
       end
     end

data/lib/id3tag/frames/v2/frame_flags.rb

@@ -0,0 +1,140 @@
+module  ID3Tag
+  module Frames
+    module  V2
+      class FrameFlags
+        FLAG_MAP_IN_APPEARANCE_ORDER_BY_VERSION = {
+          3 => {
+            :status_flags => [ :preserve_on_tag_alteration, :preserve_on_file_alteration, :read_only, nil, nil, nil, nil, nil ],
+            :format_flags => [ :compressed, :encrypted, :grouped, nil, nil, nil, nil, nil ]
+          },
+          4 => {
+            :status_flags => [ nil, :preserve_on_tag_alteration, :preserve_on_file_alteration, :read_only, nil, nil, nil, nil ],
+            :format_flags => [ nil, :grouped, nil, nil, :compressed, :encrypted, :unsynchronised, :data_length_indicator ]
+          }
+        }
+
+        ADDITIONAL_INFO_BYTES_IN_APPEARANCE_ORDER_BY_VERSION = {
+          3 => [
+            [:compressed?, 4], [:encrypted?, 1], [:grouped?, 1]
+          ],
+          4 => [
+            [:grouped?, 1], [:encrypted?, 1], [:data_length_indicator?, 4]
+          ]
+        }
+
+        def initialize(flag_bytes, major_version_number)
+          @flag_bytes = flag_bytes
+          @major_version_number = major_version_number
+        end
+
+        def preserve_on_tag_alteration?
+          flag(:status_flags, :preserve_on_tag_alteration) != 1
+        end
+
+        def preserve_on_file_alteration?
+          flag(:status_flags, :preserve_on_file_alteration) != 1
+        end
+
+        def read_only?
+          flag(:status_flags, :read_only) == 1
+        end
+
+        def compressed?
+          flag(:format_flags, :compressed) == 1
+        end
+
+        def encrypted?
+          flag(:format_flags, :encrypted) == 1
+        end
+
+        def grouped?
+          flag(:format_flags, :grouped) == 1
+        end
+
+        def unsynchronised?
+          flag(:format_flags, :unsynchronised) == 1
+        end
+
+        def data_length_indicator?
+          flag(:format_flags, :data_length_indicator) == 1
+        end
+
+        def additional_info_byte_count
+          additional_info_flags_in_effect.inject(0) do |total, query|
+            total += query.last
+            total
+          end
+        end
+
+        def position_and_count_of_data_length_bytes
+          if data_length_indicator? || compressed?
+            find_position_and_length_for_additional_info(:data_length_indicator?, :compressed?)
+          end
+        end
+
+        def position_and_count_of_group_id_bytes
+          if grouped?
+            find_position_and_length_for_additional_info(:grouped?)
+          end
+        end
+
+        def position_and_count_of_encryption_id_bytes
+          if encrypted?
+            find_position_and_length_for_additional_info(:encrypted?)
+          end
+        end
+
+        def find_position_and_length_for_additional_info(*methods_of_interest)
+          start_position = 0
+          target_info_byte_count = nil
+          additional_info_flags_in_effect.map do |query_method, byte_count|
+            start_position += (byte_count) unless methods_of_interest.include?(query_method)
+            if methods_of_interest.include?(query_method)
+              target_info_byte_count = byte_count
+              break
+            end
+          end
+          [start_position, target_info_byte_count]
+        end
+
+        def additional_info_flags_in_effect
+          current_additional_info_map.reject { |q| !self.send(q.first) }
+        end
+
+        private
+
+        def flag(scope, name)
+          index = index_of_flag(scope, name)
+          if index
+            flags = flags_for_scope(scope)
+            flags && flags[7 - index]
+          end
+        end
+
+        def flags_for_scope(scope)
+          pair = @flag_bytes.to_s.unpack("C2")
+          case scope
+          when :status_flags
+            pair.first
+          when :format_flags
+            pair.last
+          end
+        end
+
+        def index_of_flag(scope, name)
+          current_flag_map[scope].find_index(name)
+        end
+
+        def current_flag_map
+          FLAG_MAP_IN_APPEARANCE_ORDER_BY_VERSION.fetch(@major_version_number) do
+            { :status_flags => [], :format_flags => [] }
+          end
+        end
+
+        def current_additional_info_map
+          ADDITIONAL_INFO_BYTES_IN_APPEARANCE_ORDER_BY_VERSION.fetch(@major_version_number) { [] }
+        end
+      end
+    end
+  end
+end