mexico 0.0.9

data/info/releasenotes/0.0.9.md

@@ -0,0 +1,7 @@
+## Release notes for version 0.0.9
+
++ **#94**: Added implementation of constraints, and specs and assets for testing or debugging constraints.
++ **#150**: Created a first version of the import and export interface.
++ **#152**: Importers for Praat TextGrid and ShortTextGrid formats are now integrated.
++ **#153**: Completed first implementation of ELAN EAF import (still incomplete).
++ **#215**: The library now has flexible accessors for scales, layers, and items.

data/lib/mexico/cmd.rb

@@ -0,0 +1,210 @@
+# 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 'optparse'
+require 'colorize'
+
+# This class serves as the interface for the MExiCo executable. All subcommands
+# of the MExiCo executable are bound to class methods of the +Cmd+ class.
+class Mexico::Cmd
+
+  # Array of names of currently supported subcommands.
+  SUBCOMMANDS = %w(help info init status)
+
+  # Hash of descriptions for the currently supported subcommands.
+  SUBCOMMAND_DESCRIPTIONS = {}
+
+  SUBCOMMAND_DESCRIPTIONS["help"]   = "Display helpful information and exit."
+  SUBCOMMAND_DESCRIPTIONS["info"]   = "Display information about the corpus the current folder belongs to."
+  SUBCOMMAND_DESCRIPTIONS["init"]   = "Create corpus structure files in an existing or new folder."
+  SUBCOMMAND_DESCRIPTIONS["status"] = "Show status info of file linkage and format conversion."
+
+  # the default banner to be displayed on the console when asked for how to use the executable.
+  DEFAULT_BANNER = "Usage: mexico [subcommand] [options]"
+
+  # Hash of option parser objects for the currently supported subcommand.s
+  OPTION_PARSERS = {}
+
+  OPTION_PARSERS["help"] = OptionParser.new do |opts|
+  end
+
+  OPTION_PARSERS["info"] = OptionParser.new do |opts|
+    opts.banner = "Usage: mexico info [options]"
+    opts.on("-p", "--path PATH", "Look for corpus manifest at PATH") do |p|
+      @@options[:path] = p
+    end
+  end
+
+  OPTION_PARSERS["init"] = OptionParser.new do |opts|
+    opts.banner = "Usage: mexico init [options]"
+    opts.on("-p", "--path PATH", "Create corpus folder and manifest at PATH") do |p|
+      @@options[:path] = p
+    end
+  end
+
+  OPTION_PARSERS.values.each do |p|
+    p.on("-v", "--[no-]verbose", "Run verbosely") do |v|
+      @@options[:verbose] = v
+    end
+    p.on("-d", "--[no-]debug", "Turn on debugging output") do |d|
+      @@options[:debug] = d
+    end
+    p.separator ""
+    p.separator "Available subcommands are"
+    p.separator "-------------------------"
+    SUBCOMMANDS.each do |sc|
+      p.separator "%8s - %s" % [sc, SUBCOMMAND_DESCRIPTIONS[sc]]
+    end
+  end
+
+  @@options = {}
+
+  # Helper method that writes an informative verbose message to the console
+  # if the +verbose+ parameter was given on the command line.
+  # @param (String) message A verbose message to be sent to stdout.
+  # @return (void)
+  def self.verbose(message)
+    puts "VERBOSE:  #{message}".cyan if @@options[:verbose]
+  end
+
+  # Helper method that writes debugging information (typically in critical
+  # and error cases) to the console
+  # if the +debug+ parameter was given on the command line.
+  # @param (String) message A debugging message to be sent to stdout.
+  # @return (void)
+  def self.debug(message)
+    puts "DEBUG:    #{message}".magenta if @@options[:debug]
+  end
+
+  # helper method that creates a human-readable file size representation
+  # (suffixed with "KB", "MB", "GB", etc.).
+  # @param (Number) number the number to be formatted
+  # @return (String) a human-readable file size representation of that number
+  def self.humanize(number)
+    prefs = %w(T G M K)
+    display_number = number.to_f
+    unit = ""
+    while(display_number>1000 && !prefs.empty?)
+      display_number = display_number / 1024.0
+      unit = prefs.pop()
+    end
+    return "%.1f %sB" % [display_number, unit]
+  end
+
+  # The core method that is called when the executable runs.
+  # @param (Collection) arx a list of the command line parameters.
+  # @return (void) Should not return anything since {System::exit}
+  #   is usually called at some point in this method.
+  def self.run!(arx)
+    argsize = ARGV.size
+    if argsize>0
+      subcommand = ARGV.shift
+
+      if SUBCOMMANDS.include?(subcommand)
+        # ok, command is known
+        if argsize>1
+          OPTION_PARSERS[subcommand].parse!
+        else
+          # no more commands.
+        end
+        self.verbose "Verbose mode. MExiCo displays more info on what it does in cyan."
+        self.debug   "Debug mode. MExiCo displays lots of internal information in magenta."
+        self.verbose "MExiCo #{subcommand}"
+        Mexico::Cmd.send(subcommand, @@options)
+      else
+        # break: command not known
+        OPTION_PARSERS['help'].parse!
+        self.help(@@options)
+      end
+      self.debug("Detected arguments:  %s" % @@options)
+      unless ARGV.empty?
+        self.debug("Leftover arguments:  %s" % ARGV)
+      end
+      self.debug("Subcommand:          %s" % subcommand)
+    else
+      puts option_parser
+      exit(1)
+    end
+    exit(0)
+  end
+
+  # This method handles the *help* subcommand.
+  # @param (Hash) options a hash of raw options from the command line.
+  # It does nothing but output usage information to the console and quit.
+  # @return nil
+  def self.help(options)
+    puts "Help".magenta
+    puts OPTION_PARSERS['help']
+    exit(0)
+  end
+
+  # This method handles the *info* subcommand. It prints out basic information
+  # about an existing corpus.
+  # @param (Hash) options a hash of raw options from the command line.
+  # @return nil
+  def self.info(options)
+    # check if current folder is corpus folder
+    current_folder = File.dirname(__FILE__)
+    if options.has_key?(:path)
+      current_folder = options[:path]
+    end
+    corpus_manifest = File.join(current_folder,"Corpus.xml")
+    if File.exists?(corpus_manifest)
+      self.verbose "Current Directory '#{current_folder}' is a corpus folder, opening."
+      # open corpus manifest, analyse
+      corpus = Mexico::FileSystem::Corpus.open(current_folder)
+      puts ""
+      puts "-"*72
+      puts "%15s  :  %-50s" % ["Identifier", corpus.identifier]
+      puts "%15s  :  %-50s" % ["Name", corpus.name]
+      displ_description = ""
+      displ_description = corpus.description.split("\n").first unless corpus.description.blank?
+      displ_description = displ_description.slice(0,47)+" ..." unless displ_description.length<47
+      puts "%15s  :  %-50s" % ["Description", displ_description]
+      puts "-"*72
+      puts "%15s  :  %-50s" % ["Designs", corpus.designs.size]
+      puts "%15s  :  %-50s" % ["Trials", corpus.trials.size]
+      puts "%15s  :  %-50s" % ["Resources", corpus.resources.size]
+      puts "%15s  :  %-50s" % ["Local Files", corpus.resources.collect{|i| i.local_files}.flatten.size]
+      puts "%15s  :  %-50s" % ["Used Disk Space", humanize(corpus.complete_file_size)]
+      puts "-"*72
+      puts ""
+    else
+      puts "Error: No corpus manifest folder found in '#{current_folder}'.".red
+      puts "Seems like no corpus has been initialized here.".red
+      exit(1)
+    end
+  end
+
+  # This method handles the *init* subcommand. It can create the necessary structures and files
+  # for a new corpus folder.
+  # @param (Hash) options a hash of raw options from the command line.
+  # @return nil
+  def self.init(options)
+    puts "The 'init' subcommand is not yet implemented."
+    exit(0)
+  end
+
+  # This method handles the *status* subcommand. It outputs various pieces of information about
+  # the corpus, its linkage to a remote repository, untracked files, etc.
+  def self.status(options)
+    puts "The 'status' subcommand is not yet implemented."
+    exit(0)
+  end
+  
+end

