mei 0.0.1 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a696a787a23dcbf11035442725f178f55e108522
-  data.tar.gz: a623ba74eb922f194ae079038f8b24d77a24f3b9
+  metadata.gz: 231eb832fec0dc120fa890741165d2f5121eadac
+  data.tar.gz: 34cf84d2cea0f9b062b172f504a1879d899db261
 SHA512:
-  metadata.gz: c6a6b15e947675ff12b4a336a2bb90cb3d46c712725d397a6afe1130bbec5300ea3d31bcd398b637a2c3dbc99fd7ecb0d1d689d64be0d70f37f06e351bf7c462
-  data.tar.gz: 96b7ab7dadd44f82e54430e65bcb66018968bf880cf0825a8b62c531c0e22196287c7ade93ee76dcc531cc741f91e7420fb5eb32291198349a79eb4fac673802
+  metadata.gz: 1fd06ca113c6f3f8ec2f12da19cd04c592f0b671fecbf378628499ea78f2b887c7ce026e454e1f2fc8b0cfa307f165ab98973203ecefa30479b8b5175bef8654
+  data.tar.gz: ac2e034520b2c2baf260ca8fe261d84f59cc5590c0507c43fa81a9a445ec93faf0f9530eabdd5076a5dc2d68b0d8b62e7f6a473cf5814c98130d3abc61882064

data/README.rdoc

@@ -1,3 +1,21 @@
 = Mei
 
-This project rocks and uses MIT-LICENSE.
+This adds a Metadata Enrichment Interface to a Hydra / ActiveFedora based project and uses Linked Data Fragments to resolve uris.
+Currently in an alpha state 
+
+## Installation
+
+Add the following to your Gemfile:
+
+```
+gem 'mei'
+```
+
+The run:
+
+    $ rails generate mei:install
+
+
+## Further configuration
+
+See slides on this setup at https://goo.gl/BP2inf .

data/app/assets/javascripts/custom_form_functions.js

@@ -0,0 +1,110 @@
+
+
+Blacklight.onLoad(function() {
+    function get_autocomplete_opts(field) {
+        var autocomplete_opts = {
+            minLength: 2,
+            source: function( request, response ) {
+                $.getJSON( "/authorities/generic_files/" + field, {
+                    q: request.term
+                }, response );
+            },
+            focus: function() {
+                // prevent value inserted on focus
+                return false;
+            },
+            complete: function(event) {
+                $('.ui-autocomplete-loading').removeClass("ui-autocomplete-loading");
+            }
+        };
+        return autocomplete_opts;
+    }
+
+
+/*    var autocomplete_vocab = new Object();
+
+    autocomplete_vocab.url_var = ['other_subject', 'language', 'creator', 'contributor'];   // the url variable to pass to determine the vocab to attach to
+    autocomplete_vocab.field_name = new Array(); // the form name to attach the event for autocomplete
+
+    // loop over the autocomplete fields and attach the
+    // events for autocomplete and create other array values for autocomplete
+    for (var i=0; i < autocomplete_vocab.url_var.length; i++) {
+        autocomplete_vocab.field_name.push('generic_file_' + autocomplete_vocab.url_var[i]);
+        // autocompletes
+        $("input." + autocomplete_vocab.field_name[i])
+            // don't navigate away from the field on tab when selecting an item
+            .bind( "keydown", function( event ) {
+                if ( event.keyCode === $.ui.keyCode.TAB &&
+                    $( this ).data( "autocomplete" ).menu.active ) {
+                    event.preventDefault();
+                }
+            })
+            .autocomplete( get_autocomplete_opts(autocomplete_vocab.url_var[i]) );
+    }*/
+
+    function duplicate_field_click(event) {
+        original_element = $(event.target).parent().parent().parent().children().children();
+        original_id = original_element.attr("id");
+
+/*        if(original_id == 'generic_file_language' || original_id == 'generic_file_other_subject' || original_id == 'generic_file_creator' || original_id == 'generic_file_contributor'  ) {
+            cloned_element = $(event.target).parent().parent().parent().clone()
+        } else {
+            cloned_element = $(event.target).parent().parent().parent().clone(true, true);
+        }*/
+
+
+
+        cloned_element.find("input").val("");
+        cloned_element.find("textarea").val("");
+        cloned_element.find("select").val("");
+
+        $(event.target).parent().parent().parent().after(cloned_element);
+
+
+/*        if(original_id == 'generic_file_language' || original_id == 'generic_file_other_subject' || original_id == 'generic_file_creator' || original_id == 'generic_file_contributor' ) {
+            added_element = $(event.target).parent().parent().parent().next().children().children();
+            added_add_button = $(event.target).parent().parent().parent().next().children().children('.regular_dta_duplicate_span').children('.regular_dta_duplicate_field');
+            remove_add_button = $(event.target).parent().parent().parent().next().children().children('.regular_dta_delete_span').children('.regular_dta_delete_field');
+            //added_id = added_element.attr("id");
+            if(original_id == 'generic_file_language') {
+                $(added_element).autocomplete(get_autocomplete_opts('language'));
+            } else if(original_id == 'generic_file_other_subject') {
+                $(added_element).autocomplete(get_autocomplete_opts('other_subject'));
+            } else if(original_id == 'generic_file_creator') {
+                $(added_element).autocomplete(get_autocomplete_opts('creator'));
+            } else if(original_id == 'generic_file_contributor') {
+                $(added_element).autocomplete(get_autocomplete_opts('contributor'));
+            }
+
+            added_add_button.click(duplicate_field_click);
+            remove_add_button.click(delete_field_click);
+        }*/
+
+    }
+
+    function delete_field_click(event) {
+        //parent().parent().children().length
+        local_field_name = $(event.target).parent().prev().prev().attr('name');
+
+        //Current hack for lookup fields... may need more when I add hidden fields...
+        if(local_field_name == undefined) {
+            local_field_name = $(event.target).parent().prev().prev().prev().attr('name');
+        }
+        if ($('input[name*="' + local_field_name + '"]').length == 1) {
+            //$(event.target).parent().parent().parent().parent().find("input").val("");
+            $(event.target).parent().parent().parent().find("input").val("");
+        } else if($('select[name*="' + local_field_name + '"]').length == 1) {
+            //$(event.target).parent().parent().parent().parent().find("select").val("");
+            $(event.target).parent().parent().parent().find("select").val("");
+        } else {
+            //$(event.target).parent().parent().parent().parent().remove();
+            $(event.target).parent().parent().parent().remove();
+        }
+    }
+
+        $(".regular_dta_duplicate_field").click(duplicate_field_click);
+
+        $(".regular_dta_delete_field").click(delete_field_click);
+
+    });
+

