stickyflag 0.2.0

data/spec/stickyflag/paths_spec.rb

@@ -0,0 +1,29 @@
+# -*- encoding : utf-8 -*-
+require 'stickyflag/paths'
+
+class PathsTester
+  include StickyFlag::Paths
+end
+
+describe 'StickyFlag::Paths' do
+  describe '.config_path' do
+    it 'includes the config.yml file name' do
+      PathsTester.new.config_path.should include('config.yml')
+    end
+    
+    it "doesn't include any tildes" do
+      PathsTester.new.config_path.should_not include('~')
+    end
+  end
+  
+  describe '.database_path' do
+    it 'includes the db.sqlite file name' do
+      PathsTester.new.database_path.should include('db.sqlite')
+    end
+    
+    it "doesn't include any tildes" do
+      PathsTester.new.database_path.should_not include('~')
+    end
+  end
+end
+

data/spec/stickyflag/tag_factory_spec.rb

@@ -0,0 +1,185 @@
+# -*- encoding : utf-8 -*-
+require 'thor'
+require 'stickyflag/patches/tempfile_encoding'
+require 'stickyflag/paths'
+require 'stickyflag/configuration'
+require 'stickyflag/tag_factory'
+require 'stickyflag/external_cmds'
+require 'stickyflag/database'
+
+class TagFactoryTester < Thor
+  include StickyFlag::Paths
+  include StickyFlag::Configuration
+  include StickyFlag::TagFactory
+  include StickyFlag::ExternalCmds
+  include StickyFlag::Database
+end
+
+describe 'StickyFlag::TagFactory' do
+  before(:each) do
+    @obj = TagFactoryTester.new
+    
+    @obj.stub(:load_config!) { }
+    @obj.stub(:save_config!) { }
+    
+    @obj.stub(:load_database) { }
+    @obj.stub(:update_database_from_files) { }
+    @obj.stub(:set_database_tag) { }
+    @obj.stub(:unset_database_tag) { }
+    @obj.stub(:clear_database_tags) { }
+    @obj.stub(:files_for_tags) { [] }
+    
+    @obj.find_external_cmds
+  end
+  
+  describe '.available_tagging_extensions' do
+    # Some extensions require the presence of actual, good files, not
+    # just empty shells, so we can't test them in this way.  Skip those.
+    CANNOT_TEST = [ '.pdf', '.png' ]
+    
+    it 'should call get for every good extension' do
+      (@obj.available_tagging_extensions - CANNOT_TEST).each do |ext|
+        file = Tempfile.new_with_encoding(['ext', ext])
+        file.puts('test')        
+        file.close
+        
+        expect { @obj.get_tags_for(file.path) }.to_not raise_error
+        file.unlink
+      end
+    end
+    
+    it 'should call get for other extensions' do
+      CANNOT_TEST.each do |ext|
+        path = copy_example "#{ext[1..-1]}_with_tag#{ext}"
+        expect { @obj.clear_tags_for(path) }.to_not raise_error
+        File.unlink(path)
+      end
+    end
+
+    it 'should call set/unset for every good extension' do
+      (@obj.available_tagging_extensions - CANNOT_TEST).each do |ext|
+        file = Tempfile.new_with_encoding(['ext', ext])
+        file.puts('test')        
+        file.close
+        
+        expect { 
+          @obj.set_tag_for(file.path, 'test')
+          @obj.unset_tag_for(file.path, 'test')
+          }.to_not raise_error
+        file.unlink
+      end
+    end
+    
+    it 'should call set/unset for other extensions' do
+      CANNOT_TEST.each do |ext|
+        path = copy_example "#{ext[1..-1]}_with_tag#{ext}"
+        expect {
+          @obj.set_tag_for(path, 'test2')
+          @obj.unset_tag_for(path, 'test2')
+          }.to_not raise_error
+        File.unlink(path)
+      end
+    end
+    
+    it 'should call clear for every good extension' do
+      (@obj.available_tagging_extensions - CANNOT_TEST).each do |ext|
+        file = Tempfile.new_with_encoding(['ext', ext])
+        file.puts('test')        
+        file.close
+        
+        expect { @obj.clear_tags_for(file.path) }.to_not raise_error
+        file.unlink
+      end
+    end
+    
+    it 'should call clear for other extensions' do
+      CANNOT_TEST.each do |ext|
+        path = copy_example "#{ext[1..-1]}_with_tag#{ext}"
+        expect { @obj.clear_tags_for(path) }.to_not raise_error
+        File.unlink(path)
+      end
+    end
+  end
+  
+  describe '.get_tags_for' do
+    it 'should delegate to PDF' do
+      path = example_path('pdf_no_tags.pdf')
+      
+      StickyFlag::Tags::PDF.should_receive(:get).with(path, kind_of(String))
+      @obj.get_tags_for(path)
+    end
+    
+    it 'should raise error for unknown extensions' do
+      expect {
+        @obj.get_tags_for('asdf.zzy')
+        }.to raise_error(Thor::Error)
+    end
+  end
+
+  describe '.set_tag_for' do
+    it 'should delegate to PDF' do
+      path = example_path('pdf_no_tags.pdf')
+      
+      StickyFlag::Tags::PDF.should_receive(:set).with(path, 'lol', kind_of(String))
+      @obj.set_tag_for(path, 'lol')
+    end
+    
+    it 'should not call through if the tag is already set' do
+      path = example_path('pdf_with_tag.pdf')
+      
+      StickyFlag::Tags::PDF.should_not_receive(:set)
+      @obj.set_tag_for(path, 'test')
+    end
+    
+    it 'should raise error for unknown extensions' do
+      @obj.stub(:get_tags_for) { [] }
+      expect {
+        @obj.set_tag_for('asdf.zzy', 'lol')
+        }.to raise_error(Thor::Error)
+    end
+  end
+  
+  describe '.unset_tag_for' do
+    it 'should delegate to PDF' do
+      path = copy_example('pdf_with_tag.pdf')
+      
+      StickyFlag::Tags::PDF.should_receive(:unset).with(path, 'test', kind_of(String))
+      @obj.unset_tag_for(path, 'test')
+      
+      File.delete(path)
+    end
+    
+    it 'should not call through if the tag is not set' do
+      path = example_path('pdf_no_tags.pdf')
+      
+      StickyFlag::Tags::PDF.should_not_receive(:unset)
+      expect {
+        @obj.unset_tag_for(path, 'test')
+        }.to raise_error(Thor::Error)
+    end
+    
+    it 'should raise error for unknown extensions' do
+      @obj.stub(:get_tags_for) { [ 'lol' ] }
+      expect {
+        @obj.unset_tag_for('asdf.zzy', 'lol')
+        }.to raise_error(Thor::Error)
+    end
+  end
+
+  describe '.clear_tags_for' do
+    it 'should delegate to PDF' do
+      path = copy_example('pdf_with_tag.pdf')
+      
+      StickyFlag::Tags::PDF.should_receive(:clear).with(path, kind_of(String))
+      @obj.clear_tags_for(path)
+      
+      File.delete(path)
+    end
+    
+    it 'should raise error for unknown extensions' do
+      expect {
+        @obj.clear_tags_for('asdf.zzy')
+        }.to raise_error(Thor::Error)
+    end
+  end
+end

