active-fedora 1.0.2 → 1.0.4

data/README.rdoc

@@ -1,3 +1,9 @@
+== Getting Help
+
+* Project Homepage: <http://yourmediashelf.com/activefedora>
+* Further documentation is available at <http://projects.mediashelf.us/show/active-fedora>
+* Community Discussions & Mailing List are located at <http://groups.google.com/group/active-fedora>
+
 = afed-regem
 
 * FIX (url)
@@ -24,17 +30,21 @@ FIX (describe your package)
 
 == LICENSE:
 
-(The MIT License)
+Copyright (c) 2009 Matt Zumwalt
+
+This program is free software: you can redistribute it and/or modify
+it under the terms of the GNU Lesser General Public License (LGPL) as 
+published by the Free Software Foundation, either version 3 of the License, 
+or (at your option) any later version.
 
-Copyright (c) 2009 FIXME full name
+This program is distributed in the hope that it will be useful,
+but WITHOUT ANY WARRANTY; without even the implied warranty of
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+GNU General Public License for more details.
 
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-'Software'), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
+You should have received a copy of the GNU Lesser General Public License
+along with this program.  If not, see <http://www.gnu.org/licenses/> or 
+see <http://www.gnu.org/licenses/lgpl.html>.
 
 The above copyright notice and this permission notice shall be
 included in all copies or substantial portions of the Software.

data/lib/active_fedora.rb

@@ -2,8 +2,12 @@ require 'rubygems'
 gem 'ruby-fedora'
 gem 'solr-ruby'
 module ActiveFedora #:nodoc:
-  VERSION='1.0.2'
+  VERSION='1.0.4'
 end
+
+SOLR_DOCUMENT_ID = "id" unless defined?(SOLR_DOCUMENT_ID)
+ENABLE_SOLR_UPDATES = true unless defined?(ENABLE_SOLR_UPDATES)
+
 require 'ruby-fedora'
 require 'active_fedora/base.rb'
 require 'active_fedora/content_model.rb'
@@ -17,3 +21,4 @@ require 'active_fedora/relationship.rb'
 require 'active_fedora/rels_ext_datastream.rb'
 require 'active_fedora/semantic_node.rb'
 require 'active_fedora/solr_service.rb'
+

data/lib/active_fedora/base.rb

@@ -1,6 +1,10 @@
 require 'util/class_level_inheritable_attributes'
 require 'active_fedora/model'
 require 'active_fedora/semantic_node'
+
+SOLR_DOCUMENT_ID = "id" unless defined?(SOLR_DOCUMENT_ID)
+ENABLE_SOLR_UPDATES = true unless defined?(ENABLE_SOLR_UPDATES)
+
 module ActiveFedora
 
   # This class ties together many of the lower-level modules, and
@@ -29,6 +33,9 @@ module ActiveFedora
     include Model
     include SemanticNode
 
+    has_relationship "collection_members", :has_collection_member
+    
+
     # Has this object been saved?
     def new_object?
       @new_object
@@ -63,21 +70,23 @@ module ActiveFedora
     #Saves a Base object, and any dirty datastreams, then updates 
     #the Solr index for this object.
     def save
+      metadata_is_dirty = false
       # If it's a new object, set the conformsTo relationship for Fedora CMA
       if new_object? 
         add_relationship(:conforms_to, ActiveFedora::ContentModel.pid_from_ruby_class(self.class))
+        metadata_is_dirty = true
       end
-      @new_object =false
+      @new_object = false
       Fedora::Repository.instance.save(@inner_object)
       datastreams_in_memory.each do |k,ds|
         if ds.dirty? || ds.new_object? 
-          if ds.kind_of?(ActiveFedora::MetadataDatastream) 
+          if ds.kind_of?(ActiveFedora::MetadataDatastream) || ds.instance_of?(ActiveFedora::RelsExtDatastream)
             metadata_is_dirty = true
           end
           ds.save
