policy-assertions 0.0.3 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: de43c6a77ae8bc5ef2887f016bc04b7924842852
-  data.tar.gz: a68e538a28931ce1702a987c17ec56c433a132ee
+  metadata.gz: f24ccf11ad4ed8b8cfbc67593fdb47ee45acee40
+  data.tar.gz: 1383189eb57f1a60a320658985f8ca7f1853289d
 SHA512:
-  metadata.gz: d3958f8816690edb5148180e06b4f4245f98ff1f1a9e68e0643444a2793001f9f8d3b5fb91288a9f4f2fcbf74c85a2e4a70d4ff57addfc9a376ab5c3780991b7
-  data.tar.gz: 40c562a177f6387d8bff50d8aec2dbf838d46f5fb7399d96b0dbcc8a87a285266c9c166248cb9bb253d94adfdee376bd3a0d91cb02aaf44ab9846fbd88af6e42
+  metadata.gz: a5fc2eee22de0f4b9f5c0c6cb899035cef25322c09879613c83bde1b0c2e5ae943fe8f51b760223fe289889b628142e4235000fb62cceba3f5393728113d9338
+  data.tar.gz: c3dc79ede4de1fd15a5c0f2979c7c615a21f6c1d047ae29717400624881d61b062737a5489cbdf737196d77876fab87bd9fe0e899e32d0f55338d016823d5245

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## v0.1.0
+* [Adds support for arrays as actions in block tests](https://github.com/ProctorU/policy-assertions/pull/10)
+* [Adds support for `assert_not_permitted`](https://github.com/ProctorU/policy-assertions/pull/12)
+* [Readme updates](https://github.com/ProctorU/policy-assertions/pull/11)
+* Transferred ownership from @ksimmons to @proctoru
+
 ## v0.0.3
 
 * Compatibility with pundit 1.1.0

data/README.md

@@ -1,10 +1,20 @@
 # policy-assertions
-[![Build Status](https://travis-ci.org/ksimmons/policy-assertions.svg?branch=master)](https://travis-ci.org/ksimmons/policy-assertions)
+
+[![Build Status](https://circleci.com/gh/ProctorU/policy-assertions.svg?style=shield&circle-token=7084a829c9e63b415f59e627d9e4ee90db7d2afa)](https://circleci.com/gh/ProctorU/policy-assertions) [![Gem Version](https://badge.fury.io/rb/policy-assertions.svg)](https://badge.fury.io/rb/policy-assertions)
 
 Minitest test assertions for [Pundit](https://github.com/elabs/pundit) policies.
 
 policy-assertions provides a test class for easy Pundit testing. The test class provides assertions and refutations for policies and strong parameters.
 
+## Table of contents
+
+* [Installation](#installation)
+* [Usage](#usage)
+* [Available test methods](#test-method-naming)
+* [Configuration](#configuration)
+* [Developing](#developing)
+* [Credits](#credits)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -21,7 +31,7 @@ Or install it yourself as:
 
     $ gem install policy-assertions
 
-**Add require policy\_assertions to test\_helper.rb**
+**Add require policy_assertions to test_helper.rb**
 
 ```ruby
 require 'policy_assertions'
@@ -31,10 +41,10 @@ require 'policy_assertions'
 
 policy-assertions is intended to make testing Pundit policies as simple as possible. The gem adds the following helpers:
 
-- PolicyAssertions::Test class
-- parses permissions to test from method name
-- assert\_permit and refute\_permit methods
-- assert\_strong\_parameters
+* PolicyAssertions::Test class
+* parses permissions to test from method name
+* assert_permit and refute_permit methods
+* assert_strong_parameters
 
 The following code sample illustrates the intended use of this gem.
 
@@ -57,6 +67,8 @@ class ArticlePolicyTest < PolicyAssertions::Test
   # Test that this user cannot delete this article
   def test_destroy
     refute_permit users(:regular), articles(:instructions)
+    # Alternate method name
+    asssert_not_permitted users(:regular), articles(:instructions)
   end
 
   # Test a permission by passing in an array instead of
@@ -78,8 +90,19 @@ class ArticlePolicyTest < PolicyAssertions::Test
 end
 ```
 
-### Test method naming
-policy-assertions can read the permissions to test from the method name. This will only work when using the minitest def test_name syntax, it does not work for the Rails test block helper.
+If policies are namespaced, the invocation of the class name should follow the same syntax as Pundit.
+
+```ruby
+# Test that the Organizations::Article model allows index and show
+# for any site visitor. nil is passed in for the user.
+def test_index_and_show
+  assert_permit nil, [:organizations, Article]
+end
+```
+
+## Test method naming
+
+policy-assertions can read the permissions to test from the method name. This will only work when using the minitest def test_name syntax. When using the block syntax, you must explicitly pass the permission names.
 
 ```ruby
 # Good
@@ -92,26 +115,28 @@ end
 def test_show_and_index
 end
 
-# Not good
-# The permission cannot be read from this block.
+# Good block syntax
+# The permission cannot be automatically read, so you must pass the policy names directly.
 test 'create' do
- # passing the permissions to the assert or refute is ok.
  refute_permit nil, Article, 'create?', 'new?'
 end
 ```
+
 Define multiple permissions in a method name by separating the permissions using '\_and\_'.
 
 See the configuration section for changing the separator value.
 
-### assert\_permit and refute\_permit
+### assert_permit and refute_permit
+
 These methods take the following parameters:
 
-- User to authorize
-- Model or instance to authorize
-- Optional array of permissions. They should match the permission method name exactly.
+* User to authorize
+* Model or instance to authorize
+* Optional array of permissions. They should match the permission method name exactly.
 
 #### Passing permissions to assert and refute
-When permissions are passed to assert or refute the test method name is ignored and does not need to match a policy permission.
+
+When permissions are passed to assert or refute, the test method name is ignored and does not need to match a policy permission.
 
 ```ruby
 class ArticlePolicyTest < PolicyAssertions::Test
@@ -124,7 +149,8 @@ end
 ```
 
 ### Using the rails test block helper
-policy-assertions will work with the rails test block helper but it cannot parse the permissions. If a test block is used and the permissions are not passed to the assert and refute methods a PolicyAssertions::MissingBlockParameters error will be thrown.
+
+policy-assertions will work with the rails test block helper but it cannot parse the permissions. If a test block is used and the permissions are not passed to the `assert` and `refute` methods, a PolicyAssertions::MissingBlockParameters error will be thrown.
 
 ```ruby
 class ArticlePolicyTest < PolicyAssertions::Test
@@ -132,6 +158,11 @@ class ArticlePolicyTest < PolicyAssertions::Test
     assert_permit @user, Article, 'index?', 'show?'
   end
 
+  # Actions can also be passed as an array
+  test 'index?' do
+    assert_permit @user, Article, %w(index? show?)
+  end
+
   # this will result in a
   # PolicyAssertions::MissingBlockParameters error
   test 'show?' do
@@ -141,6 +172,7 @@ end
 ```
 
 ### Strong Parameters
+
 Since Pundit offers a [permitted_attributes](https://github.com/elabs/pundit#strong-parameters) helper, policy-assertions provides an assert method for testing.
 
 ```ruby
@@ -157,17 +189,39 @@ class ArticlePolicyTest < PolicyAssertions::Test
   end
 end
 ```
-## Configure
+
+## Configuration
+
 Use the following in your test helper to change the test definition permissions separator.
 
 ```ruby
 PolicyAssertions.config.separator = '__separator__'
 ```
 
-## Contributing
+## Developing
 
 1. Fork it ( https://github.com/[my-github-username]/policy-assertions/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes with tests (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
+
+## Credits
+
+Policy-assertions is maintained and funded by [ProctorU](https://twitter.com/ProctorU),
+a simple online proctoring service that allows you to take exams or
+certification tests at home.
+
+We'd like to thank [@ksimmons](https://github.com/ksimmons) for being the original creator of policy-assertions and allowing us to maintain the project.
+
+<br>
+
+<p align="center">
+  <a href="https://twitter.com/ProctorUEng">
+    <img src="https://s3-us-west-2.amazonaws.com/dev-team-resources/procki-eyes.svg" width=108 height=72>
+  </a>
+
+  <h3 align="center">
+    <a href="https://twitter.com/ProctorUEng">ProctorU Engineering & Design</a>
+  </h3>
+</p>

data/circle.yml

@@ -0,0 +1,13 @@
+dependencies:
+  override:
+    - 'rvm-exec 2.1.10 bundle install'
+    - 'rvm-exec 2.2.8 bundle install'
+    - 'rvm-exec 2.3.5 bundle install'
+    - 'rvm-exec 2.4.2 bundle install'
+
+test:
+  override:
+    - 'rvm-exec 2.1.10 bundle exec rake'
+    - 'rvm-exec 2.2.8 bundle exec rake'
+    - 'rvm-exec 2.3.5 bundle exec rake'
+    - 'rvm-exec 2.4.2 bundle exec rake'

data/lib/policy_assertions.rb

@@ -16,7 +16,7 @@ require 'policy_assertions/configuration'
 module PolicyAssertions
   class Test < ActiveSupport::TestCase
     def assert_permit(user, record, *permissions)
-      get_permissions(permissions).each do |permission|
+      get_permissions(permissions.flatten).each do |permission|
         policy = Pundit.policy!(user, record)
         assert policy.public_send(permission),
                "Expected #{policy.class.name} to grant #{permission} "\
@@ -25,13 +25,14 @@ module PolicyAssertions
     end
 
     def refute_permit(user, record, *permissions)
-      get_permissions(permissions).each do |permission|
+      get_permissions(permissions.flatten).each do |permission|
         policy = Pundit.policy!(user, record)
         refute policy.public_send(permission),
                "Expected #{policy.class.name} not to grant #{permission} "\
                "on #{record} for #{user} but it did"
       end
     end
+    alias assert_not_permitted refute_permit
 
     def assert_strong_parameters(user, record, params_hash, allowed_params)
       policy = Pundit.policy!(user, record)

data/lib/policy_assertions/version.rb

@@ -1,3 +1,3 @@
 module PolicyAssertions
-  VERSION = '0.0.3'
+  VERSION = '0.1.1'
 end

data/policy-assertions.gemspec

@@ -6,8 +6,8 @@ require 'policy_assertions/version'
 Gem::Specification.new do |spec|
   spec.name          = "policy-assertions"
   spec.version       = PolicyAssertions::VERSION
-  spec.authors       = ['Kevin Simmons']
-  spec.email         = ['kevin.p.simmons@gmail.com']
+  spec.authors       = ['ProctorU']
+  spec.email         = ['engineering@proctoru.com']
   spec.summary       = %q{Minitest assertions for Pundit policies.}
   spec.description   = %q{Minitest assertions for Pundit policies.}
   spec.homepage      = 'https://github.com/ksimmons/policy-assertions'

data/test/lib/policy_assertions_test.rb

@@ -102,6 +102,17 @@ class AssertionsTest < Minitest::Test
     assert test_runner.passed?
   end
 
+  def test_permission_failed_as_assert_not_permitted
+    test_runner = policy_class do
+      def test_create
+        assert_not_permitted nil, Article
+      end
+    end.new :test_create
+
+    test_runner.run
+    assert test_runner.passed?
+  end
+
   def test_destroy
     test_runner = policy_class do
       def test_destroy
@@ -197,8 +208,20 @@ class ValidBlockParametersTest
       assert_permit nil, Article, 'index?', 'long_action?'
     end
 
+    test 'assert_permit index? as array' do
+      assert_permit nil, Article, %w(index? long_action?)
+    end
+
     test 'destroy?' do
       refute_permit nil, Article, 'destroy?'
     end
+
+    test 'destroy? with assert_not_permitted' do
+      assert_not_permitted nil, Article, 'destroy?'
+    end
+    
+    test 'refute_permit destroy? as array' do
+      refute_permit nil, Article, %w(destroy?)
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: policy-assertions
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.1
 platform: ruby
 authors:
-- Kevin Simmons
+- ProctorU
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-08 00:00:00.000000000 Z
+date: 2018-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -124,19 +124,19 @@ dependencies:
         version: 3.0.0
 description: Minitest assertions for Pundit policies.
 email:
-- kevin.p.simmons@gmail.com
+- engineering@proctoru.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- circle.yml
 - lib/policy_assertions.rb
 - lib/policy_assertions/configuration.rb
 - lib/policy_assertions/errors.rb
@@ -167,7 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Minitest assertions for Pundit policies.
@@ -177,4 +177,3 @@ test_files:
 - test/lib/policy-assertions/version_test.rb
 - test/lib/policy_assertions_test.rb
 - test/test_helper.rb
-has_rdoc: 

data/.travis.yml

@@ -1,4 +0,0 @@
-language: ruby
-rvm:
-  - 1.9.3
-  - 2.2.0-preview1