active-fedora 7.0.4 → 7.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e75a0408125225a3ef0ae91e7de53d0560d10a6
-  data.tar.gz: 56de97df291d2239583e16c500f99ab26df355af
+  metadata.gz: 481726bbeb31ad09149dbe0facfcc577a504f0da
+  data.tar.gz: 66f87369d95a41cb5c0d5fd02dccd43f89e589f7
 SHA512:
-  metadata.gz: 3df7b3a6fd7aab417e3c10d589e0fc06bba37cbee05400ea9d4983314cdaf191239b54ed9202a38f75ce1d1e5dbf1b03ec74b60a0ded41856ac3f68c140fdf31
-  data.tar.gz: d43e9f106e4b6f2c59eb12e36fe62c03d0e1b0040f60af2d373247aa25143499c1ce163ae39b75b3de353301a10abcc6535a01ad9e26c2085c0726dff4bd4c9e
+  metadata.gz: 82de3808e266997ca4e95144e6792877398deabddceb9cc7306ea0f7badecfe5d79a666915cb688a4fa2b5fcabc1997436b31593c39e52f7e6a204d3b48aaa77
+  data.tar.gz: f038a141b3d4136c9d5313e63137412a912f5a78632c0ca27efe235757e030e117f7d3b58d97c9544bfddb3a8e12b0b2b666a03145b1283957e8be9fffc6ae32

data/.rspec

@@ -0,0 +1 @@
+--colour

data/History.txt

@@ -1,4 +1,54 @@
-v7.0.0 Unreleased
+v7.1.0
+
+  2014-07-17: Update Om and Rubydora depencencies [Justin Coyne]
+
+  2014-07-17: Change the deprecation message so that it helps you find where the
+  problem is [Justin Coyne]
+
+  2014-06-30: Refactoring ActiveFedora::Rdf to use ActiveTriples [Tom Johnson]
+
+  2014-07-16: Make logger an accessor that can be set [Justin Coyne]
+
+  2014-07-16: Remove mediashelf-loggable [Justin Coyne]
+
+  2014-06-24: Replace ActiveFedora::Core#init_with with #init_with_object to avoid
+  a respond_to? false positive in Psych [Michael B. Klein]
+
+  2014-06-24: Have DatastreamHash delegate to a Hash instead of descending from
+  one [Michael B. Klein]
+
+  2014-06-24: Add solr_page_size as a valid option for HABTM [Justin Coyne]
+
+  2014-06-23: Refactor for style/readability [Justin Coyne]
+
+  2014-06-18: Adds :update_index option to `save' -- passing a false value will
+  prevent `update_index' from being called after the object is persisted.  The
+  `create_needs_index?' and `update_needs_index?' methods, however, will not be
+  overridden when they return false. [David Chandek-Stark]
+
+  2014-06-18: Fixed bug in ActiveFedora::FinderMethods#load_from_fedora so that it
+  casts when klass is ActiveFedora::Base and `cast' argument is nil, as intended.
+  Fixes #431 since by default it calls load_from_fedora(pid, nil) on each hit.
+  [David Chandek-Stark]
+
+  2014-06-13: Created pid instance variable so value can be retained after destroy
+  Fixes #422 [David Chandek-Stark]
+
+  2014-06-10: Added support to `exists?' finder method for a hash of conditions
+  Fixes #427 [David Chandek-Stark]
+
+  2014-06-10: Deprecate setting multiple attribute to scalar value Deprecate
+  setting unique attribute to enumerable value [David Chandek-Stark]
+
+  2014-06-10: Remove useage of RDF.Class from test code. That's not a real URI
+  [Justin Coyne]
+
+  2014-06-10: Peg rspec to ~> 2.99 [Justin Coyne]
+
+  2014-06-10: Put rspec options in a .rspec file for rspec 3 [Justin Coyne]
+
+
+v7.0.0
 
 Removed update_indexed_attributes, update_datastream_attributes, get_values_from_datastream
 

data/active-fedora.gemspec

@@ -14,27 +14,27 @@ Gem::Specification.new do |s|
   s.license = "APACHE2"
   s.required_ruby_version     = '>= 1.9.3'
 
