blacklight-access_controls 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e429877da325ab5e409d1d62676ef8d5e1fc0495
-  data.tar.gz: c77b7f0cf4e24cdaa8acfe763e92aacd16b36f64
+  metadata.gz: 7e7447f8da715903fc974515f34db237e8ba5653
+  data.tar.gz: 6afe65e64d3fc0ee3bb9b8c79279a6167dd5d74c
 SHA512:
-  metadata.gz: 054afd2481955b5278a523a11d57723b0d1c8b6fe27d18e5956abae262b2d93ed77e9775b0ad582f70d73269d4e9c69a3c790a5aa5b0e7884e59db2a918c9523
-  data.tar.gz: d679058bc3c0aa1a782f992433678e229f10d892e81257dfe9329601dcfefaeb0db3af6e579706781a9393ae30f48725c7b9b6f5b1e21035269182b974a200f2
+  metadata.gz: b4c4174a084bda61d07de209e9b2486a84bed7cd9b714a557f85ffc47bc371fc1aa85241db4155a532622e13a38418ec563f5d4b113707427578b051af9221e0
+  data.tar.gz: e5ab41654830f20e8355a51f07b2f6c2ae05dc7aa917bc7e71d31c4ca560490e61fe0cfe00aed1430f0688c1b2778438d454d4a394ad7d0f21c5f6be9e7a00b1

data/.travis.yml

@@ -0,0 +1,22 @@
+language: ruby
+sudo: false
+cache:
+  directories:
+  - /tmp/solr-5.3.0
+
+notifications:
+  email: false
+
+rvm:
+  - 2.3.0
+
+env:
+ - "RAILS_VERSION=4.2.5"
+
+notifications:
+  irc: "irc.freenode.org#blacklight"
+  email:
+      - blacklight-commits@googlegroups.com
+
+global_env:
+  - NOKOGIRI_USE_SYSTEM_LIBRARIES=true

data/Rakefile

@@ -1,4 +1,11 @@
 #!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+Bundler::GemHelper.install_tasks
 
 require 'solr_wrapper'
 
@@ -19,14 +26,13 @@ require 'engine_cart/rake_task'
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => 'solr:spec'
+task default: 'ci'
 
 def solr_config_dir
   File.join(File.expand_path(File.dirname(__FILE__)), "solr_conf", "conf")
 end
 
 namespace :solr do
-
   desc 'Configure solr cores'
   task :config do
     SolrWrapper.wrap do |solr|
@@ -43,5 +49,7 @@ namespace :solr do
       end
     end
   end
-
 end
+
+desc "Run CI build"
+task ci: ['engine_cart:generate', 'solr:spec']

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/blacklight-access_controls.gemspec

@@ -18,7 +18,7 @@ Gem::Specification.new do |gem|
   gem.required_ruby_version = '>= 1.9.3'
 
   gem.add_dependency 'cancancan', '~> 1.8'
-  gem.add_dependency "blacklight", '~> 5.16'
+  gem.add_dependency "blacklight", '~> 6.0'
 
   gem.add_development_dependency "rake", '~> 10.1'
   gem.add_development_dependency 'rspec', '~> 3.1'

data/lib/blacklight-access_controls.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'rails'
 require 'cancan'
 require 'blacklight'

data/lib/blacklight/access_controls.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Blacklight
   module AccessControls
     extend ActiveSupport::Autoload

data/lib/blacklight/access_controls/ability.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'cancan'
 
 module Blacklight

data/lib/blacklight/access_controls/catalog.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This is behavior for the catalog controller.
 
 module Blacklight
@@ -7,9 +8,9 @@ module Blacklight
 
       # Override blacklight to produce a search_builder that has
       # the current ability in context
-      def search_builder processor_chain = search_params_logic
-        super(true).tap { |builder| builder.current_ability = current_ability }
-      end 
+      def search_builder
+        super.tap { |builder| builder.current_ability = current_ability }
+      end
 
       # Controller "before" filter for enforcing access controls
       # on show actions.

data/lib/blacklight/access_controls/config.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Blacklight
   module AccessControls
     class Config

data/lib/blacklight/access_controls/enforcement.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Blacklight
   module AccessControls
     module Enforcement
@@ -23,6 +24,14 @@ module Blacklight
         @current_ability || raise("current_ability has not been set on #{self}")
       end
 
+      def except(*)
+        super.tap { |new_builder| new_builder.current_ability = current_ability }
+      end
+
+      def append(*)
+        super.tap { |new_builder| new_builder.current_ability = current_ability }
+      end
+
       protected
 
       def gated_discovery_filters(permission_types = discovery_permissions, ability = current_ability)

data/lib/blacklight/access_controls/permissions_cache.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Blacklight::AccessControls::PermissionsCache
 
   def initialize

