ogg_album_tagger 0.1.0 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cbafc73bba9ee1dd7d8b8e5ee7c041258f8a9461
-  data.tar.gz: b44bd48acb92454f074fdb2c61c912d81a29e3ea
+  metadata.gz: 983a9f7496ee72da685f94ffa21ae742faf8a0f6
+  data.tar.gz: 5936938764084915a9d788c0515d7245291e999e
 SHA512:
-  metadata.gz: eafe6bc6b531c0c6d66b83ac632d837ef7ce7b2834ed678e9537f6ab7d3cce977c044413906b6e0b70882b1f60a88b5ff2bbf95f44349f724dcfde7a36000e89
-  data.tar.gz: 59dbd75622405bff1ebfc78eeb5163608f9bb8824c8778a304f261b5b03ec589e300c264d70af08409415bf01f29139cc0ddf616be298a2e7b7ef1cf1f99ee53
+  metadata.gz: b5f6d82ef7288f08eee1643d468ab672187718bb5e3337a0c6985736dd02ceab905a99f4f3e6a6c7db45a73001499b497d61c395adce07d5107756f0f144de0e
+  data.tar.gz: '092765d7af62d73484ea9867a173757322424d5a6855c3a89cb6928ecae24fc36b75e7197ae452ae80dba061042c37c87d5c428c10f60eb679d303baa602297a'

data/bin/ogg-album-tagger

@@ -4,264 +4,100 @@ require 'rubygems'
 
 require 'ogg_album_tagger/version'
 require 'ogg_album_tagger/library'
-require 'ogg_album_tagger/picture'
-require 'ogg_album_tagger/tag_container'
-require 'ogg_album_tagger/exceptions'
+require 'ogg_album_tagger/ogg_file'
+require 'ogg_album_tagger/cli'
 
 require 'readline'
 require 'optparse'
-require 'shellwords'
+require 'pathname'
 
