stickyflag 0.2.0

data/.gitignore

@@ -0,0 +1,7 @@
+Gemfile.lock
+
+pkg
+spec/coverage
+tmp
+
+*.gem

data/.rspec

@@ -0,0 +1,4 @@
+--require thor
+--require spec_helper
+--colour
+--order random

data/.simplecov

@@ -0,0 +1,9 @@
+SimpleCov.start do
+  coverage_dir '/spec/coverage'
+  add_filter '/spec/'
+
+  add_group 'Frontend', 'bin'
+  add_group 'Library code', 'lib'
+  add_group 'File taggers', 'lib/tags'
+  add_group 'Core patches', 'lib/patches'
+end

data/.travis.yml

@@ -0,0 +1,13 @@
+language: ruby
+before_install:
+    - sudo apt-get update -qq
+    - sudo apt-get install -qq pdftk
+script: "bundle exec rake"
+
+env:
+    - CI=true
+rvm:
+    - 1.9.3
+    - 1.8.7
+    - ree
+    - jruby-19mode

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+gemspec

data/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright (c) 2012 Charles H. Pence
+
+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,49 @@
+
+# StickyFlag
+
+*file tagging for everyone*
+
+## 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.
+
+StickyFlag solves this problem.  It lets you set tags on all your files, and then search across all those files quickly, by storing tags in a database.  But it doesn't just keep the tags in the database -- it saves the tags *directly into the files.*  So your tags stick with your files, even if your StickyFlag database becomes corrupted, or you want to sync your files via Dropbox over to a different machine.
+
+## TL;DR
+
+* Set tags on a wide variety of files
+* Save those tags *in the files themselves*
+* Also save those tags in a database for searching
+
+## What can it tag?
+
+StickyFlag can currently tag:
+
+* MultiMarkdown files
+* PDF files (with `pdftk` installed; see below)
+* PNG 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).
+
+## How do I get it?
+
+`gem install stickyflag`
+
+## How do I use it?
+
+* `stickyflag get [FILE] [...]`: Query the tags from a list of files
+* `stickyflag set [FILE] [TAG]`: Set the given tag on the given file
+* `stickyflag unset [FILE] [TAG]`: Remove the given tag from the given file
+* `stickyflag clear [FILE]`: Remove all the tags from the given file
+* `stickyflag update`: Refresh the information in the tag database from your files on disk
+* `stickyflag tags`: Print a list of all the tags currently in use in all of your files
+* `stickyflag find [TAG] [...]`: List all files that are tagged with *all* of the listed tags
+
+`stickyflag update` will run from the current directory, or can run from a user-specified "root" directory, which can be set via calling `stickyflag config`.  `stickyflag config` can also be used to set a couple of other configuration values, like the path to your `pdftk` executable.
+
+## Who did this?
+
+StickyFlag is authored by [Charles Pence](http://charlespence.net) and released under the MIT license.

data/Rakefile

@@ -0,0 +1,19 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+require 'cucumber'
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = 'features --quiet'
+end
+
+
+task :default do
+  Rake::Task[:spec].execute
+  if RUBY_PLATFORM != 'java'
+    Rake::Task[:features].execute
+  end
+end

data/TODO.md

@@ -0,0 +1,3 @@
+# TODO
+
+- Add tag handlers: JPEG, MMD

data/bin/stickyflag

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+# -*- encoding : utf-8 -*-
+$KCODE = 'U' if RUBY_VERSION < "1.9.0"
+require 'rubygems'
+require 'stickyflag'
+StickyFlag::ThorApp.start

data/features/clear.feature

@@ -0,0 +1,14 @@
+Feature: Clear File Tags
+  In order to reset the tags on a file
+  As a user with some tagged files
+  I want to be able to clear all the file's tags
+  
+  Scenario: Clear tags from a tagged file
+    Given the example configuration
+    When I clear the tags for "mmd_crazy_tags.mmd"
+    Then the output should match /Tags cleared for .*mmd_crazy_tags\.mmd/
+  
+  Scenario: Clear tags from an untagged file
+    Given the example configuration
+    When I clear the tags for "mmd_no_tags.mmd"
+    Then the output should match /Tags cleared for .*mmd_no_tags\.mmd/

data/features/clear_quietly.feature

@@ -0,0 +1,23 @@
+Feature: Silence Extraneous Output on Clear
+  In order to use StickyFlag in scripts
+  As a power user
+  I want to be able to clear tags without any output at all
+  
+  Scenario: Clear tags without worrying about missing tags or files
+    Given the example configuration
+    When I quietly clear the tags for "mmd_crazy_tags.mmd", "mmd_no_tags.mmd", and "nonexistent.mmd"
+    Then the output should not contain "mmd_crazy_tags.mmd"
+      And the output should not contain "mmd_no_tags.mmd"
+      And the output should not contain "nonexistent.mmd"
+  
+  Scenario: Determine quiet tag clear success from return value
+    Given the example configuration
+    Given PENDING: figure out how to get Thor to do exit codes
+    When I quietly clear the tags for "mmd_crazy_tags.mmd"
+    Then the exit status should be 0
+  
+  Scenario: Determine quiet tag clear failure from return value
+    Given the example configuration
+    Given PENDING: figure out how to get Thor to do exit codes
+    When I quietly clear the tags for "nonexistent.mmd"
+    Then the exit status should not be 0

data/features/configuration.feature

@@ -0,0 +1,14 @@
+Feature: Persistent Configuration
+  In order to customize the behavior of StickyFlag
+  As a new user
+  I want to be able to set persistent configuration values
+  
+  Scenario: Set and query a configuration value
+    Given a clean configuration
+    When I set the configuration key "root" to "/test/"
+      And I get the configuration key "root"
+    Then the output should contain "root: '/test/'"
+  
+  Scenario: Query a previously set configuration value
+    When I get the configuration key "root"
+    Then the output should contain "root: '/test/'"

data/features/get.feature

@@ -0,0 +1,14 @@
+Feature: Get File Tags
+  In order to know what tags I have set on a file
+  As a user with some tagged files
+  I want to be able to query the file tags
+  
+  Scenario: Get tags from a tagged file
+    Given the example configuration
+    When I get the tags for "mmd_crazy_tags.mmd"
+    Then the output should contain "mmd_crazy_tags.mmd: asdf, sdfg, dfgh, fghj, qwer"
+  
+  Scenario: Get tags from an untagged file
+    Given the example configuration
+    When I get the tags for "mmd_no_tags.mmd"
+    Then the output should contain "mmd_no_tags.mmd: no tags"

data/features/get_quietly.feature

@@ -0,0 +1,23 @@
+Feature: Silence Extraneous Output on Get
+  In order to use StickyFlag in scripts
+  As a power user
+  I want to be able to get tags without extra output
+  
+  Scenario: Get tags without worrying about missing tags or files
+    Given the example configuration
+    When I quietly get the tags for "mmd_crazy_tags.mmd", "mmd_no_tags.mmd", and "nonexistent.mmd"
+    Then the output should contain "mmd_crazy_tags.mmd: asdf, sdfg, dfgh, fghj, qwer"
+      And the output should not contain "mmd_no_tags.mmd"
+      And the output should not contain "nonexistent.mmd"
+  
+  Scenario: Determine quiet tag get success from return value
+    Given the example configuration
+    Given PENDING: figure out how to get Thor to do exit codes
+    When I quietly get the tags for "mmd_crazy_tags.mmd"
+    Then the exit status should be 0
+  
+  Scenario: Determine quiet tag get failure from return value
+    Given the example configuration
+    Given PENDING: figure out how to get Thor to do exit codes
+    When I quietly get the tags for "nonexistent.mmd"
+    Then the exit status should not be 0

data/features/set.feature

@@ -0,0 +1,14 @@
+Feature: Set File Tags
+  In order to keep track of my files
+  As a user
+  I want to be able to set new tags on files
+  
+  Scenario: Set tags on an already tagged file
+    Given the example configuration
+    When I set the tag "test2" for "mmd_crazy_tags.mmd"
+    Then the output should match /New tags for .*mmd_crazy_tags.mmd: asdf, sdfg, dfgh, fghj, qwer, test2/
+  
+  Scenario: Set tags on an untagged file
+    Given the example configuration
+    When I set the tag "test" for "mmd_no_tags.mmd"
+    Then the output should match /New tags for .*mmd_no_tags.mmd: test/

data/features/set_quietly.feature

@@ -0,0 +1,22 @@
+Feature: Silence Extraneous Output on Set
+  In order to use StickyFlag in scripts
+  As a power user
+  I want to be able to set tags without any output at all
+
+  Scenario: Set tags with no output at all
+    Given the example configuration
+    When I quietly set the tag "test2" for "mmd_crazy_tags.mmd"
+    Then the output should not contain "mmd_crazy_tags.mmd"
+      And the output should not contain "test2"
+  
+  Scenario: Determine quiet set tag success from return value
+    Given the example configuration
+    Given PENDING: figure out how to get Thor to do exit codes
+    When I quietly set the tag "test2" for "mmd_crazy_tags.mmd"
+    Then the exit status should be 0
+  
+  Scenario: Determine quiet set tag failure from return value
+    Given the example configuration
+    Given PENDING: figure out how to get Thor to do exit codes
+    When I quietly set the tag "test" for "nonexistent.mmd"
+    Then the exit status should not be 0

data/features/step_definitions/configuration_steps.rb

@@ -0,0 +1,31 @@
+# -*- encoding : utf-8 -*-
+require 'rspec/expectations'
+require 'cucumber/formatter/unicode'
+require 'aruba/cucumber'
+require_relative '../../spec/support/examples'
+
+Given /a clean configuration/ do
+  FileUtils.rm $paths.config_path if File.exist? $paths.config_path
+end
+
+Given /the example configuration/ do
+  path = example_root
+  
+  steps %Q{
+    Given a clean configuration
+    When I run `stickyflag config -k root '#{path}'`
+    And I run `stickyflag update`
+  }
+end
+
+When /I set the configuration key "(.*?)" to "(.*?)"$/ do |key, val|
+  steps %Q{
+    When I run `stickyflag config -k '#{key}' '#{val}'`
+  }
+end
+
+When /I get the configuration key "(.*?)"$/ do |key|
+  steps %Q{
+    When I run `stickyflag config -k '#{key}'`
+  }
+end

data/features/step_definitions/database_steps.rb

@@ -0,0 +1,41 @@
+# -*- encoding : utf-8 -*-
+require 'rspec/expectations'
+require 'cucumber/formatter/unicode'
+require 'aruba/cucumber'
+
+Given /a clean database/ do
+  FileUtils.rm $paths.database_path if File.exist? $paths.database_path
+end
+
+Given /the example database/ do
+  steps %Q{
+    Given the example configuration
+    When I run `stickyflag update`
+  }
+end
+
+Given /I update the database in the directory "(.*?)"$/ do |dir|
+  steps %Q{
+    When I set the configuration key "root" to "#{dir}"
+    When I run `stickyflag update`
+  }
+end
+
+When /I get the list of tags in use/ do
+  steps %Q{
+    When I run `stickyflag tags`
+  }
+end
+
+When /I quietly get the list of tags in use/ do
+  steps %Q{
+    When I run `stickyflag tags --quiet`
+  }
+end
+
+When /I search for the tag (".*?")$/ do |tag_strings|
+  tags = tag_strings.scan(/"([^"]+?)"/).flatten
+  steps %Q{
+    When I run `stickyflag find #{tags.join(' ')}`
+  }
+end