-        end
-        self.update_index if metadata_is_dirty == true 
+        end 
       end
+      self.update_index if metadata_is_dirty == true && ENABLE_SOLR_UPDATES
     end
 
     #Deletes a Base object, also deletes the info indexed in Solr, and 
@@ -85,9 +94,14 @@ module ActiveFedora
     def delete
       Fedora::Repository.instance.delete(@inner_object)
       escaped_pid = self.pid.gsub(/(:)/, '\\:')
-      SolrService.instance.conn.delete(escaped_pid)
+      SolrService.instance.conn.delete(escaped_pid) if ENABLE_SOLR_UPDATES 
     end
 
+
+    #
+    # Datastream Management
+    #
+    
     # Returns all known datastreams for the object.  If the object has been 
     # saved to fedora, the persisted datastreams will be included.
     # Datastreams that have been modified in memory are given preference over 
@@ -104,7 +118,7 @@ module ActiveFedora
     def datastreams_in_fedora #:nodoc:
       mds = {}
       self.datastreams_xml['datastream'].each do |ds|
-        ds.merge!({:pid => self.pid, :dsID => ds["dsid"]})
+        ds.merge!({:pid => self.pid, :dsID => ds["dsid"], :dsLabel => ds["label"]})
         if ds["dsid"] == "RELS-EXT" 
           mds.merge!({ds["dsid"] => ActiveFedora::RelsExtDatastream.new(ds)})
         else
@@ -125,10 +139,17 @@ module ActiveFedora
     end
 
     # Adds datastream to the object.  Saves the datastream to fedora upon adding.
-    def add_datastream(datastream)
+    # If datastream does not have a DSID, a unique DSID is generated
+    # :prefix option will set the prefix on auto-generated DSID
+    # @returns DSID of the added datastream
+    def add_datastream(datastream, opts={})
       datastream.pid = self.pid
+      if datastream.dsid == nil || datastream.dsid.empty?
+        prefix = opts.has_key?(:prefix) ? opts[:prefix] : "DS"
+        datastream.dsid = generate_dsid(prefix)
+      end
       datastreams[datastream.dsid] = datastream
-      return true
+      return datastream.dsid
     end
     def add(datastream) # :nodoc:
       warn "Warning: ActiveFedora::Base.add has been deprected.  Use add_datastream"
@@ -161,6 +182,18 @@ module ActiveFedora
       return results
     end
     
