iqvoc 3.4.0 → 3.5.0

data/lib/iqvoc/configuration/core.rb

@@ -0,0 +1,135 @@
+require "active_support/concern"
+
+module Iqvoc
+  module Configuration
+    module Core
+      extend ActiveSupport::Concern
+      
+      included do
+        mattr_accessor :searchable_class_names,
+          :unlimited_search_results,
+          :default_rdf_namespace_helper_methods,
+          :rdf_namespaces,
+          :change_note_class_name,
+          :first_level_class_configuration_modules,
+          :ability_class_name,
+          :core_assets
+
+        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
+          json2.js
+        )
+
+        self.searchable_class_names = [
+          'Labeling::SKOS::Base',
+          'Labeling::SKOS::PrefLabel',
+          'Note::Base'
+        ]
+        self.unlimited_search_results = false
+
+        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'
+        
+        # initialize
+        self.config.register_settings({
+          "title" => "iQvoc",
+          "available_languages" => ["en", "de"],
+          "languages.pref_labeling" => ["en", "de"],
+          "languages.further_labelings.Labeling::SKOS::AltLabel" => ["en", "de"]
+        })
+        self.config.initialize_cache
+      end
+      
+      module ClassMethods
+        def 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
+
+        # ************** instance configuration **************
+
+        def config(&block)
+          cfg = InstanceConfiguration.instance
+          if block
+            block.call(cfg)
+          else
+            return cfg
+          end
+        end
+      
+        def change_note_class
+          change_note_class_name.constantize
+        end
+
+        def searchable_classes
+          searchable_class_names.map(&:constantize)
+        end
+
+        def first_level_classes
+          self.first_level_class_configuration_modules.map { |mod| mod.send(:base_class) }
+        end
+
+        def ability_class
+          ability_class_name.constantize
+        end
+      
+        def title
+          return config["title"]
+        end
+
+        def available_languages
+          return config["available_languages"]
+        end
+      
+        # @deprecated
+        def title=(value)
+          ActiveSupport::Deprecation.warn "title has been moved into instance configuration", caller
+          self.config.register_setting("available_languages", value)
+        end
+
+        # @deprecated
+        def available_languages=(value)
+          ActiveSupport::Deprecation.warn "available_languages has been moved into instance configuration", caller
+          self.config.register_setting("available_languages", value)
+        end
+      end
+      
+    end
+  end
+end

data/lib/iqvoc/configuration/label.rb

@@ -0,0 +1,23 @@
+require "active_support/concern"
+
+module Iqvoc
+  module Configuration
+    module Label
+      extend ActiveSupport::Concern
+      
+      included do
+        mattr_accessor :base_class_name
+        self.base_class_name        = 'Label::SKOS::Base'
+      end
+
+      module ClassMethods
+        # 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
+      end
+
+    end
+  end
+end

data/lib/iqvoc/controller_extensions.rb