data/features/step_definitions/pending_steps.rb

@@ -0,0 +1,5 @@
+# -*- encoding : utf-8 -*-
+
+Given /^PENDING/ do
+  pending
+end

data/features/step_definitions/tag_steps.rb

@@ -0,0 +1,62 @@
+# -*- encoding : utf-8 -*-
+require 'rspec/expectations'
+require 'cucumber/formatter/unicode'
+require 'aruba/cucumber'
+require 'backports'
+require_relative '../../spec/support/examples'
+
+When /I get the tags for (".*?")$/ do |filename_strings|
+  filenames = filename_strings.scan(/"([^"]+?)"/).flatten.map { |f| "'#{example_path(f).to_s}'" }
+  steps %Q{
+    When I run `stickyflag get #{filenames.join(' ')}`
+  }
+end
+
+When /I quietly get the tags for (".*?")$/ do |filename_strings|
+  filenames = filename_strings.scan(/"([^"]+?)"/).flatten.map { |f| "'#{example_path(f).to_s}'" }
+  steps %Q{
+    When I run `stickyflag get #{filenames.join(' ')} --quiet`
+  }
+end
+
+When /I set the tag "(.*?)" for "(.*?)"$/ do |tag, filename|
+  path = copy_example(filename)
+  steps %Q{
+    When I run `stickyflag set '#{path}' '#{tag}'`
+  }
+end
+
+When /I quietly set the tag "(.*?)" for "(.*?)"$/ do |tag, filename|
+  path = copy_example(filename)
+  steps %Q{
+    When I run `stickyflag set '#{path}' '#{tag}' --quiet`
+  }
+end
+
+When /I unset the tag "(.*?)" for "(.*?)"$/ do |tag, filename|
+  path = copy_example(filename)
+  steps %Q{
+    When I run `stickyflag unset '#{path}' '#{tag}'`
+  }
+end
+
+When /I quietly unset the tag "(.*?)" for "(.*?)"$/ do |tag, filename|
+  path = copy_example(filename)
+  steps %Q{
+    When I run `stickyflag unset '#{path}' '#{tag}' --quiet`
+  }
+end
+
+When /I clear the tags for (".*?")$/ do |filename_strings|
+  filenames = filename_strings.scan(/"([^"]+?)"/).flatten.map { |f| "'#{copy_example(f).to_s}'" }
+  steps %Q{
+    When I run `stickyflag clear #{filenames.join(' ')}`
+  }
+end
+
+When /I quietly clear the tags for (".*?")$/ do |filename_strings|
+  filenames = filename_strings.scan(/"([^"]+?)"/).flatten.map { |f| "'#{copy_example(f).to_s}'" }
+  steps %Q{
+    When I run `stickyflag clear #{filenames.join(' ')} --quiet`
+  }
+end

