optimus-ep 0.6.91 → 0.8.0

data/spec/spec_helper.rb

@@ -1,33 +1,95 @@
 # Part of the Optimus package for managing E-Prime data
 # 
-# Copyright (C) 2008 Board of Regents of the University of Wisconsin System
+# Copyright (C) 2008-09 Board of Regents of the University of Wisconsin System
 # 
 # Written by Nathan Vack <njvack@wisc.edu>, at the Waisman Laborotory for Brain
 # Imaging and Behavior, University of Wisconsin - Madison
 
-module EprimeTestHelper
+module OptimusTestHelper
   
-  class RoundTrip
-    def initialize(expected)
+  class ParseAs
+    def initialize(parse_str, expected)
+      @parse_str = parse_str
       @expected = expected
     end
     
     def matches?(target)
-      @parsed = target.parse(@expected).to_s
-      @parsed == @expected
+      @parsed = target.parse(@parse_str).to_s
+      return (@parsed == @expected)
     end
     
     def failure_message
-      "expected #{@parsed} to parse to #{@expected}"
+      "expected #{@parse_str} to parse to #{@expected}, got #{@parsed}"
     end
     
     def negative_failure_message
-      "Expected #{@parsed} to not parse to #{@expected}"
+      "expected #{@parse_str} not to parse to #{@expected}."
     end
   end
   
+  def parse_as(parse_str, expected)
+    ParseAs.new(parse_str, expected)
+  end
+  
   def round_trip(expected)
-    RoundTrip.new(expected)
+    ParseAs.new(expected, expected)
+  end
+  
+  class ParseSuccessfully
+    def initialize(expected)
+      @expected = expected
+    end
+    
+    def matches?(target)
+      begin
+        @parsed = target.parse(@expected)
+      rescue RParsec::ParserException => e
+        @message = e.message
+        return false
+      end
+      return true
+    end
+    
+    def failure_message
+      "expected #{@expected} to parse; raised #{@message}"
+    end
+    
+    def negative_failure_message
+      "expected #{@expected} not to parse"
+    end
+  end
+  
+  def parse_successfully(expected)
+    ParseSuccessfully.new(expected)
+  end
+  
+  class EvaluateTo
+    def initialize(expected)
+      @expected = expected
+    end
+    
+    def matches?(target)
+      @target = target
+      @result = target.evaluate
+      return ((@result == @expected) or (is_NaN(@result) and is_NaN(@expected)))
+    end
+    
+    def failure_message
+      "#{@target.to_s} expected to evaluate to #{@expected.inspect}; actual: #{@result.inspect}"
+    end
+
+    def negative_failure_message
+      "#{@target.to_s} expected to NOT evaluate to #{@expected}"
+    end
+    
+    private
+    def is_NaN(obj)
+      obj.respond_to? :nan? and obj.nan?
+    end
+  end
+  
+  def evaluate_to(expected)
+    EvaluateTo.new(expected)
   end
   
   unless constants.include?('SAMPLE_DIR')
@@ -40,6 +102,7 @@ module EprimeTestHelper
     UNKNOWN_FILE = File.join(SAMPLE_DIR, 'unknown_type.txt')
     UNREADABLE_FILE = File.join(SAMPLE_DIR, 'unreadable_file')
     CORRUPT_LOG_FILE = File.join(SAMPLE_DIR, 'corrupt_log_file.txt')
