mexico 0.0.9

data/spec/file_system_based/better_collection_spec.rb

@@ -0,0 +1,142 @@
+# This file is part of the MExiCo gem.
+# Copyright (c) 2012-2014 Peter Menke, SFB 673, Universität Bielefeld
+# http://www.sfb673.org
+#
+# MExiCo is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as
+# published by the Free Software Foundation, either version 3 of
+# the License, or (at your option) any later version.
+#
+# MExiCo is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with MExiCo. If not, see
+# <http://www.gnu.org/licenses/>.
+
+require 'spec_helper'
+include Mexico::FileSystem
+
+describe Mexico::FileSystem::FiestaDocument do
+
+  # set up an initial corpus representation from the example file
+  before(:each) do
+    #@basepath = File.join(File.dirname(__FILE__), '..','..','assets','TESTCORPUS')
+    #@corpus = Mexico::FileSystem::Corpus.open(@basepath)
+
+    @fiesta_document = FiestaDocument.new
+
+    @scale = @fiesta_document.add_standard_timeline("s")
+
+    @foo_layer = @fiesta_document.add_layer Layer.new identifier: 'foo', name: 'lily'
+    @bar_layer = @fiesta_document.add_layer Layer.new identifier: 'bar', name: 'lotus'
+
+
+    @item1 = @fiesta_document.add_item(identifier: 'i1') do |i|
+      i.data = Mexico::FileSystem::Data.new(string_value: 'lion')
+      i.add_layer_link(Mexico::FileSystem::LayerLink.new(target_object: @foo_layer))
+    end
+
+
+    @item2 = @fiesta_document.add_item(identifier: 'i2') do |i|
+      i.data = Mexico::FileSystem::Data.new(string_value: 'tiger')
+      i.add_layer_link(Mexico::FileSystem::LayerLink.new(target_object: @bar_layer))
+    end
+
+    @item3 = @fiesta_document.add_item(identifier: 'i1') do |i|
+      i.data = Mexico::FileSystem::Data.new(string_value: 'bear')
+      i.add_layer_link(Mexico::FileSystem::LayerLink.new(target_object: @bar_layer))
+    end
+
+  end
+
+  context 'ActiveRecord-like collections' do
+
+
+    it 'should detect the helper modules' do
+
+      expect do
+        ::Mexico
+        ::Mexico::Util
+      end.to_not raise_error
+
+    end
+
+    context 'Scales' do
+
+      it 'should return the correct scale when asked for a string-based identifier' do
+        @fiesta_document.scales(@scale.identifier).should eq @scale
+        @fiesta_document.scales('other').should be nil
+      end
+
+      it 'should filter scales correctly by unit' do
+        @fiesta_document.scales(unit: 's').should include(@scale)
+        @fiesta_document.scales(unit: 'ms').should be_empty
+      end
+
+      it 'should filter scales correctly by dimension' do
+        @fiesta_document.scales(dimension: Mexico::FileSystem::Scale::DIM_TIME).should include(@scale)
+        @fiesta_document.scales(dimension: Mexico::FileSystem::Scale::DIM_SPACE).should be_empty
+      end
+
+      it 'should filter scales correctly by regexp id' do
+        @fiesta_document.scales(identifier: /time/).should include(@scale)
+        @fiesta_document.scales(identifier: /cauliflower/).should be_empty
+      end
+
+      it 'should select scales correctly by index' do
+        @fiesta_document.scales(0).should eq @scale
+      end
+
+    end
+
+
+    context 'Layers' do
+
+      it 'should return the correct layer when asked for a string-based identifier' do
+        @fiesta_document.layers(@foo_layer.identifier).should eq @foo_layer
+        @fiesta_document.layers(@bar_layer.identifier).should eq @bar_layer
+      end
+
+      context 'hash-based filtering' do
+
+        it 'should return the correct layers when given a hash with string values' do
+          @fiesta_document.layers(name: @foo_layer.name).should eq [@foo_layer]
+          @fiesta_document.layers(name: @bar_layer.name).should eq [@bar_layer]
+          @fiesta_document.layers(identifier: @foo_layer.identifier).should eq [@foo_layer]
+          @fiesta_document.layers(identifier: @bar_layer.identifier).should eq [@bar_layer]
+          @fiesta_document.layers(identifier: @foo_layer.identifier, name: @foo_layer.name).should eq [@foo_layer]
+          @fiesta_document.layers(identifier: @bar_layer.identifier, name: @bar_layer.name).should eq [@bar_layer]
+          @fiesta_document.layers(identifier: @foo_layer.identifier, name: @bar_layer.name).should eq []
+        end
+
+        it 'should return the correct layers when given a hash with regexp values' do
+          @fiesta_document.layers(name: /lil.*/).should eq [@foo_layer]
+          @fiesta_document.layers(name: /lot.*/).should eq [@bar_layer]
+          @fiesta_document.layers(name: /l.*/).should include(@foo_layer, @bar_layer)
+        end
+
+      end
+
+    end
+
+  end
+
+  context 'Items' do
+
+    it 'should return the correct item when asked for a string-based identifier' do
+      @fiesta_document.items(@item1.identifier).should eq @item1
+      @fiesta_document.items(@item2.identifier).should eq @item2
+    end
+
+    it 'should return the correct layers when given a hash with string values' do
+      @fiesta_document.items(identifier: 'i1').should include(@item1)
+      @fiesta_document.items(data: 'tiger').should include(@item2)
+    end
+
+  end
+
+
+end