data/features/support/cukegem.rb

@@ -0,0 +1,82 @@
+# Copyright 2011 Solano Labs All Rights Reserved
+
+require 'aruba'
+require 'aruba/api'
+
+class CukeGem
+  @setup_done = false
+
+  class << self
+    include Aruba::Api
+
+    attr_reader :setup_done
+
+    def setup(gemspec, once=true)
+      gem_home = setup_env
+      if !@setup_done || !once then
+        @setup_done = true
+        mkgemdir(gem_home)
+        gem_install(gemspec)
+      end
+    end
+
+    def teardown
+      restore_env
+    end
+
+    def setup_env
+      tid = ENV['TDDIUM_TID'] || ''
+      gem_home = File.expand_path(File.join(Dir.tmpdir, "aruba-gem"))
+
+      set_env('GEM_HOME', gem_home)
+      set_env('GEM_PATH', gem_home)
+      set_env('BUNDLE_PATH', gem_home)
+      unset_bundler_env_vars
+
+      paths = (ENV['PATH'] || "").split(File::PATH_SEPARATOR)
+      paths.unshift(File.join(gem_home, 'bin'))
+      set_env('PATH', paths.uniq.join(File::PATH_SEPARATOR))
+
+      return gem_home
+    end
+
+    def mkgemdir(gem_home)
+      FileUtils::rm_rf(gem_home)
+      FileUtils::mkdir_p(gem_home)
+
+      output = `gem install bundler`
+      if $?.exitstatus != 0 then
+        raise "unable to install bundler into #{gem_home}: #{output}"
+      end
+    end
+
+    def gem_install(gemspec)
+      gem_file = nil
+      begin
+        pwd = Dir.pwd
+        gemspec_dir = File.dirname(gemspec)
+        Dir.chdir(gemspec_dir)
+        output = `gem build #{File.basename(gemspec)}`
+        Dir.chdir(pwd)
+
+        if $?.exitstatus != 0 then
+          raise "unable to build gem: #{output}"
+        end
+
+        if output =~ /File:\s+([A-Za-z0-9_.-]+[.]gem)/ then
+          gem_file = $1
+          output = `gem install #{File.join(gemspec_dir, gem_file)}`
+          if $?.exitstatus != 0 then
+            raise "unable to install gem: #{output}"
+          end
+        else
+          raise "garbled gem build output: #{output}"
+        end
+      ensure
+        if gem_file then
+          FileUtils.rm_f(File.join(gemspec_dir, gem_file))
+        end
+      end
+    end
+  end
+end

