flacky 0.9.0

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.rvmrc
+.rbenv-verion
+.ruby-version

data/Gemfile

@@ -0,0 +1,19 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in flacky.gemspec
+gemspec
+
+group :test do
+  gem 'rake', '~> 10.0'
+end
+
+require 'rbconfig'
+
+if RbConfig::CONFIG['target_os'] =~ /darwin/i
+  gem 'rb-fsevent', '>= 0.3.9'
+  gem 'growl',      '~> 1.0.3'
+end
+if RbConfig::CONFIG['target_os'] =~ /linux/i
+  gem 'rb-inotify', '>= 0.5.1'
+  gem 'libnotify',  '~> 0.1.3'
+end

data/Guardfile

@@ -0,0 +1,5 @@
+guard 'minitest' do
+  # with Minitest::Spec
+  watch(%r|^spec/(.*)_spec\.rb|)
+  watch(%r|^lib/(.*)([^/]+)\.rb|)     { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Fletcher Nichol
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# Flacky
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'flacky'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install flacky
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs.push 'lib'
+  t.test_files = FileList['spec/**/*_spec.rb']
+  t.verbose = true
+end
+
+task :default => 'test'

data/bin/flacky

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+# -*- encoding: utf-8 -*-
+
+# Trap interrupts to quit cleanly. See
+# https://twitter.com/mitchellh/status/283014103189053442
+Signal.trap("INT") { exit 1 }
+
+$:.unshift File.join(File.dirname(__FILE__), %w{.. lib})
+require 'rubygems'
+require 'flacky/cli'
+
+Flacky::CLI.start

data/flacky.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'flacky/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "flacky"
+  gem.version       = Flacky::VERSION
+  gem.authors       = ["Fletcher Nichol"]
+  gem.email         = ["fnichol@nichol.ca"]
+  gem.summary       = %q{Loose collection of CLI commands to sort and process Flac files}
+  gem.description   = gem.summary
+  gem.homepage      = "https://github.com/fnichol/flacky"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'thor'
+  gem.add_dependency 'nokogiri'
+  gem.add_dependency 'flacinfo-rb'
+
+  gem.add_development_dependency 'minitest'
+  gem.add_development_dependency 'vcr'
+  gem.add_development_dependency 'webmock', '~> 1.8.11'
+  gem.add_development_dependency 'mocha'
+  gem.add_development_dependency 'guard-minitest'
+end

data/lib/flacky.rb

@@ -0,0 +1,4 @@
+require "flacky/version"
+
+module Flacky
+end

data/lib/flacky/cli.rb

@@ -0,0 +1,84 @@
+# -*- encoding: utf-8 -*-
+
+require 'benchmark'
+require 'json'
+require 'thor'
+
+require 'flacky'
+require 'flacky/metadata_generator'
+require 'flacky/mp3_convertor'
+
+module Flacky
+
+  class CLI < Thor
+
+    include Thor::Actions
+
+    desc "generate <root_path>", "Generate and populate metadata as JSON"
+    def generate(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")
+        say("Processing <#{dir}>", :cyan)
+        data = Flacky::MetadataGenerator.new(mdf).combined_data
+        IO.write(mdf, JSON.pretty_generate(data))
+      end
+    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'])
+      start_dir = File.join(File.expand_path(root_dir), '**/metadata.json')
+      files = []
+
+      Dir.glob(start_dir).each do |mdf|
+        attr = JSON.parse(IO.read(mdf))["allmusic_url"]
+        files << mdf if attr.nil? || attr.empty?
+      end
+
+      if options[:print0]
+        print files.join("\x0").concat("\x0")
+      else
+        puts files.join("\n") unless files.empty?
+      end
+    end
+
+    desc "to_mp3 [file ...]|[**/*.flac ...]", "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",
+      :desc => "Set the lame encoding arguments"
+    def to_mp3(*args)
+      %w{flac metaflac lame}.each do |cmd|
+        abort "Command #{cmd} must be on your PATH" unless %x{which #{cmd}}
+      end
+
+      mp3izer = Flacky::Mp3Convertor.new(
+        :lame_opts  => options[:'lame-opts'],
+        :dest_root  => options[:destination]
+      )
+
+      args.each { |glob| convert_files(glob, mp3izer) }
+    end
+
+    private
+
+    def convert_files(glob, mp3izer)
+      Dir.glob(glob).each do |file|
+        next unless file =~ /\.flac$/
+
+        say("Processing #{file}...", :cyan)
+        response = mp3izer.convert_file!(file)
+        say("Created #{response.mp3_filename} #{duration(response.elapsed)}",
+          :yellow)
+      end
+    end
+
+    def duration(total)
+      minutes = (total / 60).to_i
+      seconds = (total - (minutes * 60))
+      "(%dm%.2fs)" % [minutes, seconds]
+    end
+  end
+end

data/lib/flacky/core_ext.rb

@@ -0,0 +1,15 @@
+# -*- encoding: UTF-8 -*-
+
+module DeepMergeHash
+
+  def deep_merge(other_hash)
+    r = {}
+    merge(other_hash) do |key, oldval, newval|
+      r[key] = oldval.class == self.class ? oldval.deep_merge(newval) : newval
+    end
+  end
+end
+
+class Hash
+  include DeepMergeHash
+end

data/lib/flacky/metadata_generator.rb

@@ -0,0 +1,61 @@
+# -*- encoding: UTF-8 -*-
+
+require 'flacinfo'
+
+require 'flacky/core_ext'
+require 'flacky/scraper'
+
+module Flacky
+  class MetadataGenerator
+    attr_reader :dir, :metadata_file, :file_metadata
+
+    def initialize(metadata_file)
+      @metadata_file = metadata_file
+      @dir = File.dirname(@metadata_file)
+      @file_metadata = load_file_metadata
+    end
+
+    def flac_metadata
+      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
+      end
+
+      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
+
+    def scraped_metadata
+      url = file_metadata["allmusic_url"]
+      return Hash.new if !url || (url && url.empty?)
+
+      scraper = Flacky::Scraper.new(url)
+      { 'STYLE' => scraper.styles.join(';'), 'MOOD' => scraper.moods.join(';') }
+    end
+
+    def combined_data
+      result = { "allmusic_url" => "" }
+      result["flac"] = (result["flac"] || Hash.new).merge(flac_metadata)
+      result = result.deep_merge(file_metadata)
+      result["flac"] = result["flac"].merge(scraped_metadata)
+      result
+    end
+
+    private
+
+    def load_file_metadata
+      File.exists?(metadata_file) ? JSON.parse(IO.read(metadata_file)) : Hash.new
+    end
+
+    def common_tags
+      %w[Artist Album Date Genre TOTALDISCS STYLE MOOD FILEOWNER].freeze
+    end
+  end
+end

data/lib/flacky/mp3_convertor.rb

@@ -0,0 +1,47 @@
+# -*- encoding: utf-8 -*-
+
+module Flacky
+
+  class Mp3Convertor
+
+    def initialize(opts = {})
+      @lame_opts = opts[:lame_opts]
+      @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
+
+      cmd = %{flac -dcs "#{file}" | lame #{lame_opts}}
+      tags.each { |lt, ft| cmd << %{ --#{lt} "#{tag(file, ft)}"} }
+      cmd << %{ - "#{dst}"}
+
+      elapsed = Benchmark.measure do ; %x{#{cmd}} ; end
+      Response.new(dst, elapsed.real)
+    end
+
+    Response = Struct.new(:mp3_filename, :elapsed)
+
+    private
+
+    attr_reader :lame_opts, :dest_root
+
+    def tags
+      { :tt => :title, :tl => :album, :ta => :artist, :tn => :tracknumber,
+        :tg => :genre, :tc => :comment, :ty => :date }.freeze
+    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
+        ""
+      end
+    end
+  end
+end

data/lib/flacky/scraper.rb

@@ -0,0 +1,39 @@
+# -*- encoding: utf-8 -*-
+
+require 'nokogiri'
+require 'open-uri'
+require 'net/http'
+
+module Flacky
+  class ScraperError < RuntimeError ; end
+
+  class Scraper
+
+    def initialize(url)
+      @url = url
+    end
+
+    def styles
+      doc.css('#sidebar .styles ul a').map { |link| link.content }.sort
+    end
+
+    def moods
+      doc.css('#sidebar .moods ul a').map { |link| link.content }.sort
+    end
+
+    private
+
+    HTTP_ERRORS = [::Timeout::Error, ::Errno::EINVAL, ::Errno::ECONNRESET,
+      ::EOFError, ::Net::HTTPBadResponse, ::Net::HTTPHeaderSyntaxError,
+      ::Net::ProtocolError, ::SocketError, ::OpenSSL::SSL::SSLError,
+      ::Errno::ECONNREFUSED]
+
+    def doc
+      @doc ||= begin
+        Nokogiri::HTML(open(@url))
+      rescue *HTTP_ERRORS => ex
+        raise Flacky::ScraperError, "#{ex.class.name}: #{ex.message}"
+      end
+    end
+  end
+end

data/lib/flacky/tagger.rb

@@ -0,0 +1,27 @@
+# -*- 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