data/lib/blacklight/access_controls/permissions_query.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Blacklight::AccessControls
   module PermissionsQuery
     extend ActiveSupport::Concern

data/lib/blacklight/access_controls/user.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # Injects behaviors into User model so that it will work with
 # Blacklight Access Controls.  By default, this module assumes
 # you are using the User model created by Blacklight, which uses

data/lib/generators/blacklight/ability.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 class Ability
   include CanCan::Ability
   include Blacklight::AccessControls::Ability

data/lib/generators/blacklight/access_controls_generator.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module Blacklight
   class AccessControlsGenerator < Rails::Generators::Base
 
@@ -56,5 +57,10 @@ module Blacklight
       copy_file 'ability.rb', 'app/models/ability.rb'
     end
 
+    def add_configuration
+      say_status('status', 'ADDING BLACKLIGHT ACCESS CONTROLS CONFIGURATION', :yellow)
+      copy_file 'blacklight_access_controls.rb', 'config/initializers/blacklight_access_controls.rb'
+    end
+
   end
 end

data/lib/generators/blacklight/blacklight_access_controls.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+Blacklight::AccessControls.configure do |config|
+  # This specifies the solr field names of permissions-related fields.
+  # The default fields used are shown below, if you index your permissions to other fields update the configuration below.
+  # If you change these, you must also update the permissions request handler in your solrconfig.xml to return those values
+  #
+  # config.discover_group_field = Solrizer.solr_name("discover_access_group", :symbol)
+  # config.discover_user_field  = Solrizer.solr_name("discover_access_person", :symbol)
+  # config.read_group_field     = Solrizer.solr_name("read_access_group", :symbol)
+  # config.read_user_field      = Solrizer.solr_name("read_access_person", :symbol)
+  # config.download_group_field = Solrizer.solr_name("download_access_group", :symbol)
+  # config.download_user_field  = Solrizer.solr_name("dowload_access_person", :symbol)
+  #
+  # specify the user model
+  # config.user_model = 'User'
+end

data/spec/factories/user.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 FactoryGirl.define do
   factory :user do
     sequence(:email) { |n| "user_#{n}@example.com" }

data/spec/spec_helper.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 ENV['RAILS_ENV'] ||= 'test'
 
 require 'engine_cart'

data/spec/support/solr_support.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 module SolrSupport
 
   def create_solr_doc(hash)

data/spec/test_app_templates/lib/generators/test_app_generator.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'rails/generators'
 
 class TestAppGenerator < Rails::Generators::Base

data/spec/unit/ability_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 require 'cancan/matchers'
 

data/spec/unit/catalog_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe Blacklight::AccessControls::Catalog do

data/spec/unit/config_spec.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe Blacklight::AccessControls::Config do

data/spec/unit/enforcement_spec.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
 require 'spec_helper'
 
 describe Blacklight::AccessControls::Enforcement do
   let(:controller) { CatalogController.new }
   let(:search_builder) { SearchBuilder.new(method_chain, context) }
-  let(:method_chain) { CatalogController.search_params_logic }
+  let(:method_chain) { SearchBuilder.default_processor_chain }
   let(:context) { controller }
 
   let(:user) { User.new }
@@ -63,6 +64,28 @@ describe Blacklight::AccessControls::Enforcement do
     end
   end
 
+  describe "#except" do
+    let(:user) { build(:user) }
+    let(:ability) { Ability.new(user) }
+    before { search_builder.current_ability = ability }
+    subject { search_builder.except('foo') }
+
+    it "keeps the current_ability set" do
+      expect(subject.current_ability).to eq ability
+    end
+  end
+
+  describe "#append" do
+    let(:user) { build(:user) }
+    let(:ability) { Ability.new(user) }
+    before { search_builder.current_ability = ability }
+    subject { search_builder.append('foo') }
+
+    it "keeps the current_ability set" do
+      expect(subject.current_ability).to eq ability
+    end
+  end
+
   describe "apply_gated_discovery" do
     let(:user) { create(:user) }
     let(:groups) { ["archivist","researcher"] }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: blacklight-access_controls
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Chris Beer
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-04 00:00:00.000000000 Z
+date: 2016-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: cancancan
@@ -33,14 +33,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.16'
+        version: '6.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.16'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -133,6 +133,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - Gemfile
 - README.textile
 - Rakefile
@@ -149,6 +150,7 @@ files:
 - lib/blacklight/access_controls/user.rb
 - lib/generators/blacklight/ability.rb
 - lib/generators/blacklight/access_controls_generator.rb
+- lib/generators/blacklight/blacklight_access_controls.rb
 - solr_conf/conf/abc123
 - solr_conf/conf/admin-extra.html
 - solr_conf/conf/admin-extra.menu-bottom.html