stickyflag 0.2.0

data/spec/stickyflag/configuration_spec.rb

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

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

data/spec/stickyflag/external_cmds_spec.rb

@@ -0,0 +1,175 @@
+# -*- encoding : utf-8 -*-
+require 'tmpdir'
+require 'thor'
+require 'stickyflag/paths'
+require 'stickyflag/configuration'
+require 'stickyflag/external_cmds'
+
+class ExternalCmdsTester < Thor
+  include StickyFlag::Paths
+  include StickyFlag::Configuration
+  include StickyFlag::ExternalCmds
+end
+
+describe 'StickyFlag::ExternalCmds' do
+  # We want to handle the path manually here
+  def add_to_path(file_name)
+    ENV['PATH'] = Dir.tmpdir
+    
+    path = File.join(Dir.tmpdir, file_name)
+    File.open(path, 'w:UTF-8') { |f| f.write('test') }
+    File.chmod(0755, path)
+    
+    @files_to_delete << path
+  end
+  
+  before(:each) do    
+    @files_to_delete = []
+    @old_path = ENV['PATH']
+    ENV['PATH'] = ''
+  end
+  
+  after(:each) do
+    ENV['PATH'] = @old_path
+    @files_to_delete.each { |f| File.delete f }
+  end
+  
+  describe '.find_external_cmds' do
+    describe 'with no configuration set, no pdftk' do
+      before(:each) do
+        @obj = ExternalCmdsTester.new
+        @obj.stub(:load_config!) { }
+        @obj.stub(:save_config!) { }
+        
+        @obj.set_config :pdftk_path, ''
+        @obj.set_config :have_pdftk, false
+      end
+      
+      it 'sets have_pdftk to false' do
+        @obj.find_external_cmds
+        @obj.get_config(:have_pdftk).should eq(false)
+      end
+      
+      it 'outputs a warning message' do
+        @obj.should_receive(:say_status).with(:warning, kind_of(String), kind_of(Symbol))
+        @obj.find_external_cmds
+      end
+    end
+    
+    describe 'with no configuration set, with pdftk' do
+      before(:each) do
+        @obj = ExternalCmdsTester.new
+        @obj.stub(:load_config!) { }
+        @obj.stub(:save_config!) { }
+        
+        @obj.set_config :pdftk_path, ''
+        @obj.set_config :have_pdftk, false
+        
+        add_to_path('pdftk')
+      end
+      
+      it 'sets have_pdftk to true' do
+        @obj.find_external_cmds
+        @obj.get_config(:have_pdftk).should eq(true)
+      end
+      
+      it 'sets the right pdftk path' do
+        @obj.find_external_cmds
+        
+        path = File.expand_path(File.join(Dir.tmpdir, 'pdftk'))
+        @obj.get_config(:pdftk_path).should eq(path)
+      end
+      
+      it 'should not print any messages' do
+        @obj.should_not_receive(:say)
+        @obj.should_not_receive(:say_status)
+        @obj.find_external_cmds
+      end
+    end
+    
+    describe 'with configuration set, non-executable pdftk' do
+      before(:each) do
+        @obj = ExternalCmdsTester.new
+        @obj.stub(:load_config!) { }
+        @obj.stub(:save_config!) { }
+        
+        @obj.set_config :pdftk_path, __FILE__
+        @obj.set_config :have_pdftk, true
+      end
+      
+      it 'resets have_pdftk to false' do
+        @obj.find_external_cmds
+        @obj.get_config(:have_pdftk).should be(false)
+      end
+      
+      it 'unsets the pdftk path' do
+        @obj.find_external_cmds
+        @obj.get_config(:pdftk_path).should eq('')
+      end
+      
+      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.find_external_cmds
+      end
+    end
+    
+    describe 'with configuration set, non-existent pdftk' do
+      before(:each) do
+        @obj = ExternalCmdsTester.new
+        @obj.stub(:load_config!) { }
+        @obj.stub(:save_config!) { }
+        
+        @obj.set_config :pdftk_path, '/nope/wut'
+        @obj.set_config :have_pdftk, true
+      end
+      
+      it 'resets have_pdftk to false' do
+        @obj.find_external_cmds
+        @obj.get_config(:have_pdftk).should be(false)
+      end
+      
+      it 'unsets the pdftk path' do
+        @obj.find_external_cmds
+        @obj.get_config(:pdftk_path).should eq('')
+      end
+      
+      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.find_external_cmds
+      end
+    end
+    
+    describe 'with configuration set, with pdftk' do
+      before(:each) do
+        @obj = ExternalCmdsTester.new
+        @obj.stub(:load_config!) { }
+        @obj.stub(:save_config!) { }
+        
+        @obj.set_config :pdftk_path, File.expand_path(File.join(Dir.tmpdir, 'pdftk'))
+        @obj.set_config :have_pdftk, true
+        
+        add_to_path('pdftk')
+      end
+      
+      it 'leaves have_pdftk true' do
+        @obj.find_external_cmds
+        @obj.get_config(:have_pdftk).should eq(true)
+      end
+      
+      it 'leaves the right pdftk path' do
+        @obj.find_external_cmds
+        
+        path = File.expand_path(File.join(Dir.tmpdir, 'pdftk'))
+        @obj.get_config(:pdftk_path).should eq(path)
+      end
+      
+      it 'should not print any messages' do
+        @obj.should_not_receive(:say)
+        @obj.should_not_receive(:say_status)
+        @obj.find_external_cmds
+      end
+    end
+  end
+end

data/spec/stickyflag/patches/tempfile_encoding_spec.rb

@@ -0,0 +1,26 @@
+# -*- encoding : utf-8 -*-
+require 'stickyflag/patches/tempfile_encoding'
+
+describe 'Tempfile' do
+  describe '.new_with_encoding' do
+    it 'successfully creates temporary files' do
+      f = Tempfile.new_with_encoding 'asdf'
+      f.should be
+      
+      f.unlink
+      f.close
+    end
+    
+    # JRuby <1.7.0 implements Ruby 1.9 but doesn't follow the spec for Tempfile
+    if RUBY_VERSION >= "1.9.0" && (RUBY_PLATFORM != 'java' || JRUBY_VERSION >= '1.7.0')
+      it 'sets the correct external encoding' do
+        f = Tempfile.new_with_encoding 'asdf'
+        f.external_encoding.should be
+        f.external_encoding.name.should eq('UTF-8')
+        
+        f.unlink
+        f.close
+      end
+    end
+  end
+end

data/spec/stickyflag/patches/tmpnam_spec.rb

@@ -0,0 +1,35 @@
+# -*- encoding : utf-8 -*-
+require 'fileutils'
+require 'stickyflag/patches/tmpnam'
+
+describe 'File' do
+  describe '.tmpnam' do
+    it "creates file names that don't exist" do
+      File.exist?(File.tmpnam).should be_false
+    end
+    
+    it "puts extensions on files (no dot)" do
+      path = File.tmpnam('txt')
+      path[-4..-1].should eq('.txt')
+    end
+    
+    it "puts extensions on files (with dot)" do
+      path = File.tmpnam('txt')
+      path[-4..-1].should eq('.txt')
+    end
+    
+    it "puts files in the temporary directory" do
+      File.tmpnam.should start_with(Dir.tmpdir)
+    end
+    
+    it "can create lots and lots in a row" do
+      files = []
+      (1..1000).each do |i|
+        files << File.tmpnam
+        FileUtils.touch(files.last)
+      end
+      
+      files.each { |f| File.unlink(f) }
+    end
+  end
+end