nametag 0.2.0

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown

data/README.md

@@ -0,0 +1,112 @@
+[]: {{{1
+
+    File        : README.md
+    Maintainer  : Felix C. Stegerman <flx@obfusk.net>
+    Date        : 2013-09-06
+
+    Copyright   : Copyright (C) 2013  Felix C. Stegerman
+    Version     : v0.2.0
+
+[]: }}}1
+
+[![Gem Version](https://badge.fury.io/rb/nametag.png)](http://badge.fury.io/rb/nametag)
+
+## Description
+[]: {{{1
+
+  nametag - set audio file tags based on file name
+
+  nametag uses regular expressions to parse paths of audio files and
+  then sets the file tags based on the parsed data.  This allows you
+  to keep paths and tags in sync by creating the tags from the paths.
+
+  Everything is configurable: the path regexes, the character
+  substitution, and the handling of special cases.  For example, the
+  abum `if_then_else` by The Gathering should not have its underscores
+  interpreted as spaces.
+
+[]: }}}1
+
+## Usage
+[]: {{{1
+
+    $ nametag -h
+    nametag - set audio file tags based on file name
+
+    nametag [<option(s)>]
+        -c, --config-file FILE           Configuration file
+        -v, --verbose                    Run verbosely
+        -n, --no-act                     Do not modify files
+        -h, --help                       Show this message
+            --version                    Show version
+
+    $ nametag -v ".../Between_the_Buried_and_Me/04-Colors_(2007)/05-Ants_of_the_Sky.mp3"
+    /.../Between_the_Buried_and_Me/04-Colors_(2007)/05-Ants_of_the_Sky.mp3:
+      artist="Between the Buried and Me" album="Colors" track="05" title="Ants of the Sky" ext="mp3" album_n="04" year="2007"
+
+[]: }}}1
+
+## Configuration
+[]: {{{1
+
+See `nametag.rb` for the default regex and substitution.
+
+`~/.nametagrc`:
+
+```ruby
+NameTag.configure do |c|
+  c.regexes << %r{ ... }
+  c.tr['~'] = '_'
+  c.process do |info, opts, tr|
+    if info.artist == 'The_Gathering' && info.album == 'if_then_else'
+      info.map_values { |k,v| k == :album ? v : tr[v] }
+    end
+    # when nothing is returned, the default processing will be used
+  end
+end
+```
+
+[]: }}}1
+
+## Installing
+[]: {{{1
+
+    $ sudo aptitude install libtag1-dev
+    $ gem install nametag
+
+[]: }}}1
+
+## Specs & Docs
+[]: {{{1
+
+    $ rake spec
+    $ rake docs
+
+[]: }}}1
+
+## TODO
+[]: {{{1
+
+  * test config: regexes, tr
+  * (use cucumber to) test tag writing/behaviour?
+  * more specs/docs?
+  * ...
+
+[]: }}}1
+
+## License
+[]: {{{1
+
+  GPLv2 [1].
+
+[]: }}}1
+
+## References
+[]: {{{1
+
+  [1] GNU General Public License, version 2
+  --- http://www.opensource.org/licenses/GPL-2.0
+
+[]: }}}1
+
+[]: ! ( vim: set tw=70 sw=2 sts=2 et fdm=marker : )

data/Rakefile

@@ -0,0 +1,58 @@
+desc 'Run specs'
+task :spec do
+  sh 'rspec -c'
+end
+
+desc 'Run specs verbosely'
+task 'spec:verbose' do
+  sh 'rspec -cfd'
+end
+
+desc 'Run specs verbosely, view w/ less'
+task 'spec:less' do
+  sh 'rspec -cfd --tty | less -R'
+end
+
+desc 'Check for warnings'
+task :warn do
+  sh "ruby -w -I lib -r nametag -e ''"
+end
+
+desc 'Check for warnings in specs'
+task 'warn:spec' do
+  reqs = Dir['spec/**/*.rb'].sort.map { |x| "-r ./#{x}" } * ' '
+  sh "ruby -w -I lib -r rspec #{reqs} -e ''"
+end
+
+desc 'Check for warnings in specs (but not void context)'
+task 'warn:spec:novoid' do
+  sh 'rake warn:spec 2>&1 | grep -v "void context"'
+end
+
+desc 'Generate docs'
+task :docs do
+  sh 'yardoc | cat'
+end
+
+desc 'List undocumented objects'
+task 'docs:undoc' do
+  sh 'yard stats --list-undoc'
+end
+
+desc 'Cleanup'
+task :clean do
+  sh 'rm -rf .yardoc/ doc/ *.gem'
+end
+
+desc 'Build SNAPSHOT gem'
+task :snapshot do
+  v = Time.new.strftime '%Y%m%d%H%M%S'
+  f = 'lib/nametag/version.rb'
+  sh "sed -ri~ 's!(SNAPSHOT)!\\1.#{v}!' #{f}"
+  sh 'gem build nametag.gemspec'
+end
+
+desc 'Undo SNAPSHOT gem'
+task 'snapshot:undo' do
+  sh 'git checkout -- lib/nametag/version.rb'
+end

data/bin/nametag

@@ -0,0 +1,59 @@
+#!/usr/bin/ruby -w
+
+require 'nametag'
+require 'optparse'
+
+info    = 'nametag - set audio file tags based on file name'
+usage   = 'nametag [<option(s)>]'
+rc      = "#{ Dir.home }/.nametagrc"
+options = { cfgfile: nil, verbose: 0, noact: false }
+
+op = OptionParser.new(usage) do |o|                             # {{{1
+  o.on('-c', '--config-file FILE', 'Configuration file') do |x|
+    options[:cfgfile] = x
+  end
+
+  o.on('-v', '--verbose', 'Run verbosely') do |x|
+    options[:verbose] += 1
+  end
+
+  o.on('-n', '--no-act', 'Do not modify files') do |x|
+    options[:noact] = !x
+  end
+
+  o.on_tail('-h', '--help', 'Show this message') do
+    puts info, '', o; exit
+  end
+
+  o.on_tail('--version', 'Show version') do
+    puts "nametag version #{NameTag::VERSION}"; exit
+  end
+end                                                             # }}}1
+
+begin
+  op.parse! ARGV
+rescue OptionParser::ParseError => e
+  $stderr.puts "Error: #{e}"; exit 1
+end
+
+opts  = NameTag::DEFAULTS
+v     = options[:verbose]
+cf    = options[:cfgfile] || (File.exists?(rc) ? rc : nil)
+
+load cf if cf
+
+ARGV.each do |f|                                                # {{{1
+  fn    = File.realpath f
+  info  = NameTag.parse(fn, opts) or raise "parse failed for: #{f}"
+  info_ = NameTag.process info, opts
+
+  if v > 0
+    puts "#{fn}:"
+    puts(v > 1 ? "  - #{info}\n  + #{info_}" : "  #{info_}")
+    puts
+  end
+
+  NameTag.tag fn, info_ unless options[:noact]
+end                                                             # }}}1
+
+# vim: set tw=70 sw=2 sts=2 et fdm=marker :

data/lib/nametag.rb

@@ -0,0 +1,129 @@
+# --                                                            ; {{{1
+#
+# File        : nametag.rb
+# Maintainer  : Felix C. Stegerman <flx@obfusk.net>
+# Date        : 2013-09-06
+#
+# Copyright   : Copyright (C) 2013  Felix C. Stegerman
+# Licence     : GPLv2
+#
+# --                                                            ; }}}1
+
+require 'nametag/version'
+require 'taglib'
+
+module NameTag
+
+  # default pattern; matches artist, album, track, title, ext;
+  # optionally: album_n, year; matches e.g.
+  # "Between_the_Buried_and_Me/04-Colors_(2007)/05-Ants_of_the_Sky.mp3"
+  RX =                                                          # {{{1
+    %r{ / (?<artist> [^/]* )
+        / (?: (?<album_n> [0-9]+ ) - )?
+          (?<album> [^/]*? )
+          (?: _\( (?<year> \d{4} ) \) )?
+        / (?<track> [0-9]+ ) (?: - (?<title> [^/]* ) )?
+          \. (?<ext> mp3 | ogg | flac )
+        \z }x                                                   # }}}1
+
+  # default character substitution
+  TR = { '_|' => ' /' }
+
+  # --
+
+  # substitute characters
+  TR_F = ->(o) { ->(x) {
+    x && o.tr.reduce(x) { |a,y;k,v| k, v = y; a.tr k, v }
+  } }
+
+  # tr all values
+  PROCESS = ->(i, o, f) { i.map { |k,v| [k, f[v]] } }
+
+  # --
+
+  # better struct
+  module BetterStruct                                           # {{{1
+    def initialize(h = {})
+      h.each_pair { |k,v| self[k] = v }
+    end
+    def map(&b)
+      each_pair.map(&b)
+    end
+    def map_values(&b)
+      map { |k,v| [k,b[k,v]] }
+    end
+  end                                                           # }}}1
+
+  # options
+  Options = Struct.new(:regexes, :tr, :_process) do
+    include BetterStruct
+    def process(&b)
+      _process << b
+    end
+  end
+
+  # info
+  Info = Struct.new(:artist, :album, :track, :title,            # {{{1
+                    :ext, :album_n, :year) do
+    include BetterStruct
+    def to_s
+      map { |k,v| "#{k}=#{v.inspect}" } *' '
+    end
+  end                                                           # }}}1
+
+  # default options
+  DEFAULTS = Options.new regexes: [RX], tr: TR, _process: []
+
+  # --
+
+  # configure nametag by changing DEFAULTS, which is passed to the
+  # block
+  def self.configure(c = DEFAULTS, &b)
+    b[c]; c
+  end
+
+  # --
+
+  # parse filename; tries each regex in turn
+  # @return [Info, nil]
+  def self.parse(filename, opts)
+    m = _first_map(opts.regexes) { |rx| rx.match filename }
+    m ? Info.new(Hash[m.names.map { |x| [x, m[x]] }]) : nil
+  end
+
+  # process info object; tries each processing function in turn
+  # @return [Info]
+  def self.process(info, opts)                                  # {{{1
+    ps    = opts._process + [PROCESS]; tr = TR_F[opts]
+    info_ = _first_map(ps) { |p| p[info, opts, tr] }
+    case info_
+    when Info ; info_
+    when Hash ; Info.new(info_)
+    when Array; Info.new(Hash[info_])
+    else raise 'processing function dit not return Info|Hash|Array'
+    end
+  end                                                           # }}}1
+
+  # process file: set tags from info, save file
+  def self.tag(filename, info)                                  # {{{1
+    TagLib::FileRef.open(filename) do |file|
+      tag         = file.tag
+      tag.artist  = info[:artist]
+      tag.album   = info[:album]
+      tag.track   = info[:track].to_i
+      tag.title   = info[:title] || "[track #{info[:track]}]"
+      tag.year    = info[:year].to_i
+      file.save
+    end
+  end                                                           # }}}1
+
+  # --
+
+  # lazy xs.map(&f).first
+  def self._first_map(xs, &f)
+    xs.each { |x| y = f[x]; return y if y }; nil
+  end
+
+end
+
+# vim: set tw=70 sw=2 sts=2 et fdm=marker :

data/lib/nametag/version.rb

@@ -0,0 +1,4 @@
+module NameTag
+  VERSION = '0.2.0'
+  DATE    = '2013-09-05'
+end

data/nametag.gemspec

@@ -0,0 +1,33 @@
+require File.expand_path('../lib/nametag/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name        = 'nametag'
+  s.homepage    = 'https://github.com/obfusk/nametag'
+  s.summary     = 'set audio file tags based on file name'
+
+  s.description = <<-END.gsub(/^ {4}/, '')
+    set audio file tags based on file name
+
+    ...
+  END
+
+  s.version     = NameTag::VERSION
+  s.date        = NameTag::DATE
+
+  s.authors     = [ 'Felix C. Stegerman' ]
+  s.email       = %w{ flx@obfusk.net }
+
+  s.licenses    = %w{ GPLv2 }
+
+  s.executables = %w{ nametag }
+  s.files       = %w{ .yardopts README.md Rakefile bin/nametag } \
+                + %w{ nametag.gemspec } \
+                + Dir['{lib,spec}/**/*.rb']
+
+  s.add_runtime_dependency 'taglib-ruby'
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'rspec'
+
+  s.required_ruby_version = '>= 1.9.1'
+end

data/spec/nametag_spec.rb

@@ -0,0 +1,102 @@
+# --                                                            ; {{{1
+#
+# File        : nametag_spec.rb
+# Maintainer  : Felix C. Stegerman <flx@obfusk.net>
+# Date        : 2013-09-06
+#
+# Copyright   : Copyright (C) 2013  Felix C. Stegerman
+# Licence     : GPLv2
+#
+# --                                                            ; }}}1
+
+require 'nametag'
+
+nt = NameTag
+
+describe nt do
+
+  ants = {                                                      # {{{1
+    file:   '.../Between_the_Buried_and_Me/04-Colors_(2007)/' +
+              '05-Ants_of_the_Sky.mp3',
+    info:   nt::Info.new(artist: 'Between_the_Buried_and_Me',
+              album: 'Colors', track: '05', title: 'Ants_of_the_Sky',
+              ext: 'mp3', album_n: '04', year: '2007'),
+    info_:  nt::Info.new(artist: 'Between the Buried and Me',
+              album: 'Colors', track: '05', title: 'Ants of the Sky',
+              ext: 'mp3', album_n: '04', year: '2007')
+  }                                                             # }}}1
+
+  harl = {                                                      # {{{1
+    file:   '.../Opeth/08-Ghost_Reveries_(2005)/' +
+              '05-Reverie|Harlequin_Forest.mp3',
+    info:   nt::Info.new(artist: 'Opeth',
+              album: 'Ghost_Reveries', track: '05',
+              title: 'Reverie|Harlequin_Forest',
+              ext: 'mp3', album_n: '08', year: '2005'),
+    info_:  nt::Info.new(artist: 'Opeth',
+              album: 'Ghost Reveries', track: '05',
+              title: 'Reverie/Harlequin Forest',
+              ext: 'mp3', album_n: '08', year: '2005')
+  }                                                             # }}}1
+
+  roll = {                                                      # {{{1
+    file:   '.../The_Gathering/03-if_then_else_(2000)/' +
+              '01-Rollercoaster.mp3',
+    info:   nt::Info.new(artist: 'The_Gathering',
+              album: 'if_then_else', track: '01',
+              title: 'Rollercoaster', ext: 'mp3',
+              album_n: '03', year: '2000'),
+    info_:  nt::Info.new(artist: 'The Gathering',
+              album: 'if_then_else', track: '01',
+              title: 'Rollercoaster', ext: 'mp3',
+              album_n: '03', year: '2000')
+  }                                                             # }}}1
+
+  opts = nt.configure(nt::DEFAULTS.dup) do |c|                  # {{{1
+    c.process do |info, opts, tr|
+      if  info.artist == 'The_Gathering' &&
+          info.album  == 'if_then_else'
+        info.map_values { |k,v| k == :album ? v : tr[v] }
+      end
+    end
+  end                                                           # }}}1
+
+  context 'RX' do                                               # {{{1
+    it 'matches ants' do
+      expect(nt::RX).to match ants[:file]
+    end
+    it 'matches harl' do
+      expect(nt::RX).to match harl[:file]
+    end
+    it 'matches roll' do
+      expect(nt::RX).to match roll[:file]
+    end
+  end                                                           # }}}1
+
+  context 'parse' do                                            # {{{1
+    it 'matches ants' do
+      expect(nt.parse(ants[:file], opts)).to eq ants[:info]
+    end
+    it 'matches harl' do
+      expect(nt.parse(harl[:file], opts)).to eq harl[:info]
+    end
+    it 'matches roll' do
+      expect(nt.parse(roll[:file], opts)).to eq roll[:info]
+    end
+  end                                                           # }}}1
+
+  context 'process' do                                          # {{{1
+    it 'transforms ants correctly' do
+      expect(nt.process(ants[:info], opts)).to eq ants[:info_]
+    end
+    it 'transforms harl correctly' do
+      expect(nt.process(harl[:info], opts)).to eq harl[:info_]
+    end
+    it 'transforms roll correctly' do
+      expect(nt.process(roll[:info], opts)).to eq roll[:info_]
+    end
+  end                                                           # }}}1
+
+end
+
+# vim: set tw=70 sw=2 sts=2 et fdm=marker :

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: nametag
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
+platform: ruby
+authors:
+- Felix C. Stegerman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: taglib-ruby
+  requirement: &18703080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *18703080
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &16200320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *16200320
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &16197100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *16197100
+description: ! 'set audio file tags based on file name
+
+
+  ...
+
+'
+email:
+- flx@obfusk.net
+executables:
+- nametag
+extensions: []
+extra_rdoc_files: []
+files:
+- .yardopts
+- README.md
+- Rakefile
+- bin/nametag
+- nametag.gemspec
+- lib/nametag.rb
+- lib/nametag/version.rb
+- spec/nametag_spec.rb
+homepage: https://github.com/obfusk/nametag
+licenses:
+- GPLv2
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.1
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: set audio file tags based on file name
+test_files: []
+has_rdoc: