ddr-models 3.0.0.beta.20 → 3.0.0.beta.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 83e427c337952549de62787a1e38025b6a41153e
-  data.tar.gz: 57656751812c73a3360e5122eddf22bc317f02f1
+  metadata.gz: a4e3d477eef945d6636d2efdfd19053988b54b7b
+  data.tar.gz: 9775e2a63e01749a0594c131803133e57e38156a
 SHA512:
-  metadata.gz: f27a59cee19c3b97e19a36347ee37aabd216d0a566cbb0cf840a998e80053d29d0a088e753d08fd8f6a3107be4be714ca30e9ae8542ce2db81a110253dc89089
-  data.tar.gz: cbe43fb12c173fc4c0eff9727d033ed60eea022b0a8d827cdae305a4a76995f7582e5fc61268ddcc2496b81f251526dcca482e625e3f25f4afd2dd74bb104a78
+  metadata.gz: d9180d73d0e6c23c52bba318e5cf823172531819fc16696ec885a342a2ffde4918fa97167bcd093d1a64f0c5f7a3d428c6dd83f4c494f72a8b757650541af58e
+  data.tar.gz: d04f18db69f8183c65d6eef39ccfe915a220b5b4914f9a20ecea5f5add682e78d9bb709d5d572c1ad5ce45a7281130a7197f2cf0ef44e1b4214af48ac33e1dda

data/lib/ddr/auth.rb

@@ -38,6 +38,7 @@ module Ddr
       autoload :DatastreamAbilityDefinitions
       autoload :EventAbilityDefinitions
       autoload :ItemAbilityDefinitions
+      autoload :LockAbilityDefinitions
       autoload :PublicationAbilityDefinitions
       autoload :RoleBasedAbilityDefinitions
       autoload :SuperuserAbilityDefinitions

data/lib/ddr/auth/ability.rb

@@ -10,7 +10,8 @@ module Ddr
                                    RoleBasedAbilityDefinitions,
                                    DatastreamAbilityDefinitions,
                                    EventAbilityDefinitions,
-                                   PublicationAbilityDefinitions ]
+                                   PublicationAbilityDefinitions,
+                                   LockAbilityDefinitions ]
 
     end
   end

data/lib/ddr/auth/ability_definitions/lock_ability_definitions.rb

@@ -0,0 +1,13 @@
+module Ddr
+  module Auth
+    class LockAbilityDefinitions < AbilityDefinitions
+
+      DENIED_WHEN_LOCKED = [ :add_children, :update, :replace, :arrange, :grant ]
+
+      def call
+        cannot DENIED_WHEN_LOCKED, Ddr::Models::Base, :locked? => true
+      end
+
+    end
+  end
+end

data/lib/ddr/index/fields.rb

@@ -35,6 +35,7 @@ module Ddr::Index
     IS_ATTACHED_TO              = Field.new :is_attached_to, solr_name: "isAttachedTo_ssim"
     IS_EXTERNAL_TARGET_FOR      = Field.new :is_external_target_for, solr_name: "isExternalTargetFor_ssim"
     IS_GOVERNED_BY              = Field.new :is_governed_by, solr_name: "isGovernedBy_ssim"
+    IS_LOCKED                   = Field.new :is_locked, :stored_sortable
     IS_MEMBER_OF_COLLECTION     = Field.new :is_member_of_collection, solr_name: "isMemberOfCollection_ssim"
     IS_PART_OF                  = Field.new :is_part_of, solr_name: "isPartOf_ssim"
     LAST_FIXITY_CHECK_ON        = Field.new :last_fixity_check_on, :stored_sortable, type: :date

data/lib/ddr/index/query.rb

@@ -5,6 +5,7 @@ module Ddr::Index
   class Query
     include Virtus.model
     extend Forwardable
+    extend Deprecation
 
     attribute :q,       String
     attribute :fields,  Array[FieldAttribute], default: [ ]
@@ -12,7 +13,7 @@ module Ddr::Index
     attribute :sort,    Array[String],         default: [ ]
     attribute :rows,    Integer
 
-    delegate [:count, :docs, :pids, :each_pid, :all] => :result
+    delegate [:count, :docs, :ids, :each_id, :all] => :result
     delegate :params => :query_params
 
     def initialize(**args, &block)
@@ -31,6 +32,16 @@ module Ddr::Index
       URI.encode_www_form(params)
     end
 
