flac2mp3 0.3.1 → 0.3.2

data/History.txt

@@ -1,3 +1,10 @@
+== 0.3.2 2008-11-29
+
+* 3 enhancements:
+  * Added command-line option for only converting metadata
+  * Added new command for metadata conversion
+  * Added class method for metadata conversion
+
 == 0.3.1 2008-10-17
 
 * 1 enhancement:

data/Manifest.txt

@@ -4,6 +4,7 @@ Manifest.txt
 README.txt
 Rakefile
 bin/flac2mp3
+bin/metaflac2mp3
 config/hoe.rb
 config/requirements.rb
 lib/flac2mp3.rb
@@ -14,6 +15,7 @@ script/generate
 setup.rb
 spec/flac2mp3_command_spec.rb
 spec/flac2mp3_spec.rb
+spec/metaflac2mp3_command_spec.rb
 spec/spec.opts
 spec/spec_helper.rb
 tasks/deployment.rake

data/README.txt

@@ -1,12 +1,60 @@
-flac2mp3 is meant to, as the name implies, convert FLAC files to MP3 files.
+= flac2mp3
 
-It presently requires the `flac` and `lame` binaries to execute, as those are used for the actual conversion.
-It moves tags using the flacinfo-rb and ruby-mp3info gems.
+== DESCRIPTION:
 
-flac2mp3 operates on one file at a time. To convert more, try something like
+flac2mp3 is meant to, as the name implies, convert FLAC files to MP3 files
+
+== FEATURES/PROBLEMS:
+
+* Will convert a file from FLAC to MP3 format, natch.
+* Not *only* is the song data converted, but so is the metadata!
+* Options:
+  * silent running
+  * delete the FLAC after conversion
+  * MP3 encoding (defaults to --preset standard)
+* Reads options from YAML config file, ~/.flac2mp3
+
+Currently operates on one file at a time. To convert more, try something like
 
   for f in *.flac; do flac2mp3 "$f"; done
 
 or
 
   find . -name '*.flac' -exec flac2mp3 {} \;
+
+If neither of those commands will work for you, try using a different OS.
+
+== SYNOPSIS:
+
+  $ flac2mp3 flac_filename
+  $ flac2mp3 flac_filename --silent
+  $ flac2mp3 --meta flac_filename mp3_filename
+  (or)
+  $ metaflac2mp3 flac_filename mp3_filename
+  
+  or, if you insist
+  
+  require 'flac2mp3'
+  
+  Flac2mp3.convert(flac_filename)
+  Flac2mp3.convert(flac_filename, :silent => true)
+  Flac2mp3.convert_metadata(flac_filename, mp3_filename)
+  
+
+== REQUIREMENTS:
+
+* flac, the binary
+* lame, the binary
+* flacinfo-rb, the gem
+* ruby-mp3info, the gem
+* ruby, the interpreter
+
+== INSTALL:
+
+* gem install flac2mp3
+
+== THANKS:
+
+  * Rich Lafferty, for turning me on to the wonderful idea of keeping everything in FLAC format
+  * Apple, for having a bunch of little-i, capital-letter products that don't like FLAC format
+  * Robin Bowes, for flac2mp3.pl, which annoyed me enough to get me to write this

data/bin/flac2mp3

@@ -11,12 +11,10 @@ end
 
 require 'optparse'
 require 'flac2mp3'
-require 'flac2mp3/version'
-
-# NOTE: the option -p/--path= is given as an example, and should probably be replaced in your application.
 
 OPTIONS = {}
 MANDATORY_OPTIONS = %w[]
+meta = false
 
 parser = OptionParser.new do |opts|
   opts.banner = <<BANNER
@@ -26,13 +24,15 @@ Options are:
 BANNER
   opts.separator ''
   opts.on('-v', '--version',
-          "Show the #{File.basename($0)} version number and exit") { puts "flac2mp3 #{Flac2mp3::VERSION::STRING}"; exit }
+          "Show the #{File.basename($0)} version number and exit") { require 'flac2mp3/version'; puts "flac2mp3 #{Flac2mp3::VERSION::STRING}"; exit }
   opts.on('-d', '--[no-]delete',
           "Delete the original file after conversion") { |delete|  OPTIONS[:delete] = delete }
   opts.on('-s', '--silent',
           "Don't show progress") { |silent|  OPTIONS[:silent] = silent }
   opts.on('-e', '--encoding=ENCODING', String,
           "Set lame encoding options", "Default: #{Flac2mp3.default_encoding}") { |encoding|  OPTIONS[:encoding] = encoding }
