active-fedora 8.7.0 → 9.0.0.beta1

data/lib/active_fedora/relation.rb

@@ -2,14 +2,14 @@ module ActiveFedora
   class Relation
 
     include FinderMethods, Calculations, SpawnMethods, QueryMethods, Delegation
-    
+
 
     attr_reader :loaded
     attr_accessor :default_scoped
     alias :loaded? :loaded
-    
+
     attr_accessor :values, :klass
-    
+
     def initialize(klass, values = {})
       @klass = klass
       @loaded = false
@@ -56,7 +56,7 @@ module ActiveFedora
       args[:rows] = limit_value if limit_value
       args[:start] = offset_value if offset_value
       args[:sort] = order_values if order_values
-      
+
       @records = to_enum(:find_each, where_values, args).to_a
       @loaded = true
 
@@ -75,6 +75,7 @@ module ActiveFedora
 
     def inspect
       to_a.inspect
+      # "<#{self.class} @klass=\"#{@klass}\" @values=\"#{@values.inspect}\">"
     end
 
     # Destroys the records matching +conditions+ by instantiating each
@@ -119,11 +120,22 @@ module ActiveFedora
       end
     end
 
+    # Returns a hash of where conditions.
+    #
+    #   User.where(name: 'Oscar').where_values_hash
+    #   # => {name: "Oscar"}
+    def where_values_hash
+      {}
+    end
+
+    def scope_for_create
+      @scope_for_create ||= where_values_hash.merge(create_with_value)
+    end
 
     private
 
     VALID_FIND_OPTIONS = [:order, :limit, :start, :conditions, :cast]
-    
+
     def apply_finder_options(options)
       relation = clone
       return relation unless options
@@ -139,6 +151,6 @@ module ActiveFedora
       relation = relation.where(finders[:conditions]) if options.has_key?(:conditions)
       relation
     end
-    
+
   end
 end

data/lib/active_fedora/relation/finder_methods.rb

@@ -31,7 +31,7 @@ module ActiveFedora
     # Returns an Array of objects of the Class that +find+ is being 
     # called on
     #
-    # @param[String,Hash] args either a pid or a hash of conditions
+    # @param[String,Hash] args either an id or a hash of conditions
     # @option args [Integer] :rows when :all is passed, the maximum number of rows to load from solr
     # @option args [Boolean] :cast when true, examine the model and cast it to the first known cModel
     def find(*args)
@@ -52,17 +52,37 @@ module ActiveFedora
 
       if options.present?
         options = args.first unless args.empty?
+        Deprecation.warn(ActiveFedora::Base, "Calling .find with a hash has been deprecated and will not be allowed in active-fedora 10.0. Use .where instead")
         options = {conditions: options}
         apply_finder_options(options)
       else
-        raise ArgumentError, "#{self}.find() expects a pid. You provided `#{args.inspect}'" unless args.is_a? Array
+        raise ArgumentError, "#{self}.find() expects an id. You provided `#{args.inspect}'" unless args.is_a? Array
         find_with_ids(args, cast)
       end
     end
 
-    # Returns true if object having the pid or matching the conditions exists in the repository
+    # Gives a record (or N records if a parameter is supplied) without any implied
+    # order. The order will depend on the database implementation.
+    # If an order is supplied it will be respected.
+    #
+    #   Person.take # returns an object fetched by SELECT * FROM people LIMIT 1
+    #   Person.take(5) # returns 5 objects fetched by SELECT * FROM people LIMIT 5
+    #   Person.where(["name LIKE '%?'", name]).take
+    def take(limit = nil)
+      limit ? limit(limit).to_a : find_take
+    end
+
+    def find_take
+      if loaded?
+        @records.first
+      else
+        @take ||= limit(1).to_a.first
+      end
+    end
+
+    # Returns true if object having the id or matching the conditions exists in the repository
     # Returns false if param is false (or nil) 
-    # @param[ActiveFedora::Base, String, Hash] object, pid or hash of conditions
+    # @param[ActiveFedora::Base, String, Hash] object, id or hash of conditions
     # @return[boolean]
     def exists?(conditions)
       conditions = conditions.id if Base === conditions
@@ -71,11 +91,11 @@ module ActiveFedora
       when Hash
         find_with_conditions(conditions, {rows: 1}).present?
       when String
