popcap 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 06018b8dc59e4e1f5e4a71499b2761a66263fcb3
-  data.tar.gz: 75e7e1d1d0d817d2d53bebdf7be0ffba63f2cd54
+  metadata.gz: fe1804b885ed55227148832677e5697bd95d8ca8
+  data.tar.gz: f0d5ac62e3690a6aaaca546a7abc86a218268366
 SHA512:
-  metadata.gz: fd92273467cde9d7ebc21c8717034bfa54ed26aeebb56b07374ca77917f248d14c0d76fb3e8e3c6fe70980754f60d06d4149a471e0cb77904c5583e39e2aa77c
-  data.tar.gz: 343bf09d55d5e5f913a5cfc4b0e2d53ee88b039b7229a0c0889ee725396251952c66b4d3fbd5e3307240bc81e51407c18751e2eef7c4eff66f4f074f5a907a33
+  metadata.gz: 6c0bd62beca21f4fe86bee66638c69a594deb3418e1b9b12e6c5072dac4930482bc953c4f7404ab71e3fc3fefeb641b906e67d32fb7fa7debffa8d90df35992e
+  data.tar.gz: 7d11a95c9bc6829996d744764006ab049fbc5ac3b67eada66ae779aeb96475df35b71bfdcc07eda01cf9b73796556345258733abfbd4a543132f7ccf1775923e

data/README.md

@@ -22,40 +22,71 @@ Read the metadata tags from an audio file.
 ```
 audio_file = PopCap::AudioFile.new('sample.flac')
 
-audio_file.raw_tags => Returns JSON for the raw output from running ffprobe -show_format.
-
-audio_file.unformatted => Returns a Ruby hash after sanitizing the raw output of #raw_tags.
-    { filename: 'sample.flac',
-      format_name: 'flac',
-      format_long_name: 'raw FLAC',
-      nb_streams: '1',
-      duration: '1.000000',
-      filesize: '18291',
-      bit_rate: '146328',
-      start_time: 'N/A',
-      genre: 'Sample Genre',
-      track: '01',
-      album: 'Sample Album',
-      date: '2012',
-      title: 'Sample Title',
-      artist: 'Sample Artist' }
-
-audio_file.formatted => Returns a Ruby hash after sanitizing the raw output of #raw_tags.  It also applies internal formatters to make fields such as duration, bit_rate, filesize, & date human readable.
-
-    { filename: 'sample.flac',
-      format_name: 'flac',
-      format_long_name: 'raw FLAC',
-      nb_streams: '1',
-      duration: '1.000000',
-      filesize: '18291',
-      bit_rate: '146328',
-      start_time: 'N/A',
-      genre: 'Sample Genre',
-      track: '01',
-      album: 'Sample Album',
-      date: '2012',
-      title: 'Sample Title',
-      artist: 'Sample Artist' }
+audio_file.raw_output => Returns JSON for the raw output from 
+running "ffprobe -show_format -print_format json."
+
+      { 
+        "format": 
+          { 
+            "filename":"spec/fixtures/sample.flac",
+            "nb_streams":1,
+            "format_name":"flac",
+            "format_long_name":"raw FLAC",
+            "duration":"1.000000",
+            "size":"18291",
+            "bit_rate":"146328",
+
+              "tags": 
+              { 
+                "GENRE":"Sample Genre",
+                "track":"01",
+                "ALBUM":"Sample Album",
+                "DATE":"2012",
+                "TITLE":"Sample Title",
+                "ARTIST":"Sample Artist" 
+              }
+          }
+      }
+
+audio_file.unformatted => Returns a Ruby hash after sanitizing 
+the raw output of #raw_output.
+
+      {
+        filename: '$HOME/spec/fixtures/sample.flac',
+        nb_streams: 1,
+        format_name: 'flac',
+        format_long_name: 'raw FLAC',
+        duration: '1.000000',
+        filesize: '18291',
+        bit_rate: '146328',
+        genre: 'Sample Genre',
+        track: '01',
+        album: 'Sample Album',
+        date: '2012',
+        title: 'Sample Title',
+        artist: 'Sample Artist'
+      }
+
+audio_file.formatted => Returns a Ruby hash after sanitizing 
+the raw output of #raw_output.  It also applies internal formatters 
+on fields such as duration, bit_rate, filesize, & date,
+returning human readable output.
+
+      {
+        filename: '$HOME/spec/fixtures/sample.flac',
+        nb_streams: 1,
+        format_name: 'flac',
+        format_long_name: 'raw FLAC',
+        duration: '1',
+        filesize: '17.9K',
+        bit_rate: '146 kb/s',
+        genre: 'Sample Genre',
+        track: '01',
+        album: 'Sample Album',
+        date: 2012,
+        title: 'Sample Title',
+        artist: 'Sample Artist'
+      }
 
 audio_file.tags => Returns a tag structure using the #formatted values.
 
@@ -64,38 +95,43 @@ audio_file.tags => Returns a tag structure using the #formatted values.
     .bit_rate          =>  '146 kb/s'
     .date              =>  2012
     .duration          =>  '1'
-    .filename          =>  'spec/fixtures/sample.flac'
+    .filename          =>  ''$HOME/spec/fixtures/sample.flac'
     .filesize          =>  '17.9K'
     .format_long_name  =>  'raw FLAC'
     .format_name       =>  'flac'
     .genre             =>  'Sample Genre'
-    .nb_streams        =>  '1'
+    .nb_streams        =>  1
     .start_time        =>  'N/A'
     .title             =>  'Sample Title'
     .track             =>  '01'
 
-audio_file.reload! => Reload an instance of itself, useful when updating tags.  This behavior is built in, but will need to be called manually in certain situations (such as moving a file on the file system, deleting a file, etc.)
+audio_file.reload! => Reload an instance of itself, 
+useful when updating tags.  This behavior is built in, 
+but will need to be called manually in certain situations; 
+(such as moving a file on the file system, deleting a file, etc.)
 ```
 
 Update Tags
 -----------
 