data/lib/mexico/constants.rb

@@ -0,0 +1,82 @@
+# 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 aggregates all constant (type-level) objects that
+# are needed for corpus management.
+module Mexico::Constants
+  
+  # This module lists all participant roles
+  # that are part of the current MExiCo model.
+  module ParticipantRoles
+    
+    # A naive participant who does not have additional
+    # background information about the experiment
+    NAIVE       = Mexico::FileSystem::ParticipantRole.new :identifier =>'naive',       :name => 'Naive Participant'
+    
+    # A participant who has been instructed and informed
+    # about the experiment in at least one aspect, and
+    # who pretends to be naive to other participants
+    CONFEDERATE = Mexico::FileSystem::ParticipantRole.new :identifier =>'confederate', :name => 'Confederate'
+  
+    # container for all other roles
+    OTHER = Mexico::FileSystem::ParticipantRole.new :identifier =>'other-participant-role', :name => 'Other'
+    
+    # A collection of all participant roles currently predefined.
+    ALL = Array.new
+    ALL << ::Mexico::Constants::ParticipantRoles::NAIVE
+    ALL << ::Mexico::Constants::ParticipantRoles::CONFEDERATE
+
+    # retrieves a participant role object by its key.
+    # @param [String] key The key of the needed participant role.
+    # @return [Mexico::FileSystem::ParticipantRole,nil] the participant role object, or nil, if no object was found.
+    def self.get(key)
+      ::Mexico::Constants::ParticipantRoles::ALL.first{ |x| x.identifier==key}  
+    end
+
+    # checks for the existence of a predefined participant role object.
+    # @param [String] key The key of the needed participant role.
+    # @return [true,false] true iff such a participant role object exists, false otherwise.
+    def self.has?(key)
+      ::Mexico::Constants::ParticipantRoles::ALL.select{ |x| x.identifier==key}.size>0
+    end
+    
+  end
+
+  # Scale modes are categories of scales based on the publication by S. S. Stevens
+  # (Stevens, S. S. (1946). On the Theory of Scales of Measurement. Science, 103(2684), pp.677-680).
+  # scales have different properties and allow different operations depending on their
+  # level.
+  module ScaleModes
+
+    # The nominal scale is the simplest scale mode. It makes equality / inequality operations available.
+    NOMINAL  = "nominal"
+
+    # The ordinal scale mode is the next mode after the nominal mode. Besides all operations of the
+    # nominal mode, it makes an ordering operations and comparisons available.
+    ORDINAL  = "ordinal"
+
+    # The cardinal scale mode is the next mode after the ordinal mode. Besides all operations of the
+    # ordinal mode, it makes operations and comparisons based on distances or metrics available.
+    CARDINAL = "cardinal"
+
+    # The ratio scale mode is the next mode after the cardinal mode. Besides all operations of the
+    # cardinal mode, it makes operations and comparisons based on a zero point available.
+    RATIO    = "ratio"
+  end
+
+end

