popcap 0.7.2 → 0.8.0

metadata

@@ -1,20 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: popcap
 version: !ruby/object:Gem::Version
-  version: 0.7.2
-  prerelease: 
+  version: 0.8.0
 platform: ruby
 authors:
 - Culley Smith
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-20 00:00:00.000000000 Z
+date: 2013-03-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: reek
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +20,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,7 +27,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -38,27 +34,10 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.11'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.7'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.7'
 description: Read & write metadata tags, convert audio files to alternate formats,
   manage files on the filesystem.
 email:
@@ -74,90 +53,95 @@ files:
 - LICENSE
 - README.md
 - lib/pop_cap/audio_file.rb
-- lib/pop_cap/commander.rb
-- lib/pop_cap/converter.rb
-- lib/pop_cap/ffmpeg.rb
+- lib/pop_cap/class_support.rb
+- lib/pop_cap/ffmpeg/commander.rb
+- lib/pop_cap/ffmpeg/converter.rb
+- lib/pop_cap/ffmpeg/ffmpeg.rb
+- lib/pop_cap/ffmpeg/tag_reader.rb
+- lib/pop_cap/ffmpeg/tag_writer.rb
 - lib/pop_cap/fileable.rb
-- lib/pop_cap/formatters.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/helper.rb
-- lib/pop_cap/tag_key.rb
-- lib/pop_cap/tag_line.rb
-- lib/pop_cap/tag_struct.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/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/commander_spec.rb
-- spec/lib/pop_cap/converter_spec.rb
-- spec/lib/pop_cap/ffmpeg_spec.rb
+- spec/lib/pop_cap/class_support_spec.rb
+- spec/lib/pop_cap/ffmpeg/commander_spec.rb
+- spec/lib/pop_cap/ffmpeg/converter_spec.rb
+- spec/lib/pop_cap/ffmpeg/ffmpeg_spec.rb
+- 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/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/formatters_spec.rb
-- spec/lib/pop_cap/helper_spec.rb
-- spec/lib/pop_cap/tag_key_spec.rb
-- spec/lib/pop_cap/tag_line_spec.rb
-- spec/lib/pop_cap/tag_struct_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/spec_helper.rb
 - spec/support/popcap_spec_helper.rb
 - spec/support/reek_spec.rb
-- spec/support/sample.flac
 homepage: http://madstance.com
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.0
 signing_key: 
-specification_version: 3
+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/commander_spec.rb
-- spec/lib/pop_cap/converter_spec.rb
-- spec/lib/pop_cap/ffmpeg_spec.rb
+- spec/lib/pop_cap/class_support_spec.rb
+- spec/lib/pop_cap/ffmpeg/commander_spec.rb
+- spec/lib/pop_cap/ffmpeg/converter_spec.rb
+- spec/lib/pop_cap/ffmpeg/ffmpeg_spec.rb
+- 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/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/formatters_spec.rb
-- spec/lib/pop_cap/helper_spec.rb
-- spec/lib/pop_cap/tag_key_spec.rb
-- spec/lib/pop_cap/tag_line_spec.rb
-- spec/lib/pop_cap/tag_struct_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/spec_helper.rb
 - spec/support/popcap_spec_helper.rb
 - spec/support/reek_spec.rb
-- spec/support/sample.flac
 has_rdoc: 

data/lib/pop_cap/converter.rb

