mexico 0.0.9

data/lib/mexico/fiesta/interfaces.rb

@@ -0,0 +1,31 @@
+# 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/>.
+
+# The FileSystem module contains an implementation of the MExiCo
+# library that works locally with a set of folders and files as
+# its backend.
+
+module Mexico::Fiesta::Interfaces
+
+end
+
+require 'mexico/fiesta/interfaces/b6_chat_game_interface.rb'
+require 'mexico/fiesta/interfaces/elan_interface.rb'
+require 'mexico/fiesta/interfaces/short_text_grid_interface.rb'
+require 'mexico/fiesta/interfaces/text_grid_interface.rb'
+# require 'mexico/fiesta/interfaces/dot_interface.rb'

data/lib/mexico/fiesta.rb

@@ -0,0 +1,27 @@
+# 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/>.
+
+# The FileSystem module contains an implementation of the MExiCo
+# library that works locally with a set of folders and files as
+# its backend.
+
+module Mexico::Fiesta
+
+end
+
+require 'mexico/fiesta/interfaces'

data/lib/mexico/file_system/bound_to_corpus.rb

@@ -0,0 +1,37 @@
+# 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/>.
+
+# XML bound elements know the corpus object, the corpus file, and
+# the nokogiri element they come from and can write changes back to
+# that file.
+
+module Mexico::FileSystem::BoundToCorpus
+  
+  attr_accessor :corpus
+  
+  #sets up the bound between the object and the corpus elements
+  def bind_to_corpus(param_corpus)
+    @corpus = param_corpus
+    
+    if self.respond_to?(:when_bound_to_corpus)
+      self.when_bound_to_corpus
+    end
+    
+  end
+    
+end

data/lib/mexico/file_system/corpus.rb

