rubydora 1.8.1 → 1.9.0

data/lib/rubydora/transactions.rb

@@ -1,6 +1,6 @@
 module Rubydora
   # Extremely basic (and naive) 'transaction' support for Rubydora. This isn't
-  # really intended to be used in a production-like situation -- more for 
+  # really intended to be used in a production-like situation -- more for
   # rolling back (small) changes during testing.
   module Transactions
     extend ActiveSupport::Concern
@@ -62,10 +62,9 @@ module Rubydora
       end
 
     end
-    
 
     # Start a transaction
-    def transaction &block
+    def transaction(&block)
       Transaction.new self, &block
       self.transactions_log.clear
     end
@@ -73,13 +72,11 @@ module Rubydora
     # Unshift a transaction entry onto the transaction logs.
     # We want these entries in reverse-chronological order
     # for ease of undoing..
-    def append_to_transactions_log method, options = {}
+    def append_to_transactions_log(method, options = {})
       return unless Rubydora::Transactions.use_transactions
-
-      unless transaction_is_redundant?(method, options)
-        options[:foxml] = export(:pid => options[:pid], :context => :archive) if options[:foxml] == true
-        transactions_log.unshift([method, options])
-      end
+      return if transaction_is_redundant?(method, options)
+      options[:foxml] = export(:pid => options[:pid], :context => :archive) if options[:foxml] == true
+      transactions_log.unshift([method, options])
     end
 
     # The repository transaction log.
@@ -87,12 +84,11 @@ module Rubydora
       @log ||= []
     end
 
