active-fedora 1.1.13 → 1.2.0

data/lib/active_fedora/solr_service.rb

@@ -1,10 +1,9 @@
 require 'solr'
-require "active_fedora/solr_mapper"
-require "yaml"
-module ActiveFedora 
-  class SolrService
+require "solrizer/field_name_mapper"
+
+module ActiveFedora
+  class SolrService 
       
-    @@mappings = {}
     attr_reader :conn
         
     def self.register(host=nil, args={})
@@ -22,19 +21,23 @@ module ActiveFedora
       Thread.current[:solr_service]
     end
     
-    def self.reify_solr_results(solr_result)
+    def self.reify_solr_results(solr_result,opts={})
       unless solr_result.is_a?(Solr::Response::Standard)
         raise ArgumentError.new("Only solr responses (Solr::Response::Standard) are allowed. You provided a #{solr_result.class}")
       end
       results = []
       solr_result.hits.each do |hit|
-        model_value = hit[ActiveFedora::SolrMapper.solr_name("active_fedora_model", :symbol)].first
+        model_value = hit[Solrizer::FieldNameMapper.solr_name("active_fedora_model", :symbol)].first
         if model_value.include?("::")
           classname = eval(model_value)
         else
           classname = Kernel.const_get(model_value)
         end
-        results << Fedora::Repository.instance.find_model(hit[SOLR_DOCUMENT_ID], classname)
+        if opts[:load_from_solr]
+          results << classname.load_instance_from_solr(hit[SOLR_DOCUMENT_ID])
+        else
+          results << Fedora::Repository.instance.find_model(hit[SOLR_DOCUMENT_ID], classname)
+        end
       end
       return results
     end
@@ -54,40 +57,22 @@ module ActiveFedora
     end
     
     def self.mappings
-      @@mappings
+      Solrizer::FieldNameMapper.mappings
     end
     def self.mappings=(mappings)
-      @@mappings = mappings
-    end    
-    
+      Solrizer::FieldNameMapper.mappings = mappings
+    end
+        
     def self.logger      
       @logger ||= defined?(RAILS_DEFAULT_LOGGER) ? RAILS_DEFAULT_LOGGER : Logger.new(STDOUT)
     end
     
-    # Loads solr mappings from yml file.
-    # @config_path This is the path to the directory where your mappings file is stored. @default "RAILS_ROOT/config/solr_mappings.yml"
-    # @mappings_file This is the filename for your solr mappings YAML file.  @default solr_mappings.yml
+    # (re)load solr field name mappings
     def self.load_mappings( config_path=nil )
-
-      if config_path.nil? 
-        if defined?(RAILS_ROOT)
-          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
-      end
-
-      logger.info("FEDORA: loading SolrService mappings from #{File.expand_path(config_path)}")
-
-      @@mappings = YAML::load(File.open(config_path))
-      
-      mappings["id"] = "id" unless mappings["id"]
+      Solrizer::FieldNameMapper.load_mappings(config_path)
     end
     
-    self.load_mappings
-    
-  end
-  class SolrNotInitialized < StandardError;end
-end
+  
+end #SolrService
+class SolrNotInitialized < StandardError;end
+end #ActiveFedora

data/lib/fedora/connection.rb

@@ -186,9 +186,13 @@ module Fedora
     # Creates new Net::HTTP instance for communication with
     # remote service and resources.
     def http
-      http             = Net::HTTP.new(@site.host, @site.port)
-      http.use_ssl     = @site.is_a?(URI::HTTPS)
-      http.verify_mode = OpenSSL::SSL::VERIFY_NONE if http.use_ssl
+      http = Net::HTTP.new(@site.host, @site.port)
+      if(@site.is_a?(URI::HTTPS) && !SSL_CLIENT_CERT_FILE.nil? && !SSL_CLIENT_KEY_FILE.nil? && !SSL_CLIENT_KEY_PASS.nil?)
+        http.use_ssl = true
+        http.cert = OpenSSL::X509::Certificate.new( File.read(SSL_CLIENT_CERT_FILE) )
+        http.key = OpenSSL::PKey::RSA.new( File.read(SSL_CLIENT_KEY_FILE), SSL_CLIENT_KEY_PASS )
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
       http
     end
 

data/lib/hydra/sample_mods_datastream.rb

@@ -1,100 +1,63 @@
 require "hydra"
 module Hydra
 class Hydra::SampleModsDatastream < ActiveFedora::NokogiriDatastream       
