flacky 0.9.0 → 1.0.0

data/bin/flacky

@@ -9,4 +9,6 @@ $:.unshift File.join(File.dirname(__FILE__), %w{.. lib})
 require 'rubygems'
 require 'flacky/cli'
 
+$stdout.sync = true
+
 Flacky::CLI.start

data/flacky.gemspec

@@ -17,9 +17,11 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
+  gem.required_ruby_version = ">= 1.9.3"
+
   gem.add_dependency 'thor'
   gem.add_dependency 'nokogiri'
-  gem.add_dependency 'flacinfo-rb'
+  gem.add_dependency 'taglib-ruby'
 
   gem.add_development_dependency 'minitest'
   gem.add_development_dependency 'vcr'

data/lib/flacky/cli.rb

@@ -5,6 +5,7 @@ require 'json'
 require 'thor'
 
 require 'flacky'
+require 'flacky/flac_metadata_importer'
 require 'flacky/metadata_generator'
 require 'flacky/mp3_convertor'
 
@@ -14,8 +15,8 @@ module Flacky
 
     include Thor::Actions
 
-    desc "generate <root_path>", "Generate and populate metadata as JSON"
-    def generate(root_dir = ENV['PWD'])
+    desc "generate_json <root_path>", "Generate and populate metadata as JSON"
+    def generate_json(root_dir = ENV['PWD'])
       start_dir = File.join(File.expand_path(root_dir), '**/*.flac')
       Dir.glob(start_dir).map { |f| File.dirname(f) }.uniq.each do |dir|
         mdf = File.join(dir, "metadata.json")
@@ -25,6 +26,11 @@ module Flacky
       end
     end
 
+    desc "import_json [file ...]|[**/*.flac ...]", "Import metadata JSON into Flac files"
+    def import_json(*args)
+      args.each { |glob| import_metadata_for_files(glob) }
+    end
+
     desc "missing_urls <root_path>", "List all metadata files with missing URLs"
     method_option :print0, :aliases => "-0", :type => :boolean
     def missing_urls(root_dir = ENV['PWD'])
@@ -43,14 +49,14 @@ module Flacky
       end
     end
 
-    desc "to_mp3 [file ...]|[**/*.flac ...]", "Convert Flac files to MP3 files"
+    desc "to_mp3 [file ...]|[**/*.flac ...] [options]", "Convert Flac files to MP3 files"
     method_option :destination, :aliases => "-d",
       :desc => "Sets optional destination directory"
     method_option :'lame-opts', :aliases => "-l",
-      :default => "--vbr-new -V 0 -b 320",
+      :default => "--vbr-new --verbose -V 0 -b 320",
       :desc => "Set the lame encoding arguments"
     def to_mp3(*args)