data/spec/file_system_based/corpus_spec.rb

@@ -0,0 +1,194 @@
+# This file is part of the MExiCo gem.
+# Copyright (c) 2012-2014 Peter Menke, SFB 673, Universität Bielefeld
+# http://www.sfb673.org
+#
+# MExiCo is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as
+# published by the Free Software Foundation, either version 3 of
+# the License, or (at your option) any later version.
+#
+# MExiCo is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with MExiCo. If not, see
+# <http://www.gnu.org/licenses/>.
+
+require 'spec_helper'
+
+describe Mexico::FileSystem::Corpus do
+  
+  def write_corpus
+    
+    doc = Nokogiri::XML::Document.new
+    doc.root = @corpus.to_xml
+    open(File.join(@basepath, "Corpus.OUT.xml"), 'w') do |file|
+      file << doc.serialize
+    end
+    
+  end
+  
+  # set up an initial corpus representation from the example file
+  before(:each) do
+    @basepath = File.join(File.dirname(__FILE__), '..','..','assets','TESTCORPUS')
+    @corpus = Mexico::FileSystem::Corpus.open(@basepath)
+  end
+  
+  context 'Attributes' do
+  
+    it 'should include the CorpusCore module' do
+      @corpus.should respond_to('core_included?')  
+    end
+  
+    context "identifier" do
+    
+      it "should have accessor methods" do
+        @corpus.should respond_to(:identifier, :identifier=)  
+      end
+  
+      it "should have the right type" do
+        @corpus.identifier.kind_of?(String).should be true
+        @corpus.identifier.should match /^\w[-\w\d_]*$/
+      end
+      
+      it "should have the correct value" do
+        @corpus.identifier.should eq "example-corpus"
+      end
+      
+    end
+    
+    context "name" do
+          
+      it "should have accessor methods" do
+        @corpus.should respond_to(:name, :name=)  
+      end
+  
+      it "should have the right type" do
+        @corpus.name.kind_of?(String).should be true
+      end
+      
+      it "should have the correct value" do
+        @corpus.name.should eq "Example Corpus"
+      end
+      
+    end
+    
+    context "description" do
+          
+      it "should have accessor methods" do
+        @corpus.should respond_to(:description, :description=)  
+      end
+  
+      it "should have the right type" do
+        @corpus.description.kind_of?(String).should be true
+      end
+      
+      it "should have the correct value" do
+        @corpus.description.should eq "This is an example corpus."
+      end
+      
+    end
+    
+  end
+  
+  
+  context "Aggregated components" do
+
+    context "Participants: " do
+
+      it 'should respond to participant methods' do
+        @corpus.should respond_to(:participants)
+      end
+  
+      it 'collection accessor returns collection' do
+       @corpus.participants.should be_kind_of(Array)
+      end
+      
+      it 'should have one member' do
+        @corpus.participants.should_not be nil
+        @corpus.participants.size.should be 1
+      end
+  
+      it 'should have a first member with the correct data' do
+        @corpus.participants[0].identifier.should eq "vp01"
+        @corpus.participants[0].should respond_to("corpus")
+        @corpus.participants[0].corpus.identifier.should eq "example-corpus"
+      end
+
+      it 'should have a first member with the correct participant role' do
+        @corpus.participants[0].participant_role.should eq(::Mexico::Constants::ParticipantRoles::NAIVE)
+      end
+      
+      
+      it 'should reflect addition of a new participant' do
+        @corpus.participants << ::Mexico::FileSystem::Participant.new(:identifier=>"vp02",:participant_role=>"confederate")
+        @corpus.participants.size.should be 2
+        write_corpus
+      end
+      
+    end
+    
+    context "Designs: " do
+  
+      it 'should respond to design methods' do
+        @corpus.should respond_to(:designs)
+      end
+  
+      it 'collection accessor returns collection' do
+       @corpus.designs.should be_kind_of(Array)
+      end
+      
+      it 'should have one design' do
+        @corpus.designs.should_not be nil
+        @corpus.designs.size.should be 2
+      end
+  
+      it 'should have a first design with the correct data' do
+        @corpus.designs[0].identifier.should eq "example-design"
+        @corpus.designs[0].should respond_to("corpus")
+        @corpus.designs[0].corpus.identifier.should eq "example-corpus"
+      end
+    
+    end
+    
+    
+    context "Trials: " do
+      it 'should respond to trials methods' do
+        @corpus.should respond_to(:trials)
+      end
+      
+      it 'should have one trial' do
+        @corpus.trials.should_not be nil
+        @corpus.trials.size.should be 1
+      end
+      
+      it 'after adding a trial, it should have two trials' do
+        @corpus.trials.size.should be 1
+        @corpus.trials << Mexico::FileSystem::Trial.new(:identifier=>"second-example-trial", :name=>"Second Example Trial", :description=>"This is an example trial.",:cue=>"V0?2",:running_number=>2)
+        @corpus.trials.size.should be 2
+      end
+    end
+
+    
+    context "Resources: " do
+      it 'should respond to resources methods' do
+        @corpus.should respond_to(:resources)
+      end
+      
+      it 'should have one resource' do
+        @corpus.resources.should_not be nil
+        @corpus.resources.size.should be 1
+      end
+      
+      it 'after adding a resource, it should have two resources' do
+        @corpus.resources.size.should be 1
+        @corpus.resources << Mexico::FileSystem::Resource.new(:identifier=>"second-example-resource", :name=>"Second Example Resource", :description=>"This is an example resource.")
+        @corpus.resources.size.should be 2
+      end
+    end
+
+  end
+  
+end