@@ -0,0 +1,115 @@
+require "active_support/concern"
+
+module Iqvoc
+  module ControllerExtensions
+    extend ActiveSupport::Concern
+    
+    included do
+      prepend_before_filter :set_locale
+      before_filter :ensure_extension
+      before_filter :require_user
+
+      helper :all
+      helper_method :current_user_session, :current_user, :concept_widget_data, :collection_widget_data, :label_widget_data
+
+      rescue_from ActiveRecord::RecordNotFound, :with => :handle_not_found
+      rescue_from CanCan::AccessDenied, :with => :handle_access_denied
+    end
+
+    protected
+
+    def default_url_options(options = nil)
+      { :format => params[:format], :lang => I18n.locale }.
+        reject { |key, value| key == :lang and value.to_s.strip.blank? }. # Strip out the lang parameter if it's empty.
+        merge(options || {})
+    end
+
+    # Force an extension to every url. (LOD)
+    def ensure_extension
+      unless params[:format] || request.method != "GET"
+        flash.keep
+        redirect_to url_for(params.merge(:format => (request.format && request.format.symbol) || :html))
+      end
+    end
+
+    def handle_access_denied(exception)
+      @exception = exception
+      render :template => 'errors/access_denied', :status => :access_denied
+    end
+
+    def handle_multiple_choices(exception)
+      @exception = exception
+      render :template => 'errors/multiple_choices', :status => :multiple_choices
+    end
+
+    def handle_not_found(exception)
+      @exception = exception
+      SearchResultsController.prepare_basic_variables(self)
+
+      respond_to do |format|
+        format.html { render :template => 'errors/not_found', :status => :not_found }
+      end
+    end
+
+    def set_locale
+      if Iqvoc::Concept.pref_labeling_languages.include?(nil)
+        I18n.locale = " "
+      elsif params[:lang] && Iqvoc::Concept.pref_labeling_languages.include?(params[:lang])
+        I18n.locale = params[:lang]
+      else
+        I18n.locale = Iqvoc::Concept.pref_labeling_languages.first
+      end
+    end
+
+    def concept_widget_data(concept)
+      {
+        :id => concept.origin,
+        :name => concept.pref_label.value.to_s + (concept.additional_info ? " (#{concept.additional_info })" : "")
+      }
+    end
+
+    def collection_widget_data(collection)
+      {
+        :id => collection.origin,
+        :name => collection.pref_label.to_s
+      }
+    end
+
+    def label_widget_data(label)
+      {
+        :id => label.origin,
+        :name => label.value
+      }
+    end
+
+    # Configurable Ability class
+    def current_ability
+      @current_ability ||= Iqvoc.ability_class.new(current_user)
+    end
+
+    def current_user_session
+      return @current_user_session if defined?(@current_user_session)
+      @current_user_session = UserSession.find
+    end
+
+    def current_user
+      return @current_user if defined?(@current_user)
+      @current_user = current_user_session && current_user_session.user
+    end
+
+    # TODO: Don't require an user (this is skipped in nearly every controller).
+    # Use Abilitys instead and handle the AccessDeniedException: (#handle_access_denied)
+    # * User logged in: Exception!
+    # * User not logged in: Redirect to login path!
+    # Don't forget to delete this method and all the /.*before_filter :require_user/
+    # statements in the controllers.
+    def require_user
+      unless current_user
+        flash[:error] = I18n.t("txt.controllers.application.login_required")
+        redirect_to new_user_session_url(:back_to => request.fullpath)
+        return false
+      end
+    end
+    
+  end
+end

data/lib/iqvoc/environments/development.rb

@@ -0,0 +1,66 @@
+require 'iqvoc'
+
+module Iqvoc::Environments
+
+  def self.setup_development(config)
+    # In the development environment your application's code is reloaded on
+    # every request.  This slows down response time but is perfect for development
+    # since you don't have to restart the web server when you make code changes.
+    config.cache_classes = false
+
+    # Log error messages when you accidentally call methods on nil.
+    config.whiny_nils = true
+
+    # Show full error reports and disable caching
+    config.consider_all_requests_local = true
+    config.action_controller.perform_caching = false
+
+    # Don't care if the mailer can't send
+    config.action_mailer.raise_delivery_errors = false
+
+    # Print deprecation notices to the Rails logger
+    config.active_support.deprecation = :log
+
+    # Only use best-standards-support built into browsers
+    config.action_dispatch.best_standards_support = :builtin
+
+    # Do not compress assets
+    config.assets.compress = false
+
+    # Expands the lines which load the assets
+    config.assets.debug = true
+
+    # Raise exception on mass assignment protection for Active Record models
+    config.active_record.mass_assignment_sanitizer = :logger
+
+    # Log the query plan for queries taking more than this (works
+    # with SQLite, MySQL, and PostgreSQL)
+    config.active_record.auto_explain_threshold_in_seconds = 0.5
+
+    # Prepend all log lines with the following tags
+    # config.log_tags = [ :subdomain, :uuid ]
+
+    # The default URI prefix for RDF data. This will be followed by a document
+    # specific shnippet like (specimenType) and the id.
+
+    # The JDBC driver URL for the connection to the virtuoso triple store.
+    # Login credentials have to be stored here too. See
+    # http://docs.openlinksw.com/virtuoso/VirtuosoDriverJDBC.html#jdbcurl4mat for
+    # more details.
+    # Example: "jdbc:virtuoso://localhost:1111/UID=dba/PWD=dba"
+    # Use nil to disable virtuoso triple synchronization
+    # Rails.application.config.virtuoso_jdbc_driver_url = "jdbc:virtuoso://virtuoso.dyndns.org:1111/UID=iqvoc/PWD=vocpass!/charset=UTF-8"
+    config.virtuoso_jdbc_driver_url = nil
+
+    # Set up the virtuoso synchronization (which is a triggered pull from the
+    # virtuoso server) to be run in a new thread.
+    # This is needed in environments where the web server only runs in a single
+    # process/thread (mostly in development environments).
+    # When a synchronization would be triggered e.g. from a running
+    # update action in the UPB, the update would trigger virtuoso to do a HTTP GET
+    # back to the UPB to fetch the RDF data. But the only process in the UPB would be
+    # blocked by the update... => Deadlock. You can avoid this by using the threaded
+    # mode.
+    config.virtuoso_sync_threaded = false
+  end
+end

