hydra-access-controls 11.0.6 → 12.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9a286d397032ccf1ba4e2df1ea63470a75184cc7f7f98ed053663d33f593683c
-  data.tar.gz: a4c7de8fa18771222b5710bb954ad59c3011420ed7f3b02bc241105559712962
+  metadata.gz: 399d12c5e3bbaf7a4f7f89b834803ba68bfa9f6a28d6e8ee95c0cb3d6a1d745b
+  data.tar.gz: ed68661ab7b6182930000473102723a6ad0e6f82c9fe671aac7c2f03a3597fd4
 SHA512:
-  metadata.gz: 9647db12b9efdac6049bc6fd770e200b4e9f28e1a8d5e5f8e357f8a8020d5390bd68eb0cc03bda037dc0a4d1db89048dcba5c9db387086d98e0474d770302a81
-  data.tar.gz: cffcd8456b9e636e4e4957fc02a1709c3fad8764658205ea851bebdc7109bb2f68a7ea8e56f8343bcce33301446dbe29daa02fe47582067291b3894a2108f0c4
+  metadata.gz: d0c2cf3c21d32ae7b5cf3aeb72116603cd614340f3409b9b69aaff4d8a09760bf18f01164775cd2ff628d522b53e8e8b530c6ea82159003e53dd107d48bfe109
+  data.tar.gz: bd228f09270e9a1b08c315db330413f42e530a1e6964e324ef56f86e504758ee7964edfca8a8504e09627e32d32127967e426b9c69699c968f25465d81e12449

data/app/models/concerns/hydra/access_controls/visibility.rb

@@ -2,6 +2,14 @@ module Hydra::AccessControls
   module Visibility
     extend ActiveSupport::Concern
 
+    included do
+      # ActiveModel::Dirty requires defining the attribute method
+      # @see https://api.rubyonrails.org/classes/ActiveModel/Dirty.html
+      define_attribute_methods :visibility
+      # instance variable needs to be initialized here based upon what is in read_groups
+      after_initialize { @visibility = visibility }
+    end
+
     def visibility=(value)
       return if value.nil?
       # only set explicit permissions
@@ -15,6 +23,7 @@ module Hydra::AccessControls
       else
         raise ArgumentError, "Invalid visibility: #{value.inspect}"
       end
+      @visibility = value
     end
 
     def visibility
@@ -27,8 +36,14 @@ module Hydra::AccessControls
       end
     end
 
-    def visibility_changed?
-      !!@visibility_will_change
+    # Overridden for ActiveModel::Dirty tracking of visibility
+    # Required by ActiveModel::AttributeMethods
+    # @see https://api.rubyonrails.org/classes/ActiveModel/AttributeMethods.html
+    # An instance variable is used to avoid infinite recursion caused by calling #visibility
+    # Using this approach requires setting visibility read groups through #visibility=
+    # instead of manipulating them directly if #visibility_changed? is expected to work correctly.
+    def attributes
+      super.merge({ 'visibility' => @visibility })
     end
 
     private
@@ -41,10 +56,6 @@ module Hydra::AccessControls
          AccessRight::PERMISSION_TEXT_VALUE_PUBLIC]
       end
 
-      def visibility_will_change!
-        @visibility_will_change = true
-      end
-
       def public_visibility!
         visibility_will_change! unless visibility == AccessRight::VISIBILITY_TEXT_VALUE_PUBLIC
         remove_groups = represented_visibility - [AccessRight::PERMISSION_TEXT_VALUE_PUBLIC]

data/hydra-access-controls.gemspec

@@ -16,15 +16,14 @@ Gem::Specification.new do |gem|
   gem.version       = version
   gem.license       = "APACHE-2.0"
 
-  gem.required_ruby_version = '>= 1.9.3'
+  gem.required_ruby_version = '>= 2.4'
 
-  gem.add_dependency 'activesupport', '>= 4', '< 6'
-  gem.add_dependency "active-fedora", '>= 10.0.0'
-  gem.add_dependency "blacklight", '>= 5.16'
-  gem.add_dependency "blacklight-access_controls", '~> 0.6.0'
-  gem.add_dependency 'cancancan', '~> 1.8'
+  gem.add_dependency 'activesupport', '>= 5.2', '< 7'
+  gem.add_dependency 'active-fedora', '>= 10.0.0'
+  gem.add_dependency 'blacklight-access_controls', '~> 6.0'
+  gem.add_dependency 'cancancan', '>= 1.8', '< 4'
   gem.add_dependency 'deprecation', '~> 1.0'
 