data/spec/file_system_based/design_spec.rb

@@ -0,0 +1,100 @@
+# This file is part of the MExiCo gem.
+# Copyright (c) 2012-2014 Peter Menke, SFB 673, Universität Bielefeld
+# http://www.sfb673.org
+#
+# MExiCo is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as
+# published by the Free Software Foundation, either version 3 of
+# the License, or (at your option) any later version.
+#
+# MExiCo is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with MExiCo. If not, see
+# <http://www.gnu.org/licenses/>.
+
+require 'spec_helper'
+
+describe Mexico::FileSystem::Design do
+
+  # set up an initial corpus representation from the example file
+  before(:each) do
+    @basepath = File.join(File.dirname(__FILE__), '..','..','assets','TESTCORPUS')
+    @xml = File.open(File.join(@basepath,'Corpus.xml'),'rb') { |f| f.read }
+    @corpus = Mexico::FileSystem::Corpus.from_xml(@xml, {:path => @basepath})
+    @design = @corpus.designs.first
+  end
+  
+  context "Attributes" do
+    
+    context "identifier" do
+    
+      it "should have accessor methods" do
+        @design.should respond_to(:identifier, :identifier=)  
+      end
+  
+      it "should have the right type" do
+        @design.identifier.kind_of?(String).should be true
+        @design.identifier.should match /^\w[-\w\d_]*$/
+      end
+      
+      it "should have the correct value" do
+        @design.identifier.should eq "example-design"
+      end
+      
+    end
+    
+    context "name" do
+          
+      it "should have accessor methods" do
+        @design.should respond_to(:name, :name=)  
+      end
+  
+      it "should have the right type" do
+        @design.name.kind_of?(String).should be true
+      end
+      
+      it "should have the correct value" do
+        @design.name.should eq "Example Design"
+      end
+      
+    end
+    
+    context "description" do
+          
+      it "should have accessor methods" do
+        @design.should respond_to(:description, :description=)  
+      end
+  
+      it "should have the right type" do
+        @design.description.kind_of?(String).should be true
+      end
+      
+      it "should have the correct value" do
+        @design.description.should eq "Design Description"
+      end
+      
+    end
+    
+  end
+
+
+  context "Aggregated components" do
+
+    it 'should have one or more design components' do
+      @design.should respond_to(:design_components)
+      @design.design_components.size.should eq 1
+    end
+
+    it 'should return correct values for the first design component' do
+      @design.design_components[0].identifier.should eq 'example-design-component'
+      @design.design_components[0].name.should eq 'Example Design Component'
+      @design.design_components[0].media_type.should eq ::Mexico::Constants::MediaTypes::VIDEO
+    end
+
+  end
+
+end