-        !!DigitalObject.find(self.klass, conditions) 
+        !!find(conditions)
       else
         raise ArgumentError, "`conditions' argument must be ActiveFedora::Base, String, or Hash: #{conditions.inspect}"
       end
-    rescue ActiveFedora::ObjectNotFoundError 
+    rescue ActiveFedora::ObjectNotFoundError, Ldp::Gone
       false
     end
 
@@ -98,15 +118,15 @@ module ActiveFedora
     # Yields the found ActiveFedora::Base object to the passed block
     #
     # @param [Hash] conditions the conditions for the solr search to match
-    # @param [Hash] opts 
-    # @option opts [Boolean] :cast when true, examine the model and cast it to the first known cModel
+    # @param [Hash] opts
+    # @option opts [Boolean] :cast (true) when true, examine the model and cast it to the first known cModel
     def find_each( conditions={}, opts={})
       cast = opts.delete(:cast)
       find_in_batches(conditions, opts.merge({:fl=>SOLR_DOCUMENT_ID})) do |group|
         group.each do |hit|
-          begin 
+          begin
             yield(load_from_fedora(hit[SOLR_DOCUMENT_ID], cast))
-          rescue ActiveFedora::ObjectNotFoundError
+          rescue Ldp::Gone
             ActiveFedora::Base.logger.error "Although #{hit[SOLR_DOCUMENT_ID]} was found in Solr, it doesn't seem to exist in Fedora. The index is out of synch." if ActiveFedora::Base.logger
           end
         end
@@ -119,15 +139,15 @@ module ActiveFedora
     #
     # Returns a solr result matching the supplied conditions
     # @param[Hash] conditions solr conditions to match
-    # @param[Hash] options 
-    # @option opts [Array] :sort a list of fields to sort by 
+    # @param[Hash] options
+    # @option opts [Array] :sort a list of fields to sort by
     # @option opts [Array] :rows number of rows to return
     #
     # @example
     #  Person.find_in_batches('age_t'=>'21', {:batch_size=>50}) do |group|
     #  group.each { |person| puts person['name_t'] }
     #  end
-    
+
     def find_in_batches conditions, opts={}
       opts[:q] = create_query(conditions)
       opts[:qt] = @klass.solr_query_handler
@@ -144,36 +164,47 @@ module ActiveFedora
         response = ActiveFedora::SolrService.instance.conn.paginate counter, batch_size, "select", :params => opts
         docs = response["response"]["docs"]
         yield docs
-      end while docs.has_next? 
+      end while docs.has_next?
     end
 
-    # Retrieve the Fedora object with the given pid, explore the returned object, determine its model 
-    # using #{ActiveFedora::ContentModel.known_models_for} and cast to that class.
+    # Retrieve the Fedora object with the given id, explore the returned object
     # Raises a ObjectNotFoundError if the object is not found.
-    # @param [String] pid of the object to load
+    # @param [String] id of the object to load
     # @param [Boolean] cast when true, cast the found object to the class of the first known model defined in it's RELS-EXT
     #
-    # @example because the object hydra:dataset1 asserts it is a Dataset (hasModel info:fedora/afmodel:Dataset), return a Dataset object (not a Book).
-    #   Book.find_one("hydra:dataset1") 
-    def find_one(pid, cast=nil)
+    # @example because the object hydra:dataset1 asserts it is a Dataset (hasModel http://fedora.info/definitions/v4/model#Dataset), return a Dataset object (not a Book).
+    #   Book.find_one("hydra:dataset1")
+    def find_one(id, cast=nil)
       if where_values.empty?
-        load_from_fedora(pid, cast)
+        load_from_fedora(id, cast)
       else
-        conditions = where_values + [ActiveFedora::SolrService.raw_query(SOLR_DOCUMENT_ID, pid)]
+        conditions = where_values + [ActiveFedora::SolrService.raw_query(SOLR_DOCUMENT_ID, id)]
         query = conditions.join(" AND ".freeze)
         to_enum(:find_each, query, {}).to_a.first
       end
     end
-    
+
     protected
 
