stickyflag 0.2.0

data/lib/stickyflag/tags/pdf.rb

@@ -0,0 +1,119 @@
+# -*- encoding : utf-8 -*-
+require 'thor'
+require 'open3'
+require 'stickyflag/patches/tempfile_encoding'
+
+module StickyFlag
+  module Tags
+    module PDF
+      module_function
+    
+      def get(file_name, pdftk_path = 'pdftk')
+        stdout_str = ''
+        stderr_str = ''
+      
+        begin
+          Open3.popen3(pdftk_path, file_name.to_s, 'dump_data_utf8') 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}; pdftk call failed")
+        end
+        if stderr_str.start_with?("Error: ") || stderr_str.include?("Errno::ENOENT")
+          raise Thor::Error.new("ERROR: Failed to get tags for #{file_name}; pdftk call failed")
+        end
+      
+        # More than one of these shouldn't be possible, but try to recover if
+        # it somehow happens.
+        matches = stdout_str.scan(/InfoKey: X-StickyFlag-Flags\nInfoValue: (.*?)\n/)
+        return [] if matches.empty?
+      
+        tags = []
+      
+        matches.each do |m|
+          match_string = m[0]
+          match_tags = match_string.split(',').map { |t| t.empty? ? nil : t.strip }.compact
+          next if match_tags.empty?
+        
+          tags.concat(match_tags)
+        end
+      
+        tags
+      end
+    
+      def set(file_name, tag, pdftk_path = 'pdftk')
+        tags = get(file_name, pdftk_path)
+        return if tags.include? tag
+      
+        tags << 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 set tag for #{file_name}; pdftk call failed")
+          end
+          
+          FileUtils.mv outpath, file_name
+        ensure
+          info.unlink
+        end
+      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
+      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
+      end
+    end
+  end
+end

data/lib/stickyflag/tags/png.rb

@@ -0,0 +1,61 @@
+# -*- encoding : utf-8 -*-
+require 'thor'
+begin
+  require 'oily_png'
+rescue LoadError
+  require 'chunky_png'
+end
+require 'fileutils'
+
+module StickyFlag
+  module Tags
+    module PNG
+      module_function
+    
+      def get(file_name)
+        image = ChunkyPNG::Image.from_file(file_name)
+        tag_string = image.metadata['X-StickyFlag-Flags']
+        return [] if tag_string.nil?
+        tag_string.force_encoding('UTF-8') if RUBY_VERSION >= "1.9.0"
+        tag_string.split(',').map { |t| t.empty? ? nil : t.strip }.compact
+      end
+    
+      def set(file_name, tag)
+        tags = get(file_name)
+        return if tags.include? tag
+      
+        tags << tag
+      
+        image = ChunkyPNG::Image.from_file(file_name)
+        image.metadata['X-StickyFlag-Flags'] = tags.join(', ')
+      
+        outpath = File.tmpnam('.png')
+        image.save(outpath)
+        FileUtils.mv(outpath, file_name)
+      end
+    
+      def unset(file_name, tag)
+        tags = get(file_name)
+        return unless tags.include? tag
+      
+        tags.delete(tag)
+      
+        image = ChunkyPNG::Image.from_file(file_name)
+        image.metadata['X-StickyFlag-Flags'] = tags.join(', ')
+      
+        outpath = File.tmpnam('.png')
+        image.save(outpath)
+        FileUtils.mv(outpath, file_name)
+      end
+    
+      def clear(file_name)
+        image = ChunkyPNG::Image.from_file(file_name)
+        image.metadata.delete('X-StickyFlag-Flags')
+      
+        outpath = File.tmpnam('.png')
+        image.save(outpath)
+        FileUtils.mv(outpath, file_name)
+      end
+    end
+  end
+end

data/lib/stickyflag/tags/source_code.rb

