permisi 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f5921c398a6ce7ae469c520df94b9fa41c9ee9e43008acfad87ad45c2252000
-  data.tar.gz: 467511ff2872e5a4b42cf01b18b4578ac3c8e45b42b4dba7ce2354ff65303d81
+  metadata.gz: '082297c3c88cb77bf0fe05e8c855d27d8bd5293c7db4d55cc3f0a6e0b982ac84'
+  data.tar.gz: caa2bef94cfaba331a10e5f27ee45c0d8256690139f3de39447d1d515ad3daa0
 SHA512:
-  metadata.gz: 7740edf97adf3444c8051b6d126f148851467aad17c80b73ab43ff505a8201ba5eedb0c681ce85cadcac354e377a92a888b4f19b51a3b72ab353bdc3ec070ced
-  data.tar.gz: 491438a44e151e82cadf211a2ffd8d6cffd0fab84e321553a0089c10f29f95acc5463ca2acaa9ced5f888d5c9a50cbaf8c513cab5ca24c46dc73487b6a4927b7
+  metadata.gz: c06509c2a113376920a1f41f6382f2542642c5ca83a1f37b330b28474f426566a3a526942417345a6ba7c4860dc87cd4744c669f2535f15f25f216cec61cf5b6
+  data.tar.gz: 2f497885ec26787708b26900576d95c5ee2ff127b1d48f14560ddd5826edfcc0c01bbd6018a06bc05212e8ab73495cdbe1d1979902acefcfa88c34d9e819ddbe

data/CHANGELOG.md

@@ -1,12 +1,23 @@
 # Changelog
 
