cul_scv_hydra 0.3.0

data/lib/cul_scv_hydra/solrizer.rb

@@ -0,0 +1,12 @@
+module Cul
+  module Scv
+    module Hydra
+      module Solrizer
+      end
+    end
+  end
+end
+require "cul_scv_hydra/solrizer/extractor"
+require "cul_scv_hydra/solrizer/field_mapper"
+require "cul_scv_hydra/solrizer/terminology_based_solrizer"
+require "cul_scv_hydra/solrizer/value_mapper"

data/lib/cul_scv_hydra/solrizer/extractor.rb

@@ -0,0 +1,27 @@
+module Cul::Scv::Hydra::Solrizer
+class Extractor < ::Solrizer::Extractor
+  # Insert +field_value+ for +field_name+ into +solr_doc+
+  # Handles inserting new values into a Hash while ensuring that you don't destroy or overwrite any existing values in the hash.
+  # Ensures that field values are always appended to arrays within the values hash. 
+  # Ensures that values are run through format_node_value
+  # Also ensures that values are unique if specified
+  # @param [Hash] solr_doc
+  # @param [String] field_name
+  # @param [String] field_value
+  # @param [boolean] unique
+  def self.insert_solr_field_value(solr_doc, field_name, field_value, unique=false)
+    formatted_value = self.format_node_value(field_value)
+    if solr_doc.has_key?(field_name)
+      solr_doc[field_name] << formatted_value unless (unique and solr_doc[field_name].include? formatted_value)
+    else
+      solr_doc.merge!( {field_name => [formatted_value]} ) 
+    end
+    return solr_doc
+  end
+
+  # Instance Methods
+  def insert_solr_field_value(solr_doc, field_name, field_value, unique=false)
+    Cul::Scv::Hydra::Solrizer::Extractor.insert_solr_field_value(solr_doc, field_name, field_value, unique)
+  end
+end
+end

data/lib/cul_scv_hydra/solrizer/field_mapper.rb

@@ -0,0 +1,30 @@
+require 'solrizer'
+module Cul::Scv::Hydra::Solrizer
+class FieldMapper < ::Solrizer::FieldMapper::Default
+  alias_method(:orig_solr_name_and_mappings, :solr_name_and_mappings)
+
+  def self.default
+    if defined?(Rails.root) && !Rails.root.nil?
+      config_path = File.join(Rails.root, "config", "solr_mappings.yml")
+    end
+    # Default to using the config file within the gem 
+    if !File.exist?(config_path.to_s)
+      config_path = File.join(File.dirname(__FILE__), "..", "..", "..", "config", "solr_mappings.yml")
+    end
+    self.load_mappings(config_path)
+    logger.info("FieldMapper: loading field name mappings from #{File.expand_path(config_path)}")
+    self.new
+  end
+
+# This is an override of a private method in the base class, and will have to be monitored for changes
+  def solr_name_and_mappings(field_name, field_type, index_type)
+    if index_type == :textable
+      result = orig_solr_name_and_mappings(field_name, field_type, :searchable)
+      result[0]  = 'text'
+      return result
+    else
+      orig_solr_name_and_mappings(field_name, field_type, index_type)
+    end
+  end
+end
+end

data/lib/cul_scv_hydra/solrizer/terminology_based_solrizer.rb

