musk 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: de4f097d74a73c706373689095573eede025a309
-  data.tar.gz: 3dfe5fff8e66130a94c826d582456159e75ee8ce
+  metadata.gz: c48bd0abea6550bac7abce80fefe2fc03352273d
+  data.tar.gz: 1cf2a874737ff755d2e6763f5397fd64152ce2cc
 SHA512:
-  metadata.gz: 8fbef5b662def26e868f5b81032e90606f3b014a2dcc448b5086f46c014b83b94151b0d8e6da214c04a2348d3a5a4a4016b922f994fb5848eb595e2c4d52d340
-  data.tar.gz: 034fb77607002b90a4c8bf10c36a704e0a7bf85762ef37c5019ad2bc077d552b53e50ab337b3a86c95c4ee39e8405839909347c96189271056bc7f70031d7de9
+  metadata.gz: 9a48cca700249f4f7ff71394942abefed2b3e5dbce2f45f1da6812ace1f0eb14b8c53e51b901a00adbe4eb8d1505d46121901a82d7f4beb02b46e8612a787665
+  data.tar.gz: 9aa0bf6b59e6f9a39ea0f41f68bf7be53209dff9a61c72600d823418e49d6fe33908a67e656002af6070205ebd9ab772023b5ca9e9a4ed130714031b44676cdb

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    musk (0.0.4)
+    musk (0.0.5)
       gli (~> 2.9)
       taglib-ruby (~> 0.6)
 

data/LICENSE

@@ -1,6 +1,4 @@
-The MIT License (MIT)
-
-Copyright (c) 2014 
+Copyright (c) 2014 Eugene Pempel
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -18,4 +16,4 @@ 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.
+SOFTWARE.

data/README.md

@@ -1,2 +1,98 @@
-musk
-====
+## Musk
+
+Use musk to impart the demonic scent of musk to your music.
+Musk allows you to extract tags from MP3 files and perfume MP3 files
+with fragrant tags.
+
+## Installation
+
+Manually from RubyGems.org:
+
+    gem install musk
+
+## Command Reference
+
+Like `git`, the `musk` command delegates to subcommands based on its
+first argument. The most common subcommands are:
+
+### musk extract
+
+To extract tags from an MP3 file, run `musk extract` with the path to
+the MP3 file. For example,
+
+    musk extract ~/tracks/bonobo/jets.mp3
+
+    Path:     jets.mp3
+    Title:    Jets
+    Position: 6/13
+    Artist:   Bonobo
+    Release:  The North Borders
+    Genre:    Electronic
+    Year:     2013
+    Comment:  -
+
+To extract tags from MP3 files in a directory and its subdirectories,
+run `musk extract` with the path to the directory. For example,
+
+    musk extract ~/tracks
+
+    Path:     bonobo/jets.mp3
+    Title:    Jets
+    Position: 6/13
+    Artist:   Bonobo
+    Release:  The North Borders
+    Genre:    Electronic
+    Year:     2013
+    Comment:  -
+
+    Path:     emancipator/kamakura.mp3
+    Title:    Kamakura
+    Position: 4/14
+    Artist:   Emancipator
+    Release:  Safe In The Steep Cliffs
+    Genre:    Electronic
+    Year:     2010
+    Comment:  -
+
+To see the output in the csv format, run `musk extract --format csv`.
+For example,
+
+    musk extract --format csv ~/tracks
+
+    bonobo/jets.mp3,Jets,6/13,Bonobo,The North Borders,Electronic,2013,-
+    emancipator/kamakura.mp3,Kamakura,4/14,Emancipator,Safe In The Steep Cliffs,Electronic,2010,-
+
+The `--format csv` option prints MP3 tags in the following order:
+path, title, position, artist, release, genre, year, comment.
+
+The `--format csv` option allows you to effectively combine
+several commands together. For example,
+
+    musk extract --format csv ~/tracks | cut -d',' -f2
+
+    Jets
+    Kamakura
+
+## License
+
+(The MIT license)
+
+Copyright (c) 2014 Eugene Pempel
+
+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/bin/musk

@@ -5,7 +5,9 @@ require "musk"
 
 extend GLI::App
 
-desc "Extract meta-data (tags) from MP3 files"
+program_desc "Extract tags from MP3 files and perfume MP3 files with fragrant tags."
+
+desc "Extract tags from MP3 files"
 arg_name "path_to_files"
 command :extract do |command|
   command.arg_name "csv|pretty"

data/lib/musk/decorator/printable_track.rb

@@ -19,7 +19,7 @@ module Musk
         end
       end
 
-      [:title, :artist, :album, :genre].each do |method|
+      [:title, :artist, :release, :genre].each do |method|
         define_method(method) do
           @track.send(method) or "-"
         end

data/lib/musk/formatter/csv.rb

@@ -6,7 +6,7 @@ module Musk
         :title,
         :position,
         :artist,
-        :album,
+        :release,
         :genre,
         :year,
         :comment,