data/features/support/env.rb

@@ -0,0 +1,37 @@
+# -*- encoding : utf-8 -*-
+$:.unshift File.expand_path("../../../lib", __FILE__)
+
+require 'rubygems'
+require 'bundler/setup'
+
+require 'backports'
+require 'aruba/cucumber'
+require 'stickyflag'
+require 'fileutils'
+require_relative './cukegem'
+
+# JRuby is slow to start up
+Before do
+  @aruba_timeout_seconds = 10
+end
+
+# Back up and restore the user's configuration and database
+$backup_db = File.tmpnam('.sqlite')
+$backup_config = File.tmpnam('.yml')
+
+class GetPaths
+  include StickyFlag::Paths
+end
+$paths = GetPaths.new
+
+FileUtils.mv $paths.config_path, $backup_config if File.exist? $paths.config_path
+FileUtils.mv $paths.database_path, $backup_db if File.exist? $paths.database_path
+
+CukeGem.setup(File.expand_path('../../../stickyflag.gemspec', __FILE__))
+
+at_exit do
+  CukeGem.teardown
+  
+  FileUtils.mv $backup_config, $paths.config_path if File.exist? $backup_config
+  FileUtils.mv $backup_db, $paths.database_path if File.exist? $backup_db
+end

data/features/tags.feature