@@ -0,0 +1,112 @@
+require 'solrizer'
+module Cul::Scv::Hydra::Solrizer::TerminologyBasedSolrizer
+# copied from Solrizer::XML::TerminologyBasedSolrizer
+  def self.default_field_mapper
+    @@default_field_mapper ||= Cul::Scv::Hydra::Solrizer::FieldMapper.default
+  end
+
+  def self.default_extractor
+    @@default_extractor ||= Cul::Scv::Hydra::Solrizer::Extractor.new
+  end
+
+  def self.default_value_mapper
+    @@value_mapper ||= Cul::Scv::Hydra::Solrizer::ValueMapper.new
+  end
+
+  
+  # Module Methods
+  
+  # Build a solr document from +doc+ based on its terminology
+  # @param [OM::XML::Document] doc  
+  # @param [Hash] (optional) solr_doc (values hash) to populate
+  def self.solrize(doc, solr_doc=Hash.new, field_mapper = nil)
+    unless doc.class.terminology.nil?
+      doc.class.terminology.terms.each_pair do |term_name,term|
+        doc.solrize_term(term, solr_doc, field_mapper)
+        # self.solrize_by_term(accessor_name, accessor_info, :solr_doc=>solr_doc)
+      end
+    end
+
+    return solr_doc
+  end
+  
+  # Populate a solr document with fields based on nodes in +xml+ corresponding to the 
+  # term identified by +term_pointer+ within +terminology+
+  # @param [OM::XML::Document] doc xml document to extract values from
+  # @param [OM::XML::Term] term corresponding to desired xml values
+  # @param [Hash] (optional) solr_doc (values hash) to populate
+  # @param [Solrizer::FieldMapper] (optional) object that maps a term and its index options to solr field names
+  def self.solrize_term(doc, term, solr_doc = Hash.new, field_mapper = nil, opts={})
+    terminology = doc.class.terminology
+    parents = opts.fetch(:parents, [])
+
+    term_pointer = parents+[term.name]
+    nodeset = doc.find_by_terms(*term_pointer)
+    nodeset.each do |node|
+      # create solr fields
+      
+      doc.solrize_node(node, term_pointer, term, solr_doc, field_mapper)
+      unless term.kind_of? OM::XML::NamedTermProxy
+        term.children.each_pair do |child_term_name, child_term|
+          doc.solrize_term(child_term, solr_doc, field_mapper, opts={:parents=>parents+[{term.name=>nodeset.index(node)}]})
+        end
+      end
+    end
+    solr_doc
+  end
+  
+  # Populate a solr document with solr fields corresponding to the given xml node
+  # Field names are generated using settings from the term in the +doc+'s terminology corresponding to +term_pointer+
+  # @param [Nokogiri::XML::Node] node to solrize
+  # @param [OM::XML::Document] doc document the node came from
+  # @param [Array] term_pointer Array pointing to the term that should be used for solrization settings
+  # @param [Hash] (optional) solr_doc (values hash) to populate
+  def self.solrize_node(node, doc, term_pointer, term, solr_doc = Hash.new, field_mapper = nil, opts = {})
+    terminology = doc.class.terminology
+    # term = terminology.retrieve_term(*term_pointer)
+    if term.path.kind_of?(Hash) && term.path.has_key?(:attribute)
+      node_value = node.value
+    else
+      node_value = node.text
+    end
+    generic_field_name_base = OM::XML::Terminology.term_generic_name(*term_pointer)
+    
+    self.insert_field_value(solr_doc, term, generic_field_name_base, node_value, term.data_type, term.index_as, field_mapper)
+    
+    if term_pointer.length > 1
+      hierarchical_field_name_base = OM::XML::Terminology.term_hierarchical_name(*term_pointer)
+      self.insert_field_value(solr_doc, term, hierarchical_field_name_base, node_value, term.data_type, term.index_as, field_mapper)
+    end
+    if term.variant_of and term.variant_of[:field_base]
+      self.insert_field_value(solr_doc, term, term.variant_of[:field_base], node_value, term.data_type, term.index_as, field_mapper, true)
+    end
+    solr_doc
+  end
+
+  def self.insert_field_value(solr_doc, term, field_base_name, field_value, data_type, index_as, field_mapper=nil , unique=false)
+    field_mapper = self.default_field_mapper if field_mapper.nil?
+    field_mapper.solr_names_and_values(field_base_name, field_value, data_type, index_as).each { |field_name, field_value|
+        unless field_value.join("").strip.empty?
+          if term.variant_of and term.variant_of[:map]
+            field_value = default_value_mapper.solr_value(term.variant_of[:map], field_value)
+          end
+          self.default_extractor.insert_solr_field_value(solr_doc, field_name, field_value, (unique || (field_name == 'text')))
+        end
+    }
+  end
+# Instance Methods
+  
+  attr_accessor :field_mapper
+  
+  def to_solr(solr_doc = Hash.new, field_mapper = self.field_mapper) # :nodoc:
+    ::Solrizer::XML::TerminologyBasedSolrizer.solrize(self, solr_doc, field_mapper)
+  end
+  
+  def solrize_term(term, solr_doc = Hash.new, field_mapper = self.field_mapper, opts={})
+    Cul::Scv::Hydra::Solrizer::TerminologyBasedSolrizer.solrize_term(self, term, solr_doc, field_mapper, opts)    
+  end
+
+  def solrize_node(node, term_pointer, term, solr_doc = Hash.new, field_mapper = self.field_mapper, opts={})
+    Cul::Scv::Hydra::Solrizer::TerminologyBasedSolrizer.solrize_node(node, self, term_pointer, term, solr_doc, field_mapper, opts)
+  end
+end # module

