iqvoc 3.2.3

data/lib/iqvoc/rdf_helper.rb

@@ -0,0 +1,67 @@
+# encoding: UTF-8
+
+# Copyright 2011 innoQ Deutschland GmbH
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Iqvoc
+  # TODO: The whole class should move to umt because it highly proprietary
+  # (and also has the wrong name because it only deals with "turtle").
+  # TODO: The term "Helper" is misleading.
+  class RdfHelper
+
+    LITERAL_REGEXP = /"(.*)"@([a-zA-Z]{2})/
+
+    NSMAP = {
+      'rdf'  => "http://www.w3.org/1999/02/22-rdf-syntax-ns#",
+      'skos' => "http://www.w3.org/2004/02/skos/core#",
+      'owl'  => "http://www.w3.org/2002/07/owl#",
+      'rdfs' => "http://www.w3.org/2000/01/rdf-schema#" }
+
+    def self.extract_id(uri)
+      uri =~ /([^\/]+)\/{0,1}$/
+      $1
+    end
+
+    def self.is_literal_form?(str)
+      str.match LITERAL_REGEXP
+    end
+
+    def self.quote_turtle_literal(val)
+      if val.to_s.match(/^<.*>$/)
+        val
+      else
+        "\"#{val}\""
+      end
+    end
+
+    def self.split_literal(str)
+      elements = str.scan(LITERAL_REGEXP).first
+      @split_literal = {
+        :value    => elements[0].gsub(/\\"/, '"'),
+        :language => elements[1]
+      }
+      RAILS_DEFAULT_LOGGER.debug "@split_literal => #{@split_literal}"
+      @split_literal
+    end
+
+    def self.to_xml_attribute_array
+      res = {}
+      NSMAP.each do |k,v|
+        res["xmlns:#{k}"] = v
+      end
+      res
+    end
+
+  end
+end

data/lib/iqvoc/skos_importer.rb

@@ -0,0 +1,144 @@
+module Iqvoc
+  class SkosImporter
+
+    FIRST_LEVEL_OBJECT_CLASSES = [Iqvoc::Concept.base_class]
+    SECOND_LEVEL_OBJECT_CLASSES = Iqvoc::Concept.labeling_classes.keys +
+      Iqvoc::Concept.note_classes +
+      Iqvoc::Concept.relation_classes +
+      Iqvoc::Concept.match_classes
+
+    def initialize(file, default_namespace_url)
+      unless file.is_a?(File) || file.is_a?(Array)
+        raise "Iqvoc::SkosImporter#import: Parameter 'file' should be a File or an Array."
+      end
+
+      # Some general Namespaces to support in any case
+      @prefixes = {
+        "http://www.w3.org/2004/02/skos/core#" => "skos:",
+        "http://www.w3.org/2008/05/skos#" => "skos:",
+        "http://www.w3.org/1999/02/22-rdf-syntax-ns#" => "rdf:",
+        default_namespace_url => ":"
+      }
+      # Add the namespaces specified in the Iqvoc config
+      Iqvoc.rdf_namespaces.each do |pref, uri|
+        @prefixes[uri] = "#{pref.to_s}:"
+      end
+
+      @seen_first_level_objects = {}
+
+      @existing_origins = {} # To prevent the creation of first level objects we already have
+      FIRST_LEVEL_OBJECT_CLASSES.each do |klass|
+        klass.select("origin").all.each do |thing|
+          @existing_origins[thing.origin] = klass
+        end
+      end
+
+      import(file)
+    end
+
+    private
+
+    def import(file)
+      types = {} # type identifier ("namespace:SomeClass") to Iqvoc class assignment hash
+      FIRST_LEVEL_OBJECT_CLASSES.each do |klass|
+        types["#{klass.rdf_namespace}:#{klass.rdf_class}"] = klass
+      end
+      file.each do |line|
+        import_first_level_objects(types, *extract_triple(line))
+      end
+      new_subjects = @seen_first_level_objects.dup # Remember the objects seen yet, because they are the ones to be published later
+
+      file.rewind if file.is_a?(IO)
+      types = {}
+      SECOND_LEVEL_OBJECT_CLASSES.each do |klass|
+        types["#{klass.rdf_namespace}:#{klass.rdf_predicate}"] = klass
+      end
+      file.each do |line|
+        import_second_level_objects(types, *extract_triple(line))
+      end
+
+      new_subjects.each do |id, subject|
+        if subject.valid_with_full_validation?
+          subject.publish
+          subject.save!
+        else
+          Rails.logger.warn "WARNING: Subject not valid: '#{subject.origin}'. Won't be published automatically.."
+        end
+      end
+
+    end
+
+    def import_first_level_objects(types, subject, predicate, object)
+      if (predicate == "rdf:type" && types[object] && subject =~ /^:(.+)$/)
+        # We've found a subject definition with a class we know and which is in our responsibility (":")
+        origin = $1
+
+        if (@existing_origins[origin])
+          if (types[object] == @existing_origins[origin])
+            Rails.logger.info "Iqvoc::SkosImporter: Subject with origin '#{origin}' already exists. Skipping duplicate creation (should be no problem)."
+          else
+            Rails.logger.warn "Iqvoc::SkosImporter: Subject with origin '#{origin} already exists but has another class (#{@existing_origins[origin]}) then the one I wanted to create (#{types[object]}). You seem to have a problem with your configuration!"
+          end
+        else
+          @seen_first_level_objects[origin] = types[object].create!(:origin => origin)
+        end
+      end
+    end
+
+    def import_second_level_objects(types, subject, predicate, object)
+      return unless (subject =~ /^:(.*)$/ && types[predicate]) # We're not responsible for this
+
+      # Load the subject and replace the string by the respective data object
+      subject_origin = $1
+      subject = load_first_level_object(subject_origin)
+      unless subject
+        Rails.logger.warn "Iqvoc::SkosImporter: Couldn't find Subject with origin '#{subject_origin}. Skipping entry '#{subject} #{predicate} #{object}.'"
+        return
+      end
+
+      # Load the data object for the object string if this is representing a thing in our domain
+      if (object =~ /^:(.*)$/ && types[predicate])
+        object_origin = $1
+        object = load_first_level_object(object_origin)
+        unless object
+          Rails.logger.warn "Iqvoc::SkosImporter: Couldn't find Object with origin '#{object_origin}. Skipping entry ':#{subject_origin} #{predicate} #{object}.'"
+          return
+        end
+      end
+
+      types[predicate].build_from_rdf(subject, predicate, object)
+    end
+
+    def load_first_level_object(origin)
+      unless @seen_first_level_objects[origin]
+        FIRST_LEVEL_OBJECT_CLASSES.each do |klass|
+          @seen_first_level_objects[origin] = klass.by_origin(origin).last
+          break if @seen_first_level_objects[origin]
+        end
+      end
+      @seen_first_level_objects[origin]
+    end
+
+    def extract_triple(line)
+      raise "'#{line}' doesn't look like valid ntriples data." unless line =~ /^(.*)\.\w*$/
+      line = $1.squish
+
+      triple = line.split(' ', 3) # The first one are uris the last can be a literal too
+
+      triple.each do |e| # Do some fun with the uris and literals
+        @prefixes.keys.each do |uri_prefix| # Use prefixes instead of full uris
+          e.gsub! /<#{uri_prefix}([^>]*)>/ do |matches|
+            @prefixes[uri_prefix] + $1.gsub(".", "_")
+          end
+        end
+        e.squish!
+        e.gsub!(/^:(.*)$/) do
+          ":#{OriginMapping.merge($1)}" # Force correct origins in the default namespace
+        end
+      end
+
+      triple
+    end
+
+  end
+end

data/lib/iqvoc/version.rb

@@ -0,0 +1,19 @@
+# encoding: UTF-8
+
+# Copyright 2011 innoQ Deutschland GmbH
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Iqvoc
+  VERSION = "3.2.3"
+end

data/lib/iqvoc/versioning.rb

@@ -0,0 +1,151 @@
+# encoding: UTF-8
+
+# Copyright 2011 innoQ Deutschland GmbH
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Iqvoc
+  module Versioning
+
+    extend ActiveSupport::Concern
+
+    included do
+
+      # ********* Relations
+
+      belongs_to :published_version, :foreign_key => 'published_version_id', :class_name => name
+
+      belongs_to :locking_user, :foreign_key => 'locked_by', :class_name => 'User'
+
+      # ********* Scopes
+
+      scope :by_origin, lambda { |origin|
+        where(:origin => origin)
+      }
+
+      scope :published, lambda {
+        where(arel_table[:published_at].not_eq(nil))
+      }
+      scope :unpublished,  lambda {
+        where(:published_at => nil)
+      }
+      # The following scope returns all objects which should be selectable by the editor
+      scope :editor_selectable, lambda {
+        where(
+          arel_table[:published_at].not_eq(nil).or( # == published (is there a way to OR comibne two scopes? [published OROPERATOR where(...)])
+            arel_table[:published_at].eq(nil).and(arel_table[:published_version_id].eq(nil)) # this are all unpublished with no published version
+          )
+        )
+      }
+
+      scope :in_edit_mode, lambda {
+        where(arel_table[:locked_by].not_eq(nil))
+      }
+
+      scope :unpublished_or_follow_up, lambda {
+        where(
+          arel_table[:published_at].eq(nil).or(
+            arel_table[:follow_up].not_eq(nil)
+          )
+        )
+      }
+
+      scope :unsynced, where(:rdf_updated_at => nil)
+
+    end
+
+    # ********* Methods
+
+    def branch(user)
+      new_version = self.clone(:include => self.class.includes_to_deep_cloning)
+      new_version.lock_by_user(user.id)
+      new_version.increment!(:rev)
+      new_version.published_version_id = self.id
+      new_version.unpublish
+      new_version.send(:"#{Iqvoc.change_note_class_name.to_relation_name}").build(
+        :language => I18n.locale.to_s,
+        :annotations_attributes => [
+          { :namespace => "dct", :predicate => "creator", :value => user.name },
+          { :namespace => "dct", :predicate => "modified", :value => DateTime.now.to_s }
+        ])
+      new_version
+    end
+
+    def publish
+      write_attribute(:published_at, Time.now)
+      write_attribute(:to_review, nil)
+      write_attribute(:published_version_id, nil)
+    end
+
+    def unpublish
+      write_attribute(:published_at, nil)
+    end
+
+    def published?
+      read_attribute(:published_at).present?
+    end
+
+    # Editor selectable if published or no published version exists (before
+    # first publication)
+    def editor_selectable?
+      published? || read_attribute(:published_version_id).blank?
+    end
+
+    def lock_by_user(user_id)
+      write_attribute(:locked_by, user_id)
+    end
+
+    def locked?
+      locked_by?
+    end
+
+    def state
+      if published?
+        I18n.t("txt.common.state.published")
+      elsif !published? && in_review?
+        I18n.t("txt.common.state.in_review")
+      elsif !published? && !in_review?
+        I18n.t("txt.common.state.checked_out")
+      end
+    end
+
+    def unlock
+      write_attribute(:locked_by, nil)
+    end
+
+    def in_review?
+      read_attribute(:to_review).present?
+    end
+
+    def to_review
+      write_attribute(:to_review, true)
+    end
+
+    module ClassMethods
+
+      def include_to_deep_cloning(*association_names)
+        (@@include_to_deep_cloning ||= {})[self] ||= []
+        association_names.each do |association_name|
+          @@include_to_deep_cloning[self] << association_name
+        end
+      end
+
+      def includes_to_deep_cloning
+        (@@include_to_deep_cloning ||= {})[self] ||= []
+        (@@include_to_deep_cloning.keys & self.ancestors).map{|c| @@include_to_deep_cloning[c]}.flatten.compact
+      end
+
+    end
+
+  end
+end

data/lib/iqvoc.rb

@@ -0,0 +1,228 @@
+# encoding: UTF-8
+
+# Copyright 2011 innoQ Deutschland GmbH
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require 'string'
+
+module Iqvoc
+
+  unless Iqvoc.const_defined?(:Application)
+    require File.join(File.dirname(__FILE__), '../config/engine')
+  end
+
+  mattr_accessor :title,
+    :searchable_class_names,
+    :unlimited_search_results,
+    :available_languages,
+    :default_rdf_namespace_helper_methods,
+    :rdf_namespaces,
+    :change_note_class_name,
+    :additional_js_files,
+    :additional_css_files,
+    :first_level_class_configuration_modules,
+    :ability_class_name
+
+  self.title = "iQvoc"
+
+  self.searchable_class_names = [
+    'Labeling::SKOS::Base',
+    'Labeling::SKOS::PrefLabel',
+    'Note::Base'
+  ]
+  self.unlimited_search_results = false
+
+  self.available_languages = [:en, :de]
+
+  self.default_rdf_namespace_helper_methods = [:iqvoc_default_rdf_namespaces]
+
+  self.rdf_namespaces = {
+    :rdf  => "http://www.w3.org/1999/02/22-rdf-syntax-ns#",
+    :rdfs => "http://www.w3.org/2000/01/rdf-schema#",
+    :owl  => "http://www.w3.org/2002/07/owl#",
+    :skos => "http://www.w3.org/2004/02/skos/core#",
+    :dct  => "http://purl.org/dc/terms/"
+  }
+
+  # The class to use for automatic generation of change notes on every save
+  self.change_note_class_name = 'Note::SKOS::ChangeNote'
+
+  # Use these config hooks in your engine to inject your custom js and css includes.
+  self.additional_js_files  = []
+  self.additional_css_files = []
+
+  self.first_level_class_configuration_modules = [] # Will be set in the modules
+
+  self.ability_class_name = 'Iqvoc::Ability'
+
+  def self.change_note_class
+    change_note_class_name.constantize
+  end
+
+  def self.searchable_classes
+    searchable_class_names.map(&:constantize)
+  end
+
+  def self.first_level_classes
+    self.first_level_class_configuration_modules.map { |mod| mod.send(:base_class) }
+  end
+
+  def self.ability_class
+    ability_class_name.constantize
+  end
+
+  # ************** Concept specific settings **************
+
+  module Concept
+
+    Iqvoc.first_level_class_configuration_modules << self
+
+    mattr_accessor :base_class_name,
+      :broader_relation_class_name, :further_relation_class_names,
+      :pref_labeling_class_name, :pref_labeling_languages, :further_labeling_class_names,
+      :match_class_names,
+      :note_class_names,
+      :additional_association_class_names,
+      :view_sections,
+      :include_module_names
+
+    self.base_class_name              = 'Concept::SKOS::Base'
+
+    self.broader_relation_class_name  = 'Concept::Relation::SKOS::Broader::Mono'
+    self.further_relation_class_names = [ 'Concept::Relation::SKOS::Related' ]
+
+    self.pref_labeling_class_name     = 'Labeling::SKOS::PrefLabel'
+    self.pref_labeling_languages      = [:en, :de]
+    self.further_labeling_class_names = { 'Labeling::SKOS::AltLabel' => [:de, :en] }
+
+    self.note_class_names             = [
+      Iqvoc.change_note_class_name,
+      'Note::SKOS::Definition',
+      'Note::SKOS::EditorialNote',
+      'Note::SKOS::Example',
+      'Note::SKOS::HistoryNote',
+      'Note::SKOS::ScopeNote'
+    ]
+
+    self.match_class_names            = [
+      'Match::SKOS::CloseMatch',
+      'Match::SKOS::ExactMatch',
+      'Match::SKOS::RelatedMatch',
+      'Match::SKOS::BroadMatch',
+      'Match::SKOS::NarrowMatch',
+    ]
+
+    self.additional_association_class_names = {}
+
+    self.view_sections = ["main", "labels", "relations", "notes", "matches"]
+
+    self.include_module_names = []
+
+    # Do not use the following method in models. This will probably cause a
+    # loading loop (something like "expected file xyz to load ...")
+    def self.base_class
+      base_class_name.constantize
+    end
+
+    def self.pref_labeling_class
+      pref_labeling_class_name.constantize
+    end
+
+    def self.labeling_class_names
+      { pref_labeling_class_name => pref_labeling_languages }.merge(further_labeling_class_names)
+    end
+
+    def self.labeling_classes
+      { pref_labeling_class => pref_labeling_languages }.merge(further_labeling_classes)
+    end
+
+    def self.broader_relation_class
+      broader_relation_class_name.constantize
+    end
+
+    def self.further_labeling_classes
+      further_labeling_class_names.keys.each_with_object({}) do |class_name, hash|
+        hash[class_name.constantize] = further_labeling_class_names[class_name]
+      end
+    end
+
+    def self.relation_class_names
+      further_relation_class_names + [broader_relation_class_name, broader_relation_class.narrower_class.name]
+    end
+
+    def self.relation_classes
+      relation_class_names.map(&:constantize)
+    end
+
+    def self.further_relation_classes
+      further_relation_class_names.map(&:constantize)
+    end
+
+    def self.note_classes
+      note_class_names.map(&:constantize)
+    end
+
+    def self.match_classes
+      match_class_names.map(&:constantize)
+    end
+
+    def self.additional_association_classes
+      additional_association_class_names.keys.each_with_object({}) do |class_name, hash|
+        hash[class_name.constantize] = additional_association_class_names[class_name]
+      end
+    end
+
+    def self.supports_multi_language_pref_labelings?
+      pref_labeling_languages.size > 1
+    end
+
+    def self.include_modules
+      include_module_names.map(&:constantize)
+    end
+
+  end
+
+  # ************** Collection specific settings **************
+
+  module Collection
+
+    mattr_accessor :base_class_name
+
+    self.base_class_name = 'Collection::Unordered'
+
+    def self.base_class
+      base_class_name.constantize
+    end
+  end
+
+  # ************** Label specific settings **************
+
+  module Label
+
+    mattr_accessor :base_class_name
+
+    self.base_class_name        = 'Label::SKOS::Base'
+
+    # Do not use the following method in models. This will probably cause a
+    # loading loop (something like "expected file xyz to load ...")
+    def self.base_class
+      base_class_name.constantize
+    end
+
+  end
+
+end
+
+# FIXME: For yet unknown reasons, the load hook gets to run 2 times
+ActiveSupport.run_load_hooks(:after_iqvoc_config, Iqvoc)