-
-    # have to call this in order to set namespace & schema
-    root_property :mods, "mods", "http://www.loc.gov/mods/v3", :attributes=>["id", "version"], :schema=>"http://www.loc.gov/standards/mods/v3/mods-3-2.xsd"          
-
-    property :title_info, :path=>"titleInfo", 
-                :convenience_methods => {
-                  :main_title => {:path=>"title"},
-                  :language => {:path=>{:attribute=>"lang"}},                    
-                }
-    property :abstract, :path=>"abstract"
-    property :topic_tag, :path=>'subject',:default_content_path => "topic"
-
-    property :name_, :path=>"name", 
-                :attributes=>[:xlink, :lang, "xml:lang", :script, :transliteration, {:type=>["personal", "enumerated", "corporate"]} ],
-                :subelements=>["namePart", "displayForm", "affiliation", :role, "description"],
-                :default_content_path => "namePart",
-                :convenience_methods => {
-                  :date => {:path=>"namePart", :attributes=>{:type=>"date"}},
-                  :family_name => {:path=>"namePart", :attributes=>{:type=>"family"}},
-                  :first_name => {:path=>"namePart", :attributes=>{:type=>"given"}},
-                  :terms_of_address => {:path=>"namePart", :attributes=>{:type=>"termsOfAddress"}}
-                }
-
-    property :person, :variant_of=>:name_, :attributes=>{:type=>"personal"}
-    property :organizaton, :variant_of=>:name_, :attributes=>{:type=>"institutional"}
-    property :conference, :variant_of=>:name_, :attributes=>{:type=>"conference"}
-
-    property :role, :path=>"role",
-                :parents=>[:name_],
-                :convenience_methods => {
-                  :text => {:path=>"roleTerm", :attributes=>{:type=>"text"}},
-                  :code => {:path=>"roleTerm", :attributes=>{:type=>"code"}},                    
-                }
-
-    property :journal, :path=>'relatedItem', :attributes=>{:type=>"host"},
-                :subelements=>[:title_info, :origin_info, :issue],
-                :convenience_methods => {
-                  :issn => {:path=>"identifier", :attributes=>{:type=>"issn"}},
-                }
-
-    property :origin_info, :path=>'originInfo',
-                :subelements=>["publisher","dateIssued"]
-
-    property :issue, :path=>'part',
-                :subelements=>[:start_page, :end_page],
-                :convenience_methods => {
-                  :volume => {:path=>"detail", :attributes=>{:type=>"volume"}},
-                  :level => {:path=>"detail", :attributes=>{:type=>"level"}},
-                  :publication_date => {:path=>"date"}
-                }
-    property :start_page, :path=>"extent", :attributes=>{:unit=>"pages"}, :default_content_path => "start"
-    property :end_page, :path=>"extent", :attributes=>{:unit=>"pages"}, :default_content_path => "end"
-
-    generate_accessors_from_properties    
-    # accessor :title_info, :relative_xpath=>'oxns:titleInfo', :children=>[
-    #   {:main_title=>{:relative_xpath=>'oxns:title'}},         
-    #   {:language =>{:relative_xpath=>{:attribute=>"lang"} }}
-    #   ] 
-    # accessor :abstract
-    # accessor :topic_tag, :relative_xpath=>'oxns:subject/oxns:topic'
-    # accessor :person, :relative_xpath=>'oxns:name[@type="personal"]',  :children=>[
-    #   {:last_name=>{:relative_xpath=>'oxns:namePart[@type="family"]'}}, 
-    #   {:first_name=>{:relative_xpath=>'oxns:namePart[@type="given"]'}}, 
-    #   {:institution=>{:relative_xpath=>'oxns:affiliation'}}, 
-    #   {:role=>{:children=>[
-    #     {:text=>{:relative_xpath=>'oxns:roleTerm[@type="text"]'}},
-    #     {:code=>{:relative_xpath=>'oxns:roleTerm[@type="code"]'}}
-    #   ]}}
-    # ]
-    # accessor :organization, :relative_xpath=>'oxns:name[@type="institutional"]', :children=>[
-    #   {:role=>{:children=>[
-    #     {:text=>{:relative_xpath=>'oxns:roleTerm[@type="text"]'}},
-    #     {:code=>{:relative_xpath=>'oxns:roleTerm[@type="code"]'}}
-    #   ]}}
-    # ]
-    # accessor :conference, :relative_xpath=>'oxns:name[@type="conference"]', :children=>[
-    #   {:role=>{:children=>[
-    #     {:text=>{:relative_xpath=>'oxns:roleTerm[@type="text"]'}},
-    #     {:code=>{:relative_xpath=>'oxns:roleTerm[@type="code"]'}}
-    #   ]}}
-    # ]
-    # accessor :journal, :relative_xpath=>'oxns:relatedItem[@type="host"]', :children=>[
-    #     {:title=>{:relative_xpath=>'oxns:titleInfo/oxns:title'}}, 
-    #     {:publisher=>{:relative_xpath=>'oxns:originInfo/oxns:publisher'}},
-    #     {:issn=>{:relative_xpath=>'oxns:identifier[@type="issn"]'}}, 
-    #     {:date_issued=>{:relative_xpath=>'oxns:originInfo/oxns:dateIssued'}},
-    #     {:issue => {:relative_xpath=>"oxns:part", :children=>[          
-    #       {:volume=>{:relative_xpath=>'oxns:detail[@type="volume"]'}},
-    #       {:level=>{:relative_xpath=>'oxns:detail[@type="level"]'}},
-    #       {:start_page=>{:relative_xpath=>'oxns:extent[@unit="pages"]/oxns:start'}},
-    #       {:end_page=>{:relative_xpath=>'oxns:extent[@unit="pages"]/oxns:end'}},
-    #       {:publication_date=>{:relative_xpath=>'oxns:date'}}
-    #     ]}}
-    # ]    
+    
+    set_terminology do |t|
+      t.root(:path=>"mods", :xmlns=>"http://www.loc.gov/mods/v3", :schema=>"http://www.loc.gov/standards/mods/v3/mods-3-2.xsd")
+
+      t.title_info(:path=>"titleInfo") {
+        t.main_title(:path=>"title", :label=>"title")
+        t.language(:path=>{:attribute=>"lang"})
+      } 
+      t.abstract     
+      t.topic_tag(:path=>"subject", :default_content_path=>"topic")           
+      # This is a mods:name.  The underscore is purely to avoid namespace conflicts.
+      t.name_ {
+        # this is a namepart
+        t.namePart(:index_as=>[:searchable, :displayable, :facetable, :sortable], :required=>:true, :type=>:string, :label=>"generic name")
+        # affiliations are great
+        t.affiliation
+        t.displayForm
+        t.role(:ref=>[:role])
+        t.description
+        t.date(:path=>"namePart", :attributes=>{:type=>"date"})
+        t.last_name(:path=>"namePart", :attributes=>{:type=>"family"})
+        t.first_name(:path=>"namePart", :attributes=>{:type=>"given"}, :label=>"first name")
+        t.terms_of_address(:path=>"namePart", :attributes=>{:type=>"termsOfAddress"})
+      }
+      # lookup :person, :first_name        
+      t.person(:ref=>:name, :attributes=>{:type=>"personal"})
+      t.organizaton(:ref=>:name, :attributes=>{:type=>"institutional"})
+      t.conference(:ref=>:name, :attributes=>{:type=>"conference"})
+
+      t.role {
+        t.text(:path=>"roleTerm",:attributes=>{:type=>"text"})
+        t.code(:path=>"roleTerm",:attributes=>{:type=>"code"})
+      }
+      t.journal(:path=>'relatedItem', :attributes=>{:type=>"host"}) {
+        t.title_info
+        t.origin_info(:path=>"originInfo") {
+          t.publisher
+          t.date_issued(:path=>"dateIssued")
+        }
+        t.issn(:path=>"identifier", :attributes=>{:type=>"issn"})
+        t.issue(:path=>"part") {
+          t.volume(:path=>"detail", :attributes=>{:type=>"volume"}, :default_content_path=>"number")
+          t.level(:path=>"detail", :attributes=>{:type=>"number"}, :default_content_path=>"number")
+          t.extent
+          t.pages(:path=>"extent", :attributes=>{:type=>"pages"}) {
+            t.start
+            t.end
+          }
+          t.publication_date(:path=>"date")
+        }
+      }
+      
+    end
+    
+    # Changes from OM::Properties implementation
+    # renamed family_name => last_name
+    # start_page & end_page now accessible as [:journal, :issue, :pages, :start] (etc.)
 
 end
 end

