hyrax 2.9.5 → 3.0.0.pre.beta1

data/spec/models/hyrax/download_spec.rb

@@ -0,0 +1,13 @@
+RSpec.describe Hyrax::Download, type: :model do
+  it 'has an events metric' do
+    expect(described_class.metrics).to be == Legato::ListParameter.new(:metrics, [:totalEvents])
+  end
+
+  it 'has dimensions' do
+    expect(described_class.dimensions).to be == Legato::ListParameter.new(:dimensions, [:eventCategory, :eventAction, :eventLabel, :date])
+  end
+
+  it 'responds to :for_file' do
+    expect(described_class).to respond_to(:for_file)
+  end
+end

data/spec/models/hyrax/operation_spec.rb

@@ -0,0 +1,123 @@
+RSpec.describe Hyrax::Operation do
+  describe '#status' do
+    it 'is protected by enum enforcement' do
+      expect { described_class.new(status: 'not_valid') }.to raise_error(ArgumentError)
+    end
+
+    # Because the Rails documentation says "Declare an enum attribute where the values map to integers in the database, but can be queried by name." but appears to not be the case.
+    it 'is persisted as a string' do
+      create(:operation, :pending)
+      values = described_class.connection.execute("SELECT * FROM #{described_class.quoted_table_name}")
+      expect(values.first.fetch('status')).to eq(described_class::PENDING)
+    end
+  end
+
+  describe '#rollup_messages' do
+    subject { operation.rollup_messages }
+
+    context 'with no message and no children' do
+      let(:operation) { create(:operation, :failing, message: nil) }
+
+      it { is_expected.to eq [] }
+    end
+    context 'with a message and no children' do
+      let(:operation) { create(:operation, :failing, message: 'A bad thing!') }
+
+      it { is_expected.to eq ['A bad thing!'] }
+    end
+    context 'with a message and children with messages' do
+      let(:operation) { create(:operation, :failing, message: 'A bad thing!') }
+      let(:child1) { create(:operation, :failing, message: 'Foo!') }
+      let(:child2) { create(:operation, :failing, message: 'Bar!') }
+
+      before do
+        allow(operation).to receive(:children).and_return([child1, child2])
+      end
+
+      it { is_expected.to match_array ['A bad thing!', 'Foo!', 'Bar!'] }
+    end
+  end
+
+  describe "#rollup_status" do
+    let(:parent) { create(:operation, :pending) }
+
+    describe "with a pending process" do
+      let!(:child1) { create(:operation, :failing, parent: parent) }
+      let!(:child2) { create(:operation, :pending, parent: parent) }
+
+      it "sets status to pending" do
+        parent.rollup_status
+        expect(parent.status).to eq Hyrax::Operation::PENDING
+      end
+    end
+
+    describe "with only failing processes" do
+      let(:grandparent) { create(:operation, :pending) }
+      let(:parent) { create(:operation, :pending, parent: grandparent) }
+      let!(:child1) { create(:operation, :failing, parent: parent) }
+
+      it "sets status to fail and roll_up to the parent" do
+        # Without this line the `expect(grandparent).to receive(:fail!)` fails
+        allow(parent).to receive(:parent).and_return(grandparent)
+        expect(grandparent).to receive(:fail!)
+        parent.rollup_status
+        expect(parent.status).to eq Hyrax::Operation::FAILURE
+      end
+    end
+
+    describe "with a failure" do
+      let!(:child1) { create(:operation, :failing, parent: parent) }
+      let!(:child2) { create(:operation, :successful, parent: parent) }
+
+      it "sets status to failure" do
+        parent.rollup_status
+        expect(parent.status).to eq Hyrax::Operation::FAILURE
+      end
+    end
+
+    describe "with a successes" do
+      let!(:child1) { create(:operation, :successful, parent: parent) }
+      let!(:child2) { create(:operation, :successful, parent: parent) }
+
+      it "sets status to success" do
+        parent.rollup_status
+        expect(parent.status).to eq Hyrax::Operation::SUCCESS
+      end
+    end
+  end
+
+  describe "performing!" do
+    it "changes the status to performing" do
+      subject.performing!
+      expect(subject.status).to eq Hyrax::Operation::PERFORMING
+    end
+  end
+
+  describe "success!" do
+    subject { create(:operation, :pending, parent: parent) }
+
+    let(:parent) { create(:operation, :pending) }
+
+    it "changes the status to SUCCESS and rolls the status up to the parent" do
+      # Without this line the `expect(parent).to receive(:rollup_status)` fails
+      allow(subject).to receive(:parent).and_return(parent)
+      expect(parent).to receive(:rollup_status)
+      subject.success!
+      expect(subject.status).to eq Hyrax::Operation::SUCCESS
+    end
+  end
+
+  describe "fail!" do
+    subject { create(:operation, :pending, parent: parent) }
+
+    let(:parent) { create(:operation, :pending) }
+
+    it "changes the status to FAILURE and rolls the status up to the parent" do
+      # Without this line the `expect(parent).to receive(:rollup_status)` fails
+      allow(subject).to receive(:parent).and_return(parent)
+      expect(parent).to receive(:rollup_status)
+      subject.fail!
+      expect(subject.status).to eq Hyrax::Operation::FAILURE
+    end
+  end
+end