@@ -0,0 +1,18 @@
+Feature: Get List of Tags in Use
+  In order to know which tags I've already used
+  As a user with some tagged files
+  I want to be able to get a list of all file tags
+  
+  Scenario: Get list of tags
+    Given the example database
+    When I get the list of tags in use
+    Then the output should contain "   test"
+      And the output should contain "   asdf"
+      And the output should contain "Tags currently in use:"
+      And the output should not contain "rspec"
+    
+  Scenario: Get bare list of tags for scripting
+    Given the example database
+    When I quietly get the list of tags in use
+    Then the output should not contain "Tags currently in use:"
+      And the output should contain "\ntest\n"

data/features/unset.feature

@@ -0,0 +1,14 @@
+Feature: Unset File Tags
+  In order to be able to change my mind
+  As a user
+  I want to be able to unset or remove tags from files
+  
+  Scenario: Unset tags from a file with multiple tags
+    Given the example configuration
+    When I unset the tag "asdf" for "mmd_crazy_tags.mmd"
+    Then the output should match /New tags for .*mmd_crazy_tags.mmd: sdfg, dfgh, fghj, qwer/
+  
+  Scenario: Unset tags from a file with one tag
+    Given the example configuration
+    When I unset the tag "test" for "mmd_with_tag.mmd"
+    Then the output should match /New tags for .*mmd_with_tag.mmd: no tags/

data/features/unset_quietly.feature

@@ -0,0 +1,23 @@
+Feature: Silence Extraneous Output on Unset
+  In order to use StickyFlag in scripts
+  As a power user
+  I want to be able to unset tags without any output at all
+
+  Scenario: Unset tags with no output at all
+    Given the example configuration
+    When I quietly unset the tag "asdf" for "mmd_crazy_tags.mmd"
+    Then the output should not contain "mmd_crazy_tags.mmd"
+      And the output should not contain "sdfg"
+  
+  Scenario: Determine quiet unset tag success from return value
+    Given the example configuration
+    Given PENDING: figure out how to get Thor to do exit codes
+    When I quietly unset the tag "asdf" for "mmd_crazy_tags.mmd"
+    Then the exit status should be 0
+  
+  Scenario: Determine quiet unset tag failure from return value
+    Given the example configuration
+    Given PENDING: figure out how to get Thor to do exit codes
+    When I quietly unset the tag "test" for "nonexistent.mmd"
+    Then the exit status should not be 0
+    

data/lib/stickyflag/configuration.rb

@@ -0,0 +1,66 @@
+# -*- encoding : utf-8 -*-
+require 'thor'
+require 'yaml'
+require 'stickyflag/paths'
+
+module StickyFlag
+  module Configuration
+    DEFAULT_CONFIG = {
+      :have_pdftk => false,
+      :pdftk_path => '',
+      :root => ''
+    }
+  
+    def get_config(key)
+      @configuration ||= DEFAULT_CONFIG.clone
+  
+      unless @configuration.keys.include?(key.to_sym)
+        raise Thor::Error.new('ERROR: Invalid configuration key') 
+      end
+    
+      @configuration[key.to_sym]
+    end
+  
+    def set_config(key, value)
+      @configuration ||= DEFAULT_CONFIG.clone
+  
+      unless @configuration.keys.include?(key.to_sym)
+        raise Thor::Error.new('ERROR: invalid configuration key')
+      end
+    
+      @configuration[key.to_sym] = value
+    end
+  
+    def reset_config!
+      @configuration = DEFAULT_CONFIG.clone
+      save_config!
+    end
+  
+    def dump_config
+      @configuration ||= DEFAULT_CONFIG.clone
+  
+      return if options.quiet?
+    
+      say "StickyFlag Configuration:"
+      @configuration.each do |key, val|
+        say "  #{key}: '#{val}'"
+      end
+    end
+  
+    def load_config!
+      file_name = config_path
+      if File.file? file_name
+        @configuration = YAML::load(File.open(file_name, 'r:UTF-8'))
+      end
+    end
+  
+    def save_config!
+      @configuration ||= DEFAULT_CONFIG.clone
+  
+      file_name = config_path
+      File.open(file_name, 'w:UTF-8') do |f|
+        YAML.dump(@configuration, f)
+      end
+    end
+  end
+end