+    UTF16LE_FILE = File.join(SAMPLE_DIR, 'optimus_log_utf16le.txt')
     
     
     STD_COLUMNS = ["ExperimentName", "Subject", "Session", "RFP.StartTime", "BlockTitle", "PeriodA", "CarriedVal[Session]", "BlockList", "Trial", 
@@ -75,8 +138,8 @@ module EprimeTestHelper
   end
   
   
-  def mock_eprime(col_count, row_count)
-    data = Eprime::Data.new()
+  def mock_optimus(col_count, row_count)
+    data = Optimus::Data.new()
     1.upto(row_count) do |rownum|
       row = data.add_row
       1.upto(col_count) do |colnum|
@@ -90,7 +153,7 @@ module EprimeTestHelper
   end
   
   def mock_edata
-    data = Eprime::Data.new()
+    data = Optimus::Data.new()
     row = data.add_row
     row['stim_time'] = '3188'
     row['run_start'] = '2400'

data/spec/tabfile_parser_spec.rb

@@ -1,62 +1,62 @@
 # Part of the Optimus package for managing E-Prime data
 # 
-# Copyright (C) 2008 Board of Regents of the University of Wisconsin System
+# Copyright (C) 2008-09 Board of Regents of the University of Wisconsin System
 # 
 # Written by Nathan Vack <njvack@wisc.edu>, at the Waisman Laborotory for Brain
 # Imaging and Behavior, University of Wisconsin - Madison
 
 require File.join(File.dirname(__FILE__),'spec_helper')
-require File.join(File.dirname(__FILE__), '../lib/eprime')
-include EprimeTestHelper
+require File.join(File.dirname(__FILE__), '../lib/optimus')
+include OptimusTestHelper
 
 
-shared_examples_for "Eprime::Reader::TabfileParser with sample data" do
-  it "should generate and Eprime::Data object" do
-    @eprime.should be_an_instance_of(Eprime::Data)
+shared_examples_for "Optimus::Reader::TabfileParser with sample data" do
+  it "should generate and Optimus::Data object" do
+    @optimus.should be_an_instance_of(Optimus::Data)
   end
 
   it "should have columns matching the test set" do
-    @eprime.columns.sort.should == STD_COLUMNS.sort
+    @optimus.columns.sort.should == STD_COLUMNS.sort
   end
 
   it "should contain three rows" do
-    @eprime.length.should == 3
+    @optimus.length.should == 3
   end
 end
 
-describe Eprime::Reader::TabfileParser do
+describe Optimus::Reader::TabfileParser do
   
   describe "without column order specified" do
     before :each do
       @file = File.open(EXCEL_FILE, 'r')
-      @reader = Eprime::Reader::TabfileParser.new(@file, :skip_lines => 1)
-      @eprime = @reader.to_eprime
+      @reader = Optimus::Reader::TabfileParser.new(@file, :skip_lines => 1)
+      @optimus = @reader.to_optimus
     end
     
-    it_should_behave_like "Eprime::Reader::TabfileParser with sample data"
+    it_should_behave_like "Optimus::Reader::TabfileParser with sample data"
   end
   
   describe "with column order specified" do
     before :each do
       @file = File.open(EXCEL_FILE, 'r')
-      @reader = Eprime::Reader::TabfileParser.new(@file, :skip_lines => 1, :columns => SORTED_COLUMNS)
-      @eprime = @reader.to_eprime
+      @reader = Optimus::Reader::TabfileParser.new(@file, :skip_lines => 1, :columns => SORTED_COLUMNS)
+      @optimus = @reader.to_optimus
     end
    
-    it_should_behave_like "Eprime::Reader::TabfileParser with sample data"
+    it_should_behave_like "Optimus::Reader::TabfileParser with sample data"
     
   end
   
   describe "with data missing from some rows" do
     before :each do
       @file = File.open(BAD_EXCEL_FILE, 'r')
-      @reader = Eprime::Reader::TabfileParser.new(@file, :skip_lines => 1)
+      @reader = Optimus::Reader::TabfileParser.new(@file, :skip_lines => 1)
     end
     
     it "should raise an error when parsing" do
       lambda {
-        @reader.to_eprime
-      }.should raise_error(Eprime::DamagedFileError)
+        @reader.to_optimus
+      }.should raise_error(Optimus::DamagedFileError)
     end
   end
 end

data/spec/tabfile_writer_spec.rb

@@ -1,34 +1,34 @@
 # Part of the Optimus package for managing E-Prime data
 # 
-# Copyright (C) 2008 Board of Regents of the University of Wisconsin System
+# Copyright (C) 2008-09 Board of Regents of the University of Wisconsin System
 # 
 # Written by Nathan Vack <njvack@wisc.edu>, at the Waisman Laborotory for Brain
 # Imaging and Behavior, University of Wisconsin - Madison
 
 require File.join(File.dirname(__FILE__),'spec_helper')
-require File.join(File.dirname(__FILE__), '../lib/eprime')
+require File.join(File.dirname(__FILE__), '../lib/optimus')
 require 'stringio'
 
-include EprimeTestHelper
+include OptimusTestHelper
 
 E_ROWS = 3
 E_COLS = 4
 
-describe "Eprime::TabfileWriter" do
+describe "Optimus::TabfileWriter" do
   
   before :each do
-    @eprime_data = mock_eprime(E_COLS, E_ROWS)
+    @optimus_data = mock_optimus(E_COLS, E_ROWS)
     @out_s = StringIO.new
   end
   
   it "should succeed at writing" do
-    writer = Eprime::TabfileWriter.new(@eprime_data, @out_s)
+    writer = Optimus::TabfileWriter.new(@optimus_data, @out_s)
     writer.write
   end
   
   describe "without filename line" do
     before :each do
-      @writer = Eprime::TabfileWriter.new(@eprime_data, @out_s)
+      @writer = Optimus::TabfileWriter.new(@optimus_data, @out_s)
       @writer.write
       @out_s.rewind
     end
@@ -51,7 +51,7 @@ describe "Eprime::TabfileWriter" do
       def @out_s.path # Redefine this so we can test the first line trick
         'spec_test'
       end
