active-fedora 8.7.0 → 9.0.0.beta1

data/spec/integration/with_metadata_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe ActiveFedora::WithMetadata do
+  before do
+    class Sample < ActiveFedora::Base
+      contains :file, class_name: 'SampleFile'
+    end
+
+    class SampleFile < ActiveFedora::File
+      include ActiveFedora::WithMetadata
+
+      metadata do
+        property :title, predicate: ::RDF::DC.title
+      end
+    end
+  end
+
+  after do
+    Object.send(:remove_const, :SampleFile)
+    Object.send(:remove_const, :Sample)
+  end
+
+  let(:base) { Sample.new }
+  let(:file) { base.file }
+
+  describe "properties" do
+    before do
+      file.title = ['one', 'two']
+    end
+    it "should set and retrieve properties" do
+      expect(file.title).to eq ['one', 'two']
+    end
+
+    it "should track changes" do
+      expect(file.title_changed?).to be true
+    end
+  end
+
+  describe "#save" do
+    before do
+      file.content = "Hey"
+      file.title = ["foo"]
+      base.save
+      base.reload
+    end
+
+    it "should save the metadata too" do
+      expect(base.file.title).to eq ['foo']
+    end
+  end
+
+end

data/spec/samples/hydra-mods_article_datastream.rb

@@ -1,6 +1,6 @@
 require "active-fedora"
 module Hydra
-  
+
   # This is an example of a OmDatastream that defines an OM terminology for MODS xml
   # It focuses on the aspects of MODS that deal with descriptive metadata for published articles
   # This is not the hydra-head plugin version of this OM Terminology; See https://github.com/projecthydra/hydra-head/blob/master/lib/hydra/mods_article.rb
@@ -11,14 +11,14 @@ module Hydra
   # * Defines a term lang_code that maps to "languageTerm[@type=code]"
   # * Defines a variety of terms, date, last_name, first_name & terms_of_address, that all map to mods:namePart but use varying attributes to distinguish themselves
   # * Uses proxy terms to define familar terms like start_page and end_page that map to non-intuitive xml structures "extent[@unit=pages]/start" and "extent[@unit=pages]/end"
-  # * Uses proxy terms, publication_url, peer_reviewed, and title, to allow convenient access to frequently used terms 
+  # * Uses proxy terms, publication_url, peer_reviewed, and title, to allow convenient access to frequently used terms
   #
   # Things to note about the additional methods it defines:
-  # 
+  #
   # * Defines a series of templates, person_template, organization_template, etc. for generating a whole set of xml nodes to insert into the document (note: the new OM::TemplateRegistry provides an even better way to do this)
   # * Defines a custom method, insert_contributor, that uses the Terminology to manipulate xml documents in specialized ways
   # * Defines a series of relator_term Hashes that can then be used when generating views, etc.  In this case, the Hashes are hard-coded into the Class.  Ideally, they might be read from a configuration file or mixed into the class using a module
-  class ModsArticleDatastream < ActiveFedora::OmDatastream       
+  class ModsArticleDatastream < ActiveFedora::OmDatastream
 
     set_terminology do |t|
       t.root(:path=>"mods", :xmlns=>"http://www.loc.gov/mods/v3", :schema=>"http://www.loc.gov/standards/mods/v3/mods-3-2.xsd")
@@ -153,6 +153,10 @@ module Hydra
       end
       return builder.doc
     end
+
+    def prefix(name)
+      "#{name.underscore}__"
+    end
     
     # Generates a new Person node
     def self.person_template
@@ -505,8 +509,8 @@ module Hydra
         ["data", "supporting file", "profile", "lorem ipsum", "dolor"]
       end
 
-    def to_solr(solr_doc=Hash.new)
-      solr_doc = super(solr_doc)
+    def to_solr(solr_doc=Hash.new, opts={})
+      solr_doc = super
             
       ::Solrizer::Extractor.insert_solr_field_value(solr_doc, Solrizer.default_field_mapper.solr_name('object_type', :facetable), "Article")
       ::Solrizer::Extractor.insert_solr_field_value(solr_doc, Solrizer.default_field_mapper.solr_name('mods_journal_title_info', :facetable), "Unknown") if solr_doc["mods_journal_title_info_facet"].nil? 

