active-fedora 4.2.0 → 4.3.0

data/Gemfile.lock

@@ -1,13 +1,13 @@
 PATH
   remote: .
   specs:
-    active-fedora (4.2.0)
+    active-fedora (4.3.0)
       activeresource (>= 3.0.0)
       activesupport (>= 3.0.0)
       equivalent-xml
       mediashelf-loggable
       mime-types (>= 1.16)
-      multipart-post (= 1.1.2)
+      multipart-post
       nokogiri
       om (~> 1.6.0)
       rdf
@@ -31,9 +31,10 @@ GEM
       i18n (~> 0.6)
       multi_json (~> 1.0)
     addressable (2.2.8)
-    akami (1.0.0)
+    akami (1.1.0)
       gyoku (>= 0.4.0)
-    backports (2.5.3)
+      nokogiri (>= 1.5.2)
+    backports (2.6.1)
     builder (3.0.0)
     childprocess (0.3.2)
       ffi (~> 1.0.6)
@@ -46,7 +47,7 @@ GEM
     ffi (1.0.11)
     gyoku (0.4.5)
       builder (>= 2.1.2)
-    httpi (0.9.7)
+    httpi (1.0.0)
       rack
     i18n (0.6.0)
     jettywrapper (1.2.1)
@@ -65,7 +66,7 @@ GEM
       metaclass (~> 0.0.1)
     multi_json (1.3.5)
     multipart-post (1.1.2)
-    nokogiri (1.5.2)
+    nokogiri (1.5.3)
     nori (1.1.0)
     om (1.6.0)
       mediashelf-loggable
@@ -108,14 +109,14 @@ GEM
       nokogiri
       rest-client
       savon
-    savon (0.9.9)
-      akami (~> 1.0)
+    savon (0.9.14)
+      akami (~> 1.1)
       builder (>= 2.1.2)
       gyoku (>= 0.4.0)
-      httpi (~> 0.9)
+      httpi (~> 1.0)
       nokogiri (>= 1.4.0)
       nori (~> 1.1)
-      wasabi (~> 2.1)
+      wasabi (~> 2.2)
     simplecov (0.6.4)
       multi_json (~> 1.0)
       simplecov-html (~> 0.5.3)
@@ -130,7 +131,7 @@ GEM
       stomp
       xml-simple
     stomp (1.2.2)
-    wasabi (2.1.1)
+    wasabi (2.3.0)
       nokogiri (>= 1.4.0)
     xml-simple (1.1.1)
     yard (0.8.1)

data/History.txt

@@ -1,3 +1,9 @@
+4.3.0
+Added the #delegate_to method for easier delegation of multiple terms to the same datastream.
+Deprecated AF::Base#file_streams
+Deprecated AF::Base#to_xml
+HYDRA-826 Added SimpleDatastream as a replacement for MetadataDatastream
+
 4.2.0
 Added Base.find_each which allows yielding of each result
 Added Base.find_in_batches which allows yielding of a chunk of solr results

data/active-fedora.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |s|
   s.add_dependency('rsolr')
   s.add_dependency('xml-simple', '>= 1.0.12')
   s.add_dependency('mime-types', '>= 1.16')
-  s.add_dependency('multipart-post', "= 1.1.2")
+  s.add_dependency('multipart-post')
   s.add_dependency('nokogiri')
   s.add_dependency('om', '~> 1.6.0')
   s.add_dependency('solrizer', '~>1.2.0')

data/lib/active_fedora.rb

@@ -51,6 +51,7 @@ module ActiveFedora #:nodoc:
     autoload :RelsExtDatastream
     autoload :ServiceDefinitions
     autoload :SemanticNode
+    autoload :SimpleDatastream
     autoload :NestedAttributes
     autoload :FixtureLoader
     autoload :FixtureExporter

data/lib/active_fedora/base.rb

@@ -30,21 +30,16 @@ module ActiveFedora
     self.profile_solr_name = ActiveFedora::SolrService.solr_name("object_profile", :string, :displayable)
 
     def method_missing(name, *args)
