weft-qda 0.9.8 → 1.0.0

data/lib/weft.rb

@@ -1,5 +1,7 @@
+# $Header: /var/cvs/weft-qda/weft-qda/lib/weft.rb,v 1.11 2006/01/08 20:27:19 brokentoy Exp $ 
+
 # maybe if running under rubygems
-if not defined?(WEFT_SHARE_DIR)
+if not defined?(WEFT_SHAREDIR)
   WEFT_SHAREDIR = File.join( File.dirname(__FILE__), '..', 'share')
 end
 

data/lib/weft/WEFT-VERSION-STRING.rb

@@ -1 +1 @@
-WEFT_VERSION_STRING = '0.9.8a'
+WEFT_VERSION_STRING = '1.0.0'

data/lib/weft/backend/sqlite/schema.rb

@@ -1,4 +1,5 @@
 module QDA::Backend::SQLite::Schema
+  # The tables
   SCHEMA_TABLES = <<'SCHEMA_TABLES'
 CREATE TABLE category (
   catid INTEGER PRIMARY KEY,
@@ -36,6 +37,9 @@ CREATE TABLE app_preference (
   value TEXT);
 SCHEMA_TABLES
 
+  # Triggers- these currently just ensure that coding is cleaned up when a 
+  # document or category is deleted. In the future they also trigger entries 
+  # into the undo/redo table.
   SCHEMA_TRIGGERS = <<'SCHEMA_TRIGGERS'
 CREATE TRIGGER insert_category
   INSERT ON category
@@ -62,6 +66,10 @@ END;
 SCHEMA_TRIGGERS
 
   # This is here because it's written, but it's not in use yet.
+  #
+  # This is an outline of adding undo/redo facility using SQLite triggers, writing
+  # stepped actions to a undo action table, and recording SQL to restore the database
+  # to its prior state.
   SCHEMA_UNDO = <<'SCHEMA_UNDO'
 CREATE TABLE undoable ( 
   actionid INTEGER PRIMARY KEY,
@@ -117,6 +125,8 @@ BEGIN
 END;
 SCHEMA_UNDO
 
+  # Indexes - those on the coding table make a big difference to speed of
+  # retrieving marked text.
   SCHEMA_INDEXES = <<'SCHEMA_INDEXES'
 
 CREATE INDEX document_idx
@@ -130,6 +140,8 @@ ON docmeta(metaname, docid);
 
 SCHEMA_INDEXES
 
+  # model query for doing fast text searches from a reverse index
+  # (stored as categories). 
   RINDEX_SEARCH_MODEL_QUERY = <<'RINDEX_SEARCH_MODEL_QUERY'
 SELECT document.docid AS docid, document.doctitle AS doctitle,
 MAX( 0, code.offset - ?)

data/lib/weft/exceptions.rb

@@ -7,4 +7,8 @@ module QDA
   end
   class NotFoundError < StandardError
   end
-end
+  class FilterError < StandardError
+  end
+  class CalculationError < StandardError
+  end
+end

data/lib/weft/filters.rb

@@ -21,8 +21,11 @@ module QDA
     # +filename+, which should be a string.
     def import_file(klass, filename, opts = {}, &block)
       ext = filename[-3,3]
-      filter = Filters.find_import_filter(klass, ext).new()
-      import(filter, filename, &block)
+      filter_class = Filters.find_import_filter(klass, ext)
+      if not filter_class
+        raise FilterError.new("Cannot import a file of type '#{ext}'")
+      end
+      import(filter_class.new(), filename, &block)
     end
     
     def import(filter, content)

data/lib/weft/query.rb

@@ -1,4 +1,4 @@
-# A stub class modelling a boolean query expression
+# A class modelling an arbitrarily complexe boolean query expression
 module QDA
 class Query
   attr_accessor :dbid, :root
@@ -76,11 +76,11 @@ class Query
       super(app)
       case identifier
       when Category # a category specified directly
-        @identifier = identifier.path
+        @identifier = identifier.dbid
       when String # a path to a category
-        @identifier = identifier
+        @identifier = app.get_category(identifier).dbid
       when Fixnum # a category id
-        @identifier = @app.get_category(identifier, false).path
+        @identifier = identifier
       when NilClass
         raise ArgumentError.new("Unspecified category for CODED BY expression")
       else
@@ -89,14 +89,19 @@ class Query
     end
     
     def to_s()
-      "( CODED BY(#{@identifier.inspect}) )"
+      path = @app.get_category(@identifier).path
+      "( CODED BY(#{path}) )"
     end
     
     def calculate()
-      cat = @app.get_category(@identifier, false)
+      cat = @app.get_category(@identifier, false) # Will raise NotFoundError
       @app.get_text_at_category( cat )
+    rescue NotFoundError => err
+      raise CalculationError,
+            "Could not retrieve category identified by #{@identifier}"
     end
   end
+
   
   class WordSearchFunction < Function
     attr_reader :word
@@ -166,4 +171,4 @@ class Query
     end
   end
 end
-end
+end

data/lib/weft/wxgui.rb

@@ -10,7 +10,7 @@ require 'weft/wxgui/dialogs'
 require 'weft/wxgui/inspectors'
 require 'weft/wxgui/sidebar'
 require 'weft/wxgui/workarea'
-require 'weft/wxgui/error_handler.rb'
+require 'weft/wxgui/error_handler'
 
 
 module QDA
@@ -285,22 +285,21 @@ module QDA
               end
               prog.step('Saving document')
               @app.save_document(doc, true)
-              prog.step('Indexing document')
+              prog.title = "Importing document '#{doc.title}'"
+              prog.step("Indexing document '#{doc.title}'")
               indexer = QDA::WordIndexer.new()
               indexer.feed(doc)
-              prog.step('Saving indexes')
+              prog.step("Saving word indexes for '#{doc.title}'")
               wordcount = indexer.words.keys.length
               if wordcount > 0
                 prog.retarget(wordcount)
                 @app.save_reverse_index(doc.dbid, indexer.words, prog)
               end
               prog.finish()
-            rescue UserAbortedException, IOError => err
+            rescue FilterError, UserAbortedException, IOError => err
               prog.finish() if prog
               app.delete_document(doc) if doc && doc.dbid
-              MessageDialog.new(nil, err.to_s(),
-                                "Document not imported", 
-                                OK|ICON_ERROR).show_modal()
+              ErrorDialog.display( "Document not imported", err.to_s() )
               @workarea.cursor = Wx::Cursor.new(Wx::CURSOR_ARROW)
             end
           end
@@ -455,8 +454,9 @@ module QDA
       # returns true if a new project was started, false if not
 	  def on_open_project(e)
         return false unless on_close_project(e)
-		file_dialog = FileDialog.new(@workarea, "Open Project",
-										 "",  "", "Project Files (*.qdp)|*.qdp" )
+		file_dialog = FileDialog.new( @workarea, "Open Project",
+                                      "",  "", 
+                                      "Weft QDA Project Files (*.qdp)|*.qdp" )
         return false unless file_dialog.show_modal() == Wx::ID_OK
         
         open_project( file_dialog.get_path() )
@@ -528,7 +528,7 @@ module QDA
       end
 
       def on_saveas_project(e)
-        wildcard = "QDA Project Files (*.qdp)|*.qdp"
+        wildcard = "Weft QDA Project Files (*.qdp)|*.qdp"
 		file_dialog = Wx::FileDialog.new(@workarea, "Save Project As",
 										 "",  "", wildcard, Wx::SAVE)
 
@@ -565,7 +565,7 @@ module QDA
 	  end
 
 	  def on_import_n6(e)
-        wildcard = "Project Files (*.stp)|*.stp"
+        wildcard = "N6 Project Files (*.stp)|*.stp"
 		file_dialog = Wx::FileDialog.new(@workarea, "Import N6 Project", "",  
                                          "", wildcard )
 		if file_dialog.show_modal() == Wx::ID_OK

data/lib/weft/wxgui/controls/category_tree.rb

@@ -54,7 +54,7 @@ module QDA::GUI
     def delete(id)
       super(id)
       del_cat = data.delete(id)
-      if del_cat.parent and old_parent_id = value_to_ident(del_cat.parent)
+      if del_cat.parent && old_parent_id = value_to_ident(del_cat.parent)
         set_item_data( old_parent_id, 
                        @client.app.get_category(del_cat.parent.dbid) )
       end        
@@ -194,9 +194,11 @@ module QDA::GUI
 
       movee = get_item_data( from )
       destination = get_item_data( to )
+      # if for some reason these tree ids didn't correspond to categories...
+      return dont_move(from) unless movee and destination
       # don't move root nodes
       return dont_move(from) if not movee.parent
-      # ignore if no move
+      # ignore if no move - target is same as current parent
       return dont_move(from) if movee.parent == destination
       # don't attach to descendants
       return dont_move(from) if destination.is_descendant_of?(movee)
@@ -218,14 +220,27 @@ module QDA::GUI
     # of the node.
     def move_item(from, to)
       # don't alter if unchanged
-      return from if get_item_parent(from) == to
-      new_child = append_item(to, get_item_text(from), get_item_data(from))
+      from_parent = get_item_parent(from)
+      return from if from_parent == to
+
+      # remember expanded-or-collapsed state
+      reexpand = expanded?(from_parent)
+
+      # create a new tree item under the new parent
+      new_child = append_item(to, get_item_text(from),
+      get_item_data(from))
+
+      # recursively move all children underneath to the new node
       child = get_first_child(from)[0]
       while child != 0
         move_item(child, new_child)
         child = get_first_child(from)[0]
       end
+
+      # restore my visibility settings
+      expand(to) if reexpand
       delete( from )
+      
       new_child
     end
 
@@ -311,4 +326,4 @@ module QDA::GUI
       select_item(id)
     end
   end
-end
+end

data/lib/weft/wxgui/dialogs.rb

@@ -172,7 +172,7 @@ module QDA::GUI
                                      filt::EXTENSIONS, 
                                      filt::EXTENSIONS ] }.join('|')
       super(parent, Lang::IMPORT_DOC_DIALOGUE_TITLE,
-			"",  "", wildcard, Wx::MULTIPLE)
+			"",  "", wildcard, Wx::MULTIPLE|Wx::FILE_MUST_EXIST)
     end
     
     # return each selected file in turn into a block, passing in +path+ and 