-  s.add_dependency('rsolr', "~> 1.0.10.pre1")
-  s.add_dependency('om', '~> 3.0.0')
-  s.add_dependency('nom-xml', '>=0.5.1')
-  s.add_dependency("activesupport", '>= 3.0.0')
-  s.add_dependency("mediashelf-loggable")
-  s.add_dependency("rubydora", '~>1.7.4')
-  s.add_dependency("linkeddata")
-  s.add_dependency("rdf-rdfxml", '~>1.1.0')
-  s.add_dependency("deprecation")
-  s.add_development_dependency("rdoc")
-  s.add_development_dependency("yard")
-  s.add_development_dependency("rake")
-  s.add_development_dependency("jettywrapper", ">=1.4.0")
-  s.add_development_dependency("rspec", ">= 2.9.0")
-  s.add_development_dependency("equivalent-xml")
-  s.add_development_dependency("rest-client")
-  s.add_development_dependency("webmock")
-  s.add_development_dependency("simplecov", '~> 0.7.1')
+  s.add_dependency 'rsolr', "~> 1.0.10"
+  s.add_dependency 'om', '~> 3.1'
+  s.add_dependency 'nom-xml', '>= 0.5.1'
+  s.add_dependency "activesupport", '>= 3.0.0'
+  s.add_dependency "rubydora", '~> 1.8'
+  s.add_dependency "active-triples", '~> 0.2.2'
+  s.add_dependency "rdf-rdfxml", '~> 1.1.0'
+  s.add_dependency "deprecation"
+  s.add_development_dependency "rdoc"
+  s.add_development_dependency "yard"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "jettywrapper", ">=1.4.0"
+  s.add_development_dependency "rspec", "~> 2.99"
+  s.add_development_dependency "rspec-its"
+  s.add_development_dependency "equivalent-xml"
+  s.add_development_dependency "rest-client"
+  s.add_development_dependency "webmock"
+  s.add_development_dependency "simplecov", '~> 0.7.1'
 
   s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.test_files    = `git ls-files -- {spec}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.extra_rdoc_files = [
     "LICENSE",

data/lib/active_fedora.rb

@@ -1,4 +1,3 @@
-require "loggable"
 require 'active_support'
 require "solrizer"
 require 'active_fedora/file_configurator'
@@ -7,7 +6,7 @@ require 'active_support/core_ext/class/attribute'
 require 'active_support/core_ext/object'
 require 'active_support/core_ext/hash/indifferent_access'
 require "active_support/core_ext/hash/except"
-require 'rdf'
+require 'active_triples'
 
 SOLR_DOCUMENT_ID = Solrizer.default_field_mapper.id_field unless defined?(SOLR_DOCUMENT_ID)
 ENABLE_SOLR_UPDATES = true unless defined?(ENABLE_SOLR_UPDATES)
@@ -100,10 +99,6 @@ module ActiveFedora #:nodoc:
     end
   end
 
-
-  
-  include Loggable
-  
   class << self
     attr_reader :fedora_config, :solr_config, :config_options
     attr_accessor :configurator

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

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

data/lib/active_fedora/associations/collection_association.rb

@@ -246,7 +246,7 @@ module ActiveFedora
           begin
             targets = find_target
           rescue ObjectNotFoundError => e
-            ActiveFedora::Base.logger.error "Solr and Fedora may be out of sync:\n" + e.message
+            ActiveFedora::Base.logger.error "Solr and Fedora may be out of sync:\n" + e.message if ActiveFedora::Base.logger
             reset
           end
 

data/lib/active_fedora/associations/has_and_belongs_to_many_association.rb

@@ -19,7 +19,7 @@ module ActiveFedora
         @owner.add_relationship(@reflection.options[:property], record)
 
         if @owner.new_record? and @reflection.options[:inverse_of]
-          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.")
+          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]
           record.add_relationship(@reflection.options[:inverse_of], @owner)
           record.save

data/lib/active_fedora/attributes.rb

@@ -3,6 +3,7 @@ module ActiveFedora
     extend ActiveSupport::Concern
     extend ActiveSupport::Autoload
     include ActiveModel::Dirty
+    extend Deprecation
     
     autoload :Serializers
 
@@ -138,6 +139,13 @@ module ActiveFedora
       def create_attribute_setter(field, dsid, args)
         find_or_create_defined_attribute(field, dsid, args)
         define_method "#{field}=".to_sym do |v|
+          if self.class.multiple?(field)
+            unless v.nil? || v.respond_to?(:each)
+              Deprecation.warn(ActiveFedora::Attributes, "You attempted to set the attribute `#{field}' on `#{self.class}' to a scalar value. However, this attribute is declared as being multivalued. This behavior is deprecated and will raise an ArgumentError in active-fedora 8.0.0")
+            end
+          elsif v.respond_to?(:each) # unique
+            Deprecation.warn(ActiveFedora::Attributes, "You attempted to set the attribute `#{field}' on `#{self.class}' to an enumerable value. However, this attribute is declared as being singular. This behavior is deprecated and will raise an ArgumentError in active-fedora 8.0.0")
+          end
           self[field]=v
         end
       end