data/spec/models/hyrax/pageview_spec.rb

@@ -0,0 +1,13 @@
+RSpec.describe Hyrax::Pageview, type: :model do
+  it 'has a pageviews metric' do
+    expect(described_class.metrics).to be == Legato::ListParameter.new(:metrics, [:pageviews])
+  end
+
+  it 'has a date dimension' do
+    expect(described_class.dimensions).to be == Legato::ListParameter.new(:dimensions, [:date])
+  end
+
+  it 'responds to :for_path' do
+    expect(described_class).to respond_to(:for_path)
+  end
+end

data/spec/models/hyrax/permission_template_access_spec.rb

@@ -0,0 +1,180 @@
+RSpec.describe Hyrax::PermissionTemplateAccess do
+  let(:permission_template) { create(:permission_template) }
+  let(:permission_template_access) do
+    create(:permission_template_access,
+           :manage,
+           permission_template: permission_template,
+           agent_type: agent_type,
+           agent_id: agent_id)
+  end
+
+  subject { permission_template_access }
+
+  context 'with the admin users group' do
+    let(:agent_type) { 'group' }
+    let(:agent_id) { 'admin' }
+
+    describe '#label' do
+      it 'returns the repo admins label' do
+        expect(subject.label).to eq 'Repository Administrators'
+      end
+    end
+    describe '#admin_group?' do
+      it 'returns true' do
+        expect(subject).to be_admin_group
+      end
+    end
+    describe '#destroy' do
+      it 'destroys the permission template access record' do
+        subject.destroy
+        expect(subject).to be_destroyed
+      end
+    end
+  end
+
+  context 'with an agent that is not the admin users group' do
+    let(:agent_type) { 'user' }
+    let(:agent_id) { 'foobar' }
+
+    describe '#label' do
+      it 'returns the repo admins label' do
+        expect(subject.label).to eq agent_id
+      end
+    end
+    describe '#admin_group?' do
+      it 'returns true' do
+        expect(subject).not_to be_admin_group
+      end
+    end
+    describe '#destroy' do
+      it 'carries out the destroy operation' do
+        subject.destroy
+        expect(subject).to be_destroyed
+        expect(subject.errors).to be_empty
+      end
+    end
+  end
+
+  context 'with a user that is an admin set viewer' do
+    let(:agent_type) { 'user' }
+    let(:agent_id) { 'foobar' }
+
+    let(:permission_template_access) do
+      create(:permission_template_access,
+             :view,
+             permission_template: permission_template,
+             agent_type: agent_type,
+             agent_id: agent_id)
+    end
+
+    subject { permission_template_access }
+
+    describe '#label' do
+      it 'returns the user label' do
+        expect(subject.label).to eq agent_id
+      end
+    end
+    describe '#admin_group?' do
+      it 'returns true' do
+        expect(subject).not_to be_admin_group
+      end
+    end
+    describe '#destroy' do
+      it 'carries out the destroy operation' do
+        subject.destroy
+        expect(subject).to be_destroyed
+        expect(subject.errors).to be_empty
+      end
+    end
+  end
+
+  context 'with a user that is an admin set depositor' do
+    let(:agent_type) { 'user' }
+    let(:agent_id) { 'foobar' }
+
+    let(:permission_template_access) do
+      create(:permission_template_access,
+             :deposit,
+             permission_template: permission_template,
+             agent_type: agent_type,
+             agent_id: agent_id)
+    end
+
+    subject { permission_template_access }
+
+    describe '#label' do
+      it 'returns the user label' do
+        expect(subject.label).to eq agent_id
+      end
+    end
+    describe '#admin_group?' do
+      it 'returns true' do
+        expect(subject).not_to be_admin_group
+      end
+    end
+    describe '#destroy' do
+      it 'carries out the destroy operation' do
+        subject.destroy
+        expect(subject).to be_destroyed
+        expect(subject.errors).to be_empty
+      end
+    end
+  end
+
+  context 'with a user that is an admin set manager' do
+    let(:agent_type) { 'user' }
+    let(:agent_id) { 'foobar' }
+
+    let(:permission_template_access) do
+      create(:permission_template_access,
+             :manage,
+             permission_template: permission_template,
+             agent_type: agent_type,
+             agent_id: agent_id)
+    end
+
+    subject { permission_template_access }
+
+    describe '#label' do
+      it 'returns the user label' do
+        expect(subject.label).to eq agent_id
+      end
+    end
+    describe '#admin_group?' do
+      it 'returns true' do
+        expect(subject).not_to be_admin_group
+      end
+    end
+    describe '#destroy' do
+      it 'carries out the destroy operation' do
+        subject.destroy
+        expect(subject).to be_destroyed
+        expect(subject.errors).to be_empty
+      end
+    end
+  end
+
+  describe "duplicate records" do
+    let(:permission_template) { create(:permission_template) }
+    let(:agent_type) { 'user' }
+    let(:agent_id) { 'foobar' }
+
+    before do
+      create(:permission_template_access,
+             :view,
+             permission_template: permission_template,
+             agent_type: agent_type,
+             agent_id: agent_id)
+    end
+
+    subject do
+      build(:permission_template_access,
+            :view,
+            permission_template: permission_template,
+            agent_type: agent_type,
+            agent_id: agent_id)
+    end
+
+    it { is_expected.not_to be_valid }
+  end
+end

