stickyflag 0.2.0 → 0.3.0

data/.travis.yml

@@ -1,7 +1,7 @@
 language: ruby
 before_install:
     - sudo apt-get update -qq
-    - sudo apt-get install -qq pdftk
+    - sudo apt-get install -qq pdftk mkvtoolnix
 script: "bundle exec rake"
 
 env:

data/README.md

@@ -3,6 +3,8 @@
 
 *file tagging for everyone*
 
+[![Build Status](https://secure.travis-ci.org/cpence/stickyflag.png)](http://travis-ci.org/cpence/stickyflag) [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/cpence/stickyflag)
+
 ## What does it do?
 
 Filesystems are great.  Most of our file organization tasks can be performed by arranging things in hierarchical directories.  But every once in a while, you have an organization problem that can really only be resolved with categories that *cut across* these hierarchical structures.  What if you want everything related to Project X, including its code, meeting notes about it, photos you took of it, and so on?  The code is in your development directory, meeting notes in a meetings directory, and photos in an images directory.
@@ -22,11 +24,13 @@ StickyFlag can currently tag:
 * MultiMarkdown files
 * PDF files (with `pdftk` installed; see below)
 * PNG files
+* Matroska video files
 * Source code (C/C++, TeX)
 
 ## What else does it need?
 
-If you're going to tag PDF files, you need to install [pdftk,](http://www.pdflabs.com/tools/pdftk-the-pdf-toolkit/) which is available for Windows, Mac OS X, and Linux (licensed under the GPL).
+* If you're going to tag PDF files, you need to install [pdftk,](http://www.pdflabs.com/tools/pdftk-the-pdf-toolkit/) which is available for all platforms (licensed under the GPL).
+* If you're going to tag MKV files, you need to install [mkvtoolnix,](http://www.bunkus.org/videotools/mkvtoolnix/) which is available for all platforms (licensed under the GPL).
 
 ## How do I get it?
 

data/lib/stickyflag/configuration.rb

@@ -8,6 +8,11 @@ module StickyFlag
     DEFAULT_CONFIG = {
       :have_pdftk => false,
       :pdftk_path => '',
+      :have_mkvextract => false,
+      :mkvextract_path => '',
+      :have_mkvpropedit => false,
+      :mkvpropedit_path => '',
+      
       :root => ''
     }
   
@@ -15,7 +20,7 @@ module StickyFlag
       @configuration ||= DEFAULT_CONFIG.clone
   
       unless @configuration.keys.include?(key.to_sym)
-        raise Thor::Error.new('ERROR: Invalid configuration key') 
+        raise Thor::Error.new("ERROR: Invalid configuration key (#{key.to_s})") 
       end
     
       @configuration[key.to_sym]
@@ -25,7 +30,7 @@ module StickyFlag
       @configuration ||= DEFAULT_CONFIG.clone
   
       unless @configuration.keys.include?(key.to_sym)
-        raise Thor::Error.new('ERROR: invalid configuration key')
+        raise Thor::Error.new("ERROR: invalid configuration key (#{key.to_s})")
       end
     
       @configuration[key.to_sym] = value
@@ -51,6 +56,9 @@ module StickyFlag
       file_name = config_path
       if File.file? file_name
         @configuration = YAML::load(File.open(file_name, 'r:UTF-8'))
+        
+        # Merge with the default to pick up new keys
+        @configuration = DEFAULT_CONFIG.merge(@configuration)
       end
     end
   

data/lib/stickyflag/external_cmds.rb

@@ -4,7 +4,9 @@ module StickyFlag
   module ExternalCmds
   
     EXTERNAL_CMDS = {
-      'pdftk' => 'read and write PDF tags'
+      'pdftk' => 'read and write PDF tags',
+      'mkvextract' => 'read MKV tags',
+      'mkvpropedit' => 'write MKV tags'
     }
   
     def find_external_cmds

data/lib/stickyflag/tag_factory.rb

@@ -3,7 +3,6 @@ require 'thor'
 require 'pathname'
 require 'backports'
 require 'stickyflag/tags/pdf'
-require 'stickyflag/tags/pdf'
 require 'stickyflag/tags/png'
 require 'stickyflag/tags/tex'
 require 'stickyflag/tags/c'
@@ -11,98 +10,58 @@ require 'stickyflag/tags/mmd'
 
 module StickyFlag
   module TagFactory
+    TAG_MODULES = StickyFlag::Tags.constants.map { |sym| 
+      StickyFlag::Tags.const_get(sym) 
+    }.select { |const| 
+      const.is_a?(Module) && const.respond_to?(:extensions)
+    }
+    
+    TAG_EXTENSIONS = TAG_MODULES.map { |mod| mod.extensions }.reduce(:|)
+    
     def available_tagging_extensions
-      ['.pdf', '.png', '.tex', '.c', '.cpp', '.cxx', '.c++',
-       '.h', '.hpp', '.hxx', '.mmd']
+      TAG_EXTENSIONS
     end
-  
-    def get_tags_for(file_name)
+    
+    def call_tag_method(file_name, method, *args)
       extension = File.extname file_name
-      case extension
-      when '.pdf' then return StickyFlag::Tags::PDF::get(file_name, get_config(:pdftk_path))
-      when '.png' then return StickyFlag::Tags::PNG::get(file_name)
-      when '.tex' then return StickyFlag::Tags::TeX::get(file_name)
-      when '.c' then return StickyFlag::Tags::C::get(file_name)
-      when '.cpp' then return StickyFlag::Tags::C::get(file_name)
-      when '.cxx' then return StickyFlag::Tags::C::get(file_name)
-      when '.c++' then return StickyFlag::Tags::C::get(file_name)
-      when '.h' then return StickyFlag::Tags::C::get(file_name)
-      when '.hpp' then return StickyFlag::Tags::C::get(file_name)
-      when '.hxx' then return StickyFlag::Tags::C::get(file_name)
-      when '.mmd' then return StickyFlag::Tags::MMD::get(file_name)
-      else raise Thor::Error.new("ERROR: Don't know how to get tags for a file of extension '#{extension}'")
+      
+      TAG_MODULES.each do |mod|
+        if mod.send(:extensions).include? extension  
+          if mod.respond_to?(:config_values)
+            config_values = mod.send(:config_values)
+            config_values.each { |val| args << get_config(val) }
+          end
+                  
+          return mod.send(method, file_name, *args)
+        end
       end
+      
+      raise Thor::Error.new("ERROR: Don't know how to tag a file of extension '#{extension}'")
+    end
+  
+    def get_tags_for(file_name)
+      call_tag_method(file_name, :get)
     end
   
     def set_tag_for(file_name, tag)
       tags = get_tags_for file_name
-      if tags.include? tag
-        # Already set
-        return
-      end
+      return if tags.include? tag
     
       set_database_tag file_name, tag
-    
-      extension = File.extname file_name
-      case extension
-      when '.pdf' then return StickyFlag::Tags::PDF::set(file_name, tag, get_config(:pdftk_path))
-      when '.png' then return StickyFlag::Tags::PNG::set(file_name, tag)
-      when '.tex' then return StickyFlag::Tags::TeX::set(file_name, tag)
-      when '.c' then return StickyFlag::Tags::C::set(file_name, tag)
-      when '.cpp' then return StickyFlag::Tags::C::set(file_name, tag)
-      when '.cxx' then return StickyFlag::Tags::C::set(file_name, tag)
-      when '.c++' then return StickyFlag::Tags::C::set(file_name, tag)
-      when '.h' then return StickyFlag::Tags::C::set(file_name, tag)
-      when '.hpp' then return StickyFlag::Tags::C::set(file_name, tag)
-      when '.hxx' then return StickyFlag::Tags::C::set(file_name, tag)
-      when '.mmd' then return StickyFlag::Tags::MMD::set(file_name, tag)
-      else raise Thor::Error.new("ERROR: Don't know how to set tags for a file of extension '#{extension}'")
-      end
+      call_tag_method(file_name, :set, tag)
     end
   
     def unset_tag_for(file_name, tag)
       tags = get_tags_for file_name
-      unless tags.include? tag
-        raise Thor::Error.new("ERROR: Cannot unset tag #{tag} from file, not set")
-      end
+      raise Thor::Error.new("ERROR: Cannot unset tag #{tag} from file, not set") unless tags.include? tag
     
       unset_database_tag file_name, tag
-    
-      extension = File.extname file_name
-      case extension
-      when '.pdf' then return StickyFlag::Tags::PDF::unset(file_name, tag, get_config(:pdftk_path))
-      when '.png' then return StickyFlag::Tags::PNG::unset(file_name, tag)
-      when '.tex' then return StickyFlag::Tags::TeX::unset(file_name, tag)
-      when '.c' then return StickyFlag::Tags::C::unset(file_name, tag)
-      when '.cpp' then return StickyFlag::Tags::C::unset(file_name, tag)
-      when '.cxx' then return StickyFlag::Tags::C::unset(file_name, tag)
-      when '.c++' then return StickyFlag::Tags::C::unset(file_name, tag)
-      when '.h' then return StickyFlag::Tags::C::unset(file_name, tag)
-      when '.hpp' then return StickyFlag::Tags::C::unset(file_name, tag)
-      when '.hxx' then return StickyFlag::Tags::C::unset(file_name, tag)
-      when '.mmd' then return StickyFlag::Tags::MMD::unset(file_name, tag)
-      else raise Thor::Error.new("ERROR: Don't know how to unset tags for a file of extension '#{extension}'")
-      end
+      call_tag_method(file_name, :unset, tag)
     end
   
     def clear_tags_for(file_name)
       clear_database_tags file_name
-    
-      extension = File.extname file_name
-      case extension
-      when '.pdf' then return StickyFlag::Tags::PDF::clear(file_name, get_config(:pdftk_path))
-      when '.png' then return StickyFlag::Tags::PNG::clear(file_name)
-      when '.tex' then return StickyFlag::Tags::TeX::clear(file_name)
-      when '.c' then return StickyFlag::Tags::C::clear(file_name)
-      when '.cpp' then return StickyFlag::Tags::C::clear(file_name)
-      when '.cxx' then return StickyFlag::Tags::C::clear(file_name)
-      when '.c++' then return StickyFlag::Tags::C::clear(file_name)
-      when '.h' then return StickyFlag::Tags::C::clear(file_name)
-      when '.hpp' then return StickyFlag::Tags::C::clear(file_name)
-      when '.hxx' then return StickyFlag::Tags::C::clear(file_name)
-      when '.mmd' then return StickyFlag::Tags::MMD::clear(file_name)
-      else raise Thor::Error.new("ERROR: Don't know how to clear all tags for a file of extension '#{extension}'")
-      end
+      call_tag_method(file_name, :clear)
     end
   end
 end

data/lib/stickyflag/tags/c.rb

@@ -5,6 +5,10 @@ module StickyFlag
   module Tags
     module C
       module_function
+      
+      def extensions
+        [ '.c', '.cpp', '.cxx', '.c++', '.h', '.hpp', '.hxx' ]
+      end
     
       def comment_line_regex
         /\A\/\/ .*/

data/lib/stickyflag/tags/mkv.rb

@@ -0,0 +1,204 @@
+# -*- encoding : utf-8 -*-
+require 'thor'
+require 'open3'
+require 'nokogiri'
+require 'stickyflag/patches/tempfile_encoding'
+
+module StickyFlag
+  module Tags
+    module MKV
+      module_function
+      
+      def extensions
+        [ '.mkv' ]
+      end
+      def config_values
+        [ :mkvextract_path, :mkvpropedit_path ]
+      end
+      
+      def get_tag_xml(file_name, mkvextract_path = 'mkvextract', mkvpropedit_path = 'mkvpropedit')
+        stdout_str = ''
+        stderr_str = ''
+      
+        begin
+          Open3.popen3("#{mkvextract_path} tags #{file_name} -q") do |i, o, e, t|
+            out_reader = Thread.new { o.read }
+            err_reader = Thread.new { e.read }
+            i.close
+            stdout_str = out_reader.value
+            stderr_str = err_reader.value
+
+            stdout_str.force_encoding("UTF-8") if RUBY_VERSION >= "1.9.0"
+            stderr_str.force_encoding("UTF-8") if RUBY_VERSION >= "1.9.0"
+          end
+        rescue Exception
+          raise Thor::Error.new("ERROR: Failed to get tags for #{file_name}; mkvextract call failed")
+        end
+        if stderr_str.start_with?("Error: ") || stderr_str.include?("Errno::ENOENT") || stdout_str.start_with?("Error: ")
+          raise Thor::Error.new("ERROR: Failed to get tags for #{file_name}; mkvextract call failed")
+        end
+        
+        if stdout_str == ''
+          # This is what happens when a file has no tags whatsoever, we need
+          # to build a skeleton document
+          stdout_str = <<-XML
+          <?xml version="1.0" encoding="UTF-8"?>
+
+          <!DOCTYPE Tags SYSTEM "matroskatags.dtd">
+
+          <Tags>
+            <Tag>
+              <Targets>
+              </Targets>
+            </Tag>
+          </Tags>
+          XML
+        end
+        
+        # Strip off newlines and BOM, these wreak havoc on the Java XML parser,
+        # which considers them content before the prolog
+        bom = "\xEF\xBB\xBF"
+        bom.force_encoding("UTF-8") if RUBY_VERSION >= "1.9.0"
+        stdout_str.strip!.gsub!(bom, '')
+        
+        Nokogiri::XML(stdout_str)        
+      end
+      
+      def get_stickyflag_root(xml_doc)
+        xml_doc.xpath("/Tags/Tag").each do |tag|
+          targets = tag.at_xpath("Targets")
+          next if targets.nil? # This shouldn't ever happen
+          
+          # If there's no UID elements under this tag, then we're good (note
+          # that sometimes mkvpropedit will *force* in a TargetTypeValue or
+          # a TargetType, and we don't want to block on those)
+          good = true
+          targets.children.each do |child|
+            if child.name.end_with? 'UID'
+              good = false
+              break
+            end
+          end
+          
+          return tag if good
+        end
+        
+        # Make one, then
+        tag_tag = Nokogiri::XML::Node.new 'Tag', xml_doc
+        targets_tag = Nokogiri::XML::Node.new 'Targets', xml_doc
+        tag_tag.add_child targets_tag
+
+        root_elem = xml_doc.at_xpath("/Tags")
+        root_elem.add_child tag_tag
+        
+        tag_tag
+      end
+      
+      def get_stickyflag_tag(xml_doc)
+        tag_tag = get_stickyflag_root(xml_doc)
+        if tag_tag.nil?
+          # Should never happen!
+          raise Thor::Error.new("INTERNAL ERROR: Failed to find the StickyFlag tag root in MKV XML")
+        end
+        
+        tag_tag.at_xpath("Simple[Name = 'X_STICKYFLAG_FLAGS']/String")
+      end
+      
+      def set_tag_xml(xml_doc, file_name, mkvextract_path = 'mkvextract', mkvpropedit_path = 'mkvpropedit')
+        # Write out this XML file and attach it to the MKV
+        outfile = Tempfile.new_with_encoding ['sfmkvtag', '.xml']
+        begin
+          outfile.write(xml_doc.to_xml)
+          outfile.close
+          
+          ret = system(mkvpropedit_path, file_name, '--tags', "all:#{outfile.path}", "-q")
+          unless ret == true
+            raise Thor::Error.new("ERROR: Failed to update tag for #{file_name}; mkvpropedit call failed")
+          end
+        ensure
+          outfile.unlink
+        end
+      end
+    
+      def get(file_name, mkvextract_path = 'mkvextract', mkvpropedit_path = 'mkvpropedit')
+        xml_doc = get_tag_xml(file_name, mkvextract_path, mkvpropedit_path)
+        stickyflag_tag = get_stickyflag_tag(xml_doc)
+        return [] if stickyflag_tag.nil?
+        
+        tag_string = stickyflag_tag.content
+        return [] if tag_string.nil? || tag_string.empty?
+        
+        tag_string.split(',').map { |t| t.empty? ? nil : t.strip }.compact
+      end
+    
+      def set(file_name, tag, mkvextract_path = 'mkvextract', mkvpropedit_path = 'mkvpropedit')
+        xml_doc = get_tag_xml(file_name, mkvextract_path, mkvpropedit_path)
+        stickyflag_tag = get_stickyflag_tag(xml_doc)
+        
+        unless stickyflag_tag.nil?
+          # We already have the right tag, check it
+          tag_string = stickyflag_tag.content
+          unless tag_string.nil? || tag_string.empty?
+            tags = tag_string.split(',').map { |t| t.empty? ? nil : t.strip }.compact
+            return if tags.include? tag
+            tags << tag
+            
+            # Set the new string in the XML file
+            new_tag_string = tags.join(', ')
+            stickyflag_tag.content = new_tag_string
+          else
+            # Somehow the tag has no content, write it in
+            stickyflag_tag.content = tag
+          end
+        else
+          # No tag, add it
+          root = get_stickyflag_root(xml_doc)
+          simple_tag = Nokogiri::XML::Node.new 'Simple', xml_doc
+          
+          name_tag = Nokogiri::XML::Node.new 'Name', xml_doc
+          name_tag.content = 'X_STICKYFLAG_FLAGS'
+          string_tag = Nokogiri::XML::Node.new 'String', xml_doc
+          string_tag.content = tag
+          
+          simple_tag.add_child(name_tag)
+          simple_tag.add_child(string_tag)
+          
+          root.add_child(simple_tag)
+        end
+        
+        set_tag_xml(xml_doc, file_name, mkvextract_path, mkvpropedit_path)
+      end
+
+      def unset(file_name, tag, mkvextract_path = 'mkvextract', mkvpropedit_path = 'mkvpropedit')
+        xml_doc = get_tag_xml(file_name, mkvextract_path, mkvpropedit_path)
+        stickyflag_tag = get_stickyflag_tag(xml_doc)
+        
+        unless stickyflag_tag.nil?
+          # We already have the right tag, check it
+          tag_string = stickyflag_tag.content
+          unless tag_string.nil? || tag_string.empty?
+            tags = tag_string.split(',').map { |t| t.empty? ? nil : t.strip }.compact
+            return unless tags.include? tag
+            tags.delete(tag)
+            
+            # Set the new string in the XML file
+            new_tag_string = tags.join(', ')
+            stickyflag_tag.content = new_tag_string
+            
+            set_tag_xml(xml_doc, file_name, mkvextract_path, mkvpropedit_path)
+          end
+        end
+      end
+
+      def clear(file_name, mkvextract_path = 'mkvextract', mkvpropedit_path = 'mkvpropedit')
+        xml_doc = get_tag_xml(file_name, mkvextract_path, mkvpropedit_path)
+        stickyflag_tag = get_stickyflag_tag(xml_doc)
+        
+        unless stickyflag_tag.nil?
+          stickyflag_tag.remove
+          set_tag_xml(xml_doc, file_name, mkvextract_path, mkvpropedit_path)
+        end
+      end
+    end
+  end
+end

data/lib/stickyflag/tags/mmd.rb

@@ -5,6 +5,10 @@ module StickyFlag
   module Tags
     module MMD    
       module_function
+      
+      def extensions
+        [ '.md', '.mmd', '.markdown', '.text' ]
+      end
     
       # We duplicate the source-code module here because we want to have
       # cute support for the indentation of tag contents in MMD, and because

data/lib/stickyflag/tags/pdf.rb

@@ -7,6 +7,13 @@ module StickyFlag
   module Tags
     module PDF
       module_function
+      
+      def extensions
+        [ '.pdf' ]
+      end
+      def config_values
+        [ :pdftk_path ]
+      end
     
       def get(file_name, pdftk_path = 'pdftk')
         stdout_str = ''
@@ -47,13 +54,8 @@ module StickyFlag
       
         tags
       end
-    
-      def set(file_name, tag, pdftk_path = 'pdftk')
-        tags = get(file_name, pdftk_path)
-        return if tags.include? tag
-      
-        tags << tag
       
+      def write_tags_to(file_name, tags, pdftk_path = 'pdftk')
         info = Tempfile.new_with_encoding ['sfpdftag', '.txt']
         begin
           info.write("InfoKey: X-StickyFlag-Flags\n")
@@ -61,9 +63,9 @@ module StickyFlag
           info.close
         
           outpath = File.tmpnam('.pdf')
-          ret = system(pdftk_path, file_name.to_s, 'update_info', info.path, 'output', outpath)
+          ret = system(pdftk_path, file_name, 'update_info', info.path, 'output', outpath)
           unless ret == true
-            raise Thor::Error.new("ERROR: Failed to set tag for #{file_name}; pdftk call failed")
+            raise Thor::Error.new("ERROR: Failed to write tag for #{file_name}; pdftk call failed")
           end
           
           FileUtils.mv outpath, file_name
@@ -71,48 +73,27 @@ module StickyFlag
           info.unlink
         end
       end
+    
+      def set(file_name, tag, pdftk_path = 'pdftk')
+        tags = get(file_name, pdftk_path)
+        return if tags.include? tag
+      
+        tags << tag
+        
+        write_tags_to(file_name, tags, pdftk_path)
+      end
 
       def unset(file_name, tag, pdftk_path = 'pdftk')
         tags = get(file_name, pdftk_path)
         return unless tags.include? tag
       
         tags.delete(tag)
-      
-        info = Tempfile.new_with_encoding ['sfpdftag', '.txt']
-        begin
-          info.write("InfoKey: X-StickyFlag-Flags\n")
-          info.write("InfoValue: #{tags.join(', ')}\n")
-          info.close
         
-          outpath = File.tmpnam('.pdf')
-          ret = system(pdftk_path, file_name.to_s, 'update_info', info.path, 'output', outpath)
-          unless ret == true
-            raise Thor::Error.new("ERROR: Failed to unset tag for #{file_name}; pdftk call failed")
-          end
-          
-          FileUtils.mv outpath, file_name
-        ensure
-          info.unlink
-        end
+        write_tags_to(file_name, tags, pdftk_path)
       end
 
       def clear(file_name, pdftk_path = 'pdftk')
-        info = Tempfile.new_with_encoding ['sfpdftag', '.txt']
-        begin
-          info.write("InfoKey: X-StickyFlag-Flags\n")
-          info.write("InfoValue: \n")
-          info.close
-        
-          outpath = File.tmpnam('.pdf')
-          ret = system(pdftk_path, file_name.to_s, 'update_info', info.path, 'output', outpath)
-          unless ret == true
-            raise Thor::Error.new("ERROR: Failed to clear tags for #{file_name}; pdftk call failed")
-          end
-          
-          FileUtils.mv outpath, file_name
-        ensure
-          info.unlink
-        end
+        write_tags_to(file_name, [], pdftk_path)
       end
     end
   end

data/lib/stickyflag/tags/png.rb

@@ -11,6 +11,10 @@ module StickyFlag
   module Tags
     module PNG
       module_function
+      
+      def extensions
+        [ '.png' ]
+      end
     
       def get(file_name)
         image = ChunkyPNG::Image.from_file(file_name)

data/lib/stickyflag/tags/tex.rb

@@ -5,6 +5,10 @@ module StickyFlag
   module Tags
     module TeX
       module_function
+      
+      def extensions
+        [ '.tex' ]
+      end
     
       def comment_line_regex
         /\A% .*/

data/lib/stickyflag/version.rb

@@ -4,7 +4,7 @@ module StickyFlag
   module Version
     NUMBERS = [
       MAJOR = 0,
-      MINOR = 2,
+      MINOR = 3,
       BUILD = 0
     ]
   end

data/spec/stickyflag/external_cmds_spec.rb

@@ -51,7 +51,7 @@ describe 'StickyFlag::ExternalCmds' do
       end
       
       it 'outputs a warning message' do
-        @obj.should_receive(:say_status).with(:warning, kind_of(String), kind_of(Symbol))
+        @obj.should_receive(:say_status).with(:warning, kind_of(String), kind_of(Symbol)).at_least(:once)
         @obj.find_external_cmds
       end
     end
@@ -81,8 +81,8 @@ describe 'StickyFlag::ExternalCmds' do
       end
       
       it 'should not print any messages' do
-        @obj.should_not_receive(:say)
-        @obj.should_not_receive(:say_status)
+        @obj.should_not_receive(:say).with(/pdftk/)
+        @obj.should_not_receive(:say_status).with(:warning, /pdftk/, kind_of(Symbol))
         @obj.find_external_cmds
       end
     end
@@ -109,7 +109,7 @@ describe 'StickyFlag::ExternalCmds' do
       
       it 'prints out an error message' do
         @obj.stub(:say_status) {}
-        @obj.should_receive(:say_status).with(:error, kind_of(String), kind_of(Symbol))
+        @obj.should_receive(:say_status).with(:error, /pdftk/, kind_of(Symbol))
         @obj.find_external_cmds
       end
     end
@@ -136,7 +136,7 @@ describe 'StickyFlag::ExternalCmds' do
       
       it 'prints out an error message' do
         @obj.stub(:say_status) {}
-        @obj.should_receive(:say_status).with(:error, kind_of(String), kind_of(Symbol))
+        @obj.should_receive(:say_status).with(:error, /pdftk/, kind_of(Symbol))
         @obj.find_external_cmds
       end
     end
@@ -166,8 +166,8 @@ describe 'StickyFlag::ExternalCmds' do
       end
       
       it 'should not print any messages' do
-        @obj.should_not_receive(:say)
-        @obj.should_not_receive(:say_status)
+        @obj.should_not_receive(:say).with(/pdftk/)
+        @obj.should_not_receive(:say_status).with(:warning, /pdftk/, kind_of(Symbol))
         @obj.find_external_cmds
       end
     end

data/spec/stickyflag/tag_factory_spec.rb

@@ -33,70 +33,11 @@ describe 'StickyFlag::TagFactory' do
   end
   
   describe '.available_tagging_extensions' do
-    # Some extensions require the presence of actual, good files, not
-    # just empty shells, so we can't test them in this way.  Skip those.
-    CANNOT_TEST = [ '.pdf', '.png' ]
-    
-    it 'should call get for every good extension' do
-      (@obj.available_tagging_extensions - CANNOT_TEST).each do |ext|
-        file = Tempfile.new_with_encoding(['ext', ext])
-        file.puts('test')        
-        file.close
-        
-        expect { @obj.get_tags_for(file.path) }.to_not raise_error
-        file.unlink
-      end
-    end
-    
-    it 'should call get for other extensions' do
-      CANNOT_TEST.each do |ext|
-        path = copy_example "#{ext[1..-1]}_with_tag#{ext}"
-        expect { @obj.clear_tags_for(path) }.to_not raise_error
-        File.unlink(path)
-      end
-    end
-
-    it 'should call set/unset for every good extension' do
-      (@obj.available_tagging_extensions - CANNOT_TEST).each do |ext|
-        file = Tempfile.new_with_encoding(['ext', ext])
-        file.puts('test')        
-        file.close
-        
-        expect { 
-          @obj.set_tag_for(file.path, 'test')
-          @obj.unset_tag_for(file.path, 'test')
-          }.to_not raise_error
-        file.unlink
-      end
-    end
-    
-    it 'should call set/unset for other extensions' do
-      CANNOT_TEST.each do |ext|
-        path = copy_example "#{ext[1..-1]}_with_tag#{ext}"
-        expect {
-          @obj.set_tag_for(path, 'test2')
-          @obj.unset_tag_for(path, 'test2')
-          }.to_not raise_error
-        File.unlink(path)
-      end
-    end
-    
-    it 'should call clear for every good extension' do
-      (@obj.available_tagging_extensions - CANNOT_TEST).each do |ext|
-        file = Tempfile.new_with_encoding(['ext', ext])
-        file.puts('test')        
-        file.close
-        
-        expect { @obj.clear_tags_for(file.path) }.to_not raise_error
-        file.unlink
-      end
-    end
-    
-    it 'should call clear for other extensions' do
-      CANNOT_TEST.each do |ext|
-        path = copy_example "#{ext[1..-1]}_with_tag#{ext}"
-        expect { @obj.clear_tags_for(path) }.to_not raise_error
-        File.unlink(path)
+    it 'should be able to call through to a class method for every good extension' do
+      @obj.available_tagging_extensions.each do |ext|
+        # This is a bit of a hack -- call TagClass::respond_to?, which takes
+        # one argument
+        expect { @obj.call_tag_method("test#{ext}", :respond_to?) }.to_not raise_error
       end
     end
   end

data/spec/stickyflag/tags/mkv_spec.rb

@@ -0,0 +1,54 @@
+# -*- encoding : utf-8 -*-
+require 'stickyflag/tags/mkv'
+require 'stickyflag/paths'
+require 'stickyflag/configuration'
+require 'stickyflag/external_cmds'
+
+class GetConfiguration
+  include StickyFlag::Paths
+  include StickyFlag::Configuration
+  include StickyFlag::ExternalCmds
+end
+
+describe StickyFlag::Tags::MKV do
+  before(:each) do
+    config = GetConfiguration.new
+    config.stub(:load_config!) { }
+    config.stub(:save_config!) { }
+
+    config.find_external_cmds
+    
+    @mkve = config.get_config(:mkvextract_path)
+    @mkvp = config.get_config(:mkvpropedit_path)
+  end
+  
+  it_behaves_like 'a tag handler' do
+    let(:params) {
+      [ @mkve, @mkvp ]
+    }
+  end
+  
+  context 'when we set our own tag' do
+    it "doesn't wipe out other tags set on the file" do
+      path = copy_example("mkv_with_tag.mkv")
+      StickyFlag::Tags::MKV.set(path, 'test2', @mkve, @mkvp)
+      
+      # This is an internal method, but it's too useful not to use
+      xml_doc = StickyFlag::Tags::MKV.get_tag_xml(path, @mkve, @mkvp)
+      
+      # This is one of the original tags on the file
+      tag = xml_doc.at_xpath("/Tags/Tag[Targets[TargetTypeValue = '50']]/Simple[Name = 'TITLE']")
+      tag.should_not be_nil
+      tag.at_xpath("String").content.should eq('Big Buck Bunny - test 1')
+    end
+  end
+  
+  context 'with bad mkv utility paths' do
+    it 'raises errors for everything' do
+      expect { StickyFlag::Tags::MKV.get(example_path("mkv_with_tag.mkv"), '/wut/bad', '/wut/no') }.to raise_error(Thor::Error)
+      expect { StickyFlag::Tags::MKV.clear(example_path("mkv_with_tag.mkv"), '/wut/bad', '/wut/no') }.to raise_error(Thor::Error)
+      expect { StickyFlag::Tags::MKV.set(example_path("mkv_with_tag.mkv"), 'test2', '/wut/bad', '/wut/no') }.to raise_error(Thor::Error)
+      expect { StickyFlag::Tags::MKV.unset(example_path("mkv_with_tag.mkv"), 'test', '/wut/bad', '/wut/no') }.to raise_error(Thor::Error)
+    end
+  end
+end

data/stickyflag.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'thor'
   s.add_runtime_dependency 'backports'
   s.add_runtime_dependency 'xdg'
+  s.add_runtime_dependency 'nokogiri'
   s.add_runtime_dependency 'chunky_png'
   s.add_runtime_dependency 'sequel'
   

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: stickyflag
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-31 00:00:00.000000000 Z
+date: 2012-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -59,6 +59,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: chunky_png
   requirement: !ruby/object:Gem::Requirement
@@ -282,6 +298,7 @@ files:
 - lib/stickyflag/paths.rb
 - lib/stickyflag/tag_factory.rb
 - lib/stickyflag/tags/c.rb
+- lib/stickyflag/tags/mkv.rb
 - lib/stickyflag/tags/mmd.rb
 - lib/stickyflag/tags/pdf.rb
 - lib/stickyflag/tags/png.rb
@@ -297,6 +314,7 @@ files:
 - spec/stickyflag/paths_spec.rb
 - spec/stickyflag/tag_factory_spec.rb
 - spec/stickyflag/tags/c_spec.rb
+- spec/stickyflag/tags/mkv_spec.rb
 - spec/stickyflag/tags/mmd_spec.rb
 - spec/stickyflag/tags/pdf_spec.rb
 - spec/stickyflag/tags/png_spec.rb
@@ -306,6 +324,8 @@ files:
 - spec/support/examples/c_all_comments.c
 - spec/support/examples/c_no_tags.c
 - spec/support/examples/c_with_tag.c
+- spec/support/examples/mkv_no_tags.mkv
+- spec/support/examples/mkv_with_tag.mkv
 - spec/support/examples/mmd_all_meta.mmd
 - spec/support/examples/mmd_crazy_keys.mmd
 - spec/support/examples/mmd_crazy_tags.mmd
@@ -373,6 +393,7 @@ test_files:
 - spec/stickyflag/paths_spec.rb
 - spec/stickyflag/tag_factory_spec.rb
 - spec/stickyflag/tags/c_spec.rb
+- spec/stickyflag/tags/mkv_spec.rb
 - spec/stickyflag/tags/mmd_spec.rb
 - spec/stickyflag/tags/pdf_spec.rb
 - spec/stickyflag/tags/png_spec.rb
@@ -382,6 +403,8 @@ test_files:
 - spec/support/examples/c_all_comments.c
 - spec/support/examples/c_no_tags.c
 - spec/support/examples/c_with_tag.c
+- spec/support/examples/mkv_no_tags.mkv
+- spec/support/examples/mkv_with_tag.mkv
 - spec/support/examples/mmd_all_meta.mmd
 - spec/support/examples/mmd_crazy_keys.mmd
 - spec/support/examples/mmd_crazy_tags.mmd