data/app/assets/stylesheets/mei/mei_styles.scss

@@ -0,0 +1,80 @@
+.mei_alt_table_row {
+  background-color: #D3D3D3;
+}
+
+.mei_table_style {
+  padding: 10px;
+  width:100%;
+}
+
+.mei_table_style tr td {
+  padding-left:10px;
+  padding-top:5px;
+  padding-bottom: 5px;
+}
+
+/*.modal.modal-wide {
+  width: 90%;
+}*/
+
+.regular_dta_duplicate_span {
+  width:35px;
+}
+
+.repeat_field_value, .no_repeat_field_value {
+  .btn.add, .btn.remove {
+    width: 6em;
+  }
+
+  .field-wrapper {
+    list-style-type:none;
+    width:100%;
+  }
+
+  .listing {
+    margin-left: 0;
+    max-width: 50em;
+    padding-left: 0px;
+    .input-group {
+      margin-bottom: 1px;
+    }
+  }
+
+  .field-controls span {
+    margin-left:.2em;
+  }
+
+  .field-controls {
+    margin-left: 2em;
+  }
+
+  .message{
+    background-size: 40px 40px;
+    background-image: linear-gradient(135deg, rgba(255, 255, 255, .05) 25%, transparent 25%,
+            transparent 50%, rgba(255, 255, 255, .05) 50%, rgba(255, 255, 255, .05) 75%,
+            transparent 75%, transparent);
+    box-shadow: inset 0 -1px 0 rgba(255,255,255,.4);
+    width: 100%;
+    border: 1px solid;
+    color: #fff;
+    padding: 10px;
+    text-shadow: 0 1px 0 rgba(0,0,0,.5);
+    animation: animate-bg 5s linear infinite;
+    //border-radius: $border-radius-base;
+  }
+
+  .has-error{
+    background-color: #de4343;
+    border-color: #c43d3d;
+  }
+
+  .has-warning{
+    background-color: #eaaf51;
+    border-color: #d99a36;
+  }
+}
+
+// The contributor listing needs some normalization
+#contributors .listing {
+  max-width:20em;
+}