+    # return a valid dsid that is not currently in use.  Uses a prefix (default "DS") and an auto-incrementing integer
+    # Example: if there are already datastreams with IDs DS1 and DS2, this method will return DS3.  If you specify FOO as the prefix, it will return FOO1.
+    def generate_dsid(prefix="DS")
+      keys = datastreams.keys
+      next_index = keys.select {|v| v =~ /(#{prefix}\d*$)/}.count + 1
+      new_dsid = prefix.to_s + next_index.to_s
+      # while keys.include?(new_dsid)
+      #         next_index += 1
+      #         new_dsid = prefix.to_s + rand(range).to_s
+      #       end
+    end
+    
     # Return the Dublin Core (DC) Datastream. You can also get at this via 
     # the +datastreams["DC"]+.
     def dc
@@ -179,6 +212,38 @@ module ActiveFedora
       return datastreams["RELS-EXT"]
     end
 
+    #
+    # File Management
+    #
+    
+    def add_file_datastream(file, opts={})
+      label = opts.has_key?(:label) ? opts[:label] : ""
+      ds = ActiveFedora::Datastream.new(:dsLabel => label, :controlGroup => 'M', :blob => file)
+      opts.has_key?(:dsid) ? ds.dsid=(opts[:dsid]) : nil
+      add_datastream(ds)
+    end
+    
+    def file_objects
+      collection_members
+    end
+    
+    def file_objects_append(obj)
+      collection_members_append(obj)
+    end
+    
+    def collection_members_append(obj)
+      add_relationship(:has_collection_member, obj)
+    end
+
+    def collection_members_remove()
+      # will rely on SemanticNode.remove_relationship once it is implemented
+    end
+
+
+    # 
+    # Relationships Management
+    #
+    
     # @returns Hash of relationships, as defined by SemanticNode
     # Rely on rels_ext datastream to track relationships array
     # Overrides accessor for relationships array used by SemanticNode.
@@ -244,6 +309,10 @@ module ActiveFedora
     def label
       @inner_object.label
     end
+    
+    def label=(new_label)
+      @inner_object.label = new_label
+    end
 
 
     def self.deserialize(doc) #:nodoc:
@@ -254,7 +323,8 @@ module ActiveFedora
           proto.datastreams[name]=ds.class.from_xml(ds, el)
         end
       end
-      proto
+      proto.inner_object.new_object = false
+      return proto
     end
 
     #Return a hash of all available metadata fields for all 
@@ -285,9 +355,8 @@ module ActiveFedora
 
     #Return a Solr::Document version of this object.
     def to_solr(solr_doc = Solr::Document.new)
-      solr_doc << {:id => pid, :system_create_date => self.create_date, :system_modified_date => self.modified_date, :active_fedora_model_field => self.class.inspect}
+      solr_doc << {SOLR_DOCUMENT_ID.to_sym => pid, :system_create_date => self.create_date, :system_modified_date => self.modified_date, :active_fedora_model_field => self.class.inspect}
       datastreams.each_value do |ds|
-      puts "updating solr for ds #{ds}" if ds.kind_of?(ActiveFedora::Datastream)
         solr_doc = ds.to_solr(solr_doc) if ds.kind_of?(ActiveFedora::MetadataDatastream) || ds.kind_of?(ActiveFedora::RelsExtDatastream)
       end
       return solr_doc
@@ -346,7 +415,19 @@ module ActiveFedora
       end
 
     end
-
+    
+    def self.pids_from_uris(uris) 
+      if uris.class == String
+        return uris.gsub("info:fedora/", "")
+      elsif uris.class == Array
+        arr = []
+        uris.each do |uri|
+          arr << uri.gsub("info:fedora/", "")
+        end
+        return arr
+      end
+    end
+    
     private
     def configure_defined_datastreams
       if self.class.ds_specs

data/lib/active_fedora/datastream.rb

@@ -14,7 +14,7 @@ module ActiveFedora
     
     #Return the xml content representing this Datastream from Fedora
     def content
-      result = Fedora::Repository.instance.fetch_custom(self.attributes[:pid], "datastreams/#{self.dsid}")
+      result = Fedora::Repository.instance.fetch_custom(self.attributes[:pid], "datastreams/#{self.dsid}/content")
       return result
     end
   
@@ -75,6 +75,7 @@ module ActiveFedora
         tmpl.send("#{f.name}_append", f.text)
       end
       tmpl.instance_variable_set(:@dirty, false)
+      tmpl.control_group= el.attributes['CONTROL_GROUP']
       tmpl
     end
     

data/lib/active_fedora/model.rb

@@ -1,4 +1,7 @@
 require 'active_fedora/fedora_object'
+
+SOLR_DOCUMENT_ID = "id" unless defined?(SOLR_DOCUMENT_ID)
+
 module ActiveFedora
   # = ActiveFedora
   # This module mixes various methods into the including class,
@@ -56,11 +59,13 @@ module ActiveFedora
           q = "active_fedora_model_field:#{escaped_class_name}"
         elsif args.class == String
           escaped_id = args.gsub(/(:)/, '\\:')
-          q = "id:#{escaped_id}"
+          q = "#{SOLR_DOCUMENT_ID}:#{escaped_id}"
         end
         hits = SolrService.instance.conn.query(q).hits 
         results = hits.map do |hit|
           obj = Fedora::Repository.instance.find_model(hit["id"], self)
+          #obj.inner_object.new_object = false
+          #return obj
         end
         results.first
       end
@@ -87,7 +92,7 @@ module ActiveFedora
           SolrService.instance.conn.query("active_fedora_model_field:#{escaped_class_name}", args)
         elsif query.class == String
           escaped_id = query.gsub(/(:)/, '\\:')          
-          SolrService.instance.conn.query("id:#{escaped_id}", args)
+          SolrService.instance.conn.query("#{SOLR_DOCUMENT_ID}:#{escaped_id}", args)
         end
       end
 

data/lib/active_fedora/rels_ext_datastream.rb

@@ -26,6 +26,18 @@ module ActiveFedora
       EOL
     end
     
+    # Expects a RelsExtDatastream and a REXML Element as inputs.
+    def self.from_xml(tmpl, el) 
+      #puts el.elements["./foxml:datastreamVersion[last()]/foxml:xmlContent/rdf:RDF/rdf:Description/"]
+      el.elements.each("./foxml:datastreamVersion[last()]/foxml:xmlContent/rdf:RDF/rdf:Description/*") do |f|
+          #puts "Element" + f.inspect
+          r = ActiveFedora::Relationship.new(:subject=>:self, :predicate=>ActiveFedora::SemanticNode::PREDICATE_MAPPINGS.invert[f.name], :object=>f.attributes["rdf:resource"])
+          tmpl.add_relationship(r)
+      end
+      tmpl.send(:dirty=, false)
+      tmpl
+    end
+    
     def to_solr(solr_doc = Solr::Document.new)
       self.relationships.each_pair do |subject, predicates|
         if subject == :self || subject == "info:fedora/#{self.pid}"

data/lib/active_fedora/semantic_node.rb

@@ -6,8 +6,26 @@ module ActiveFedora
     attr_accessor :internal_uri, :relationships
     
     PREDICATE_MAPPINGS = Hash[:is_member_of => "isMemberOf",
+                          :has_member => "hasMember",
                           :is_part_of => "isPartOf",
                           :has_part => "hasPart",
+                          :is_member_of_collection => "isMemberOfCollection",
+                          :has_collection_member => "hasCollectionMember",
+                          :is_constituent_of => "isConstituentOf",
+                          :has_constituent => "hasConstituent",
+                          :is_subset_of => "isSubsetOf",
+                          :has_subset => "hasSubset",
+                          :is_derivation_of => "isDerivationOf",
+                          :has_derivation => "hasDerivation",
+                          :is_dependent_of => "isDependentOf",
+                          :has_dependent => "hasDependent",
+                          :is_description_of => "isDescriptionOf",
+                          :has_description => "hasDescription",
+                          :is_metadata_for => "isMetadataFor",
+                          :has_metadata => "hasMetadata",
+                          :is_annotation_of => "isAnnotationOf",
+                          :has_annotation => "hasAnnotation",
+                          :has_equivalent => "hasEquivalent",
                           :conforms_to => "conformsTo"]
     PREDICATE_MAPPINGS.freeze
     
@@ -127,39 +145,53 @@ module ActiveFedora
     
       def create_inbound_relationship_finders(name, predicate, opts = {})
         class_eval <<-END
-        def #{name}
+        def #{name}(opts={})
           escaped_uri = self.internal_uri.gsub(/(:)/, '\\:')
-          hits = SolrService.instance.conn.query("#{predicate}_field:\#{escaped_uri}").hits
-          results = []
-          hits.each do |hit|
-            classname = Kernel.const_get(hit["active_fedora_model_field"].first)
-            results << Fedora::Repository.instance.find_model(hit["id"], classname)
+          solr_result = SolrService.instance.conn.query("#{predicate}_field:\#{escaped_uri}")
+          if opts[:response_format] == :solr
+            return solr_result
+          else
+            if opts[:response_format] == :id_array
+              id_array = []
+              solr_result.hits.each do |hit|
+                id_array << hit["id"]
+              end
+              return id_array
+            else
+              return ActiveFedora::SolrService.reify_solr_results(solr_result)
+            end
           end
-          return results
         end
         def #{name}_ids
-          escaped_uri = self.internal_uri.gsub(/(:)/, '\\:')
-          SolrService.instance.conn.query("#{predicate}_field:\#{escaped_uri}")
+          #{name}(:response_format => :id_array)
         end 
         END
       end
     
       def create_outbound_relationship_finders(name, predicate, opts = {})
         class_eval <<-END
-        def #{name}
-          results = []
-          outbound_relationships[#{predicate.inspect}].each do |rel|
-            uri_as_pid = rel.gsub("info:fedora/", "")
-            results << Fedora::Repository.instance.find_model(uri_as_pid, ActiveFedora::Base)
+        def #{name}(opts={})
+          id_array = []
+          if !outbound_relationships[#{predicate.inspect}].nil? 
+            outbound_relationships[#{predicate.inspect}].each do |rel|
+              id_array << rel.gsub("info:fedora/", "")
+            end
+          end
+          if opts[:response_format] == :id_array
+            return id_array
+          else
+            query = ActiveFedora::SolrService.construct_query_for_pids(id_array)
+            solr_result = SolrService.instance.conn.query(query)
+            if opts[:response_format] == :solr
+              return solr_result
+            else
+              return ActiveFedora::SolrService.reify_solr_results(solr_result)
+            end
           end
-          return results
         end
         def #{name}_ids
-          results = []
-          outbound_relationships[#{predicate.inspect}].each do |rel|
-            results << rel
-          end
-        end 
+          #{name}(:response_format => :id_array)
+        end
         END
       end
     

data/lib/active_fedora/solr_service.rb

@@ -15,6 +15,34 @@ module ActiveFedora
       raise SolrNotInitialized unless Thread.current[:solr_service]
       Thread.current[:solr_service]
     end
+    def self.reify_solr_results(solr_result)
+      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["active_fedora_model_field"].first
+        if model_value.include?("::")
+          classname = eval(model_value)
+        else
+          classname = Kernel.const_get(model_value)
+        end
+        results << Fedora::Repository.instance.find_model(hit["id"], classname)
+      end
+      return results
+    end
+    def self.construct_query_for_pids(pid_array)
+      query = ""
+      pid_array.each_index do |i|
+        query << "#{SOLR_DOCUMENT_ID}:#{escape_uri_for_query(pid_array[i])}"
+        query << " OR " if i != pid_array.count-1
+      end
+      query = "id:NEVER_USE_THIS_ID" if query.empty? || query == "id:"
+      return query
+    end
+    def self.escape_uri_for_query(uri)
+      return uri.gsub(/(:)/, '\\:')
+    end
   end
   class SolrNotInitialized < StandardError;end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: active-fedora
 version: !ruby/object:Gem::Version 
-  version: 1.0.2
+  version: 1.0.4
 platform: ruby
 authors: 
 - MediaShelf Inc.
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-02-26 00:00:00 -06:00
+date: 2009-07-10 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,7 +20,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.0.0
+        version: 1.0.3
     version: 
 - !ruby/object:Gem::Dependency 
   name: solr-ruby
@@ -40,7 +40,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.2.3
+        version: 1.4.1
     version: 
 - !ruby/object:Gem::Dependency 
   name: rspec
@@ -105,7 +105,7 @@ files:
 - lib/active_fedora/solr_service.rb
 - solr/config/schema.xml
 has_rdoc: true
-homepage: FIX (url)
+homepage: "Project Homepage: <http://yourmediashelf.com/activefedora>"
 post_install_message: PostInstall.txt
 rdoc_options: 
 - --main
@@ -126,7 +126,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   version: 
 requirements: []
 
-rubyforge_project: active-fedora
+rubyforge_project: rubyfedora
 rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2