+  opts.on('-m', '--meta',
+          'Convert metadata (requires a second filename)') { meta = true }
   opts.on('-h', '--help',
           'Show this help message.') { puts opts; exit }
   opts.parse!(ARGV)
@@ -45,9 +45,19 @@ end
 # do stuff
 filename = ARGV[0]
 
-unless filename
-  puts "Usage: #{File.basename($0)} [filename]"
-  exit
-end
+if meta
+  mp3file = ARGV[1]
+  unless filename and mp3file
+    puts "Usage: #{File.basename($0)} --meta [filename] [mp3file]"
+    exit
+  end
+  
+  Flac2mp3.convert_metadata(filename, mp3file)
+else
+  unless filename
+    puts "Usage: #{File.basename($0)} [filename]"
+    exit
+  end
 
-Flac2mp3.convert(filename, OPTIONS)
+  Flac2mp3.convert(filename, OPTIONS)
+end

data/bin/metaflac2mp3

@@ -0,0 +1,45 @@
+#!/usr/bin/env ruby
+#
+#  Created on 2008-11-29.
+#  Copyright (c) 2008. All rights reserved.
+
+begin
+  require 'rubygems'
+rescue LoadError
+  # no rubygems to load, so we fail silently
+end
+
+require 'optparse'
+require 'flac2mp3'
+
+OPTIONS = {}
+MANDATORY_OPTIONS = %w[]
+
+parser = OptionParser.new do |opts|
+  opts.banner = <<BANNER
+Usage: #{File.basename($0)} [filename] [mp3file]
+
+Options are:
+BANNER
+  opts.separator ''
+  opts.on('-v', '--version',
+          "Show the #{File.basename($0)} version number and exit") { require 'flac2mp3/version'; puts "metaflac2mp3 #{Flac2mp3::VERSION::STRING}"; exit }
+  opts.on('-h', '--help',
+          'Show this help message.') { puts opts; exit }
+  opts.parse!(ARGV)
+
+  if MANDATORY_OPTIONS && MANDATORY_OPTIONS.find { |option| OPTIONS[option.to_sym].nil? }
+    puts opts; exit
+  end
+end
+
+# do stuff
+filename = ARGV[0]
+mp3file = ARGV[1]
+
+unless filename and mp3file
+  puts "Usage: #{File.basename($0)} [filename] [mp3file]"
+  exit
+end
+  
+Flac2mp3.convert_metadata(filename, mp3file)

data/lib/flac2mp3/version.rb

@@ -2,7 +2,7 @@ class Flac2mp3 #:nodoc:
   module VERSION #:nodoc:
     MAJOR = 0
     MINOR = 3
-    TINY  = 1
+    TINY  = 2
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/lib/flac2mp3.rb

@@ -113,6 +113,10 @@ class Flac2mp3
       new(options).convert(filename)
     end
     
