iqvoc 4.7.0 → 4.8.0

data/config/routes.rb

@@ -79,6 +79,8 @@ Rails.application.routes.draw do
     get 'search' => 'search_results#index', as: 'search'
 
     get 'help' => 'pages#help', as: 'help'
+    get 'version' => 'pages#version', as: 'version'
+    get 'components' => 'pages#components', as: 'components'
 
     get '/' => 'frontpage#index'
     # root to: 'frontpage#index', format: nil

data/config/travis/database.yml.mysql

@@ -0,0 +1,9 @@
+test:
+  adapter: mysql2
+  encoding: utf8
+  reconnect: false
+  database: iqvoc_test
+  pool: 5
+  username: travis
+  password:
+  host: 127.0.0.1

data/config/travis/database.yml.postgresql

@@ -0,0 +1,7 @@
+test:
+  adapter: postgresql
+  encoding: unicode
+  database: iqvoc_test
+  pool: 5
+  username: travis
+  password:

data/config/travis/database.yml.sqlite

@@ -0,0 +1,5 @@
+test:
+  adapter: sqlite3
+  database: db/iqvoc_test.sqlite3
+  pool: 5
+  timeout: 5000

data/db/migrate/20141204151558_add_foreign_key_constraints.rb

@@ -0,0 +1,23 @@
+class AddForeignKeyConstraints < ActiveRecord::Migration
+  def change
+    # user foreign keys
+    add_foreign_key :concepts, :users, column: 'locked_by', on_delete: :nullify, on_update: :cascade
+    add_foreign_key :exports, :users, column: 'user_id', on_delete: :nullify, on_update: :cascade
+    add_foreign_key :imports, :users, column: 'user_id', on_delete: :nullify, on_update: :cascade
+
+    # concept/collection foreign keys
+    add_foreign_key :concept_relations, :concepts, column: 'owner_id', on_update: :cascade
+    add_foreign_key :concept_relations, :concepts, column: 'target_id', on_update: :cascade
+    add_foreign_key :collection_members, :concepts, column: 'collection_id', on_update: :cascade
+    add_foreign_key :collection_members, :concepts, column: 'target_id', on_update: :cascade
+    add_foreign_key :labelings, :concepts, column: 'owner_id', on_update: :cascade
+    add_foreign_key :matches, :concepts, column: 'concept_id', on_delete: :cascade, on_update: :cascade
+    add_foreign_key :notations, :concepts, column: 'concept_id', on_update: :cascade
+
+    # labels
+    add_foreign_key :labelings, :labels, column: 'target_id',  on_delete: :cascade, on_update: :cascade
+
+    # note annotations foreign keys
+    add_foreign_key :note_annotations, :notes, column: 'note_id', on_delete: :cascade, on_update: :cascade
+  end
+end

data/iqvoc.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |s|
   s.description = 'iQvoc - a SKOS(-XL) vocabulary management system built on the Semantic Web'
   s.license     = 'Apache License 2.0'
 
-  s.add_dependency 'rails', '~> 4.1.0'
+  s.add_dependency 'rails', '~> 4.2.0'
   s.add_dependency 'bundler'
   s.add_dependency 'kaminari'
   s.add_dependency 'kaminari-bootstrap', '~> 3.0.1'
@@ -24,7 +24,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'rails_autolink'
   s.add_dependency 'faraday'
   s.add_dependency 'faraday_middleware'
-  s.add_dependency 'sass-rails', '~> 4.0.2'
+  s.add_dependency 'sass-rails', '~> 5.0.0'
   s.add_dependency 'bootstrap-sass', '~> 3.3.1.0'
   s.add_dependency 'bootstrap_form', '~> 2.2.0'
   s.add_dependency 'iq_triplestorage'

data/lib/generators/app/template.rb

@@ -29,13 +29,23 @@ end
 EOF
 end
 
+create_file "lib/#{namespaced_app_name.to_s.underscore}/version.rb", <<-EOF
+module #{namespaced_app_name}
+  VERSION = '0.0.1'
+end
+EOF
+
 initializer 'iqvoc.rb', <<-EOF
+require '#{namespaced_app_name.to_s.underscore}/version'
+
 Iqvoc.config do |config|
   config.register_settings({
     "title" => "#{app_const_base.titleize}"
   })
 end
 
+Iqvoc.host_namespace = #{namespaced_app_name}
+
 # Iqvoc::Concept.base_class_name = "MyConceptClass"
 # Iqvoc::Concept.pref_labeling_class_name = "MyLabelingClass"
 # Iqvoc::Concept.further_relation_class_names << "MyConceptRelationClass"
@@ -55,15 +65,13 @@ EOF
 create_file "app/assets/javascripts/#{app_path}/manifest.js"
 
 remove_file 'app/assets/stylesheets/application.css'
-create_file 'app/assets/stylesheets/manifest.css', <<-EOF
-/*
-*= require framework
-*= require iqvoc/manifest
+create_file 'app/assets/stylesheets/manifest.css.scss', <<-EOF
+@import 'framework';
+@import 'iqvoc/manifest';
+@import '#{app_path}/manifest';
 
-*= require #{app_path}/manifest
-*/
 EOF