data/app/controllers/mei/application_controller.rb

@@ -0,0 +1,4 @@
+module Mei
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/mei/terms_controller.rb

@@ -0,0 +1,55 @@
+require 'rdf'
+require 'cgi'
+
+# This controller is used for all requests to all authorities. It will verify params and figure out
+# which class to instantiate based on the "vocab" param. All the authotirty classes inherit from a
+# super class so they implement the same methods.
+
+class Mei::TermsController < ApplicationController
+  def query
+    s = params.fetch("q", "")
+    e = params.fetch("e", "")
+    field = params[:term]
+
+    ldf_server = Mei::TermsController.mei_config[:ldf_server]
+    selected_config = Mei::TermsController.mei_config[:form_fields].select { |item| item["id"] == field}
+    return [] if selected_config.blank?
+
+    hits = case selected_config.first["adapter"].to_sym
+             when :lcsh
+               Mei::LcshSubjectResource.find(s,e,selected_config.first["solr_field"])
+             when :geonames
+               Mei::GeoNamesResource.find(s,e,selected_config.first["solr_field"])
+             when :homosaurus
+               Mei::HomosaurusSubjectResource.find(s,e,selected_config.first["solr_field"])
+             else
+               []
+           end
+
+    render json: hits
+  end
+
+  def self.mei_config
+    @config ||= YAML::load(File.open(config_path))[env]
+                    .with_indifferent_access
+  end
+
+  def self.app_root
+    return @app_root if @app_root
+    @app_root = Rails.root if defined?(Rails) and defined?(Rails.root)
+    @app_root ||= APP_ROOT if defined?(APP_ROOT)
+    @app_root ||= '.'
+  end
+
+  def self.env
+    return @env if @env
+    #The following commented line always returns "test" in a rails c production console. Unsure of how to fix this yet...
+    #@env = ENV["RAILS_ENV"] = "test" if ENV
+    @env ||= Rails.env if defined?(Rails) and defined?(Rails.root)
+    @env ||= 'development'
+  end
+
+  def self.config_path
+    File.join(app_root, 'config', 'mei.yml')
+  end
+end

data/app/helpers/mei/application_helper.rb

@@ -0,0 +1,2 @@
+module Mei::ApplicationHelper
+end

data/app/inputs/lcsh_lookup_input.rb