-  gem.add_development_dependency "rake", '~> 10.1'
-  gem.add_development_dependency 'rspec', '~> 3.1'
+  gem.add_development_dependency 'rake', '>= 12.3.3'
+  gem.add_development_dependency 'rspec', '~> 4.0'
 end

data/lib/active_fedora/accessible_by.rb

@@ -1,8 +1,5 @@
 ActiveFedora::QueryMethods.module_eval do
   extend ActiveSupport::Concern
-  included do
-    include Hydra::AccessControlsEnforcement
-  end
 
   def accessible_by(ability, action = :index)
     permission_types = case action
@@ -11,7 +8,8 @@ ActiveFedora::QueryMethods.module_eval do
       when :update, :edit, :create, :new, :destroy then [:edit]
     end
 
-    filters = gated_discovery_filters(permission_types, ability).join(" OR ")
+    builder = Hydra::SearchBuilder.new(nil).with_ability(ability).with_discovery_permissions(permission_types)
+    filters = builder.send(:gated_discovery_filters).join(" OR ")
     spawn.where!(filters)
   end
 end

data/lib/hydra-access-controls.rb

@@ -29,7 +29,13 @@ module Hydra
     alias :config :configure
   end
 
-  class Engine < Rails::Engine; end
+  class Engine < Rails::Engine
+    config.before_configuration do
+      ActiveSupport::Inflector.inflections(:en) do |inflect|
+        inflect.acronym 'ACL'
+      end
+    end
+  end
 
   # This error is raised when a user isn't allowed to access a given controller action.
   # This usually happens within a call to AccessControlsEnforcement#enforce_access_controls but can be

data/lib/hydra/ability.rb

@@ -12,7 +12,6 @@ module Hydra
 
     included do
       include Hydra::PermissionsQuery
-      include Blacklight::SearchHelper
 
       self.ability_logic = [:create_permissions, :edit_permissions, :read_permissions, :discover_permissions, :download_permissions, :custom_permissions]
     end

data/lib/hydra/access_controls_enforcement.rb

@@ -2,6 +2,22 @@ module Hydra::AccessControlsEnforcement
   extend ActiveSupport::Concern
   include Blacklight::AccessControls::Enforcement
 
+  def current_ability
+    @current_ability || (scope.current_ability if scope&.respond_to?(:current_ability))
+  end
+
+  def with_ability(ability)
+    params_will_change!
+    @current_ability = ability
+    self
+  end
+
+  def with_discovery_permissions(permissions)
+    params_will_change!
+    @discovery_permissions = Array(permissions)
+    self
+  end
+
   protected
 
   def under_embargo?

data/spec/factories/objects.rb

@@ -0,0 +1,34 @@
+FactoryBot.define do
+
+  #
+  # Repository Objects
+  #
+
+  factory :asset, :class => ModsAsset do |o|
+  end
+
+  factory :admin_policy, :class => Hydra::AdminPolicy do |o|
+  end
+
+  factory :default_access_asset, :parent=>:asset do |a|
+    permissions_attributes { [{ name: "joe_creator", access: "edit", type: "person" }] }
+  end
+
+  factory :dept_access_asset, :parent=>:asset do |a|
+    permissions_attributes { [{ name: "africana-faculty", access: "read", type: "group" }, { name: "joe_creator", access: "edit", type: "person" }] }
+  end
+
+  factory :group_edit_asset, :parent=>:asset do |a|
+    permissions_attributes { [{ name:"africana-faculty", access: "edit", type: "group" }, {name: "calvin_collaborator", access: "edit", type: "person"}] }
+  end
+
+  factory :org_read_access_asset, :parent=>:asset do |a|
+    permissions_attributes { [{ name: "registered", access: "read", type: "group" }, { name: "joe_creator", access: "edit", type: "person" }, { name: "calvin_collaborator", access: "edit", type: "person" }] }
+  end
+
+  factory :open_access_asset, :parent=>:asset do |a|
+    permissions_attributes { [{ name: "public", access: "read", type: "group" }, { name: "joe_creator", access: "edit", type: "person" }, { name: "calvin_collaborator", access: "edit", type: "person" }] }
+  end
+
+end
+