-This will update the metadata tags for an audio file.  It will also dynamically add any newly provided tags.  It takes a hash of attributes.
+This will update the metadata tags for an audio file.  
+It will also dynamically add any newly provided tags.  
+It takes a hash of attributes.
 
 ```
 audio_file = PopCap::AudioFile.new('sample.flac')
-audio_file.update_tags(artist: 'David Bowie'})
+audio_file.update(artist: 'David Bowie')
 
-audio_file.update_tags(fancy_new_tag: 'Custom Tag Input')
+audio_file.update(fancy_new_tag: 'Custom Tag Input')
 ```
 
 Convert
 -------
 
-This will convert between audio file formats.  It is restricted to basic audio formats.  It also takes an optional bitrate for mp3 formats.  The original file is preserved during the conversion.
-
-Supported formats: aac, flac, m4a, mp3, ogg, wav
-Supported mp3 bitrates: 64, 128, 160, 192, 256, 320
+This will convert between audio file formats.  
+It is restricted to basic audio formats.  
+It also takes an optional bitrate for mp3 formats.  
+The original file is preserved during the conversion.
 
 ```
 audio_file = PopCap::AudioFile.new('sample.flac')
@@ -128,7 +164,8 @@ audio_file.move('destination') # = > moves file to destination
 
 audio_file.rename('new_name.flac') # => renames file
 
-audio_file.restore # => restores file from backup_path, takes an optional path as well
+audio_file.restore # => restores file from backup_path; 
+                        takes an optional path
 
 audio_file.tmppath # => returns the temporary path, e.g. '/tmp/sample.flac'
 ```

data/lib/pop_cap/audio_file.rb

@@ -1,8 +1,10 @@
 require 'pop_cap/ffmpeg/converter'
 require 'pop_cap/ffmpeg/tag_reader'
 require 'pop_cap/ffmpeg/tag_writer'
+require 'pop_cap/unformatted_hash'
+require 'pop_cap/formatted_hash'
+require 'pop_cap/tag_struct'
 require 'pop_cap/fileable'
-require 'pop_cap/taggable'
 
 module PopCap
   FileNotFound = Class.new(StandardError)
@@ -17,10 +19,10 @@ module PopCap
   #
   #
   class AudioFile
+    include Fileable
     attr_accessor :filepath
 
-    include Fileable
-    include Taggable
+    ::MEMOIZABLES = %w(@raw @unformatted_hash @formatted_hash @tag_struct)
 
     # Public: Initialize
     #
@@ -43,8 +45,8 @@ module PopCap
     #   audio_file.convert('mp3', 128)
     #   # => 'spec/fixtures/sample.mp3'
     #
-    def convert(format, bitrate=192)
-      Converter.convert(filepath, {format: format, bitrate: bitrate})
+    def convert(format, bitrate=192, converter: Converter)
+      converter.convert(filepath, {format: format, bitrate: bitrate})
     end
 
     # Public: raw_tags
@@ -54,25 +56,96 @@ module PopCap
     #   audio_file = AudioFile.new('spec/fixtures/sample.flac')
     #   audio_file.raw_tags
     #   # =>
-    #    [FORMAT]
-    #    filename=spec/fixtures/sample.flac
-    #    nb_streams=1
-    #    format_name=flac
-    #    format_long_name=raw FLAC
-    #    start_time=N/A
-    #    duration=1.000000
-    #    size=18291
-    #    bit_rate=146328
-    #    TAG:GENRE=Sample Genre
-    #    TAG:track=01
-    #    TAG:ALBUM=Sample Album
-    #    TAG:DATE=2012
-    #    TAG:TITLE=Sample Title
-    #    TAG:ARTIST=Sample Artist
-    #    [/FORMAT]
-    #
-    def raw_tags
-      @raw ||= TagReader.read(filepath)
+    #
+    #  {
+    #    "format":
+    #      {
+    #        "filename":"spec/fixtures/sample.flac",
+    #        "nb_streams":1,
+    #        "format_name":"flac",
+    #        "format_long_name":"raw FLAC",
+    #        "duration":"1.000000",
+    #        "size":"18291",
+    #        "bit_rate":"146328",
+    #          "tags":
+    #          {
+    #            "GENRE":"Sample Genre",
+    #            "track":"01",
+    #            "ALBUM":"Sample Album",
+    #            "DATE":"2012",
+    #            "TITLE":"Sample Title",
+    #            "ARTIST":"Sample Artist"
+    #          }
+    #      }
+    #  }
+    #
+    def raw_output(tag_reader: TagReader)
+      @raw ||= tag_reader.read(filepath)
+    end
+
+    # Public: This method returns a sanitized version of #raw_tags.
+    #
+    #  {
+    #    filename: '$HOME/spec/fixtures/sample.flac',
+    #    nb_streams: 1,
+    #    format_name: 'flac',
+    #    format_long_name: 'raw FLAC',
+    #    duration: '1.000000',
+    #    filesize: '18291',
+    #    bit_rate: '146328',
+    #    genre: 'Sample Genre',
+    #    track: '01',
+    #    album: 'Sample Album',
+    #    date: '2012',
+    #    title: 'Sample Title',
+    #    artist: 'Sample Artist'
+    #  }
+    #
+    def unformatted(unformatted_hash: UnformattedHash)
+      @unformatted_hash ||= unformatted_hash.hash(raw_output)
+    end
+
+    # Public: This method returns #unformatted tags with
+    # any available Formatters automatically applied.
+    #
+    #  {
+    #    filename: '$HOME/spec/fixtures/sample.flac',
+    #    nb_streams: 1,
+    #    format_name: 'flac',
+    #    format_long_name: 'raw FLAC',
+    #    duration: '1',
+    #    filesize: '17.9K',
+    #    bit_rate: '146 kb/s',
+    #    genre: 'Sample Genre',
+    #    track: '01',
+    #    album: 'Sample Album',
+    #    date: 2012,
+    #    title: 'Sample Title',
+    #    artist: 'Sample Artist'
+    #  }
+    def formatted(formatted_hash: FormattedHash)
+      @formatted_hash ||= formatted_hash.formatted(unformatted)
+    end
+
+    # Public: This method builds a tag structure from #formatted.
+    #
+    #    .album             =>  'Sample Album'
+    #    .artist            =>  'Sample Artist'
+    #    .bit_rate          =>  '146 kb/s'
+    #    .date              =>  2012
+    #    .duration          =>  '1'
+    #    .filename          =>  'spec/fixtures/sample.flac'
+    #    .filesize          =>  '17.9K'
+    #    .format_long_name  =>  'raw FLAC'
+    #    .format_name       =>  'flac'
+    #    .genre             =>  'Sample Genre'
+    #    .nb_streams        =>  '1'
+    #    .start_time        =>  'N/A'
+    #    .title             =>  'Sample Title'
+    #    .track             =>  '01'
+    #
+    def tags(tag_struct: TagStruct)
+      @tag_struct ||= tag_struct.new(formatted)
     end
 
     # Public: This method reloads the current instance.