-      # if [:collection_members, :part_of, :parts, :part_of_append, :file_objects].include? name 
-      #   ActiveSupport::Deprecation.warn("Deprecation: FileManagement will not be included by default in the next version.   To use #{name} add 'include ActiveFedora::FileManagement' to your model")
-      #   self.class.send :include, FileManagement
-      #   send name, *args
-      # else 
-        dsid = corresponding_datastream_name(name)
-        if dsid
-          ### Create and invoke a proxy method 
-          self.class.send :define_method, name do
-              datastreams[dsid]
-          end
-          self.send(name)
-        else 
-          super
+      dsid = corresponding_datastream_name(name)
+      if dsid
+        ### Create and invoke a proxy method 
+        self.class.send :define_method, name do
+            datastreams[dsid]
         end
+        self.send(name)
+      else 
+        super
+      end
     end
 
 
@@ -54,7 +49,7 @@ module ActiveFedora
     end
     
     def new_object=(bool)
-      ActiveSupport::Deprecation.warn("ActiveFedora::Base.new_object= has been deprecated and nolonger has any effect")
+      ActiveSupport::Deprecation.warn("ActiveFedora::Base.new_object= has been deprecated and nolonger has any effect. Will be removed in 5.0")
     end
 
     ## Required by associations
@@ -263,13 +258,14 @@ module ActiveFedora
     # TODO this can likely be removed once find_by_fields_by_solr is removed
       fields = {:id => {:values => [pid]}, :system_create_date => {:values => [self.create_date], :type=>:date}, :system_modified_date => {:values => [self.modified_date], :type=>:date}, :active_fedora_model => {:values => [self.class.inspect], :type=>:symbol}}
       datastreams.values.each do |ds|        
-        fields.merge!(ds.fields) if [ActiveFedora::MetadataDatastream, ActiveFedora::QualifiedDublinCoreDatastream].include?(ds.class)
+        fields.merge!(ds.fields) if [ActiveFedora::MetadataDatastream, ActiveFedora::SimpleDatastream, ActiveFedora::QualifiedDublinCoreDatastream].include?(ds.class)
       end
       return fields
     end
     
     #Returns the xml version of this object as a string.
     def to_xml(xml=Nokogiri::XML::Document.parse("<xml><fields/><content/></xml>"))
+      ActiveSupport::Deprecation.warn("ActiveFedora::Base#to_xml has been deprecated and will be removed in version 5.0")
       fields_xml = xml.xpath('//fields').first
       builder = Nokogiri::XML::Builder.with(fields_xml) do |fields_xml|
         fields_xml.id_ pid
@@ -278,12 +274,6 @@ module ActiveFedora
         fields_xml.active_fedora_model self.class.inspect
       end
       
-      # {:id => pid, :system_create_date => self.create_date, :system_modified_date => self.modified_date, :active_fedora_model => self.class.inspect}.each_pair do |attribute_name, value|
-      #   el = REXML::Element.new(attribute_name.to_s)
-      #   el.text = value
-      #   fields_xml << el
-      # end
-      
       datastreams.each_value do |ds|  
         ds.to_xml(fields_xml) if ds.class.included_modules.include?(ActiveFedora::MetadataDatastreamHelper)
         ds.to_rels_ext if ds.kind_of?(ActiveFedora::RelsExtDatastream)
@@ -317,7 +307,6 @@ module ActiveFedora
       end
       datastreams.each_value do |ds|
         ds.ensure_xml_loaded if ds.respond_to? :ensure_xml_loaded  ### Can't put this in the model because it's often implemented in Solrizer::XML::TerminologyBasedSolrizer 
-        #puts "\n\nQDC #{ds.to_solr(solr_doc).inspect}" if ds.kind_of?(ActiveFedora::QualifiedDublinCoreDatastream)
         solr_doc = ds.to_solr(solr_doc) if ds.kind_of?(ActiveFedora::RDFDatastream) || ds.kind_of?(ActiveFedora::NokogiriDatastream) || ds.kind_of?(ActiveFedora::MetadataDatastream)
       end
       solr_doc = solrize_relationships(solr_doc) unless opts[:model_only]

data/lib/active_fedora/datastreams.rb

@@ -113,7 +113,7 @@ module ActiveFedora
     end
 
     def add(datastream) # :nodoc:
-      warn "Warning: ActiveFedora::Base.add has been deprecated.  Use add_datastream"
+      ActiveSupport::Deprecation.warn "Warning: ActiveFedora::Base.add has been deprecatedand will be removed in 5.0.  Use add_datastream"
       add_datastream(datastream)
     end
     
