stickyflag 0.3.0 → 0.3.1

data/features/support/cukegem.rb

@@ -1,82 +0,0 @@
-# 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

@@ -1,37 +0,0 @@
-# -*- 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

@@ -1,18 +0,0 @@
-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

@@ -1,14 +0,0 @@
-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

@@ -1,23 +0,0 @@
-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/spec/spec_helper.rb

@@ -1,22 +0,0 @@
-# -*- 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
-

data/spec/stickyflag/configuration_spec.rb

@@ -1,132 +0,0 @@
-# -*- encoding : utf-8 -*-
-require 'stickyflag/paths'
-require 'stickyflag/configuration'
-
-class ConfigTester < Thor
-  include StickyFlag::Paths
-  include StickyFlag::Configuration
-end
-
-describe 'StickyFlag::Configuration' do  
-  describe '#initialize' do
-    it 'loads default configuration values' do
-      @obj = ConfigTester.new
-      @obj.stub(:load_config!) { }
-      @obj.stub(:save_config!) { }
-      
-      StickyFlag::Configuration::DEFAULT_CONFIG.keys.each do |k|        
-        @obj.get_config(k).should eq(StickyFlag::Configuration::DEFAULT_CONFIG[k])
-      end
-    end
-  end
-  
-  describe '.get_config' do
-    before(:each) do      
-      @obj = ConfigTester.new
-      
-      @obj.stub(:load_config!) { }
-      @obj.stub(:save_config!) { }
-    end
-    
-    context 'with good keys' do
-      it 'reads default values' do
-        @obj.get_config(:have_pdftk).should eq(false)
-      end
-    
-      it 'reads updated values' do
-        @obj.set_config :have_pdftk, true
-        @obj.get_config(:have_pdftk).should eq(true)
-      end
-    end
-    
-    context 'with bad keys' do
-      it 'raises an error on get' do
-        expect { @obj.get_config(:bad_key) }.to raise_error
-      end
-      
-      it 'raises an error on set' do
-        expect { @obj.set_config(:bad_key, 'test') }.to raise_error
-      end
-    end
-  end
-  
-  describe '.reset_config!' do
-    before(:each) do      
-      @obj = ConfigTester.new
-      
-      @obj.stub(:load_config!) { }
-      @obj.stub(:save_config!) { }
-      
-      @obj.set_config :have_pdftk, true
-    end
-    
-    it 'resets changed values to defaults' do
-      @obj.reset_config!
-      @obj.get_config(:have_pdftk).should eq(false)
-    end
-  end
-  
-  describe '.dump_config' do
-    before(:each) do
-      @obj = ConfigTester.new
-      
-      @obj.stub(:load_config!) { }
-      @obj.stub(:save_config!) { }
-      
-      @obj.set_config :pdftk_path, 'wut'
-    end
-    
-    it 'prints out the set configuration values' do
-      @obj.stub(:say) {}
-      @obj.should_receive(:say).with(/pdftk_path: 'wut'/)
-      @obj.dump_config
-    end
-  end
-  
-  describe '.load_config!' do
-    before(:each) do      
-      @obj = ConfigTester.new
-      
-      @obj.stub(:save_config!) { }
-
-      @config_file = File.join(File.dirname(__FILE__), 'config.yml')
-      @obj.stub(:config_path) { @config_file }      
-    end
-    
-    it 'should load from the requested YAML file' do
-      config = {
-        :have_pdftk => true,
-        :pdftk_path => 'wut'
-      }
-      File.open(@config_file, 'w:UTF-8') do |f|
-        YAML.dump(config, f)
-      end
-      
-      @obj.load_config!
-      @obj.get_config(:pdftk_path).should eq('wut')
-      
-      File.delete(@config_file)
-    end
-  end
-  
-  describe '.save_config!' do
-    before(:each) do      
-      @obj = ConfigTester.new
-      
-      @obj.stub(:load_config!) { }
-
-      @config_file = File.join(File.dirname(__FILE__), 'config.yml')
-      @obj.stub(:config_path) { @config_file }      
-    end
-    
-    it 'should save to the requested YAML file' do
-      @obj.set_config :pdftk_path, 'wut'
-      @obj.save_config!
-      
-      config = YAML::load(File.open(@config_file, 'r:UTF-8'))
-      config[:pdftk_path].should eq('wut')
-      
-      File.delete(@config_file)
-    end
-  end
-end

data/spec/stickyflag/database_spec.rb