data/lib/weft/wxgui/error_handler.rb

@@ -40,19 +40,21 @@ class CrashReportDialog < Wx::Dialog
    end
     
   def crash_details()
-    @crash ||= { 'when' => Time.now.to_s(),
-                 'os'   => Config::CONFIG['target_os'],
-                 'config' => Config::CONFIG['build'], 
+    @crash ||= { 'when'         => Time.now.to_s(),
+                 'os'           => Config::CONFIG['target_os'],
+                 'config'       => Config::CONFIG['build'],
+                 'weft_version' => WEFT_VERSION_STRING,
                  'ruby_version' => [ Config::CONFIG['MAJOR'], 
                                      Config::CONFIG['MINOR'], 
                                      Config::CONFIG['TEENY'] ].join('.'),
-                 'rs2exe' => rs2exe,
-                 'backtrace' => ( [ err.inspect ] + 
-                                    err.backtrace ).join("\n") }
+                 'rs2exe'       => rs2exe,
+                 'backtrace'    => ( [ err.inspect ] + 
+                                       err.backtrace ).join("\n") }
   end
   
   def crash_details_string
-    %w[when os config ruby_version rs2exe backtrace].inject('') do | str, key |
+    %w[when weft_version os config 
+       ruby_version rs2exe backtrace].inject('') do | str, key |
       str << "#{key}: #{crash_details[key]}\n"
     end
   end