-      %w{flac metaflac lame}.each do |cmd|
+      %w{flac lame}.each do |cmd|
         abort "Command #{cmd} must be on your PATH" unless %x{which #{cmd}}
       end
 
@@ -75,6 +81,17 @@ module Flacky
       end
     end
 
+    def import_metadata_for_files(glob)
+      Dir.glob(glob).each do |file|
+        next unless file =~ /\.flac$/
+
+        say("Processing #{file}...", :cyan)
+        response = Flacky::FlacMetadataImporter.new(file).import!
+        say("Imported #{response.metadata_filename} into #{file} " +
+          "#{duration(response.elapsed)}", :yellow)
+      end
+    end
+
     def duration(total)
       minutes = (total / 60).to_i
       seconds = (total - (minutes * 60))

data/lib/flacky/flac_metadata_importer.rb

@@ -0,0 +1,50 @@
+# -*- encoding: utf-8 -*-
+
+require 'flacky/flac_tagger'
+
+module Flacky
+
+  class FlacMetadataImporter
+
+    def initialize(file)
+      @file = file
+    end
+
+    def import!
+      return Resonse.new(nil, 0) if ! File.exists?(metadata_file)
+
+      md = JSON.parse(IO.read(metadata_file))
+
+      elapsed = Benchmark.measure do
+        FlacTagger.update(@file) do
+          trackn_good = self["TRACKNUMBER"] && self["TRACKNUMBER"].to_i > 0
+          discn_good = self["DISCNUMBER"] && self["DISCNUMBER"].to_i > 0
+          md_good = md["flac"] && md["flac"]["totaltracks"] \
+            && md["flac"]["totaltracks"].is_a?(Array)
+          totaltracks = md["flac"]["totaltracks"][self["DISCNUMBER"].to_i - 1]
+
+          %w{artist album genre style mood fileowner}.each do |t|
+            tag(t, md["flac"][t]) if md["flac"] && md["flac"][t]
+          end
+
+          tag "DATE", md["flac"]["year"] if md["flac"]["year"]
+
+          if trackn_good && discn_good && md_good
+            tag('TOTALTRACKS', totaltracks.to_s)
+            tag('TOTALDISCS', md["flac"]["totaltracks"].size.to_s)
+          end
+        end
+      end
+
+      Response.new(metadata_file, elapsed.real)
+    end
+
+    Response = Struct.new(:metadata_filename, :elapsed)
+
+    private
+
+    def metadata_file
+      @metadata_file ||= File.join(File.dirname(@file), "metadata.json")
+    end
+  end
+end

data/lib/flacky/flac_tagger.rb

@@ -0,0 +1,49 @@
+# -*- encoding: utf-8 -*-
+
+require 'taglib'
+
+module Flacky
+  class FlacTagger
+
+    def self.update(file, &block)
+      instance = self.new(file)
+      instance.instance_eval(&block)
+      instance.update!
+    end
+
+    def initialize(file)
+      @taglib = TagLib::FLAC::File.new(file)
+      @tag = @taglib.xiph_comment
+    end
+
+    def [](attr)
+      result = @tag.field_list_map[attr]
+
+      if result.nil?
+        nil
+      elsif result.is_a?(Array) && result.size == 1
+        result.first
+      else
+        result
+      end
+    end
+
+    def find(attr)
+      key = @tag.field_list_map.keys.find { |key| key =~ /#{attr}/i }
+      key ? self[key] : nil
+    end
+
+    def tag(name, value)
+      @tag.add_field(name.to_s.upcase, value, true)
+    end
+
+    def cleanup
+      @taglib.close
+    end
+
+    def update!
+      @taglib.save
+      cleanup
+    end
+  end
+end

data/lib/flacky/metadata_generator.rb

@@ -1,6 +1,6 @@
 # -*- encoding: UTF-8 -*-
 
-require 'flacinfo'
+require 'taglib'
 
 require 'flacky/core_ext'
 require 'flacky/scraper'
@@ -19,16 +19,23 @@ module Flacky
       flacs = Dir.glob(File.join(dir, '*.flac'))
       return Hash.new if flacs.empty?
 
-      # keep trying flac files until we run out
-      info = begin
-        FlacInfo.new(flacs.shift).tags
-      rescue FlacInfoReadError => ex
-        flacs.size > 0 ? retry : Hash.new
+      result = Hash.new
+      result["totaltracks"] = []
+
+      flacs.each do |flac|
+        md = read_flac_metadata(flac)
+        track_total = (md["totaltracks"] || -1).to_i
+        disc_number = (md["discnumber"] || -1).to_i
+
+        next if track_total < 0 || disc_number < 0
+        next if result["totaltracks"][disc_number - 1]
+
+        result["totaltracks"][disc_number - 1] = track_total
+
+        common_tags.each { |t| result[t] = md[t] if md[t] }
       end
+      result["year"] = result.delete("date") if result["date"]
 
-      info.each_pair { |k,v| v.force_encoding('UTF-8') if v.is_a? String }
-      result = Hash.new
-      common_tags.each { |t| result[t] = info[t] }
       result
     end
 
@@ -55,7 +62,24 @@ module Flacky
     end
 
     def common_tags
-      %w[Artist Album Date Genre TOTALDISCS STYLE MOOD FILEOWNER].freeze
+      %w[artist album date year genre style mood fileowner].freeze
+    end
+
+    def read_flac_metadata(flac)
+      info = TagLib::FLAC::File.open(flac) do |file|
+        file.xiph_comment.field_list_map
+      end
+
+      info.each_pair do |k, v|
+        value = Array(v).first
+        value.force_encoding('UTF-8') if v.is_a? String
+        info[k] = value
+      end
+      info.keys.each do |key|
+        info[key.downcase] = info.delete(key)
+      end
+
+      info
     end
   end
 end

data/lib/flacky/mp3_convertor.rb

@@ -1,5 +1,8 @@
 # -*- encoding: utf-8 -*-
 
+require 'flacky/flac_tagger'
+require 'flacky/mp3_tagger'
+
 module Flacky
 
   class Mp3Convertor
@@ -9,19 +12,16 @@ module Flacky
       @dest_root = opts[:dest_root]
     end
 
-    def convert_file!(file)
-      dst = file.sub(/\.flac$/, ".mp3")
-      if dest_root
-        dst = File.join(dest_root, dst)
-        FileUtils.mkdir_p File.dirname(dst)
-      end
+    def convert_file!(flac_file)
+      mp3_file = calculate_mp3_filename(flac_file)
 
-      cmd = %{flac -dcs "#{file}" | lame #{lame_opts}}
-      tags.each { |lt, ft| cmd << %{ --#{lt} "#{tag(file, ft)}"} }
-      cmd << %{ - "#{dst}"}
+      elapsed = Benchmark.measure do
+        FileUtils.mkdir_p File.dirname(mp3_file)
+        transcode_file(flac_file, mp3_file)
+        tag_file(flac_file, mp3_file)
+      end
 
-      elapsed = Benchmark.measure do ; %x{#{cmd}} ; end
-      Response.new(dst, elapsed.real)
+      Response.new(mp3_file, elapsed.real)
     end
 
     Response = Struct.new(:mp3_filename, :elapsed)
@@ -30,18 +30,62 @@ module Flacky
 
     attr_reader :lame_opts, :dest_root
 
-    def tags
-      { :tt => :title, :tl => :album, :ta => :artist, :tn => :tracknumber,
-        :tg => :genre, :tc => :comment, :ty => :date }.freeze
+    def calculate_mp3_filename(flac_file)
+      mp3_file = flac_file.sub(/\.flac$/, ".mp3")
+      mp3_file = File.join(dest_root, mp3_file) if dest_root
+      File.expand_path(mp3_file)
+    end
+
+    def transcode_file(flac_file, mp3_file)
+      %x{flac -dcs "#{flac_file}" | lame #{lame_opts} - "#{mp3_file}"}
+    end
+
+    def tag_file(flac_file, mp3_file)
+      flac_tags = Flacky::FlacTagger.new(flac_file)
+      track     = track_tag(flac_tags)
+      disc      = disc_tag(flac_tags)
+      comment   = comment_tag(flac_tags)
+
+      Flacky::Mp3Tagger.update(mp3_file) do
+        tag "album",    flac_tags.find(:album)
+        tag "artist",   flac_tags.find(:artist)
+        tag "title",    flac_tags.find(:title)
+        tag "year",     flac_tags.find(:date).to_i
+        tag "genre",    flac_tags.find(:genre)
+        tag "track",    track
+        tag "disc",     disc
+        tag "comment",  comment
+      end
+
+      flac_tags.cleanup
     end
 
-    def tag(file, tag)
-      r = %x{metaflac --show-tag=#{tag.to_s.upcase} "#{file}"}
-      unless r.nil? || r.empty?
-        r.split("=").last.chomp
-      else
-        ""
+    def track_tag(flac_tags)
+      track_number = flac_tags.find(:tracknumber) || "0"
+      track_total = flac_tags.find(:totaltracks) || "1"
+
+      "#{track_number}/#{track_total}"
+    end
+
+    def disc_tag(flac_tags)
+      disc_number = flac_tags.find(:discnumber) || "0"
+      disc_total = flac_tags.find(:totaldiscs) || "1"
+
+      "#{disc_number}/#{disc_total}"
+    end
+
+    def comment_tag(flac_tags)
+      comment = []
+      if owner = flac_tags.find(:fileowner)
+        comment << "o=#{owner}"
+      end
+      (flac_tags.find(:style) || "").split(';').each do |style|
+        comment << "s=#{style}"
+      end
+      (flac_tags.find(:mood) || "").split(';').each do |mood|
+        comment << "m=#{mood}"
       end
+      comment.join("\n")
     end
   end
 end

data/lib/flacky/mp3_tagger.rb

@@ -0,0 +1,79 @@
+# -*- encoding: utf-8 -*-
+
+require 'taglib'
+
+module Flacky
+  class Mp3Tagger
+
+    def self.update(file, &block)
+      instance = self.new(file)
+      instance.instance_eval(&block)
+      instance.update!
+    end
+
+    def initialize(file)
+      @taglib = TagLib::MPEG::File.new(file)
+      @tag = @taglib.id3v2_tag
+    end
+
+    def [](attr)
+      result = @tag.field_list_map[attr]
+
+      if result.nil?
+        nil
+      elsif result.is_a?(Array) && result.size == 1
+        result.first
+      else
+        result
+      end
+    end
+
+    def find(attr)
+      key = @tag.field_list_map.keys.find { |key| key =~ /#{attr}/i }
+      key ? self[key] : nil
+    end
+
+    def tag(name, value)
+      if TAGS.include?(name.to_sym)
+        @tag.public_send("#{name}=", value)
+      elsif name =~ /track/i
+        @tag.add_frame(new_text_frame("TRCK", value))
+      elsif name =~ /disc/i
+        @tag.add_frame(new_text_frame("TPOS", value))
+      elsif name =~ /comment/i
+        @tag.add_frame(new_comment_frame(value))
+      end
+    end
+
+    def cleanup
+      @taglib.close
+    end
+
+    def update!
+      @taglib.save
+      cleanup
+    end
+
+    private
+
+    TAGS = [:album, :artist, :title, :year, :genre].freeze
+
+    def encoding
+      TagLib::String::Latin1
+    end
+
+    def new_text_frame(type, value)
+      frame = TagLib::ID3v2::TextIdentificationFrame.new(type, encoding)
+      frame.text = value
+      frame
+    end
+
+    def new_comment_frame(value)
+      frame = TagLib::ID3v2::CommentsFrame.new
+      frame.text_encoding = encoding
+      frame.language = "eng"
+      frame.text = value
+      frame
+    end
+  end
+end

data/lib/flacky/version.rb

@@ -1,3 +1,3 @@
 module Flacky
-  VERSION = "0.9.0"
+  VERSION = "1.0.0"
 end

data/spec/flacky/flac_tagger_spec.rb

@@ -0,0 +1,99 @@
+# -*- encoding: utf-8 -*-
+
+require 'minitest/autorun'
+require 'mocha/setup'
+require 'flacky/flac_tagger'
+
+describe Flacky::FlacTagger do
+
+  let(:flac_file) do
+    File.join(File.dirname(__FILE__), '../fixtures/silence.flac')
+  end
+
+  let(:tagger) do
+    Flacky::FlacTagger.new(flac_file)
+  end
+
+  describe "when writing tags" do
+
+    let(:tag) do
+      mock('xiph_comment')
+    end
+
+    let(:taglib_flac) do
+      mock = TagLib::FLAC::File.new(flac_file)
+      mock.stubs(:save).returns(true)
+      mock.stubs(:xiph_comment).returns(tag)
+      mock
+    end
+
+    before do
+      taglib_flac
+      TagLib::FLAC::File.stubs(:new).returns(taglib_flac)
+    end
+
+    describe "#tag" do
+      it "sets a tag if none exist" do
+        tag.expects(:add_field).with("DISCNUMBER", "1", true)
+
+        tagger.tag "DISCNUMBER", "1"
+      end
+
+      it "sets a tag if one exists" do
+        tag.expects(:add_field).with("TITLE", "Foopants", true)
+
+        tagger.tag "TITLE", "Foopants"
+      end
+    end
+
+    describe ".update" do
+
+      it "add the tag and updates" do
+        tag.expects(:add_field).with("ARTIST", "The MiniTest", true)
+        taglib_flac.expects(:save)
+        taglib_flac.expects(:close).at_least_once
+
+        Flacky::FlacTagger.update(flac_file) do
+          tag "ARTIST", "The MiniTest"
+        end
+      end
+    end
+  end
+
+  describe "when reading" do
+
+    after do
+      tagger.cleanup
+    end
+
+    describe "#find" do
+
+      it "returns nil if attribute isn't found" do
+        tagger.find("haha").must_be_nil
+      end
+
+      it "returns a string if tag value array only has only one element" do
+        tagger.find("GENRE").must_equal "Avantgarde"
+      end
+
+      it "matches case insensitive attribute matches" do
+        tagger.find("artist").must_equal "Fletcher Nichol"
+      end
+    end
+
+    describe "#[]" do
+
+      it "returns nil if attribute isn't found" do
+        tagger["nope"].must_be_nil
+      end
+
+      it "returns a string if tag value array only has only one element" do
+        tagger["GENRE"].must_equal "Avantgarde"
+      end
+
+      it "returns and array if tag value has multiple elements" do
+        tagger["MULTIPLE"].must_equal ["One", "Two"]
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flacky
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-24 00:00:00.000000000 Z
+date: 2013-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -44,7 +44,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: flacinfo-rb
+  name: taglib-ruby
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
@@ -158,17 +158,19 @@ files:
 - lib/flacky.rb
 - lib/flacky/cli.rb
 - lib/flacky/core_ext.rb
+- lib/flacky/flac_metadata_importer.rb
+- lib/flacky/flac_tagger.rb
 - lib/flacky/metadata_generator.rb
 - lib/flacky/mp3_convertor.rb
+- lib/flacky/mp3_tagger.rb
 - lib/flacky/scraper.rb
-- lib/flacky/tagger.rb
 - lib/flacky/version.rb
 - spec/fixtures/silence.flac
 - spec/fixtures/vcr_cassettes/audioslave_revelations.yml
 - spec/fixtures/vcr_cassettes/bend_sinister_small_fame.yml
 - spec/fixtures/vcr_cassettes/rush_moving_pictures.yml
+- spec/flacky/flac_tagger_spec.rb
 - spec/flacky/scraper_spec.rb
-- spec/flacky/tagger_spec.rb
 homepage: https://github.com/fnichol/flacky
 licenses: []
 post_install_message: 
@@ -180,7 +182,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -198,5 +200,5 @@ test_files:
 - spec/fixtures/vcr_cassettes/audioslave_revelations.yml
 - spec/fixtures/vcr_cassettes/bend_sinister_small_fame.yml
 - spec/fixtures/vcr_cassettes/rush_moving_pictures.yml
+- spec/flacky/flac_tagger_spec.rb
 - spec/flacky/scraper_spec.rb
-- spec/flacky/tagger_spec.rb

data/lib/flacky/tagger.rb

@@ -1,27 +0,0 @@
-# -*- encoding: utf-8 -*-
-
-require 'flacinfo'
-
-module Flacky
-  class Tagger
-    def self.update(flac_file, &block)
-      instance = self.new(flac_file)
-      instance.instance_eval(&block)
-      instance.update!
-    end
-
-    def initialize(flac_file)
-      @flac_file = flac_file
-      @flac = FlacInfo.new(@flac_file)
-    end
-
-    def tag(name, value)
-      @flac.comment_del(name) if @flac.tags.keys.include?(name)
-      @flac.comment_add("#{name}=#{value}")
-    end
-
-    def update!()
-      @flac.update!
-    end
-  end
-end

data/spec/flacky/tagger_spec.rb

@@ -1,67 +0,0 @@
-# -*- encoding: utf-8 -*-
-
-require 'minitest/autorun'
-require 'mocha/setup'
-require 'flacky/tagger'
-
-describe Flacky::Tagger do
-  let(:flac_file) do
-    File.join(File.dirname(__FILE__), '../fixtures/silence.flac')
-  end
-
-  let(:tagger) do
-    Flacky::Tagger.new(flac_file)
-  end
-
-  let(:flacinfo) do
-    mock = FlacInfo.new(flac_file)
-    mock.stubs(:tags).returns({ 'Title' => 'Silence' })
-    mock.stubs(:update!).returns(true)
-    mock
-  end
-
-  describe "#tag" do
-    it "adds a new comment tag if none exist" do
-      flacinfo.expects(:comment_add).with('DISCNUMBER=1').returns(true)
-      FlacInfo.stubs(:new).returns(flacinfo)
-
-      tagger.tag "DISCNUMBER", "1"
-    end
-
-    it "overwrites a comment tag if one exists" do
-      flacinfo.expects(:comment_del).with('Title').returns(true)
-      flacinfo.expects(:comment_add).with('Title=Le Silence').returns(true)
-      FlacInfo.stubs(:new).returns(flacinfo)
-
-      tagger.tag "Title", "Le Silence"
-    end
-  end
-
-  describe "#update!" do
-    it "calls update! on the FlacInfo object" do
-      flacinfo.expects(:update!).returns(true)
-      FlacInfo.stubs(:new).returns(flacinfo)
-
-      tagger.update!
-    end
-  end
-
-  describe ".update" do
-    it "adds the tag and updates" do
-      flacinfo.expects(:comment_add).with('DISCNUMBER=1').returns(true)
-      flacinfo.expects(:update!).returns(true)
-      FlacInfo.stubs(:new).returns(flacinfo)
-
-      Flacky::Tagger.update(flac_file) do
-        tag "DISCNUMBER", "1"
-      end
-    end
-  end
-
-  # it "does stuff" do
-  #   Flacky::Tagger.update('file') do
-  #     tag 'MOOD', "yep"
-  #     tag 'FILEOWNER', "fletcher"
-  #   end
-  # end
-end