@@ -130,10 +130,12 @@ module ActiveFedora
     
     #return all datastreams not of type ActiveFedora::MetadataDatastream 
     #(that aren't Dublin Core or RELS-EXT streams either)
+    #@deprecated
     def file_streams
+      ActiveSupport::Deprecation.warn("ActiveFedora::Base#file_streams has been deprecated and will be removed in 5.0")
       results = []
       datastreams.each_value do |ds|
-        if !ds.kind_of?(ActiveFedora::MetadataDatastream) 
+        if !ds.kind_of?(ActiveFedora::MetadataDatastream) && !ds.kind_of?(ActiveFedora::NokogiriDatastream)
           dsid = ds.dsid
           if dsid != "DC" && dsid != "RELS-EXT"
             results << ds

data/lib/active_fedora/delegating.rb

@@ -1,18 +1,18 @@
 module ActiveFedora
   module Delegating
     extend ActiveSupport::Concern
-    
+
     module ClassMethods
       # Provides a delegate class method to expose methods in metadata streams
-      # as member of the base object. Pass the target datastream via the 
-      # <tt>:to</tt> argument. If you want to return a unique result, (e.g. string 
+      # as member of the base object. Pass the target datastream via the
+      # <tt>:to</tt> argument. If you want to return a unique result, (e.g. string
       # instead of an array) set the <tt>:unique</tt> argument to true.
       #
       # The optional <tt>:at</tt> argument provides a terminology that the delegate will point to.
-      #   
+      #
       #   class Foo < ActiveFedora::Base
-      #     has_metadata :name => "descMetadata", :type => MyDatastream 
-      #     
+      #     has_metadata :name => "descMetadata", :type => MyDatastream
+      #
       #     delegate :field1, :to=>"descMetadata", :unique=>true
       #     delegate :field2, :to=>"descMetadata", :at=>[:term1, :term2]
       #   end
@@ -26,27 +26,54 @@ module ActiveFedora
         create_delegate_accessor(field, args)
         create_delegate_setter(field, args)
       end
-      
+
+
+      # Allows you to delegate multiple terminologies to the same datastream, instead
+      # having to call the method each time for each term.  The target datastream is the
+      # first argument, followed by an array of the terms that will point to that
+      # datastream.  Terms must be a single value, ie. :field and not [:term1, :term2].
+      # This is best accomplished by refining your OM terminology using :ref or :proxy
+      # methods to reduce nested terms down to one.
+      #
+      #   class Foo < ActiveFedora::Base
+      #     has_metadata :name => "descMetadata", :type => MyDatastream
+      #
+      #     delegate_to :descMetadata, [:field1, :field2]
+      #   end
+      #
+      #   foo = Foo.new
+      #   foo.field1 = "My Value"
+      #   foo.field1                 # => "My Value"
+      #   foo.field2                 # => NoMethodError: undefined method `field2' for #<Foo:0x1af30c>
+
+      def delegate_to(datastream,fields,args={})
+        fields.each do |f|
+          args.merge!({:to=>datastream})
+          create_delegate_accessor(f, args)
+          create_delegate_setter(f, args)
+        end
+      end
+
       private
       def create_delegate_accessor(field, args)
         define_method field do
           ds = self.send(args[:to])
           val = if ds.kind_of?(ActiveFedora::MetadataDatastream) || ds.kind_of?(ActiveFedora::RDFDatastream)
                   ds.send(:get_values, field)
-                else 
+                else
                   terminology = args[:at] || [field]
                   ds.send(:term_values, *terminology)
                 end
           args[:unique] ? val.first : val
         end
       end
-      
+
       def create_delegate_setter(field, args)
         define_method "#{field}=".to_sym do |v|
           ds = self.send(args[:to])
           if ds.kind_of?(ActiveFedora::MetadataDatastream) || ds.kind_of?(ActiveFedora::RDFDatastream)
             ds.send(:set_value, field, v)
-          else 
+          else
             terminology = args[:at] || [field]
             ds.send(:update_indexed_attributes, {terminology => v})
           end

data/lib/active_fedora/model.rb