@@ -81,20 +154,19 @@ module PopCap
     #   audio_file.reload!
     #
     def reload!
-      @raw = nil
-      super
+      ::MEMOIZABLES.each { |var| self.instance_variable_set(var, nil) }
     end
 
-    # Public: update_tags(updates)
+    # Public: update(updates)
     # Updates existing tags, adds a tag if it does not exist.
     #
-    # updates - This takes a hash of keys matching a tag name with a value.
+    # updates - This takes a hash of tags.
     #
     # Examples
     #
-    #   audio_file.update_tags({artist: 'New Artist', album: 'New Album'})
+    #   audio_file.update(artist: 'New Artist', album: 'New Album')
     #
-    def update_tags(updates)
+    def update(updates={})
       TagWriter.write(filepath, updates)
       self.reload!
     end

data/lib/pop_cap/formatted_hash.rb

@@ -0,0 +1,40 @@
+require 'pop_cap/class_support'
+require 'pop_cap/formatter'
+
+module PopCap
+  # Public: This class will apply all Formatters to
+  # the supplied hash.
+  #
+  # new - Supply an unformatted hash.
+  #
+  class FormattedHash
+    def initialize(unformatted)
+      @unformatted = unformatted
+    end
+
+    # Public: This class will apply all Formatters to
+    # the supplied hash.
+    #
+    def formatted
+      @unformatted.merge(formatted_hash)
+    end
+
+    # Public: This wraps #new & #formatted.
+    #
+    def self.formatted(unformatted)
+      new(unformatted).formatted
+    end
+
+    private
+    def formatted_hash(formatters: Formatters::Formatter, support: ClassSupport)
+      formatters.subclasses.inject({}) do |formatted, formatter|
+        attribute = support.new(formatter).symbolize
+        formatted.merge(formatted_attribute(formatter, attribute))
+      end.reject { |_,val| val.nil? }
+    end
+
+    def formatted_attribute(formatter, attribute)
+      {attribute => formatter.format(@unformatted[attribute])}
+    end
+  end
+end

data/lib/pop_cap/{tag/tag_struct.rb → tag_struct.rb}

@@ -16,6 +16,7 @@ module PopCap
     def initialize(hash)
       raise(ArgumentError, argument_error_message) unless hash.kind_of?(Hash)
       @hash = hash
+      @tags = {}
       define_instance_methods
     end
 
@@ -31,6 +32,14 @@ module PopCap
       "#<#{self.class.name} " + methods + '>'
     end
 
+    # Public: This method is a custom each iterator for tags.
+    #
+    def each(&block)
+      @tags.each do |tag|
+        block_given? ? block.call(tag) : tag
+      end
+    end
+
     private
     def argument_error_message
       'Initialize with a hash.'
@@ -40,6 +49,7 @@ module PopCap
       @hash.each do |key, val|
         unless self.class.respond_to? key
           define_singleton_method(key) { val }
+          @tags[key] = val
         end
       end
     end

data/lib/pop_cap/{tag/tag_hash.rb → unformatted_hash.rb}

@@ -3,7 +3,7 @@ require 'json'
 module PopCap
   # Public: This class formats the JSON output of TagReader.
   #
-  class TagHash
+  class UnformattedHash
     attr_reader :json
 
     def initialize(json)
@@ -14,7 +14,7 @@ module PopCap
     # The keys have been converted to symbols.
     #
     def hash
-      renamed_hash.reject { |key,_| key == :size }
+      renamed_hash
     end
 
     # Public: This method wraps #new & #hash.
@@ -25,7 +25,9 @@ module PopCap
 
     private
     def renamed_hash
-      symbolized_hash.merge({filesize: size_element})
+      symbolized_hash.
+        merge({filesize: size_element}).
+        reject { |key,_| key == :size }
     end
 
     def symbolized_hash