+    def convert_metadata(infile, outfile)
+      new.convert_metadata(infile, outfile)
+    end
+    
     def tag_mapping
       {
         :album       => :album,

data/spec/flac2mp3_command_spec.rb

@@ -10,7 +10,9 @@ describe 'flac2mp3 command' do
   end
   
   before :each do
-    Flac2mp3.stubs(:convert)
+    @convert_state = states('convert').starts_as('setup')
+    Flac2mp3.stubs(:convert).when(@convert_state.is('setup'))
+    Flac2mp3.stubs(:convert_metadata)
     
     [:ARGV, :OPTIONS, :MANDATORY_OPTIONS].each do |const|
       Object.send(:remove_const, const) if Object.const_defined?(const)
@@ -80,4 +82,36 @@ describe 'flac2mp3 command' do
     Flac2mp3.expects(:convert).with(anything, Not(has_key(:encoding)))
     run_command('blah')
   end
+  
+  it 'should take a --meta option to convert metadata' do
+    lambda { run_command('--meta', 'blah.flac', 'something.mp3') }.should_not raise_error(OptionParser::InvalidOption)
+  end
+  
+  describe 'when converting metadata' do
+    before :each do
+      @infile = 'blah.flac'
+      @outfile = 'something.mp3'
+    end
+    
+    it 'should require two filenames' do
+      self.expects(:puts) { |text|  text.match(/usage.+filename/i) }
+      run_command('--meta', @infile)
+    end
+    
+    it 'should pass the filenames to Flac2mp3 for metadata conversion' do
+      Flac2mp3.expects(:convert_metadata).with(@infile, @outfile)
+      run_command('--meta', @infile, @outfile)
+    end
+    
+    it 'should not attempt to convert any files' do
+      @convert_state.become('test')
+      Flac2mp3.expects(:convert).never.when(@convert_state.is('test'))
+      run_command('--meta', @infile, @outfile)
+    end
+    
+    it 'should accept a shorthand -m option' do
+      Flac2mp3.expects(:convert_metadata).with(@infile, @outfile)
+      run_command('-m', @infile, @outfile)
+    end
+  end
 end

data/spec/flac2mp3_spec.rb

@@ -824,6 +824,37 @@ describe Flac2mp3 do
       end
     end
     
+    it 'should convert metadata' do
+      Flac2mp3.should respond_to(:convert_metadata)
+    end
+    
+    describe 'when converting metadata' do
+      before :each do
+        @infile  = 'test.flac'
+        @outfile = 'some.mp3'
+        @flac2mp3 = stub('flac2mp3 object', :convert_metadata => nil)
+        Flac2mp3.stubs(:new).returns(@flac2mp3)
+      end
+      
+      it 'should accept two filenames' do
+        lambda { Flac2mp3.convert_metadata(@infile, @outfile) }.should_not raise_error(ArgumentError)
+      end
+      
+      it 'should require two filenames' do
+        lambda { Flac2mp3.convert_metadata(@infile) }.should raise_error(ArgumentError)
+      end
+      
+      it 'should instantiate a new Flac2mp3 object' do
+        Flac2mp3.expects(:new).returns(@flac2mp3)
+        Flac2mp3.convert_metadata(@infile, @outfile)
+      end
+      
+      it 'should use the Flac2mp3 object to convert the metadata between the given files' do
+        @flac2mp3.expects(:convert_metadata).with(@infile, @outfile)
+        Flac2mp3.convert_metadata(@infile, @outfile)
+      end
+    end
+    
     it 'should provide a tag mapping' do
       Flac2mp3.should respond_to(:tag_mapping)
     end

data/spec/metaflac2mp3_command_spec.rb

@@ -0,0 +1,41 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe 'metaflac2mp3 command' do
+  def run_command(*args)
+    Object.const_set(:ARGV, args)
+    begin
+      eval File.read(File.join(File.dirname(__FILE__), *%w[.. bin metaflac2mp3]))
+    rescue SystemExit
+    end
+  end
+  
+  before :each do
+    Flac2mp3.stubs(:convert_metadata)
+    
+    [:ARGV, :OPTIONS, :MANDATORY_OPTIONS].each do |const|
+      Object.send(:remove_const, const) if Object.const_defined?(const)
+    end
+    
+    @infile = 'blah.flac'
+    @outfile = 'something.mp3'
+  end
+  
+  it 'should exist' do
+    lambda { run_command(@infile, @outfile) }.should_not raise_error(Errno::ENOENT)
+  end
+  
+  it 'should require two filenames' do
+    self.expects(:puts) { |text|  text.match(/usage.+filename/i) }
+    run_command(@infile)
+  end
+  
+  it 'should pass the filenames to Flac2mp3 for metadata conversion' do
+    Flac2mp3.expects(:convert_metadata).with(@infile, @outfile)
+    run_command(@infile, @outfile)
+  end
+  
+  it 'should not attempt to convert any files' do
+    Flac2mp3.expects(:convert).never
+    run_command(@infile, @outfile)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: flac2mp3
 version: !ruby/object:Gem::Version 
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors: 
 - Yossef Mendelssohn
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-10-17 00:00:00 -05:00
+date: 2008-11-29 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -66,6 +66,7 @@ description: converter for FLAC to MP3
 email: ymendel@pobox.com
 executables: 
 - flac2mp3
+- metaflac2mp3
 extensions: []
 
 extra_rdoc_files: 
@@ -80,6 +81,7 @@ files:
 - README.txt
 - Rakefile
 - bin/flac2mp3
+- bin/metaflac2mp3
 - config/hoe.rb
 - config/requirements.rb
 - lib/flac2mp3.rb
@@ -90,6 +92,7 @@ files:
 - setup.rb
 - spec/flac2mp3_command_spec.rb
 - spec/flac2mp3_spec.rb
+- spec/metaflac2mp3_command_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
 - tasks/deployment.rake
@@ -119,7 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: yomendel
-rubygems_version: 1.3.0
+rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2
 summary: converter for FLAC to MP3