-    def load_from_fedora(pid, cast)
-      inner = DigitalObject.find(klass, pid)
-      obj = klass.allocate.init_with_object(inner)
-      if cast != false
-        obj = obj.adapt_to_cmodel
+    def load_from_fedora(id, cast)
+      raise ActiveFedora::ObjectNotFoundError if id.empty?
+      resource = LdpResource.new(ActiveFedora.fedora.connection, klass.id_to_uri(id))
+      raise ActiveFedora::ObjectNotFoundError if resource.new?
+      class_to_load(resource, cast).allocate.init_with_resource(resource) # Triggers the find callback
+    end
+
+    def class_to_load(resource, cast)
+      if @klass == ActiveFedora::Base && cast == false
+        ActiveFedora::Base
+      else
+        # The true class may be a subclass of @klass, so always use from_class_uri
+        Model.from_class_uri(has_model_value(resource)) || ActiveFedora::Base
       end
-      obj
+    end
+
+    # TODO just use has_model
+    def has_model_value(resource)
+      Ldp::Orm.new(resource).value(::RDF::URI.new("http://fedora.info/definitions/v4/rels-ext#hasModel")).first.to_s
     end
 
     def find_with_ids(ids, cast)
@@ -197,7 +228,6 @@ module ActiveFedora
       ids.map{|id| find_one(id, cast)}
     end
 
-
     private 
 
     # Returns a solr query for the supplied conditions
@@ -227,7 +257,7 @@ module ActiveFedora
     def condition_to_clauses(key, value)
       unless value.nil?
         # if the key is a property name, turn it into a solr field
-        if @klass.defined_attributes.key?(key)
+        if @klass.delegated_attributes.key?(key)
           # TODO Check to see if `key' is a possible solr field for this class, if it isn't try :searchable instead
           key = ActiveFedora::SolrService.solr_name(key, :stored_searchable, type: :string)
         end
@@ -235,23 +265,24 @@ module ActiveFedora
         if value.empty?
           "-#{key}:['' TO *]"
         elsif value.is_a? Array
-          value.map { |val| "#{key}:#{solr_escape(val)}" }
+          value.map { |val| "#{key}:#{RSolr.escape(val)}" }
         else
-          key = SOLR_DOCUMENT_ID if (key === :id || key === :pid)
-          "#{key}:#{solr_escape(value)}"
+          key = SOLR_DOCUMENT_ID if (key === :id || key === :id)
+          "#{key}:#{RSolr.escape(value)}"
         end
       end
     end
 
     # Return the solr clause that queries for this type of class
     def search_model_clause
+      # The concrete class could could be any subclass of @klass or @klass itself
       unless @klass == ActiveFedora::Base
-        return ActiveFedora::SolrService.construct_query_for_rel(:has_model => @klass.to_class_uri)
+        clauses = ([@klass] + @klass.descendants).map do |k|
+          ActiveFedora::SolrService.construct_query_for_rel(has_model: k.to_s)
+        end
+        clauses.size == 1 ? clauses.first : "(#{clauses.join(" OR ")})"
       end
     end
 
-    def solr_escape terms
-      RSolr.solr_escape(terms).gsub(/\s+/,"\\ ")
-    end
   end
 end

data/lib/active_fedora/relation/query_methods.rb

@@ -26,7 +26,7 @@ module ActiveFedora
     def order_values=(values)
       raise ImmutableRelation if @loaded
       @values[:order] = values
-    end   
+    end
 
     def limit_value
       @values[:limit]
@@ -35,7 +35,7 @@ module ActiveFedora
     def limit_value=(value)
       raise ImmutableRelation if @loaded
       @values[:limit] = value
-    end   
+    end
 
     def offset_value
       @values[:offset]
@@ -44,7 +44,7 @@ module ActiveFedora
     def offset_value=(value)
       raise ImmutableRelation if loaded?
       @values[:offset] = value
-    end   
+    end
 
     # Limits the returned records to those that match the provided search conditions
     #
@@ -140,5 +140,9 @@ module ActiveFedora
     def select
       to_a.select { |*block_args| yield(*block_args) }
     end
+
+    def create_with_value # :nodoc:
+      @values[:create_with] || {}
+    end
   end
 end

data/lib/active_fedora/rspec_matchers/belong_to_associated_active_fedora_object_matcher.rb