data/spec/samples/models/mods_article.rb

@@ -6,9 +6,13 @@ require_relative '../hydra-rights_metadata_datastream.rb'
 #
 # See lib/samples/sample_thing.rb for a fuller, annotated example of an ActiveFedora Model
 class ModsArticle < ActiveFedora::Base
-  
-  has_metadata :name => "descMetadata", :type=> Hydra::ModsArticleDatastream  
+
+  # Mute deprecation of has_metadata
+  @original_behavior = Deprecation.default_deprecation_behavior
+  Deprecation.default_deprecation_behavior = :silence
+  has_metadata :name => "descMetadata", :type=> Hydra::ModsArticleDatastream
   has_metadata :name => "rightsMetadata", :type => Hydra::RightsMetadataDatastream
   has_metadata :name => "properties", :type => ActiveFedora::SimpleDatastream
+  Deprecation.default_deprecation_behavior = @original_behavior
 
 end

data/spec/samples/oral_history_sample.xml

@@ -9,7 +9,7 @@
 		<rights>rights</rights>
 		<publisher>publisher</publisher>
 		<creation_date>creation date</creation_date>
-		<identifier>jwa:sample_pid</identifier>
+		<identifier>jwa:sample_id</identifier>
 		<format>format</format>
 		<extent>extent</extent>
 		<language>language</language>

data/spec/samples/oral_history_xml.xml

@@ -8,7 +8,7 @@
   <field name="rights_text">rights</field>
   <field name="publisher_field">publisher</field>
   <field name="creation_date">creation date</field>
-  <field name="identifier_field">jwa:sample_pid</field>
+  <field name="identifier_field">jwa:sample_id</field>
   <field name="format_field">format</field>
   <field name="extent_field">extent</field>
   <field name="language_field">language</field>

data/spec/samples/special_thing.rb

@@ -34,11 +34,11 @@ class SpecialThing < ActiveFedora::Base
   #
   # RELATIONSHIPS
   #
-  
+
   # This is an example of how you can add a custom relationship to a model
   # This will allow you to call .derivation on instances of the model to get the _outbound_ "hasDerivation" relationship in the RELS-EXT datastream
-  belongs_to :derivation, property: :has_derivation, class_name: 'SpecialThing' 
+  belongs_to :derivation, predicate: ActiveFedora::RDF::RelsExt.hasDerivation, class_name: 'SpecialThing'
 
   # This will allow you to call .inspirations on instances of the model to get a list of all of the objects that assert "hasDerivation" relationships pointing at this object
-  has_many :inspirations, property: :has_derivation, class_name: 'SpecialThing'
+  has_many :inspirations, predicate: ActiveFedora::RDF::RelsExt.hasDerivation, class_name: 'SpecialThing'
 end

data/spec/spec_helper.rb

@@ -1,23 +1,28 @@
 ENV["environment"] ||= 'test'
 require "bundler/setup"
 
-
-begin
+if ENV["COVERAGE"]
   require 'simplecov'
-  SimpleCov.start
-rescue LoadError
-  #It's nbd if we don't have simplecov
-  $stderr.puts "Couldn't load simplecov"
+  require 'coveralls'
+
+  SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+  SimpleCov.start do
+    add_filter "/spec/"
+  end
 end
 
 require 'active-fedora'
 require 'rspec'
-require 'rspec/its'
 require 'equivalent-xml/rspec_matchers'
 require 'logger'
+require 'byebug' unless ENV['TRAVIS']
 
-ActiveFedora::Base.logger = Logger.new(STDERR);
+ActiveFedora::Base.logger = Logger.new(STDERR)
 ActiveFedora::Base.logger.level = Logger::WARN
