iqvoc 4.3.3 → 4.4.0

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright 2011-2013 innoQ Deutschland GmbH
+Copyright 2011-2014 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.

data/README.md

@@ -32,7 +32,7 @@ In order to deploy to heroku you need to have an account and [heroku toolbelt](h
 ```
 $ bundle install
 $ heroku create
-$ bundle exec rake heroku:config
+$ heroku config:add HEROKU=true RAILS_ENV=heroku RACK_ENV=heroku SECRET_KEY_BASE=$(bundle exec rake secret)
 $ git push heroku master
 $ heroku run rake db:migrate
 $ heroku run rake db:seed
@@ -53,14 +53,14 @@ Running the cloned source code is possible but any modifications would require a
 3. Run `bundle exec rake db:create` to create the database
 4. Create the necessary tables by running `rake db:migrate`
 5. Load some base data by running `rake db:seed`
-6. Run `bundle exec rake setup:generate_secret_token`
+6. Make sure you have got `config/secrets.yml` in place
 7. Boot up the app using `bundle exec rails s` (or `passenger start` if you use passenger)
 8. Log in with "admin@iqvoc" / "admin" or "demo@iqvoc" / "cooluri" (cf. step #5)
 9. Visit the Users section and change the default passwords
 
 ## Background Jobs
 
-Note that some features like "Import" exposed in the Web UI store their workload
+Note that some features like "Import" and "Export" exposed in the Web UI store their workload
 as jobs. You can either issue a job worker that runs continuously and watches
 for new jobs via
 
@@ -88,6 +88,14 @@ overview of the possibilities.
 
 Documentation resources can be found in the [wiki](https://github.com/innoq/iqvoc/wiki/_pages).
 
+## Versioning
+
+Releases will follow a semantic versioning format:
+
+    <major>.<minor>.<patch>
+
+For more information on SemVer, visit http://semver.org/.
+
 ## Contributing
 
 If you want to help out there are several options:
@@ -110,6 +118,6 @@ iQvoc was originally created and is being maintained by [innoQ Deutschland GmbH]
 
 ## License
 
-Copyright 2013 innoQ Deutschland GmbH
+Copyright 2014 innoQ Deutschland GmbH
 
 Licensed under the Apache License, Version 2.0

data/app/assets/javascripts/framework.js

@@ -5,6 +5,6 @@
 //= require jquery.treeview
 //= require jquery.treeview.async
 //= require storage
-//= require bootstrap-transition
-//= require bootstrap-collapse
-//= require bootstrap-tab
+//= require bootstrap/transition
+//= require bootstrap/collapse
+//= require bootstrap/tab

data/app/assets/javascripts/iqvoc/concept_mapper.js

@@ -22,10 +22,12 @@ function ConceptMapper(selector) {
 
   this.container = $("<div />").addClass("concept-mapper control-group");
 
-  this.input = $("<input />").attr("type", "text").prependTo(this.container);
-  $("<button />").addClass("btn fa fa-plus").insertAfter(this.input).
-      click($.proxy(this, "onConfirm"));
-  this.matchType = $("<select />").append(matchOptions).insertAfter(this.input);
+  this.input = $("<input />").attr("type", "text").addClass("form-control").
+      prependTo(this.container);
+  $("<button />").addClass("btn btn-default fa fa-plus").
+      insertAfter(this.input).click($.proxy(this, "onConfirm"));
+  this.matchType = $("<select />").addClass("form-control").
+      append(matchOptions).insertAfter(this.input);
 
   this.container.prependTo(this.root);
 }

data/app/assets/javascripts/iqvoc/entityselect.js.erb

@@ -11,7 +11,11 @@ var EntitySelector = function(node) {
   }
   this.el = $(node).hide(); // XXX: rename
   this.container = $('<div class="entity_select" />').data("widget", this);
-  this.indicator = $('<i class="spinner fa fa-refresh fa-spin hidden" />');
+  this.bootstrapInputGroup = $('<div class="input-group" />');
+  this.indicator = $('<i class="spinner fa fa-refresh fa-spin" />');
+  this.indicatorWrapper = $('<span class="input-group-addon" />');
+  this.languageWrapper = $('<span class="input-group-addon" />');
+  this.language = this.el.data("language") || false;
   this.delimiter = ",";
   this.singular = this.el.data("singular") || false;
   this.entities = this.getSelection();
@@ -19,6 +23,8 @@ var EntitySelector = function(node) {
 
   var self = this;
 
+  this.indicator.css("visibility", "hidden");
+
   var selection = $.map(this.el.data("entities"), function(entity, i) {
     return self.createEntity(entity);
   });
@@ -27,20 +33,25 @@ var EntitySelector = function(node) {
   this.input = $("<input />").autocomplete({
     minLength: 3,
     source: $.proxy(this, "onInput"), // XXX: discards original `this` context
-    search: function(ev, ui) { self.indicator.removeClass("hidden"); },
+    search: function(ev, ui) { self.indicator.css("visibility", "visible"); },
     focus: function(ev, ui) { return false; },
     select: this.onSelect
   });
 
   // jQuery UI does not add a type attribute
   // Bootstrap expects it to be there
-  this.input.attr('type', 'text');
+  this.input.attr('type', 'text').addClass('form-control');
+
+  this.container.append(this.bootstrapInputGroup.append(this.input).append(this.indicatorWrapper.append(this.indicator))).
+    append(selection).insertAfter(node).prepend(node);
 
-  this.container.append(this.input).append(this.indicator).append(selection).
-    insertAfter(node).prepend(node);
+  if(this.language) {
+    this.bootstrapInputGroup.prepend(this.languageWrapper.append(this.language));
+  }
 
   if(this.singular && this.entities.length) {
     this.input.hide();
+    this.indicatorWrapper.hide();
   }
 };
 // data transformations; target format is an array of objects with members
@@ -77,7 +88,7 @@ $.extend(EntitySelector.prototype, {
       data = self.processResponse(data);
       self.input.autocomplete("option", "autoFocus", data.length === 1);
       callback(data);
-      self.indicator.addClass("hidden");
+      self.indicator.css("visibility", "hidden");
     };
 
     var sourceSelector = this.el.data("source-selector") || "default";
@@ -94,6 +105,7 @@ $.extend(EntitySelector.prototype, {
       widget.container.find("ul").append(entity);
       if(widget.singular) {
         widget.input.hide();
+        widget.indicatorWrapper.hide();
       }
     }
     return false;
@@ -106,6 +118,7 @@ $.extend(EntitySelector.prototype, {
     entity.remove();
     if(widget.singular && !widget.entities.length) {
       widget.input.show();
+      widget.indicatorWrapper.show();
     }
     ev.preventDefault();
   },

data/app/assets/javascripts/iqvoc/federated_concept_mapper.js

@@ -20,7 +20,8 @@ function FederatedConceptMapper(selector) {
   sources = $.map(sources, function(name, url) {
     return $("<option />").val(url).text(name)[0];
   });
-  this.source = $("<select />").append(sources).insertBefore(this.input);
+  this.source = $("<select />").addClass("form-control").append(sources).
+      insertBefore(this.input);
 
   this.indicator = $("<i />").
       addClass("concept-mapper-indicator hidden fa fa-refresh fa-spin").
@@ -30,9 +31,10 @@ function FederatedConceptMapper(selector) {
   this.input.autocomplete({ // TODO: extract autocomplete extension into subclass
     source: $.proxy(this, "onChange"),
     search: function(ev, ui) {
-      self.indicator.removeClass("hidden");
       if(self.source.val() === "_custom") {
         return false;
+      } else {
+        self.indicator.removeClass("hidden");
       }
     },
     response: function(ev, ui) {

data/app/assets/javascripts/iqvoc/onebox.js.erb

@@ -5,20 +5,19 @@ IQVOC.onebox = (function($) {
 
 "use strict";
 
-function OneBox(form) {
-  this.form = form.jquery ? form : $(form);
+function OneBox(container) {
+  this.container = container.jquery ? container : $(container);
+  this.form = this.container.find('form');
   this.input = $(".onebox-input", this.form); // TODO: document
-  this.container = this.form.removeClass("onebox").
-      wrap('<div class="onebox" />').parent(); // TODO: document
-  this.results = $('<ol class="results concept-items unstyled" />');
-  this.spinner = $('<i class="fa fa-refresh fa-spin fa-3x" />').
+  this.results = $('<ol class="results concept-items list-unstyled" />');
+  this.indicator = $('<i class="fa fa-refresh fa-spin fa-3x onebox-indicator" />').
       appendTo(this.container).hide();
 
   this.form.on("submit", $.proxy(this, "onSubmit"));
   this.input.on("keyup", debounce($.proxy(this, "onInput"), 300));
 }
 OneBox.prototype.reset = function() {
-  this.container.children().not(this.form).not(this.spinner).remove();
+  this.container.children().not(this.form).not(this.indicator).remove();
 };
 OneBox.prototype.renderResults = function(html) {
   var doc = $("<div />").append(html);
@@ -40,7 +39,7 @@ OneBox.prototype.onInput = function(ev) {
   }
 };
 OneBox.prototype.getConcepts = function() {
-  this.spinner.show();
+  this.indicator.show();
   $.ajax({
     type: this.form.attr("method"),
     url: this.form.attr("action"),
@@ -54,7 +53,7 @@ OneBox.prototype.onResults = function(html, status, xhr) {
   var rscript = /<script\b[^<]*(?:(?!<\/script>)<[^<]*)*<\/script>/gi;
   html = html.replace(rscript, "");
 
-  this.spinner.hide();
+  this.indicator.hide();
   this.renderResults(html);
 };
 

data/app/assets/stylesheets/framework.css.scss

@@ -3,7 +3,6 @@
 
 @import 'bootstrap';
 body {
-  padding-top: 60px;
+  padding-top: 70px;
 }
-@import 'bootstrap-responsive';
 @import 'font-awesome';

data/app/assets/stylesheets/iqvoc/components/_components.css.scss

@@ -14,8 +14,18 @@
     margin: 2em 0 1em 0;
   }
 
-  input {
-    min-width: 60%;
+  .onebox-form {
+    @include make-row;
+  }
+
+  .onebox-input-wrapper {
+    @include make-md-column(8);
+    @include make-md-column-offset(2);
+  }
+
+  .onebox-indicator {
+    margin-top: 1em;
+    color: lighten($muted-color, 20%);
   }
 
   ol {
@@ -51,11 +61,6 @@ tr.highlightable {
   }
 }
 
-.spinner {
-  position: absolute;
-  margin: 8px 0 0 -20px;
-}
-
 .arrow_down {
   margin-top: 3px;
 }
@@ -185,6 +190,11 @@ tr.highlightable {
 .concept-mapper {
   margin-bottom: 25px;
   > * { margin-right: 10px; }
+
+  .form-control {
+    width: auto;
+    display: inline-block;
+  }
 }
 
 .concept-mapper-indicator {

data/app/concerns/first_level_object_validations.rb

@@ -0,0 +1,22 @@
+# Validations for both concepts and labels
+
+module FirstLevelObjectValidations
+  extend ActiveSupport::Concern
+
+  included do
+    validate :distinct_versions, on: :create # FIXME: on: :create?
+  end
+
+  def distinct_versions
+    query = self.class.by_origin(origin)
+    existing_total = query.count
+    if existing_total >= 2
+      errors.add :base, I18n.t('txt.models.concept.version_error', origin: origin)
+    elsif existing_total == 1
+      unless (query.published.count == 0 and published?) or
+             (query.published.count == 1 and not published?)
+        errors.add :base, I18n.t('txt.models.concept.version_error', origin: origin)
+      end
+    end
+  end
+end

data/app/concerns/versioning.rb

@@ -0,0 +1,187 @@
+# 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.
+
+module Versioning
+  extend ActiveSupport::Concern
+
+  included do
+    belongs_to :published_version, foreign_key: 'published_version_id', class_name: name
+    belongs_to :locking_user, foreign_key: 'locked_by', class_name: 'User'
+
+    after_initialize do
+      disable_validations_for_publishing
+    end
+  end
+
+  module ClassMethods
+    def by_origin(origin)
+       where(origin: origin)
+     end
+
+     def published
+       where(arel_table[:published_at].not_eq(nil))
+     end
+
+     def unpublished
+       where(published_at: nil)
+     end
+
+     # The following method returns all objects which should be selectable by the editor
+     def editor_selectable
+       where(
+         arel_table[:published_at].not_eq(nil).or( # == published (is there a way to OR combine two scopes? `published OR where(...)`)
+           arel_table[:published_at].eq(nil).and(arel_table[:published_version_id].eq(nil)) # this are all unpublished with no published version
+         )
+       )
+     end
+
+     def in_edit_mode
+       where(arel_table[:locked_by].not_eq(nil))
+     end
+
+     def unpublished_or_follow_up
+       where(
+         arel_table[:published_at].eq(nil).or(
+           arel_table[:follow_up].not_eq(nil)
+         )
+       )
+     end
+
+     def unsynced
+       where(rdf_updated_at: nil)
+     end
+
+     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
+
+  def branch(user)
+    new_version = self.dup(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
+
+  # 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)
+    tap do
+      write_attribute(:locked_by, user_id)
+    end
+  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
+    tap do
+      write_attribute(:locked_by, nil)
+    end
+  end
+
+  def in_review?
+    read_attribute(:to_review).present?
+  end
+
+  def to_review
+    tap do
+      write_attribute(:to_review, true)
+    end
+  end
+
+  def with_validations_for_publishing
+    enable_validations_for_publishing
+    status = yield
+    disable_validations_for_publishing
+
+    return status
+  end
+
+  def enable_validations_for_publishing
+    @_run_validations_for_publishing = true
+  end
+
+  def disable_validations_for_publishing
+    @_run_validations_for_publishing = false
+  end
+
+  def validatable_for_publishing?
+    @_run_validations_for_publishing
+  end
+
+  def publish
+    tap do
+      write_attribute(:published_at, Time.now)
+      write_attribute(:to_review, nil)
+      write_attribute(:published_version_id, nil)
+    end
+  end
+
+  def unpublish
+    tap do
+      write_attribute(:published_at, nil)
+    end
+  end
+
+  def published?
+    read_attribute(:published_at).present?
+  end
+
+  def publish!
+    with_validations_for_publishing do
+      publish
+      save!
+    end
+  end
+
+  def publishable?
+    with_validations_for_publishing do
+      valid?
+    end
+  end
+end