@@ -0,0 +1,99 @@
+# -*- encoding : utf-8 -*-
+
+module StickyFlag
+  module Tags
+    module SourceCode
+      module_function
+    
+      #
+      # Specify:
+      #   comment_line_regex: matches any line of comments at the start of the source code (when this doesn't match, we'll stop looking)
+      #
+      #   tag_line_regex: matches the specific line that contains the tags, the one group in this regex should be the comma-separated list of tags
+      #
+      #   tag_line_for(tags): convert the tag string (already a string!) into the output line we should print
+      #
+    
+      def get(file_name)
+        File.open(file_name, 'r:UTF-8').each_line do |line|
+          return [] unless line =~ comment_line_regex
+
+          m = line.match(tag_line_regex)
+          if m
+            tag_string = m[1]
+            return [] if tag_string.nil? || tag_string.empty?
+            return tag_string.split(',').map { |t| t.empty? ? nil : t.strip }.compact
+          end
+        end
+      
+        []
+      end
+    
+      def set(file_name, tag)
+        tags = get(file_name)
+        return if tags.include? tag
+      
+        tags << tag      
+        set_tags = false
+
+        outpath = File.tmpnam
+        File.open(outpath, 'w:UTF-8') do |outfile|
+          File.open(file_name, 'r:UTF-8').each_line do |line|
+            if line !~ comment_line_regex
+              if set_tags == false
+                # We haven't set the tags yet, but the current line does *not*
+                # match the comment line regex.  Add the tags line as a new line
+                # at the end of the comment block.
+                outfile.puts tag_line_for(tags.join(', '))
+                set_tags = true
+              else
+                outfile.puts line
+              end
+            else
+              if line =~ tag_line_regex
+                # Replace the old tag line with the new tag line
+                outfile.puts tag_line_for(tags.join(', '))
+              else
+                outfile.puts line
+              end
+            end
+          end
+        end
+      
+        FileUtils.mv(outpath, file_name)
+      end
+    
+      def unset(file_name, tag)
+        tags = get(file_name)
+        return unless tags.include? tag
+      
+        tags.delete(tag)
+      
+        outpath = File.tmpnam
+        File.open(outpath, 'w:UTF-8') do |outfile|
+          File.open(file_name, 'r:UTF-8').each_line do |line|
+            if line =~ tag_line_regex
+              outfile.puts tag_line_for(tags.join(', '))
+            else
+              outfile.puts line
+            end
+          end
+        end
+      
+        FileUtils.mv(outpath, file_name)
+      end
+    
+      def clear(file_name)
+        outpath = File.tmpnam
+        File.open(outpath, 'w:UTF-8') do |outfile|
+          File.open(file_name, 'r:UTF-8').each_line do |line|
+            next if line =~ tag_line_regex
+            outfile.puts line
+          end
+        end
+      
+        FileUtils.mv(outpath, file_name)
+      end
+    end
+  end
+end

data/lib/stickyflag/tags/tex.rb

@@ -0,0 +1,25 @@
+# -*- encoding : utf-8 -*-
+require 'stickyflag/tags/source_code'
+
+module StickyFlag
+  module Tags
+    module TeX
+      module_function
+    
+      def comment_line_regex
+        /\A% .*/
+      end
+    
+      def tag_line_regex
+        /\A% SF_TAGS = (.*)/
+      end
+    
+      def tag_line_for(str)
+        "% SF_TAGS = #{str}"
+      end
+    
+      include SourceCode
+      module_function :get, :set, :unset, :clear
+    end
+  end
+end

data/lib/stickyflag/version.rb

@@ -0,0 +1,12 @@
+# -*- encoding : utf-8 -*-
+
+module StickyFlag
+  module Version
+    NUMBERS = [
+      MAJOR = 0,
+      MINOR = 2,
+      BUILD = 0
+    ]
+  end
+  VERSION = Version::NUMBERS.join('.')
+end

data/lib/stickyflag.rb

