cuesnap 1.0.0

data/.gitignore

@@ -0,0 +1,21 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+/cuesnap
+/vendor/
+.DS_Store

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/Guardfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Jeremy Mack
+
+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,72 @@
+# CueSnap
+
+Snapping MP3s with [cue sheets][1] faster than your mom pops Pringle tops.
+
+[1]: http://en.wikipedia.org/wiki/Cue_sheet_%28computing%29
+
+## Setup
+
+_Tested on Mac OS X 10.7 (Lion)._
+
+**Prerequisites**
+
+ 1. [Ruby 1.9.2 or Greater](https://rvm.io/)
+ 2. [Mac OS X](http://store.apple.com)
+
+**Okay, let's go**
+
+ 1. `brew install mp3splt` _Install the mp3 clipping lbrary, it does the heavy-lifting._
+ 1. `gem install cuesnap` _The cuesnap command will now be available._
+ 1. `cuesnap phattrack.mp3 phattrack.cue` _*snap -- zzrgt -- crack*_
+ 1. `open phattrack` _Gaze into the eyes of your slim mp3 files_
+
+## Usage
+
+**Run**
+
+`cuesnap supercool_but_so_large.mp3 supercool.cue`
+
+**and you get**
+
+```
+  supercool_but_so_large\
+    |
+    |- 01 Intro.mp3
+    |- 02 Holy Crap - So Cool.mp3
+    |- 03 Slower Crap - Pretty Coo.mp3
+    |- 04 It's On - Like Donkey Kong.mp3
+```
+
+## Command Line Options
+
+```
+  --no-numbers (-nn) -
+    Because, fuck sorting.
+      e.g. Holy Crap - So Cool.mp3
+  -q, --quiet
+    Shut the hell up cuensap. Just be quiet.
+```
+
+## Setup for Development
+
+ 1. Follow the steps in the **Setup** section.
+ 1. `git clone http://github.com/mutewinter/cuesnap` _Clone this repo, duh._
+ 1. `cd cuesnap` _Change directory into the folder._
+ 1. `bundle` _Setup those pretty Ruby gems._
+
+ That's it, now code something awesome and tell me about it.
+
+## Todo
+
+ 1. Unicode Support _Fail test is already in_.
+ 2. Error Message when mp3splt is missing.
+ 3. Lower requirements to Ruby 1.8.7 (OS X built-in Ruby).
+
+## Contributing
+
+1. [Fork it](https://github.com/mutewinter/cuesnap/fork_select).
+2. Create your feature branch (`git checkout -b my_sweet_feature`).
+3. Write some kickass code.
+3. Commit your changes (`git commit -am 'Added a sweet feature'`).
+4. Push to the branch (`git push origin my_sweet_feature`).
+5. Create new [Pull Request](https://github.com/mutewinter/cuesnap/pulls).

data/Rakefile

@@ -0,0 +1,10 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = "spec/*_spec.rb"
+end
+
+task default: ['test']

data/bin/cuesnap

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+require 'bundler/setup'
+
+begin
+  require 'cuesnap/cli'
+  CueSnap::CLI.go!
+rescue Interrupt => e
+  puts "\nQuitting..."
+  exit 1
+rescue SystemExit => e
+  exit e.status
+end

data/cuesnap.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/cuesnap/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.authors       = ['Jeremy Mack']
+  s.email         = ['jeremy@pileofturtles.com']
+  s.description   = %q{A Ruby wrapper around mp3splt that makes splitting mp3s with a cue file super simple.}
+  s.summary       = %q{A command line tool for splitting mp3s with cue files}
+  s.homepage      = "http://github.com/mutewinter/cuesnap"
+
+  s.files         = `git ls-files`.split($\)
+  s.executables   = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.name          = "cuesnap"
+  s.require_paths = ["lib"]
+  s.version       = CueSnap::VERSION
+
+  # Regular Gems
+  s.add_dependency 'rubycue', '~> 0.1.0'
+  s.add_dependency 'methadone', '~> 1.2.1'
+  s.add_dependency 'hashie', '~> 1.2.0'
+
+  # Development Gems
+  s.add_development_dependency 'minitest', '~> 3.3.0'
+  s.add_development_dependency 'guard-minitest', '~> 0.5.0'
+end

data/lib/cuesnap/base.rb

@@ -0,0 +1,3 @@
+require 'cuesnap/version'
+require 'cuesnap/cli'
+require 'cuesnap/splitter'

data/lib/cuesnap/cli.rb

@@ -0,0 +1,36 @@
+require 'cuesnap'
+require 'methadone'
+require 'pathname'
+
+module CueSnap
+  class CLI
+    include Methadone::Main
+    include Methadone::CLILogging
+
+    main do |mp3_file, cue_file|
+      # no-numbers comes in false when it's set, I know, crazy.
+      options[:no_numbers] = !options[:'no-numbers'] if options.has_key?(:'no-numbers')
+
+      file_not_found mp3_file unless File.exists? mp3_file
+
+      splitter = CueSnap::Splitter.new(mp3_file, cue_file, options)
+
+      if File.exists? splitter.cue_file
+        splitter.split!
+      else
+        file_not_found splitter.cue_file
+      end
+
+    end
+
+    on('--no-numbers')
+    on('-q', '--quiet')
+
+    arg :mp3_file
+    arg :cue_file, :optional
+
+    def self.file_not_found(file)
+      help_now! "I looked for #{file}, but didn't find it."
+    end
+  end
+end

data/lib/cuesnap/splitter.rb

@@ -0,0 +1,77 @@
+require 'hashie'
+require 'rubycue'
+
+module CueSnap
+  class Splitter
+    # Public: Loads an mp3 and a RubyCue cuesheet.
+    #
+    # mp3_file  - String file path to an mp3 file.
+    # cue_file  - The path to a cuesheet for the target cue file (default: the
+    #               name of the mp3, with .cue added).
+    # options   - Hash of options.
+    #             no_numbers - No number prefix for tracks.
+    #             output_folder - The output folder to use (default: the name
+    #               of the mp3).
+    #
+    # Returns the initalized object.
+    def initialize(mp3_file, cue_file = nil, options = {})
+      @mp3_file = mp3_file
+      if cue_file and cue_file.strip != ''
+        @cue_file = cue_file
+      else
+        @cue_file = File.expand_path("#{mp3_filename}.cue", File.dirname(@mp3_file))
+      end
+
+      @options = Hashie::Mash.new options
+      @output_folder = @options.output_folder
+      @output_folder ||= mp3_filename
+    end
+
+    # Internal: Parses the cue file using RubyCue and sets the @cuesheet
+    # variable.
+    #
+    # Returns nothing.
+    def parse_cue_file
+      file_contents = File.read @cue_file
+      file_contents.encode!('UTF-8', 'UTF-8', invalid: :replace)
+      @cuesheet = RubyCue::Cuesheet.new file_contents
+      @cuesheet.parse!
+    end
+
+    # Public: Splits the mp3 into files based on track_names and saves them to
+    # the output folder.
+    #
+    # Returns nothing.
+    def split!
+      # Wait until the last second to parse the cue file, in case the user
+      # changes it before we split.
+      parse_cue_file
+
+      format = "@p - @t"
+
+      song_count_length = (@cuesheet.songs.length + 1).to_s.length
+      number_format = "@N#{song_count_length > 1 ? song_count_length : ''}"
+      format = "#{number_format} #{format}" unless @options.no_numbers
+
+      # Got to esape the spaces for the shell
+      format.gsub!(/\s/, '\\ ')
+
+      command = ['mp3splt',
+                 "-d #{output_folder}",
+                 "-o #{format}",
+                 "-c #@cue_file"]
+      command.push '-Q' if @options.quiet
+      command.push @mp3_file
+
+      system command.join(' ')
+    end
+
+    # Public: The filename for the mp3 file with the .mp3 extension removed.
+    def mp3_filename
+      File.basename(@mp3_file, '.mp3')
+    end
+
+    attr_reader :mp3_file, :cue_file, :output_folder, :options
+
+  end
+end

data/lib/cuesnap/version.rb

@@ -0,0 +1,3 @@
+module CueSnap
+  VERSION = '1.0.0'
+end

data/lib/cuesnap.rb

@@ -0,0 +1,5 @@
+require 'cuesnap/base'
+
+module CueSnap
+  autoload :CLI, 'cuesnap/cli'
+end

data/spec/cli_spec.rb

@@ -0,0 +1,19 @@
+require File.expand_path('../spec_helper', __FILE__)
+
+describe CueSnap::CLI do
+  describe 'When running the command line' do
+    describe 'with no cue file argument' do
+      it 'should tell the user when no .cue file is found' do
+        stdin, stdout = Open3.popen3 'bin/cuesnap spec/fixtures/ten_minute.mp3'
+        stdout.read.must_match(/I looked for .*ten_minute\.cue, but didn't find it\./)
+      end
+    end
+
+    describe 'with missing .mp3 argument' do
+      it "should tell the user when the specified mp3 isn't found" do
+        stdin, stdout = Open3.popen3 'bin/cuesnap spec/fixtures/missing.mp3'
+        stdout.read.must_match(/I looked for .*missing\.mp3, but didn't find it\./)
+      end
+    end
+  end
+end

data/spec/fixtures/same_name.cue

@@ -0,0 +1,7 @@
+PERFORMER "Same Name"
+TITLE "Same Man"
+FILE "same_name.mp3" MP3
+  TRACK 01 AUDIO
+    PERFORMER "So Samy"
+    TITLE "Mr. Same"
+    INDEX 01 01:00:00

data/spec/fixtures/ten_splits.cue

@@ -0,0 +1,39 @@
+PERFORMER "Sir Splits-A-Lot"
+TITLE "Many Splits Test"
+FILE "ten_minute.mp3" MP3
+  TRACK 01 AUDIO
+    PERFORMER "I'm First"
+    TITLE "Always First"
+    INDEX 01 01:00:00
+  TRACK 02 AUDIO
+    PERFORMER "Derp Man"
+    TITLE "36 Second Track"
+    INDEX 01 02:36:71
+  TRACK 03 AUDIO
+    PERFORMER "Herp Woman"
+    TITLE "Two Minute 50 Second Track"
+    INDEX 01 03:50:42
+  TRACK 05 AUDIO
+    PERFORMER "Test Artist"
+    TITLE "Tësting Unicode"
+    INDEX 01 04:00:00
+  TRACK 06 AUDIO
+    PERFORMER "I'm First"
+    TITLE "Always First"
+    INDEX 01 05:00:00
+  TRACK 07 AUDIO
+    PERFORMER "Derp Man"
+    TITLE "36 Second Track"
+    INDEX 01 06:36:71
+  TRACK 08 AUDIO
+    PERFORMER "Herp Woman"
+    TITLE "Two Minute 50 Second Track"
+    INDEX 01 07:50:42
+  TRACK 09 AUDIO
+    PERFORMER "Test Artist"
+    TITLE "Tësting Unicode"
+    INDEX 01 08:00:00
+  TRACK 10 AUDIO
+    PERFORMER "I'm First"
+    TITLE "Always First"
+    INDEX 01 09:00:00

data/spec/fixtures/unicode.cue

@@ -0,0 +1,19 @@
+PERFORMER "T�st"
+TITLE "Small Unicode Test"
+FILE "small_unicode.mp3" MP3
+  TRACK 01 AUDIO
+    PERFORMER "I'm First"
+    TITLE "Always First"
+    INDEX 01 00:00:00
+  TRACK 02 AUDIO
+    PERFORMER "Derp Man"
+    TITLE "36 Second Track"
+    INDEX 01 00:36:71
+  TRACK 03 AUDIO
+    PERFORMER "Herp Woman"
+    TITLE "Two Minute 50 Second Track"
+    INDEX 01 02:50:42
+  TRACK 04 AUDIO
+    PERFORMER "Test Artist"
+    TITLE "T�sting Unicode"
+    INDEX 01 10:00:00

data/spec/spec_helper.rb

@@ -0,0 +1,100 @@
+require 'bundler/setup'
+
+require "minitest/autorun"
+require "minitest/pride"
+
+require 'cuesnap'
+require 'rubycue'
+
+# -------------
+# Constants
+# -------------
+
+OUTPUT_FOLDER = File.expand_path("../../tmp/spec_output", __FILE__)
+
+# -------------
+# Helpers
+# -------------
+def cuesheet_fixture(name)
+  if name && name.strip != ''
+    fixture_path "#{name}.cue"
+  else
+    name
+  end
+end
+
+def mp3_fixture(name)
+  fixture_path "#{name}.mp3"
+end
+
+def fixture_path(name)
+  File.join(File.dirname(__FILE__), "fixtures/#{name}")
+end
+
+def load_splitter(mp3_name, cuesheet_name)
+  mp3 = mp3_fixture(mp3_name)
+  cuesheet = cuesheet_fixture(cuesheet_name)
+
+  @splitter = CueSnap::Splitter.new(mp3, cuesheet, {
+    quiet: true,
+    output_folder: "#{Time.now.to_i}#{rand(1000)}"
+  })
+
+end
+
+# -------------
+# Output Folder
+# -------------
+
+def cd_to_output
+  FileUtils.mkdir_p OUTPUT_FOLDER unless File.exists? OUTPUT_FOLDER
+  Dir.chdir OUTPUT_FOLDER
+end
+
+# Public: Get all of the mp3s in the output folder for the splitter.
+def created_mp3s
+  Dir.glob("#{@splitter.output_folder}/*.mp3").map { |f| File.basename f }
+end
+
+# Public: Adds after test suite callback to ensure temporary files are deleted.
+class MyMiniTest
+  class Unit < MiniTest::Unit
+    def before_suites
+    end
+
+    def after_suites
+      remove_mp3s
+      remove_empty_directories
+    end
+
+    def remove_mp3s
+      Dir.glob("#{OUTPUT_FOLDER}/**/*.mp3").each do |f|
+        File.delete f unless File.directory? f
+      end
+    end
+
+    def remove_empty_directories
+      Dir.glob("#{OUTPUT_FOLDER}/*/").each { |d| Dir.delete d }
+    end
+
+    def _run_suites(suites, type)
+      begin
+        before_suites
+        super(suites, type)
+      ensure
+        after_suites
+      end
+    end
+
+    def _run_suite(suite, type)
+      begin
+        suite.before_suite if suite.respond_to?(:before_suite)
+        super(suite, type)
+      ensure
+        suite.after_suite if suite.respond_to?(:after_suite)
+      end
+    end
+  end
+end
+
+MiniTest::Unit.runner = MyMiniTest::Unit.new

data/spec/splitter_spec.rb

@@ -0,0 +1,64 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../spec_helper', __FILE__)
+
+describe CueSnap::Splitter do
+
+  describe 'When splitting ten_minute.mp3 and unicode.cue' do
+
+    before do
+      load_splitter 'ten_minute', 'unicode'
+      cd_to_output
+    end
+
+    it 'splitting should produce 4 mp3 files' do
+      created_mp3s.length.wont_equal 4
+      @splitter.split!
+      created_mp3s.length.must_equal 4
+    end
+
+    it 'the third track should not have a zero-padded index' do
+      # FIXME failing test
+      @splitter.split!
+      created_mp3s[2].must_match(/^3/)
+    end
+
+    it 'it should have no numbers when no_numbers is specified' do
+      @splitter.options.no_numbers = true
+      @splitter.split!
+      created_mp3s.first.must_equal 'Derp Man - 36 Second Track.mp3'
+    end
+
+    it 'the fourth track should be proper unicode' do
+      @splitter.split!
+      created_mp3s[3].must_equal "Tësting Unicode"
+    end
+
+  end
+
+  describe 'When splitting ten_minute.mp3 and ten_splits.cue' do
+
+    before do
+      load_splitter 'ten_minute', 'ten_splits'
+      cd_to_output
+    end
+
+    it 'must zero pad tracks less than 10th' do
+      @splitter.split!
+      created_mp3s.first.must_match(/^01/)
+    end
+  end
+
+  describe 'When splitting same_name.mp3 without specified cuefile' do
+
+    before do
+      load_splitter 'same_name', nil
+      cd_to_output
+    end
+
+    it 'should default to using same_name.cue' do
+      File.basename(@splitter.cue_file).must_equal 'same_name.cue'
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: cuesnap
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Jeremy Mack
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubycue
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: methadone
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.1
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.3.0
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.0
+description: A Ruby wrapper around mp3splt that makes splitting mp3s with a cue file
+  super simple.
+email:
+- jeremy@pileofturtles.com
+executables:
+- cuesnap
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/cuesnap
+- cuesnap.gemspec
+- lib/cuesnap.rb
+- lib/cuesnap/base.rb
+- lib/cuesnap/cli.rb
+- lib/cuesnap/splitter.rb
+- lib/cuesnap/version.rb
+- spec/cli_spec.rb
+- spec/fixtures/same_name.cue
+- spec/fixtures/same_name.mp3
+- spec/fixtures/ten_minute.mp3
+- spec/fixtures/ten_splits.cue
+- spec/fixtures/unicode.cue
+- spec/spec_helper.rb
+- spec/splitter_spec.rb
+homepage: http://github.com/mutewinter/cuesnap
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A command line tool for splitting mp3s with cue files
+test_files:
+- spec/cli_spec.rb
+- spec/fixtures/same_name.cue
+- spec/fixtures/same_name.mp3
+- spec/fixtures/ten_minute.mp3
+- spec/fixtures/ten_splits.cue
+- spec/fixtures/unicode.cue
+- spec/spec_helper.rb
+- spec/splitter_spec.rb