+# HttpLogger.logger = Logger.new(STDOUT)
+# HttpLogger.ignore = [/localhost:8983\/solr/]
+# HttpLogger.colorize = false
+# HttpLogger.log_headers = true
 
 Dir[File.expand_path("../support/**/*.rb", __FILE__)].each {|f| require f }
 require 'samples/samples'
@@ -34,13 +39,18 @@ restore_spec_configuration
 # Shut those Rails deprecation warnings up
 ActiveSupport::Deprecation.behavior= Proc.new { |message, callstack| }
 
+require 'active_fedora/cleaner'
 RSpec.configure do |config|
+  # Stub out test stuff.
+  config.before(:each) do
+    ActiveFedora::Cleaner.clean!
+  end
+  config.after(:each) do
+    # cleanout_fedora
+  end
+  config.order = :random if ENV['CI']
 end
 
 def fixture(file)
   File.open(File.join(File.dirname(__FILE__), 'fixtures', file), 'rb')
 end
-
-def solr_uri(uri)
-  uri.gsub(/(:)/, "\\:").gsub(/(\/)/,"\\/")
-end

data/spec/support/an_active_model.rb

@@ -1,18 +1,14 @@
 shared_examples_for "An ActiveModel" do
   def assert(test, *args)
-    expect(test).to eq(true)
-  end
-
-  def assert_equal(test, obj)
-    expect(test).to eq(obj)
+    expect(test).to be true
   end
 
   def assert_kind_of(klass, inspected_object)
     expect(inspected_object).to be_kind_of(klass)
   end
 
-  def assert_respond_to(obj, meth, msg = nil)
-    expect(obj).to respond_to meth
+  def assert_equal(the_other, one)
+    expect(one).to eq the_other
   end
 
   include ActiveModel::Lint::Tests

data/spec/unit/active_fedora_spec.rb

@@ -5,6 +5,9 @@ require 'config_helper'
 
 describe ActiveFedora do
   
+  before(:each) do
+    restore_spec_configuration
+  end
   after :all do
     unstub_rails
     # Restore to default fedora configs
@@ -14,20 +17,20 @@ describe ActiveFedora do
   describe "initialization methods" do
     describe "environment" do
       it "should use config_options[:environment] if set" do
-        allow(ActiveFedora).to receive_messages(:config_options => {:environment=>"ballyhoo"})
+        allow(ActiveFedora).to receive(:config_options).and_return(:environment=>"ballyhoo")
         expect(ActiveFedora.environment).to eql("ballyhoo")
       end
 
       it "should use Rails.env if no config_options and Rails.env is set" do
         stub_rails(:env => "bedbugs")
-        allow(ActiveFedora).to receive_messages(:config_options => {})
+        allow(ActiveFedora).to receive(:config_options).and_return({})
         expect(ActiveFedora.environment).to eql("bedbugs")
         unstub_rails
       end
 
       it "should use ENV['environment'] if neither config_options nor Rails.env are set" do
         ENV['environment'] = "wichita"
-        allow(ActiveFedora).to receive_messages(:config_options => {})
+        allow(ActiveFedora).to receive(:config_options).and_return({})
         expect(ActiveFedora.environment).to eql("wichita")
         ENV['environment']='test'
       end
@@ -35,15 +38,15 @@ describe ActiveFedora do
       it "should use ENV['RAILS_ENV'] and log a warning if none of the above are set" do
         ENV['environment']=nil
         ENV['RAILS_ENV'] = "rails_env"
-        expect {ActiveFedora.environment}.to raise_error(RuntimeError, "You're depending on RAILS_ENV for setting your environment. Please use ENV['environment'] for non-rails environment setting: 'rake foo:bar environment=test'")
+        expect{ ActiveFedora.environment }.to raise_error(RuntimeError, "You're depending on RAILS_ENV for setting your environment. Please use ENV['environment'] for non-rails environment setting: 'rake foo:bar environment=test'")
         ENV['environment']='test'
       end
 
       it "should be development if none of the above are present" do
         ENV['environment']=nil
         ENV['RAILS_ENV'] = nil