data/spec/stickyflag/tags/c_spec.rb

@@ -0,0 +1,14 @@
+# -*- encoding : utf-8 -*-
+require 'stickyflag/tags/c'
+
+describe StickyFlag::Tags::C do
+  it_behaves_like 'a tag handler'
+  
+  it 'can open a file with all comments and no tags' do
+    ret = nil
+    expect {
+     ret = StickyFlag::Tags::C.get(example_path('c_all_comments.c'))
+     }.to_not raise_error
+   ret.should be_empty
+  end
+end

data/spec/stickyflag/tags/mmd_spec.rb

@@ -0,0 +1,40 @@
+# -*- encoding : utf-8 -*-
+require 'stickyflag/tags/mmd'
+
+describe StickyFlag::Tags::MMD do
+  it_behaves_like 'a tag handler'
+  
+  it 'handles multiline metadata documents' do
+    StickyFlag::Tags::MMD.get(example_path('mmd_crazy_keys.mmd')).should include('test')
+  end
+  
+  it 'handles multiline tag documents' do
+    StickyFlag::Tags::MMD.get(example_path('mmd_crazy_tags.mmd')).should include('sdfg')
+  end
+  
+  it 'handles all-metadata documents' do
+    StickyFlag::Tags::MMD.get(example_path('mmd_all_meta.mmd')).should be_empty   
+  end
+  
+  it 'can edit multiline metadata documents' do
+    path = copy_example('mmd_crazy_keys.mmd')
+    
+    StickyFlag::Tags::MMD.set(path, 'test2')
+    StickyFlag::Tags::MMD.get(path).should include('test2')
+    
+    File.open(path, 'r:UTF-8').each_line.to_a.should include("Tags:        test, test2  \n")
+    
+    File.delete path
+  end    
+  
+  it 'can edit multiline tag documents' do
+    path = copy_example('mmd_crazy_tags.mmd')
+    
+    StickyFlag::Tags::MMD.set(path, 'test2')
+    StickyFlag::Tags::MMD.get(path).should include('test2')
+    
+    File.open(path, 'r:UTF-8').each_line.to_a.should include("Tags:        asdf, sdfg, dfgh, fghj, qwer, test2  \n")
+    
+    File.delete path
+  end
+end

