active-fedora 9.0.2 → 9.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d965581bccc2e324f6336a4f7c5efb78efad4fcc
-  data.tar.gz: 72afbee2a1034a97575d0bfbfb74fed1e3d1ca14
+SHA256:
+  metadata.gz: ebf611de1fa3721bc0d53f15e6210ced8509072da4f1406f818e2f14c5f11be2
+  data.tar.gz: 1f6729e4bce4f1b03ba5ba2864c4dbe84ae454932221de98fe4357b8e80e69e4
 SHA512:
-  metadata.gz: e72f35a6d6effd301066113a82479a9924e67b6f137e97db989cef3e9d7ac48790835d074fb617f222a07d7b9641ca49aac0bba4ec6e778da23340eff3edf857
-  data.tar.gz: 0689886286c8acc0aea9f4a19b70fac85b7da7d011ecdfcf13c140ab5e5479f900063d5ca5d88e94a315a83d88d72ccdd26b268240a6615596a481542f16c89b
+  metadata.gz: f5ba1bc7bcb326f435f1ed88cad1e1a7b68c04b122472379430bf320a634e67e3da72c13c424dda5ba1f9d2673aec820a74d9b7adffb60bd9c23498f89ed7b52
+  data.tar.gz: 2e06a0593ec85862f1995277e7a530f05bff3f31e30ed80a4719c04beb8807c28060ec275fa2d833c118b83ad22fb812c5a07d848823bbfc9d90bb8693683fd9

data/History.txt

@@ -1,3 +1,88 @@
+v9.0.8
+
+  2015-04-15: Revert "Move the indexing logic to the model. Fixes #736"
+  [Justin Coyne] (cabb9057)
+
+  2015-04-15: Fix deleting from a HABTM when the inverse_of is a
+  has_many. Fixes #763 [Justin Coyne] (b1e67fb1)
+
+  2015-04-15: Remove a spec that is a duplicate of
+  integration/collection_association_spec.rb:92 [Justin Coyne]
+  (bdafd50d)
+
+  2015-04-15: Leverage the code in AssociationRelation to find the
+  inverse. Fixes #760 [Justin Coyne] (c764ea70)
+
+  2015-04-15: Make #translate_id_to_uri/uri_to_id reliable. [Trey
+  Terrell] (80a4e3fd)
+
+  2015-04-15: Find best model match in case of inheritance [Stuart
+  Kenny] (481a9cd4)
+
+  2015-04-15: Requires 'deprecation' for ActiveFedora::File [Andrew
+  Myers] (14be5cf6)
+
+  2015-04-07: The indexing hints should be inheritable [Justin Coyne]
+  (c8d41b91)
+
+v9.0.7
+  2015-04-06: Only set/save the inverse on a HABTM if the inverse is also HABTM
+  previously we were getting: [Justin Coyne]
+
+  2015-04-06: Derive a foreign_key ending with `_ids` if the inverse is a
+  collection [Justin Coyne]
+
+  2015-04-06: Find inverse relations when class_names have modules [Justin Coyne]
+
+  2015-04-06: Raise an error when the inverse relationship can not be found.
+  Previously a "SystemStackError: Stack too deep" was encountered in this
+  situation [Justin Coyne]
+
+  2015-04-02: Add a mechanism to set rdf_label on the ActiveTriple resource
+  [Justin Coyne]
+
+  2015-04-03: Refactor has_and_belongs_to_many_associations_spec [Justin Coyne]
+
+  2015-04-03: Remove unused sample classes [Justin Coyne]
+
+  2015-04-02: Sort versions as dates not as strings [Justin Coyne]
+
+  2015-04-01: Prevents an object from being loaded to the incorrect class. For
+  example, when loading a batch object it should be loaded into a Batch (and not a
+  File for example.) [Justin Coyne]
+
+  2015-03-27: Move the indexing logic to the model. Fixes #736 You should now add
+  indexing hints to has_attributes by passing a block similar to how you do it
+  with rdf properties. e.g.: [Justin Coyne]
+
+v9.0.6
+  2015-03-26: Setting type should not wipe out properties. Fixes #737 [Justin Coyne]
+
+v9.0.5
+  2015-03-25: Properties named *_id should not break the change set [Chris Colvard]
+
+  2015-03-24: Add rdf:type assertions to ActiveFedora::Base [Justin Coyne]
+
+  2015-03-24: Add documentation that differentiates attach_file from add_file [Justin Coyne]
+
+  2015-03-24: Remove #default_attributes. Fixes #732 [Chris Colvard]
+
+  2015-03-18: Make sure datastreams get configured on load as well as new/create [Michael B. Klein]
+
+  2015-03-17: Allow a has_many association to specify an explicit foreign key via the :as option [Michael B. Klein]
+
+v9.0.4
+  2015-03-10: Refactor the AF::Base initializer [Justin Coyne]
+
+  2015-03-10: Added missing id setter [Justin Coyne]
+
+v9.0.3
+  2015-03-04: Encapsulate solr_escape and make it private [Justin Coyne]
+
+  2015-03-04: Update readme [Justin Coyne]
+
+  2015-02-28: Use modified RSolr.solr_escape method [Adam Wead]
+
 v9.0.0
   2015-01-30: When save! is called only validate once [Justin Coyne]
 

