ruolo 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3366759c1da52afa0c58dfc5c4778868b4fba8ff7b1f3a29cbd0a7580306e3af
-  data.tar.gz: 8bb57e581742d56a7259880eb33998eb042a6ef5a1df4b230072c7e923dbe991
+  metadata.gz: 0a59aa52708f49c8096c1c0623d7098120fa34e73cdd4bc72d8380f165bd67ac
+  data.tar.gz: d6463de5e3dceceecbac1fe0b0ed873748e508246497bc460ed2dc73ed55ddb6
 SHA512:
-  metadata.gz: 6bc881521a3481e12b107b14e611140cf47abcb508438b296167030aad9bf411983f7ad7765ce2f58eb754a07df8e9570f6bc14baf98e95cde2e0a713d5b095c
-  data.tar.gz: 2aad3aed99d638fe0e46544a462342533d8e70392b552310fa7f209047905307715819f028d9a89650f949ad625e867c45e959d8b7c7c32231bc85aa25e91067
+  metadata.gz: 7f8944b7a657b4c7681558fd32f617a5df71d6639e869e3cf1b606e706a98379a48262384d041c252fb70d15111adceac3f75da92e5e97a2ed6e3d68209a12ff
+  data.tar.gz: bc75347e0ffce4b4c1d13d0fc2e265d21cac5e5c716be49df994a3b08948ba831f71d5c0ab4653ad78ee163f12bab81c961a2f92a46ae705264d0cd92334d766

data/CHANGELOG.md

@@ -3,6 +3,11 @@
 This file keeps track of changes between releases for the ruolo project
 which adheres to [semantic versioning](https://semver.org).
 
+## v0.3.0 2019-10-08
+
+Add a `role?` method to the user mixin to check for given roles instead of
+permissions.
+
 ## v0.2.0 2019-09-11
 
 Initial cleanup of original code: add tests and documentation.

data/README.md

@@ -1,5 +1,6 @@
 # Ruolo
 
+[![RubyGems](https://img.shields.io/gem/v/ruolo.svg)](https://rubygems.org/gems/ruolo)
 [![Build Status](https://travis-ci.org/mfinelli/ruolo.svg?branch=master)](https://travis-ci.org/mfinelli/ruolo)
 [![Coverage Status](https://coveralls.io/repos/github/mfinelli/ruolo/badge.svg?branch=master)](https://coveralls.io/github/mfinelli/ruolo?branch=master)
 [![Inline docs](http://inch-ci.org/github/mfinelli/ruolo.svg?branch=master)](http://inch-ci.org/github/mfinelli/ruolo)
@@ -17,6 +18,18 @@ and authorization of users after that, `ruolo` is completely unopinionated.
 
 ## Usage
 
+### Require
+
+Include the gem in your gemfile:
+
+```ruby
+gem 'ruolo', require: false
+```
+
+Notice the `require: false` which is necessary so it doesn't automatically get
+included if you do something like `Bundler.require`. Make sure that you have a
+database connection and _then_ require the gem and configure it.
+
 ### Migrations
 
 You'll need to run the following database migration to setup your schema, fill

data/lib/ruolo/models/user.rb

@@ -19,7 +19,7 @@ module Ruolo
     # A mixin to include in downstream user classes that adds useful helper
     # methods for dealing with roles and permissions.
     module User
-      # Given the name of a permission determin whether the user's role
+      # Given the name of a permission determine whether the user's role
       # membership includes it.
       #
       # @param permission [String] the name of the permission
@@ -27,6 +27,15 @@ module Ruolo
       def permission?(permission)
         roles.map { |role| role.permissions.map(&:name) }.flatten.uniq.include?(permission)
       end
+
+      # Given a role name or array of role names determine if the user has
+      # that/those roles.
+      #
+      # @param role [String|Array<String>] role(s) to check
+      # @return [Boolean] if the user has the given role(s)
+      def role?(role)
+        !(roles.map(&:name) & Array(role)).empty?
+      end
     end
   end
 end

data/lib/ruolo/version.rb

@@ -15,5 +15,5 @@
 # limitations under the License.
 
 module Ruolo
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruolo
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Mario Finelli
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-11 00:00:00.000000000 Z
+date: 2019-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sequel