+# 0.1.3
+
+[_View the docs._](https://github.com/ukazap/permisi/blob/v0.1.3/README.md)
+
+- Correct grammars and examples in the docs
+- Change actor permissions cache key
+
 # 0.1.2
 
+[_View the docs._](https://github.com/ukazap/permisi/blob/v0.1.2/README.md)
+
 - Fix namespaces/actions should no longer contain periods
 - Implement cache config for faster access to actor permissions
 
 # 0.1.1
 
+[_View the docs._](https://github.com/ukazap/permisi/blob/v0.1.1/README.md)
+
 - General code refactoring
 - Improvements on ActiveRecord backend:
   - Code refactoring
@@ -14,6 +25,8 @@
 
 # 0.1.0
 
+[_View the docs._](https://github.com/ukazap/permisi/blob/v0.1.0/README.md)
+
 Finished extraction work from my past projects.
 
 - Implement ActiveRecord backend
@@ -22,4 +35,6 @@ Finished extraction work from my past projects.
 
 # 0.0.1
 
+[_View the docs._](https://github.com/ukazap/permisi/blob/v0.0.1/README.md)
+
 Reserved the gem name: https://en.wiktionary.org/wiki/permisi

data/Gemfile

@@ -11,5 +11,4 @@ gem "rspec", "~> 3.0"
 gem "rubocop", "~> 1.9"
 gem "simplecov", "~> 0.21.2"
 gem "sqlite3", "~> 1.4"
-
 gem "codecov", "~> 0.4.3"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    permisi (0.1.2)
+    permisi (0.1.3)
       activemodel (>= 3.2.0)
       activerecord (>= 3.2.0)
       activesupport (>= 3.2.0)
@@ -51,7 +51,7 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.2)
-    rubocop (1.9.1)
+    rubocop (1.10.0)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)

data/README.md

@@ -1,4 +1,4 @@
-If you're viewing this at https://github.com/ukazap/permisi, you're reading the documentation for the main branch. [Go to specific version.](https://github.com/ukazap/permisi/tags)
+If you're viewing this at https://github.com/ukazap/permisi, you're reading the documentation for the main branch. [Go to specific version.](https://github.com/ukazap/permisi/blob/main/CHANGELOG.md)
 
 <table>
   <tr>
@@ -142,12 +142,12 @@ admin_role = Permisi.roles.create(slug: :admin, name: "Administrator", permissio
 })
 
 # Ask specific role permission
-admin_role.allows? "books.delete" # == false
+admin_role.allows?("books.delete") # == false
 
 # Update existing role
-admin.permissions[:books].merge!({ delete: true })
-admin.save
-admin_role.allows? "books.delete" # == true
+admin_role.permissions[:books].merge!({ delete: true })
+admin_role.save
+admin_role.allows?("books.delete") # == true
 ```
 
 ## Configuring actors
@@ -173,20 +173,20 @@ user = User.find_by_email "esther@example.com"
 user.permisi # => instance of Actor
 
 admin_role = Permisi.roles.find_by_slug(:admin)
-admin_role.allows? "books.delete" # == true
+admin_role.allows?("books.delete") # == true
 
 user.permisi.roles << admin_role
 
-user.permisi.role? :admin # == true
-user.permisi.has_role? :admin # == user.permisi.role? :admin
+user.permisi.role?(:admin) # == true
+user.permisi.has_role?(:admin) # == user.permisi.role? :admin
 
-user.permisi.may_i? "books.delete" # == true
-user.permisi.may? "books.delete" # == user.permisi.may_i? "books.delete"
+user.permisi.may_i?("books.delete") # == true
+user.permisi.may?("books.delete") # == user.permisi.may_i? "books.delete"
 
 user.permisi.roles.destroy(admin_role)
 
-user.permisi.role? :admin # == false
-user.permisi.may_i? "books.delete" # == false
+user.permisi.role?(:admin) # == false
+user.permisi.may_i?("books.delete") # == false
 ```
 
 ## Caching
@@ -199,24 +199,24 @@ Although checking whether an actor has a role goes against a good RBAC practice,
 
 ```ruby
 user = User.find_by_email "esther@example.com"
-user.role? :admin # eager loads roles
-user.role? :admin # uses the eager-loaded roles
-user.has_role? :admin # uses the eager-loaded roles
+user.permisi.role?(:admin) # eager loads roles
+user.permisi.role?(:admin) # uses the eager-loaded roles
+user.permisi.has_role?(:admin) # uses the eager-loaded roles
 ```
 
 ### Actor permissions memoization
 
 To check whether or not an actor is allowed to perform a specific action (`#may_i?`), Permisi will check on the actor's permissions which is constructed in the following steps:
 
-- get all roles an actor have (this will make a database call)
+- load all the roles an actor have from the database
 - initialize an empty aggregate hash
-- for each roles, merge its permissions hash to the aggregate hash
+- for each role, merge its permissions hash to the aggregate hash
 
 Deserializing the hashes from the database and deeply-merging them into an aggregate hash can be expensive, so it will only happen to an instance of actor only once through memoization.
 
 ### Actor permissions caching
 
-Although memoization helps, the permission hash construction will still occur everytime a actor is initialized. To alleviate this, we can introduce a caching layer so that we can skip the hash construction for fresh actors. You must configure a cache store to use caching:
+Although memoization helps, the permission hash construction will still occur every time an actor is initialized. To alleviate this, we can introduce a caching layer so that we can skip the hash construction for fresh actors. You must configure a cache store to use caching:
 
 ```ruby
 # config/initializers/permisi.rb
@@ -239,7 +239,7 @@ The following will trigger actor's permissions cache/memo invalidation:
 
 - adding roles to the actor
 - removing roles from the actor
-- editing roles that belongs to an actor
+- editing roles that belongs to the actor
 
 ## Contributing
 

data/lib/permisi/backend/active_record/actor.rb

@@ -20,7 +20,7 @@ module Permisi
 
         # Memoized and cached actor permissions
         def permissions
-          @permissions ||= Permisi.config.cache_store.fetch(cache_key) { aggregate_permissions }
+          @permissions ||= Permisi.config.cache_store.fetch("#{cache_key}-p") { aggregate_permissions }
         end
 
         # Aggregate permissions from all roles an actor plays

data/lib/permisi/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Permisi
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: permisi
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Ukaza Perdana
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-21 00:00:00.000000000 Z
+date: 2021-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel