popcap 0.7.2 → 0.8.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 06018b8dc59e4e1f5e4a71499b2761a66263fcb3
+  data.tar.gz: 75e7e1d1d0d817d2d53bebdf7be0ffba63f2cd54
+SHA512:
+  metadata.gz: fd92273467cde9d7ebc21c8717034bfa54ed26aeebb56b07374ca77917f248d14c0d76fb3e8e3c6fe70980754f60d06d4149a471e0cb77904c5583e39e2aa77c
+  data.tar.gz: 343bf09d55d5e5f913a5cfc4b0e2d53ee88b039b7229a0c0889ee725396251952c66b4d3fbd5e3307240bc81e51407c18751e2eef7c4eff66f4f074f5a907a33

data/Gemfile

@@ -9,5 +9,4 @@ group :test do
   gem 'cane'
   gem 'reek'
   gem 'rspec'
-  gem 'simplecov'
 end

data/Gemfile.lock

@@ -2,42 +2,34 @@ GEM
   remote: https://rubygems.org/
   specs:
     awesome_print (1.1.0)
-    cane (2.5.0)
+    cane (2.5.2)
       parallel
-    coderay (1.0.8)
-    diff-lcs (1.1.3)
+    coderay (1.0.9)
+    diff-lcs (1.2.1)
     method_source (0.8.1)
-    multi_json (1.5.0)
-    parallel (0.6.1)
-    pry (0.9.11.3)
+    parallel (0.6.2)
+    pry (0.9.12)
       coderay (~> 1.0.5)
       method_source (~> 0.8)
       slop (~> 3.4)
-    reek (1.2.13)
-      ripper_ruby_parser (~> 0.0.7)
-      ruby2ruby (~> 1.2.5)
-      ruby_parser (~> 2.0)
-      sexp_processor (~> 3.0)
-    ripper_ruby_parser (0.0.8)
-      sexp_processor (~> 3.0)
-    rspec (2.12.0)
-      rspec-core (~> 2.12.0)
-      rspec-expectations (~> 2.12.0)
-      rspec-mocks (~> 2.12.0)
-    rspec-core (2.12.2)
-    rspec-expectations (2.12.1)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.12.2)
-    ruby2ruby (1.2.5)
-      ruby_parser (~> 2.0)
-      sexp_processor (~> 3.0)
-    ruby_parser (2.3.1)
-      sexp_processor (~> 3.0)
-    sexp_processor (3.2.0)
-    simplecov (0.7.1)
-      multi_json (~> 1.0)
-      simplecov-html (~> 0.7.1)
-    simplecov-html (0.7.1)
+    reek (1.3.1)
+      ruby2ruby (~> 2.0.2)
+      ruby_parser (~> 3.1.1)
+      sexp_processor
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.0)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.0)
+    ruby2ruby (2.0.3)
+      ruby_parser (~> 3.1)
+      sexp_processor (~> 4.0)
+    ruby_parser (3.1.1)
+      sexp_processor (~> 4.1)
+    sexp_processor (4.1.5)
     slop (3.4.3)
 
 PLATFORMS
@@ -49,4 +41,3 @@ DEPENDENCIES
   pry
   reek
   rspec
-  simplecov

data/README.md