data/lib/active_fedora/base.rb

@@ -30,7 +30,6 @@ module ActiveFedora
     include Sharding
     include ActiveFedora::Persistence
     include Scoping
-    include Loggable
     include Indexing
     include ActiveModel::Conversion
     include Validations
@@ -49,4 +48,5 @@ module ActiveFedora
     include Rdf::Identifiable
   end
 
+  ActiveSupport.run_load_hooks(:active_fedora, Base)
 end

data/lib/active_fedora/callbacks.rb

@@ -236,7 +236,7 @@ module ActiveFedora
       run_callbacks(:save) { super }
     end
 
-    def create #:nodoc:
+    def create(*) #:nodoc:
       run_callbacks(:create) { super }
     end
 

data/lib/active_fedora/core.rb

@@ -3,6 +3,14 @@ module ActiveFedora
     extend ActiveSupport::Concern
     
     attr_reader :inner_object
+    included do
+      ##
+      # :singleton-method:
+      #
+      # Accepts a logger conforming to the interface of Log4r which can be
+      # retrieved on both a class and instance level by calling +logger+.
+      mattr_accessor :logger, instance_writer: false
+    end
 
     # Constructor.  You may supply a custom +:pid+, or we call the Fedora Rest API for the
     # next available Fedora pid, and mark as new object.
@@ -27,7 +35,7 @@ module ActiveFedora
       raise ActiveFedora::ObjectNotFoundError, "Can't reload an object that hasn't been saved" unless persisted?
       clear_association_cache
       clear_relationships
-      init_with(self.class.find(self.pid).inner_object)
+      init_with_object(self.class.find(self.pid).inner_object)
     end
 
     # Initialize an empty model object and set the +inner_obj+
@@ -38,9 +46,9 @@ module ActiveFedora
     #   end
     #
     #   post = Post.allocate
-    #   post.init_with(DigitalObject.find(pid))
+    #   post.init_with_object(DigitalObject.find(pid))
     #   post.properties.title # => 'hello world'
-    def init_with(inner_obj)
+    def init_with_object(inner_obj)
       @association_cache = {}
       @inner_object = inner_obj
       unless @inner_object.is_a? SolrDigitalObject
@@ -108,7 +116,7 @@ module ActiveFedora
       unless klass.ancestors.include? ActiveFedora::Base
         raise "Cannot adapt #{self.class.name} to #{klass.name}: Not a ActiveFedora::Base subclass"
       end
-      klass.allocate.init_with(inner_object)
+      klass.allocate.init_with_object(inner_object)
     end
 
     # Examines the :has_model assertions in the RELS-EXT.
@@ -147,7 +155,7 @@ module ActiveFedora
       if self.inner_object.is_a? DigitalObject
         raise "#{self.inspect} is already a full digital object"
       end
-      self.init_with DigitalObject.find(self.class,self.pid)
+      self.init_with_object DigitalObject.find(self.class,self.pid)
     end
     
     module ClassMethods

data/lib/active_fedora/datastream_attribute.rb

@@ -48,7 +48,7 @@ module ActiveFedora
           return obj.inner_object.fetch(field)
         rescue NoMethodError => e
           # couldn't get it from solr, so try from fedora.
-          logger.info "Couldn't get #{field} out of solr, because #{e.message}. Trying another way."
+          ActiveFedora::Base.logger.info "Couldn't get #{field} out of solr, because #{e.message}. Trying another way." if ActiveFedora::Base.logger
         end
       end
       # Load from fedora

data/lib/active_fedora/datastream_hash.rb

@@ -1,9 +1,14 @@
+require 'forwardable'
+
 module ActiveFedora
-  class DatastreamHash < Hash
+  class DatastreamHash
+    extend Forwardable
+
+    def_delegators :@hash, *(Hash.instance_methods(false))
     
-    def initialize (obj)
+    def initialize (obj, &block)
       @obj = obj
-      super()
+      @hash = Hash.new &block
     end
 
     def [] (key)
@@ -11,18 +16,19 @@ module ActiveFedora
         ds = Datastream.new(@obj.inner_object, key, :controlGroup=>'X')
         self[key] = ds
       end
