mexico 0.0.9

data/lib/mexico/file_system/trial.rb

@@ -0,0 +1,87 @@
+# 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'
+
+# Trials model the events from reality that form the ultimate substrate
+# of a corpus. Trials are usually numbered sequentially. A trial
+# stands for a specific clip or segment of reality, e.g., a time span
+# and a location in space where the events under observation occurred.
+class Mexico::FileSystem::Trial
+  
+  include Mexico::FileSystem::BoundToCorpus
+  extend Mexico::FileSystem::IdRef
+
+  include ::ROXML
+  
+  # identifier
+  xml_accessor :identifier,     :from => '@identifier'
+
+  # type String
+  xml_accessor :name,           :from => '@name'
+
+  # type String
+  xml_accessor :cue,            :from => '@cue'
+
+  # type Integer
+  xml_accessor :running_number, :from => '@runningnumber', :as => Integer
+
+  # type String
+  xml_accessor :description, :from => "Description"     
+
+  # attr_accessor :corpus
+  xml_accessor :design_id, :from => '@design_id'
+
+  # type Mexico::FileSystem::Design
+  id_ref :design
+
+  # POSEIdON-based RDF augmentation
+  include Poseidon
+
+  self_uri %q(http://cats.sfb673.org/Trial)
+  instance_uri_scheme %q(http://phoibos.sfb673.org/corpora/#{corpus.identifier}/trials/#{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)
+
+  # creates a new Trial object.
+  # @option opts [String] :identifier The identifier of the new trial object.
+  # @option opts [String] :description The identifier of the new trial object.
+  # @option opts [String] :cue The cue for the new trial object.
+  # @option opts [Integer] :running_number The running number for the new trial object.
+  def initialize(opts={})
+    # @corpus = corpus
+    [:identifier,:name,:description,:cue,:running_number].each do |att|
+      send("#{att}=", opts[att]) if opts.has_key?(att)
+    end
+  end
+
+  # Returns a collection of resources that are associated with this trial.
+  # @return [Array<Resource>] an array of resources associated with this trial.
+  def resources
+    @corpus.resources.select{ |i| i.trial === self }
+  end
+
+  def linked_to_design?
+    return design!=nil
+  end
+  
+end

data/lib/mexico/file_system/url.rb

@@ -0,0 +1,65 @@
+# 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'
+
+# An URL object stands for a resource representation at the given location.
+class Mexico::FileSystem::URL
+  
+  include Mexico::FileSystem::BoundToCorpus
+  extend Mexico::FileSystem::IdRef
+  extend Mexico::FileSystem::StaticCollectionRef
+  
+  include ::ROXML
+  
+  xml_accessor :identifier,     :from => '@identifier' 
+  xml_accessor :name,           :from => '@name' 
+  xml_accessor :description,    :from => 'Description' 
+
+  xml_accessor :href, :from => "@href"
+
+  # POSEIdON-based RDF augmentation
+  include Poseidon
+  self_uri %q(http://cats.sfb673.org/URL)
+  instance_uri_scheme %q(http://phoibos.sfb673.org/corpora/#{corpus.identifier}/urls/#{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 :href, %q(http://cats.sfb673.org/href)
+
+  def initialize(opts={})
+    # @corpus = corpus
+    [:identifier,:name,:description].each do |att|
+      send("#{att}=", opts[att]) if opts.has_key?(att)
+    end
+  end
+
+  # Retrieves a bunch of meta data with information about this resource representation.
+  # @return [Hash] A hash containing various information (size, mime_type, availability)
+  def info
+    # @todo Implement this method stub
+  end
+
+  # Attempts to fetch the contents at this resource.
+  # @option opts [String] :format The format to be retrieved. If omitted, the standard format will be retrieved.
+  # @return [String or ByteArray] The file contents, as a string or binary object.
+  def get(opts = {} )
+    # @todo Implement this method stub
+  end
+  
+end

data/lib/mexico/file_system.rb

@@ -0,0 +1,62 @@
+# 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::FileSystem
+  
+end
+
+#require 'mexico/file_system/file_system_utils.rb'
+#require 'mexico/file_system/xml_based_collection.rb'
+
+require 'mexico/file_system/bound_to_corpus.rb'
+require 'mexico/file_system/id_ref.rb'
+require 'mexico/file_system/static_collection_ref.rb'
+
+require 'mexico/file_system/participant_role.rb'
+require 'mexico/file_system/participant.rb'
+require 'mexico/file_system/local_file.rb'
+require 'mexico/file_system/url.rb'
+require 'mexico/file_system/resource.rb'
+
+require 'mexico/file_system/property.rb'
+require 'mexico/file_system/property_map.rb'
+require 'mexico/file_system/section.rb'
+require 'mexico/file_system/head.rb'
+require 'mexico/file_system/scale.rb'
+require 'mexico/file_system/layer.rb'
+require 'mexico/file_system/layer_connector.rb'
+#require 'mexico/file_system/fiesta_list.rb'
+require 'mexico/file_system/fiesta_map.rb'
+require 'mexico/file_system/data.rb'
+require 'mexico/file_system/layer_link.rb'
+require 'mexico/file_system/item_link.rb'
+require 'mexico/file_system/implicit_item_link.rb'
+require 'mexico/file_system/point_link.rb'
+require 'mexico/file_system/interval_link.rb'
+require 'mexico/file_system/item.rb'
+require 'mexico/file_system/fiesta_document.rb'
+
+require 'mexico/file_system/trial.rb'
+require 'mexico/file_system/design_component.rb'
+require 'mexico/file_system/design.rb'
+require 'mexico/file_system/corpus.rb'
+
+

data/lib/mexico/not_yet_implemented_error.rb

@@ -0,0 +1,28 @@
+# 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 NotYetImplementedError < StandardError
+
+
+
+end

data/lib/mexico/util/fancy_container.rb

@@ -0,0 +1,57 @@
+# 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 module contains various helper methods.
+module Mexico::Util::FancyContainer
+
+  #module ClassMethods
+
+  def add_fancy_container(container_name, p_back_collection_name=nil)
+    back_collection_name = p_back_collection_name.nil? ? "#{container_name.to_s}_container" : p_back_collection_name
+    define_method(container_name) do |*args|
+      coll = Array.new(instance_variable_get("@#{back_collection_name}"))
+      if args.is_a?(Enumerable)
+        if args.length==1
+          if args.first.is_a?(String)
+            # one argument in string form: assume an identifier, return a single object or nil
+            return instance_variable_get("@#{back_collection_name}").find{|x| x.identifier == args.first }
+          end
+          if args.first.is_a?(Hash)
+            # one argument in string form: assume a hash with conditions
+            args.first.each do |key,val|
+              if val.is_a?(String)
+                coll.select!{|c| c.send(key).to_s==val }
+              elsif val.is_a?(Regexp)
+                coll.select!{|c| c.send(key).to_s=~val }
+              end
+            end
+            return coll
+          end
+          if args.first.is_a?(Integer)
+            return coll[args.first]
+          end
+        end
+      end
+      # otherwise:
+      orig_coll = instance_variable_get("@#{back_collection_name}")
+      orig_coll = [] if orig_coll.nil?
+      Array.new(orig_coll)
+    end
+  end
+end

data/lib/mexico/util.rb

@@ -0,0 +1,51 @@
+# 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 module contains various helper methods.
+module Mexico::Util
+
+  # A list of umlauts and other special characters that are word characters in German.
+  UMLAUTS = {
+      "ä" => "ae",
+      "ö" => "oe",
+      "ü" => "ue",
+      "ß" => "ss"
+  }
+
+  # Simple helper that strips away double quotes around a string.
+  # @param string [String] The string to be unquoted.
+  # @return       [String] The unquoted string.
+  def self.strip_quotes(string)
+    return string.gsub(/^"/, '').gsub(/"$/, '')
+  end
+
+  # Helper method that takes a name and sanitizes it for use as an XML/FiESTA id.
+  # @param string [String] The string to be converted to an ID.
+  # @return       [String] The resulting ID.
+  def self.to_xml_id(string)
+    result = string.downcase
+    UMLAUTS.each_pair do |u,v|
+      result.gsub!(/#{u}/, v)
+    end
+    return result.gsub(/[^\w\d]/, '')
+  end
+
+end
+
+require 'mexico/util/fancy_container'

data/lib/mexico.rb

@@ -0,0 +1,36 @@
+# 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 'nokogiri'
+require 'roxml'
+require 'fileutils'
+
+# This is the main module for the MExiCO gem.
+module Mexico
+  
+end
+
+require "mexico/core.rb"
+require "mexico/util.rb"
+require "mexico/constraints.rb"
+require "mexico/file_system.rb"
+require "mexico/constants.rb"
+require "mexico/fiesta.rb"
+require 'mexico/cmd.rb'