@@ -22,25 +22,26 @@ Read the metadata tags from an audio file.
 ```
 audio_file = PopCap::AudioFile.new('sample.flac')
 
-audio_file.raw_tags => Returns a string of the raw output from running ffprobe -show_format.
-    [FORMAT]
-    filename=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]
-
-audio_file.to_hash => Returns a Ruby hash after sanitizing the raw output of #raw_tags.
+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',
@@ -56,13 +57,14 @@ audio_file.to_hash => Returns a Ruby hash after sanitizing the raw output of #ra
       title: 'Sample Title',
       artist: 'Sample Artist' }
 
-audio_file.tags => Returns a tag structure after applying formatters #to_hash.
+audio_file.tags => Returns a tag structure using the #formatted values.
+
     .album             =>  'Sample Album'
     .artist            =>  'Sample Artist'
     .bit_rate          =>  '146 kb/s'
     .date              =>  2012
     .duration          =>  '1'
-    .filename          =>  'spec/support/sample.flac'
+    .filename          =>  'spec/fixtures/sample.flac'
     .filesize          =>  '17.9K'
     .format_long_name  =>  'raw FLAC'
     .format_name       =>  'flac'
@@ -72,7 +74,7 @@ audio_file.tags => Returns a tag structure after applying formatters #to_hash.
     .title             =>  'Sample Title'
     .track             =>  '01'
 
-audio_file.reload! => Reload an instance of itself, useful when updating tags.
+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
@@ -82,9 +84,9 @@ This will update the metadata tags for an audio file.  It will also dynamically
 
 ```
 audio_file = PopCap::AudioFile.new('sample.flac')
-audio_file.update_tags({artist: 'David Bowie'})
+audio_file.update_tags(artist: 'David Bowie'})
 