-      @writer = Eprime::TabfileWriter.new(@eprime_data, @out_s, :write_top_line => true)
+      @writer = Optimus::TabfileWriter.new(@optimus_data, @out_s, :write_top_line => true)
       @writer.write
       @out_s.rewind
     end
@@ -68,7 +68,7 @@ describe "Eprime::TabfileWriter" do
   
   describe "with good output columns specified" do
     before :each do
-      @writer = Eprime::TabfileWriter.new(@eprime_data, @out_s, :columns => ['col_2'])
+      @writer = Optimus::TabfileWriter.new(@optimus_data, @out_s, :columns => ['col_2'])
       @writer.write
       @out_s.rewind
     end
@@ -84,20 +84,20 @@ describe "Eprime::TabfileWriter" do
   describe "with nonexistent output column specified" do
 
     it "should raise an error when specifying a nonexistent column" do
-      @writer = Eprime::TabfileWriter.new(@eprime_data, @out_s, :columns => ['KITTEH'])
+      @writer = Optimus::TabfileWriter.new(@optimus_data, @out_s, :columns => ['KITTEH'])
       lambda { @writer.write }.should raise_error(IndexError)
     end
   end
   
   describe "with column_labels set to false" do
     before :each do
-      @writer = Eprime::TabfileWriter.new(@eprime_data, @out_s, {:column_labels => false})
+      @writer = Optimus::TabfileWriter.new(@optimus_data, @out_s, {:column_labels => false})
       @writer.write
       @out_s.rewind
     end
     
     it "should not write a line with column labels" do
-      @out_s.readlines.size.should == @eprime_data.size
+      @out_s.readlines.size.should == @optimus_data.size
     end
     
   end

data/spec/transformers/basic_transformer_spec.rb

@@ -1,6 +1,6 @@
 # Part of the Optimus package for managing E-Prime data
 # 
-# Copyright (C) 2008 Board of Regents of the University of Wisconsin System
+# Copyright (C) 2008-09 Board of Regents of the University of Wisconsin System
 # 
 # Written by Nathan Vack <njvack@wisc.edu>, at the Waisman Laborotory for Brain
 # Imaging and Behavior, University of Wisconsin - Madison
@@ -8,12 +8,12 @@
 # All of the complex behavior is exercised in 
 
 require File.join(File.dirname(__FILE__),'..','spec_helper')
-require File.join(File.dirname(__FILE__),'../../lib/eprime')
+require File.join(File.dirname(__FILE__),'../../lib/optimus')
 require File.join('transformers/basic_transformer')
-include EprimeTestHelper
-include Eprime::Transformers
+include OptimusTestHelper
+include Optimus::Transformers
 
-describe Eprime::Transformers::BasicTransformer do
+describe Optimus::Transformers::BasicTransformer do
   before :each do
     @data = mock_edata
     @xf = BasicTransformer.new(@data)
@@ -33,7 +33,7 @@ describe Eprime::Transformers::BasicTransformer do
   end
   
   it "should allow copydown columns" do
-    @xf.copydown_column 'test', 'sparse'
+    @xf.copydown_column 'test', "sparse"
     @xf.columns.should include('test')
   end
   
@@ -48,8 +48,18 @@ describe Eprime::Transformers::BasicTransformer do
     @xf.size.should == count
   end
   
+  it "should allow adding simple passes without a block" do
+    @xf.add_pass(
+      '-{stim_time}', 
+      lambda {|r| !r['sparse'].to_s.empty?}, 
+      [['test', '{stim_time}']]
+    )
+    df = @data.find_all { |r| !r['sparse'].to_s.empty? }
+    @xf.size.should == df.size
+  end
+  
   it "should allow adding passes without a block" do
-    @xf.add_pass('-{stim_time}', lambda {|r| !r['sparse'].to_s.empty?}, [['test', 'stim_time']])
+    @xf.add_pass('-{stim_time}', lambda {|r| !r['sparse'].to_s.empty?}, [['test', '{stim_time}']])
     df = @data.find_all { |r| !r['sparse'].to_s.empty? }
     @xf.size.should == df.size
     @xf[0]['stim_time'].should == df.reverse[0]['stim_time']
@@ -60,7 +70,7 @@ describe Eprime::Transformers::BasicTransformer do
     @xf.add_pass do |p|
       p.sort_expression = '-{stim_time}'
       p.row_filter = lambda { |r| !r['sparse'].to_s.empty?}
-      p.computed_column 'test', 'stim_time'
+      p.computed_column 'test', '{stim_time}'
     end
     df = @data.find_all { |r| !r['sparse'].to_s.empty? }
     @xf.size.should == df.size