iqvoc 3.4.0 → 3.5.0

data/config/initializers/iqvoc.rb

@@ -26,18 +26,8 @@ ActiveRecord::Base.send :include, Iqvoc::DeepCloning
 
 ##### INSTANCE SETTINGS #####
 
-# uncomment the settings below and adjust as desired
-# see lib/iqvoc.rb for the full list of available setting
+# initialize non-dynamic settings below
+# see lib/iqvoc.rb for the list of available setting
 
 unless Rails.env.test?
-  # Iqvoc.title = "My Thesaurus"
-
-  # interface languages (cf. config/locales)
-  # Iqvoc.available_languages = [ :en, :de ]
-
-  # label languages (and classes)
-  # Iqvoc::Concept.pref_labeling_languages      = [ :de, :en ]
-  # Iqvoc::Concept.further_labeling_class_names = {
-  #  "Labeling::SKOS::AltLabel" => [ :de, :en ]
-  # }
 end

data/config/initializers/secret_token.rb

@@ -17,6 +17,7 @@
 # Be sure to restart your server when you modify this file.
 
 if Iqvoc.const_defined?(:Application)
+
   # Your secret key for verifying the integrity of signed cookies.
   # If you change this key, all old signed cookies will become invalid!
   # Make sure the secret is at least 30 characters and all random,
@@ -24,5 +25,6 @@ if Iqvoc.const_defined?(:Application)
 
   # Run `rake secret` and uncomment the following line
   # Replace the secret-placeholder with your generated token
-  Iqvoc::Application.config.secret_token = '175128c5b4a40cfd8b1db1ab15606e20a2263346eca7a1f89b5e06bea6f1d822ac794262642605b53c8c632062826799726e348f383d6b88c19eb93a60c75948'
+  Iqvoc::Application.config.secret_token = '17d06ea2c1b5aceb4274a466a83d3b063094ecb22826c82af3572740bf2d61b30f756f1aea5e6c845ad5c078265065c8748760e655da7f6425a11bbf22ec8007'
+
 end

data/config/locales/de.yml

@@ -81,6 +81,8 @@ de:
          select_language: "Sprache auswählen"
          login: "Anmelden"
          logout: "Abmelden"
+     instance_configuration:
+       caption: "Instanzkonfiguration"
      alphabetical_concepts:
      untranslated_concepts:
        caption: "Fehlende Übersetzungen"
@@ -125,6 +127,7 @@ de:
        back_to_edit_versioned_object: "Zurück zur Bearbeitung"
        back_to_show: "Zurück zur Originalversion"
        back_to_preview: "Zurück zur Versionsvorschau"
+       instance_configuration: "Instanzkonfiguration"
        hierarchical: "Hierarchisch"
        alphabetical: "Alphabetisch"
        search: "Suche"
@@ -243,6 +246,11 @@ de:
      application:
        login_required: "Sie müssen angemeldet sein, um diese Seite aufzurufen."
        logout_required: "Sie müssen abgemeldet sein, um diese Seite aufzurufen."
+     instance_configuration:
+       update_success: "Konfigurationänderungen übernommen."
+       update_error: "Fehler in Konfigurationwerten: %{error_messages}."
+       invalid_key: "unbekanntes Feld: %{key}"
+       invalid_value: "fehlerhafter Wert: %{key} (%{error_message})"
      search_results:
        insufficient_data: "Bitte geben Sie mehr Suchkriterien an."
      users:

data/config/locales/en.yml

@@ -81,6 +81,8 @@ en:
          relations: Relations
          notes: Notes
          matches: Concept mappings
+     instance_configuration:
+       caption: "Instance Configuration"
      alphabetical_concepts:
      untranslated_concepts:
        caption: "Missing Translations"
@@ -133,6 +135,7 @@ en:
        back_to_edit_versioned_object: "Back to editing"
        back_to_show: "Back to original version"
        back_to_preview: "Back to version preview"
+       instance_configuration: "Instance configuration"
        hierarchical: "Hierachical listings"
        alphabetical: "Alphabetical listings"
        search: "Search"
@@ -251,6 +254,11 @@ en:
      application:
        login_required: "You must be logged in to access this page."
        logout_required: "You must be logged out to access this page."
+     instance_configuration:
+       update_success: "Configuration updated."
+       update_error: "Errors occurred while updating configuration: %{error_messages}."
+       invalid_key: "unknown key: #{key}"
+       invalid_value: "unsupported value: %{key} (%{error_message})"
      search_results:
        insufficient_data: "You entered insufficient search data"
      users:

data/config/routes.rb

@@ -18,7 +18,10 @@ Rails.application.routes.draw do
 
   match 'schema(.:format)' => 'pages#schema', :as => 'schema'
 
-  scope '(:lang)', :lang => /#{Iqvoc::Concept.pref_labeling_languages.join("|").presence || " "}/ do
+  scope '(:lang)', :constraints => lambda { |params, req|
+    lang = params[:lang]
+    return lang.nil? || lang.to_s =~ /#{Iqvoc::Concept.pref_labeling_languages.join("|").presence || " "}/
+  } do
 
     resource  :user_session, :only => [:new, :create, :destroy]
     resources :users, :except => [:show]
@@ -44,6 +47,9 @@ Rails.application.routes.draw do
     match 'about(.:format)'     => 'pages#about',          :as => 'about'
     match 'dashboard(.:format)' => 'dashboard#index',      :as => 'dashboard'
 
+    get 'config(.:format)' => 'instance_configuration#index', :as => 'instance_configuration'
+    put 'config(.:format)' => 'instance_configuration#update'
+
     get "import" => "import#index", :as => 'import'
     post "import" => "import#import"
 

data/db/migrate/20120119000000_create_configuration_settings.rb

@@ -0,0 +1,14 @@
+class CreateConfigurationSettings < ActiveRecord::Migration
+
+  def up
+    create_table :configuration_settings, :force => true do |t|
+      t.string :key
+      t.string :value
+    end
+  end
+
+  def down
+    drop_table :configuration_settings
+  end
+
+end

data/lib/debug.rb

@@ -4,11 +4,11 @@ def dbg(*args)
   prefix = "#{args.shift} " if [String, Symbol].include?(args.first.class)
 
   msg = args.map(&:inspect).join(" | ")
-  msg = "[DEBUG] #{prefix}#{msg}"
+  msg = "#{prefix}#{msg}"
 
-  if defined?(Rails::Console) || Rails.env == "test" # STDOUT is usually available here
-    puts msg
+  if defined?(Rails::Console) || Rails.env.test? # STDOUT is usually available here
+    puts "[DEBUG] #{msg}"
   else
-    Rails.logger.debug msg
+    Rails.logger.tagged("DEBUG") { Rails.logger.debug msg }
   end
 end

data/lib/iqvoc.rb

@@ -15,240 +15,32 @@
 # limitations under the License.
 
 require 'string'
+require 'iqvoc/instance_configuration'
+require 'iqvoc/configuration/core'
+require 'iqvoc/configuration/concept'
+require 'iqvoc/configuration/collection'
+require 'iqvoc/configuration/label'
 
 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,
-    :first_level_class_configuration_modules,
-    :ability_class_name,
-    :core_assets
-
-  self.title = "iQvoc"
-
-  self.core_assets = %w(
-    manifest.css
-    manifest.js
-    blueprint/screen.css
-    blueprint/print.css
-    blueprint/ie.css
-    iqvoc/ie_fixes.css
-    excanvas.js
-    jit_rgraph.js
-    iqvoc/visualization.js
-  )
-
-  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'
-
-  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
-
-  def self.generate_secret_token
-    require 'securerandom'
-
-    template = Rails.root.join("config", "initializers", "secret_token.rb.template")
-    raise "File not found: #{template}" unless File.exist?(template)
-
-    file_name = "config/initializers/secret_token.rb"
-
-    token = SecureRandom.hex(64)
-    txt = File.read(template)
-    txt.gsub!("S-E-C-R-E-T", token)
-
-    File.open(file_name, "w") do |f|
-      f.write txt
-    end
-
-    puts "Secret token configuration has been created in #{file_name}."
-  end
-
-  # ************** Concept specific settings **************
+  
+  include Iqvoc::Configuration::Core
 
   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
-
+    include Iqvoc::Configuration::Concept
   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
+    include Iqvoc::Configuration::Collection
   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
-
+    include Iqvoc::Configuration::Label
   end
 
 end
 
-# FIXME: For yet unknown reasons, the load hook gets to run 2 times
+# FIXME: For reasons yet unknown, the load hook is executed twice
 ActiveSupport.run_load_hooks(:after_iqvoc_config, Iqvoc)

data/lib/iqvoc/ability.rb

@@ -32,11 +32,12 @@ module Iqvoc
           can [:update, :destroy, :unlock], [::Concept::Base, ::Label::Base], :published_at => nil # Mustn't be locked by myself
 
           can :manage, User
+          can :manage, Iqvoc.config
 
           can :full_export, ::Concept::Base
           can :import, ::Concept::Base
         end
-      
+
       end
 
     end

data/lib/iqvoc/configuration/collection.rb

@@ -0,0 +1,22 @@
+require "active_support/concern"
+
+module Iqvoc
+  module Configuration
+    module Collection
+      extend ActiveSupport::Concern
+      
+      included do
+        mattr_accessor :base_class_name
+
+        self.base_class_name = 'Collection::Unordered'
+      end
+      
+      module ClassMethods
+        def base_class
+          base_class_name.constantize
+        end
+      end
+
+    end
+  end
+end

data/lib/iqvoc/configuration/concept.rb

@@ -0,0 +1,152 @@
+require "active_support/concern"
+
+module Iqvoc
+  module Configuration
+    module Concept
+      extend ActiveSupport::Concern
+      
+      included do
+        Iqvoc.first_level_class_configuration_modules << self
+
+        mattr_accessor :base_class_name,
+        :broader_relation_class_name, :further_relation_class_names,
+        :pref_labeling_class_name,
+        :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.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 = []
+      end
+      
+      module ClassMethods
+        def pref_labeling_languages
+          # FIXME: mutable object; needs custom array setters to guard against
+          # modification (to highlight deprecated usage)
+          return Iqvoc.config["languages.pref_labeling"]
+        end
+
+        # Do not use the following method in models. This will probably cause a
+        # loading loop (something like "expected file xyz to load ...")
+        def base_class
+          base_class_name.constantize
+        end
+
+        def pref_labeling_class
+          pref_labeling_class_name.constantize
+        end
+
+        def labeling_class_names
+          { pref_labeling_class_name => pref_labeling_languages }.merge(further_labeling_class_names)
+        end
+
+        def labeling_classes
+          { pref_labeling_class => pref_labeling_languages }.merge(further_labeling_classes)
+        end
+
+        def broader_relation_class
+          broader_relation_class_name.constantize
+        end
+
+        # returns hash of class name / languages pairs
+        # e.g. { "Labeling::SKOS::AltLabel" => ["de", "en"] }
+        def further_labeling_class_names
+          # FIXME: mutable object; needs custom hash setters to guard against
+          # modification of languages arrays (to highlight deprecated usage)
+          return Iqvoc.config.defaults.each_with_object({}) do |(key, default_value), hsh|
+            prefix = "languages.further_labelings."
+            if key.start_with? prefix
+              class_name = key[prefix.length..-1]
+              hsh[class_name] = Iqvoc.config[key]
+            end
+          end
+        end
+
+        def 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 relation_class_names
+          further_relation_class_names + [broader_relation_class_name, broader_relation_class.narrower_class.name]
+        end
+
+        def relation_classes
+          relation_class_names.map(&:constantize)
+        end
+
+        def further_relation_classes
+          further_relation_class_names.map(&:constantize)
+        end
+
+        def note_classes
+          note_class_names.map(&:constantize)
+        end
+
+        def match_classes
+          match_class_names.map(&:constantize)
+        end
+
+        def 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 supports_multi_language_pref_labelings?
+          pref_labeling_languages.size > 1
+        end
+
+        def include_modules
+          include_module_names.map(&:constantize)
+        end
+      
+        # @deprecated
+        def pref_labeling_languages=(value)
+          ActiveSupport::Deprecation.warn "pref_labeling_languages has been moved into instance configuration", caller
+          Iqvoc.config.register_setting("languages.pref_labeling", arr)
+        end
+
+        # @deprecated
+        def further_labeling_class_names=(hsh)
+          ActiveSupport::Deprecation.warn "further_labeling_class_names has been moved into instance configuration", caller
+          prefix = "languages.further_labelings."
+          hsh.each do |class_name, value|
+            Iqvoc.config.register_setting(prefix + class_name, value.map(&:to_s))
+          end
+        end
+      end
+
+    end
+  end
+end