hyrax 0.0.0 → 1.0.0.rc1

data/spec/models/file_view_stat_spec.rb

@@ -0,0 +1,80 @@
+RSpec.describe FileViewStat, type: :model do
+  let(:file_id) { file.id }
+  let(:user_id) { 123 }
+  let(:date) { Time.current }
+  let(:file_stat) { described_class.create(views: "25", date: date, file_id: file_id, user_id: user_id) }
+  let(:file) { mock_model(FileSet, id: 99) }
+
+  it "has attributes" do
+    expect(file_stat).to respond_to(:views)
+    expect(file_stat).to respond_to(:date)
+    expect(file_stat).to respond_to(:file_id)
+    expect(file_stat.file_id).to eq("99")
+    expect(file_stat.date).to eq(date)
+    expect(file_stat.views).to eq(25)
+    expect(file_stat.user_id).to eq(user_id)
+  end
+
+  describe "#statistics" do
+    let(:dates) do
+      ldates = []
+      4.downto(0) { |idx| ldates << (Time.zone.today - idx.day) }
+      ldates
+    end
+    let(:date_strs) do
+      dates.map { |date| date.strftime("%Y%m%d") }
+    end
+
+    let(:view_output) do
+      [[statistic_date(dates[0]), 4], [statistic_date(dates[1]), 8], [statistic_date(dates[2]), 6], [statistic_date(dates[3]), 10]]
+    end
+
+    # This is what the data looks like that's returned from Google Analytics (GA) via the Legato gem
+    # Due to the nature of querying GA, testing this data in an automated fashion is problematc.
+    # Sample data structures were created by sending real events to GA from a test instance of
+    # Scholarsphere.  The data below are essentially a "cut and paste" from the output of query
+    # results from the Legato gem.
+    let(:sample_pageview_statistics) do
+      [
+        OpenStruct.new(date: date_strs[0], pageviews: 4),
+        OpenStruct.new(date: date_strs[1], pageviews: 8),
+        OpenStruct.new(date: date_strs[2], pageviews: 6),
+        OpenStruct.new(date: date_strs[3], pageviews: 10)
+      ]
+    end
+    describe "cache empty" do
+      let(:stats) do
+        expect(described_class).to receive(:ga_statistics).and_return(sample_pageview_statistics)
+        described_class.statistics(file, Time.zone.today - 4.days, user_id)
+      end
+
+      it "includes cached ga data" do
+        expect(stats.map(&:to_flot)).to include(*view_output)
+      end
+
+      it "caches data" do
+        expect(stats.map(&:to_flot)).to include(*view_output)
+        expect(stats.first.user_id).to eq user_id
+
+        # at this point all data should be cached
+        allow(described_class).to receive(:ga_statistics).with(Time.zone.today, file).and_raise("We should not call Google Analytics All data should be cached!")
+
+        stats2 = described_class.statistics(file, Time.zone.today - 5.days)
+        expect(stats2.map(&:to_flot)).to include(*view_output)
+      end
+    end
+
+    describe "cache loaded" do
+      let!(:file_view_stat) { described_class.create(date: (Time.zone.today - 5.days).to_datetime, file_id: file_id, views: "25") }
+
+      let(:stats) do
+        expect(described_class).to receive(:ga_statistics).and_return(sample_pageview_statistics)
+        described_class.statistics(file, Time.zone.today - 5.days)
+      end
+
+      it "includes cached data" do
+        expect(stats.map(&:to_flot)).to include([file_view_stat.date.to_i * 1000, file_view_stat.views], *view_output)
+      end
+    end
+  end
+end

data/spec/models/flipflop_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+
+RSpec.describe Flipflop do
+  describe "assign_admin_set?" do
+    subject { described_class.assign_admin_set? }
+    it "defaults to true" do
+      is_expected.to be true
+    end
+  end
+
+  describe "proxy_deposit?" do
+    subject { described_class.proxy_deposit? }
+    it "defaults to true" do
+      is_expected.to be true
+    end
+  end
+
+  describe "transfer_works?" do
+    subject { described_class.transfer_works? }
+    it "defaults to true" do
+      is_expected.to be true
+    end
+  end
+end

data/spec/models/generic_work_spec.rb