+    def pids
+      Deprecation.warn(QueryResult, "`pids` is deprecated; use `ids` instead.")
+      ids
+    end
+
+    def each_pid(&block)
+      Deprecation.warn(QueryResult, "`each_pid` is deprecated; use `each_id` instead.")
+      each_id(&block)
+    end
+
     def result
       QueryResult.new(self)
     end

data/lib/ddr/index/query_result.rb

@@ -1,5 +1,6 @@
 module Ddr::Index
   class QueryResult < AbstractQueryResult
+    extend Deprecation
 
     PAGE_SIZE = 1000
 
@@ -22,6 +23,11 @@ module Ddr::Index
     end
 
     def pids
+      Deprecation.warn(QueryResult, "`pids` is deprecated; use `ids` instead.")
+      ids
+    end
+
+    def ids
       Enumerator.new do |e|
         each do |doc|
           e << doc[Fields::ID]
@@ -30,7 +36,12 @@ module Ddr::Index
     end
 
     def each_pid(&block)
-      pids.each(&block)
+      Deprecation.warn(QueryResult, "`each_pid` is deprecated; use `each_id` instead.")
+      each_id(&block)
+    end
+
+    def each_id(&block)
+      ids.each(&block)
     end
 
     def docs

data/lib/ddr/models/has_admin_metadata.rb

@@ -37,6 +37,10 @@ module Ddr::Models
                predicate: RDF::URI("info:fedora/fedora-system:def/model#PID"),
                multiple: false
 
+      property :is_locked,
+               predicate: Ddr::Vocab::Asset.isLocked,
+               multiple: false
+
       property :license,
                predicate: RDF::Vocab::DC.license,
                multiple: false
@@ -119,6 +123,28 @@ module Ddr::Models
       end
     end
 
+    def locked?
+      !!is_locked
+    end
+
+    def lock
+      self.is_locked = true
+    end
+
+    def unlock
+      self.is_locked = false
+    end
+
+    def lock!
+      lock
+      save
+    end
+
+    def unlock!
+      unlock
+      save
+    end
+
     private
 
     def update_permanent_id_on_destroy

data/lib/ddr/models/indexing.rb

@@ -34,6 +34,7 @@ module Ddr
           FCREPO3_PID           => fcrepo3_pid,
           FORMAT_FACET          => desc_metadata.format,
           IDENTIFIER_ALL        => all_identifiers,
+          IS_LOCKED             => is_locked,
           LICENSE               => license,
           LOCAL_ID              => local_id,
           PERMANENT_ID          => permanent_id,
@@ -101,7 +102,7 @@ module Ddr
       end
 
       def all_identifiers
-        desc_metadata.identifier + [local_id, permanent_id, id].compact
+        desc_metadata.identifier + [fcrepo3_pid, local_id, permanent_id, id].compact
       end
 
       def associated_collection

data/lib/ddr/models/version.rb

@@ -1,5 +1,5 @@
 module Ddr
   module Models
-    VERSION = "3.0.0.beta.20"
+    VERSION = "3.0.0.beta.21"
   end
 end

data/lib/ddr/vocab/asset.rb

@@ -24,6 +24,9 @@
       property "multiresImageFilePath",
         label: "Multires Image File Path"
 
+      property "isLocked",
+        label: "Is Locked?"
+
     end
   end
 end

data/spec/auth/ability_spec.rb

@@ -210,6 +210,25 @@ module Ddr::Auth
 
     end
 
+    describe "locks" do
+      let(:obj) { Ddr::Models::Base.new }
+
+      describe "effects of locks on abilities" do
+        before do
+          allow(obj).to receive(:effective_permissions) { Permissions::ALL }
+          allow(obj).to receive(:locked?) { true }
+        end
+        it { should be_able_to(:read, obj) }
+        it { should be_able_to(:download, obj) }
+        it { should_not be_able_to(:add_children, obj) }
+        it { should_not be_able_to(:update, obj) }
+        it { should_not be_able_to(:replace, obj) }
+        it { should_not be_able_to(:arrange, obj) }
+        it { should be_able_to(:audit, obj) }
+        it { should_not be_able_to(:grant, obj) }
+      end
+    end
+
     describe "role based abilities" do
       shared_examples "it has role based abilities" do
         describe "when permissions are cached" do

data/spec/models/has_admin_metadata_spec.rb

@@ -198,23 +198,77 @@ module Ddr::Models
         end
       end
 