data/spec/stickyflag/tags/pdf_spec.rb

@@ -0,0 +1,39 @@
+# -*- encoding : utf-8 -*-
+require 'stickyflag/tags/pdf'
+require 'stickyflag/paths'
+require 'stickyflag/configuration'
+require 'stickyflag/external_cmds'
+
+class GetConfiguration
+  include StickyFlag::Paths
+  include StickyFlag::Configuration
+  include StickyFlag::ExternalCmds
+end
+
+describe StickyFlag::Tags::PDF do
+  it_behaves_like 'a tag handler' do
+    let(:params) {
+      config = GetConfiguration.new
+      config.stub(:load_config!) { }
+      config.stub(:save_config!) { }
+
+      config.find_external_cmds
+      
+      [ config.get_config(:pdftk_path) ]
+    }
+  end
+  
+  context 'with a bad pdftk path' do
+    it 'raises errors for everything' do
+      expect { StickyFlag::Tags::PDF.get(example_path("pdf_with_tag.pdf"), '/wut/bad') }.to raise_error(Thor::Error)
+      expect { StickyFlag::Tags::PDF.clear(example_path("pdf_with_tag.pdf"), '/wut/bad') }.to raise_error(Thor::Error)
+
+      # If get doesn't succeed, we won't get all the way into set or unset
+      # with the bad pdftk path.
+      StickyFlag::Tags::PDF.stub(:get) { [ 'test' ] }
+      expect { StickyFlag::Tags::PDF.set(example_path("pdf_with_tag.pdf"), 'test2', '/wut/bad') }.to raise_error(Thor::Error)
+      expect { StickyFlag::Tags::PDF.unset(example_path("pdf_with_tag.pdf"), 'test', '/wut/bad') }.to raise_error(Thor::Error)
+      StickyFlag::Tags::PDF.unstub(:get)
+    end
+  end
+end

data/spec/stickyflag/tags/png_spec.rb

@@ -0,0 +1,6 @@
+# -*- encoding : utf-8 -*-
+require 'stickyflag/tags/png'
+
+describe StickyFlag::Tags::PNG do
+  it_behaves_like 'a tag handler'
+end

data/spec/stickyflag/tags/tex_spec.rb

@@ -0,0 +1,6 @@
+# -*- encoding : utf-8 -*-
+require 'stickyflag/tags/tex'
+
+describe StickyFlag::Tags::TeX do
+  it_behaves_like 'a tag handler'
+end