-      super
+      @hash[key]
     end 
 
     def []= (key, val)
       @obj.inner_object.datastreams[key]=val
-      super
-    end 
+      @hash[key]=val
+    end
 
     def freeze
       each_value do |datastream|
         datastream.freeze
       end
+      @hash.freeze
       super
     end
   end

data/lib/active_fedora/fedora_attributes.rb

@@ -7,7 +7,7 @@ module ActiveFedora
     # if there is no fedora object (loaded from solr) get the instance var
     # TODO make inner_object a proxy that can hold the pid
     def pid
-       @inner_object.pid
+       @pid ||= @inner_object.pid
     end
 
     def id   ### Needed for the nested form helper

data/lib/active_fedora/file_configurator.rb

@@ -101,7 +101,7 @@ module ActiveFedora
     def load_fedora_config
       return @fedora_config unless @fedora_config.empty?
       @fedora_config_path = get_config_path(:fedora)
-      logger.info("ActiveFedora: loading fedora config from #{File.expand_path(@fedora_config_path)}")
+      ActiveFedora::Base.logger.info("ActiveFedora: loading fedora config from #{File.expand_path(@fedora_config_path)}") if ActiveFedora::Base.logger
 
       begin
         config_erb = ERB.new(IO.read(@fedora_config_path)).result(binding)
@@ -126,7 +126,7 @@ module ActiveFedora
       return @solr_config unless @solr_config.empty?
       @solr_config_path = get_config_path(:solr)
 
-      logger.info("ActiveFedora: loading solr config from #{File.expand_path(@solr_config_path)}")
+      ActiveFedora::Base.logger.info "ActiveFedora: loading solr config from #{File.expand_path(@solr_config_path)}" if ActiveFedora::Base.logger
       begin
         config_erb = ERB.new(IO.read(@solr_config_path)).result(binding)
       rescue Exception => e
@@ -191,7 +191,7 @@ module ActiveFedora
       # Last choice, check for the default config file
       config_path = File.join(ActiveFedora.root, "config", "#{config_type}.yml")
       if File.file? config_path
-        logger.warn "Using the default #{config_type}.yml that comes with active-fedora.  If you want to override this, pass the path to #{config_type}.yml to ActiveFedora - ie. ActiveFedora.init(:#{config_type}_config_path => '/path/to/#{config_type}.yml') - or set Rails.root and put #{config_type}.yml into \#{Rails.root}/config."
+        ActiveFedora::Base.logger.warn "Using the default #{config_type}.yml that comes with active-fedora.  If you want to override this, pass the path to #{config_type}.yml to ActiveFedora - ie. ActiveFedora.init(:#{config_type}_config_path => '/path/to/#{config_type}.yml') - or set Rails.root and put #{config_type}.yml into \#{Rails.root}/config." if ActiveFedora::Base.logger
         return config_path
       else
         raise ConfigurationError, "Couldn't load #{config_type} config file!"

data/lib/active_fedora/fixture_loader.rb

@@ -15,10 +15,10 @@ module ActiveFedora
         ActiveFedora::Base.find(pid, cast: true).delete
         1
       rescue ActiveFedora::ObjectNotFoundError
-        logger.debug "The object #{pid} has already been deleted (or was never created)."
+        ActiveFedora::Base.logger.debug "The object #{pid} has already been deleted (or was never created)." if ActiveFedora::Base.logger
         0
       rescue Errno::ECONNREFUSED => e
-        logger.debug "Can't connect to Fedora! Are you sure jetty is running?"
+        ActiveFedora::Base.logger.debug "Can't connect to Fedora! Are you sure jetty is running?" if ActiveFedora::Base.logger
        0
       end
     end

data/lib/active_fedora/model.rb

@@ -21,14 +21,14 @@ module ActiveFedora
       raise "model URI incorrectly formatted: #{uri}" unless model_value
 
       unless class_exists?(model_value)
-        logger.warn "#{model_value} is not a real class"
+        ActiveFedora::Base.logger.warn "#{model_value} is not a real class" if ActiveFedora::Base.logger
         return false
       end
       result = ActiveFedora.class_from_string(model_value)
       unless result.nil?
         model_ns = (result.respond_to? :pid_namespace) ? result.pid_namespace : ContentModel::CMODEL_NAMESPACE
         if model_ns != pid_ns
-          logger.warn "Model class namespace '#{model_ns}' does not match uri: '#{uri}'"
+          ActiveFedora::Base.logger.warn "Model class namespace '#{model_ns}' does not match uri: '#{uri}'" if ActiveFedora::Base.logger
         end
       end
       result