@@ -1,331 +0,0 @@
-# -*- encoding : utf-8 -*-
-require 'stickyflag/paths'
-require 'stickyflag/configuration'
-require 'stickyflag/external_cmds'
-require 'stickyflag/tag_factory'
-require 'stickyflag/database'
-
-class DatabaseTester < Thor
-  include StickyFlag::Paths
-  include StickyFlag::Configuration
-  include StickyFlag::ExternalCmds
-  include StickyFlag::TagFactory
-  include StickyFlag::Database
-end
-
-describe 'StickyFlag::Database' do
-  before(:each) do
-    @obj = DatabaseTester.new
-    
-    @obj.stub(:load_config!) { }
-    @obj.stub(:save_config!) { }
-    @obj.stub(:database_path) { ":memory:" }
-    
-    @obj.find_external_cmds
-    @obj.load_database
-    
-    # Save this out for (lots of) later use
-    @database = @obj.instance_variable_get(:@database)
-  end
-  
-  after(:each) do
-    # We've disabled automatic cleanup, so make sure we do this
-    @database.disconnect
-  end
-  
-  describe '.load_database' do
-    it 'sets the member variable' do
-      @database.should be
-    end
-  end
-  
-  describe '.update_database_from_files' do
-    context 'without a specific directory' do
-      before(:each) do
-        @obj.update_database_from_files
-      end
-      
-      it 'has some files in the database' do
-        @database[:tagged_files].should_not be_empty
-      end
-      
-      it 'has found the test and asdf tags' do
-        @obj.tag_list.should include('asdf')
-        @obj.tag_list.should include('test')
-      end
-      
-      it 'has found a sample markdown file' do
-        path = example_path 'mmd_crazy_keys.mmd'
-        @obj.files_for_tags(['test']).map { |f| File.expand_path(f) }.should include(path)
-      end
-    end
-    
-    context 'with an empty directory' do
-      before(:each) do
-        @dir = File.tmpnam('.dir')
-        Dir.mkdir(@dir)
-        
-        @obj.update_database_from_files(@dir)
-      end
-      
-      after(:each) do
-        Dir.rmdir(@dir)
-      end
-      
-      it 'has no files in the database' do
-        @database[:tagged_files].should be_empty
-      end
-    end
-    
-    context 'with some bad files in the directory' do
-      before(:each) do
-        @dir = File.tmpnam('.dir')
-        Dir.mkdir(@dir)
-        
-        file = File.new(File.join(@dir, 'bad.pdf'), 'w:UTF-8')
-        file.puts('test bad')
-        file.close
-      end
-      
-      after(:each) do
-        File.unlink(File.join(@dir, 'bad.pdf'))
-        Dir.rmdir(@dir)
-      end
-      
-      it 'does not throw an exception' do
-        expect { @obj.update_database_from_files(@dir) }.to_not raise_error
-      end
-      
-      it 'prints a warning' do
-        @obj.should_receive(:say_status).with(:warning, kind_of(String), kind_of(Symbol))
-        @obj.update_database_from_files(@dir)
-      end
-    end
-    
-    context 'with a full directory' do
-      before(:each) do
-        @obj.update_database_from_files(example_root)
-      end
-      
-      it 'has some files in the database' do
-        @database[:tagged_files].should_not be_empty
-      end
-      
-      it 'has found the test and asdf tags' do
-        @obj.tag_list.should include('asdf')
-        @obj.tag_list.should include('test')
-      end
-      
-      it 'has found a sample markdown file' do
-        path = example_path 'mmd_crazy_keys.mmd'
-        @obj.files_for_tags(['test']).map { |f| File.expand_path(f) }.should include(path)
-      end
-    end
-  end
-  
-  describe '.set_database_tag' do
-    context 'with an already extant tag' do
-      before(:each) do
-        @obj.update_database_from_files example_root
-        @path = example_path 'mmd_with_tag.mmd'
-        @obj.set_database_tag(@path, 'asdf')
-      end
-      
-      it "adds the record for the tagged file" do
-        file_id = @database[:file_list].where(:file_name => @path).get(:id)
-        file_id.should_not be_nil
-        
-        tag_id = @database[:tag_list].where(:tag_name => 'asdf').get(:id)
-        tag_id.should_not be_nil
-        
-        ds = @database[:tagged_files].where(:file => file_id).and(:tag => tag_id)
-        ds.should_not be_empty
-        ds.count.should eq(1)
-      end
-      
-      it "doesn't duplicate the entry for the tag" do
-        ds = @database[:tag_list].where(:tag_name => 'asdf')
-        ds.count.should eq(1)
-      end
-    end
-    
-    context 'with a new tag' do
-      before(:each) do
-        @obj.update_database_from_files example_root
-        @path = example_path 'mmd_with_tag.mmd'
-        @obj.set_database_tag(@path, 'zuzzax')
-      end
-      
-      it "adds a new record for the new tag" do
-        ds = @database[:tag_list].where(:tag_name => 'zuzzax')
-        ds.should_not be_empty
-        ds.count.should eq(1)
-      end
-      
-      it "adds the record for the tagged file" do
-        file_id = @database[:file_list].where(:file_name => @path).get(:id)
-        file_id.should_not be_nil
-        
-        tag_id = @database[:tag_list].where(:tag_name => 'zuzzax').get(:id)
-        tag_id.should_not be_nil
-        
-        ds = @database[:tagged_files].where(:file => file_id).and(:tag => tag_id)
-        ds.should_not be_empty
-        ds.count.should eq(1)
-      end
-    end
-  end
-  
-  describe '.unset_database_tag' do
-    context 'with a multiply-present tag' do
-      before(:each) do
-        @obj.update_database_from_files example_root
-        @path = example_path 'mmd_with_tag.mmd'
-      end
-      
-      it 'removes the record for the tagged file' do
-        @obj.unset_database_tag(@path, 'test')
-        
-        file_id = @database[:file_list].where(:file_name => @path).get(:id)
-        file_id.should_not be_nil
-        
-        tag_id = @database[:tag_list].where(:tag_name => 'test').get(:id)
-        tag_id.should_not be_nil
-        
-        ds = @database[:tagged_files].where(:file => file_id).and(:tag => tag_id)
-        ds.should be_empty
-      end
-    end
-    
-    context 'with a singly-present tag' do
-      before(:each) do
-        @obj.update_database_from_files example_root
-        @path = example_path 'mmd_crazy_tags.mmd'
-      end
-      
-      it 'removes the record for the tagged file' do        
-        file_id = @database[:file_list].where(:file_name => @path).get(:id)
-        file_id.should_not be_nil
-        
-        tag_id = @database[:tag_list].where(:tag_name => 'qwer').get(:id)
-        tag_id.should_not be_nil
-
-        @obj.unset_database_tag(@path, 'qwer')
-        
-        ds = @database[:tagged_files].where(:file => file_id).and(:tag => tag_id)
-        ds.should be_empty
-      end
-      
-      it 'removes the record of the tag' do
-        @obj.unset_database_tag(@path, 'qwer')
-        ds = @database[:tag_list].where(:tag_name => 'qwer')
-        ds.should be_empty
-      end
-    end
-  end
-  
-  describe '.clear_database_tags' do
-    before(:each) do
-      @obj.update_database_from_files example_root
-      @path = example_path 'mmd_crazy_tags.mmd'
-      @obj.clear_database_tags(@path)
-    end
-    
-    it 'removes all tag records for the file' do
-      file_id = @database[:file_list].where(:file_name => @path).get(:id)
-      file_id.should_not be_nil
-      
-      ds = @database[:tagged_files].where(:file => file_id)
-      ds.should be_empty
-    end
-    
-    it 'removes the tag after clearing single-instance tags' do
-      ds = @database[:tag_list].where(:tag_name => 'qwer')
-      ds.should be_empty
-    end
-  end
-  
-  describe '.files_for_tags' do
-    before(:each) do
-      @obj.update_database_from_files example_root
-    end
-    
-    context 'with good, single tags' do
-      it 'includes one of the markdown files' do
-        path = example_path 'mmd_crazy_keys.mmd'
-        @obj.files_for_tags([ 'test' ]).should include(path)
-      end
-    
-      it 'does not include files that lack a tag' do
-        path = example_path 'mmd_with_tag.mmd'
-        @obj.files_for_tags([ 'asdf' ]).should_not include(path)
-      end
-    
-      it 'does not include untaggable files' do
-        path = example_path 'untaggable.txt'
-        @obj.files_for_tags([ 'test' ]).should_not include(path)
-      end
-    end
-    
-    context 'with multiple tags' do
-      it 'combines with boolean AND' do
-        path1 = example_path 'mmd_crazy_tags.mmd'
-        path2 = example_path 'mmd_with_tag.mmd'
-      
-        files = @obj.files_for_tags([ 'sdfg', 'asdf', 'qwer' ])
-        files.should include(path1)
-        files.should_not include(path2)
-      end
-      
-      it 'prints a warning if no files have all those tags' do
-        @obj.should_receive(:say_status).with(:warning, kind_of(String), kind_of(Symbol))
-        @obj.files_for_tags([ 'asdf', 'test' ])
-      end
-      
-      it 'returns an empty array if no files have all those tags' do
-        @obj.files_for_tags([ 'asdf', 'test' ]).should be_empty
-      end
-    end
-    
-    context 'with missing tags' do
-      it "doesn't throw" do
-        expect { @obj.files_for_tags([ 'zuzzax' ]) }.to_not raise_error
-      end
-
-      it 'prints a warning' do
-        @obj.should_receive(:say_status).with(:warning, kind_of(String), kind_of(Symbol))
-        @obj.files_for_tags([ 'zuzzax' ])
-      end
-    
-      it 'returns an empty array' do
-        @obj.files_for_tags([ 'zuzzax', 'test' ]).should be_empty
-      end
-    end
-  end
-  
-  describe '.tag_list' do
-    context 'prior to loading anything into the database' do
-      it 'is empty' do
-        @obj.tag_list.should be_empty
-      end
-    end
-    
-    context 'after loading files into the database' do
-      before(:each) do
-        @obj.update_database_from_files example_root
-      end
-      
-      it 'includes multiply-present tags' do
-        @obj.tag_list.should include('test')
-      end
-      
-      it 'includes singly-present tags' do
-        @obj.tag_list.should include('qwer')
-      end
-      
-      it 'does not include absent tags' do
-        @obj.tag_list.should_not include('zuzzax')
-      end
-    end
-  end
-end