data/lib/iqvoc/environments/production.rb

@@ -0,0 +1,64 @@
+require 'iqvoc'
+
+module Iqvoc::Environments
+
+  def self.setup_production(config)
+    # The production environment is meant for finished, "live" apps.
+    # Code is not reloaded between requests
+    config.cache_classes = true
+
+    # Full error reports are disabled and caching is turned on
+    config.consider_all_requests_local = false
+    config.action_controller.perform_caching = true
+
+    # Specifies the header that your server uses for sending files
+    config.action_dispatch.x_sendfile_header = "X-Sendfile"
+
+    # For nginx:
+    # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect'
+
+    # If you have no front-end server that supports something like X-Sendfile,
+    # just comment this out and Rails will serve the files
+
+    # See everything in the log (default is :info)
+    # config.log_level = :debug
+
+    # Use a different logger for distributed setups
+    # config.logger = SyslogLogger.new
+
+    # Use a different cache store in production
+    # config.cache_store = :mem_cache_store
+
+    # Disable Rails's static asset server
+    # In production, Apache or nginx will already do this
+    config.serve_static_assets = false
+
+    # Compress JavaScripts and CSS
+    config.assets.compress = true
+
+    # Don't fallback to assets pipeline if a precompiled asset is missed
+    config.assets.compile = false
+
+    # Generate digests for assets URLs
+    config.assets.digest = true
+
+    config.assets.precompile += Iqvoc.core_assets
+
+    # Enable serving of images, stylesheets, and javascripts from an asset server
+    # config.action_controller.asset_host = "http://assets.example.com"
+
+    # Disable delivery errors, bad email addresses will be ignored
+    # config.action_mailer.raise_delivery_errors = false
+
+    # Enable threaded mode
+    # config.threadsafe!
+
+    # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+    # the I18n.default_locale when a translation can not be found)
+    config.i18n.fallbacks = true
+
+    # Send deprecation notices to registered listeners
+    config.active_support.deprecation = :notify
+  end
+
+end

data/lib/iqvoc/environments/test.rb

@@ -0,0 +1,52 @@
+require 'iqvoc'
+
+module Iqvoc::Environments
+
+  def self.setup_test(config)
+    # The test environment is used exclusively to run your application's
+    # test suite.  You never need to work with it otherwise.  Remember that
+    # your test database is "scratch space" for the test suite and is wiped
+    # and recreated between test runs.  Don't rely on the data there!
+    config.cache_classes = true
+
+    # Log error messages when you accidentally call methods on nil.
+    config.whiny_nils = true
+
+    # Show full error reports and disable caching
+    config.consider_all_requests_local = true
+    config.action_controller.perform_caching = false
+
+    # Raise exceptions instead of rendering exception templates
+    config.action_dispatch.show_exceptions = false
+
+    # Disable request forgery protection in test environment
+    config.action_controller.allow_forgery_protection = false
+
+    # Tell Action Mailer not to deliver emails to the real world.
+    # The :test delivery method accumulates sent emails in the
+    # ActionMailer::Base.deliveries array.
+    config.action_mailer.delivery_method = :test
+
+    # Use SQL instead of Active Record's schema dumper when creating the test database.
+    # This is necessary if your schema can't be completely dumped by the schema dumper,
+    # like if you have constraints or database-specific column types
+    # config.active_record.schema_format = :sql
+
+    # Print deprecation notices to the stderr
+    config.active_support.deprecation = :stderr
+
+    # Configure static asset server for tests with Cache-Control for performance
+    config.serve_static_assets = true
+    config.static_cache_control = "public, max-age=3600"
+
+    # Allow pass debug_assets=true as a query parameter to load pages with unpackaged assets
+    config.assets.allow_debugging = true
+
+    # Raise exception on mass assignment protection for Active Record models
+    config.active_record.mass_assignment_sanitizer = :logger
+
+    # Print deprecation notices to the stderr
+    config.active_support.deprecation = :stderr
+  end
+
+end