data/spec/integration/base_find_by_fields_spec.rb

@@ -0,0 +1,215 @@
+require File.join( File.dirname(__FILE__), "..", "spec_helper" )
+
+class MockAFBaseQuerySolr < ActiveFedora::Base
+  has_metadata :name => "properties", :type => ActiveFedora::MetadataDatastream do |m|
+    m.field "holding_id", :string
+  end
+  
+  has_metadata :name => "descMetadata", :type => ActiveFedora::QualifiedDublinCoreDatastream do |m|
+    m.field "created", :date, :xml_node => "created"
+    m.field "language", :string, :xml_node => "language"
+    m.field "creator", :string, :xml_node => "creator"
+    # Created remaining fields
+    m.field "geography", :string, :xml_node => "geography"
+    m.field "title", :string, :xml_node => "title"
+  end
+end
+
+describe ActiveFedora::Base do
+  
+  before(:each) do
+    @test_object = ActiveFedora::Base.new
+    @test_object.new_object = true
+  end
+
+  after(:each) do
+    begin
+    @test_object.delete
+    rescue
+    end
+    begin
+    @test_object2.delete
+    rescue
+    end
+    begin
+    @test_object3.delete
+    rescue
+    end
+    begin
+    @test_object4.delete
+    rescue
+    end
+    begin
+    @test_object5.delete
+    rescue
+    end
+  end
+
+  describe '#find_by_fields_by_solr' do
+    it 'should return fedora objects of the model of self that match the given solr query, queries the active_fedora solr instance' do
+      #get objects into fedora and solr
+      @test_object2 = MockAFBaseQuerySolr.new
+      @test_object2.new_object = true
+      attributes = {"holding_id"=>{0=>"Holding 1"},
+                    "language"=>{0=>"Italian"},
+                    "creator"=>{0=>"Linguist, A."},
+                    "geography"=>{0=>"Italy"},
+                    "title"=>{0=>"Italian and Spanish: A Comparison of Common Phrases"}}
+      @test_object2.update_indexed_attributes(attributes)
+      @test_object2.save
+      
+      @test_object3 = MockAFBaseQuerySolr.new
+      @test_object3.new_object = true
+      attributes = {"holding_id"=>{0=>"Holding 2"},
+                    "language"=>{0=>"Spanish;Latin"},
+                    "creator"=>{0=>"Linguist, A."},
+                    "geography"=>{0=>"Spain"},
+                    "title"=>{0=>"A study of the evolution of Spanish from Latin"}}
+      @test_object3.update_indexed_attributes(attributes)
+      @test_object3.save      
+
+      @test_object4 = MockAFBaseQuerySolr.new
+      @test_object4.new_object = true
+      attributes = {"holding_id"=>{0=>"Holding 3"},
+                    "language"=>{0=>"Spanish;Latin"},
+                    "creator"=>{0=>"Linguist, A."},
+                    "geography"=>{0=>"Spain"},
+                    "title"=>{0=>"An obscure look into early nomadic tribes of Spain"}}
+      @test_object4.update_indexed_attributes(attributes)
+      @test_object4.save
+      
+      #query based on just model
+      results = MockAFBaseQuerySolr.find_by_fields_by_solr({})
+      found_pids = []
+      results.hits.each do |hit|
+        found_pids.push(hit[SOLR_DOCUMENT_ID])
+      end
+      
+      found_pids.should == [@test_object2.pid,@test_object3.pid,@test_object4.pid]
+      
+      #query on certain fields
+      results = MockAFBaseQuerySolr.find_by_fields_by_solr({"language"=>"Latin"})
+      found_pids = []
+      results.hits.each do |hit|
+        found_pids.push(hit[SOLR_DOCUMENT_ID])
+      end
+      
+      found_pids.should == [@test_object3.pid,@test_object4.pid]
+      
+      results = MockAFBaseQuerySolr.find_by_fields_by_solr({"language"=>"Italian"})
+      found_pids = []
+      results.hits.each do |hit|
+        found_pids.push(hit[SOLR_DOCUMENT_ID])
+      end
+      
+      found_pids.should== [@test_object2.pid]
+      
+      results = MockAFBaseQuerySolr.find_by_fields_by_solr({"language"=>"Spanish"})
+      found_pids = []
+      results.hits.each do |hit|
+        found_pids.push(hit[SOLR_DOCUMENT_ID])
+      end
+      
+      found_pids.should == [@test_object3.pid,@test_object4.pid]
+      
+      #assume spaces removed at index time so query by 'Linguist,A.' instead of 'Linguist, A.'
+      results = MockAFBaseQuerySolr.find_by_fields_by_solr({"creator"=>"Linguist,A."})
+      found_pids = []
+      results.hits.each do |hit|
+        found_pids.push(hit[SOLR_DOCUMENT_ID])
+      end
+      
+      found_pids.should == [@test_object2.pid,@test_object3.pid,@test_object4.pid]
+      
+      results = MockAFBaseQuerySolr.find_by_fields_by_solr({"geography"=>"Italy"})
+      found_pids = []
+      results.hits.each do |hit|
+        found_pids.push(hit[SOLR_DOCUMENT_ID])
+      end
+      
+      found_pids.should == [@test_object2.pid]
+      
+      results = MockAFBaseQuerySolr.find_by_fields_by_solr({"creator"=>"Linguist,A.","title"=>"latin"})
+      found_pids = []
+      results.hits.each do |hit|
+        found_pids.push(hit[SOLR_DOCUMENT_ID])
+      end
+      
+      found_pids.should == [@test_object3.pid]
+      
+      #query with value with embedded ':' (pid)
+      results = MockAFBaseQuerySolr.find_by_fields_by_solr({"id"=>@test_object3.pid})
+      found_pids = []
+      results.hits.each do |hit|
+        found_pids.push(hit[SOLR_DOCUMENT_ID])
+      end
+      
+      found_pids.should == [@test_object3.pid]
+      
+      #query with different options
+      #sort defaults to system_create_date
+      results = MockAFBaseQuerySolr.find_by_fields_by_solr({"creator"=>"Linguist,A.","language"=>"Spanish"})
+      found_pids = []
+      results.hits.each do |hit|
+        found_pids.push(hit[SOLR_DOCUMENT_ID])
+      end
+      
+      found_pids.should == [@test_object3.pid,@test_object4.pid]
+      
+      #change sort direction
+      results = MockAFBaseQuerySolr.find_by_fields_by_solr({"creator"=>"Linguist,A."},{:sort=>[{"system_create"=>"desc"}]})
+      found_pids = []
+      results.hits.each do |hit|
+        found_pids.push(hit[SOLR_DOCUMENT_ID])
+      end
+      
+      found_pids.should == [@test_object4.pid,@test_object3.pid,@test_object2.pid]
+      
+      #pass in sort without direction defined and make ascending by default
+      results = MockAFBaseQuerySolr.find_by_fields_by_solr({"creator"=>"Linguist,A."},{:sort=>["system_create"]})
+      found_pids = []
+      results.hits.each do |hit|
+        found_pids.push(hit[SOLR_DOCUMENT_ID])
+      end
+      
+      found_pids.should == [@test_object2.pid,@test_object3.pid,@test_object4.pid]
+      
+      #sort on multiple fields
+      results = MockAFBaseQuerySolr.find_by_fields_by_solr({"creator"=>"Linguist,A."},{:sort=>["geography",{"system_create"=>"desc"}]})
+      found_pids = []
+      results.hits.each do |hit|
+        found_pids.push(hit[SOLR_DOCUMENT_ID])
+      end
+      
+      found_pids.should == [@test_object2.pid,@test_object4.pid,@test_object3.pid]
+      
+      #check appropriate logic for system_modified_date field name transformation
+      results = MockAFBaseQuerySolr.find_by_fields_by_solr({"creator"=>"Linguist,A."},{:sort=>["geography",{"system_mod"=>"desc"}]})
+      found_pids = []
+      results.hits.each do |hit|
+        found_pids.push(hit[SOLR_DOCUMENT_ID])
+      end
+      
+      found_pids.should == [@test_object2.pid,@test_object4.pid,@test_object3.pid]
+      
+      #check pass in rows values
+      results = MockAFBaseQuerySolr.find_by_fields_by_solr({"creator"=>"Linguist,A."},{:rows=>2})
+      found_pids = []
+      results.hits.each do |hit|
+        found_pids.push(hit[SOLR_DOCUMENT_ID])
+      end
+      
+      found_pids.should == [@test_object2.pid,@test_object3.pid]
+      
+      #check query with field mapping to solr field and with solr field that is not a field in object
+      #should be able to query by either active fedora model field name or solr key name
+      results = MockAFBaseQuerySolr.find_by_fields_by_solr({"geography_t"=>"Italy"})
+      found_pids = []
+      results.hits.each do |hit|
+        found_pids.push(hit[SOLR_DOCUMENT_ID])
+      end
+      
+      found_pids.should == [@test_object2.pid]
+    end
+  end
+end