-create_file "app/assets/stylesheets/#{app_path}/manifest.css"
+create_file "app/assets/stylesheets/#{app_path}/_manifest.scss"
 
 remove_file 'public/index.html'
 remove_file 'app/controllers/application_controller.rb'

data/lib/iqvoc.rb

@@ -15,7 +15,8 @@
 # limitations under the License.
 
 require 'string'
-require 'iqvoc/instance_configuration'
+require 'iqvoc/configuration/instance_configuration'
+require 'iqvoc/configuration/navigation'
 require 'iqvoc/configuration/core'
 require 'iqvoc/configuration/concept'
 require 'iqvoc/configuration/collection'

data/lib/iqvoc/configuration/core.rb

@@ -20,7 +20,8 @@ module Iqvoc
           :search_sections,
           :export_path,
           :upload_path,
-          :truncation_blacklist
+          :truncation_blacklist,
+          :host_namespace
 
         self.localized_routes = [] # routing extensibility hook
 
@@ -93,6 +94,9 @@ module Iqvoc
           }, {
             text: proc { t('txt.views.navigation.about') },
             href: 'http://iqvoc.net/'
+          }, {
+            text: proc { t('txt.views.navigation.version') },
+            href: proc { version_path }
           }]
         }]
 
@@ -123,7 +127,7 @@ module Iqvoc
 
         self.first_level_class_configuration_modules = [] # Will be set in the modules
 