@@ -1,40 +0,0 @@
-module PopCap
-  # Internal: This module builds a command to convert an audio file
-  # to the specified output format. The module is included in FFmpeg.
-  #
-  module Converter
-    # Internal: This method takes an input format & optional bitrate
-    # in order to supply the ffmpeg command used to convert.
-    #
-    # format - Provide a valid format as a string or symbol.
-    # bitrate - Provide a valid bitrate as a string or integer.
-    #
-    def convert(format, bitrate=192)
-      @bitrate = bitrate
-      @format = format.downcase.to_s
-      input_path + strict_mode + bitrate_options + output_path
-    end
-
-    private
-    def bitrate_options
-      %W{-ab #{@bitrate}k}
-    end
-
-    def input_path
-      %W{ffmpeg -i #{self.filepath}}
-    end
-
-    def output_path
-      %W{#{self.filepath.sub(%r([^.]+\z),@format)}}
-    end
-
-    def strict_mode
-      return %W{} unless use_strict_mode?
-      %W{-strict -2}
-    end
-
-    def use_strict_mode?
-      @format == 'm4a'
-    end
-  end
-end

data/lib/pop_cap/ffmpeg.rb

@@ -1,130 +0,0 @@
-require 'pop_cap/commander'
-require 'pop_cap/converter'
-require 'pop_cap/fileable'
-
-module PopCap
-  MissingDependency = Class.new(Errno::ENOENT)
-  # Internal: This is a wrapper for the FFmpeg C library.
-  #
-  # Examples
-  #
-  #   filepath = 'spec/support/sample.flac'
-  #   ffmpeg = FFmpeg.new(filepath)
-  #
-  class FFmpeg
-    include Converter
-    include Fileable
-
-    attr_accessor :filepath
-
-    # Internal: initialize
-    #
-    # filepath - Requires a valid filepath to a file on the local filesystem.
-    #
-    def initialize(filepath)
-      check_for_ffmpeg_install
-      @filepath = filepath
-    end
-
-    # Internal: convert
-    # This command calls up to Converter@convert.
-    #
-    # format - A valid audio file format as string or symbol.
-    # bitrate = A valid bit rate as string or symbol.
-    #
-    def convert(format, bitrate=192)
-      conversion = super(format,bitrate)
-      Commander.new(*conversion).execute
-    end
-
-    # Internal: read_tags
-    # Returns the raw output of FFProbe's show_format option.
-    #
-    # Examples
-    #
-    #    [FORMAT]
-    #    filename=spec/support/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 read_tags
-      @stdout ||= encode(read_output)
-    end
-
-    # Internal: update_tags(updates)
-    # This wraps FFmpeg's -metadata command.
-    #
-    # Examples
-    #   filepath = 'spec/support/sample.flac'
-    #   ffmpeg = FFmpeg.new(filepath)
-    #   ffmpeg.update_tags({artist: 'New Artist'})
-    #
-    def update_tags(updates)
-      @updates = updates
-      unless Commander.new(*write_command).execute.success?
-        raise(FFmpegError, write_error_message)
-      end
-      self.restore('/tmp')
-      @stdout = nil
-    end
-
-    private
-    def check_for_ffmpeg_install
-      begin
-        Open3.capture3('ffmpeg')
-      rescue Errno::ENOENT
-        raise MissingDependency, 'FFmpeg is not installed.'
-      end
-    end
-
-    def encode(string)
-      return string if string.valid_encoding?
-      original_encoding = string.encoding.name
-      string.encode!('UTF-16', original_encoding, undef:
-                     :replace, invalid: :replace)
-      string.encode!('UTF-8')
-    end
-
-    def read_command
-      %W{ffprobe -show_format} + %W{#{filepath}}
-    end
-
-    def read_output
-      commander = Commander.new(*read_command).execute
-      raise(FFmpegError, read_error_message) unless commander.success?
-      commander.stdout
-    end
-
-    def read_error_message
-      "Error reading #{self.filepath}"
-    end
-
-    def write_command
-      %W{ffmpeg -i #{filepath}} + write_options + %W{#{self.tmppath}}
-    end
-
-    def write_options
-      @updates.inject(%W{}) do |options,update|
-        options << '-metadata' << update.join('=')
-      end
-    end
-
-    def write_error_message
-      "Error updating #{self.filepath}"
-    end
-  end
-end
-
-FFmpegError = Class.new(StandardError)

data/lib/pop_cap/formatters.rb

@@ -1,33 +0,0 @@
-module PopCap
-  # Internal: This module requires all formatters in "formatters/."
-  #
-  module Formatters
-    # Internal: This constant is a hash of all files in "formatters/."
-    # To add new custom formatters to Taggable#tags, add the formatter
-    # to "formatters/."
-    #
-    # Formatters should follow this format:
-    #
-    # Examples
-    #   attribute - :custom_formatter
-    #   path - lib/pop_cap/formatters/custom_formatter.rb
-    #   class - CustomFormatter
-    #   format instance method - #format
-    #
-    #   # lib/pop_cap/formatters/custom_formatter.rb
-    #   class CustomFormatter
-    #     def format
-    #       # code that formats
-    #     end
-    #   end
-    #
-    ::INCLUDED_FORMATTERS= {}
-
-    Dir["#{File.dirname(__FILE__)}/formatters/*.rb"].each do |path|
-      @file_name = File.basename(path , '.rb')
-      @required = 'pop_cap/formatters/' + @file_name
-      require @required
-      ::INCLUDED_FORMATTERS[@file_name.to_sym] = @required
-    end
-  end
-end

data/lib/pop_cap/helper.rb

@@ -1,53 +0,0 @@
-module PopCap
-  # Public: This class adds helper methods to construct a class.
-  #
-  # name - This is the name of the class.
-  #
-  # Examples
-  #   Helper.new('array')
-  #   Helper.new('active_support')
-  #   Helper.new('active_record/base')
-  #
-  class Helper
-    def initialize(name)
-      @name = name.to_s
-    end
-
-    # Public: This method camel cases a string or symbol.
-    #
-    # Examples
-    #   helper = Helper.new('active_support')
-    #   helper.camelize
-    #   # => 'ActiveSupport'
-    #
-    def camelize
-      @name.split('_').map { |word| word.capitalize }.join
-    end
-
-    # Public: This namespaces a string by converting a filepath
-    # to a namespaced constant.
-    #
-    # Examples
-    #   helper = Helper.new('active_record/base')
-    #   helper.namespace
-    #   # => 'ActiveRecord::Base'
-    #
-    def namespace
-      camelize.split('/').map do |word|
-        _,head,tail = word.partition(%r(^[a-zA-Z]))
-        head.upcase + tail
-      end.join('::')
-    end
-
-    # Public: This converts a string into a constant.
-    #
-    # Examples
-    #   helper = Helper.new('active_record/base')
-    #   helper.constantize
-    #   # => ActiveSupport::Base
-    #
-    def constantize
-      Object.module_eval(namespace)
-    end
-  end
-end

data/lib/pop_cap/tag_key.rb

@@ -1,32 +0,0 @@
-module PopCap
-  # Internal: This class sanitizes the raw output of FFmpeg to
-  # be used as a hash key.
-  #
-  # key - This is a single key as created by TagLine.
-  #
-  class TagKey
-    def initialize(key)
-      @key = key
-    end
-
-    # Internal: This method removes unwanted strings, downcases,
-    # & symbolizes a key.  Additionally, it renames keys named
-    # 'size' to 'filesize' in order to avoid potential conflicts
-    # with Ruby's build-in method of the same name.
-    #
-    # Examples
-    #   tk = TagKey.new('size')
-    #   tk.format
-    #   # => :filesize
-    #
-    def format
-      return '' if ( @key.nil? || @key.empty? )
-
-      @key.
-        sub(/^TAG:/,'').
-        sub(/^size\b/,'filesize').
-        downcase.
-        to_sym
-    end
-  end
-end

data/lib/pop_cap/tag_line.rb

@@ -1,36 +0,0 @@
-require 'pop_cap/tag_key'
-require 'pop_cap/formatters'
-
-module PopCap
-  # Internal: This class sanitizes the raw output of FFmpeg to
-  # and builds a hash.
-  #
-  # line - This is a single line of raw output from FFmpeg.
-  #
-  class TagLine
-    include
-    def initialize(line)
-      @line = line
-    end
-
-    # Internal: This method builds a hash by splitting on the
-    # first equal sign in a single line of content from FFmpeg.
-    # It uses TagKey to create the key for the hash.
-    #
-    # Examples
-    #   tl = TagLine.new('TAG:ARTIST=David Bowie')
-    #   to.to_hash
-    #   # => {artist: 'David Bowie'}
-    #
-    def to_hash
-      return {} unless ( @line && is_a_tag? )
-      key,val = @line.split('=',2)
-      {TagKey.new(key).format => val}
-    end
-
-    private
-    def is_a_tag?
-      @line.match('=')
-    end
-  end
-end

data/spec/lib/pop_cap/converter_spec.rb

@@ -1,67 +0,0 @@
-require 'spec_helper'
-require 'pop_cap/converter'
-
-module PopCap
-  describe Converter do
-    class FakeClass
-      include Converter
-      def filepath
-        'path/to/file.flac'
-      end
-    end
-
-    let(:bitrate) { %W{-ab 192k}}
-    let(:filepath) { 'path/to/file.flac' }
-    let(:fk) { FakeClass.new }
-    let(:input) { %W{ffmpeg -i #{filepath}} }
-
-    context '#command' do
-      let(:output_path) { %W{path/to/file.ogg} }
-
-      it 'builds a command' do
-        expect(fk.convert('ogg')).to eq(input + bitrate + output_path)
-      end
-
-      context 'format' do
-        it 'handles symbol' do
-          expect(fk.convert(:ogg)).to eq(input + bitrate + output_path)
-        end
-
-        it 'is case insenstive' do
-          expect(fk.convert('OGG')).to eq(input + bitrate + output_path)
-        end
-      end
-
-      context 'bitrate' do
-        let(:output_path) { %W{path/to/file.mp3} }
-
-        it 'defaults to 192 kb/s' do
-          expect(fk.convert(:mp3)).to eq(input + %W{-ab 192k} + output_path)
-        end
-
-        it 'takes an optional bitrate' do
-          expect(fk.convert(:mp3, 64)).to eq(input + %W{-ab 64k} + output_path)
-        end
-
-        it 'handles bitrate as string' do
-          expect(fk.convert(:mp3, '128')).
-            to eq(input + %W{-ab 128k} + output_path)
-        end
-      end
-
-      context 'm4a' do
-        let(:output_path) { %W{path/to/file.m4a} }
-
-        it 'uses strict mode' do
-          expect(fk.convert(:m4a)).
-            to eq(input + %W{-strict -2} + bitrate + output_path)
-        end
-
-        it 'ignores strict mode if not m4a' do
-          expect(fk.convert(:ogg)).
-            to eq(input + bitrate + %W{path/to/file.ogg})
-        end
-      end
-    end
-  end
-end

data/spec/lib/pop_cap/ffmpeg_spec.rb

@@ -1,96 +0,0 @@
-require 'spec_helper'
-require 'support/popcap_spec_helper'
-require 'pop_cap/ffmpeg'
-
-module PopCap
-  describe FFmpeg do
-    before { PopCapSpecHelper.setup }
-    after { PopCapSpecHelper.teardown }
-
-    let(:commander) { double('Commander') }
-    let(:filepath) { File.realpath('spec/support/sample.flac') }
-    let(:ffmpeg) { FFmpeg.new(filepath) }
-
-    it 'returns its filepath' do
-      expect(ffmpeg.filepath).to eq filepath
-    end
-
-    it 'raises error if FFmpeg not installed' do
-      error_message = 'No such file or directory - FFmpeg is not installed.'
-      expect do
-        Open3.stub(:capture3).with('ffmpeg').and_raise(Errno::ENOENT)
-        FFmpeg.new('filepath')
-      end.to raise_error(MissingDependency, error_message)
-    end
-
-    it 'includes Fileable' do
-      expect(FFmpeg.included_modules).to include Fileable
-    end
-
-    context '#read_tags' do
-      let(:output) { double('output') }
-
-      it 'sends a read command to Commander' do
-        expect(ffmpeg.read_tags).to eq PopCapSpecHelper.raw_tags
-      end
-
-      it 'encodes invalid byte strings as UTF-8' do
-        Commander.stub_chain(:new, :execute) { output }
-        output.should_receive(:success?) { true }
-        output.should_receive(:stdout) { output }
-        output.stub(:valid_encoding?) { false }
-        output.stub_chain(:encoding, :name) { 'UTF-8' }
-        output.should_receive(:encode!).
-          with('UTF-16', 'UTF-8', undef: :replace, invalid: :replace)
-        output.should_receive(:encode!).with('UTF-8')
-        ffmpeg.read_tags
-      end
-
-      it 'raises error if could not read tags' do
-        expect do
-          failed = double('commander', :success? => false)
-          Commander.stub_chain(:new, :execute) { failed }
-          ffmpeg.read_tags
-        end.
-          to raise_error(FFmpegError, 'Error reading ' + filepath)
-      end
-    end
-
-    context '#update_tags' do
-      let(:new_tags) { {artist: 'UPDATEDARTIST'} }
-
-      it 'updates tags on a temp file & copies temp file to original' do
-        expect(ffmpeg.read_tags).to match /Sample Artist/
-        ffmpeg.update_tags(new_tags)
-        expect(ffmpeg.read_tags).to match /UPDATEDARTIST/
-        expect(ffmpeg.read_tags).not_to match /Sample Artist/
-      end
-
-      it 'reloads read_tags' do
-        ffmpeg.read_tags
-        Commander.stub_chain(:new, :execute).
-          and_return(double('output', success?: true))
-        ffmpeg.stub(:restore)
-        ffmpeg.update_tags({})
-        expect(ffmpeg.instance_variable_get('@stdout')).to be_nil
-      end
-
-      it 'raises error if could not update tags' do
-        expect do
-          failed = double('commander', :success? => false)
-          Commander.stub_chain(:new, :execute) { failed }
-          ffmpeg.update_tags({})
-        end.
-          to raise_error(FFmpegError, 'Error updating ' + filepath)
-      end
-    end
-
-    context '#convert' do
-      it 'converts from input format to specified output format & bitrate' do
-        ffmpeg.convert(:mp3, 64)
-        mp3 = FFmpeg.new(File.realpath('spec/support/sample.mp3'))
-        expect(mp3.read_tags).to match /format_name=mp3/
-      end
-    end
-  end
-end