@@ -0,0 +1,151 @@
+describe GenericWork do
+  it 'has a title' do
+    subject.title = ['foo']
+    expect(subject.title).to eq ['foo']
+  end
+
+  describe '#active_workflow' do
+    it 'leverages "Sipity::Workflow.find_active_workflow_for"' do
+      expect(Sipity::Workflow).to receive(:find_active_workflow_for)
+      subject.active_workflow
+    end
+  end
+
+  describe '.model_name' do
+    subject { described_class.model_name.singular_route_key }
+    it { is_expected.to eq 'hyrax_generic_work' }
+  end
+
+  describe ".properties" do
+    subject { described_class.properties.keys }
+    it { is_expected.to include("has_model", "create_date", "modified_date") }
+  end
+
+  describe "to_sipity_entity" do
+    let(:state) { FactoryGirl.create(:workflow_state) }
+    let(:work) { create(:work) }
+    before do
+      Sipity::Entity.create!(proxy_for_global_id: work.to_global_id.to_s,
+                             workflow_state: state,
+                             workflow: state.workflow)
+    end
+    subject { work.to_sipity_entity }
+    it { is_expected.to be_kind_of Sipity::Entity }
+  end
+
+  describe '#state' do
+    let(:work) { described_class.new(state: inactive) }
+    let(:inactive) { ::RDF::URI('http://fedora.info/definitions/1/0/access/ObjState#inactive') }
+    subject { work.state.rdf_subject }
+    it { is_expected.to eq inactive }
+  end
+
+  describe '#suppressed?' do
+    let(:work) { described_class.new(state: state) }
+    context "when state is inactive" do
+      let(:state) { ::RDF::URI('http://fedora.info/definitions/1/0/access/ObjState#inactive') }
+      it 'is suppressed' do
+        expect(work).to be_suppressed
+      end
+    end
+
+    context "when the state is active" do
+      let(:state) { ::RDF::URI('http://fedora.info/definitions/1/0/access/ObjState#active') }
+      it 'is not suppressed' do
+        expect(work).not_to be_suppressed
+      end
+    end
+
+    context "when the state is nil" do
+      let(:state) { nil }
+      it 'is not suppressed' do
+        expect(work).not_to be_suppressed
+      end
+    end
+  end
+
+  describe "created for someone (proxy)" do
+    let(:work) { described_class.new(title: ['demoname']) { |gw| gw.apply_depositor_metadata("user") } }
+    let(:transfer_to) { create(:user) }
+
+    it "transfers the request" do
+      work.on_behalf_of = transfer_to.user_key
+      expect(ContentDepositorChangeEventJob).to receive(:perform_later).once
+      work.save!
+    end
+  end
+
+  describe "delegations" do
+    let(:work) { described_class.new { |gw| gw.apply_depositor_metadata("user") } }
+    let(:proxy_depositor) { create(:user) }
+    before do
+      work.proxy_depositor = proxy_depositor.user_key
+    end
+    it "includes proxies" do
+      expect(work).to respond_to(:relative_path)
+      expect(work).to respond_to(:depositor)
+      expect(work.proxy_depositor).to eq proxy_depositor.user_key
+    end
+  end
+
+  describe "trophies" do
+    let(:user) { create(:user) }
+    let(:w) { create(:work, user: user) }
+    let!(:t) { Trophy.create(user_id: user.id, work_id: w.id) }
+
+    it "has a trophy" do
+      expect(Trophy.where(work_id: w.id).count).to eq 1
+    end
+    it "removes all trophies when work is deleted" do
+      w.destroy
+      expect(Trophy.where(work_id: w.id).count).to eq 0
+    end
+  end
+
+  describe "featured works" do
+    let(:work) { create(:public_work) }
+    before { FeaturedWork.create(work_id: work.id) }
+
+    subject { work }
+    it { is_expected.to be_featured }
+
+    context "when a previously featured work is deleted" do
+      it "deletes the featured work as well" do
+        expect { work.destroy }.to change { FeaturedWork.all.count }.from(1).to(0)
+      end
+    end
+
+    context "when the work becomes private" do
+      it "deletes the featured work" do
+        expect do
+          work.visibility = Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_PRIVATE
+          work.save!
+        end.to change { FeaturedWork.all.count }.from(1).to(0)
+        expect(work).not_to be_featured
+      end
+    end
+  end
+
+  describe "metadata" do
+    it "has descriptive metadata" do
+      expect(subject).to respond_to(:relative_path)
+      expect(subject).to respond_to(:depositor)
+      expect(subject).to respond_to(:related_url)
+      expect(subject).to respond_to(:based_near)
+      expect(subject).to respond_to(:part_of)
+      expect(subject).to respond_to(:contributor)
+      expect(subject).to respond_to(:creator)
+      expect(subject).to respond_to(:title)
+      expect(subject).to respond_to(:description)
+      expect(subject).to respond_to(:publisher)
+      expect(subject).to respond_to(:date_created)
+      expect(subject).to respond_to(:date_uploaded)
+      expect(subject).to respond_to(:date_modified)
+      expect(subject).to respond_to(:subject)
+      expect(subject).to respond_to(:language)
+      expect(subject).to respond_to(:rights)
+      expect(subject).to respond_to(:resource_type)
+      expect(subject).to respond_to(:identifier)
+    end
+  end
+end

data/spec/models/hyrax/download_spec.rb

@@ -0,0 +1,13 @@
+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,90 @@
+require 'spec_helper'
+
+describe Hyrax::Operation do
+  context '#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_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 @@
+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_spec.rb

@@ -0,0 +1,198 @@
+describe Hyrax::PermissionTemplate do
+  let(:admin_set) { create(:admin_set) }
+  let(:permission_template) { described_class.new(attributes) }
+  let(:attributes) { { admin_set_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_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: 'read', 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 "#admin_set" do
+    it 'leverages AdminSet.find for the given permission_template' do
+      expect(AdminSet).to receive(:find).with(permission_template.admin_set_id).and_return(admin_set)
+      expect(permission_template.admin_set).to eq(admin_set)
+    end
+  end
+
+  describe "#release_fixed_date?" do
+    subject { permission_template.release_fixed_date? }
+    context "with release_period='fixed'" do
+      let(:attributes) { { admin_set_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) { { admin_set_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) { { admin_set_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) { { admin_set_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) { { admin_set_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) { { admin_set_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) { { admin_set_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) { { admin_set_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) { { admin_set_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) { { admin_set_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) { { admin_set_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) { { admin_set_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) { { admin_set_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) { { admin_set_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) { { admin_set_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) { { admin_set_id: admin_set.id } }
+      it { is_expected.to eq true }
+    end
+    context "with matching date and release_fixed_date?" do
+      let(:attributes) { { admin_set_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) { { admin_set_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) { { admin_set_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) { { admin_set_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) { { admin_set_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) { { admin_set_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) { { admin_set_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) { { admin_set_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) { { admin_set_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) { { admin_set_id: admin_set.id } }
+      it { is_expected.to eq true }
+    end
+  end
+end