data/lib/mexico/constraints/constraint.rb

@@ -0,0 +1,85 @@
+# 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 defines a constraint used for type-validating an object.
+
+class Mexico::Constraints::Constraint
+
+
+  def self.create(key, config={}, &evaluator)
+    constraint = self.new(key, evaluator)
+    constraint.add_parent(config[:parent]) if config.has_key?(:parent)
+    config[:parents].each{ |p| constraint.add_parent(p) } if config.has_key?(:parents)
+
+    @@REGISTERED_CONSTRAINTS = {} unless defined?(@@REGISTERED_CONSTRAINTS)
+    @@REGISTERED_CONSTRAINTS[key] = constraint
+
+    return constraint
+  end
+
+  def self.knows?(key)
+    defined?(@@REGISTERED_CONSTRAINTS) && @@REGISTERED_CONSTRAINTS.has_key?(key)
+  end
+
+  def self.get(key)
+    defined?(@@REGISTERED_CONSTRAINTS) && @@REGISTERED_CONSTRAINTS[key]
+  end
+
+  def evaluate(document)
+    self.evaluator.call(document)
+  end
+
+  def initialize(key, evaluator)
+    @key = key
+    @evaluator = evaluator
+    @parents = []
+    @children = []
+  end
+
+  def add_parent(parent)
+    internal_add_parent(parent)
+    parent.internal_add_child(self)
+  end
+
+  def add_child(child)
+    internal_add_child(child)
+    child.internal_add_parent(self)
+  end
+
+
+  attr_reader :evaluator
+  attr_accessor :key
+  attr_accessor :parents
+  attr_accessor :children
+
+  private
+
+  attr_writer :evaluator
+
+  protected
+
+  def internal_add_parent(parent)
+    @parents << parent
+  end
+
+  def internal_add_child(child)
+    @children << child
+  end
+
+end