-    def transaction_is_redundant? method, options
-      return true if transactions_log.any? { |(t_method, t_options)| 
+    def transaction_is_redundant?(method, options)
+      return true if transactions_log.any? { |(t_method, t_options)|
         # these methods will rollback ANY object change that happens after it, so there's no need to track future changes to this object
-        t_options[:pid] == options[:pid] and [:ingest, :purge_object, :modify_datastream, :purge_datastream].include? t_method
+        t_options[:pid] == options[:pid] && [:ingest, :purge_object, :modify_datastream, :purge_datastream].include?(t_method)
       }
-
       false
     end
   end
@@ -102,74 +98,69 @@ module Rubydora
     include Hooks
     define_hook :after_rollback
 
-    def initialize repository, &block
+    def initialize(repository, &block)
       @repository = repository
       with_transactions(&block)
     end
 
-    def with_transactions &block
+    def with_transactions(&block)
       old_state = Rubydora::Transactions.use_transactions
       Rubydora::Transactions.use_transactions = true
-
       yield(self)
-
       Rubydora::Transactions.use_transactions = old_state
     end
 
-    def without_transactions &block
+    def without_transactions(&block)
       old_state = Rubydora::Transactions.use_transactions
       Rubydora::Transactions.use_transactions = false
-
       yield(self)
-
       Rubydora::Transactions.use_transactions = old_state
     end
 
-    # Roll-back transactions by reversing their outcomes 
-    # (or, in some cases, re-ingesting the object at the 
+    # Roll-back transactions by reversing their outcomes
+    # (or, in some cases, re-ingesting the object at the
     # previous state.
     def rollback
       without_transactions do
-      repository.transactions_log.delete_if do |(method, options)|
+        repository.transactions_log.delete_if do |(method, options)|
 
-        begin
-          case method
-            when :ingest
-              repository.purge_object :pid => options[:pid]
+          begin
+            case method
+              when :ingest
+                repository.purge_object :pid => options[:pid]
 
-            when :modify_object
-              repository.modify_object options
+              when :modify_object
+                repository.modify_object options
 
-            when :add_datastream
-              repository.purge_datastream :pid => options[:pid], :dsid => options[:dsid]
+              when :add_datastream
+                repository.purge_datastream :pid => options[:pid], :dsid => options[:dsid]
 
-            when :add_relationship
-              repository.purge_relationship options[:options].merge(:pid => options[:pid])
+              when :add_relationship
+                repository.purge_relationship options[:options].merge(:pid => options[:pid])
 
-            when :purge_relationship
-              repository.add_relationship options[:options].merge(:pid => options[:pid])
+              when :purge_relationship
+                repository.add_relationship options[:options].merge(:pid => options[:pid])
 
-            when :purge_object
-              repository.ingest :pid => options[:pid], :file => options[:foxml]
+              when :purge_object
+                repository.ingest :pid => options[:pid], :file => options[:foxml]
 
-            when :set_datastream_options
-              repository.set_datastream_options options
+              when :set_datastream_options
+                repository.set_datastream_options options
 
-            when :modify_datastream
-              repository.purge_object :pid => options[:pid] rescue nil
-              repository.ingest :pid => options[:pid], :file => options[:foxml]
+              when :modify_datastream
+                repository.purge_object :pid => options[:pid] rescue nil
+                repository.ingest :pid => options[:pid], :file => options[:foxml]
 
-            when :purge_datastream
-              repository.purge_object :pid => options[:pid] rescue nil
-              repository.ingest :pid => options[:pid], :file => options[:foxml]
+              when :purge_datastream
+                repository.purge_object :pid => options[:pid] rescue nil
+                repository.ingest :pid => options[:pid], :file => options[:foxml]
+            end
+          rescue
+            # no-op
           end
-        rescue
-          # no-op
-        end
-
-        run_hook :after_rollback, :pid => options[:pid], :method => method, :options => options
 
-      end
+          run_hook :after_rollback, :pid => options[:pid], :method => method, :options => options
+        end
       end
       true
     end

data/rubydora.gemspec

@@ -1,35 +1,35 @@
 # Provide a simple gemspec so you can easily use your enginex
 # project in your rails apps through git.
-require File.join(File.dirname(__FILE__), "lib/rubydora/version")
+require File.join(File.dirname(__FILE__), 'lib/rubydora/version')
 Gem::Specification.new do |s|
-  s.name = "rubydora"
-  s.version = Rubydora::VERSION
-  s.platform = Gem::Platform::RUBY
-  s.authors = ["Chris Beer"]
-  s.email = ["chris@cbeer.info"]
-  s.summary = %q{Fedora Commons REST API ruby library }
-  s.description = %q{Fedora Commons REST API ruby library}
-  s.homepage = "http://github.com/projecthydra/rubydora"
+  s.name        = 'rubydora'
+  s.version     = Rubydora::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ['Chris Beer']
+  s.email       = ['chris@cbeer.info']
+  s.summary     = 'Fedora Commons REST API ruby library'
+  s.description = 'Fedora Commons REST API ruby library'
+  s.homepage    = 'http://github.com/projecthydra/rubydora'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
+  s.require_paths = ['lib']
 
-  s.add_dependency "fastercsv"
-  s.add_dependency "rest-client"
-  s.add_dependency "nokogiri"
-  s.add_dependency "equivalent-xml"
-  s.add_dependency "mime-types"
-  s.add_dependency "activesupport"
-  s.add_dependency "activemodel"
-  s.add_dependency "hooks", "~> 0.3.0"
-  s.add_dependency "deprecation"
+  s.add_dependency 'rest-client'
+  s.add_dependency 'nokogiri'
+  s.add_dependency 'equivalent-xml'
+  s.add_dependency 'mime-types'
+  s.add_dependency 'activesupport'
+  s.add_dependency 'activemodel'
+  s.add_dependency 'hooks', '~> 0.3'
+  s.add_dependency 'deprecation'
 
-  s.add_development_dependency("rake")
-  s.add_development_dependency("bundler", ">= 1.0.14")
-  s.add_development_dependency("rspec", "~> 2.0")
-  s.add_development_dependency("yard")
-  s.add_development_dependency("jettywrapper", ">= 1.4.0")
-  s.add_development_dependency("webmock")
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'yard'
+  s.add_development_dependency 'bundler', '>= 1.0.14'
+  s.add_development_dependency 'rspec', '~> 2.0'
+  s.add_development_dependency 'jettywrapper', '>= 1.4.0'
+  s.add_development_dependency 'webmock'
+  s.add_development_dependency 'simplecov'
 end

data/spec/audit_trail_spec.rb

@@ -24,5 +24,5 @@ describe "#audit_trail" do
     record.date.should == "2013-02-25T16:43:06.219Z"
     record.justification.should == ""
   end
-  
+
 end

data/spec/lib/datastream_spec.rb

@@ -28,7 +28,7 @@ describe Rubydora::Datastream do
       stub_response = double
       stub_response.stub(:read_body).and_yield("one1").and_yield('two2').and_yield('thre').and_yield('four')
       allow(stub_response).to receive(:headers) { {content_length: "16"} }
-      @mock_api.should_receive(:datastream_dissemination).with(hash_including(:pid => 'pid', :dsid => 'dsid')).and_yield(stub_response) 
+      @mock_api.should_receive(:datastream_dissemination).with(hash_including(:pid => 'pid', :dsid => 'dsid')).and_yield(stub_response)
       subject.profile = Rubydora::ProfileParser.parse_datastream_profile(prof)
     end
     shared_examples "a streamable datastream" do
@@ -166,7 +166,6 @@ describe Rubydora::Datastream do
     #   @datastream.versionable.should be true
     # end
 
-
     it "should call the appropriate api on save" do
       @datastream.stub(:content => 'content')
       @mock_api.should_receive(:add_datastream).with(hash_including(:content => 'content', :pid => 'pid', :dsid => 'dsid', :controlGroup => 'M', :dsState => 'A'))
@@ -221,7 +220,7 @@ describe Rubydora::Datastream do
         <datastreamProfile>
         </datastreamProfile>
       XML
-      @datastream.dsChecksumValid.should be_nil 
+      @datastream.dsChecksumValid.should be_nil
     end
 
     it "should be true when it's returned as true" do
@@ -268,7 +267,7 @@ describe Rubydora::Datastream do
     end
 
     it "should mediate access to datastream contents" do
-      @mock_api.should_receive(:datastream_dissemination).with(hash_including(:pid => 'pid', :dsid => 'dsid')).and_return('asdf') 
+      @mock_api.should_receive(:datastream_dissemination).with(hash_including(:pid => 'pid', :dsid => 'dsid')).and_return('asdf')
       @datastream.content.should == "asdf"
     end
 
@@ -288,7 +287,6 @@ describe Rubydora::Datastream do
 
     end
 
-
   end
 
   describe "content changed behavior" do
@@ -303,8 +301,13 @@ describe Rubydora::Datastream do
         XML
       end
 
+      it "does not retrieve content unnecessarily" do
+        @mock_api.should_not_receive(:datastream_dissemination)
+        @datastream.content_changed?.should == false
+      end
+
       it "should not be changed after a read-only access" do
-        @mock_api.stub(:datastream_dissemination).with(hash_including(:pid => 'pid', :dsid => 'dsid')).and_return('asdf') 
+        @mock_api.stub(:datastream_dissemination).with(hash_including(:pid => 'pid', :dsid => 'dsid')).and_return('asdf')
         @datastream.content
         @datastream.content_changed?.should == false
       end
@@ -313,29 +316,29 @@ describe Rubydora::Datastream do
         @datastream.content_changed?.should == false
       end
       it "should be changed when the new content is different than the old content" do
-        @mock_api.stub(:datastream_dissemination).with(hash_including(:pid => 'pid', :dsid => 'dsid')).and_return('asdf') 
+        @mock_api.stub(:datastream_dissemination).with(hash_including(:pid => 'pid', :dsid => 'dsid')).and_return('asdf')
         @datastream.content = "test"
-        @datastream.content_changed?.should == true 
+        @datastream.content_changed?.should == true
       end
 
       it "should not be changed when the new content is the same as the existing content (when eager-loading is enabled)" do
-        @mock_api.stub(:datastream_dissemination).with(hash_including(:pid => 'pid', :dsid => 'dsid')).and_return('test') 
+        @mock_api.stub(:datastream_dissemination).with(hash_including(:pid => 'pid', :dsid => 'dsid')).and_return('test')
         @datastream.eager_load_datastream_content = true
         @datastream.content = "test"
-        @datastream.content_changed?.should  == false 
+        @datastream.content_changed?.should  == false
       end
 
       it "should  be changed when the new content is the same as the existing content (without eager loading, the default)" do
-        @mock_api.stub(:datastream_dissemination).with(hash_including(:pid => 'pid', :dsid => 'dsid')).and_return('test') 
+        @mock_api.stub(:datastream_dissemination).with(hash_including(:pid => 'pid', :dsid => 'dsid')).and_return('test')
         @datastream.content = "test"
         @datastream.content_changed?.should  == true
       end
 
       it "should not be changed when the new content is the same as the existing content (and we have accessed #content previously)" do
-        @mock_api.stub(:datastream_dissemination).with(hash_including(:pid => 'pid', :dsid => 'dsid')).and_return('test') 
+        @mock_api.stub(:datastream_dissemination).with(hash_including(:pid => 'pid', :dsid => 'dsid')).and_return('test')
         @datastream.content
         @datastream.content = "test"
-        @datastream.content_changed?.should  == false 
+        @datastream.content_changed?.should  == false
       end
     end
 
@@ -350,14 +353,14 @@ describe Rubydora::Datastream do
         @datastream = Rubydora::Datastream.new @mock_object, 'dsid', :controlGroup => 'X'
       end
       it "should not be changed when the new content is the same as the existing content (when eager-loading is enabled)" do
-        @mock_api.stub(:datastream_dissemination).with(hash_including(:pid => 'pid', :dsid => 'dsid')).and_return('<xml>test</xml>') 
+        @mock_api.stub(:datastream_dissemination).with(hash_including(:pid => 'pid', :dsid => 'dsid')).and_return('<xml>test</xml>')
         @datastream.eager_load_datastream_content = true
         @datastream.content = "<xml>test</xml>"
-        @datastream.content_changed?.should  == false 
+        @datastream.content_changed?.should  == false
       end
 
       it "should  be changed when the new content is the same as the existing content (without eager loading, the default)" do
-        @mock_api.stub(:datastream_dissemination).with(hash_including(:pid => 'pid', :dsid => 'dsid')).and_return('<xml>test</xml>') 
+        @mock_api.stub(:datastream_dissemination).with(hash_including(:pid => 'pid', :dsid => 'dsid')).and_return('<xml>test</xml>')
         @datastream.content = "<xml>test</xml>"
         @datastream.content_changed?.should  == true
       end
@@ -372,12 +375,12 @@ describe Rubydora::Datastream do
     subject { Rubydora::Datastream.new double(:pid => 'asdf', :new? => false), 'asdf' }
     it "should have content if it is persisted" do
       subject.stub(:new? => false)
-      subject.should have_content     
+      subject.should have_content
     end
 
     it "should have content if it has content" do
       subject.content = "123"
-      subject.should have_content     
+      subject.should have_content
     end
 
     context "it has a dsLocation" do
@@ -398,7 +401,7 @@ describe Rubydora::Datastream do
 
     it "should not have content otherwise" do
       subject.stub(:content => nil)
-      subject.should_not have_content     
+      subject.should_not have_content
     end
   end
 
@@ -561,7 +564,7 @@ describe Rubydora::Datastream do
       end
 
     end
-    
+
   end
 
   describe "datastream attributes" do
@@ -609,11 +612,11 @@ describe Rubydora::Datastream do
           subject.send("#{method}=", 'zxcv')
         end
 
-        it "should appear in the save request" do 
-          @mock_api.should_receive(:modify_datastream).with(hash_including(method.to_sym => 'new_value'))
-          subject.send("#{method}=", 'new_value')
-          subject.save
-          expect(subject).to_not be_changed, "#{subject.changes.inspect}"
+        it "should appear in the save request" do
+         @mock_api.should_receive(:modify_datastream).with(hash_including(method.to_sym => 'new_value'))
+         subject.send("#{method}=", 'new_value')
+         subject.save
+         expect(subject).to_not be_changed, "#{subject.changes.inspect}"
        end
       end
     end
@@ -657,10 +660,10 @@ describe Rubydora::Datastream do
       end
 
       it "should appear in the save request" do
-          @mock_api.should_receive(:modify_datastream).with(hash_including(method.to_sym => 'http://example.com'))
-          subject.stub(:content_changed? => false)
-          subject.dsLocation = 'http://example.com'
-          subject.save
+        @mock_api.should_receive(:modify_datastream).with(hash_including(method.to_sym => 'http://example.com'))
+        subject.stub(:content_changed? => false)
+        subject.dsLocation = 'http://example.com'
+        subject.save
       end
     end
 
@@ -829,12 +832,12 @@ describe Rubydora::Datastream do
       end
     end
 
-
     describe "without existing properties" do
       before(:each) do
         @datastream = Rubydora::Datastream.new @mock_object, 'dsid'
         @datastream.stub(:new? => true )
         @datastream.stub(:local_or_remote_content => '123')
+        @datastream.stub(:content_loaded? => true)
         @datastream.stub(:profile) { {} }
       end
       it "should compile parameters to hash" do
@@ -880,7 +883,7 @@ describe Rubydora::Datastream do
     after(:all) do
       Object.send(:remove_const, :MyDatastream)
     end
-    
+
     describe "saving new datastream" do
       before do
         allow(@mock_api).to receive(:add_datastream).with(hash_including(:content => 'content', :pid => 'pid', :dsid => 'dsid', :controlGroup => 'M', :dsState => 'A')) { {} }
@@ -913,4 +916,3 @@ describe Rubydora::Datastream do
   end
 
 end
-

data/spec/lib/digital_object_spec.rb

@@ -68,7 +68,7 @@ describe Rubydora::DigitalObject do
 
     describe "without a provided pid" do
       subject { Rubydora::DigitalObject.new nil, @mock_api }
-      it "should create a new Fedora object with a generated PID if no PID is provided" do 
+      it "should create a new Fedora object with a generated PID if no PID is provided" do
         @mock_api.should_receive(:ingest).with(hash_including(:pid => nil)).and_return('pid')
         @mock_api.should_receive(:datastreams).with(hash_including(:pid => 'pid')).and_raise(RestClient::ResourceNotFound)
         subject.save
@@ -93,13 +93,14 @@ describe Rubydora::DigitalObject do
   end
 
   describe "retreive datastreams" do
-    describe "without profiles (fedora < 3.6)" do 
+    describe "without profiles (fedora < 3.6)" do
       before(:each) do
         @mock_api.stub :datastreams do |hash|
           "<objectDatastreams><datastream dsid='a'></datastream><datastream dsid='b'></datastream><datastream dsid='c'></datastream></objectDatastreams>"
         end
         @object = Rubydora::DigitalObject.new 'pid', @mock_api
         @object.stub(:new_record? => false)
+        @object.stub(:new? => false)
       end
 
       it "should provide a hash populated by the existing datastreams" do
@@ -137,7 +138,7 @@ describe Rubydora::DigitalObject do
         object.datastreams['asdf'].should be_a_kind_of(MyCustomDatastreamClass)
       end
     end
-    describe "with profiles (fedora >= 3.6)" do 
+    describe "with profiles (fedora >= 3.6)" do
       before(:each) do
         @mock_api.stub :datastreams do |hash|
           "<objectDatastreams>
@@ -148,6 +149,7 @@ describe Rubydora::DigitalObject do
         end
         @object = Rubydora::DigitalObject.new 'pid', @mock_api
         @object.stub(:new_record? => false)
+        @object.stub(:new? => false)
       end
 
       it "should provide a hash populated by the existing datastreams" do
@@ -185,8 +187,9 @@ describe Rubydora::DigitalObject do
         </datastreamProfile>
       </objectDatastreams>
       XML
-     @object = Rubydora::DigitalObject.new 'pid', @mock_api
+      @object = Rubydora::DigitalObject.new 'pid', @mock_api
       @object.stub(:new_record? => false)
+      @object.stub(:new? => false)
     end
     describe "datastreams" do
       it "should provide a hash populated by the existing datastreams" do
@@ -269,7 +272,7 @@ describe Rubydora::DigitalObject do
         # object date should be canonicalized and updated
         @object.lastModifiedDate.should == '2012-01-02:05:15:45.1Z'
       end
-      
+
       it "should not set lastModifiedDate if the before_save callback is false" do
         @object.stub(:datastreams) { { :changed_ds => @changed_ds } }
         @changed_ds.should_receive(:dsCreateDate).and_return(nil)
@@ -451,7 +454,7 @@ describe Rubydora::DigitalObject do
       Rubydora::Datastream.should_receive(:new).with(anything, 'my_ds', hash_including(:asOfDateTime => '2011-09-26T20:41:02.450Z'))
       ds = @object.versions.first['my_ds']
     end
-    
+
   end
 
   describe "to_api_params" do
@@ -479,7 +482,7 @@ describe Rubydora::DigitalObject do
 
       it "should fall-back to the set of default attributes" do
         @mock_api.should_receive(:object).with(:pid=>"pid").and_raise(RestClient::ResourceNotFound)
-        Rubydora::DigitalObject::OBJ_DEFAULT_ATTRIBUTES.should_receive(:[]).with(method.to_sym) { 'zxcv'} 
+        Rubydora::DigitalObject::OBJ_DEFAULT_ATTRIBUTES.should_receive(:[]).with(method.to_sym) { 'zxcv'}
         subject.send(method).should == 'zxcv'
       end
     end
@@ -499,7 +502,7 @@ describe Rubydora::DigitalObject do
         subject.send("#{method}=", 'zxcv')
       end
 
-      it "should appear in the save request" do 
+      it "should appear in the save request" do
         @mock_api.should_receive(:ingest).with(hash_including(method.to_sym => 'new_value'))
         @mock_api.should_receive(:object).with(:pid=>"pid").and_raise(RestClient::ResourceNotFound)
         subject.send("#{method}=", 'new_value')
@@ -524,7 +527,7 @@ describe Rubydora::DigitalObject do
 
       it "should fall-back to the set of default attributes" do
         @mock_api.should_receive(:object).with(:pid=>"pid").and_raise(RestClient::ResourceNotFound)
-        Rubydora::DigitalObject::OBJ_DEFAULT_ATTRIBUTES.should_receive(:[]).with(:state) { 'zxcv'} 
+        Rubydora::DigitalObject::OBJ_DEFAULT_ATTRIBUTES.should_receive(:[]).with(:state) { 'zxcv'}
         subject.state.should == 'zxcv'
       end
     end
@@ -549,7 +552,7 @@ describe Rubydora::DigitalObject do
         subject.should_not be_changed
       end
 
-      it "should appear in the save request" do 
+      it "should appear in the save request" do
         @mock_api.should_receive(:ingest).with(hash_including(:state => 'A'))
         @mock_api.should_receive(:object).with(:pid=>"pid").and_raise(RestClient::ResourceNotFound)
         subject.state='A'