data/lib/weft/wxgui/inspectors.rb

@@ -177,9 +177,13 @@ module QDA::GUI
 
     # implements keyboard shortcuts for this window - these are activated by
     # interaction with the text-box.
-    # currently, CTRL-k is mapped to "Code" and CTRL-l is mapped to "Uncode"
+    # currently, 
+    #  CTRL-m is mapped to "Mark" 
+    #  CTRL-, is mapped to "Unmark"
+    #  CTRL-f is mapped to "Start find"
+
     def on_key_down(evt)
-      return unless evt.control_down()
+      return evt.skip() unless evt.control_down()
       case evt.key_code()
       when 70 # "f"
         @text_box.start_find(self) if @text_box.respond_to?(:start_find)
@@ -188,6 +192,8 @@ module QDA::GUI
       when 44 # ","
         on_uncode(evt)
       end
+      # required so default shortcuts like CTRL-C, CTRL-V work
+      evt.skip()
     end
 
     # the current category active in this window

data/lib/weft/wxgui/inspectors/query.rb

@@ -80,8 +80,12 @@ module QDA::GUI
       @last_query = query
       set_cursor( Wx::BUSY_CURSOR )
       @last_results = @last_query.calculate()
-      set_cursor( Wx::NORMAL_CURSOR )
       return @last_results
+    rescue QDA::CalculationError => err
+      ErrorDialog.display("Error computing query", err.to_s)
+      return @last_results = QDA::FragmentTable.new()
+    ensure
+      set_cursor( Wx::NORMAL_CURSOR )
     end
 
     def get_target_argument(offset, as_string = false)
@@ -143,7 +147,9 @@ module QDA::GUI
     def on_save_results(e)
       # check for saved results
       Wx::BusyCursor.busy do
-        results = get_results( get_query )
+        query   = get_query()
+        return unless query
+        results = get_results( query )
         return unless results
         @text_box.populate(results)
       end

data/lib/weft/wxgui/lang/en.rb

@@ -52,7 +52,8 @@ Are you sure you want to proceed?"
     DELETE_CATEGORY_TITLE= "Confirm category deletion"
     DELETE_CATEGORY_WARNING = 
 "The category '%s' will permanently deleted, along with its memo and 
-any coding associated with it. 
+any coding associated with it. Any categories attached underneath this
+category in the tree will also be deleted. 
 
 Are you sure you want to proceed?"
     