-def autocomplete(input)
-	context = Readline.line_buffer.slice(0, Readline.point - input.length)
-	begin
-		args = Shellwords.shellwords(context)
-
-		# If there is no space after a quoted string, no autocompletion,
-		# or we may end up with things like "something"somethingelse
-		return [] if context.size > 0 and Readline.completer_quote_characters.include?(context[-1])
-	rescue ArgumentError => ex
-		# We are autocompleting a quoted string
-		# The quote will be the last item in the context, so we dump it
-		context.slice!(-1) if context.size > 0 and Readline.completer_quote_characters.include?(context[-1])
-		begin
-			args = Shellwords.shellwords(context)
-		rescue ArgumentError => ex
-			return []
-		end
-	end
-
-	props = []
-
-	if args.empty? then props = %w{ls select show set add rm auto check write help exit quit}
-	elsif %w{ls select check help exit quit}.include?(args[0]) then props = []
-	elsif args[0] == 'show'
-		if args.size == 1
-			props = %w{tag}
-		elsif args[1] == 'tag' and args.size == 2
-			props = $library.tags_used
-		end
-	elsif %w{add set}.include? args[0]
-		if args.size == 1
-			props = $library.tags_used
-		elsif %w{METADATA_BLOCK_PICTURE PICTURE}.include? args[1].upcase
-			if args.size == 2
-				props = Readline::FILENAME_COMPLETION_PROC.call(input)
-			end
-		end
-	elsif args[0] == 'rm'
-		if args.size == 1
-			props = $library.tags_used
-		else
-			tag = args[1].upcase
-			if tag == 'METADATA_BLOCK_PICTURE'
-				$stderr.puts
-				$stderr.puts "Autocompletion is not supported for pictures"
-				Readline.refresh_line
-			else props = $library.tag_summary(tag).values.flatten.uniq
-			end
-		end
-	elsif args[0] == 'auto'
-		if args.length == 1
-			props = %w{tracknumber rename}
-		end
-	end
-
-	(props || []).grep(/^#{Regexp.escape(input)}/i).map do |v|
-		v.include?(' ') ? "\"#{v}\"" : v
-	end
-end
-
-def print_album_summary(summary)
-	OggAlbumTagger::TagContainer.sorted_tags(summary.keys) do |tag|
-		puts tag
-
-		if (summary[tag].size == $library.selected_files.size) && (summary[tag].values.uniq.length == 1)
-			# If all tracks have only one common value
-			puts "\t" + OggAlbumTagger::TagContainer::pp_tag(summary[tag].first[1])
-		else
-			summary[tag].keys.sort.each do |i|
-				values = summary[tag][i]
-				puts sprintf("\t%4d: %s", i+1, OggAlbumTagger::TagContainer::pp_tag(values))
-			end
-		end
-	end
-end
-
-def show_command(command)
-	case command.length
-	when 0
-		print_album_summary($library.summary)
-	else
-		case command[0]
-		when 'tag'
-			if command.size == 1 then puts 'You need to specify a tag name'
-			else print_album_summary $library.summary(command[1].upcase)
-			end
-		else
-			puts "Unknown command 'show #{command[0]}'"
-		end
-	end
-end
-
-def ls_command
-	$library.ls().each do |f|
-		puts sprintf("%s %4d: %s", (f[:selected] ? '*' : ' '), f[:position], f[:file])
-	end
-end
-
-def handle_picture_args args
-	if %w{METADATA_BLOCK_PICTURE PICTURE}.include? args[0].upcase
-		file = args[1]
-		desc = args.length == 2 ? args[1] : ''
-		args.clear
-		args << 'METADATA_BLOCK_PICTURE'
-		args << OggAlbumTagger::Picture::generate_metadata_block_picture(file, desc)
-	end
-end
-
-def execute_command(command_line)
-	begin
-		command, *args = Shellwords.shellwords(command_line)
-	rescue ::StandardError => ex
-		puts 'Invalid command.'
-		return
-	end
-
-	begin
-		case command
-		when 'ls' then ls_command()
-		when 'select'
-			if args.length < 1
-				puts 'You need to specify the files you want to select. Either enter "all", a single number or a range (ex. "3-5").', 'Number and range based selections can be made cumulative by adding a plus or minus sign in front of the selector (ex. "-1-3").'
-			else
-				$library.select(args)
-				ls_command()
-			end
-		when 'show' then show_command(args)
-		when 'set'
-			if args.length < 2
-				puts 'You need to specify the tag to edit and at least one value.'
-			else
-				handle_picture_args(args)
-				$library.set_tag(*args)
-				show_command(['tag', args[0]])
-			end
-		when 'add'
-			if args.length < 2
-				puts 'You need to specify the tag to edit and at least one value.'
-			else
-				handle_picture_args(args)
-				$library.add_tag(*args)
-				show_command(['tag', args[0]])
-			end
-		when 'rm'
-			if args.length < 1
-				puts 'You need to specify the tag to edit and eventually one or several values.'
-			else
-				$library.rm_tag(*args)
-				show_command(['tag', args[0]])
-			end
-		when 'auto'
-			if args.length < 1
-				puts 'You need to specify the auto command you want to execute.'
-			else
-				case args[0]
-				when 'tracknumber' then $library.auto_tracknumber()
-				when 'rename'
-					$library.auto_rename
-					ls_command()
-				end
-			end
-		when 'check'
-			$library.check
-			puts "OK"
-		when 'write'
-			$library.write
-		when 'help'
-			# TODO
-		else
-			puts "Unknown command \"#{command}\""
-		end
-	rescue OggAlbumTagger::Error => err
-		puts err
-	end
-end
-
-def list_ogg_files dir, with_dir = false
-	Dir.chdir(dir) do
-		Dir.glob("**/*.ogg").map { |f| with_dir ? Pathname.new(dir).join(f) : Pathname.new(f) }
-	end
+def list_ogg_files dir
+    Dir.chdir(dir) do
+        return Dir.glob("**/*.ogg").sort.map { |f| Pathname.new(dir).join(f) }
+    end
 end
 
 options = {album: false}
 option_parser = OptionParser.new do |opts|
-	executable_name = File.basename($PROGRAM_NAME)
-	opts.banner = "Interactive edition of ogg tags with album/compilation support.\n" +
-	              "Usage: #{executable_name} [options] files|directories"
+    executable_name = File.basename($PROGRAM_NAME)
+    opts.banner = "Interactive edition of ogg tags with album/compilation support.\n" +
+                  "Usage: #{executable_name} [options] files|directories"
 
-	opts.separator "Options:"
+    opts.separator "Options:"
 
-	opts.on("-a", "--album", "Album mode: treat a single directory as an album.") do
-		options[:album] = true
-	end
+    opts.on("-a", "--album", "Album mode: treat a single directory as an album.") do
+        options[:album] = true
+    end
 
-	opts.on("-v", "--version", "Display version information and exit.") do
-		puts "OggAlbumTagger #{OggAlbumTagger::VERSION}"
-		exit
-	end
+    opts.on("-v", "--version", "Display version information and exit.") do
+        puts "OggAlbumTagger #{OggAlbumTagger::VERSION}"
+        exit
+    end
 
-	opts.on("-h", "--help", "Print this help and exit.") do
-		puts opts
-		exit
-	end
+    opts.on("-h", "--help", "Print this help and exit.") do
+        puts opts
+        exit
+    end
 
-	opts.separator ""
-	opts.separator "OggAlbumTagger is released under the terms of the MIT License."
-	opts.separator "For more informations, updates and bug reports, see https://github.com/Sigill/OggAlbumTagger."
-end.parse!
+    opts.separator ""
+    opts.separator "OggAlbumTagger is released under the terms of the MIT License."
+    opts.separator "For more informations, updates and bug reports, see https://github.com/Sigill/OggAlbumTagger."
+end
+
+option_parser.parse!
 
 if ARGV.size == 0
-	puts options_parser
-	exit
+    puts option_parser
+    exit
 else
-	if options[:album]
-		unless ARGV.size == 1 and File.directory?(ARGV[0])
-			abort "Error: in album mode, you have to provide a single directory as argument."
-		end
-	end
-
-	files = []
-	ARGV.each do |arg|
-		begin
-			if File.directory?(arg)
-				files.concat list_ogg_files(arg, !options[:album])
-			elsif File.file?(arg)
-				files << Pathname.new(arg)
-			else
-				raise Errno::ENOENT
-			end
-		rescue Errno::ENOENT
-			abort "#{arg} does not exists."
-		end
-	end
-
-	begin
-		$library = OggAlbumTagger::Library.new(files, options[:album] ? Pathname.new(ARGV[0]) : nil)
-	rescue OggAlbumTagger::Error => ex
-		abort ex.message
-	end
+    if options[:album]
+        unless ARGV.size == 1 and File.directory?(ARGV[0])
+            abort "Error: in album mode, you have to provide a single directory as argument."
+        end
+    end
+
+    files = []
+    ARGV.each do |arg|
+        begin
+            if File.directory?(arg)
+                files.concat list_ogg_files(arg)
+            elsif File.file?(arg)
+                files << Pathname.new(arg)
+            else
+                raise Errno::ENOENT
+            end
+        rescue Errno::ENOENT
+            abort "#{arg} does not exists."
+        end
+    end
+
+    begin
+        containers = files.map { |f| OggAlbumTagger::OggFile.new(f) }
+        $library = OggAlbumTagger::Library.new(options[:album] ? Pathname.new(ARGV[0]) : nil, containers)
+        $interpreter = OggAlbumTagger::CLI.new($library)
+    rescue OggAlbumTagger::Error => ex
+        abort ex.message
+    end
 end
 
-Readline.completion_append_character = " "
-Readline.completer_quote_characters = "\"'"
+$interpreter.configure_readline
 Readline.completion_proc = ->(input) {
-	autocomplete(input)
+    begin
+        $interpreter.autocomplete(Readline.line_buffer, Readline.point, input)
+    rescue OggAlbumTagger::Error => ex
+        # Warn the user of autocompletion issue
+        puts "", ex
+        Readline.refresh_line
+    end
 }
 
 loop do
-	command = Readline.readline("> ", true)
-	break if command.nil? or command.eql?('exit') or command.eql?('quit')
-
-	execute_command(command.strip)
+    command = Readline.readline("> ", true)
+    break if command.nil? or command.eql?('exit') or command.eql?('quit')
+
+    begin
+        $interpreter.execute_command(command.strip)
+    rescue OggAlbumTagger::Error => ex
+        puts ex
+    end
 end

data/lib/ogg_album_tagger/cli.rb

@@ -0,0 +1,278 @@
+require 'readline'
+require 'shellwords'
+
+require 'ogg_album_tagger/exceptions'
+require 'ogg_album_tagger/picture'
+
+module OggAlbumTagger
+
+
+class CLI
+    QUOTE_CHARACTERS = "\"'"
+
+    def initialize(library)
+        @library = library
+    end
+
+    def configure_readline
+        Readline.completer_quote_characters = QUOTE_CHARACTERS
+        Readline.completion_append_character = " "
+    end
+
+    SIMPLE_SELECTOR = /^[+-]?[1-9]\d*$/
+    RANGE_SELECTOR = /^[+-]?[1-9]\d*-[1-9]\d*$/
+
+    def selector?(arg)
+        return arg == 'all' || arg.match(SIMPLE_SELECTOR) || arg.match(RANGE_SELECTOR)
+    end
+
+    def autocomplete(buffer, point, input)
+        # Extract the context: everything before the word being completed.
+        context = buffer.slice(0, point - input.length)
+
+        begin
+            # Let's try to split the context into its various arguments.
+            context_args = Shellwords.shellwords(context)
+
+            # If the last argument is quoted and the quote is the last character of the context,
+            # no autocompletion, or we may end up with things like "something"somethingelse.
+            return [] if context.size > 0 and QUOTE_CHARACTERS.include?(context[-1])
+        rescue ::ArgumentError => ex
+            # The context couldn't be parsed because it ends with an opening quote.
+            # Let's remove it to allow the context to be parsed.
+            context.slice!(-1) if context.size > 0 and QUOTE_CHARACTERS.include?(context[-1])
+            begin
+                context_args = Shellwords.shellwords(context)
+            rescue ::ArgumentError => ex
+                return []
+            end
+        end
+
+        # Remove leading selectors
+        first_not_selector = context_args.find_index { |e| !selector?(e) }
+        context_args.slice!(0, first_not_selector) unless first_not_selector.nil? || first_not_selector == 0
+
+        # Keep only suggestions starting with the input.
+        sugg = suggestions(context_args, input).grep(/^#{Regexp.escape(input)}/i).map { |v|
+            # Quote them if they contain spaces, otherwise a multiple word value
+            # will appear unquoted on the command line.
+            v.include?(' ') ? "\"#{v}\"" : v
+        }
+        sugg
+    end
+
+    def suggestions(context, input)
+        if context.empty?
+            # No args, suggest the supported commands.
+            return %w{ls select move show set add rm auto check write help exit quit}
+        elsif %w{ls select move check help exit quit}.include?(context[0])
+            # These commands don't take any argument or don't need autocomplete.
+        elsif context[0] == 'show'
+            # The "show" command can be followed by a tag
+            return @library.tags_used if context.size == 1
+        elsif %w{add set}.include?(context[0])
+            case context.size
+            when 1
+                # The "add" and "set" commands must be followed by a tag.
+                # TODO Suggest usual ogg tags.
+                return @library.tags_used
+            when 2
+                if %w{METADATA_BLOCK_PICTURE PICTURE}.include? context[1].upcase
+                    # When a picture tag is edited, the tag must be followed by the path of a file.
+                    return Readline::FILENAME_COMPLETION_PROC.call(input) || []
+                else
+                    # Otherwise, propose values already used by the specified tag.
+                    return @library.tag_summary(context[1].upcase).values.flatten.uniq
+                end
+            end
+        elsif context[0] == 'rm'
+            if context.size == 1
+                return @library.tags_used
+            else
+                tag = context[1].upcase
+                raise ArgumentError, "Autocompletion is not supported for pictures" if tag == 'METADATA_BLOCK_PICTURE'
+
+                return @library.tag_summary(tag).values.flatten.uniq
+            end
+        elsif context[0] == 'auto'
+            if context.length == 1
+                return %w{tracknumber rename}
+            end
+        end
+
+        return []
+    end
+
+    def print_album_summary(summary)
+        OggAlbumTagger::OggFile.sorted_tags(summary.keys) do |tag|
+            puts tag
+
+            if (summary[tag].size == @library.selected_files.size) && (summary[tag].values.uniq.length == 1)
+                # If all tracks have only one common value
+                puts "\t" + OggAlbumTagger::TagContainer::pp_tag(summary[tag].first[1])
+            else
+                summary[tag].keys.sort.each do |i|
+                    values = summary[tag][i]
+                    puts sprintf("\t%4d: %s", i+1, OggAlbumTagger::TagContainer::pp_tag(values))
+                end
+            end
+        end
+    end
+
+    def show_command(args)
+        case args.length
+        when 0
+            print_album_summary(@library.summary)
+        else
+            print_album_summary @library.summary(args[0].upcase)
+        end
+    end
+
+    def select_command(args)
+        if args.length == 0
+            m = "Usage: select <selector>+\n\n" +
+                "A selector can either be \"all\", a single index or a range (e.g. 3-5).\n" +
+                "Number and range based selectors can be made cumulative by adding a plus or minus sign in front of the selector (ex. \"-1-3\")."
+            raise ArgumentError, m
+        end
+
+        @library.select(args)
+    end
+
+    def ls_command
+        @library.ls().each_with_index { |f, i|
+            puts sprintf("%s %4d: %s", (f[:selected] ? '*' : ' '), i + 1, f[:file])
+        }
+    end
+
+    def handle_picture_args args
+        if %w{METADATA_BLOCK_PICTURE PICTURE}.include? args[0].upcase
+            file = args[1]
+            desc = args.length == 3 ? args[2] : ''
+            args.clear
+            args << 'METADATA_BLOCK_PICTURE'
+            args << OggAlbumTagger::Picture::generate_metadata_block_picture(file, desc)
+        end
+    end
+
+    def move_command(args)
+        raise ArgumentError if args.length != 2
+
+        # Will raise ::ArgumentError if not integers
+        from = Integer(args[0]) - 1
+        to   = Integer(args[1]) - 1
+
+        @library.move(from, to)
+    rescue ::StandardError
+        m = "Usage: move <from_index> <to_index>\n\n" +
+            "<from_index> must be in the [1; #{@library.size}] range.\n" +
+            "<to_index> must be in the [1; #{@library.size + 1}] range."
+        raise ArgumentError, m
+    end
+
+    def set_command(args)
+        if args.length < 2
+            m = "Usage: set <tag> <value>+"
+            raise ArgumentError, m
+        end
+
+        handle_picture_args(args)
+        @library.set_tag(*args)
+    end
+
+    def add_command(args)
+        if args.length < 2
+            m = "Usage: add <tag> [<value>+]"
+            raise ArgumentError, m
+        end
+
+        handle_picture_args(args)
+        @library.add_tag(*args)
+    end
+
+    def rm_command(args)
+        if args.length < 1
+            m = "Usage: rm <tag> [<value>+]"
+            raise ArgumentError, m
+        end
+
+        @library.rm_tag(*args)
+    end
+
+    def auto_command(args)
+        usage = "Usage: auto tracknumber|rename"
+        if args.length < 1
+            raise ArgumentError, usage
+        end
+
+        case args[0]
+        when 'tracknumber'
+            @library.auto_tracknumber()
+        when 'rename'
+            @library.auto_rename
+            ls_command()
+        else
+            raise ArgumentError, usage
+        end
+    end
+
+    def parse_command(command_line)
+        begin
+            arguments = Shellwords.shellwords(command_line)
+        rescue ::StandardError
+            raise OggAlbumTagger::ArgumentError, "Invalid command."
+        end
+
+        selectors = []
+
+        first_not_selector = arguments.find_index { |e| !selector?(e) }
+        unless first_not_selector.nil? || first_not_selector == 0
+            selectors = arguments.slice!(0, first_not_selector)
+        end
+
+        command, *args = arguments
+
+        return selectors, command, args
+    end
+
+    def execute_command(command_line)
+        selectors, command, args = parse_command(command_line)
+
+        return if command.nil?
+
+        @library.with_selection(selectors) {
+            case command
+            when 'ls' then ls_command()
+            when 'select'
+                select_command(args)
+                ls_command()
+            when 'move'
+                move_command(args)
+                ls_command()
+            when 'show' then show_command(args)
+            when 'set'
+                set_command(args)
+                show_command([args[0]])
+            when 'add'
+                add_command(args)
+                show_command([args[0]])
+            when 'rm'
+                rm_command(args)
+                show_command([args[0]])
+            when 'auto'
+                auto_command(args)
+            when 'check'
+                @library.check
+                puts "OK"
+            when 'write'
+                @library.write
+            when 'help'
+                # TODO
+            else
+                puts "Unknown command \"#{command}\""
+            end
+        }
+    end
+end
+
+end # module OggAlbumTagger