data/spec/file_system_based/inter_links_spec.rb

@@ -0,0 +1,100 @@
+# This file is part of the MExiCo gem.
+# Copyright (c) 2012-2014 Peter Menke, SFB 673, Universität Bielefeld
+# http://www.sfb673.org
+#
+# MExiCo is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as
+# published by the Free Software Foundation, either version 3 of
+# the License, or (at your option) any later version.
+#
+# MExiCo is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with MExiCo. If not, see
+# <http://www.gnu.org/licenses/>.
+
+require 'spec_helper'
+
+describe Mexico::FileSystem::Resource do
+  
+  # set up an initial corpus representation from the example file
+  before(:each) do
+    @basepath = File.join(File.dirname(__FILE__), '..','..','assets','mexico-testcorpus','structured')
+    @xml = File.open(File.join(@basepath,'Corpus.xml'),'rb') { |f| f.read }
+    @corpus = Mexico::FileSystem::Corpus.from_xml(@xml, {:path => @basepath})
+    
+    @design_b = @corpus.designs[0]
+    @design_c = @corpus.designs[1]
+    @design_d = @corpus.designs[2]
+    @design_e = @corpus.designs[3]
+
+    @design_component_x = @design_b.design_components[0]
+    
+    @trial_f = @corpus.trials[0]
+    @trial_g = @corpus.trials[1]
+    @trial_h = @corpus.trials[2]
+    @trial_i = @corpus.trials[3]
+    
+    @resource_j = @corpus.resources[0]
+
+  end
+  
+  context 'our little corpus on the prairie' do
+  
+    context 'should link from first design to two trials' do
+      it 'should have the method' do
+        @design_b.should respond_to :trials
+      end
+      it 'should return a collection' do
+        @design_b.trials.should be_kind_of(Enumerable)
+      end
+      it 'should return a collection with 2 elements' do
+        @design_b.trials.size.should eq 2
+      end
+      it 'a linked trial should say true when asked for linkage to design' do
+        @trial_f.linked_to_design?.should eq true
+      end
+    end
+    
+    context 'resource <j> should link to trial <f>' do
+      it 'should have the methods' do
+        @resource_j.should respond_to :trial
+        @trial_f.should respond_to :resources
+      end
+      it 'should return appropriate objects' do
+        @resource_j.trial.should be_kind_of(Mexico::FileSystem::Trial)
+        @trial_f.resources.should be_kind_of(Enumerable)
+      end
+      it 'should return correct sizes' do
+        @trial_f.resources.size.should eq 1
+      end
+      it 'should return the correct objects' do
+        @resource_j.trial.should eq @trial_f
+        @trial_f.resources[0].should eq @resource_j
+      end
+    end
+
+    context 'resource <j> should link to design component <x>' do
+      it 'should have the methods' do
+        @resource_j.should respond_to :design_component
+        @design_component_x.should respond_to :resources
+      end
+      it 'should return appropriate objects' do
+        @resource_j.design_component.should be_kind_of(Mexico::FileSystem::DesignComponent)
+        @design_component_x.resources.should be_kind_of(Enumerable)
+      end
+      it 'should return correct sizes' do
+        @design_component_x.resources.size.should eq 1
+      end
+      it 'should return the correct objects' do
+        @resource_j.design_component.should eq @design_component_x
+        @design_component_x.resources[0].should eq @resource_j
+      end
+    end
+
+  end
+
+end