@@ -5,11 +5,11 @@ RSpec::Matchers.define :belong_to_associated_active_fedora_object do |associatio
     if @association_name.nil? || @expected_object.nil?
       raise(
         ArgumentError,
-        "subject.should belong_to_associated_active_fedora_object(<association_name>).with_object(<object>)"
+        "expect(subject).to belong_to_associated_active_fedora_object(<association_name>).with_object(<object>)"
       )
     end
 
-    @subject = subject.class.find(subject.pid)
+    @subject = subject.class.find(subject.id)
     @actual_object = @subject.send(@association_name)
 
     @expected_object == @actual_object
@@ -19,15 +19,15 @@ RSpec::Matchers.define :belong_to_associated_active_fedora_object do |associatio
 
 
   description do
-    "#{@subject.class} PID=#{@subject.pid} association: #{@association_name.inspect} matches ActiveFedora"
+    "#{@subject.class} ID=#{@subject.id} association: #{@association_name.inspect} matches ActiveFedora"
   end
 
-  failure_message_for_should do |text|
-    "expected #{@subject.class} PID=#{@subject.pid} association: #{@association_name.inspect} to match"
+  failure_message do |text|
+    "expected #{@subject.class} ID=#{@subject.id} association: #{@association_name.inspect} to match"
   end
 
-  failure_message_for_should_not do |text|
-    "expected #{@subject.class} PID=#{@subject.pid} association: #{@association_name.inspect} to NOT match"
+  failure_message_when_negated do |text|
+    "expected #{@subject.class} ID=#{@subject.id} association: #{@association_name.inspect} to NOT match"
   end
 
 end

data/lib/active_fedora/rspec_matchers/have_many_associated_active_fedora_objects_matcher.rb

@@ -6,11 +6,11 @@ RSpec::Matchers.define :have_many_associated_active_fedora_objects do |associati
     if @association_name.nil? || !@expected_objects.respond_to?(:count)
       raise(
         ArgumentError,
-        "subject.should have_many_associated_active_fedora_objects(<association_name>).with_objects(<objects[]>)"
+        "expect(subject).to have_many_associated_active_fedora_objects(<association_name>).with_objects(<objects[]>)"
       )
     end
 
-    @subject = subject.class.find(subject.pid)
+    @subject = subject.class.find(subject.id)
     @actual_objects = @subject.send(@association_name)
 
     if @expected_objects
@@ -19,7 +19,7 @@ RSpec::Matchers.define :have_many_associated_active_fedora_objects do |associati
       if actual_count != expected_count
         raise(
           RSpec::Expectations::ExpectationNotMetError,
-          "#{@subject.class} PID=#{@subject.pid} relationship: #{@association_name.inspect} count <Expected Count: #{expected_count}> <Actual: #{actual_count}>"
+          "#{@subject.class} ID=#{@subject.id} relationship: #{@association_name.inspect} count <Expected Count: #{expected_count}> <Actual: #{actual_count}>"
         )
       end
       intersection = @actual_objects & @expected_objects
@@ -31,15 +31,15 @@ RSpec::Matchers.define :have_many_associated_active_fedora_objects do |associati
 
 
   description do
-    "#{@subject.class} PID=#{@subject.pid} association: #{@association_name.inspect} matches ActiveFedora"
+    "#{@subject.class} ID=#{@subject.id} association: #{@association_name.inspect} matches ActiveFedora"
   end
 
-  failure_message_for_should do |text|
-    "expected #{@subject.class} PID=#{@subject.pid} association: #{@association_name.inspect} to match"
+  failure_message do |text|
+    "expected #{@subject.class} ID=#{@subject.id} association: #{@association_name.inspect} to match"
   end
 
-  failure_message_for_should_not do |text|
-    "expected #{@subject.class} PID=#{@subject.pid} association: #{@association_name.inspect} to NOT match"
+  failure_message_when_negated do |text|
+    "expected #{@subject.class} ID=#{@subject.id} association: #{@association_name.inspect} to NOT match"
   end
 
 end

data/lib/active_fedora/rspec_matchers/have_predicate_matcher.rb

@@ -6,10 +6,10 @@ RSpec::Matchers.define :have_predicate do |predicate|
     if @predicate.nil? || !@expected_objects.respond_to?(:count)
       raise(
         ArgumentError,
-        "subject.should have_predicate(<predicate>).with_objects(<objects[]>)"
+        "expect(subject).to have_predicate(<predicate>).with_objects(<objects[]>)"
       )
     end