data/lib/cul_scv_hydra/solrizer/value_mapper.rb

@@ -0,0 +1,35 @@
+module Cul::Scv::Hydra::Solrizer
+# This class uses a yaml map to translate field values for solr
+class ValueMapper
+def self.load_value_maps(config_path=nil)
+    if config_path.nil?
+      if defined?(Rails.root) && !Rails.root.nil?
+        config_path = File.join(Rails.root, "config", "solr_value_maps.yml")
+      end
+      # Default to using the config file within the gem
+      if !File.exist?(config_path.to_s)
+        config_path = File.join(File.dirname(__FILE__), "..", "..", "..", "config", "solr_value_maps.yml")
+      end
+    end
+    logger.info("ValueMapper: loading field value maps from #{File.expand_path(config_path)}")
+    YAML::load(File.open(config_path))
+  end
+
+  def self.default_value_maps
+    @@value_maps ||= self.load_value_maps
+  end
+  # Instance methods
+
+  def initialize(value_maps=nil)
+    @value_maps = value_maps || Cul::Scv::Hydra::Solrizer::ValueMapper.default_value_maps
+  end
+  def solr_value(map_key, value_key)
+    return value_key unless @value_maps.has_key? map_key
+    if value_key.is_a? Array
+      value_key.collect{ |val| @value_maps[map_key].fetch(val, val) }
+    else
+      @value_maps[map_key].fetch(value_key, value_key)
+    end
+  end
+end
+end

data/lib/cul_scv_hydra/version.rb

@@ -0,0 +1,10 @@
+module Cul
+  module Scv
+    module Hydra
+        VERSION = '0.3.0'
+        def self.version
+          VERSION
+        end
+    end
+  end
+end

metadata