-      describe "contacts" do
-        before do
-          allow(Ddr::Models::Contact).to receive(:get).with(:find, slug: 'xa') do
-            {'id'=>1, 'slug'=>'xa', 'name'=>'Contact A', 'short_name'=>'A'}
-          end
-          allow(Ddr::Models::Contact).to receive(:get).with(:find, slug: 'yb') do
-            {'id'=>1, 'slug'=>'yb', 'name'=>'Contact B', 'short_name'=>'B'}
+    end
+
+    describe "contacts" do
+
+      subject { FactoryGirl.build(:item) }
+
+      before do
+        allow(Ddr::Models::Contact).to receive(:get).with(:find, slug: 'xa') do
+          {'id'=>1, 'slug'=>'xa', 'name'=>'Contact A', 'short_name'=>'A'}
+        end
+        allow(Ddr::Models::Contact).to receive(:get).with(:find, slug: 'yb') do
+          {'id'=>1, 'slug'=>'yb', 'name'=>'Contact B', 'short_name'=>'B'}
+        end
+      end
+      describe "#research_help" do
+        before { subject.research_help_contact = 'yb' }
+        it "should return the appropriate contact" do
+          expect(subject.research_help.slug).to eq('yb')
+        end
+      end
+    end
+
+    describe "locking" do
+
+      subject { FactoryGirl.build(:item) }
+
+      describe "#locked?" do
+        context "object is locked" do
+          before { subject.is_locked = true }
+          it "should be true" do
+            expect(subject.locked?).to be true
           end
         end
-        describe "#research_help" do
-          before { subject.research_help_contact = 'yb' }
-          it "should return the appropriate contact" do
-            expect(subject.research_help.slug).to eq('yb')
+        context "object is not locked" do
+          it "should be false" do
+            expect(subject.locked?).to be false
           end
         end
       end
 
+      describe "lock" do
+        it "should lock the object" do
+          expect { subject.lock }.to change(subject, :locked?).from(false).to(true)
+        end
+      end
+
+      describe "unlock" do
+        before { subject.lock }
+        it "should unlock the object" do
+          expect { subject.unlock }.to change(subject, :locked?).from(true).to(false)
+        end
+      end
+
+      describe "lock!" do
+        it "should lock and save the object" do
+          subject.lock!
+          subject.reload
+          expect(subject.locked?).to be true
+        end
+      end
+
+      describe "unlock!" do
+        before { subject.lock! }
+        it "should unlock and save the object" do
+          subject.unlock!
+          subject.reload
+          expect(subject.locked?).to be false
+        end
+      end
+
     end
+
   end
 end

data/spec/support/shared_examples_for_ddr_models.rb

@@ -101,17 +101,18 @@ RSpec.shared_examples "a DDR model" do
 
   describe "#all_identifiers" do
     subject { described_class.new(id: 'test-3') }
-    context "when it has descriptive identifiers, local ID, permanent ID, and id" do
+    context "when it has descriptive identifiers, Fedora 3 PID, local ID, permanent ID, and id" do
       before do
         subject.desc_metadata.identifier = [ 'ID001', 'ID002' ]
+        subject.fcrepo3_pid = 'test:92'
         subject.local_id = 'LOCAL_ID_A'
         subject.permanent_id = 'ark:/999999/cd3'
       end
       its(:all_identifiers) {
-        is_expected.to match_array([ 'ID001', 'ID002', 'LOCAL_ID_A', 'ark:/999999/cd3', 'test-3' ])
+        is_expected.to match_array([ 'ID001', 'ID002', 'test:92', 'LOCAL_ID_A', 'ark:/999999/cd3', 'test-3' ])
       }
     end
-    context "when it has no descriptive identifiers or local ID" do
+    context "when it has no descriptive identifiers, Fedora 3 PID, or local ID" do
       before { subject.permanent_id = 'ark:/999999/cd3' }
       its(:all_identifiers) {
         is_expected.to match_array([ 'ark:/999999/cd3', 'test-3' ])

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ddr-models
 version: !ruby/object:Gem::Version
-  version: 3.0.0.beta.20
+  version: 3.0.0.beta.21
 platform: ruby
 authors:
 - Jim Coble
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-29 00:00:00.000000000 Z
+date: 2016-04-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -424,6 +424,7 @@ files:
 - lib/ddr/auth/ability_definitions/datastream_ability_definitions.rb
 - lib/ddr/auth/ability_definitions/event_ability_definitions.rb
 - lib/ddr/auth/ability_definitions/item_ability_definitions.rb
+- lib/ddr/auth/ability_definitions/lock_ability_definitions.rb
 - lib/ddr/auth/ability_definitions/publication_ability_definitions.rb
 - lib/ddr/auth/ability_definitions/role_based_ability_definitions.rb
 - lib/ddr/auth/ability_definitions/superuser_ability_definitions.rb