-        allow(ActiveFedora).to receive_messages(:config_options => {})
-        expect(ActiveFedora.environment).to eq('development')
+        allow(ActiveFedora).to receive(:config_options).and_return({})
+        expect(ActiveFedora.environment).to eq 'development'
         ENV['environment']="test"
       end
     end
@@ -51,7 +54,7 @@ describe ActiveFedora do
   
   describe ".init" do
     
-    after(:all) do
+    after(:each) do
       # Restore to default fedora configs
       ActiveFedora.init(:environment => "test", :fedora_config_path => File.join(File.dirname(__FILE__), "..", "..", "config", "fedora.yml"))
     end
@@ -59,13 +62,13 @@ describe ActiveFedora do
     describe "outside of rails" do
        it "should load the passed config if explicit config passed in as a string" do
         ActiveFedora.init(:fedora_config_path=>'./spec/fixtures/rails_root/config/fedora.yml', :environment => 'test')
-        expect(ActiveFedora.config.credentials).to eq({:url=> "http://testhost.com:8983/fedora", :user=>'fedoraAdmin', :password=>'fedoraAdmin'})
+        expect(ActiveFedora.config.credentials).to eq(url: "http://testhost.com:8983/fedora", :user=>'fedoraAdmin', :password=>'fedoraAdmin')
       end
     end
 
     describe "within rails" do
 
-      after(:all) do
+      after(:each) do
         unstub_rails
       end
 
@@ -78,13 +81,13 @@ describe ActiveFedora do
             fedora_config_path = File.expand_path(File.join(File.dirname(__FILE__),"../fixtures/rails_root/config/fedora.yml"))
             solr_config_path = File.expand_path(File.join(File.dirname(__FILE__),"../fixtures/rails_root/config/solr.yml"))
             pred_config_path = File.expand_path(File.join(File.dirname(__FILE__),"../fixtures/rails_root/config/predicate_mappings.yml"))
-            
+
             allow(File).to receive(:open).with(fedora_config_path).and_return(fedora_config)
             allow(File).to receive(:open).with(solr_config_path).and_return(solr_config)
             allow(ActiveFedora::SolrService).to receive(:load_mappings) #For the solrizer solr_mappings.yml
 
             ActiveFedora.init(:fedora_config_path=>fedora_config_path,:solr_config_path=>solr_config_path)
-            expect(ActiveFedora.solr.class).to eq(ActiveFedora::SolrService)
+            expect(ActiveFedora.solr.class).to eq ActiveFedora::SolrService
           end
         end
 
@@ -94,7 +97,7 @@ describe ActiveFedora do
             
             stub_rails(:root=>File.join(File.dirname(__FILE__),"../fixtures/rails_root"))
             ActiveFedora.init()
-            expect(ActiveFedora.config.credentials[:url]).to eq("http://testhost.com:8983/fedora")
+            expect(ActiveFedora.config.credentials[:url]).to eq "http://testhost.com:8983/fedora"
           end
         end
       end
@@ -111,19 +114,19 @@ describe ActiveFedora do
       end
     end
     it "should return class constants based on strings" do
-      expect(ActiveFedora.class_from_string("Om")).to eq(Om)
-      expect(ActiveFedora.class_from_string("ActiveFedora::RDF::Indexing")).to eq(ActiveFedora::RDF::Indexing)
-      expect(ActiveFedora.class_from_string("Indexing", ActiveFedora::RDF)).to eq(ActiveFedora::RDF::Indexing)
+      expect(ActiveFedora.class_from_string("Om")).to eq Om
+      expect(ActiveFedora.class_from_string("ActiveFedora::RDF::Indexing")).to eq ActiveFedora::RDF::Indexing
+      expect(ActiveFedora.class_from_string("Indexing", ActiveFedora::RDF)).to eq ActiveFedora::RDF::Indexing
     end
 
     it "should find sibling classes" do