data/spec/{factories.rb → factories/user.rb}

@@ -1,7 +1,6 @@
 FactoryBot.define do
 
   # Users
-
   # Prototype user factory
   factory :user, :aliases => [:owner] do |u|
     sequence :uid do |n|
@@ -58,36 +57,5 @@ FactoryBot.define do
     uid { 'alice_admin' }
     password { 'alice_admin' }
   end
-
-  #
-  # Repository Objects
-  #
-
-  factory :asset, :class => ModsAsset do |o|
-  end
-
-  factory :admin_policy, :class => Hydra::AdminPolicy do |o|
-  end
-
-  factory :default_access_asset, :parent=>:asset do |a|
-    permissions_attributes { [{ name: "joe_creator", access: "edit", type: "person" }] }
-  end
-
-  factory :dept_access_asset, :parent=>:asset do |a|
-    permissions_attributes { [{ name: "africana-faculty", access: "read", type: "group" }, { name: "joe_creator", access: "edit", type: "person" }] }
-  end
-
-  factory :group_edit_asset, :parent=>:asset do |a|
-    permissions_attributes { [{ name:"africana-faculty", access: "edit", type: "group" }, {name: "calvin_collaborator", access: "edit", type: "person"}] }
-  end
-
-  factory :org_read_access_asset, :parent=>:asset do |a|
-    permissions_attributes { [{ name: "registered", access: "read", type: "group" }, { name: "joe_creator", access: "edit", type: "person" }, { name: "calvin_collaborator", access: "edit", type: "person" }] }
-  end
-
-  factory :open_access_asset, :parent=>:asset do |a|
-    permissions_attributes { [{ name: "public", access: "read", type: "group" }, { name: "joe_creator", access: "edit", type: "person" }, { name: "calvin_collaborator", access: "edit", type: "person" }] }
-  end
-
 end
 

data/spec/spec_helper.rb

@@ -48,7 +48,8 @@ require "support/user"
 require "factory_bot"
 require 'rspec/mocks'
 require 'rspec/its'
-require "factories"
+require 'factories/user'
+require 'factories/objects'
 
 # HttpLogger.logger = Logger.new(STDOUT)
 # HttpLogger.ignore = [/localhost:8983\/solr/]

data/spec/unit/embargoable_spec.rb

@@ -165,11 +165,7 @@ describe Hydra::AccessControls::Embargoable do
     context "when the same embargo is applied" do
       before do
         subject.apply_embargo(future_date.to_s)
-        if ActiveModel.version < Gem::Version.new('4.2.0')
-          subject.embargo.send(:reset_changes)
-        else
-          subject.embargo.send(:clear_changes_information)
-        end
+        subject.embargo.send(:clear_changes_information)
       end
 
       it "doesn't call visibility_will_change!" do
@@ -248,11 +244,7 @@ describe Hydra::AccessControls::Embargoable do
       context "when the same lease is applied" do
         before do
           subject.apply_lease(future_date.to_s)
-          if ActiveModel.version < Gem::Version.new('4.2.0')
-            subject.lease.send(:reset_changes)
-          else
-            subject.lease.send(:clear_changes_information)
-          end
+          subject.lease.send(:clear_changes_information)
         end
 
         it "doesn't call visibility_will_change!" do
@@ -266,7 +258,7 @@ describe Hydra::AccessControls::Embargoable do
       before do
         subject.visibility = Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_PUBLIC
         # reset the changed log
-        subject.send(:instance_variable_set, :@visibility_will_change, false)
+        subject.send(:clear_changes_information)
       end
 
       it "applies appropriate embargo_visibility settings" do

data/spec/unit/policy_aware_access_controls_enforcement_spec.rb

@@ -1,28 +1,15 @@
 require 'spec_helper'
 
-describe Hydra::PolicyAwareAccessControlsEnforcement do
+RSpec.describe Hydra::PolicyAwareAccessControlsEnforcement do
   before do
     allow(Devise).to receive(:authentication_keys).and_return(['uid'])
 
-    class PolicyMockSearchBuilder < Blacklight::SearchBuilder
-      include Blacklight::Solr::SearchBuilderBehavior
-      include Hydra::AccessControlsEnforcement
+    class PolicyMockSearchBuilder < Hydra::SearchBuilder
       include Hydra::PolicyAwareAccessControlsEnforcement