@@ -0,0 +1,253 @@
+# -*- encoding : utf-8 -*-
+
+require 'rubygems'
+require 'thor'
+require 'backports'
+
+require 'stickyflag/version'
+
+require 'stickyflag/patches/tempfile_encoding'
+require 'stickyflag/patches/tmpnam.rb'
+
+require 'stickyflag/tags/source_code'
+require 'stickyflag/tags/c'
+require 'stickyflag/tags/mmd'
+require 'stickyflag/tags/pdf'
+require 'stickyflag/tags/png'
+require 'stickyflag/tags/tex'
+
+require 'stickyflag/configuration'
+require 'stickyflag/paths'
+require 'stickyflag/external_cmds'
+require 'stickyflag/database'
+require 'stickyflag/tag_factory'
+
+module StickyFlag
+  class ThorApp < Thor
+    include Thor::Actions
+    class_option :color, :required => false, :default => true,
+      :desc => 'if true, print our status messages in color', :type => :boolean
+    class_option :force, :requires => false, :default => false, :aliases => '-f',
+      :desc => 'do not print diagnostic messages for missing files or empty tags on multiple-file operations'
+    class_option :quiet, :required => false, :default => false, :aliases => '-q',
+      :desc => 'if true, print only essential output to the console (skip empty tags, diagnostics)'
+
+    include Paths
+    include Configuration
+    include ExternalCmds
+    include TagFactory
+    include Database
+
+    def initialize(*args)
+      super
+    
+      if options.color?
+        self.shell = Thor::Shell::Color.new
+      end
+    
+      load_config!
+      find_external_cmds
+      load_database
+    end
+
+    desc 'config', "display and set configuration parameters"
+    long_desc <<-LONGDESC
+      `stickyflag config` allows you to set persistent configuration parameters
+      for StickyFlag.
+    
+      With only --key <key> specified, display the current value for the given key.
+    
+      With --key <key> <value>, set the value for the key.
+    
+      With the --list option, list all available configuration parameters and 
+      their current values.
+    LONGDESC
+    method_option :key, :aliases => '-k', :required => false,
+      :desc => 'the configuration key to set', :type => :string
+    method_option :list, :aliases => '-l', :default => false, :required => false,
+      :desc => 'list all available configuration options', :type => :boolean
+    method_option :reset, :default => false, :required => false,
+      :desc => 'reset *all* configuration settings to defaults', :type => :boolean
+    def config(value = nil)
+      if options.reset?
+        reset_config!
+        return
+      end
+    
+      if options.list? || (options[:key].nil? && value.nil?)
+        dump_config
+        return
+      end
+    
+      if options[:key].nil?
+        raise Thor::Error.new("ERROR: Cannot set a value without a key specified")
+      end
+    
+      if value.nil?
+        value = get_config options[:key]
+        say "#{options[:key]}: '#{value}'"
+        return
+      end
+    
+      set_config options[:key], value
+      say "'#{options[:key]}' set to '#{value}'" unless options.quiet?
+    
+      save_config!
+    end
+  
+    desc 'get [FILES]', "print the tags set for a set of files"
+    long_desc <<-LONGDESC
+      `stickyflag get` lets you look at the tags that have been applied to
+      a file or set of files.
+    LONGDESC
+    def get(*files)
+      if files.empty?
+        raise Thor::Error.new("stickyflag get requires at least 1 argument: \"stickyflag get [FILES]\"")
+      end
+    
+      files.each do |file_name|
+        unless File.exist? file_name
+          say_status :error, "File #{file_name} does not exist", :red unless options.force? || options.quiet?
+          next
+        end
+      
+        tags = get_tags_for file_name
+        if tags.empty?
+          say "#{file_name}: no tags" unless options.force? || options.quiet?
+          next
+        else
+          say "#{file_name}: #{tags.join(', ')}"
+          next
+        end
+      end
+    end
+  
+  
+    desc 'set [FILE] [TAG]', "set a tag for a file"
+    long_desc <<-LONGDESC
+      `stickyflag set` lets you add one particular tag to the tags present in a
+      given file.  Specify the file you want to modify, and the tag you want to
+      add.
+    LONGDESC
+    def set(file_name, tag)
+      check_tag tag
+    
+      unless File.exist? file_name
+        say_status :error, "File #{file_name} does not exist", :red unless options.quiet?
+        return
+      end
+    
+      set_tag_for file_name, tag
+    
+      tags = get_tags_for file_name
+      say_status :success, "New tags for #{file_name}: #{tags.join(', ')}", :green unless options.quiet?
+    end
+  
+  
+    desc 'unset [FILE] [TAG]', "remove a tag from a file"
+    long_desc <<-LONGDESC
+      `stickyflag unset` lets you delete one tag from the tags present in a file.
+      Specify the file you want to modify, and the tag you want to remove.  This
+      action will fail if the tag is not set in the requested file.
+    LONGDESC
+    def unset(file_name, tag)
+      check_tag tag
+    
+      unless File.exist? file_name
+        say_status :error, "File #{file_name} does not exist", :red unless options.quiet?
+        return
+      end
+    
+      unset_tag_for file_name, tag
+    
+      # Unsetting a tag might leave us with no tags at all, which makes this more
+      # complicated than the #set behavior
+      unless options.quiet?
+        tags = get_tags_for file_name
+        if tags.empty?
+          say_status :success, "New tags for #{file_name}: no tags", :green
+        else
+          say_status :success, "New tags for #{file_name}: #{tags.join(', ')}", :green
+        end
+      end
+    end
+  
+  
+    desc 'clear [FILES]', "remove all tags from a set of files"
+    long_desc <<-LONGDESC
+      `stickyflag clear` removes all tags that have been applied to the given 
+      list of files.
+    LONGDESC
+    def clear(*files)
+      if files.empty?
+        raise Thor::Error.new("stickyflag clear requires at least 1 argument: \"stickyflag clear [FILES]\"")
+      end
+    
+      files.each do |file_name|
+        unless File.exist? file_name
+          say_status :error, "File #{file_name} does not exist", :red unless options.force? || options.quiet?
+          return
+        end
+      
+        clear_tags_for file_name
+        say_status :success, "Tags cleared for #{file_name}", :green unless options.quiet?
+      end
+    end
+  
+    desc 'update', "update the tag database from the files on disk"
+    long_desc <<-LONGDESC
+      `stickyflag update` will read all files under the current directory (or
+      using the `root` configuration key) and refresh the database based on their
+      contents.
+    LONGDESC
+    def update
+      root = get_config(:root).strip
+      root = '.' if root.empty? || root.nil?
+    
+      update_database_from_files root
+    end
+  
+    desc 'tags', "show the list of currently used tags"
+    long_desc <<-LONGDESC
+      `stickyflag tags` shows the list of currently used tags as present in the
+      database.  Note that this may be out of date with respect to the contents
+      of the disk, and can be refreshed using `stickyflag update`.
+    LONGDESC
+    def tags
+      say "Tags currently in use:" unless options.quiet?
+      padding = ''
+      padding = '   ' unless options.quiet?
+    
+      tag_list.each do |t|
+        say "#{padding}#{t}"
+      end
+    end
+  
+    desc 'find [TAG] [...]', "show all files that are tagged with the given tags"
+    long_desc <<-LONGDESC
+      `stickyflag find` locates all files that have a given tag or set of tags.
+      If multiple tags are provided, returned files must have all those tags.
+    LONGDESC
+    def find(*tags)
+      if tags.empty?
+        raise Thor::Error.new("stickyflag find requires at least 1 argument: \"stickyflag find [TAG] [...]\"")
+      end
+      tags.each { |t| check_tag t }
+    
+      files_for_tags(tags).each do |file|
+        say file
+      end
+    end
+  
+    private
+  
+    def check_tag(tag)
+      if tag.include? ','
+        raise Thor::Error.new("ERROR: Tag names cannot include a comma.")
+      end
+      if tag.empty?
+        raise Thor::Error.new("ERROR: Cannot set an empty tag.")
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+# -*- encoding : utf-8 -*-
+$KCODE = 'U' if RUBY_VERSION < "1.9.0"
+ENV['RSPEC_TESTING'] = 'true'
+
+require 'rubygems'
+require 'bundler/setup'
+require 'simplecov' unless ENV["CI"] == 'true'
+
+require 'backports'
+require 'rspec/autorun'
+require 'stickyflag'
+
+Dir['./spec/support/**/*.rb'].map { |f| require f }
+
+RSpec.configure do |c|
+  c.before(:each) do    
+    # Don't write anything to the console
+    Thor::Shell::Basic.any_instance.stub(:say) { }
+    Thor::Shell::Basic.any_instance.stub(:say_status) { }    
+  end
+end
+