stickyflag 0.2.0

data/spec/stickyflag_spec.rb

@@ -0,0 +1,482 @@
+# -*- encoding : utf-8 -*-
+require 'thor'
+require 'stickyflag'
+
+describe 'StickyFlag' do  
+  describe '#config' do
+    context 'without any further parameters' do
+      it 'prints out the configuration' do
+        run_with_args('config') do |sf|
+          sf.should_receive(:dump_config)
+        end
+      end
+    end
+    
+    context 'with --reset' do
+      it 'resets the configuration' do
+        run_with_args('config', '--reset') do |sf|
+          sf.should_receive(:reset_config!)
+        end
+      end
+    end
+    
+    context 'with --list' do
+      it 'prints out the configuration' do
+        run_with_args('config', '--list') do |sf|
+          sf.should_receive(:dump_config)
+        end
+      end
+
+      it 'prints out the configuration with --quiet' do
+        run_with_args('config', '--list', '--quiet') do |sf|
+          sf.should_receive(:dump_config)
+        end
+      end
+    end
+    
+    context 'with a key but no value' do
+      it 'prints the value for that configuration item' do
+        run_with_args('config', '--key', 'root') do |sf|
+          sf.set_config :root, "/usr"
+          sf.should_receive(:say).with("root: '/usr'")
+        end
+      end
+    end
+    
+    context 'with a value but no key' do
+      it 'raises an error' do
+        expect {
+          run_with_args('config', 'asdf')
+          }.to raise_error
+      end
+    end
+    
+    context 'with a key and a value' do
+      it 'sets the configuration value' do
+        run_with_args('config', '--key', 'root', '/usr') do |sf|
+          sf.set_config :root, ''
+          sf.should_receive(:set_config).with('root', '/usr')
+        end
+      end
+      
+      it 'prints the new value' do
+        run_with_args('config', '--key', 'root', '/usr') do |sf|
+          sf.set_config :root, ''
+          sf.should_receive(:say).with("'root' set to '/usr'")
+        end
+      end
+      
+      it "doesn't print out if we're given --quiet" do
+        run_with_args('config', '--key', 'root', '/usr', '--quiet') do |sf|
+          sf.set_config :root, ''
+          sf.should_not_receive(:say)          
+        end
+      end
+    end
+  end
+  
+  describe '#get' do
+    context 'with no arguments' do
+      it 'raises an error' do
+        expect {
+          run_with_args('get')
+          }.to raise_error
+      end
+    end
+    
+    context 'with a missing file' do
+      it 'prints an error message' do
+        run_with_args('get', 'bad.pdf') do |sf|
+          sf.should_receive(:say_status).with(:error, /bad\.pdf/, kind_of(Symbol))
+        end
+      end
+      
+      it 'does not print an error message with --quiet' do
+        run_with_args('get', 'bad.pdf', '--quiet') do |sf|
+          sf.should_not_receive(:say)
+          sf.should_not_receive(:say_status)
+        end
+      end
+      
+      it 'does not print an error message with --force' do
+        run_with_args('get', 'bad.pdf', '--force') do |sf|
+          sf.should_not_receive(:say)
+          sf.should_not_receive(:say_status)
+        end
+      end
+    end
+    
+    context 'with a file without tags' do
+      it 'prints a no-tags message' do
+        run_with_args('get', example_path('c_no_tags.c')) do |sf|
+          sf.should_receive(:say).with(/.*c_no_tags.c: no tags/)
+        end
+      end
+      
+      it 'does not print a no-tags message with --quiet' do
+        run_with_args('get', example_path('c_no_tags.c'), '--quiet') do |sf|
+          sf.should_not_receive(:say)
+          sf.should_not_receive(:say_status)
+        end
+      end
+
+      it 'does not print a no-tags message with --force' do
+        run_with_args('get', example_path('c_no_tags.c'), '--force') do |sf|
+          sf.should_not_receive(:say)
+          sf.should_not_receive(:say_status)
+        end
+      end
+    end
+    
+    context 'with a file with tags' do
+      it 'prints the tags' do
+        run_with_args('get', example_path('mmd_crazy_tags.mmd')) do |sf|
+          sf.should_receive(:say).with(/ asdf, /)
+        end
+      end
+      
+      it 'prints the tags with --quiet' do
+        run_with_args('get', example_path('mmd_crazy_tags.mmd'), '--quiet') do |sf|
+          sf.should_receive(:say).with(/ asdf, /)
+        end        
+      end
+
+      it 'prints the tags with --force' do
+        run_with_args('get', example_path('mmd_crazy_tags.mmd'), '--force') do |sf|
+          sf.should_receive(:say).with(/ asdf, /)
+        end        
+      end
+    end
+    
+    context 'with multiple files with tags' do
+      it 'prints all the files' do
+        run_with_args('get', example_path('mmd_crazy_tags.mmd'), example_path('c_with_tag.c')) do |sf|
+          sf.should_receive(:say).with(/mmd_crazy_tags\.mmd/)
+          sf.should_receive(:say).with(/c_with_tag\.c/)
+        end
+      end
+    end
+  end
+  
+  describe '#set' do
+    context 'with no parameters' do
+      it 'raises an error' do
+        expect {
+          run_with_args('set')
+          }.to raise_error
+      end
+    end
+    
+    context 'with just a file' do
+      it 'raises an error' do
+        expect {
+          run_with_args('set', 'bad.pdf')
+          }.to raise_error
+      end
+    end
+    
+    context 'with a good file and an invalid tag' do
+      it 'raises an error' do
+        expect {
+          run_with_args('set', __FILE__, 'asdf,asdf')
+          }.to raise_error
+      end
+      
+      it 'also raises on blank tags' do
+        expect {
+          run_with_args('set', __FILE__, '')
+          }.to raise_error
+      end
+    end
+    
+    context 'with a missing file and a good tag' do
+      it 'prints an error message' do
+        run_with_args('set', 'bad.pdf', 'asdf') do |sf|
+          sf.should_receive(:say_status).with(:error, /bad\.pdf/, :red)
+        end
+      end
+      
+      it 'does not print an error message with --quiet' do
+        run_with_args('set', 'bad.pdf', 'asdf', '--quiet') do |sf|
+          sf.should_not_receive(:say)
+          sf.should_not_receive(:say_status)
+        end
+      end
+    end
+    
+    context 'with a good file and a good tag' do
+      before(:each) do
+        @path = copy_example('c_with_tag.c')
+      end
+      after(:each) do
+        File.unlink(@path)
+      end
+      
+      it 'sets the tags' do
+        run_with_args('set', @path, 'test2')
+        run_with_args('get', @path) do |sf|
+          sf.should_receive(:say).with(/ test2/)
+        end
+      end
+      
+      it 'prints all the tags' do
+        run_with_args('set', @path, 'test2') do |sf|
+          sf.should_receive(:say_status).with(:success, /: test, test2/, :green)
+        end
+      end
+      
+      it 'prints nothing with --quiet' do
+        run_with_args('set', @path, 'test2', '--quiet') do |sf|
+          sf.should_not_receive(:say)
+          sf.should_not_receive(:say_status)
+        end
+      end
+    end
+  end
+  
+  describe '#unset' do
+    context 'with no parameters' do
+      it 'raises an error' do
+        expect {
+          run_with_args('unset')
+          }.to raise_error
+      end
+    end
+    
+    context 'with just a file' do
+      it 'raises an error' do
+        expect {
+          run_with_args('unset', 'bad.pdf')
+          }.to raise_error
+      end
+    end
+    
+    context 'with a good file and an invalid tag' do
+      it 'raises an error' do
+        expect {
+          run_with_args('unset', __FILE__, 'asdf,asdf')
+          }.to raise_error
+      end
+    end
+    
+    context 'with a missing file and a good tag' do
+      it 'prints an error message' do
+        run_with_args('unset', 'bad.pdf', 'asdf') do |sf|
+          sf.should_receive(:say_status).with(:error, /bad\.pdf/, :red)
+        end
+      end
+      
+      it 'does not print an error message with --quiet' do
+        run_with_args('unset', 'bad.pdf', 'asdf', '--quiet') do |sf|
+          sf.should_not_receive(:say)
+          sf.should_not_receive(:say_status)
+        end
+      end
+    end
+    
+    context 'with a good file and a good tag' do
+      before(:each) do
+        @path = copy_example('c_with_tag.c')
+      end
+      after(:each) do
+        File.unlink(@path)
+      end
+      
+      it 'sets the tags' do
+        run_with_args('unset', @path, 'test')
+        run_with_args('get', @path) do |sf|
+          sf.should_receive(:say).with(/ no tags/)
+        end
+      end
+      
+      it 'prints no tags' do
+        run_with_args('unset', @path, 'test') do |sf|
+          sf.should_receive(:say_status).with(:success, /: no tags/, :green)
+        end
+      end
+      
+      it 'prints nothing with --quiet' do
+        run_with_args('unset', @path, 'test', '--quiet') do |sf|
+          sf.should_not_receive(:say)
+          sf.should_not_receive(:say_status)
+        end
+      end
+    end
+    
+    context 'with a file with multiple tags' do
+      before(:each) do
+        @path = copy_example('mmd_crazy_tags.mmd')
+      end
+      after(:each) do
+        File.unlink(@path)
+      end
+      
+      it 'prints the remaining tags' do
+        run_with_args('unset', @path, 'asdf') do |sf|
+          sf.should_receive(:say_status).with(:success, /: sdfg/, :green)
+        end
+      end
+    end
+  end
+  
+  describe '#clear' do
+    context 'with no parameters' do
+      it 'raises an error' do
+        expect {
+          run_with_args('clear')
+          }.to raise_error
+      end
+    end
+    
+    context 'with a missing file' do
+      it 'prints an error message' do
+        run_with_args('clear', 'bad.pdf') do |sf|
+          sf.should_receive(:say_status).with(:error, /bad\.pdf/, :red)
+        end
+      end
+      
+      it 'does not print an error message with --quiet' do
+        run_with_args('clear', 'bad.pdf', '--quiet') do |sf|
+          sf.should_not_receive(:say)
+          sf.should_not_receive(:say_status)
+        end
+      end
+
+      it 'does not print an error message with --force' do
+        run_with_args('clear', 'bad.pdf', '--force') do |sf|
+          sf.should_not_receive(:say)
+          sf.should_not_receive(:say_status)
+        end
+      end
+    end
+    
+    context 'with a good file' do
+      before(:each) do
+        @path = copy_example('c_with_tag.c')
+      end
+      after(:each) do
+        File.unlink(@path)
+      end
+      
+      it 'clears the tags' do
+        run_with_args('clear', @path)
+        run_with_args('get', @path) do |sf|
+          sf.should_receive(:say).with(/ no tags/)
+        end
+      end
+      
+      it 'prints a success message' do
+        run_with_args('clear', @path) do |sf|
+          sf.should_receive(:say_status).with(:success, /Tags cleared for /, :green)
+        end
+      end
+      
+      it 'prints nothing with --quiet' do
+        run_with_args('unset', @path, 'test', '--quiet') do |sf|
+          sf.should_not_receive(:say)
+          sf.should_not_receive(:say_status)
+        end
+      end
+    end
+  end
+  
+  describe '#update' do
+    it 'updates in the current directory by default' do
+      run_with_args('update') do |sf|
+        sf.set_config(:root, '')
+        sf.should_receive(:update_database_from_files).with('.')
+      end
+    end
+    
+    it 'updates from the configured root dir' do
+      run_with_args('update') do |sf|
+        sf.set_config(:root, '/usr/')
+        sf.should_receive(:update_database_from_files).with('/usr/')
+      end
+    end
+  end
+  
+  describe '#tags' do
+    context 'with --quiet' do
+      it 'just prints all the tags, with no padding' do
+        run_with_args('tags', '--quiet') do |sf|
+          sf.update_database_from_files example_root
+          sf.should_receive(:say).with('asdf').once
+          sf.should_receive(:say).with(kind_of(String)).any_number_of_times
+        end
+      end
+    end
+    
+    context 'without --quiet' do
+      it 'prints an intro message and padded tags' do
+        run_with_args('tags') do |sf|
+          sf.update_database_from_files example_root
+          sf.should_receive(:say).with('Tags currently in use:').once
+          sf.should_receive(:say).with(/ ?test/).once
+          sf.should_receive(:say).with(kind_of(String)).any_number_of_times
+        end
+      end
+    end
+  end
+  
+  describe '#find' do
+    context 'with no tags' do
+      it 'raises an error' do
+        expect {
+          run_with_args('find')
+          }.to raise_error
+      end
+    end
+    
+    context 'with an invalid tag' do
+      it 'raises an error' do
+        expect {
+          run_with_args('find', 'asdf,wut')
+          }.to raise_error
+      end
+    end
+    
+    context 'with a missing tag' do
+      it 'prints a warning message' do
+        run_with_args('find', 'zuzzax') do |sf|
+          sf.update_database_from_files example_root
+          sf.should_receive(:say_status).with(:warning, /not present/, :yellow)
+        end
+      end
+      
+      it 'prints nothing with --quiet' do
+        run_with_args('find', 'zuzzax', '--quiet') do |sf|
+          sf.update_database_from_files example_root
+          sf.should_not_receive(:say)
+          sf.should_not_receive(:say_status)
+        end
+      end
+    end
+    
+    context 'with a bad boolean combo' do
+      it 'prints a warning message' do
+        run_with_args('find', 'test', 'asdf') do |sf|
+          sf.update_database_from_files example_root
+          sf.should_receive(:say_status).with(:warning, /not found/, :yellow)
+        end
+      end
+      
+      it 'prints nothing with --quiet' do
+        run_with_args('find', 'test', 'asdf', '--quiet') do |sf|
+          sf.update_database_from_files example_root
+          sf.should_not_receive(:say)
+          sf.should_not_receive(:say_status)
+        end
+      end
+    end
+    
+    context 'with a good tag' do
+      it 'prints some filenames' do
+        run_with_args('find', 'test') do |sf|
+          sf.update_database_from_files example_root
+          sf.should_receive(:say).with(/#{example_root}/).at_least(:once)
+        end
+      end
+    end
+  end
+end

data/spec/support/examples/c_all_comments.c

@@ -0,0 +1,3 @@
+// all comments
+// but no tags
+// 

data/spec/support/examples/c_no_tags.c

@@ -0,0 +1,5 @@
+// This is some example C++ code
+
+int main(int argc, char *argv[]) {
+    return 0;
+}

data/spec/support/examples/c_with_tag.c

@@ -0,0 +1,6 @@
+// SF_TAGS = test
+// This is some example C++ code
+
+int main(int argc, char *argv[]) {
+    return 0;
+}

data/spec/support/examples/mmd_all_meta.mmd

@@ -0,0 +1,6 @@
+Author:      Charles H. Pence  
+Description: This is a test of a key with a value  
+             that goes on for lots and lots of  
+             different lines and whatnot.  
+Date:        October 8, 2012  
+Other:       This file is all metadata, but has no tags  

data/spec/support/examples/mmd_crazy_keys.mmd

@@ -0,0 +1,8 @@
+Author:      Charles H. Pence  
+Description: This is a test of a key with a value  
+             that goes on for lots and lots of  
+             different lines and whatnot.  
+Tags:        test  
+Date:        October 8, 2012  
+
+This is a test MMD document.

data/spec/support/examples/mmd_crazy_tags.mmd

@@ -0,0 +1,9 @@
+Author:      Charles H. Pence  
+Description: This is a test of a key with a value  
+             that goes on for lots and lots of  
+             different lines and whatnot.  
+Tags:        asdf, sdfg, dfgh, fghj,  
+             qwer  
+Date:        October 8, 2012  
+
+This is a test MMD document.

data/spec/support/examples/mmd_no_tags.mmd

@@ -0,0 +1 @@
+This is a test MMD document.

data/spec/support/examples/mmd_with_tag.mmd

@@ -0,0 +1,3 @@
+Tags: test
+
+This is a test MMD document.

data/spec/support/examples/tex_no_tags.tex

@@ -0,0 +1,10 @@
+% This is a comment
+% Here's another comment
+
+\documentclass[10pt]{article}
+\begin{document}
+  \title{A TeX example}
+  \author{StickyFlag}
+  \date{\today}
+  \maketitle
+\end{document}

data/spec/support/examples/tex_with_tag.tex

@@ -0,0 +1,11 @@
+% SF_TAGS = test
+% This is a comment
+% Here's another comment
+
+\documentclass[10pt]{article}
+\begin{document}
+  \title{A TeX example}
+  \author{StickyFlag}
+  \date{\today}
+  \maketitle
+\end{document}

data/spec/support/examples.rb

@@ -0,0 +1,32 @@
+# -*- encoding : utf-8 -*-
+require 'fileutils'
+require 'pathname'
+require 'tmpdir'
+
+def example_root
+  File.expand_path(File.join(File.dirname(__FILE__), 'examples'))
+end
+
+def example_path(example)
+  File.expand_path(File.join(File.dirname(__FILE__), 'examples', example))
+end
+
+def copy_example(example)
+  path = example_path(example)
+  temp_path = File.expand_path(File.join(Dir.tmpdir, "temp-#{Random.rand(1000)}-#{example}"))
+  
+  # If the file doesn't exist, then just return a bad file path
+  if File.exist? path
+    counter = 0
+    while File.exist? temp_path
+      temp_path = File.expand_path(File.join(Dir.tmpdir, "temp-#{Random.rand(1000)}-#{example}"))
+      counter += 1
+    
+      raise "Cannot create temporary file" if counter >= 100
+    end
+  
+    FileUtils.cp(path, temp_path)
+  end
+  
+  temp_path
+end

data/spec/support/run_with_args.rb

@@ -0,0 +1,36 @@
+# -*- encoding : utf-8 -*-
+require 'thor'
+require 'stickyflag'
+
+class DatabaseHelper
+  def database_path
+    ":memory:"
+  end
+  
+  include StickyFlag::Database
+end
+
+def run_with_args(*args)
+  # We want to load an in-memory database ourselves, so that we can tear it
+  # down in this function (there's nowhere to hook in Thor for after the
+  # task is completed)
+  dbh = DatabaseHelper.new
+  dbh.load_database
+  database = dbh.instance_variable_get(:@database)
+  
+  StickyFlag::ThorApp.send(:dispatch, nil, args, nil, {}) do |instance|
+    # Always stub out load_ and save_config! and database_path, so that we
+    # don't tromp on the user's own private data.
+    instance.stub(:load_config!) { }
+    instance.stub(:save_config!) { }
+    
+    # Patch in the new database
+    instance.instance_variable_set(:@database, database)
+    instance.create_tables
+    
+    yield instance if block_given?
+  end
+  
+  # Clean up
+  database.disconnect
+end

data/spec/support/silence_stream.rb

@@ -0,0 +1,12 @@
+# -*- encoding : utf-8 -*-
+
+module Kernel
+  def silence_stream(stream)
+    old_stream = stream.dup
+    stream.reopen(RbConfig::CONFIG['host_os'] =~ /mswin|mingw/ ? 'NUL:' : '/dev/null')
+    stream.sync = true
+    yield
+  ensure
+    stream.reopen(old_stream)
+  end
+end