data/test/003-code.rb

@@ -336,6 +336,13 @@ class TestCode < Test::Unit::TestCase
     
     sets = tbl.sets
     assert_equal(1, sets.length)
+    
+    tbl_2 = CodingTable.new()
+    result = tbl_2.merge(tbl)
+    assert( tbl_2.key?(3) )
+    assert_equal(1, tbl_2.num_of_docs)
+    assert_equal(6, tbl_2.num_of_chars)
+    assert_equal(1, tbl_2.num_of_codes)
   end
 
   def test_fragment_table

data/test/005-query_review.rb

@@ -101,16 +101,26 @@ class TestQuery < Test::Unit::TestCase
 
   
   
-  def test_or
+  def test_and
     cs_1 = CodingTable.new()
     cs_2 = CodingTable.new()
+    
     cs_1.add( Code.new(3, 0, 4) )
+    expr = Query::AND.new(cs_1, cs_2)
+    result = expr.calculate()
+    
+    assert_equal(0, result.num_of_docs)
+    assert_equal(0, result.num_of_chars)
+    assert_equal(0, result.num_of_passages)
+    
     cs_2.add( Code.new(3, 3, 5) )
     expr = Query::AND.new(cs_1, cs_2)
     result = expr.calculate()
     assert_equal(1, result.num_of_docs)
     assert_equal(1, result.num_of_chars)
     assert_equal(1, result.num_of_passages)
+    
+    # empty OR
   end
   
   def test_and_not
@@ -129,6 +139,13 @@ class TestQuery < Test::Unit::TestCase
     cs_1 = CodingTable.new()
     cs_2 = CodingTable.new()
     cs_1.add( Code.new(3, 0, 4) )
+  
+    expr = Query::OR.new(cs_1, cs_2)
+    result = expr.calculate()
+    assert_equal(1, result.num_of_docs)
+    assert_equal(4, result.num_of_chars)
+    assert_equal(1, result.num_of_passages)
+    
     cs_2.add( Code.new(3, 3, 5) )
     expr = Query::OR.new(cs_1, cs_2)
     result = expr.calculate()

data/test/007-output_filters.rb

@@ -37,7 +37,9 @@ class TestFilter < Test::Unit::TestCase
   
   def test_export_document()
     doc = Document.new('foo')
-    doc.append('blah blah blah')
+    doc.memo = 'The memo'
+    doc << "First paragraph blah blah\n\n"
+    doc << "Second paragraph bar baz qux\n\n"
     filter = Filters::DocumentTextOutput.new()
     
     tmp = Tempfile.new('doc_text')
@@ -45,7 +47,21 @@ class TestFilter < Test::Unit::TestCase
     tmp.rewind()
     contents = tmp.read()
     # Proper template not written yet
-    # assert_match(/blah/m, contents, 'Looks a bit like the document')
+    assert_match(/foo/m, contents, 'Looks a bit like the document with title')
+    assert_match(/blah/m, contents, 'Looks a bit like the document')
+    assert_match(/qux/m, contents, 'Looks a bit like the document')
+    
+    filter = Filters::DocumentHTMLOutput.new()
+    
+    tmp = Tempfile.new('doc_text')
+    filter.write(doc, tmp)
+    tmp.rewind()
+    contents = tmp.read()
+    puts contents
+    # Proper template not written yet
+    assert_match(/<h1>foo<\/h1>/m, contents, 'Looks a bit like the document with title')
+    assert_match(/blah/m, contents, 'Looks a bit like the document')
+    assert_match(/qux/m, contents, 'Looks a bit like the document')
   end
   
   def test_export_category()

data/test/009c_backend_sqlite_bench.rb

@@ -43,7 +43,7 @@ class TestSQLiteBenchmark < Test::Unit::TestCase
 	doc.append("This is various text that'll be used for testing")
 	doc.append("Some more text with different letters?")
 
-    measure('Save Document', 25) do 
+    measure('Save Document', 100) do 
       doc.dbid = nil
       @app.save_document(doc, true)
     end
@@ -67,7 +67,7 @@ class TestSQLiteBenchmark < Test::Unit::TestCase
 	@app.install_clean()
     
 	catparent = nil
-    measure('Save Category', 25) do 
+    measure('Save Category', 100) do 
       cat = QDA::Category.new("About 'Something'", catparent, 'the "memo"')
       @app.save_category(cat)
       catparent = cat

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.10
 specification_version: 1
 name: weft-qda
 version: !ruby/object:Gem::Version 
-  version: 0.9.8
-date: 2006-01-04
+  version: 1.0.0
+date: 2006-02-17
 summary: GUI Qualitative Data Analysis Tool.
 require_paths: 
   - lib