data/spec/models/hyrax/permission_template_spec.rb

@@ -0,0 +1,291 @@
+RSpec.describe Hyrax::PermissionTemplate, :clean_repo do
+  let(:admin_set) { create(:admin_set) }
+  let(:collection) { create(:collection) }
+  let(:permission_template) { described_class.new(attributes) }
+  let(:attributes) { { source_id: admin_set.id } }
+
+  subject { permission_template }
+
+  it { is_expected.to have_many(:available_workflows).dependent(:destroy) }
+  it { is_expected.to have_one(:active_workflow).conditions(active: true).dependent(nil) }
+  it { is_expected.to have_many(:access_grants).dependent(:destroy) }
+
+  describe 'factories' do
+    context 'with_admin_set parameter' do
+      it 'will create an AdminSet when true' do
+        permission_template = create(:permission_template, with_admin_set: true)
+        expect(permission_template.admin_set).to be_persisted
+      end
+      it 'will not persist an AdminSet when false (or not given)' do
+        permission_template = create(:permission_template, with_admin_set: false)
+        expect { permission_template.admin_set }.to raise_error(ActiveFedora::ObjectNotFoundError)
+      end
+    end
+
+    context 'with_collection parameter' do
+      it 'will create an Collection when true' do
+        permission_template = create(:permission_template, with_collection: true)
+        expect(permission_template.collection).to be_persisted
+      end
+      it 'will not persist an Collection when false (or not given)' do
+        permission_template = create(:permission_template, with_collection: false)
+        expect { permission_template.collection }.to raise_error(ActiveFedora::ObjectNotFoundError)
+      end
+    end
+
+    context 'with_workflows parameter' do
+      it 'will create the workflow when set true' do
+        expect { create(:permission_template, with_workflows: true) }.to change { Sipity::Workflow.count }
+      end
+      it 'will not create the workflow when false (or not given)' do
+        expect { create(:permission_template, with_workflows: false) }.not_to change { Sipity::Workflow.count }
+      end
+    end
+
+    context 'with_active_workflow parameter' do
+      it 'will create the workflow when set true' do
+        expect { create(:permission_template, with_active_workflow: true) }.to change { Sipity::Workflow.count }.by(1)
+      end
+      it 'will not create the workflow when false (or not given)' do
+        expect { create(:permission_template, with_active_workflow: false) }.not_to change { Sipity::Workflow.count }
+      end
+    end
+  end
+
+  describe '#agent_ids_for' do
+    it 'queries the underlying access_grants' do
+      template = create(:permission_template)
+      to_find = template.access_grants.create!(agent_type: 'user', access: 'manage', agent_id: '123')
+      template.access_grants.create!(agent_type: 'user', access: 'view', agent_id: '456')
+      template.access_grants.create!(agent_type: 'group', access: 'manage', agent_id: '789')
+
+      expect(template.agent_ids_for(agent_type: 'user', access: 'manage')).to eq([to_find.agent_id])
+    end
+  end
+
+  describe "#source_model" do
+    context 'when source is an AdminSet' do
+      let(:as_permission_template) { described_class.new(as_attributes) }
+      let(:as_attributes) { { source_id: admin_set.id } }
+
+      before do
+        allow(AdminSet).to receive(:find).with(as_permission_template.source_id).and_return(admin_set)
+      end
+
+      it 'returns an AdminSet if the source_type is admin_set for the given permission_template' do
+        expect(as_permission_template.source_model).to be_kind_of(AdminSet)
+        expect(as_permission_template.source_model).to eq(admin_set)
+      end
+    end
+
+    context 'when source is a Collection' do
+      let(:col_permission_template) { described_class.new(col_attributes) }
+      let(:col_attributes) { { source_id: collection.id } }
+
+      before do
+        allow(Collection).to receive(:find).with(col_permission_template.source_id).and_return(collection)
+      end
+
+      it 'returns a Collection if the source_type is collection for the given permission_template' do
+        expect(col_permission_template.source_model).to be_kind_of(Collection)
+        expect(col_permission_template.source_model).to eq(collection)
+      end
+    end
+  end
+
+  describe "#admin_set" do
+    it 'leverages AdminSet.find for the given permission_template' do
+      expect(AdminSet).to receive(:find).with(permission_template.source_id).and_return(admin_set)
+      expect(permission_template.admin_set).to eq(admin_set)
+    end
+  end
+
+  describe "#collection" do
+    let(:col_permission_template) { described_class.new(col_attributes) }
+    let(:col_attributes) { { source_id: collection.id } }
+
+    before do
+      allow(Collection).to receive(:find).with(col_permission_template.source_id).and_return(collection)
+    end
+
+    it 'leverages Collection.find for the given permission_template' do
+      expect(col_permission_template.collection).to be_kind_of(Collection)
+      expect(col_permission_template.collection).to eq(collection)
+    end
+  end
+
+  describe "#release_fixed_date?" do
+    subject { permission_template.release_fixed_date? }
+
+    context "with release_period='fixed'" do
+      let(:attributes) { { source_id: admin_set.id, release_period: Hyrax::PermissionTemplate::RELEASE_TEXT_VALUE_FIXED } }
+
+      it { is_expected.to be true }
+    end
+    context "with other release_period" do
+      let(:attributes) { { source_id: admin_set.id, release_period: Hyrax::PermissionTemplate::RELEASE_TEXT_VALUE_NO_DELAY } }
+
+      it { is_expected.to be false }
+    end
+  end
+
+  describe "#release_no_delay?" do
+    subject { permission_template.release_no_delay? }
+
+    context "with release_period='now'" do
+      let(:attributes) { { source_id: admin_set.id, release_period: Hyrax::PermissionTemplate::RELEASE_TEXT_VALUE_NO_DELAY } }
+
+      it { is_expected.to be true }
+    end
+    context "with other release_period" do
+      let(:attributes) { { source_id: admin_set.id, release_period: Hyrax::PermissionTemplate::RELEASE_TEXT_VALUE_FIXED } }
+
+      it { is_expected.to be false }
+    end
+  end
+
+  describe "#release_before_date?" do
+    subject { permission_template.release_before_date? }
+
+    context "with release_period='before'" do
+      let(:attributes) { { source_id: admin_set.id, release_period: Hyrax::PermissionTemplate::RELEASE_TEXT_VALUE_BEFORE_DATE } }
+
+      it { is_expected.to be true }
+    end
+    context "with maximum embargo period (release_period of 1 year)" do
+      let(:attributes) { { source_id: admin_set.id, release_period: Hyrax::PermissionTemplate::RELEASE_TEXT_VALUE_1_YEAR } }
+
+      it { is_expected.to be true }
+    end
+    context "with other release_period" do
+      let(:attributes) { { source_id: admin_set.id, release_period: Hyrax::PermissionTemplate::RELEASE_TEXT_VALUE_FIXED } }
+
+      it { is_expected.to be false }
+    end
+  end
+
+  describe "#release_max_embargo?" do
+    subject { permission_template.release_max_embargo? }
+
+    context "with release_period of 1 year" do
+      let(:attributes) { { source_id: admin_set.id, release_period: Hyrax::PermissionTemplate::RELEASE_TEXT_VALUE_1_YEAR } }
+
+      it { is_expected.to be true }
+    end
+    context "with release_period of 2 years" do
+      let(:attributes) { { source_id: admin_set.id, release_period: Hyrax::PermissionTemplate::RELEASE_TEXT_VALUE_2_YEARS } }
+
+      it { is_expected.to be true }
+    end
+    context "with other release_period" do
+      let(:attributes) { { source_id: admin_set.id, release_period: Hyrax::PermissionTemplate::RELEASE_TEXT_VALUE_FIXED } }
+
+      it { is_expected.to be false }
+    end
+  end
+
+  describe "#release_date" do
+    subject { permission_template.release_date }
+
+    let(:today) { Time.zone.today }
+
+    context "with today and release_fixed_date?" do
+      let(:attributes) { { source_id: admin_set.id, release_period: Hyrax::PermissionTemplate::RELEASE_TEXT_VALUE_FIXED, release_date: today } }
+
+      it { is_expected.to eq today }
+    end
+    context "with today and release_before_date?" do
+      let(:attributes) { { source_id: admin_set.id, release_period: Hyrax::PermissionTemplate::RELEASE_TEXT_VALUE_BEFORE_DATE, release_date: today } }
+
+      it { is_expected.to eq today }
+    end
+    context "with release_period of 6 months" do
+      let(:attributes) { { source_id: admin_set.id, release_period: Hyrax::PermissionTemplate::RELEASE_TEXT_VALUE_6_MONTHS } }
+
+      it { is_expected.to eq today + 6.months }
+    end
+    context "with release_period of 1 year" do
+      let(:attributes) { { source_id: admin_set.id, release_period: Hyrax::PermissionTemplate::RELEASE_TEXT_VALUE_1_YEAR } }
+
+      it { is_expected.to eq today + 1.year }
+    end
+    context "with release_no_delay?" do
+      let(:attributes) { { source_id: admin_set.id, release_period: Hyrax::PermissionTemplate::RELEASE_TEXT_VALUE_NO_DELAY } }
+
+      it { is_expected.to eq today }
+    end
+  end
+
+  describe "#valid_release_date?" do
+    let(:date) { Time.zone.today + 6.months }
+
+    subject { permission_template.valid_release_date?(date) }
+
+    context "with any release date and one is not required" do
+      let(:attributes) { { source_id: admin_set.id } }
+
+      it { is_expected.to eq true }
+    end
+    context "with matching date and release_fixed_date?" do
+      let(:attributes) { { source_id: admin_set.id, release_period: Hyrax::PermissionTemplate::RELEASE_TEXT_VALUE_FIXED, release_date: date } }
+
+      it { is_expected.to eq true }
+    end
+    context "with non-matching date and release_fixed_date?" do
+      let(:attributes) { { source_id: admin_set.id, release_period: Hyrax::PermissionTemplate::RELEASE_TEXT_VALUE_FIXED, release_date: date + 1.day } }
+
+      it { is_expected.to eq false }
+    end
+    context "with exact match date and release_before_date?" do
+      let(:attributes) { { source_id: admin_set.id, release_period: Hyrax::PermissionTemplate::RELEASE_TEXT_VALUE_BEFORE_DATE, release_date: date } }
+
+      it { is_expected.to eq true }
+    end
+    context "with future, valid date and release_before_date?" do
+      let(:date) { Time.zone.today + 1.day }
+      let(:attributes) { { source_id: admin_set.id, release_period: Hyrax::PermissionTemplate::RELEASE_TEXT_VALUE_BEFORE_DATE, release_date: Time.zone.today + 1.month } }
+
+      it { is_expected.to eq true }
+    end
+    context "with future, invalid date and release_before_date?" do
+      let(:date) { Time.zone.today + 1.year }
+      let(:attributes) { { source_id: admin_set.id, release_period: Hyrax::PermissionTemplate::RELEASE_TEXT_VALUE_BEFORE_DATE, release_date: Time.zone.today + 1.month } }
+
+      it { is_expected.to eq false }
+    end
+    context "with today release and release_no_delay?" do
+      let(:date) { Time.zone.today }
+      let(:attributes) { { source_id: admin_set.id, release_period: Hyrax::PermissionTemplate::RELEASE_TEXT_VALUE_NO_DELAY } }
+
+      it { is_expected.to eq true }
+    end
+    context "with tomorrow release and release_no_delay?" do
+      let(:date) { Time.zone.today + 1.day }
+      let(:attributes) { { source_id: admin_set.id, release_period: Hyrax::PermissionTemplate::RELEASE_TEXT_VALUE_NO_DELAY } }
+
+      it { is_expected.to eq false }
+    end
+  end
+
+  describe "#valid_visibility?" do
+    let(:visibility) { Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_PUBLIC }
+
+    subject { permission_template.valid_visibility?(visibility) }
+
+    context "with matching visibility" do
+      let(:attributes) { { source_id: admin_set.id, visibility: Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_PUBLIC } }
+
+      it { is_expected.to eq true }
+    end
+    context "with non-matching visibility" do
+      let(:attributes) { { source_id: admin_set.id, visibility: Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_AUTHENTICATED } }
+
+      it { is_expected.to eq false }
+    end
+    context "with visibility when none required" do
+      let(:attributes) { { source_id: admin_set.id } }
+
+      it { is_expected.to eq true }
+    end
+  end
+end