-      attr_accessor :params
-
-      def initialize(current_ability)
-        @current_ability = current_ability
-      end
-
-      def current_ability
-        @current_ability
-      end
-
-      def session
-      end
 
       delegate :logger, to: :Rails
     end
+
     @sample_policies = []
     # user discover
     policy1 = Hydra::AdminPolicy.create(id: "test-policy1")
@@ -91,7 +78,7 @@ describe Hydra::PolicyAwareAccessControlsEnforcement do
   end
 
   let(:current_ability) { Ability.new(user) }
-  subject { PolicyMockSearchBuilder.new(current_ability) }
+  subject { PolicyMockSearchBuilder.new(nil).with_ability(current_ability) }
   let(:user) { FactoryBot.build(:sara_student) }
 
   before do
@@ -134,7 +121,7 @@ describe Hydra::PolicyAwareAccessControlsEnforcement do
 
     context "when policies are included" do
       before { subject.apply_gated_discovery(@solr_parameters) }
-      
+
       it "builds a query that includes all the policies" do
         skip if ActiveFedora.version.split('.').first.to_i < 11
         (1..11).each do |p|
@@ -142,7 +129,7 @@ describe Hydra::PolicyAwareAccessControlsEnforcement do
         end
       end
     end
-    
+
     context "when policies are not included" do
       before do
         allow(subject).to receive(:policy_clauses).and_return(nil)

data/spec/unit/visibility_spec.rb

@@ -100,4 +100,29 @@ describe Hydra::AccessControls::Visibility do
       expect(model.read_groups).to contain_exactly 'public', 'another'
     end
   end
+
+  context 'dirty tracking' do
+    let(:object_class) do
+      Class.new(ActiveFedora::Base) do
+        include Hydra::AccessControls::Permissions
+      end
+    end
+
+    before { stub_const("Foo", object_class) }
+
+    subject { Foo.new }
+
+    it 'responds to visibility_changed?' do
+      expect(subject).to respond_to(:visibility_changed?)
+    end
+
+    it 'tracks changes' do
+      expect(subject.visibility_changed?).to eq false
+      subject.visibility = Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_PUBLIC
+      expect(subject.visibility_changed?).to eq true
+      expect(subject.visibility_changed?(to: Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_PUBLIC)).to eq true
+      expect(subject.visibility_changed?(from: Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_PRIVATE)).to eq true
+      expect(subject.visibility_changed?(from: Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_PRIVATE, to: Hydra::AccessControls::AccessRight::VISIBILITY_TEXT_VALUE_PUBLIC)).to eq true
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hydra-access-controls
 version: !ruby/object:Gem::Version
-  version: 11.0.6
+  version: 12.0.0
 platform: ruby
 authors:
 - Chris Beer
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-31 00:00:00.000000000 Z
+date: 2020-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -18,20 +18,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '5.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '5.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6'
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: active-fedora
   requirement: !ruby/object:Gem::Requirement
@@ -46,48 +46,40 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 10.0.0
-- !ruby/object:Gem::Dependency
-  name: blacklight
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '5.16'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '5.16'
 - !ruby/object:Gem::Dependency
   name: blacklight-access_controls
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: cancancan
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: deprecation
   requirement: !ruby/object:Gem::Requirement
@@ -106,30 +98,30 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.1'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.1'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '4.0'
 description: Access controls for project hydra
 email:
 - hydra-tech@googlegroups.com
@@ -182,7 +174,8 @@ files:
 - lib/hydra/role_mapper_behavior.rb
 - lib/hydra/shared_spec/group_service_interface.rb
 - lib/hydra/user.rb
-- spec/factories.rb
+- spec/factories/objects.rb
+- spec/factories/user.rb
 - spec/indexers/embargo_indexer_spec.rb
 - spec/indexers/lease_indexer_spec.rb
 - spec/services/embargo_service_spec.rb
@@ -223,19 +216,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Access controls for project hydra
 test_files:
-- spec/factories.rb
+- spec/factories/objects.rb
+- spec/factories/user.rb
 - spec/indexers/embargo_indexer_spec.rb
 - spec/indexers/lease_indexer_spec.rb
 - spec/services/embargo_service_spec.rb