data/lib/musk/formatter/pretty.rb

@@ -6,7 +6,7 @@ module Musk
         :title,
         :position,
         :artist,
-        :album,
+        :release,
         :genre,
         :year,
         :comment,
@@ -14,9 +14,9 @@ module Musk
 
       def self.print(tracks)
         tracks.each_with_index do |track, index|
+          track = Musk::Decorator::PrintableTrack.new(track)
           puts if index > 0
           ATTRIBUTES.map do |attribute|
-            track = Musk::Decorator::PrintableTrack.new(track)
             printf("%-10s%s\n", "#{attribute.capitalize}:", track.send(attribute))
           end
         end

data/lib/musk/track.rb

@@ -7,7 +7,7 @@ module Musk
       :position_number,
       :positions_count,
       :artist,
-      :album,
+      :release,
       :genre,
       :year,
       :comment,

data/lib/musk/track_loader.rb

@@ -15,7 +15,7 @@ module Musk
         end
       end
       path = File.expand_path(path)
-      loadpath = File.file?(path) ? File.dirname(path) : path
+      loadpath = "#{File.file?(path) ? File.dirname(path) : path}#{File::SEPARATOR}"
       deeppath = File.file?(path) ? path : File.join(path, "**", "*.mp3")
       Dir[deeppath].map do |fullpath|
         track = Musk::Track.new
@@ -30,7 +30,7 @@ module Musk
           end
           track.title   = tag.title
           track.artist  = tag.artist
-          track.album   = tag.album
+          track.release = tag.album
           track.genre   = tag.genre
           track.year    = tag.year
           track.comment = tag.comment

data/lib/musk/version.rb

@@ -1,3 +1,3 @@
 module Musk
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/musk.gemspec

@@ -6,8 +6,8 @@ Gem::Specification.new do |s|
   s.name          = "musk"
   s.author        = "Eugene Pempel"
   s.email         = "eugene.pempel@gmail.com"
-  s.summary       = "Your music with the demonic scent of musk"
-  s.description   = "Your music with the demonic scent of musk."
+  s.summary       = "Yet another MP3 tagging tool."
+  s.description   = "Extract tags from MP3 files and perfume MP3 files with fragrant tags."
   s.homepage      = "https://github.com/pempel/musk"
   s.license       = "MIT"
   s.version       = Musk::VERSION

data/spec/lib/musk/decorator/printable_track_spec.rb

@@ -35,7 +35,7 @@ describe Musk::Decorator::PrintableTrack do
   it_should_behave_like "the track decorator with nullable attributes", [
     :title,
     :artist,
-    :album,
+    :release,
     :genre,
   ]
 end

data/spec/lib/musk/formatter/csv_spec.rb

@@ -2,26 +2,23 @@ require "spec_helper"
 
 describe Musk::Formatter::CSV do
   describe ".print(tracks)" do
-    let(:tracks) do
-      [build(:jets_track), build(:kamakura_track)]
-    end
-
-    let(:printable_tracks) do
-      tracks.map {|t| Musk::Decorator::PrintableTrack.new(t)}
-    end
-
-    let(:attributes) do
-      [:path, :title, :position, :artist, :album, :genre, :year, :comment]
-    end
-
+    let(:tracks) {[build(:jets_track), build(:kamakura_track)]}
     let(:stdout) do
+      printable_tracks = tracks.map {|t| Musk::Decorator::PrintableTrack.new(t)}
       printable_tracks.map do |track|
-        attributes.map {|a| track.send(a)}.join(",").concat("\n")
+        "#{track.path},"\
+        "#{track.title},"\
+        "#{track.position},"\
+        "#{track.artist},"\
+        "#{track.release},"\
+        "#{track.genre},"\
+        "#{track.year},"\
+        "#{track.comment}\n"
       end.join
     end
 
     it "should print tracks to STDOUT in the csv format" do
-      capture_stdout { described_class.print(tracks) }.should eq(stdout)
+      capture_stdout {described_class.print(tracks)}.should eq(stdout)
     end
   end
 end

data/spec/lib/musk/formatter/pretty_spec.rb

@@ -2,29 +2,23 @@ require "spec_helper"
 
 describe Musk::Formatter::Pretty do
   describe ".print(tracks)" do
-    let(:tracks) do
-      [build(:jets_track), build(:kamakura_track)]
-    end
-
-    let(:printable_tracks) do
-      tracks.map {|t| Musk::Decorator::PrintableTrack.new(t)}
-    end
-
+    let(:tracks) {[build(:jets_track), build(:kamakura_track)]}
     let(:stdout) do
+      printable_tracks = tracks.map {|t| Musk::Decorator::PrintableTrack.new(t)}
       printable_tracks.map do |track|
         "Path:     #{track.path}\n"\
         "Title:    #{track.title}\n"\
         "Position: #{track.position}\n"\
         "Artist:   #{track.artist}\n"\
