active-fedora 11.5.6 → 12.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 419ffa1beafe8db1f095d978f5bf68bbc6d9ca821e2f207df12de4eb82a78662
-  data.tar.gz: '018d793df4de36dd4a207ca6b70af4474d7996acf6a12ec7acac19e019e63ef0'
+SHA1:
+  metadata.gz: bedac14828094879a2772f8ab082a5ff0af2ac44
+  data.tar.gz: efd5b61d006fd8a7f2c99105d7cd11bf00b7c5b8
 SHA512:
-  metadata.gz: a5cf6e6c08b021586dbb3a282d2bb91d128a5578e947725c365a239807814f50c4d87067f6e79e68215a9c1870a48b2d41021af51ba7ed65b9778118ce003663
-  data.tar.gz: 90883925eaaf6601f24cefa301cccb40529b0034100ccf51e92a4da2fbdfa017a405289fb620c5e1352aaa177d9c37c984f5b50dd72bc66ef4ff6024fe7eeb02
+  metadata.gz: e56690ae20fd41c22ef507fc89a8c2350ac956cded3bd72d7d46ff43e181ccfe9224e3e40535ab5716b64a34efea98d87bbd7d364fa14c5b9f879cacf65be99f
+  data.tar.gz: 18ccc767a70af04dff33580ef2785483adbc3f0e51d8ae382ab65cf49db741b9cca8042c1cf7c59613aa6bcdbe4a0f91839a9a55b6d786c3b08dc74c2bd7f67c

data/.rubocop.yml

@@ -50,6 +50,8 @@ Metrics/CyclomaticComplexity:
     - 'lib/active_fedora/file.rb'
     - 'lib/active_fedora/attribute_methods.rb'
     - 'lib/active_fedora/scoping/named.rb'
+    - 'lib/active_fedora/indexing/field_mapper.rb'
+    - 'lib/active_fedora/indexing/suffix.rb'
     - 'lib/active_fedora/inheritance.rb'
 
 Metrics/PerceivedComplexity:
@@ -66,6 +68,7 @@ Metrics/PerceivedComplexity:
     - 'lib/active_fedora/associations/collection_association.rb'
     - 'lib/active_fedora/attribute_methods.rb'
     - 'lib/active_fedora/scoping/named.rb'
+    - 'lib/active_fedora/indexing/field_mapper.rb'
     - 'lib/active_fedora/inheritance.rb'
 
 Metrics/ModuleLength:
@@ -127,6 +130,7 @@ Style/PredicateName:
     - 'lib/active_fedora/association_hash.rb'
     - 'lib/active_fedora/aggregation/list_source.rb'
     - 'lib/active_fedora/associations/builder/aggregation.rb'
+    - 'lib/active_fedora/indexing/suffix.rb'
 
 Style/GuardClause:
   Exclude:

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+cache: bundler
+sudo: false
+rvm: 2.4.1
+matrix:
+  include:
+    - rvm: 2.3.4
+      env: "RAILS_VERSION=4.2.8"
+    - env: "RAILS_VERSION=5.1.1"
+global_env:
+  - NOKOGIRI_USE_SYSTEM_LIBRARIES=true
+before_install:
+  - gem update --system
+before_script:
+  - jdk_switcher use oraclejdk8

data/Gemfile

@@ -4,16 +4,14 @@ source "https://rubygems.org"
 
 gemspec path: File.expand_path('..', __FILE__)
 
-gem 'byebug' unless ENV['CI']
+gem 'byebug' unless ENV['TRAVIS']
 gem 'pry-byebug' unless ENV['CI']
 
 gem 'activemodel', ENV['RAILS_VERSION'] if ENV['RAILS_VERSION']
-gem 'rsolr', ENV['RSOLR_VERSION'] if ENV['RSOLR_VERSION']
 
 group :test do
   gem 'simplecov', require: false
   gem 'coveralls', require: false
-  gem 'rspec_junit_formatter'
 end
 
 gem 'jruby-openssl', platform: :jruby

data/README.md

@@ -1,10 +1,10 @@
 Description
 -----------
 