@@ -0,0 +1,207 @@
+# 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/>.
+
+# This class provides a corpus representation that is backed up by the filesystem.
+# A central Corpus definition file in the top-level folder contains an
+# XML representation of the corpus structure, and all actual resources are found
+# as files on a file system reachable from the top-level folder.
+
+require 'poseidon'
+
+class Mexico::FileSystem::Corpus
+  
+  ### include Mexico::FileSystem::FileSystemUtils
+
+
+  include Mexico::Core::CorpusCore
+  
+  attr_accessor :base_path
+  
+  include ::ROXML
+  
+  xml_name 'Corpus'
+
+  # identifier
+  xml_accessor :identifier,        :from => '@identifier'
+
+  # type String
+  xml_accessor :name,              :from => '@name'
+
+  # type String
+  xml_accessor :description,       :from => "Description"
+
+  # collection of ::Mexico::FileSystem::Participant
+  xml_accessor :participants,      :as => [::Mexico::FileSystem::Participant],     :from => "Participant",     :in => "Participants"
+
+  # collection of ::Mexico::FileSystem::Design
+  xml_accessor :designs,           :as => [::Mexico::FileSystem::Design],          :from => "Design",          :in => "Designs"
+
+  # collection of ::Mexico::FileSystem::Trial
+  xml_accessor :trials,            :as => [::Mexico::FileSystem::Trial],           :from => "Trial",           :in => "Trials"
+
+  # collection of ::Mexico::FileSystem::Resource
+  xml_accessor :resources,         :as => [::Mexico::FileSystem::Resource],        :from => "Resource",        :in => "Resources"
+
+
+  # POSEIdON-based RDF augmentation
+  include Poseidon
+  self_uri %q(http://cats.sfb673.org/Corpus)
+  instance_uri_scheme %q(http://phoibos.sfb673.org/corpora/#{identifier})
+  rdf_property :identifier, %q(http://cats.sfb673.org/identifier)
+  rdf_property :name, %q(http://cats.sfb673.org/name)
+  rdf_property :description, %q(http://cats.sfb673.org/description)
+  rdf_include :designs, %q(http://cats.sfb673.org/hasDesign)
+  rdf_include :trials, %q(http://cats.sfb673.org/hasTrial)
+  rdf_include :resources, %q(http://cats.sfb673.org/hasResource)
+
+
+  public
+  
+  # corpus_file  : the XML file
+  # corpus_doc   : the nokogiri xml document based on that file
+
+  # Opens the corpus folder and its manifest file at the given path.
+  # @param [String] path the path where the corpus is
+  # @option opts [String] :identifier The identifier that will be given if a new corpus is created
+  # @return [Mexico::FileSystem::Corpus] the new or opened Corpus object
+  def self.open(path, opts={})
+    xml = File.open(File.join(path,'Corpus.xml'),'rb') { |f| f.read }
+    c = Mexico::FileSystem::Corpus.from_xml(xml, opts.merge({:path=>path}))
+    return c
+  end
+
+  # Creates a new instance of the {Corpus} class.
+  # @param [String] path the path where the corpus is
+  # @option opts [String] :identifier The identifier that will be given if a new corpus is created
+  def initialize(path, opts={})
+    init_folder(path, opts)
+    @base_path = File.expand_path(path)
+    @corpus_file_name = File.join(@base_path, "Corpus.xml")
+    f = File.open(@corpus_file_name, 'r')
+    @xml_doc = ::Nokogiri::XML(f)
+    f.close
+  end
+
+  # Creates a new corpus object
+  # @option opts [String] :path The path where to create the new corpus. Required.
+  # @option opts [String] :identifier The identifier for the new corpus. Required.
+  # @option opts [String] :name The name for the new corpus.
+  # @option opts [String] :description A description for the new corpus. Required.
+  def initialize(opts = {})
+    init_folder(opts[:path], opts)
+    @base_path = File.expand_path(opts[:path])
+    @corpus_file_name = File.join(@base_path, "Corpus.xml")
+    f = File.open(@corpus_file_name, 'r')
+    @xml_doc = ::Nokogiri::XML(f)
+    f.close
+  end
+  
+  # Saves the current data structure to the current file handle.
+  # @return [void]
+  def save_xml
+    doc = Nokogiri::XML::Document.new
+    doc.root = @corpus.to_xml
+    open(File.join(@base_path, "Corpus.OUT.xml"), 'w') do |file|
+      file << doc.serialize
+    end
+    # File.open(@corpus_file, 'w') {|f| f.write(doc.to_xml) }
+  end
+  
+  # Creates a new design object and binds it to this corpus object.
+  # @option opts [String] :identifier The identifier of the new design (required).
+  # @option opts [String] :name The name of the new design. (required).
+  # @option opts [String] :description A description of the new design (optional).
+  def create_design(opts={})
+    d = ::Mexico::FileSystem::Design.new(opts)
+    d.bind_to_corpus(self)
+    d
+  end
+
+  # Returns the disk usage in bytes for the whole corpus.
+  # @return [Integer] the number of bytes used by files of this corpus
+  def complete_file_size
+    resources.collect{ |r| r.complete_file_size }.inject(:+)
+  end
+  
+  private
+
+  # after parsing a XML corpus representation, this method binds all components
+  # to the corpus object. 
+  def after_parse
+    
+    participants.each do |participant|
+      participant.bind_to_corpus(self)
+    end
+    
+    designs.each do |design|
+      design.bind_to_corpus(self)
+      design.design_components.each do |dc|
+        dc.bind_to_corpus(self)
+      end
+    end
+    
+    trials.each do |trial|
+      trial.bind_to_corpus(self)
+    end
+
+    resources.each do |resource|
+      resource.bind_to_corpus(self)
+      resource.local_files.each do |loc|
+        loc.bind_to_corpus(self)
+      end
+      resource.urls.each do |url|
+        url.bind_to_corpus(self)
+      end
+      
+    end
+        
+  end
+    
+  # This method inits a new corpus folder in the file system.
+  # @param [String] path The path where the folder should be initialized.
+  # @param [Hash] opts A hash with additional options and parameters.
+  # @option opts [String] :identifier The identifier of the new corpus (required).
+  # @return +true+ if all operations were successful, false otherwise.
+  def init_folder(path, opts = {})
+    
+    # check whether the given folder does not exist and is writable
+    unless File.exists?(path)
+      begin
+        FileUtils.mkpath(path)
+      rescue
+        # if something goes wrong, stop here and return false
+      end
+    end
+    
+    corpus_file_name = File.join(path, "Corpus.xml")
+    unless File.exists?(corpus_file_name)
+      corpus_file = File.open(corpus_file_name, 'w+')
+      corpus_file << "<Corpus identifier='#{opts[:identifier]}'></Corpus>"
+      corpus_file.close
+    end
+    # create
+    
+  end
+
+
+  # helping method to retrieve all existing design components
+  def design_components
+    @designs.collect{|d| d.design_components}.flatten
+  end
+  
+end

data/lib/mexico/file_system/data.rb

@@ -0,0 +1,96 @@
+# 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/>.
+
+# the data container
+class Mexico::FileSystem::Data
+
+  include ::ROXML
+  xml_name 'D'
+
+  xml_accessor :string_value, :from => "String" # , :to_xml => proc{|val| (@type=='string' ? val : '')}
+  xml_accessor :int_value, :as => Integer, :from => "Int"
+  xml_accessor :float_value, :as => Float, :from => "Float"
+  xml_accessor :map, :as => Mexico::FileSystem::FiestaMap, :from => "Map"
+  #xml_accessor :list, :as => Mexico::FileSystem::FiestaList, :from => "List"
+
+  attr_accessor :item, :document
+
+  include Poseidon
+  self_uri %q(http://cats.sfb673.org/Data)
+  instance_uri_scheme %q(#{document.self_uri}##{item.identifier}-data)
+  rdf_property :string_value, %q(http://cats.sfb673.org/string_value)
+  # rdf_property :name, %q(http://cats.sfb673.org/name)
+
+  # keine Bool-Klasse in Ruby. xml_accessor :boolean_value, :as => Bool, :from => "B"
+  # @todo map and list types
+
+  def initialize(args={})
+    args.each do |k,v|
+      if self.respond_to?("#{k}=")
+        send("#{k}=", v)
+      end
+    end
+  end
+
+  def after_parse
+    # resolve links
+  end
+
+
+  def map_value
+    # return nil unless @type=="map"
+    @map # ||= JSON::load(@string_value)
+  end
+
+  def list_value
+    # return nil unless @type=="list"
+    @list # ||= JSON::load(@string_value)
+  end
+
+  def map_value=(val)
+    @string_value = nil
+    @list = nil
+    @map = Mexico::FileSystem::FiestaMap.new(val)
+  end
+
+  def list_value=(val=Array.new)
+    @string_value = nil
+    @map = nil
+    @list = val
+  end
+
+  def string_value=(new_string)
+    @map = nil
+    @list = nil
+    @string_value = new_string
+  end
+
+  def to_s
+    return string_value unless string_value.nil?
+    return @map.to_s unless @map.nil?
+  end
+
+  def is_string?
+    (!string_value.nil? && map_value.nil? && list_value.nil?)
+  end
+
+  def is_map?
+    (string_value.nil? && !map_value.nil? && list_value.nil?)
+  end
+
+end

data/lib/mexico/file_system/design.rb

@@ -0,0 +1,75 @@
+# 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 'poseidon'
+
+class Mexico::FileSystem::Design
+
+  include Mexico::FileSystem::BoundToCorpus
+
+  include Mexico::Core::DesignCore
+
+  include ::ROXML
+
+  # identifier
+  xml_accessor :identifier, :from => '@identifier'
+
+  # type String
+  xml_accessor :name,       :from => '@name'
+
+  # type String
+  xml_accessor :description, :from => "Description"
+
+  # collection of ::Mexico::FileSystem::DesignComponent
+  xml_accessor :design_components, :as => [::Mexico::FileSystem::DesignComponent], :from => "DesignComponent" #, :in => "Designs"
+
+  # POSEIdON-based RDF augmentation
+  include Poseidon
+
+  self_uri %q(http://cats.sfb673.org/Design)
+  instance_uri_scheme %q(http://phoibos.sfb673.org/corpora/#{corpus.identifier}/designs/#{identifier})
+
+  rdf_property :identifier, %q(http://cats.sfb673.org/identifier)
+  rdf_property :name, %q(http://cats.sfb673.org/name)
+  rdf_property :description, %q(http://cats.sfb673.org/description)
+
+  rdf_include :design_components, %q(http://cats.sfb673.org/hasDesignComponent)
+
+  # Creates a new design object.
+  # @option opts [String] :identifier The identifier of the new design (required).
+  # @option opts [String] :name The name of the new design. (required).
+  # @option opts [String] :description A description of the new design (optional).
+  def initialize(opts={})
+    [:identifier,:name,:description].each do |att|
+      send("#{att}=", opts[att]) if opts.has_key?(att)
+    end
+  end
+
+  # Returns a collection of trials that are associated with this design.
+  # @return [Array<Trial>] an array of trials associated with this design.
+  def trials
+    @corpus.trials.select{ |i| i.design === self }
+  end
+
+
+  def after_parse
+    design_components.each do |dc|
+      dc.design = self
+    end
+  end
+end

data/lib/mexico/file_system/design_component.rb

@@ -0,0 +1,78 @@
+# 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 'poseidon'
+
+# A template class doing nothing.
+class Mexico::FileSystem::DesignComponent
+
+  include Mexico::FileSystem::BoundToCorpus
+  extend Mexico::FileSystem::IdRef
+  extend Mexico::FileSystem::StaticCollectionRef
+
+  include ::ROXML
+
+  # identifier
+  xml_accessor :identifier,     :from => '@identifier' 
+
+  # type String
+  xml_accessor :name,           :from => '@name'
+
+  # type String
+  xml_accessor :description,    :from => 'Description'
+
+  # type String
+  xml_accessor :cue,            :from => '@cue'
+
+  # type [true,false]
+  xml_accessor :required?,      :from => '@required'
+
+  # type Mexico::Core::MediaType
+  xml_accessor :media_type_id,  :from => '@media_type_id'
+
+  # type Mexico::Core::MediaType
+  collection_ref :media_type, ::Mexico::Core::MediaType, ::Mexico::Constants::MediaTypes::ALL, ::Mexico::Constants::MediaTypes::OTHER
+
+  #@todo data_type
+  #@todo content_structure
+  #@todo belongs to Design
+
+
+  attr_accessor :design
+
+
+  # POSEIdON-based RDF augmentation
+  include Poseidon
+
+  self_uri %q(http://cats.sfb673.org/DesignComponent)
+  instance_uri_scheme %q(http://phoibos.sfb673.org/corpora/#{design.corpus.identifier}/designs/#{design.identifier}/design_components/#{identifier})
+
+  rdf_property :identifier, %q(http://cats.sfb673.org/identifier)
+  rdf_property :name, %q(http://cats.sfb673.org/name)
+  rdf_property :description, %q(http://cats.sfb673.org/description)
+  rdf_property :cue, %q(http://cats.sfb673.org/cue)
+  rdf_property :running_number, %q(http://cats.sfb673.org/running_number)
+  rdf_property :required?, %q(http://cats.sfb673.org/is_required)
+
+  # Returns a collection of resources that are associated with this design component.
+  # @return [Array<Resource>] an array of resources associated with this design component.
+  def resources
+    @corpus.resources.select{ |i| i.design_component === self }
+  end
+
+end

data/lib/mexico/file_system/entry.rb

@@ -0,0 +1,59 @@
+# encoding: utf-8
+# 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/>.
+
+# This class provides a corpus representation that is backed up by the filesystem.
+# A central Corpus definition file in the top-level folder contains an
+# XML representation of the corpus structure, and all actual resources are found
+# as files on a file system reachable from the top-level folder.
+
+class Mexico::FileSystem::Entry
+
+  include ::ROXML
+  xml_name 'Entry'
+
+  xml_accessor :key, :from => '@key'
+
+  xml_accessor :entries, :as => [::Mexico::FileSystem::Entry], :from => "Entry"
+
+  attr_accessor :values
+
+  def self.from_xml(node, args={})
+    @values = {}
+    node.elements.each do |el|
+      key = el['key']
+      val = el.text
+      @values[key] = val
+    end
+  end
+
+  def to_xml(params = {})
+    params.reverse_merge!(:name => self.class.tag_name, :namespace => self.class.roxml_namespace)
+    params[:namespace] = nil if ['*', 'xmlns'].include?(params[:namespace])
+    node = XML.new_node([params[:namespace], params[:name]].compact.join(':')).tap do |root|
+      @values.each do |k,v|
+        root.children << XML.new_node([params[:namespace], 'Entry']).tap do |ent|
+          ent['key'] = k
+          ent.text = v
+        end
+      end
+    end
+    node
+  end
+
+end