data/lib/active_fedora/om_datastream.rb

@@ -5,7 +5,7 @@ module ActiveFedora
 
     before_save do
       if content.blank?
-        logger.warn "Cowardly refusing to save a datastream with empty content: #{self.inspect}"
+        ActiveFedora::Base.logger.warn "Cowardly refusing to save a datastream with empty content: #{self.inspect}" if ActiveFedora::Base.logger
         false
       end
     end
@@ -247,7 +247,7 @@ module ActiveFedora
       current_params = params.clone
       current_params.delete_if do |term_pointer,new_values| 
         if term_pointer.kind_of?(String)
-          logger.warn "WARNING: #{dsid} ignoring {#{term_pointer.inspect} => #{new_values.inspect}} because #{term_pointer.inspect} is a String (only valid OM Term Pointers will be used).  Make sure your html has the correct field_selector tags in it."
+          ActiveFedora::Base.logger.warn "WARNING: #{dsid} ignoring {#{term_pointer.inspect} => #{new_values.inspect}} because #{term_pointer.inspect} is a String (only valid OM Term Pointers will be used).  Make sure your html has the correct field_selector tags in it." if ActiveFedora::Base.logger
           true
         else
           !self.class.terminology.has_term?(*OM.destringify(term_pointer))

data/lib/active_fedora/persistence.rb

@@ -4,7 +4,6 @@ module ActiveFedora
     extend ActiveSupport::Concern
     extend Deprecation
     self.deprecation_horizon = 'active-fedora version 8.0.0'
-    
 
     def new?
       new_record?
@@ -16,7 +15,6 @@ module ActiveFedora
       new_record?
     end
     deprecation_deprecate :new_object?
-    
 
     ## Required by associations
     def new_record?
@@ -32,15 +30,19 @@ module ActiveFedora
       @destroyed
     end
 
-    #Saves a Base object, and any dirty datastreams, then updates 
-    #the Solr index for this object.
-    def save(*)
-      # If it's a new object, set the conformsTo relationship for Fedora CMA
-      new_record? ? create : update_record
+    # Saves a Base object, and any dirty datastreams, then updates 
+    # the Solr index for this object, unless option :update_index=>false is present.
+    # Indexing is also controlled by the `create_needs_index?' and `update_needs_index?' methods.
+    #
+    # @param [Hash] options
+    # @option options [Boolean] :update_index (true) set false to skip indexing
+    # @return [Boolean] true if save was successful, otherwise false
+    def save(options={})
+      new_record? ? create(options) : update_record(options)
     end
 
-    def save!(*)
-      save
+    def save!(options={})
+      save(options)
     end
 
     # This can be overriden to assert a different model
@@ -73,10 +75,10 @@ module ActiveFedora
         end
       end
 
-      pid = self.pid ## cache so it's still available after delete
+      @pid ||= self.pid ## cache so it's still available after delete
       begin
         @inner_object.delete
-      rescue RestClient::ResourceNotFound =>e
+      rescue RestClient::ResourceNotFound => e
         raise ObjectNotFoundError, "Unable to find #{pid} in the repository"
       end
       if ENABLE_SOLR_UPDATES
@@ -128,13 +130,13 @@ module ActiveFedora
 
   protected
 
-    # Determines whether a create operation cause a solr index of this object.
-    # Override this if you need different behavior
+    # Determines whether a create operation causes a solr index of this object by default.
+    # Override this if you need different behavior.
     def create_needs_index?
       ENABLE_SOLR_UPDATES
     end
 
-    # Determines whether an update operation cause a solr index of this object.
+    # Determines whether an update operation causes a solr index of this object by default.
     # Override this if you need different behavior
     def update_needs_index?
       ENABLE_SOLR_UPDATES
@@ -143,14 +145,16 @@ module ActiveFedora
   private
     
     # Deals with preparing new object to be saved to Fedora, then pushes it and its datastreams into Fedora. 
-    def create
+    def create(options={})
       assign_pid
       assert_content_model
-      persist(create_needs_index?)
+      should_update_index = create_needs_index? && options.fetch(:update_index, true)
+      persist(should_update_index)
     end
 
-    def update_record
-      persist(update_needs_index?)
+    def update_record(options={})
+      should_update_index = update_needs_index? && options.fetch(:update_index, true)
+      persist(should_update_index)
     end
 
     # replace the unsaved digital object with a saved digital object