-      expect(ActiveFedora.class_from_string("SiblingClass", ParentClass::OtherSiblingClass)).to eq(ParentClass::SiblingClass)
+      expect(ActiveFedora.class_from_string("SiblingClass", ParentClass::OtherSiblingClass)).to eq ParentClass::SiblingClass
     end
 
     it "should raise a NameError if the class isn't found" do
       expect {
         ActiveFedora.class_from_string("FooClass", ParentClass::OtherSiblingClass)
-      }.to raise_error NameError, /uninitialized constant FooClass/
+      }.to raise_error NameError, "uninitialized constant FooClass"
     end
   end
 end

data/spec/unit/attached_files_spec.rb

@@ -0,0 +1,203 @@
+require 'spec_helper'
+
+describe ActiveFedora::AttachedFiles do
+  subject { ActiveFedora::Base.new }
+  describe "contains" do
+    before do
+      class FooHistory < ActiveFedora::Base
+         contains 'dsid', class_name: 'ActiveFedora::SimpleDatastream'
+         contains 'complex_ds', autocreate: true, class_name: 'Z'
+         contains 'thumbnail'
+      end
+    end
+    after do
+      Object.send(:remove_const, :FooHistory)
+    end
+
+    it "should have a child_resource_reflection" do
+      expect(FooHistory.child_resource_reflections).to have_key(:dsid)
+      expect(FooHistory.child_resource_reflections).to have_key(:thumbnail)
+    end
+
+    it "should let you override defaults" do
+      expect(FooHistory.child_resource_reflections[:complex_ds].options).to include(autocreate: true)
+      expect(FooHistory.child_resource_reflections[:complex_ds].class_name).to eq 'Z'
+    end
+
+    it "should raise an error if you don't give a dsid" do
+      expect{ FooHistory.contains nil, type: ActiveFedora::SimpleDatastream }.to raise_error ArgumentError,
+        "You must provide a name (dsid) for the datastream"
+    end
+  end
+
+  describe '.has_metadata' do
+    before do
+      @original_behavior = Deprecation.default_deprecation_behavior
+      Deprecation.default_deprecation_behavior = :silence
+      class FooHistory < ActiveFedora::Base
+         has_metadata :name => 'dsid', type: ActiveFedora::SimpleDatastream
+         has_metadata 'complex_ds', autocreate: true, type: 'Z'
+      end
+    end
+    after do
+      Deprecation.default_deprecation_behavior = @original_behavior
+      Object.send(:remove_const, :FooHistory)
+    end
+
+    it "should have a child_resource_reflection" do
+      expect(FooHistory.child_resource_reflections).to have_key(:dsid)
+    end
+
+    it "should have reasonable defaults" do
+      expect(FooHistory.child_resource_reflections[:dsid].options).to include(class_name: 'ActiveFedora::SimpleDatastream')
+    end
+
+    it "should let you override defaults" do
+      expect(FooHistory.child_resource_reflections[:complex_ds].options).to include(autocreate: true)
+      expect(FooHistory.child_resource_reflections[:complex_ds].class_name).to eq 'Z'
+    end
+
+    it "should raise an error if you don't give a type" do
+      expect{ FooHistory.has_metadata "bob" }.to raise_error ArgumentError,
+        "You must provide a :type property for the datastream 'bob'"
+    end
+
+    it "should raise an error if you don't give a dsid" do
+      expect{ FooHistory.has_metadata type: ActiveFedora::SimpleDatastream }.to raise_error ArgumentError,
+        "You must provide a name (dsid) for the datastream"
+    end
+
+    describe "creates accessors" do
+      subject { FooHistory.new }
+      it "should exist on the instance" do
+        expect(subject.dsid).to eq subject.attached_files['dsid']
+      end
+    end
+  end
+
+  describe '.has_file_datastream' do
+    before do
+      class FooHistory < ActiveFedora::Base
+         has_file_datastream :name => 'dsid'
+         has_file_datastream 'another'
+      end
+    end
+    after do
+      Object.send(:remove_const, :FooHistory)
+    end
+
+    it "should have reasonable defaults" do
+      expect(FooHistory.child_resource_reflections[:dsid].klass).to eq ActiveFedora::File
+      expect(FooHistory.child_resource_reflections[:another].klass).to eq ActiveFedora::File
+    end
+  end
+
+  describe "#add_file_datastream" do
+    before do
+      class Bar < ActiveFedora::File; end
+
+      class FooHistory < ActiveFedora::Base
+         contains :content, class_name: 'Bar'
+      end
+    end
+
+    after do
+      Object.send(:remove_const, :Bar)
+      Object.send(:remove_const, :FooHistory)
+    end
+    let(:container) { FooHistory.new }
+
+    context "a reflection matches the :dsid property" do
+      it "should build the reflection" do
+        container.add_file_datastream('blah', dsid: 'content')
+        expect(container.content).to be_instance_of Bar
+        expect(container.content.content).to eq 'blah'
+      end
+    end
+
+    context "no reflection matches the :dsid property" do
+      it "should create a singleton reflection and build it" do
+        container.add_file_datastream('blah', dsid: 'fizz')
+        expect(container.fizz).to be_instance_of ActiveFedora::File
+        expect(container.fizz.content).to eq 'blah'
+      end
+    end
+  end
+
+  describe "#serialize_attached_files" do
+    it "should touch each file" do
+      m1 = double()
+      m2 = double()
+
+      expect(m1).to receive(:serialize!)
+      expect(m2).to receive(:serialize!)
+      allow(subject).to receive(:attached_files).and_return(:m1 => m1, :m2 => m2)
+      subject.serialize_attached_files
+    end
+  end
+
+  describe "#accessor_name" do
+    it "should use the name" do
+      expect(subject.send(:accessor_name, 'abc')).to eq 'abc'
+    end
+
+    it "should use the name" do
+      expect(subject.send(:accessor_name, 'ARCHIVAL_XML')).to eq 'ARCHIVAL_XML'
+    end
+
+    it "should use the name" do
+      expect(subject.send(:accessor_name, 'descMetadata')).to eq 'descMetadata'
+    end
+
+    it "should hash-erize underscores" do
+      expect(subject.send(:accessor_name, 'a-b')).to eq 'a_b'
+    end
+  end
+
+  describe "#attached_files" do
+    it "should return the datastream hash proxy" do
+      allow(subject).to receive(:load_datastreams)
+      expect(subject.attached_files).to be_a_kind_of(ActiveFedora::FilesHash)
+    end
+  end
+
+  describe "#attach_file" do
+    let(:dsid) { 'Abc' }
+    let(:file) { ActiveFedora::File.new }
+    before do
+      subject.attach_file(file, dsid)
+    end
+
+    it "should add the datastream to the object" do
+      expect(subject.attached_files['Abc']).to eq file
+    end
+
+    describe "dynamic accessors" do
+      context "when the file is named with dash" do
+        let(:dsid) { 'eac-cpf' }
+        it "should convert dashes to underscores" do
+          expect(subject.eac_cpf).to eq file
+        end
+      end
+
+      context "when the file is named with underscore" do
+        let(:dsid) { 'foo_bar' }
+        it "should preserve the underscore" do
+          expect(subject.foo_bar).to eq file
+        end
+      end
+    end
+  end
+
+  describe "#metadata_streams" do
+    it "should only be metadata datastreams" do
+      ds1 = double(:metadata? => true)
+      ds2 = double(:metadata? => true)
+      ds3 = double(:metadata? => true)
+      file_ds = double(:metadata? => false)
+      allow(subject).to receive(:attached_files).and_return(:a => ds1, :b => ds2, :c => ds3, :e => file_ds)
+      expect(subject.metadata_streams).to include(ds1, ds2, ds3)
+      expect(subject.metadata_streams).to_not include(file_ds)
+    end
+  end
+end