@@ -97,7 +97,7 @@ module ActiveFedora
       # Returns an Array of objects of the Class that +find+ is being 
       # called on
       #
-      # @param[String,Symbol, Hash] either a pid or :all or a hash of conditions
+      # @param[String,Symbol,Hash] args either a pid or :all or a hash of conditions
       # @param [Hash] opts the options to create a message with.
       # @option opts [Integer] :rows when :all is passed, the maximum number of rows to load from solr
       # @option opts [Boolean] :cast when true, examine the model and cast it to the first known cModel

data/lib/active_fedora/simple_datastream.rb

@@ -0,0 +1,92 @@
+module ActiveFedora
+  #This class represents a simple xml datastream. 
+  class SimpleDatastream < NokogiriDatastream
+
+    class_attribute :class_fields
+    self.class_fields = []
+    attr_accessor :fields # TODO this can be removed when Model.find_by_fields_by_solr has been removed.
+    
+    
+     set_terminology do |t|
+       t.root(:path=>"fields", :xmlns=>nil)
+     end
+
+    define_template :creator do |xml,name|
+      xml.creator() do
+        xml.text(name)
+      end
+    end
+    
+
+    # This method generates the various accessor and mutator methods on self for the datastream metadata attributes.
+    # each field will have the 2 magic methods:
+    #   name=(arg) 
+    #   name 
+    #
+    #
+    # 'datatype' is a datatype, currently :string, :text and :date are supported.
+    #
+    # opts is an options hash, which  will affect the generation of the xml representation of this datastream.
+    #
+    # Currently supported modifiers: 
+    # For +QualifiedDublinCorDatastreams+:
+    #   :element_attrs =>{:foo=>:bar} -  hash of xml element attributes
+    #   :xml_node => :nodename  - The xml node to be used to represent this object (in dcterms namespace)
+    #   :encoding=>foo, or encodings_scheme  - causes an xsi:type attribute to be set to 'foo'
+    #   :multiple=>true -  mark this field as a multivalue field (on by default)
+    #
+    #At some point, these modifiers will be ported up to work for any +ActiveFedora::MetadataDatastream+.
+    #
+    #There is quite a good example of this class in use in spec/examples/oral_history.rb
+    #
+    #!! Careful: If you declare two fields that correspond to the same xml node without any qualifiers to differentiate them, 
+    #you will end up replicating the values in the underlying datastream, resulting in mysterious dubling, quadrupling, etc. 
+    #whenever you edit the field's values.
+    def field(name, datatype=nil, opts={})
+      fields ||= {}
+      @fields[name.to_s.to_sym]={:type=>datatype, :values=>[]}.merge(opts)
+      # add term to template
+      self.class.class_fields << name.to_s
+      # add term to terminology
+      unless self.class.terminology.has_term?(name.to_sym)
+        term = OM::XML::Term.new(name.to_sym, {}, self.class.terminology)
+        self.class.terminology.add_term(term)
+        term.generate_xpath_queries!
+      end
+      
+    end
+    
+    def update_indexed_attributes(params={}, opts={})
+      # if the params are just keys, not an array, make then into an array.
+      new_params = {}
+      params.each do |key, val|
+        if key.is_a? Array
+          new_params[key] = val
+        else
+          new_params[[key.to_sym]] = val
+        end
+      end
+      super(new_params, opts)
+    end
+    
+
+    def self.xml_template
+       Nokogiri::XML::Document.parse("<fields/>")
+    end
+
+    def to_solr(solr_doc = Hash.new) # :nodoc:
+      @fields.each do |field_key, field_info|
+        next if field_key == :location ## FIXME HYDRA-825
+        things = send(field_key)
+        if things 
+          field_symbol = ActiveFedora::SolrService.solr_name(field_key, field_info[:type])
+          things.val.each do |val|    
+            ::Solrizer::Extractor.insert_solr_field_value(solr_doc, field_symbol, val )         
+          end
+        end
+      end
+      return solr_doc
+    end
+
+  end
+end

data/lib/active_fedora/version.rb

@@ -1,3 +1,3 @@
 module ActiveFedora
-    VERSION = "4.2.0"
+  VERSION = "4.3.0"
 end