data/README.md

@@ -6,12 +6,10 @@ Description
 [![Dependencies](https://gemnasium.com/projecthydra/active_fedora.png)](https://gemnasium.com/projecthydra/active\_fedora)
 [![Coverage Status](https://img.shields.io/coveralls/projecthydra/active_fedora.svg)](https://coveralls.io/r/projecthydra/active_fedora)
 
-Rubydora and ActiveFedora provide a set of Ruby gems for creating and
+ActiveFedora is a Ruby gem for creating and
 managing objects in the Fedora Repository Architecture
 ([http://fedora-commons.org](http://fedora-commons.org)). ActiveFedora
-is loosely based on “ActiveRecord” in Rails. The 3.x series of
-ActiveFedora depends on Rails 3, specifically activemodel and
-activesupport.
+is loosely based on “ActiveRecord” in Rails. Version 9.0+ works with Fedora 4 and prior versions work on Fedora 3.
 
 Getting Help
 ------------

data/active-fedora.gemspec

@@ -30,6 +30,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency "rake"
   s.add_development_dependency "jettywrapper", ">= 2.0.0"
   s.add_development_dependency "rspec", "~> 3.0"
+  s.add_development_dependency "rspec-its"
   s.add_development_dependency "equivalent-xml"
   s.add_development_dependency "simplecov", '~> 0.7.1'
 

data/lib/active_fedora.rb

@@ -51,6 +51,10 @@ module ActiveFedora #:nodoc:
     autoload :ChangeSet
     autoload :Config
     autoload :Core
+    autoload_under 'core' do
+      autoload :FedoraIdTranslator
+      autoload :FedoraUriTranslator
+    end
     autoload :Datastream
     autoload :Datastreams
     autoload :DelegatedAttribute
@@ -63,6 +67,7 @@ module ActiveFedora #:nodoc:
     autoload :FixityService
     autoload :Indexing
     autoload :IndexingService
+    autoload :InheritableAccessors
     autoload :LdpCache
     autoload :LdpResource
     autoload :LdpResourceService

data/lib/active_fedora/associations/builder/has_many.rb

@@ -2,7 +2,7 @@ module ActiveFedora::Associations::Builder
   class HasMany < CollectionAssociation #:nodoc:
     self.macro = :has_many
 
-    self.valid_options += [:dependent, :inverse_of]
+    self.valid_options += [:as, :dependent, :inverse_of]
 
     def build
       reflection = super

data/lib/active_fedora/associations/collection_association.rb

@@ -343,29 +343,12 @@ module ActiveFedora
         def find_reflection
           return reflection if @reflection.options[:predicate]
           if @reflection.class_name && @reflection.class_name != 'ActiveFedora::Base' && @reflection.macro != :has_and_belongs_to_many
-            inverse_relation = @owner.class.to_s.underscore.to_sym
-            begin
-              find_reflection_for_relation(@reflection.class_name.constantize)
-            rescue NameError
-              raise "No :predicate attribute was set or could be inferred for #{@reflection.macro} #{@reflection.name.inspect} on #{@owner.class}"
-            end
+            @reflection.inverse_of || raise("No :inverse_of or :predicate attribute was set or could be inferred for #{@reflection.macro} #{@reflection.name.inspect} on #{@owner.class}")
           else
             raise "Couldn't find reflection"
           end
         end
 
-        def find_reflection_for_relation(klass, inverse_relation=@owner.class.to_s.underscore.to_sym)
-          raise "Unable to lookup the :predicate attribute for #{@reflection.macro} #{@reflection.name.inspect} on #{@owner.class} because #{klass} specifies \"class_name: 'ActiveFedora::Base'\".  Either specify a specific class_name in #{klass} or set :predicate in the #{@reflection.macro} declaration on #{@owner.class}" if inverse_relation == :'active_fedora/base'
-          if klass.reflections.key?(inverse_relation)
-            # Try it singular
-            return klass.reflections[inverse_relation]
-          elsif klass.reflections.key?(inverse_relation.to_s.pluralize.to_sym)
-            # Try it plural
-            return klass.reflections[inverse_relation.to_s.pluralize.to_sym]
-          end
-          find_reflection_for_relation(klass, @owner.class.superclass.to_s.underscore.to_sym)
-        end
-
         def create_record(attributes, raise = false)
           attributes.update(@reflection.options[:conditions]) if @reflection.options[:conditions].is_a?(Hash)
           ensure_owner_is_not_new

data/lib/active_fedora/associations/contains_association.rb

@@ -7,7 +7,9 @@ module ActiveFedora
       end
 
       def find_target
-        reflection.build_association(target_uri)
+        reflection.build_association(target_uri).tap do |record|
+          configure_datastream(record) if reflection.options[:block]
+        end 
       end
 
       def target_uri

data/lib/active_fedora/associations/has_and_belongs_to_many_association.rb

@@ -18,13 +18,16 @@ module ActiveFedora
         owner[reflection.foreign_key] ||= []
         owner[reflection.foreign_key] += [record.id]
 
-        if @owner.new_record? and @reflection.options[:inverse_of]
-          ActiveFedora::Base.logger.warn("has_and_belongs_to_many #{@reflection.inspect} is cowardly refusing to insert the inverse relationship into #{record}, because #{@owner} is not persisted yet.") if ActiveFedora::Base.logger
-        elsif @reflection.options[:inverse_of]
-          inverse = @reflection.inverse_of
-          record[inverse.foreign_key] ||= []
-          record[inverse.foreign_key] += [owner.id]
-          record.save
+        # Only if they've explicitly stated the inverse in the options
+        if reflection.options[:inverse_of]
+          inverse = reflection.inverse_of
+          if owner.new_record?
+            ActiveFedora::Base.logger.warn("has_and_belongs_to_many #{reflection.inspect} is cowardly refusing to insert the inverse relationship into #{record}, because #{owner} is not persisted yet.") if ActiveFedora::Base.logger
+          elsif inverse.has_and_belongs_to_many?
+            record[inverse.foreign_key] ||= []
+            record[inverse.foreign_key] += [owner.id]
+            record.save
+          end
         end
 
         return true
@@ -76,9 +79,8 @@ module ActiveFedora
           records.each do |r|
             owner[reflection.foreign_key] -= [r.id]
 
-            if (@reflection.options[:inverse_of])
-              inverse = @reflection.inverse_of
-              r[inverse.foreign_key] -= [owner.id]
+            if inverse = @reflection.inverse_of
+              r[inverse.foreign_key] -= [owner.id] if inverse.has_and_belongs_to_many?
               r.association(inverse.name).reset
               r.save
             end

data/lib/active_fedora/attached_files.rb

@@ -53,7 +53,10 @@ module ActiveFedora
       end
     end
 
-    # Adds datastream to the object.
+    # Add an ActiveFedora::File to the object.
+    # @param [ActiveFedora::File] file
+    # @param [String] file_path
+    # @param [Hash] opts
     # @return [String] path of the added datastream
     def attach_file(file, file_path, opts={})
       create_singleton_association(file_path)
@@ -80,9 +83,9 @@ module ActiveFedora
       add_file(file, opts)
     end
 
-    # Attach the given file to object
+    # Attach the given stream/string to object
     #
-    # @param [File] file the file to add
+    # @param [IO, String] file the file to add
     # @param [Hash] opts options: :dsid, :prefix, :mime_type
     # @option opts [String] :path The file path
     # @option opts [String] :prefix The path prefix (for auto-generated path)

data/lib/active_fedora/change_set.rb

@@ -19,8 +19,8 @@ module ActiveFedora
 
     def changes
       @changes ||= changed_attributes.each_with_object({}) do |key, result|
-        if m = /^.*_ids?$/.match(key)
-          predicate = object.association(m[0].to_sym).reflection.predicate
+        if object.respond_to?(:association) && object.association(key.to_sym).present?
+          predicate = object.association(key.to_sym).reflection.predicate
           result[predicate] = graph.query(predicate: predicate)
         elsif object.class.properties.keys.include?(key)
           predicate = graph.reflections.reflect_on_property(key).predicate

data/lib/active_fedora/core.rb

@@ -14,14 +14,25 @@ module ActiveFedora
       # :singleton-method
       #
       # Accepts a proc that takes an id and transforms it to a URI
-      mattr_accessor :translate_id_to_uri, instance_writer: false
+      mattr_reader :translate_id_to_uri do
+        FedoraIdTranslator
+      end
+
+      def self.translate_id_to_uri=(translator)
+        @@translate_id_to_uri = translator || FedoraIdTranslator
+      end
 
       ##
       # :singleton-method
       #
       # Accepts a proc that takes a uri and transforms it to an id
-      mattr_accessor :translate_uri_to_id, instance_writer: false
+      mattr_reader :translate_uri_to_id do
+        FedoraUriTranslator
+      end
 
+      def self.translate_uri_to_id=(translator)
+        @@translate_uri_to_id = translator || FedoraUriTranslator
+      end
     end
 
     def ldp_source
@@ -33,13 +44,14 @@ module ActiveFedora
     # Also, if +attrs+ does not contain +:id+ but does contain +:namespace+ it will pass the
     # +:namespace+ value to Fedora::Repository.nextid to generate the next id available within
     # the given namespace.
-    def initialize(attributes_or_resource_or_url = nil, &block)
+    def initialize(attributes_or_id = nil, &block)
       init_internals
-      attributes = initialize_resource_and_attributes(attributes_or_resource_or_url)
+      attributes = initialize_attributes(attributes_or_id)
+      @ldp_source = build_ldp_resource(attributes.delete(:id))
       raise IllegalOperation, "Attempting to recreate existing ldp_source: `#{ldp_source.subject}'" unless ldp_source.new?
       assert_content_model
       load_attached_files
-      self.attributes = attributes if attributes
+      self.attributes = attributes
 
       yield self if block_given?
       run_callbacks :initialize
@@ -133,27 +145,14 @@ module ActiveFedora
       # Transforms an id into a uri
       # if translate_id_to_uri is set it uses that proc, otherwise just the default
       def id_to_uri(id)
-        if translate_id_to_uri
-          translate_id_to_uri.call(id)
-        else
-          id = "/#{id}" unless id.start_with? SLASH
-          unless ActiveFedora.fedora.base_path == SLASH || id.start_with?("#{ActiveFedora.fedora.base_path}/")
-            id = ActiveFedora.fedora.base_path + id 
-          end
-          ActiveFedora.fedora.host + id
-        end
+        translate_id_to_uri.call(id)
       end
 
       ##
       # Transforms a uri into an id
       # if translate_uri_to_id is set it uses that proc, otherwise just the default
       def uri_to_id(uri)
-        if translate_uri_to_id
-          translate_uri_to_id.call(uri)
-        else
-          id = uri.to_s.sub(ActiveFedora.fedora.host + ActiveFedora.fedora.base_path, '')
-          id.start_with?('/') ? id[1..-1] : id
-        end
+        translate_uri_to_id.call(uri)
       end
 
       ##
@@ -193,33 +192,22 @@ module ActiveFedora
         end
       end
 
-      def initialize_resource_and_attributes attributes_or_resource_or_url
-        case attributes_or_resource_or_url
+      def initialize_attributes attributes_or_id
+        case attributes_or_id
           when String
-            @ldp_source = build_ldp_resource(attributes_or_resource_or_url)
-            @attributes = {}.with_indifferent_access
+            attributes = {id: attributes_or_id}.with_indifferent_access
           when Hash
-            attributes = attributes_or_resource_or_url
-
-            id = attributes.delete(:id)
-
+            attributes = attributes_or_id.with_indifferent_access
             # TODO: Remove when we decide using 'pid' is no longer supported.
-            if !id && attributes.has_key?(:pid)
+            if !attributes.key?(:id) && attributes.key?(:pid)
               Deprecation.warn Core, 'Initializing with :pid is deprecated and will be removed in active-fedora 10.0. Use :id instead'
-              id = attributes.delete(:pid)
+              attributes[:id] = attributes.delete(:pid)
             end
 
-            attributes = attributes.with_indifferent_access if attributes
-            @ldp_source = if id
-              build_ldp_resource(id)
-            else
-              build_ldp_resource
-            end
           when NilClass
-            @ldp_source = build_ldp_resource
             attributes = {}.with_indifferent_access
           else
-            raise ArgumentError, "#{attributes_or_resource_or_url.class} is not acceptable"
+            raise ArgumentError, "#{attributes_or_id.class} is not acceptable"
         end
         return attributes
       end

data/lib/active_fedora/core/fedora_id_translator.rb

@@ -0,0 +1,12 @@
+module ActiveFedora::Core
+  class FedoraIdTranslator
+    SLASH = '/'.freeze
+    def self.call(id)
+      id = "/#{id}" unless id.start_with? SLASH
+      unless ActiveFedora.fedora.base_path == SLASH || id.start_with?("#{ActiveFedora.fedora.base_path}/")
+        id = ActiveFedora.fedora.base_path + id
+      end
+      ActiveFedora.fedora.host + id
+    end
+  end
+end

data/lib/active_fedora/core/fedora_uri_translator.rb

@@ -0,0 +1,9 @@
+module ActiveFedora::Core
+  class FedoraUriTranslator
+    SLASH = '/'.freeze
+    def self.call(uri)
+      id = uri.to_s.sub(ActiveFedora.fedora.host + ActiveFedora.fedora.base_path, '')
+      id.start_with?(SLASH) ? id[1..-1] : id
+    end
+  end
+end

data/lib/active_fedora/errors.rb

@@ -72,4 +72,8 @@ module ActiveFedora #:nodoc:
   # Transactions are currently incomplete
   class Rollback < ActiveFedoraError
   end
+
+  # Raised when Fedora returns a version without a create date
+  class VersionLacksCreateDate < ActiveFedoraError
+  end
 end

data/lib/active_fedora/fedora_attributes.rb

@@ -1,11 +1,12 @@
 module ActiveFedora
   module FedoraAttributes
     extend ActiveSupport::Concern
+    include InheritableAccessors
 
     included do
       include ActiveTriples::Properties
       include ActiveTriples::Reflection
-      delegate :rdf_subject, :get_values, to: :resource
+      delegate :rdf_subject, :get_values, :type, to: :resource
 
       property :has_model, predicate: ActiveFedora::RDF::Fcrepo::Model.hasModel
       property :create_date, predicate: ActiveFedora::RDF::Fcrepo4.created
@@ -18,6 +19,8 @@ module ActiveFedora
       def modified_date
         super.first
       end
+
+      define_inheritable_accessor(:type, :rdf_label)
     end
 
     # Override ActiveTriples method for setting properties
@@ -34,6 +37,12 @@ module ActiveFedora
       end
     end
 
+    def id=(id)
+      raise "ID has already been set to #{self.id}" if self.id
+      @ldp_source = build_ldp_resource(id.to_s)
+    end
+
+
     # TODO: Remove after we no longer support #pid.
     def pid
       Deprecation.warn FedoraAttributes, "#{self.class}#pid is deprecated and will be removed in active-fedora 10.0. Use #{self.class}#id instead."
@@ -56,12 +65,21 @@ module ActiveFedora
       @resource ||= self.class.resource_class.new(@ldp_source.graph.rdf_subject, @ldp_source.graph)
     end
 
+    # You can set the URI to use for the rdf_label on ClassMethods.rdf_label, then on
+    # the instance, calling rdf_label returns the value of that configured property
+    def rdf_label
+      resource.rdf_label
+    end
+
     module ClassMethods
       # We make a unique class, because properties belong to a class.
       # This keeps properties from different objects separate.
+      # Since the copy of properties can only happen once, we don't want to invoke it
+      # until all properties have been defined.
       def resource_class
         @generated_resource_class ||= begin
             klass = self.const_set(:GeneratedResourceSchema, Class.new(ActiveTriples::Resource))
+            klass.configure active_triple_options
             klass.properties.merge(self.properties).each do |property, config|
               klass.property(config.term,
                              predicate: config.predicate,
@@ -70,6 +88,12 @@ module ActiveFedora
             klass
         end
       end
+
+      private
+        # @return a Hash of options suitable for passing to ActiveTriples::Base.configure
+        def active_triple_options
+          { type: type, rdf_label: rdf_label }
+        end
     end
   end
 end