-    @subject = subject.class.find(subject.pid)
+    @subject = subject.class.find(subject.id)
     @actual_objects = @subject.relationships(predicate)
 
     if @expected_objects
@@ -18,12 +18,10 @@ RSpec::Matchers.define :have_predicate do |predicate|
       if actual_count != expected_count
         raise(
           RSpec::Expectations::ExpectationNotMetError,
-          "#{@subject.class} PID=#{@subject.pid} relationship: #{@predicate.inspect} count <Expected Count: #{expected_count}> <Actual: #{actual_count}>"
+          "#{@subject.class} ID=#{@subject.id} relationship: #{@predicate.inspect} count <Expected Count: #{expected_count}> <Actual: #{actual_count}>"
         )
       end
-      intersection = @actual_objects.collect do |ao|
-        internal_uri = ao.respond_to?(:internal_uri) ? ao.internal_uri : ao
-      end & @expected_objects
+      intersection = @actual_objects & @expected_objects
 
       intersection.count == @expected_objects.count
     end
@@ -33,15 +31,15 @@ RSpec::Matchers.define :have_predicate do |predicate|
 
 
   description do
-    "#{@subject.class} PID=#{@subject.pid} relationship: #{@predicate.inspect} matches Fedora"
+    "#{@subject.class} ID=#{@subject.id} relationship: #{@predicate.inspect} matches Fedora"
   end
 
-  failure_message_for_should do |text|
-    "expected #{@subject.class} PID=#{@subject.pid} relationship: #{@predicate.inspect} to match"
+  failure_message do |text|
+    "expected #{@subject.class} ID=#{@subject.id} relationship: #{@predicate.inspect} to match"
   end
 
-  failure_message_for_should_not do |text|
-    "expected #{@subject.class} PID=#{@subject.pid} relationship: #{@predicate.inspect} to NOT match"
+  failure_message_when_negated do |text|
+    "expected #{@subject.class} ID=#{@subject.id} relationship: #{@predicate.inspect} to NOT match"
   end
 
 end

data/lib/active_fedora/simple_datastream.rb

@@ -27,15 +27,15 @@ module ActiveFedora
 
     # 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
+    #   name=(arg) 
+    #   name 
     #
     #
     # 'datatype' is a datatype, currently :string, :integer and :date are supported.
     #
     # opts is an options hash, which  will affect the generation of the xml representation of this datastream.
     #
-    # Currently supported modifiers:
+    # Currently supported modifiers: 
     # For +SimpleDatastream+:
     #   :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)
@@ -45,8 +45,8 @@ module ActiveFedora
     #
     #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.
+    #!! 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=:string, opts={})
       fields ||= {}
@@ -59,9 +59,9 @@ module ActiveFedora
         self.class.terminology.add_term(term)
         term.generate_xpath_queries!
       end
-
+      
     end
-
+    
     def update_indexed_attributes(params={}, opts={})
       raise "can't modify frozen #{self.class}" if frozen?
       # if the params are just keys, not an array, make then into an array.
@@ -75,20 +75,25 @@ module ActiveFedora
       end
       super(new_params, opts)
     end
+    
 
     def self.xml_template
-      Nokogiri::XML::Document.parse("<fields/>")
+       Nokogiri::XML::Document.parse("<fields/>")
     end
 
-    def to_solr(solr_doc = Hash.new) # :nodoc:
+    def to_solr(solr_doc = Hash.new, opts = {}) # :nodoc:
       @fields.each do |field_key, field_info|
         next if field_key == :location ## FIXME HYDRA-825
-        field_symbol = ActiveFedora::SolrService.solr_name(field_key, type: field_info[:type])
-        om_term_values(field_key).each do |val|
-          ::Solrizer::Extractor.insert_solr_field_value(solr_doc, field_symbol, val.to_s)
+        things = send(field_key)
+        if things 
+          field_symbol = ActiveFedora::SolrService.solr_name(field_key, type: field_info[:type])
+          things.val.each do |val|    
+            ::Solrizer::Extractor.insert_solr_field_value(solr_doc, field_symbol, val.to_s )         
+          end
         end
       end
-      solr_doc
+      return solr_doc
     end
+
   end
 end