audiothority 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4b9bc796f3af6115a58308fe0453019106973758
+  data.tar.gz: 2f131df987b5bc6f7b4fd33bea7ca7090738a760
+SHA512:
+  metadata.gz: ff4b3dc52403c8f70b29cc18f329f37573d0b02f5e346776534bcfda70adc342e2d166e21def694267f6a40944d31c8041f6825c2dbe35a324b8d7c3f291b44c
+  data.tar.gz: c9349fe6267217a5d2efa4edf713bb3a8747cdaa3b326e1fabe7ce295fc982cc40e3fbf02774cfceedebd3632cddf724af5455ab9eded8f1f7d50d682f5ae1ec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Mathias Söderberg
+
+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,30 @@
+# audiothority
+
+[![Build Status](https://travis-ci.org/mthssdrbrg/audiothority.svg?branch=master)](https://travis-ci.org/mthssdrbrg/audiothority)
+[![Coverage Status](https://img.shields.io/coveralls/mthssdrbrg/audiothority.svg)](https://coveralls.io/r/mthssdrbrg/audiothority?branch=master)
+
+Audiothority is a small command-line app for finding albums (or directories if
+you prefer) with inconsistent tags among the tracks, and either enforce some
+basic guidelines or move all inconsistent albums to a new directory.
+
+Currently the `artist`, `album`, and `year` tags are checked for uniqueness, and
+the `track` tag is checked for missing tack numbers.
+
+## Installation
+
+Audiothority depends on `taglib-ruby`, which requires `taglib`.
+See [taglib-ruby](https://github.com/robinst/taglib-ruby) for instructions on
+how to install `taglib` on a few different operating systems.
+
+```
+gem install audiothority
+```
+
+This will make the `audiothorian` command available.
+For basic usage run `audiothorian --help`, and run any of the subcommands
+without arguments to see their usage (or `audiothorian help <CMD>` if you
+prefer).
+
+## Copyright
+
+Released under the [MIT License](http://www.opensource.org/licenses/MIT) :: 2014 Mathias Söderberg.

data/bin/audiothorian

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+$: << File.expand_path('../../lib', __FILE__)
+
+require 'audiothority'
+
+
+Audiothority::Cli.start(ARGV)

data/lib/audiothority.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+
+require 'taglib'
+require 'pathname'
+
+
+require 'audiothority/change'
+require 'audiothority/cli'
+require 'audiothority/crawler'
+require 'audiothority/custodian'
+require 'audiothority/enforcer'
+require 'audiothority/extract'
+require 'audiothority/inspector'
+require 'audiothority/society'
+require 'audiothority/summary'
+require 'audiothority/tracker'
+require 'audiothority/validation'
+require 'audiothority/validators'

data/lib/audiothority/change.rb

@@ -0,0 +1,68 @@
+# encoding: utf-8
+
+module Audiothority
+  class Change
+    def initialize(field, choices, tags)
+      @field = field
+      @choices = choices
+      @tags = tags
+    end
+
+    def perform
+      if performable?
+        @tags.each do |tag|
+          tag.send(tag_setter, value)
+        end
+      end
+    end
+
+    def present(display)
+      if performable?
+        ignored = @choices.reject { |k, _| k == value }
+        ignored = ignored.map do |v, c|
+          %("#{display.set_color(v, :red)}" (#{c}))
+        end
+        chosen = %("#{display.set_color(value, :green)}" (#{@choices[value]}))
+        table = ignored.map do |i|
+          [display.set_color(@field, :yellow), i, '~>', chosen]
+        end
+        display.print_table(table, indent: 2)
+      end
+    end
+
+    private
+
+    def tag_setter
+      @tag_setter ||= (@field.to_s + '=').to_sym
+    end
+
+    def value
+      @value ||= @choices.keys.last
+    end
+
+    def performable?
+      @choices.any? && (@choices.one? || majority?)
+    end
+
+    def majority?
+      @choices.values[-2..-1].uniq.size == 2
+    end
+  end
+
+  class RewriteChange < Change
+    def initialize(field, tags)
+      @field = field
+      @tags = tags
+    end
+
+    def perform
+      @tags.each do |tag|
+        tag.send(tag_setter, tag.send(@field))
+      end
+    end
+
+    def present(display)
+      display.say(%(  #{display.set_color(@field, :yellow)} rewrite field))
+    end
+  end
+end

data/lib/audiothority/cli.rb

@@ -0,0 +1,82 @@
+# encoding: utf-8
+
+require 'thor'
+
+
+module Audiothority
+  class Cli < Thor
+    desc 'scan PATHS', 'Scan given paths for inconsistencies'
+    method_option :paths_only,
+      desc: 'only display paths for inconsistent directories',
+      type: :boolean,
+      default: false
+    method_option :custody,
+      desc: 'move inconsistent directories to a custody directory',
+      aliases: '-C',
+      type: :string
+    def scan(*paths)
+      if paths.any?
+        run_scan_for(paths)
+        display_summary
+        throw_in_custody
+      else
+        self.class.task_help(console, 'scan')
+      end
+    end
+
+    desc 'enforce PATHS', 'Enforce tagging guidelines'
+    method_option :society,
+      desc: 'move enforced directories to a `society` directory',
+      aliases: '-S',
+      type: :string
+    def enforce(*paths)
+      if paths.any?
+        run_scan_for(paths)
+        display_summary
+        if tracker.suspects.any? && should_enforce?
+          execute_enforcement
+        end
+      else
+        self.class.task_help(console, 'enforce')
+      end
+    end
+
+    private
+
+    def should_enforce?
+      console.yes?('enforce audiothority on violations?')
+    end
+
+    def console
+      @console ||= Thor::Shell::Color.new
+    end
+
+    def tracker
+      @tracker ||= Tracker.new
+    end
+
+    def run_scan_for(paths)
+      Inspector.scan(paths, tracker)
+    end
+
+    def display_summary
+      s = (options.paths_only? ? PathsOnlySummary : Summary).new(tracker.suspects)
+      s.display(console)
+    end
+
+    def throw_in_custody
+      if options.custody
+        c = Custodian.new(options.custody, tracker.suspects)
+        c.throw_in_custody
+      end
+    end
+
+    def execute_enforcement
+      Enforcer.new(tracker.suspects, console, society: society).enforce
+    end
+
+    def society
+      Society.new(options.society) if options.society
+    end
+  end
+end

data/lib/audiothority/crawler.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+
+module Audiothority
+  class Crawler
+    def initialize(dirs, blacklist=[])
+      @dirs = dirs
+      @blacklist = blacklist
+    end
+
+    def crawl
+      @dirs.each do |dir|
+        dir.each_child do |path|
+          if consider?(path)
+            yield path
+          end
+        end
+      end
+    end
+
+    private
+
+    def consider?(path)
+      path.readable? && path.directory? && path.children.any? && !blacklisted?(path)
+    end
+
+    def blacklisted?(path)
+      @blacklist.any? { |r| path.basename.to_s.match(r) }
+    end
+  end
+end

data/lib/audiothority/custodian.rb

@@ -0,0 +1,26 @@
+# encoding: utf-8
+
+require 'fileutils'
+
+
+module Audiothority
+  CustodyTorchedError = Class.new(ArgumentError)
+
+  class Custodian
+    def initialize(custody, suspects, fileutils=FileUtils)
+      @custody = Pathname.new(custody)
+      @suspects = suspects
+      @fileutils = fileutils
+    end
+
+    def throw_in_custody
+      if @custody.exist?
+        @suspects.each do |path, _|
+          @fileutils.copy_entry(path.to_s, @custody.join(path.basename).to_s, true)
+        end
+      else
+        raise CustodyTorchedError, %("#{@custody}" seems to have been torched)
+      end
+    end
+  end
+end

data/lib/audiothority/enforcer.rb

@@ -0,0 +1,60 @@
+# encoding: utf-8
+
+module Audiothority
+  class Enforcer
+    def initialize(suspects, console, options={})
+      @suspects = suspects
+      @console = console
+      @extract = options[:extract] || Extract.new
+      @society = options[:society] || EmptySociety.new
+    end
+
+    def enforce
+      @suspects.each do |path, violations|
+        violations = violations.select(&:applicable?)
+        @extract.as_tags(path.children, save: true) do |tags|
+          changes = violations.map do |violation|
+            field = violation.field
+            values = fields_from(tags, field)
+            choices = choices_from(values)
+            Change.new(field, choices, tags)
+          end
+          changes << RewriteChange.new(:track, tags)
+          changes << RewriteChange.new(:year, tags)
+          @console.say(%(changes for #{path}:))
+          changes.each do |change|
+            change.present(@console)
+          end
+          if perform_changes?
+            changes.each(&:perform)
+            @society.transfer(path)
+            @console.say
+          end
+        end
+      end
+    end
+
+    private
+
+    def perform_changes?
+      action = @console.ask(perform_question)
+      action.empty? || action.downcase == 'p'
+    end
+
+    def perform_question
+      @perform_question ||= begin
+        %([#{@console.set_color('P', :magenta)}]erform or [#{@console.set_color('S', :magenta)}kip]?)
+      end
+    end
+
+    def fields_from(tags, field)
+      tags.map { |t| t.send(field) }
+    end
+
+    def choices_from(vs)
+      f = vs.each_with_object(Hash.new(0)) { |v, s| s[v] += 1 }
+      f = Hash[f.sort_by(&:last)]
+      f
+    end
+  end
+end

data/lib/audiothority/extract.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+
+require 'taglib'
+
+
+module Audiothority
+  class Extract
+    def initialize(file_ref=TagLib::FileRef)
+      @file_ref = file_ref
+    end
+
+    def as_tags(paths, options={})
+      file_refs = paths.map { |p| @file_ref.new(p.to_s, false) }
+      null_refs = file_refs.select(&:null?)
+      if null_refs.any?
+        file_refs = file_refs - null_refs
+        null_refs.each(&:close)
+      end
+      if file_refs.empty?
+        return
+      end
+      yield file_refs.map(&:tag)
+    ensure
+      if file_refs
+        file_refs.each(&:save) if options[:save]
+        file_refs.each(&:close)
+      end
+    end
+  end
+end

data/lib/audiothority/inspector.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+
+module Audiothority
+  class Inspector
+    def self.scan(dirs, tracker, opts={})
+      paths = dirs.map { |d| Pathname.new(d) }
+      crawler = Crawler.new(paths)
+      validators = opts[:validators] || Validators.default
+      inspector = new(crawler, validators, tracker)
+      inspector.investigate
+    end
+
+    def initialize(crawler, validators, tracker, opts={})
+      @crawler = crawler
+      @validators = validators
+      @tracker = tracker
+      @extract = opts[:extract] || Extract.new
+    end
+
+    def investigate
+      @crawler.crawl do |path|
+        @extract.as_tags(path.children) do |tags|
+          violations = @validators.map { |v| v.validate(tags) }.select(&:invalid?)
+          if violations.any?
+            @tracker.mark(path, violations)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/audiothority/society.rb

@@ -0,0 +1,18 @@
+# encoding: utf-8
+
+module Audiothority
+  class EmptySociety
+    def transfer(*args) ; end
+  end
+
+  class Society
+    def initialize(location, fileutils=FileUtils)
+      @location = Pathname.new(location)
+      @fileutils = fileutils
+    end
+
+    def transfer(enforced)
+      @fileutils.move(enforced, @location)
+    end
+  end
+end