-        "Album:    #{track.album}\n"\
+        "Release:  #{track.release}\n"\
         "Genre:    #{track.genre}\n"\
         "Year:     #{track.year}\n"\
-        "Comment:  -\n"
+        "Comment:  #{track.comment}\n"
       end.join("\n")
     end
 
     it "should print tracks to STDOUT in the pretty format" do
-      capture_stdout { described_class.print(tracks) }.should eq(stdout)
+      capture_stdout {described_class.print(tracks)}.should eq(stdout)
     end
   end
 end

data/spec/lib/musk/track_loader_spec.rb

@@ -18,7 +18,7 @@ describe Musk::TrackLoader do
 
     context "when path is a nonexistent directory" do
       it "should raise \"Unknown path '{path}' to a file or files\"" do
-        path = File.join(ENV["MUSK_TRACKS_PATH"], "/nonexistent")
+        path = File.join(ENV["MUSK_TRACKS_PATH"], "nonexistent")
         error = "Unknown path '#{path}' to a file or files"
         expect { described_class.load!(path) }.to raise_error(error)
       end
@@ -26,8 +26,9 @@ describe Musk::TrackLoader do
 
     context "when path is an exisiting directory" do
       it "should create tracks from files in the directory and its subdirectories" do
-        loadpath = ENV["MUSK_TRACKS_PATH"]
-        described_class.load!(loadpath).should be_tracks([
+        path = ENV["MUSK_TRACKS_PATH"]
+        loadpath = "#{path}#{File::SEPARATOR}"
+        described_class.load!(path).should be_tracks([
           build(:jets_track, :loaded, loadpath: loadpath),
           build(:kamakura_track, :loaded, loadpath: loadpath),
         ])
@@ -36,7 +37,7 @@ describe Musk::TrackLoader do
 
     context "when path is a nonexistent file" do
       it "should raise \"Unknown path '{path}' to a file or files\"" do
-        path = File.join(ENV["MUSK_TRACKS_PATH"], "/nonexistent.mp3")
+        path = File.join(ENV["MUSK_TRACKS_PATH"], "nonexistent.mp3")
         error = "Unknown path '#{path}' to a file or files"
         expect { described_class.load!(path) }.to raise_error(error)
       end
@@ -44,7 +45,7 @@ describe Musk::TrackLoader do
 
     context "when path is an existing file that is unsupported" do
       it "should raise \"Unknown extension '{extension}'\"" do
-        path = File.join(ENV["MUSK_TRACKS_PATH"], "/track.bad")
+        path = File.join(ENV["MUSK_TRACKS_PATH"], "track.bad")
         error = "Unknown extension '.bad'"
         allow(File).to receive(:file?).with(path).and_return(true)
         expect { described_class.load!(path) }.to raise_error(error)
@@ -53,9 +54,10 @@ describe Musk::TrackLoader do
 
     context "when path is an existing file that is supported" do
       it "should create a track from the file" do
-        loadpath = File.join(ENV["MUSK_TRACKS_PATH"], "/bonobo")
+        path = File.join(ENV["MUSK_TRACKS_PATH"], "bonobo", "jets.mp3")
+        loadpath = "#{File.dirname(path)}#{File::SEPARATOR}"
         track = build(:jets_track, :loaded, loadpath: loadpath)
-        described_class.load!(loadpath).should be_tracks([track])
+        described_class.load!(path).should be_tracks([track])
       end
     end
   end

data/spec/lib/musk/track_spec.rb

@@ -13,8 +13,8 @@ describe Musk::Track do
   it { should respond_to(:positions_count=) }
   it { should respond_to(:artist) }
   it { should respond_to(:artist=) }
-  it { should respond_to(:album) }
-  it { should respond_to(:album=) }
+  it { should respond_to(:release) }
+  it { should respond_to(:release=) }
   it { should respond_to(:genre) }
   it { should respond_to(:genre=) }
   it { should respond_to(:year) }

data/spec/support/factories/tracks.rb

@@ -9,7 +9,7 @@ FactoryGirl.define do
     position_number 6
     positions_count 13
     artist "Bonobo"
-    album "The North Borders"
+    release "The North Borders"
     genre "Electronic"
     year 2013
 
@@ -25,7 +25,7 @@ FactoryGirl.define do
     position_number 4
     positions_count 14
     artist "Emancipator"
-    album "Safe In The Steep Cliffs"
+    release "Safe In The Steep Cliffs"
     genre "Electronic"
     year 2010
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: musk
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Eugene Pempel
@@ -122,7 +122,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
-description: Your music with the demonic scent of musk.
+description: Extract tags from MP3 files and perfume MP3 files with fragrant tags.
 email: eugene.pempel@gmail.com
 executables:
 - musk
@@ -185,7 +185,7 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Your music with the demonic scent of musk
+summary: Yet another MP3 tagging tool.
 test_files:
 - spec/bin/musk_spec.rb
 - spec/lib/musk/decorator/printable_track_spec.rb