data/lib/pop_cap/version.rb

@@ -1,3 +1,3 @@
 module PopCap
-  VERSION = '0.8.0'
+  VERSION = '0.9.0'
 end

data/spec/lib/pop_cap/audio_file_spec.rb

@@ -1,11 +1,11 @@
-require 'pop_cap/audio_file'
 require 'spec_helper'
 require 'support/popcap_spec_helper'
+require 'pop_cap/audio_file'
 
 module PopCap
   describe AudioFile do
     let(:audio_file) { AudioFile.new(filepath) }
-    let(:filepath) { PopCapSpecHelper::SAMPLE_FILE }
+    let(:filepath) { File.realpath(PopCapSpecHelper::SAMPLE_FILE) }
     let(:included_modules) { AudioFile.included_modules }
 
     before { PopCapSpecHelper.setup }
@@ -13,8 +13,8 @@ module PopCap
 
     subject { audio_file }
 
-    context '#filepath' do
-      its(:filepath) { should eq File.realpath(filepath) }
+    describe '#filepath' do
+      its(:filepath) { should eq File.realpath(PopCapSpecHelper::SAMPLE_FILE) }
 
       it 'raises an error if file does not exist' do
         expect do
@@ -23,43 +23,93 @@ module PopCap
       end
     end
 
-    context 'ffmpeg methods' do
-      it { expect(audio_file).to respond_to(:convert) }
-      it { expect(audio_file).to respond_to(:raw_tags) }
-      it { expect(audio_file).to respond_to(:update_tags) }
-    end
-
     context 'included modules' do
       it 'includes Fileable' do
         expect(included_modules).to include Fileable
       end
+    end
+
+    describe '#raw_output' do
+      it 'is memoized' do
+        audio_file.raw_output
+        TagReader.should_not_receive(:read).with(filepath)
+        audio_file.raw_output
+      end
+
+      it { expect(audio_file.raw_output).to eq(PopCapSpecHelper.raw_output) }
+    end
+
+    describe '#unformatted' do
+      it 'is memoized' do
+        audio_file.unformatted
+        UnformattedHash.should_not_receive(:hash).with(audio_file.raw_output)
+        audio_file.unformatted
+      end
+
+      it do
+        expect(audio_file.unformatted).to eq PopCapSpecHelper.unformatted_hash
+      end
+    end
 
-      it 'includes Taggable' do
-        expect(included_modules).to include Taggable
+    describe '#formatted' do
+      it 'is memoized' do
+        audio_file.formatted
+        FormattedHash.should_not_receive(:formatted).
+          with(audio_file.unformatted)
+        audio_file.formatted
       end
+
+      it { expect(audio_file.formatted).to eq(PopCapSpecHelper.formatted_hash) }
     end
 
-    context '#raw_tags' do
+    describe '#tags' do
       it 'is memoized' do
-        audio_file.raw_tags
-        expect(audio_file.instance_variable_get('@raw')).
-          to eq PopCapSpecHelper.raw_tags
+        audio_file.tags
+        TagStruct.should_not_receive(:new).with(audio_file.formatted)
+        audio_file.tags
+      end
+
+      it 'includes all tags for the sample file' do
+        PopCapSpecHelper.formatted_hash.each do |key,val|
+          expect(audio_file.tags.send(key)).to eq val
+        end
+      end
+
+      it 'is a TagStruct' do
+        expect(audio_file.tags).to be_a TagStruct
       end
     end
 
-    context '#reload!' do
-      it 'reloads raw tags' do
-        audio_file.raw_tags
-        expect(audio_file.instance_variable_get('@raw')).not_to be_nil
+    describe '#reload!' do
+      it 'resets all MEMOIZABLES' do
+        audio_file.tags
         audio_file.reload!
-        expect(audio_file.instance_variable_get('@raw')).to be_nil
+        ::MEMOIZABLES.each do |var|
+          expect(audio_file.instance_variable_get(var)).to be_nil
+        end
       end
     end
 
-    context '#update_tags' do
+    describe '#update' do
       it 'reloads after tags updated' do
         audio_file.should_receive(:reload!)
-        audio_file.update_tags({foo: 'foo'})
+        audio_file.update({foo: 'foo'})
+      end
+
+      it 'updates tags for file' do
+        expect(audio_file.tags.artist).to eq 'Sample Artist'
+        updates = {artist: 'New Artist'}
+        audio_file.update(updates)
+        expect(audio_file.tags.artist).to eq 'New Artist'
+      end
+    end
+
+    describe '#convert' do
+      after { PopCapSpecHelper.remove_converted }
+
+      it 'creates a new audio file with the specified format & bitrate' do
+        audio_file.convert(:mp3, 128)
+        expect(File.exists?('spec/fixtures/sample.mp3')).to be_true
       end
     end
   end

data/spec/lib/pop_cap/formatted_hash_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+require 'pop_cap/formatted_hash'
+
+module PopCap
+  describe FormattedHash do
+    describe '.formatted' do
+      it 'wraps #new & #formatted' do
+        instance = double('FormattedHash')
+        FormattedHash.should_receive(:new).with('foo') { instance }
+        instance.should_receive(:formatted)
+        FormattedHash.formatted('foo')
+      end
+    end
+
+    describe '#formatted' do
+      it 'does not return the formatter element, if not supplied' do
+        hash = FormattedHash.new(filesize: 123456)
+        expect(hash.formatted).not_to have_key(:date)
+      end
+
+      it 'applies a formatter if it is in the supplied hash' do
+        hash = FormattedHash.new(filesize: 123456)
+        expect(hash.formatted).to eq(filesize: '120.6K')
+      end
+
+      it 'merges in non-formattable attributes' do
+        hash = FormattedHash.new({filesize: 123456, artist: 'foo'})
+        expect(hash.formatted).to eq({filesize: '120.6K', artist: 'foo'})
+      end
+    end
+  end
+end