-[![Build Status](https://travis-ci.org/projecthydra/active_fedora.png?branch=master)](https://travis-ci.org/projecthydra/active\_fedora)
+[![Build Status](https://travis-ci.org/samvera/active_fedora.png?branch=master)](https://travis-ci.org/samvera/active\_fedora)
 [![Version](https://badge.fury.io/rb/active-fedora.png)](http://badge.fury.io/rb/active-fedora)
-[![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)
+[![Dependencies](https://gemnasium.com/samvera/active_fedora.png)](https://gemnasium.com/samvera/active\_fedora)
+[![Coverage Status](https://img.shields.io/coveralls/samvera/active_fedora.svg)](https://coveralls.io/r/samvera/active_fedora)
 
 ActiveFedora is a Ruby gem for creating and
 managing objects in the Fedora Repository Architecture
@@ -15,8 +15,8 @@ Getting Help
 ------------
 
 -   Community Discussions & Mailing List are located at
-    [http://groups.google.com/group/hydra-tech](http://groups.google.com/group/hydra-tech)
--   Developers hang out on IRC in \#projecthydra on freenet.
+    [http://groups.google.com/group/samvera-tech](http://groups.google.com/group/samvera-tech)
+-   Developers hang out on [slack.samvera.org](http://slack.samvera.org/)
 
 Installation
 ------------
@@ -30,7 +30,7 @@ gem install active-fedora
 Getting Started
 ---------------
 
-The [Dive into Hydra](https://github.com/projecthydra/hydra/wiki/Dive-into-Hydra)
+The [Dive into Hydra](https://github.com/samvera/hydra/wiki/Dive-into-Hydra)
 gives you a brief tour through ActiveFedora’s features on the command line.
 
 Generators
@@ -47,21 +47,18 @@ Testing (this Gem)
 
 In order to run the RSpec tests, you need to have a copy of the
 ActiveFedora source code, and then run bundle install in the source
-directory. Testing requires hydra-jetty, which contains version for
-Fedora and Solr. Setting up and maintaining hydra-jetty for the purposes
-of testing this gem is all accomplished via:
+directory. You can download the source code by doing the following:
 
 ```bash
-git clone https://github.com/projecthydra/active_fedora.git
-cd active_fedora   # or whatever directory your clone is in
+git clone https://github.com/samvera/active_fedora.git
+cd active_fedora
 bundle install
 ```
 
 ### Using the continuous integration server
 
 You can test ActiveFedora using the same process as our continuous
-integration server. To do that, unzip a copy of hydra-jetty first. This includes copies of Fedora and Solr which are
-used during the testing process.
+integration server. This will automatically pull down a copy of Solr and Fedora Content Repository.
 
 The `ci` rake task will download solr and fedora, start them,
 and run the tests for you.

data/active-fedora.gemspec

@@ -7,32 +7,31 @@ Gem::Specification.new do |s|
   s.version     = ActiveFedora::VERSION
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Matt Zumwalt", "McClain Looney", "Justin Coyne"]
-  s.email       = ["matt.zumwalt@yourmediashelf.com"]
+  s.email       = ["samvera-tech@googlegroups.com"]
   s.homepage    = %q{https://github.com/projecthydra/active_fedora}
   s.summary     = %q{A convenience libary for manipulating documents in the Fedora Repository.}
   s.description = %q{ActiveFedora provides for creating and managing objects in the Fedora Repository Architecture.}
-  s.license = "APACHE2"
+  s.license = "Apache-2.0"
   s.required_ruby_version = '~> 2.0'
 
   s.add_dependency 'rsolr', '>= 1.1.2', '< 3'
   s.add_dependency 'solrizer', '>= 3.4', '< 5'
-  s.add_dependency "activesupport", '>= 4.2.4', '< 5.2'
-  s.add_dependency "activemodel", '>= 4.2', '< 5.2'
+  s.add_dependency "activesupport", '>= 4.2.4', '< 6'
+  s.add_dependency "activemodel", '>= 4.2', '< 6'
   s.add_dependency "active-triples", '>= 0.11.0', '< 2.0.0'
   s.add_dependency "deprecation"
   s.add_dependency "ldp", '~> 0.7.0'
-  s.add_dependency 'rdf-vocab', '< 3.1.5'
   s.add_dependency "ruby-progressbar", '~> 1.0'
   s.add_dependency 'faraday', '~> 0.12.1'
   s.add_dependency 'faraday-encoding', '0.0.4'
 
-  s.add_development_dependency "rails", ">= 4.2"
+  s.add_development_dependency "rails"
   s.add_development_dependency "rdoc"
   s.add_development_dependency "yard"
   s.add_development_dependency "rake"
-  s.add_development_dependency "solr_wrapper", "~> 2.0"
+  s.add_development_dependency "solr_wrapper", "~> 1.0"
   s.add_development_dependency 'fcrepo_wrapper', '~> 0.2'
-  s.add_development_dependency "rspec", "~> 3.0"
+  s.add_development_dependency "rspec", "~> 3.5"
   s.add_development_dependency "rspec-its"
   s.add_development_dependency "equivalent-xml"
   s.add_development_dependency "simplecov", '~> 0.8'
@@ -47,5 +46,4 @@ Gem::Specification.new do |s|
     "README.md"
   ]
   s.require_paths = ["lib"]
-
 end

data/lib/active_fedora.rb

@@ -1,7 +1,6 @@
 require 'active_support'
 require 'active_model'
 require 'ldp'
-require 'solrizer'
 require 'active_fedora/file_configurator'
 require 'active_support/core_ext/class/attribute'
 require 'active_support/core_ext/object'
@@ -68,6 +67,7 @@ module ActiveFedora #:nodoc:
     autoload :FedoraAttributes
     autoload :File
     autoload :FileConfigurator
+    autoload :FileIO
     autoload :FilePathBuilder
     autoload :FilePersistence
     autoload :FileRelation
@@ -242,16 +242,14 @@ module ActiveFedora #:nodoc:
     end
 
     def index_field_mapper
-      Solrizer.default_field_mapper
+      @index_field_mapper ||= Indexing::FieldMapper.new
     end
 
     def id_field
       if defined?(SOLR_DOCUMENT_ID) && !SOLR_DOCUMENT_ID.nil?
         SOLR_DOCUMENT_ID
-      elsif defined?(Solrizer)
-        Solrizer.default_field_mapper.id_field
       else
-        'id'.freeze
+        ActiveFedora.index_field_mapper.id_field
       end
     end
 

data/lib/active_fedora/associations/collection_proxy.rb

@@ -41,8 +41,6 @@ module ActiveFedora
         merge! association.scope(nullify: false)
       end
 
-      delegate :each, to: :to_a
-
       def target
         @association.target
       end

data/lib/active_fedora/attributes/property_builder.rb

@@ -13,9 +13,10 @@ module ActiveFedora::Attributes
     end
 
     def self.define_writers(mixin, name)
+      # RDF Terms are singular, even if they respond to `#each`
       mixin.class_eval <<-CODE, __FILE__, __LINE__ + 1
         def #{name}=(value)
-          if value.present? && !value.respond_to?(:each)
+          unless value.nil? || (value.respond_to?(:each) && !(value.respond_to?(:term?) && value.term?))
             raise ArgumentError, "You attempted to set the property `#{name}' of \#{id} to a scalar value. However, this property is declared as being multivalued."
           end
           set_value(:#{name}, value)
@@ -43,6 +44,7 @@ module ActiveFedora::Attributes
     end
 
     def self.define_singular_writers(mixin, name)
+      # RDF Terms are singular, even if they respond to `#each`
       mixin.class_eval <<-CODE, __FILE__, __LINE__ + 1
         def #{name}=(value)
           if value.respond_to?(:each) && !(value.respond_to?(:term?) && value.term?)

data/lib/active_fedora/caching_connection.rb

@@ -10,7 +10,7 @@ module ActiveFedora
       if @cache_enabled
         cache_resource(url) { super }
       else
-        super
+        log(url) { super }
       end
     end
 

data/lib/active_fedora/errors.rb

@@ -40,6 +40,10 @@ module ActiveFedora #:nodoc:
   class AssociationNotFoundError < ConfigurationError #:nodoc:
   end
 
+  # Raised when an object is loaded from Fedora by an incompatible class
+  class ModelMismatch < ActiveFedoraError
+  end
+
   # This error is raised when trying to destroy a parent instance in N:1 or 1:1 associations
   # (has_many, has_one) when there is at least 1 child associated instance.
   # ex: if @project.tasks.size > 0, DeleteRestrictionError will be raised when trying to destroy @project

data/lib/active_fedora/fedora.rb

@@ -49,6 +49,10 @@ module ActiveFedora
       @config[:ssl]
     end
 
+    def request_options
+      @config[:request]
+    end
+
     def connection
       @connection ||= begin
         build_connection
@@ -86,6 +90,7 @@ module ActiveFedora
     def authorized_connection
       options = {}
       options[:ssl] = ssl_options if ssl_options
+      options[:request] = request_options if request_options
       Faraday.new(host, options) do |conn|
         conn.response :encoding # use Faraday::Encoding middleware
         conn.adapter Faraday.default_adapter # net/http

data/lib/active_fedora/file.rb

@@ -196,7 +196,9 @@ module ActiveFedora
       end
 
       def local_or_remote_content(ensure_fetch = true)
-        @content ||= ensure_fetch ? remote_content : @ds_content unless new_record?
+        return @content if new_record?
+
+        @content ||= ensure_fetch ? remote_content : @ds_content
         @content.rewind if behaves_like_io?(@content)
         @content
       end

data/lib/active_fedora/file/attributes.rb

@@ -49,6 +49,11 @@ module ActiveFedora::File::Attributes
     created && created.first
   end
 
+  def modified_date
+    modified = metadata.attributes["http://fedora.info/definitions/v4/repository#lastModified"]
+    modified && modified.first
+  end
+
   private
 
     # Fcrepo4.digest was used by Fedora < 4.3, but it was removed

data/lib/active_fedora/file_io.rb

@@ -0,0 +1,120 @@
+module ActiveFedora
+  ##
+  # IO like object for reading Fedora files.
+  # Use ActiveFedora::FileIO.new(fedora_file) to create one. You can then call
+  # read on it or use it with IO.copy_stream and the like.
+  #
+  # @Note The stream will always be in binmode and return ASCII-8BIT content.
+  class FileIO
+    attr_reader :pos
+
+    ##
+    # @param [ActiveFedora::File] the file which is wrapped in this IO object.
+    def initialize(fedora_file)
+      @fedora_file = fedora_file
+      @closed = false
+      rewind # this initialises various variables
+    end
+
+    def size
+      @fedora_file.size
+    end
+
+    alias length size
+
+    def binmode
+      # Do nothing, just return self. The stream is essentially always in binmode.
+      self
+    end
+
+    def binmode?
+      true
+    end
+
+    ##
+    # Read bytes from the file. See IO.read for more information.
+    # @param [Integer] the number of bytes to read. If nil or omitted, the
+    #                  entire contents will be read.
+    # @param [String] a string in which the contents are read. Can be omitted.
+    # @return [String] the read bytes. If number of bytes to read was not
+    #                  specified then always returns a String, possibly an empty
+    #                  one. If number of bytes was specified then the returned
+    #                  string will always be at least one byte long. If no bytes
+    #                  are left in the file returns nil instead.
+    def read(amount = nil, buf = nil)
+      raise(IOError, "closed stream") if @closed
+
+      buf ||= ''.force_encoding("ASCII-8BIT")
+      buf.clear
+
+      if amount.nil?
+        read_to_buf(nil, buf) # read the entire file, returns buf
+      elsif amount < 0
+        raise(ArgumentError, "negative length #{amount} given")
+      elsif amount.zero?
+        ''
+      else
+        read_to_buf(amount, buf)
+        # if amount was specified but we reached eof before reading anything
+        # then we must return nil
+        buf.empty? ? nil : buf
+      end
+    end
+
+    ##
+    # Rewinds the io object to the beginning. Read will return bytes from the
+    # start of the file again.
+    def rewind
+      raise(IOError, "closed stream") if @closed
+      @pos = 0
+      @buffer = nil
+      @stream_fiber = Fiber.new do
+        @fedora_file.stream.each do |chunk|
+          Fiber.yield chunk
+        end
+        @stream_fiber = nil
+        # last value from Fiber is the return value of the block which should be nil
+      end
+      0
+    end
+
+    ##
+    # Closes the file. No further action can be taken on the file.
+    def close
+      @closed = true
+      @stream_fiber = nil
+      nil
+    end
+
+    private
+
+      def read_to_buf(amount, buf)
+        while (amount.nil? || buf.length < amount) && fill_buffer
+          buf << consume_buffer(amount.nil? ? nil : (amount - buf.length))
+        end
+        buf
+      end
+
+      def consume_buffer(count = nil)
+        if count.nil? || count >= @buffer.length
+          @pos += @buffer.length
+          @buffer .tap do
+            @buffer = nil
+          end
+        else
+          @buffer.slice!(0, count) .tap do |slice|
+            @pos += slice.length
+          end
+        end
+      end
+
+      def fill_buffer
+        return true if @buffer.present?
+        # Ruby Net library doesn't seem to like it if we modify the returned
+        # chunk in any way, hence dup.
+        @buffer = @stream_fiber.try(:resume).try(:dup)
+        @buffer.try(:force_encoding, 'ASCII-8BIT')
+        !@buffer.nil?
+      end
+  end
+end

data/lib/active_fedora/indexing.rb

@@ -12,8 +12,13 @@ module ActiveFedora
     extend ActiveSupport::Autoload
 
     eager_autoload do
-      autoload :Map
+      autoload :DefaultDescriptors
+      autoload :Descriptor
       autoload :DescendantFetcher
+      autoload :FieldMapper
+      autoload :Inserter
+      autoload :Map
+      autoload :Suffix
     end
 
     included do

data/lib/active_fedora/indexing/default_descriptors.rb

@@ -0,0 +1,128 @@
+module ActiveFedora
+  module Indexing
+    class DefaultDescriptors
+      # The suffix produced depends on the type parameter -- produces suffixes:
+      #  _tesim - for strings or text fields
+      #  _dtsim - for dates
+      #  _isim - for integers
+      def self.stored_searchable
+        @stored_searchable ||= Descriptor.new(stored_searchable_field_definition, converter: searchable_converter, requires_type: true)
+      end
+
+      # The suffix produced depends on the type parameter -- produces suffixes:
+      #  _teim - for strings or text fields
+      #  _dtim - for dates
+      #  _iim - for integers
+      def self.searchable
+        @searchable ||= Descriptor.new(searchable_field_definition, converter: searchable_converter, requires_type: true)
+      end
+
+      # Takes fields which are stored as strings, but we want indexed as dates.  (e.g. "November 6th, 2012")
+      # produces suffixes:
+      #  _dtsim - for dates
+      def self.dateable
+        @dateable ||= Descriptor.new(:date, :stored, :indexed, :multivalued, converter: dateable_converter)
+      end
+
+      # Produces _sim suffix
+      def self.facetable
+        @facetable ||= Descriptor.new(:string, :indexed, :multivalued)
+      end
+
+      # Produces _ssim suffix
+      # This is useful for when you only want to match whole words, such as user/group names from the the rightsMetadata datastream
+      def self.symbol
+        @symbol ||= Descriptor.new(:string, :stored, :indexed, :multivalued)
+      end
+
+      # The suffix produced depends on the type parameter -- produces suffixes:
+      #  _tei - for text fields
+      #  _si - for strings
+      #  _dti - for dates
+      #  _ii - for integers
+      def self.sortable
+        @sortable ||= Descriptor.new(sortable_field_definition, converter: searchable_converter, requires_type: true)
+      end
+
+      # Fields that are both stored and sortable
+      # Produces _ssi suffix if field_type is string
+      # Produces _dtsi suffix if field_type is date
+      def self.stored_sortable
+        @stored_sortable ||= Descriptor.new(->(field_type) { [field_type, :stored, :indexed] }, converter: searchable_converter)
+      end
+
+      # Produces _ssm suffix
+      def self.displayable
+        @displayable ||= Descriptor.new(:string, :stored, :multivalued)
+      end
+
+      # Produces _tim suffix (used to be _unstem)
+      def self.unstemmed_searchable
+        @unstemmed_searchable ||= Descriptor.new(:text, :indexed, :multivalued)
+      end
+
+      def self.simple
+        @simple ||= Descriptor.new(->(field_type) { [field_type, :indexed] })
+      end
+
+      class << self
+        def searchable_field_definition
+          lambda do |type|
+            type = :text_en if [:string, :text].include?(type) # for backwards compatibility with old solr schema
+            vals = [type, :indexed, :multivalued]
+            vals
+          end
+        end
+
+        def stored_searchable_field_definition
+          lambda do |type|
+            type = :text_en if [:string, :text].include?(type) # for backwards compatibility with old solr schema
+            if type == :boolean
+              [type, :indexed, :stored]
+            else
+              [type, :indexed, :stored, :multivalued]
+            end
+          end
+        end
+
+        def sortable_field_definition
+          lambda do |type|
+            vals = [type, :indexed]
+            vals
+          end
+        end
+
+        def searchable_converter
+          lambda do |type|
+            case type
+            when :date, :time
+              ->(val) { iso8601_date(val) }
+            end
+          end
+        end
+
+        def dateable_converter
+          lambda do |_type|
+            lambda do |val|
+              begin
+                iso8601_date(Date.parse(val))
+              rescue ArgumentError
+                nil
+              end
+            end
+          end
+        end
+
+        def iso8601_date(value)
+          if value.is_a?(Date) || value.is_a?(Time)
+            DateTime.parse(value.to_s).to_time.utc.strftime('%Y-%m-%dT%H:%M:%SZ')
+          elsif !value.empty?
+            DateTime.parse(value).to_time.utc.strftime('%Y-%m-%dT%H:%M:%SZ')
+          end
+        rescue ArgumentError
+          raise ArgumentError, "Unable to parse `#{value}' as a date-time object"
+        end
+      end
+    end
+  end
+end