@@ -0,0 +1,333 @@
+--- !ruby/object:Gem::Specification 
+name: cul_scv_hydra
+version: !ruby/object:Gem::Version 
+  hash: 19
+  prerelease: 
+  segments: 
+  - 0
+  - 3
+  - 0
+  version: 0.3.0
+platform: ruby
+authors: 
+- Benjamin Armintor
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-04-23 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: cul_image_props
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: blacklight
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 3
+        - 1
+        version: "3.1"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: active-fedora
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 3
+        - 3
+        version: "3.3"
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: hydra-head
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 1
+        segments: 
+        - 3
+        - 3
+        version: "3.3"
+  type: :runtime
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: rubydora
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 0
+        - 2
+        - 6
+        version: 0.2.6
+  type: :runtime
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 1
+        - 4
+        - 2
+        version: 1.4.2
+  type: :runtime
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: om
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 2
+        - 4
+        version: 1.2.4
+  type: :runtime
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: solrizer
+  prerelease: false
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 1
+        - 2
+        version: 1.1.2
+  type: :runtime
+  version_requirements: *id009
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 47
+        segments: 
+        - 2
+        - 8
+        - 0
+        version: 2.8.0
+  type: :development
+  version_requirements: *id010
+- !ruby/object:Gem::Dependency 
+  name: rspec-rails
+  prerelease: false
+  requirement: &id011 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 45
+        segments: 
+        - 2
+        - 8
+        - 1
+        version: 2.8.1
+  type: :development
+  version_requirements: *id011
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id012 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 43
+        segments: 
+        - 0
+        - 9
+        - 8
+        version: 0.9.8
+  type: :development
+  version_requirements: *id012
+- !ruby/object:Gem::Dependency 
+  name: equivalent-xml
+  prerelease: false
+  requirement: &id013 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 0
+        - 2
+        - 4
+        version: 0.2.4
+  type: :development
+  version_requirements: *id013
+- !ruby/object:Gem::Dependency 
+  name: rbx-require-relative
+  prerelease: false
+  requirement: &id014 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 0
+        - 0
+        - 5
+        version: 0.0.5
+  type: :development
+  version_requirements: *id014
+description: ActiveFedora, OM, and Solrizer implementations for CUL Staff Collection Viewer
+email: armintor@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/cul_scv_hydra/access_controls_enforcement.rb
+- lib/cul_scv_hydra/active_fedora/model/aggregator.rb
+- lib/cul_scv_hydra/active_fedora/model/common.rb
+- lib/cul_scv_hydra/active_fedora/model/dcdocument.rb
+- lib/cul_scv_hydra/active_fedora/model/resource.rb
+- lib/cul_scv_hydra/active_fedora/model.rb
+- lib/cul_scv_hydra/active_fedora.rb
+- lib/cul_scv_hydra/controllers/aggregates.rb
+- lib/cul_scv_hydra/controllers/aggregator_controller_helper.rb
+- lib/cul_scv_hydra/controllers/catalog.rb
+- lib/cul_scv_hydra/controllers/content_aggregators.rb
+- lib/cul_scv_hydra/controllers/datastreams.rb
+- lib/cul_scv_hydra/controllers/helpers/active_fedora_helper_behavior.rb
+- lib/cul_scv_hydra/controllers/helpers/application_helper_behavior.rb
+- lib/cul_scv_hydra/controllers/helpers/dc_metadata_helper_behavior.rb
+- lib/cul_scv_hydra/controllers/helpers/hydra_assets_helper_behavior.rb
+- lib/cul_scv_hydra/controllers/helpers/hydra_autocomplete_helper_behavior.rb
+- lib/cul_scv_hydra/controllers/helpers/hydra_uploader_helper_behavior.rb
+- lib/cul_scv_hydra/controllers/helpers/resources_helper_behavior.rb
+- lib/cul_scv_hydra/controllers/helpers.rb
+- lib/cul_scv_hydra/controllers/resources.rb
+- lib/cul_scv_hydra/controllers/static_image_aggregators.rb
+- lib/cul_scv_hydra/controllers/suggestions.rb
+- lib/cul_scv_hydra/controllers/terms.rb
+- lib/cul_scv_hydra/controllers.rb
+- lib/cul_scv_hydra/engine.rb
+- lib/cul_scv_hydra/om/dc_metadata.rb
+- lib/cul_scv_hydra/om/scv_mods_document.rb
+- lib/cul_scv_hydra/om/standard_mods.rb
+- lib/cul_scv_hydra/om.rb
+- lib/cul_scv_hydra/solrizer/extractor.rb
+- lib/cul_scv_hydra/solrizer/field_mapper.rb
+- lib/cul_scv_hydra/solrizer/terminology_based_solrizer.rb
+- lib/cul_scv_hydra/solrizer/value_mapper.rb
+- lib/cul_scv_hydra/solrizer.rb
+- lib/cul_scv_hydra/version.rb
+- lib/cul_scv_hydra.rb
+- app/models/bag_aggregator.rb
+- app/models/content_aggregator.rb
+- app/models/dcdocument.rb
+- app/models/generic_aggregator.rb
+- app/models/generic_object.rb
+- app/models/jp2_image_aggregator.rb
+- app/models/mets_structured_aggregator.rb
+- app/models/resource.rb
+- app/models/static_audio_aggregator.rb
+- app/models/static_image_aggregator.rb
+- config/fedora.yml
+- config/predicate_mappings.yml
+- config/solr.yml
+- config/solr_mappings.yml
+- config/solr_value_maps.yml
+homepage: https://github.com/cul/cul_scv_hydra
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: ActiveFedora, OM, and Solrizer implementations for CUL Staff Collection Viewer
+test_files: []
+