data/lib/mexico/constraints/fiesta_constraints.rb

@@ -0,0 +1,209 @@
+# 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/>.
+
+
+module Mexico::Constraints::FiestaConstraints
+
+  include Mexico::Constraints
+
+  TOP = Constraint.create('TOP') do |doc|
+    true
+  end
+
+  # # # # # # # # # # # # # # # # # # # # # # # # # # #
+  # Scale-related constraints
+  # # # # # # # # # # # # # # # # # # # # # # # # # # #
+
+  SCALES_TOP = Constraint.create('SCALES_TOP', parent: TOP) do |doc|
+    true
+  end
+
+  SCALES_LTE_3 = Constraint.create('SCALES_LTE_3', parent: SCALES_TOP) do |doc|
+    doc.scales.size <= 3
+  end
+
+  SCALES_LTE_2 = Constraint.create('SCALES_LTE_2', parent: SCALES_LTE_3) do |doc|
+    doc.scales.size <= 2
+  end
+
+  SCALES_LTE_1 = Constraint.create('SCALES_LTE_1', parent: SCALES_LTE_2) do |doc|
+    doc.scales.size <= 1
+  end
+
+  SCALES_GTE_1 = Constraint.create('SCALES_GTE_1', parent: SCALES_TOP) do |doc|
+    doc.scales.size >= 1
+  end
+
+  SCALES_GTE_2 = Constraint.create('SCALES_GTE_2', parent: SCALES_GTE_1) do |doc|
+    doc.scales.size >= 2
+  end
+
+  SCALES_GTE_3 = Constraint.create('SCALES_GTE_3', parent: SCALES_GTE_2) do |doc|
+    doc.scales.size >= 3
+  end
+
+  SCALES_GTE_4 = Constraint.create('SCALES_GTE_4', parent: SCALES_GTE_3) do |doc|
+    doc.scales.size >= 4
+  end
+
+  SCALES_HAS_1_TIMELINE = Constraint.create('SCALES_HAS_1_TIMELINE', parent: SCALES_GTE_1) do |doc|
+    SCALES_GTE_1.evaluate(doc) && doc.scales[0].is_timeline?
+  end
+
+  SCALES_HAS_2_TIMELINES = Constraint.create('SCALES_HAS_2_TIMELINES', parent: SCALES_GTE_2) do |doc|
+    SCALES_GTE_2.evaluate(doc) && doc.scales[0].is_timeline? && doc.scales[1].is_timeline?
+  end
+
+  SCALES_EX_1_TIMELINE = Constraint.create('SCALES_EX_1_TIMELINE', parents: [SCALES_HAS_1_TIMELINE,SCALES_LTE_1]) do |doc|
+    SCALES_HAS_1_TIMELINE.evaluate(doc) && SCALES_LTE_1.evaluate(doc)
+  end
+
+
+  # # # # # # # # # # # # # # # # # # # # # # # # # # #
+  # Constraints related to layer structures
+  # # # # # # # # # # # # # # # # # # # # # # # # # # #
+
+  LAYERS_TOP = Constraint.create('LAYERS_TOP', parent: TOP) do |doc|
+    true
+  end
+
+  LAYERS_GRAPH = Constraint.create('LAYERS_GRAPH', parent: LAYERS_TOP) do |doc|
+    true
+  end
+
+  LAYERS_DAG = Constraint.create('LAYERS_DAG', parent: LAYERS_GRAPH) do |doc|
+    doc.layers_form_a_dag?
+  end
+
+  LAYERS_CDAG = Constraint.create('LAYERS_CDAG', parent: LAYERS_DAG) do |doc|
+    doc.layers_form_a_cdag?
+  end
+
+  LAYERS_FOREST = Constraint.create('LAYERS_FOREST', parent: LAYERS_DAG) do |doc|
+    doc.layers_form_a_forest?
+  end
+
+  LAYERS_TREE = Constraint.create('LAYERS_TREE', parents: [LAYERS_CDAG,LAYERS_FOREST]) do |doc|
+    doc.layers_form_a_tree?
+  end
+
+  LAYERS_EDGELESS = Constraint.create('LAYERS_EDGELESS', parent: LAYERS_FOREST) do |doc|
+    doc.layers_form_an_edgeless_graph?
+  end
+
+  LAYERS_EMPTY = Constraint.create('LAYERS_EMPTY', parent: LAYERS_GRAPH) do |doc|
+    doc.layers_form_an_empty_graph?
+  end
+
+
+  # # # # # # # # # # # # # # # # # # # # # # # # # # #
+  # Constraints related to intra-layer structures
+  # # # # # # # # # # # # # # # # # # # # # # # # # # #
+
+  INTRALAYER_TOP = Constraint.create('INTRALAYER_TOP', parent: TOP) do |doc|
+    true
+  end
+
+  INTRALAYER_GRAPH_ALL = Constraint.create('INTRALAYER_GRAPH', parent: INTRALAYER_TOP) do |doc|
+    true
+  end
+
+  INTRALAYER_FOREST_ALL = Constraint.create('INTRALAYER_FOREST_ALL', parent: INTRALAYER_GRAPH_ALL) do |doc|
+    boolean_result = true
+    doc.layers.each do |layer|
+      boolean_result = boolean_result && layer.items_form_a_forest?
+    end
+    boolean_result
+  end
+
+  # This one is actually used.
+  INTRALAYER_EDGELESS_ALL = Constraint.create('INTRALAYER_EDGELESS_ALL', parent: INTRALAYER_FOREST_ALL) do |doc|
+    boolean_result = true
+    doc.layers.each do |layer|
+      boolean_result = boolean_result && layer.items_form_an_edgeless_graph?
+    end
+    boolean_result
+  end
+
+  # # # # # # # # # # # # # # # # # # # # # # # # # # #
+  # Constraints related to inter-layer structures
+  # # # # # # # # # # # # # # # # # # # # # # # # # # #
+
+  # needed: calculation of the inter-layer-graph
+  # take all nodes from layer 1, all nodes from layer 2
+  # find all item links that have a l1 node as source and an l2 node as target
+
+  INTERLAYER_TOP = Constraint.create('INTERLAYER_TOP', parent: TOP) do |doc|
+    true
+  end
+
+  INTERLAYER_SOURCE_LTE_1 = Constraint.create('INTERLAYER_SOURCE_LTE_1', parent: INTERLAYER_TOP) do |doc|
+    puts doc.inter_layer_source_cardinality
+    doc.inter_layer_source_cardinality <= 1
+  end
+
+  INTERLAYER_SOURCE_0 = Constraint.create('INTERLAYER_SOURCE_0', parent: INTERLAYER_SOURCE_LTE_1) do |doc|
+    puts doc.inter_layer_source_cardinality
+    doc.inter_layer_source_cardinality == 0
+  end
+
+  INTERLAYER_SINK_LTE_1 = Constraint.create('INTERLAYER_SINK_LTE_1', parent: INTERLAYER_TOP) do |doc|
+    puts doc.inter_layer_sink_cardinality
+    doc.inter_layer_sink_cardinality <= 1
+  end
+
+  INTERLAYER_SINK_0 = Constraint.create('INTERLAYER_SINK_0', parent: INTERLAYER_SINK_LTE_1) do |doc|
+    puts doc.inter_layer_sink_cardinality
+    oc.inter_layer_sink_cardinality == 0
+  end
+
+  INTERLAYER_1_TO_N = Constraint.create('INTERLAYER_1_TO_N', parents: [INTERLAYER_SOURCE_LTE_1]) do |doc|
+    INTERLAYER_SOURCE_LTE_1.evaluate(doc)
+  end
+
+  INTERLAYER_N_TO_1 = Constraint.create('INTERLAYER_N_TO_1', parents: [INTERLAYER_SINK_LTE_1]) do |doc|
+    INTERLAYER_SINK_LTE_1.evaluate(doc)
+  end
+
+  INTERLAYER_1_TO_1 = Constraint.create('INTERLAYER_1_TO_1', parents: [INTERLAYER_1_TO_N, INTERLAYER_N_TO_1]) do |doc|
+    INTERLAYER_1_TO_N.evaluate(doc) && INTERLAYER_N_TO_1.evaluate(doc)
+  end
+
+  INTERLAYER_EDGELESS = Constraint.create('INTERLAYER_EDGELESS', parents: [INTERLAYER_SOURCE_0,INTERLAYER_SINK_0]) do |doc|
+    INTERLAYER_SOURCE_0.evaluate(doc) && INTERLAYER_SINK_0.evaluate(doc)
+  end
+
+
+  # # # # # # # # # # # # # # # # # # # # # # # # # # #
+  # Constraints related values
+  # # # # # # # # # # # # # # # # # # # # # # # # # # #
+
+  VALUES_TOP = Constraint.create('VALUES_TOP', parent: TOP) do |doc|
+    true
+  end
+
+  VALUES_STRINGS_ONLY = Constraint.create('VALUES_STRINGS_ONLY', parent: VALUES_TOP) do |doc|
+    doc.items.collect{|i| i.data }.all?{|d| d.is_string?}
+  end
+
+  VALUES_MAPS_ONLY = Constraint.create('VALUES_MAPS_ONLY', parent: VALUES_TOP) do |doc|
+    doc.items.collect{|i| i.data }.all?{|d| d.is_map?}
+  end
+
+end

data/lib/mexico/constraints.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/>.
+
+# This module aggregates all constant (type-level) objects that
+# are needed for corpus management.
+
+module Mexico::Constraints
+
+end
+
+require 'mexico/constraints/constraint.rb'
+require 'mexico/constraints/fiesta_constraints.rb'

data/lib/mexico/core/corpus_core.rb

@@ -0,0 +1,39 @@
+# 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 Corpus core module contains methods for implementations of the
+# corpus class that are independent of the implementation.
+module Mexico::Core::CorpusCore
+  
+  #def included(x)
+  #  puts "CorpusCore is now included in #{x}."  
+  #end
+  
+  #def extended(x)
+  #  puts "CorpusCore now extends #{x}."  
+  #end
+  
+  # simple test method that can be called to see whether the module
+  # was included successfully
+  def core_included?
+    true
+  end  
+  
+end
+
+

data/lib/mexico/core/design_core.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 Design core module contains methods for implementations of the
+# design class that are independent of the implementation.
+module Mexico::Core::DesignCore
+  
+  # simple test method that can be called to see whether the module
+  # was included successfully
+  def core_included?
+    true
+  end  
+  
+end
+
+