-audio_file.update_tags({fancy_new_tag: 'Custom Tag Input'})
+audio_file.update_tags(fancy_new_tag: 'Custom Tag Input')
 ```
 
 Convert
@@ -133,5 +135,6 @@ audio_file.tmppath # => returns the temporary path, e.g. '/tmp/sample.flac'
 
 Dependencies
 ------------
+Ruby 2.0+
 
 [FFmpeg](http://ffmpeg.org)

data/lib/pop_cap/audio_file.rb

@@ -1,4 +1,7 @@
-require 'pop_cap/ffmpeg'
+require 'pop_cap/ffmpeg/converter'
+require 'pop_cap/ffmpeg/tag_reader'
+require 'pop_cap/ffmpeg/tag_writer'
+require 'pop_cap/fileable'
 require 'pop_cap/taggable'
 
 module PopCap
@@ -9,7 +12,7 @@ module PopCap
   #
   # Examples
   #
-  #   filepath = 'spec/support/sample.flac'
+  #   filepath = 'spec/fixtures/sample.flac'
   #   af = AudioFile.new(filepath)
   #
   #
@@ -23,10 +26,9 @@ module PopCap
     #
     # filepath - Requires a valid filepath to a file on the local filesystem.
     #
-    def initialize(filepath, tag_util=FFmpeg)
+    def initialize(filepath)
       raise(FileNotFound, filepath) unless File.exists?(filepath)
       @filepath = File.realpath(filepath)
-      @tag_util = tag_util
     end
 
     # Public: convert
@@ -37,23 +39,23 @@ module PopCap
     # bitrate - An optional bitrate for mp3s.
     #
     # Examples
-    #   audio_file = AudioFile.new('spec/support/sample.flac')
+    #   audio_file = AudioFile.new('spec/fixtures/sample.flac')
     #   audio_file.convert('mp3', 128)
-    #   # => 'spec/support/sample.mp3'
+    #   # => 'spec/fixtures/sample.mp3'
     #
     def convert(format, bitrate=192)
-      @tag_util.new(@filepath).convert(format, bitrate)
+      Converter.convert(filepath, {format: format, bitrate: bitrate})
     end
 
     # Public: raw_tags
     # This method returns the raw_tags from FFmpeg.
     #
     # Examples
-    #   audio_file = AudioFile.new('spec/support/sample.flac')
+    #   audio_file = AudioFile.new('spec/fixtures/sample.flac')
     #   audio_file.raw_tags
     #   # =>
     #    [FORMAT]
-    #    filename=spec/support/sample.flac
+    #    filename=spec/fixtures/sample.flac
     #    nb_streams=1
     #    format_name=flac
     #    format_long_name=raw FLAC
@@ -70,7 +72,7 @@ module PopCap
     #    [/FORMAT]
     #
     def raw_tags
-      @raw ||= @tag_util.new(@filepath).read_tags
+      @raw ||= TagReader.read(filepath)
     end
 
     # Public: This method reloads the current instance.
@@ -93,7 +95,7 @@ module PopCap
     #   audio_file.update_tags({artist: 'New Artist', album: 'New Album'})
     #
     def update_tags(updates)
-      @tag_util.new(@filepath).update_tags(updates)
+      TagWriter.write(filepath, updates)
       self.reload!
     end
   end

data/lib/pop_cap/class_support.rb

@@ -0,0 +1,73 @@
+module PopCap
+  # Public: This class adds methods to construct a class.
+  #
+  # name - This is the name of the class.
+  #
+  # Examples
+  #   ClassSupport.new('array')
+  #   ClassSupport.new('active_support')
+  #   ClassSupport.new('active_record/base')
+  #
+  class ClassSupport
+    attr_reader :name
+
+    def initialize(name)
+      @name = name.to_s
+    end
+
+    # Public: This method camel cases a string or symbol.
+    #
+    # Examples
+    #   support = ClassSupport.new('active_support')
+    #   support.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
+    #   support = ClassSupport.new('active_record/base')
+    #   support.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
+    #   support = ClassSupport.new('active_record/base')
+    #   support.constantize
+    #   # => ActiveSupport::Base
+    #
+    def constantize
+      Object.module_eval(namespace)
+    end
+
+    # Public: This converts a string into a symbol.
+    # It will handle CamelCased strings.
+    #
+    # option - It takes an option to demodulize the string.
+    #
+    # Examples
+    #   support = ClassSupport.new('ActiveSupport')
+    #   support.symbolize
+    #   # => :active_support
+    #
+    #   support = ClassSupport.new('ActiveSupport::CamelCase')
+    #   support.symbolize(:demodulize)
+    #   # => :camel_case
+    #
+    def symbolize
+      name.split('::').last.split(%r((?=[A-Z]))).join('_').downcase.to_sym
+    end
+  end
+end

data/lib/pop_cap/{commander.rb → ffmpeg/commander.rb}

@@ -10,13 +10,15 @@ module PopCap
   #   # => <directory contents>
   #
   class Commander
+    attr_reader :command
     # Public: Initialize
     #
     # args - Arguments should be escaped with an interpolated literal.
     #
     def initialize(*args)
       raise(ArgumentError, error_message) if args.empty?
-      @command = args.inject(%W{}) { |command, arg| command << arg }
+      @args = args
+      @command = shell_escaped_arguments
       @executed = []
     end
 
@@ -25,7 +27,7 @@ module PopCap
     # to chain methods.
     #
     def execute
-      @executed = Open3.capture3(*@command)
+      @executed = Open3.capture3(*command)
       self
     end
 
@@ -57,6 +59,10 @@ module PopCap
     end
 
     private
+    def shell_escaped_arguments
+      @args.inject(%W{}) { |command, arg| command << arg }
+    end
+
     def error_message
       'Cannot run command with no args.'
     end

data/lib/pop_cap/ffmpeg/converter.rb

@@ -0,0 +1,57 @@
+require 'pop_cap/ffmpeg/ffmpeg'
+
+module PopCap
+  # Public: This class converts an audio file to the specified
+  # output format.
+  #
+  class Converter < FFmpeg
+    # Public: This method will execute the conversion.
+    #
+    def convert
+      unless commander.new(*command).execute.success?
+        raise(FFmpegError, error_message('converting'))
+      end
+    end
+
+    # Public: A convenience class method which wraps the instance
+    # constructor.
+    #
+    def self.convert(filepath, options={})
+      new(filepath, options).convert
+    end
+
+    private
+    def format
+      options[:format].downcase.to_s
+    end
+
+    def bitrate
+      options[:bitrate] || 192
+    end
+
+    def command
+      input_path + strict_mode + bitrate_options + output_path
+    end
+
+    def bitrate_options
+      %W{-ab #{bitrate}k}
+    end
+
+    def input_path
+      %W{ffmpeg -i #{filepath}}
+    end
+
+    def output_path
+      %W{#{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/ffmpeg.rb

@@ -0,0 +1,45 @@
+require 'pop_cap/ffmpeg/commander'
+
+module PopCap
+  FFmpegError = Class.new(StandardError)
+  MissingDependency = Class.new(Errno::ENOENT)
+
+  # Public: This is a wrapper for the FFmpeg C library.
+  #
+  # Examples
+  #
+  #   file = 'spec/fixtures/sample.flac'
+  #   ffmpeg = FFmpeg.new(filepath)
+  #
+  class FFmpeg
+    attr_accessor :commander, :filepath, :options
+
+    # Public: initialize
+    #
+    # filepath - Requires a valid filepath to a file on the local filesystem.
+    # commander - Defaults to Commander for executing system commands.
+    #
+    def initialize(filepath, options={})
+      check_for_ffmpeg_install
+      @filepath, @options = filepath, options
+      @commander = options[:commander] || Commander
+    end
+
+    # Public: error_message
+    #
+    # message - Provide the message to return.
+    #
+    def error_message(message)
+      "Error #{message} #{filepath}."
+    end
+
+    private
+    def check_for_ffmpeg_install
+      begin
+        Open3.capture3('ffmpeg')
+      rescue Errno::ENOENT
+        raise MissingDependency, 'FFmpeg is not installed.'
+      end
+    end
+  end
+end

data/lib/pop_cap/ffmpeg/tag_reader.rb

@@ -0,0 +1,45 @@
+require 'json'
+require 'pop_cap/ffmpeg/ffmpeg'
+
+module PopCap
+  # Public: This class wraps FFprobe to read tags from a specified file.
+  #
+  class TagReader < FFmpeg
+    # Public: This method returns the results of FFprobe -show_format.
+    #
+    def read
+      JSON.load(encode(output)).to_json
+    end
+
+    # Public: A convenience class method which wraps the instance
+    # constructor.
+    #
+    def self.read(filepath, options={})
+      new(filepath, options).read
+    end
+
+    private
+    def command
+      %W{ffprobe -show_format -print_format json} + %W{#{filepath}}
+    end
+
+    def output
+      executed = commander.new(*command).execute
+      raise(FFmpegError, error_message('reading')) unless executed.success?
+      executed.stdout
+    end
+
+    def encode(string)
+      return string if string.valid_encoding?
+      remove_invalid_bytes(string)
+    end
+
+    def remove_invalid_bytes(string)
+      @string = string
+      original_encoding = @string.encoding.name
+      @string.encode!('UTF-16', original_encoding, undef:
+                      :replace, invalid: :replace)
+      @string.encode!('UTF-8')
+    end
+  end
+end

data/lib/pop_cap/ffmpeg/tag_writer.rb

@@ -0,0 +1,44 @@
+require 'pop_cap/ffmpeg/ffmpeg'
+require 'fileutils'
+
+module PopCap
+  # Public: This class wraps FFmpeg to write tags for a specified file.
+  #
+  class TagWriter < FFmpeg
+    # Public: This methods writes the tags to a temporary file, if
+    # successful, it moves the temporary file over the original.  This
+    # is done to prevent corrupting the original file.
+    #
+    def write
+      unless commander.new(*command).execute.success?
+        raise(FFmpegError, error_message('writing'))
+      end
+      FileUtils.move(tmppath, filepath)
+    end
+
+    # Public: A convenience class method to wrap #new & #write.
+    #
+    def self.write(filepath, options = {})
+      new(filepath, options).write
+    end
+
+    private
+    def tmppath
+      '/tmp/' + File.basename(filepath)
+    end
+
+    def command
+      %W{ffmpeg -i #{filepath}} + write_options + %W{#{tmppath}}
+    end
+
+    def write_options
+      clean_tags.inject(%W{}) do |tags,tag|
+        tags << '-metadata' << tag.join('=')
+      end
+    end
+
+    def clean_tags
+      @cleaned ||= options.reject { |key,_| key == :commander }
+    end
+  end
+end

data/lib/pop_cap/formatter.rb

@@ -0,0 +1,62 @@
+module PopCap
+  module Formatters
+    # Public: This is a super class for all formatter classes.
+    # It establishes the default behavior of formatter classes.
+    #
+    class Formatter
+      attr_reader :value, :options
+
+      # Public: This class is constructed with a value & options hash.
+      #
+      # value - The value to be formatted.
+      # options - An options hash.
+      #
+      def initialize(value, options={})
+        @value, @options = value, options
+      end
+
+      # Public: This method contains the handles the formating.
+      #
+      def format
+      end
+
+      # Public: A class method for convenience calling of #format.
+      #
+      def self.format(value, options={})
+        new(value, options).format
+      end
+
+      # Public: This returns an array of all subclasses.
+      #
+      def self.subclasses
+        require_all_formatters
+
+        ObjectSpace.each_object(Class).select do |klass|
+          klass if is_a_subclass?(klass)
+        end.uniq.compact
+      end
+
+      # Public: This returns an array of all subclasses "demodulized."
+      #
+      def self.subclasses_demodulized
+        subclasses.map { |klass| demodulize(klass) }
+      end
+
+      private
+      def self.require_all_formatters
+        Dir["#{File.dirname(__FILE__)}/formatters/*.rb"].each do |file|
+          require File.realpath(file)
+        end
+      end
+
+      def self.demodulize(klass)
+        klass.to_s.split('::').last
+      end
+
+      def self.is_a_subclass?(klass)
+        superclass = klass.superclass
+        superclass && superclass.name == self.name
+      end
+    end
+  end
+end

data/lib/pop_cap/formatters/bit_rate.rb

@@ -1,3 +1,5 @@
+require 'pop_cap/formatter'
+
 module PopCap
   module Formatters
     # Public: This is a formatter for the bit_rate tag.  It is used
@@ -5,11 +7,7 @@ module PopCap
     #
     # bitrate - The bitrate can be sent as a string or integer.
     #
-    class BitRate
-      def initialize(bitrate)
-        @bitrate = bitrate
-      end
-
+    class BitRate < Formatter
       # Public: This method returns a bitrate represented in kilobytes.
       #
       # It returns nil for anything that is not a number greater than
@@ -21,8 +19,8 @@ module PopCap
       #   # => '128 kb/s'
       #
       def format
-        return unless @bitrate.to_i > 0
-        @bitrate.to_s[0..-4] + ' kb/s'
+        return unless @value.to_i > 0
+        @value.to_s[0..-4] + ' kb/s'
       end
     end
   end

data/lib/pop_cap/formatters/date.rb

@@ -1,3 +1,5 @@
+require 'pop_cap/formatter'
+
 module PopCap
   module Formatters
     # Public: This is a formatter for the date tag.  It is used
@@ -8,15 +10,7 @@ module PopCap
     #           The start_date defaults to 1800, end_date defaults
     #           to 2100.
     #
-    class Date
-      attr_reader :start_date, :end_date
-
-      def initialize(date, options={})
-        @date = date.to_s
-        @start_date = options[:start_date] || 1800
-        @end_date = options[:end_date] || 2100
-      end
-
+    class Date < Formatter
       # Public:  This method returns a year if it is matched.
       #
       # Examples
@@ -29,9 +23,17 @@ module PopCap
         @match[0].to_i
       end
 
+      def start_date
+        options[:start_date] || 1800
+      end
+
+      def end_date
+        options[:end_date] || 2100
+      end
+
       private
       def date_match
-        @match ||= @date.match(/\b\d{4}\b/)
+        @match ||= value.to_s.match(/\b\d{4}\b/)
       end
 
       def within_date_range?