-        self.ability_class_name = 'Iqvoc::Ability'
+        self.ability_class_name = 'Ability'
 
         self.search_sections = [
           'klass',
@@ -158,7 +162,7 @@ module Iqvoc
         # ************** instance configuration **************
 
         def config(&block)
-          cfg = InstanceConfiguration.instance
+          cfg = Iqvoc::Configuration::InstanceConfiguration.instance
           if block
             block.call(cfg)
           else
@@ -203,8 +207,12 @@ module Iqvoc
           self.config.register_setting('title', value)
         end
 
+        def engine?
+          Iqvoc.const_defined?(:Engine)
+        end
+
         def root
-          if Iqvoc.const_defined?(:Engine)
+          if engine?
             Iqvoc::Engine.root
           else
             Rails.root
@@ -217,6 +225,12 @@ module Iqvoc
             return params[:lang].to_s =~ /^#{langs}$/
           end
         end
+
+        def host_version
+          if Iqvoc.host_namespace
+            Iqvoc.host_namespace::VERSION
+          end
+        end
       end
     end
   end

data/lib/iqvoc/configuration/instance_configuration.rb

@@ -0,0 +1,125 @@
+# encoding: UTF-8
+
+# Copyright 2011-2013 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 'singleton'
+
+# provides the interface to configuration settings
+module Iqvoc
+  module Configuration
+    class InstanceConfiguration
+      include Singleton
+
+      attr_reader :defaults # XXX: dangerous (mutable object)
+
+      class UnregisteredSetting < ArgumentError
+        def to_s
+          'A setting needs to be registered with register_setting before it can be used.'
+        end
+      end
+
+      def initialize
+        @defaults = {} # default settings
+        @records = {} # customized (non-default) settings
+        @settings = {} # current settings, using defaults as fallback
+        # NB: cannot cache immediately because defaults need to be registered first
+      end
+
+      # convenience wrapper for `register_setting` batch operations
+      # accepts a hash of key / default value pairs
+      def register_settings(settings)
+        settings.each do |key, default_value|
+          register_setting(key, default_value)
+        end
+      end
+
+      # create or update a default setting
+      def register_setting(key, default_value)
+        self.class.validate_value(default_value)
+
+        @defaults[key] = default_value
+
+        # update cache
+        @settings[key] = @records[key] || default_value
+      end
+
+      # remove a default setting
+      # returns nil if setting does not exist
+      # NB: does *not* delete configuration settings from the database
+      def deregister_setting(key)
+        res = @defaults.delete(key)
+
+        # update cache
+        @settings.delete(key)
+
+        return res
+      end
+
+      # retrieve individual setting, using default value as fallback
+      def [](key)
+        initialize_cache unless @initialized
+        return @settings[key]
+      end
+
+      # store individual customized setting
+      def []=(key, value)
+        raise UnregisteredSetting unless @defaults.include?(key)
+        self.class.validate_value(value)
+
+        json = JSON.dump([value])[1..-2] # temporary array wrapper ensures valid JSON text
+        if setting = ConfigurationSetting.find_by_key(key)
+          setting.update_attributes(value: json)
+        else
+          ConfigurationSetting.create(key: key, value: json)
+        end
+
+        # update cache
+        @records[key] = value
+        @settings[key] = value
+
+        return value
+      end
+
+      # populate settings caches
+      # (subsequent updates will happen automatically via the respective setters)
+      def initialize_cache
+        return false unless ConfigurationSetting.table_exists? # pre-migration
+
+        # cache customized settings
+        ConfigurationSetting.all.each do |setting|
+          @records[setting.key] = JSON.load("[#{setting.value}]")[0] # temporary array wrapper ensures valid JSON text
+        end
+
+        # cache current settings
+        @defaults.each do |key, default_value|
+          value = @records[key]
+          @settings[key] = value.nil? ? default_value : value
+        end
+
+        @initialized = true
+      end
+
+      # checks whether value type is supported
+      def self.validate_value(value) # TODO: compare type to default's? (cf. controller)
+        if value == nil
+          raise TypeError, 'nil values not supported'
+        end
+        unless [TrueClass, FalseClass, String, Fixnum, Float, Array].include?(value.class)
+          raise TypeError, 'complex values not supported'
+        end
+      end
+    end
+  end
+end

data/lib/iqvoc/configuration/navigation.rb

@@ -0,0 +1,63 @@
+# encoding: UTF-8
+
+# Copyright 2011-2013 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.
+
+##
+# Provides a basic API wrapping low-level iQvoc config operations
+# on Iqvoc.navigation_items
+
+module Iqvoc
+  module Configuration
+    class Navigation
+      def self.items
+        Iqvoc.navigation_items
+      end
+
+      def self.add(item, position = nil)
+        if position
+          items.insert(position, item)
+        else
+          items << item
+        end
+      end
+
+      def self.add_grouped(item, position = nil)
+        index = setup_extension_group(position)
+        items[index][:items] << item
+      end
+
+      private
+      # Setup an empty navigation group for extensions
+      # Returns index for the new (or existing) group, so add_grouped
+      # can use the index to insert it's item under the group
+      def self.setup_extension_group(position)
+        group = {
+          text: proc { t('txt.views.navigation.extensions') },
+          items: []
+        }
+
+        if position && !items[position][:items]
+          items.insert(position, group)
+        elsif position && items[position][:items]
+          return position
+        else
+          items << group
+        end
+
+        items.index(group)
+      end
+    end
+  end
+end

data/lib/iqvoc/environments/development.rb

@@ -60,6 +60,10 @@ module Iqvoc::Environments
     # number of complex assets.
     config.assets.debug = true
 
+    # Asset digests allow you to set far-future HTTP expiration dates on all assets,
+    # yet still be able to expire them through the digest params.
+    config.assets.digest = true
+
     # Adds additional error checking when serving assets at runtime.
     # Checks for improperly declared sprockets dependencies.
     # Raises helpful error messages.

data/lib/iqvoc/environments/production.rb

@@ -19,11 +19,12 @@ module Iqvoc::Environments
 
     # Enable Rack::Cache to put a simple HTTP cache in front of your application
     # Add `rack-cache` to your Gemfile before enabling this.
-    # For large-scale production use, consider using a caching reverse proxy like nginx, varnish or squid.
+    # For large-scale production use, consider using a caching reverse proxy like
+    # NGINX, varnish or squid.
     # config.action_dispatch.rack_cache = true
 
-    # Disable Rails's static asset server (Apache or nginx will already do this).
-    config.serve_static_assets = false
+    # Disable Rails's static asset server (Apache or NGINX will already do this).
+    config.serve_static_files = false
 
     # Compress JavaScripts and CSS.
     config.assets.js_compressor = :uglifier
@@ -32,21 +33,22 @@ module Iqvoc::Environments
     # Do not fallback to assets pipeline if a precompiled asset is missed.
     config.assets.compile = false
 
-    # Generate digests for assets URLs.
+    # Asset digests allow you to set far-future HTTP expiration dates on all assets,
+    # yet still be able to expire them through the digest params.
     config.assets.digest = true
 
     # Version of your assets, change this if you want to expire all your assets.
     config.assets.version = '1.0'
 
     # Specifies the header that your server uses for sending files.
-    # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache
-    # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx
+    # config.action_dispatch.x_sendfile_header = 'X-Sendfile' # for Apache
+    # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for NGINX
 
     # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
     # config.force_ssl = true
 
-    # Set to :debug to see everything in the log.
-    config.log_level = :info
+    # Decrease the log volume.
+    config.log_level = :debug
 
     # Prepend all log lines with the following tags.
     # config.log_tags = [ :subdomain, :uuid ]
@@ -58,7 +60,7 @@ module Iqvoc::Environments
     # config.cache_store = :mem_cache_store
 
     # Enable serving of images, stylesheets, and JavaScripts from an asset server.
-    # config.action_controller.asset_host = "http://assets.example.com"
+    # config.action_controller.asset_host = 'http://assets.example.com'
 
     # Ignore bad email addresses and do not raise email delivery errors.
     # Set this to true and configure the email server for immediate delivery to raise delivery errors.
@@ -71,9 +73,6 @@ module Iqvoc::Environments
     # Send deprecation notices to registered listeners.
     config.active_support.deprecation = :notify
 
-    # Disable automatic flushing of the log to improve performance.
-    # config.autoflush_log = false
-
     # Use default logging formatter so that PID and timestamp are not suppressed.
     config.log_formatter = ::Logger::Formatter.new