data/spec/file_system_based/item_links_spec.rb

@@ -0,0 +1,76 @@
+# This file is part of the MExiCo gem.
+# Copyright (c) 2012-2014 Peter Menke, SFB 673, Universität Bielefeld
+# http://www.sfb673.org
+#
+# MExiCo is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as
+# published by the Free Software Foundation, either version 3 of
+# the License, or (at your option) any later version.
+#
+# MExiCo is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with MExiCo. If not, see
+# <http://www.gnu.org/licenses/>.
+
+require 'spec_helper'
+
+describe Mexico::FileSystem::Resource do
+
+  # set up an initial corpus representation from the example file
+  before(:each) do
+    @basepath = File.join(File.dirname(__FILE__), '..','..','assets','fiesta','elan')
+    @file = File.open(File.join(@basepath,'ElanFileFormat.eaf'),'rb') { |f| f.read }
+    @fiesta_document = ::Mexico::Fiesta::Interfaces::ElanInterface.instance.import(@file)
+  end
+
+  context 'our little corpus on the prairie' do
+
+    context 'should link from first design to two trials' do
+
+      it 'should have the method' do
+        puts @fiesta_document.scales
+      end
+
+    end
+
+  end
+
+  context 'item linking' do
+
+    it 'should behave correctly before testing' do
+      puts @fiesta_document.items.size
+      @fiesta_document.layers.each do |layer|
+        puts layer.name
+        #puts "  /#{layer.items}/"
+        #puts "  /#{layer.items.class.name}/"
+        puts "  /#{layer.items.size}/"
+        layer.items.each do |i|
+          puts "    #{i.data.string_value}"
+          i.item_links.each do |ili|
+            puts "      -(#{ili.role})-> #{ili.target_object}"
+          end
+        end
+      end
+    end
+
+    it 'should behave correctly before testing' do
+      l1 = Mexico::FileSystem::Layer.new(identifier: 'test1', name: 'test1')
+      l2 = Mexico::FileSystem::Layer.new(identifier: 'test2', name: 'test2')
+      @fiesta_document.layers << l1
+      @fiesta_document.layers << l2
+
+      puts "L1: %s" % l1
+      puts "L2: %s" % l2
+
+      # add items
+      # link them
+      # check if additional links occur in the correct way
+    end
+
+  end
+
+end