@@ -0,0 +1,40 @@
+class LcshLookupInput < MeiMultiLookupInput
+  #include WithHelpIcon
+
+  def buffer_each(collection)
+    collection.each_with_object('').with_index do |(value, buffer), index|
+      #buffer << yield(value, index) if value.match(/http:\/\/id.loc.gov\/authorities\/subjects\//) || value.blank?
+      if  value.blank?
+        buffer << yield(value, index)
+      elsif value.match(/http:\/\/id.loc.gov\/authorities\/subjects\//)
+        english_label = nil
+        default_label = nil
+        any_match = nil
+
+        repo = Mei::Loc.pop_graph(value)
+
+        if repo.query(:subject=>::RDF::URI.new(value), :predicate=>Mei::Loc.qskos('prefLabel')).count > 0
+          repo.query(:subject=>::RDF::URI.new(value), :predicate=>Mei::Loc.qskos('prefLabel')).each_statement do |result_statement|
+            #LoC has blank nodes... see alts of http://id.loc.gov/authorities/subjects/sh85102696 ... these aren't literals.
+            #LoC's blank node representation.... alt: to_s == "_:t829213" or check .resource? or check .node? or .id == 't829213'
+            if result_statement.object.literal?
+              if result_statement.object.language == :en
+                english_label ||= result_statement.object.value
+              elsif result_statement.object.language.blank?
+                default_label ||= result_statement.object.value
+              else
+                any_match ||= result_statement.object.value
+              end
+            end
+          end
+
+          default_label ||= any_match
+          english_label ||= default_label
+
+          buffer << yield("#{english_label} (#{value})", index)
+        end
+      end
+    end
+  end
+
+end

data/app/inputs/mei_multi_lookup_input.rb

@@ -0,0 +1,60 @@
+class MeiMultiLookupInput < MultiValueInput
+  # Overriding this so that the class is correct and the javascript for multivalue will work on this.
+  def input_type
+    'multi_value'.freeze
+  end
+
+  def inner_wrapper
+    <<-HTML
+          <li class="field-wrapper">
+<div class="input-group col-sm-12">
+            #{yield}
+             <button style="width:auto;" type="button" class="btn btn-default" data-toggle="modal" data-target="#meiLookupModal_#{attribute_name}">Lookup</button>
+</div>
+          </li>
+    HTML
+  end
+
+  # Although the 'index' parameter is not used in this implementation it is useful in an
+  # an overridden version of this method, especially when the field is a complex object and
+  # the override defines nested fields.
+  def build_field_options(value, index)
+    options = input_html_options.dup
+
+    options[:value] = value
+    if @rendered_first_element
+      options[:id] = nil
+      options[:required] = nil
+    else
+      options[:id] ||= input_dom_id
+    end
+    options[:class] ||= []
+    options[:class] += ["#{input_dom_id} form-control multi-text-field"]
+    options[:style] ||= []
+    options[:style] += ["width:80%"]
+    options[:'aria-labelledby'] = label_id
+    @rendered_first_element = true
+
+    options
+  end
+
+=begin
+  def inner_wrapper
+    <<-HTML
+          <li class="field-wrapper">
+             <div class="input-group col-sm-12">
+              #{yield}
+
+             <button style="width:auto;" type="button" class="btn btn-default" data-toggle="modal" data-target="#meiLookupModal_#{attribute_name}">Lookup</button>
+              <span class="input-group-btn regular_dta_duplicate_span">
+                <button class="btn btn-success regular_dta_duplicate_field" type="button">+</button>
+              </span>
+                    <span class="input-group-btn regular_dta_delete_span">
+                      <button class="btn btn-danger regular_dta_delete_field" type="button">-</button>
+                    </span>
+              </div>
+          </li>
+    HTML
+  end
+=end
+end

data/app/inputs/with_help_icon.rb

@@ -0,0 +1,32 @@
+module WithHelpIcon
+  def label(wrapper_options = nil)
+    "#{super} #{link_to_help}"
+  end
+
+  protected
+
+  def link_to_help
+    template.link_to '#', id: "#{input_class}_help", rel: 'popover'.freeze,
+                     'data-content' => metadata_help, 'data-original-title' => raw_label_text,
+                     'aria-label' => aria_label, 'data-trigger' => 'focus' do
+      help_icon
+    end
+  end
+
+  def help_icon
+    template.content_tag 'i', nil, "aria-hidden" => true, class: "help-icon"
+  end
+
+  def metadata_help
+    translate_from_namespace(:metadata_help) || attribute_name.to_s.humanize
+  end
+
+  def aria_label
+    translate_from_namespace(:aria_label) || default_aria_label
+  end
+
+  def default_aria_label
+    I18n.t("#{i18n_scope}.aria_label.#{lookup_model_names.join('.')}.default",
+           title: attribute_name.to_s.humanize)
+  end
+end

data/app/models/mei/geo_names_resource.rb

@@ -0,0 +1,14 @@
+module Mei
+  class GeoNamesResource
+    def self.find(subject, type, solr_field)
+      authority_check = Mei::Geonames.new(type)
+      authority_result = authority_check.search(subject) #URI escaping doesn't work for Baseball fields?
+      if authority_result.present?
+        return authority_result
+      else
+        return []
+      end
+    end
+
+  end
+end

data/app/models/mei/homosaurus_subject_resource.rb

@@ -0,0 +1,132 @@
+module Mei
+  class HomosaurusSubjectResource
+
+    def self.find(subject, type, solr_field)
+      #solr_response = ActiveFedora::Base.find_with_conditions({subject_tesim: "test"} , rows: '10', fl: 'subject_tesim' )
+      #ActiveFedora::Base.find_each("subject_tesim:tes*") { |x| puts 'hi' }
+      matches = []
+      dup_checker = []
+      subject = subject.downcase #FIXME?
+
+      solr_response = Homosaurus.find_with_conditions("dta_homosaurus_lcase_prefLabel_ssi:*#{solr_clean(subject)}*", rows: '25', fl: 'identifier_ssi, prefLabel_ssim, altLabel_ssim, narrower_ssim, broader_ssim, related_ssim' )
+
+      #FIXME - A result for "http" gives back the entire array of values...
+      if solr_response.present?
+
+        solr_response.each do |indv_response|
+          indv_subj = indv_response["identifier_ssi"]
+          if dup_checker.length < 20 && !dup_checker.include?(indv_subj)
+            matches << indv_response
+            dup_checker << indv_subj
+          end
+        end
+      end
+
+
+      if dup_checker.length < 20
+        solr_response = Homosaurus.find_with_conditions("dta_homosaurus_lcase_altLabel_ssim:*#{solr_clean(subject)}*", rows: '25', fl: 'identifier_ssi, prefLabel_ssim, altLabel_ssim, narrower_ssim, broader_ssim, related_ssim' )
+
+        #FIXME - A result for "http" gives back the entire array of values...
+        if solr_response.present?
+
+          solr_response.each do |indv_response|
+            indv_subj = indv_response["identifier_ssi"]
+            if dup_checker.length < 20 && !dup_checker.include?(indv_subj)
+              matches << indv_response
+              dup_checker << indv_subj
+            end
+          end
+        end
+      end
+
+      if dup_checker.length < 20
+        solr_response = Homosaurus.find_with_conditions("dta_homosaurus_lcase_comment_tesi:#{solr_clean(subject)}", rows: '25', fl: 'identifier_ssi, prefLabel_ssim, altLabel_ssim, comment_ssim, narrower_ssim, broader_ssim, related_ssim' )
+
+        #FIXME - A result for "http" gives back the entire array of values...
+        if solr_response.present?
+
+          solr_response.each do |indv_response|
+            indv_subj = indv_response["identifier_ssi"]
+            if dup_checker.length < 20 && !dup_checker.include?(indv_subj)
+              matches << indv_response
+              dup_checker << indv_subj
+            end
+          end
+        end
+      end
+
+      if matches.present?
+
+        return matches.map! { |item|
+          ##{URI.escape(item)}
+          full_uri = 'http://homosaurus.org/terms/' + item['identifier_ssi']
+
+          count = ActiveFedora::Base.find_with_conditions("homosaurus_subject_ssim:#{solr_clean(full_uri)}", rows: '100', fl: 'subject_tesim' ).length
+          if count >= 99
+            count = "99+"
+          else
+            count = count.to_s
+          end
+
+          variants = item['altLabel_ssim']
+
+          {
+              "uri_link" => full_uri,
+              "label" => item['prefLabel_ssim'].first,
+              "broader" => getBroader(item['broader_ssim']),
+              "narrower" => getNarrower(item['narrower_ssim']),
+              "related" => getRelated(item['related_ssim']),
+              "variants" => variants,
+              "count" => count
+          }
+        }
+      else
+        return []
+      end
+    end
+
+    def self.getBroader(broader_uris)
+      broader_list = []
+
+      if broader_uris.present?
+        broader_uris.each do |broader_single_uri|
+          broader_label = Homosaurus.find_with_conditions("id:#{solr_clean(broader_single_uri)}", rows: '1', fl: 'prefLabel_ssim' )
+          broader_list << {:uri_link=>"http://homosaurus.org/terms/#{broader_single_uri.split('/').last}", :label=>broader_label[0]["prefLabel_ssim"][0]}
+        end
+      end
+
+      return broader_list
+    end
+
+    def self.getNarrower(narrower_uris)
+      narrower_list = []
+
+      if narrower_uris.present?
+        narrower_uris.each do |narrower_single_uri|
+          narrower_label = Homosaurus.find_with_conditions("id:#{solr_clean(narrower_single_uri)}", rows: '1', fl: 'prefLabel_ssim' )
+          narrower_list << {:uri_link=>"http://homosaurus.org/terms/#{narrower_single_uri.split('/').last}", :label=>narrower_label[0]["prefLabel_ssim"][0]}
+        end
+      end
+
+      return narrower_list
+    end
+
+    def self.getRelated(related_uris)
+      related_list = []
+
+      if related_uris.present?
+        related_uris.each do |related_single_uri|
+          related_label = Homosaurus.find_with_conditions("id:#{solr_clean(related_single_uri)}", rows: '1', fl: 'prefLabel_ssim' )
+          related_list << {:uri_link=>"http://homosaurus.org/terms/#{related_single_uri.split('/').last}", :label=>related_label[0]["prefLabel_ssim"][0]}
+        end
+      end
+
+      return related_list
+    end
+
+    def self.solr_clean(term)
+      return term.gsub('\\', '\\\\').gsub(':', '\\:').gsub(' ', '\ ')
+    end
+
+  end
+end