data/spec/integration/base_find_by_fields_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 class MockAFBaseQuerySolr < ActiveFedora::Base
-  has_metadata :name => "properties", :type => ActiveFedora::MetadataDatastream do |m|
+  has_metadata :name => "properties", :type => ActiveFedora::SimpleDatastream do |m|
     m.field "holding_id", :string
   end
   

data/spec/integration/base_spec.rb

@@ -136,7 +136,7 @@ describe ActiveFedora::Base do
       has_relationship "testing_inbound", :has_part, :type=>MockAFBaseFromSolr, :inbound=>true
       has_relationship "testing_inbound2", :has_member, :type=>MockAFBaseFromSolr, :inbound=>true
       
-      has_metadata :name => "properties", :type => ActiveFedora::MetadataDatastream do |m|
+      has_metadata :name => "properties", :type => ActiveFedora::SimpleDatastream do |m|
         m.field "holding_id", :string
       end
       
@@ -266,8 +266,8 @@ describe ActiveFedora::Base do
   end
   
   describe ".metadata_streams" do
-    it "should return all of the datastreams from the object that are kinds of MetadataDatastreams " do
-      mds1 = ActiveFedora::MetadataDatastream.new(@test_object.inner_object, "md1")
+    it "should return all of the datastreams from the object that are kinds of NokogiriDatastream " do
+      mds1 = ActiveFedora::SimpleDatastream.new(@test_object.inner_object, "md1")
       mds2 = ActiveFedora::QualifiedDublinCoreDatastream.new(@test_object.inner_object, "qdc")
       fds = ActiveFedora::Datastream.new(@test_object.inner_object, "fds")
       @test_object.add_datastream(mds1)
@@ -282,10 +282,10 @@ describe ActiveFedora::Base do
   end
   
   describe ".file_streams" do
-    it "should return all of the datastreams from the object that are kinds of MetadataDatastreams" do
+    it "should return all of the datastreams from the object that are kinds of NokogiriDatastream" do
       fds1 = ActiveFedora::Datastream.new(@test_object.inner_object, "fds1")
       fds2 = ActiveFedora::Datastream.new(@test_object.inner_object, "fds2")
-      mds = ActiveFedora::MetadataDatastream.new(@test_object.inner_object, "mds")
+      mds = ActiveFedora::SimpleDatastream.new(@test_object.inner_object, "mds")
       @test_object.add_datastream(fds1)  
       @test_object.add_datastream(fds2)
       @test_object.add_datastream(mds)    

data/spec/integration/bug_spec.rb

@@ -11,11 +11,11 @@ include Mocha::API
 describe 'bugs' do
   before :all do
     class FooHistory < ActiveFedora::Base
-      has_metadata :type=>ActiveFedora::MetadataDatastream, :name=>"someData" do |m|
+      has_metadata :type=>ActiveFedora::SimpleDatastream, :name=>"someData" do |m|
         m.field "fubar", :string
         m.field "swank", :text
       end
-      has_metadata :type=>ActiveFedora::MetadataDatastream, :name=>"withText" do |m|
+      has_metadata :type=>ActiveFedora::SimpleDatastream, :name=>"withText" do |m|
         m.field "fubar", :text
       end
     end
@@ -33,22 +33,22 @@ describe 'bugs' do
   end
   it "should not clobber everything when setting a value" do
     ds = @test_object.datastreams["someData"]
-    ds.fubar_values.should == []
+    ds.fubar.should == []
     ds.should_not be_nil
-    ds.fubar_values=['bar']
-    ds.fubar_values.should == ['bar']
+    ds.fubar=['bar']
+    ds.fubar.should == ['bar']
     @test_object.save
 
     @test_object.pid.should_not be_nil
 
     x = FooHistory.find(@test_object.pid)
     ds2 = x.datastreams["someData"]
-    ds2.fubar_values.should == ['bar']
-    ds2.fubar_values = ["meh"]
-    ds2.fubar_values.should == ["meh"]
+    ds2.fubar.should == ['bar']
+    ds2.fubar = ["meh"]
+    ds2.fubar.should == ["meh"]
     x.save
     x = FooHistory.find(@test_object.pid)
-    x.datastreams['someData'].fubar_values.should == ["meh"]
+    x.datastreams['someData'].fubar.should == ["meh"]
     x.save
   end
 end