data/spec/lib/pop_cap/formatter_spec.rb

@@ -4,15 +4,15 @@ require 'pop_cap/formatter'
 module PopCap
   module Formatters
     describe Formatter do
-      class TagClass < Formatter
+      class Filesize < Formatter
         def format; 'baz'; end
       end
 
       describe '.format' do
-        let(:taggy) { Formatters::TagClass.new('foo', {option: 'bar'}) }
+        let(:taggy) { Formatters::Filesize.new('foo', {option: 'bar'}) }
 
         it 'wraps #format in a class method' do
-          klass = Formatters::TagClass.format('foo', {option: 'bar'})
+          klass = Formatters::Filesize.format('foo', {option: 'bar'})
           instance = taggy.format
           expect(klass).to eq instance
         end
@@ -20,12 +20,12 @@ module PopCap
 
       describe '.subclasses' do
         it 'returns a list of all subclasses in the ObjectSpace' do
-          expect(Formatter.subclasses).to include(PopCap::Formatters::TagClass)
+          expect(Formatter.subclasses).to include(PopCap::Formatters::Filesize)
         end
 
         it 'includes the subclass only once' do
           unique = Formatter.subclasses.select do |cls|
-            cls == PopCap::Formatters::TagClass
+            cls == PopCap::Formatters::Filesize
           end
           expect(unique.size).to eq 1
         end
@@ -45,19 +45,20 @@ module PopCap
 
       describe '.subclasses_demodulized' do
         it 'returns of the subclasses with their names demodulized' do
-          expect(Formatter.subclasses_demodulized).to include('TagClass')
+          expect(Formatter.subclasses_demodulized).
+            to include('Filesize')
         end
       end
     end
 
     describe '#format' do
-      let(:taggy) { Formatters::TagClass.new('foo', {option: 'bar'}) }
+      let(:taggy) { Formatters::Filesize.new('foo', {option: 'bar'}) }
 
       it { expect(taggy).to respond_to(:format) }
     end
 
     describe '#new' do
-      let(:taggy) { Formatters::TagClass.new('foo', {option: 'bar'}) }
+      let(:taggy) { Formatters::Filesize.new('foo', {option: 'bar'}) }
 
       it 'has a getter for value' do
         expect(taggy.value).to eq 'foo'

data/spec/lib/pop_cap/{tag/tag_struct_spec.rb → tag_struct_spec.rb}

@@ -1,5 +1,5 @@
 require 'spec_helper'
-require 'pop_cap/tag/tag_struct'
+require 'pop_cap/tag_struct'
 
 module PopCap
   describe TagStruct do
@@ -36,8 +36,21 @@ module PopCap
       end
     end
 
-    it 'has a custom #to_s method' do
-      expect(ts.to_s).to eq "#<PopCap::TagStruct artist: Artist, date: 1984>"
+    describe '#to_s' do
+      it 'has a custom #to_s method' do
+        expect(ts.to_s).to eq "#<PopCap::TagStruct artist: Artist, date: 1984>"
+      end
+    end
+
+    describe '#each' do
+      let(:tags) { {foo: 'foo', bar: 'bar', baz: 'baz'} }
+      let(:tag_struct) { TagStruct.new tags }
+
+      it 'has a custom #each method for all defined methods' do
+        tag_struct.each do |key,val|
+          expect(tags[key]).to eq val
+        end
+      end
     end
 
     describe 'already defined methods' do

data/spec/lib/pop_cap/unformatted_hash_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+require 'support/popcap_spec_helper'
+require 'pop_cap/unformatted_hash'
+
+module PopCap
+  describe UnformattedHash do
+    describe '#hash' do
+      let(:json) { '{"format":{"size":"10","tags":{"artist":"artist"}}}' }
+      let(:unformatted_hash) do
+        UnformattedHash.new(PopCapSpecHelper.raw_output)
+      end
+
+      it 'symbolizes all keys' do
+        unformatted_hash.hash.each_key do |key|
+          expect(key).to be_a Symbol
+        end
+      end
+
+      it 'renames filesize to size' do
+        expect(unformatted_hash.hash[:size]).to be_nil
+        expect(unformatted_hash.hash[:filesize]).not_to be_nil
+      end
+
+      it 'formats json output as a hash' do
+        expect(unformatted_hash.hash).to be_a Hash
+      end
+
+      it 'merges tags section with format section' do
+        unformatted = UnformattedHash.new(json)
+        expect(unformatted.hash).to eq({filesize: '10', artist: 'artist'})
+      end
+    end
+
+    describe '.hash' do
+      it 'wraps #new & #hash' do
+        instance = double('UnformattedHash')
+        UnformattedHash.should_receive(:new).with('foo') { instance }
+        instance.should_receive(:hash)
+        UnformattedHash.hash('foo')
+      end
+    end
+  end
+end

data/spec/support/popcap_spec_helper.rb

@@ -6,7 +6,7 @@ module PopCapSpecHelper
   SAMPLE_FILE = 'spec/fixtures/sample.flac'
 
   class << self
-    def raw_tags
+    def raw_output
       '{"format":{"filename":"/home/marsalis/.apps/popcap/spec/fixtures/'\
         'sample.flac","nb_streams":1,"format_name":"flac","format_long_name"'\
         ':"raw FLAC","duration":"1.000000","size":"18291","bit_rate":"146328"'\
@@ -54,7 +54,7 @@ module PopCapSpecHelper
       OpenStruct.new(
         {
         filename: File.realpath(SAMPLE_FILE),
-        nb_streams: '1',
+        nb_streams: 1,
         format_name: 'flac',
         format_long_name: 'raw FLAC',
         start_time: 'N/A',
@@ -81,23 +81,5 @@ module PopCapSpecHelper
       FileUtils.mv('spec/fixtures/backup.flac', SAMPLE_FILE)
       FileUtils.rm_f('spec/fixtures/sample.mp3')
     end
-
-    def object_names(const)
-      ObjectSpace.each_object(const).map { |cls| cls.name }
-    end
-
-    def all_names
-      ObjectSpace.each_object(Object).map do |obj|
-        obj.name if(obj.is_a?(Class) || obj.is_a?(Module))
-      end.compact
-    end
-
-    def classes
-      ObjectSpace.each_object(Class).map { |cls| cls }
-    end
-
-    def modules
-      ObjectSpace.each_object(Module).map { |cls| cls }
-    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: popcap
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Culley Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-03 00:00:00.000000000 Z
+date: 2013-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: reek
@@ -60,22 +60,18 @@ files:
 - lib/pop_cap/ffmpeg/tag_reader.rb
 - lib/pop_cap/ffmpeg/tag_writer.rb
 - lib/pop_cap/fileable.rb
+- lib/pop_cap/formatted_hash.rb
 - lib/pop_cap/formatter.rb
 - lib/pop_cap/formatters/bit_rate.rb
 - lib/pop_cap/formatters/date.rb
 - lib/pop_cap/formatters/duration.rb
 - lib/pop_cap/formatters/filesize.rb
-- lib/pop_cap/tag/formatted_tag.rb
-- lib/pop_cap/tag/tag_hash.rb
-- lib/pop_cap/tag/tag_struct.rb
-- lib/pop_cap/taggable.rb
+- lib/pop_cap/tag_struct.rb
+- lib/pop_cap/unformatted_hash.rb
 - lib/pop_cap/version.rb
 - lib/popcap.rb
 - popcap.gemspec
 - spec/fixtures/sample.flac
-- spec/integration/convert_audio_file_spec.rb
-- spec/integration/read_metatags_spec.rb
-- spec/integration/update_metatags_spec.rb
 - spec/lib/pop_cap/audio_file_spec.rb
 - spec/lib/pop_cap/class_support_spec.rb
 - spec/lib/pop_cap/ffmpeg/commander_spec.rb
@@ -84,15 +80,14 @@ files:
 - spec/lib/pop_cap/ffmpeg/tag_reader_spec.rb
 - spec/lib/pop_cap/ffmpeg/tag_writer_spec.rb
 - spec/lib/pop_cap/fileable_spec.rb
+- spec/lib/pop_cap/formatted_hash_spec.rb
 - spec/lib/pop_cap/formatter_spec.rb
 - spec/lib/pop_cap/formatters/bit_rate_spec.rb
 - spec/lib/pop_cap/formatters/date_spec.rb
 - spec/lib/pop_cap/formatters/duration_spec.rb
 - spec/lib/pop_cap/formatters/filesize_spec.rb
-- spec/lib/pop_cap/tag/formatted_tag_spec.rb
-- spec/lib/pop_cap/tag/tag_hash_spec.rb
-- spec/lib/pop_cap/tag/tag_struct_spec.rb
-- spec/lib/pop_cap/taggable_spec.rb
+- spec/lib/pop_cap/tag_struct_spec.rb
+- spec/lib/pop_cap/unformatted_hash_spec.rb
 - spec/spec_helper.rb
 - spec/support/popcap_spec_helper.rb
 - spec/support/reek_spec.rb
@@ -121,9 +116,6 @@ specification_version: 4
 summary: A library work with audio files on the filesystem .
 test_files:
 - spec/fixtures/sample.flac
-- spec/integration/convert_audio_file_spec.rb
-- spec/integration/read_metatags_spec.rb
-- spec/integration/update_metatags_spec.rb
 - spec/lib/pop_cap/audio_file_spec.rb
 - spec/lib/pop_cap/class_support_spec.rb
 - spec/lib/pop_cap/ffmpeg/commander_spec.rb
@@ -132,15 +124,14 @@ test_files:
 - spec/lib/pop_cap/ffmpeg/tag_reader_spec.rb
 - spec/lib/pop_cap/ffmpeg/tag_writer_spec.rb
 - spec/lib/pop_cap/fileable_spec.rb
+- spec/lib/pop_cap/formatted_hash_spec.rb
 - spec/lib/pop_cap/formatter_spec.rb
 - spec/lib/pop_cap/formatters/bit_rate_spec.rb
 - spec/lib/pop_cap/formatters/date_spec.rb
 - spec/lib/pop_cap/formatters/duration_spec.rb
 - spec/lib/pop_cap/formatters/filesize_spec.rb
-- spec/lib/pop_cap/tag/formatted_tag_spec.rb
-- spec/lib/pop_cap/tag/tag_hash_spec.rb
-- spec/lib/pop_cap/tag/tag_struct_spec.rb
-- spec/lib/pop_cap/taggable_spec.rb
+- spec/lib/pop_cap/tag_struct_spec.rb
+- spec/lib/pop_cap/unformatted_hash_spec.rb
 - spec/spec_helper.rb
 - spec/support/popcap_spec_helper.rb
 - spec/support/reek_spec.rb

data/lib/pop_cap/tag/formatted_tag.rb

@@ -1,31 +0,0 @@
-module PopCap
-  # Public: This class will apply a provided Formatter to
-  # the supplied value.
-  #
-  class FormattedTag
-    attr_reader :formatter, :value
-
-    # Public: To construct an instance, provide a Formatter
-    # and the value to format.
-    #
-    # formatter - A class of type Formatters::Formatter.
-    # value - The value to format.
-    #
-    def initialize(formatter, value)
-      @formatter, @value = formatter, value
-    end
-
-    # Public: This returns the formatted value.
-    #
-    def format
-      formatter.format(value)
-    end
-
-    # Public: A class level method that initializes the class
-    # and formats the value.
-    #
-    def self.format(formatter, value)
-      new(formatter, value).format
-    end
-  end
-end

data/lib/pop_cap/taggable.rb

@@ -1,120 +0,0 @@
-require 'pop_cap/class_support'
-require 'pop_cap/formatter'
-require 'pop_cap/tag/formatted_tag'
-require 'pop_cap/tag/tag_hash'
-require 'pop_cap/tag/tag_struct'
-
-module PopCap
-  # Public: This module is included in anything with a #raw_tags
-  # attribute.  It is used to parse and build tags from FFmpeg raw output.
-  #
-  module Taggable
-    # Public: This method reloads memoized tags.
-    #
-    def reload!
-      @unformatted_hash, @formatted_hash, @tag_struct = nil, nil, nil
-    end
-
-    # Public: This method builds an unformatted hash of tags.
-    #
-    # Examples
-    #   class SomeClass
-    #     def raw_tags
-    #     end
-    #   end
-    #
-    #   klass = SomeClass.new
-    #   klass.unformatted
-    #   # =>
-    #       { filename: 'spec/fixtures/sample.flac',
-    #         format_name: 'flac',
-    #         duration: '1.000000',
-    #         filesize: '18291',
-    #         bit_rate: '146328',
-    #         genre: 'Sample Genre',
-    #         track: '01',
-    #         album: 'Sample Album',
-    #         date: '2012',
-    #         title: 'Sample Title',
-    #         artist: 'Sample Artist' }
-    #
-    def unformatted(tag_hash: TagHash)
-      @unformatted_hash ||= tag_hash.hash(self.raw_tags)
-    end
-
-    # Public: This method builds an unformatted hash of tags.
-    #
-    # Examples
-    #   class SomeClass
-    #     def raw_tags
-    #     end
-    #   end
-    #
-    #   klass = SomeClass.new
-    #   klass.unformatted
-    #   # =>
-    #       { filename: 'spec/fixtures/sample.flac',
-    #         format_name: 'flac',
-    #         duration: '1.000000',
-    #         filesize: '18291',
-    #         bit_rate: '146328',
-    #         genre: 'Sample Genre',
-    #         track: '01',
-    #         album: 'Sample Album',
-    #         date: '2012',
-    #         title: 'Sample Title',
-    #         artist: 'Sample Artist' }
-    #
-    def formatted
-      @formatted_hash ||= unformatted.merge(formatted_tags)
-    end
-
-    # Public: This method builds an tag structure from #to_hash. Also,
-    # TagFormatters are applied to any tag with a custom formatter.
-    #
-    # Examples
-    #   class SomeClass
-    #     def raw_tags
-    #     end
-    #   end
-    #
-    #   klass = SomeClass.new
-    #   klass.tags
-    #
-    #   # =>
-    #    .album             =>  'Sample Album'
-    #    .artist            =>  'Sample Artist'
-    #    .bit_rate          =>  '146 kb/s'
-    #    .date              =>  2012
-    #    .duration          =>  '1'
-    #    .filename          =>  'spec/fixtures/sample.flac'
-    #    .filesize          =>  '17.9K'
-    #    .format_long_name  =>  'raw FLAC'
-    #    .format_name       =>  'flac'
-    #    .genre             =>  'Sample Genre'
-    #    .nb_streams        =>  '1'
-    #    .start_time        =>  'N/A'
-    #    .title             =>  'Sample Title'
-    #    .track             =>  '01'
-    #
-    def tags
-      @tag_struct ||= build_tag_struct(formatted)
-    end
-
-    private
-    def build_tag_struct(hash)
-      TagStruct.new(hash)
-    end
-
-    def formatted_tags(support: ClassSupport)
-      Formatters::Formatter.subclasses.inject({}) do |formatted, formatter|
-        attribute = support.new(formatter).symbolize
-        formatted.merge({attribute => format(formatter, attribute)})
-      end
-    end
-
-    def format(formatter, attribute, tag: FormattedTag)
-      tag.format(formatter, unformatted[attribute])
-    end
-  end
-end

data/spec/integration/convert_audio_file_spec.rb

@@ -1,15 +0,0 @@
-require 'spec_helper'
-require 'support/popcap_spec_helper'
-require 'pop_cap/audio_file'
-
-module PopCap
-  describe 'Convert Audio Files' do
-    after { PopCapSpecHelper.remove_converted }
-
-    it 'creates a new audio file with the specified format & bitrate' do
-      audio_file = AudioFile.new(PopCapSpecHelper::SAMPLE_FILE)
-      audio_file.convert(:mp3, 128)
-      expect(File.exists?('spec/fixtures/sample.mp3')).to be_true
-    end
-  end
-end

data/spec/integration/read_metatags_spec.rb

@@ -1,12 +0,0 @@
-require 'popcap'
-require 'spec_helper'
-require 'support/popcap_spec_helper'
-
-describe PopCap do
-  let(:audio_file) { PopCap::AudioFile.new(filepath) }
-  let(:filepath) { PopCapSpecHelper::SAMPLE_FILE }
-
-  it '#raw_tags' do
-    expect(audio_file.raw_tags).to eq PopCapSpecHelper.raw_tags
-  end
-end

data/spec/integration/update_metatags_spec.rb

@@ -1,20 +0,0 @@
-require 'popcap'
-require 'spec_helper'
-require 'support/popcap_spec_helper'
-
-describe PopCap do
-  let(:audio_file) { PopCap::AudioFile.new(filepath) }
-  let(:filepath) { PopCapSpecHelper::SAMPLE_FILE }
-
-  context '#update_tags' do
-    before { PopCapSpecHelper.setup }
-    after { PopCapSpecHelper.teardown }
-
-    it 'updates tags for file' do
-      expect(audio_file.tags.artist).to eq 'Sample Artist'
-      updates = {artist: 'New Artist'}
-      audio_file.update_tags(updates)
-      expect(audio_file.tags.artist).to eq 'New Artist'
-    end
-  end
-end

data/spec/lib/pop_cap/tag/formatted_tag_spec.rb

@@ -1,29 +0,0 @@
-require 'spec_helper'
-require 'pop_cap/tag/formatted_tag'
-
-module PopCap
-  describe FormattedTag do
-    class FakeFormatter
-      def self.format(value)
-        value.to_i
-      end
-    end
-
-    describe '#format' do
-      it 'formats a value with the formatter' do
-        tag = FormattedTag.new(FakeFormatter, '123')
-        expect(tag.format).to eq 123
-      end
-    end
-
-    describe '.format' do
-      it 'wraps #new & #format' do
-        instance = double('FormattedTagInstance')
-        FormattedTag.should_receive(:new).with(FakeFormatter, '123').
-          and_return(instance)
-        instance.should_receive(:format)
-        FormattedTag.format(FakeFormatter, '123')
-      end
-    end
-  end
-end

data/spec/lib/pop_cap/tag/tag_hash_spec.rb

@@ -1,35 +0,0 @@
-require 'spec_helper'
-require 'support/popcap_spec_helper'
-require 'pop_cap/tag/tag_hash'
-
-module PopCap
-  describe TagHash do
-    describe '#hash' do
-      let(:tag_hash) { TagHash.new(PopCapSpecHelper.raw_tags) }
-
-      it 'symbolizes all keys' do
-        tag_hash.hash.each_key do |key|
-          expect(key).to be_a Symbol
-        end
-      end
-
-      it 'renames filesize to size' do
-        expect(tag_hash.hash[:size]).to be_nil
-        expect(tag_hash.hash[:filesize]).not_to be_nil
-      end
-
-      it 'formats json output as a hash' do
-        expect(tag_hash.hash).to eq(PopCapSpecHelper.unformatted_hash)
-      end
-    end
-
-    describe '.hash' do
-      it 'wraps #new & #hash' do
-        instance = double('TagHash')
-        TagHash.should_receive(:new).with('foo') { instance }
-        instance.should_receive(:hash)
-        TagHash.hash('foo')
-      end
-    end
-  end
-end

data/spec/lib/pop_cap/taggable_spec.rb

@@ -1,76 +0,0 @@
-require 'spec_helper'
-require 'support/popcap_spec_helper'
-require 'pop_cap/taggable'
-
-module PopCap
-  describe Taggable do
-    class SomeClass
-      include Taggable
-      def raw_tags
-        PopCapSpecHelper.raw_tags
-      end
-    end
-
-    let(:sc) { SomeClass.new }
-
-    it 'has #raw_tags' do
-      expect(sc).to respond_to(:raw_tags)
-    end
-
-    describe '#unformatted' do
-      it 'returns TagHash#hash' do
-        TagHash.should_receive(:hash).with(sc.raw_tags)
-        sc.unformatted
-      end
-
-      it 'is memoized' do
-        sc.unformatted
-        TagHash.should_not_receive(:new)
-        sc.unformatted
-      end
-    end
-
-    describe '#formatted' do
-      it 'builds a formatted hash' do
-        expect(sc.formatted).to include(PopCapSpecHelper.formatted_hash)
-      end
-
-      it 'is memoized' do
-        sc.formatted
-        FormattedTag.should_not_receive(:new)
-        sc.formatted
-      end
-    end
-
-    describe '#tags' do
-      it 'builds a tag structure from #formatted_hash' do
-        expect(sc.tags.album).to eq PopCapSpecHelper.tags.album
-        expect(sc.tags.artist).to eq PopCapSpecHelper.tags.artist
-        expect(sc.tags.bit_rate).to eq PopCapSpecHelper.tags.bit_rate
-        expect(sc.tags.date).to eq PopCapSpecHelper.tags.date
-        expect(sc.tags.duration).to eq PopCapSpecHelper.tags.duration
-        expect(sc.tags.filename).to eq PopCapSpecHelper.tags.filename
-        expect(sc.tags.filesize).to eq PopCapSpecHelper.tags.filesize
-        expect(sc.tags.format_name).to eq PopCapSpecHelper.tags.format_name
-        expect(sc.tags.genre).to eq PopCapSpecHelper.tags.genre
-        expect(sc.tags.title).to eq PopCapSpecHelper.tags.title
-        expect(sc.tags.track).to eq PopCapSpecHelper.tags.track
-      end
-
-      it 'is memoized' do
-        sc.tags
-        TagStruct.should_not_receive(:new)
-        sc.tags
-      end
-    end
-
-    context '#reload!' do
-      it 'sets instance variables to nil' do
-        %w(@formatted_hash @unformatted_hash @tag_struct).each do |instance|
-          sc.reload!
-          expect(sc.instance_variable_get(instance)).to be_nil
-        end
-      end
-    end
-  end
-end