role_core 0.0.20 → 0.0.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9edb95eb240054cb26913657fe3c3b6b1d723a02bf34bc1503435598e9299d99
-  data.tar.gz: 02666f872e3cdee62288e3e567ac157b30a88240f8e620c4e4777b2332da6b57
+  metadata.gz: b54a7260db7b31f966bbedca0ccc5ca2931fe8c8c573c5b22dc4cd29046b9a04
+  data.tar.gz: 1e040dec8f41bb8cfa04ade4f1aa2ccf523fa34ac19c2eb804e6a8d3f08a4e95
 SHA512:
-  metadata.gz: e87f6dc580136e18fc8fc95e527cd0cd3cc53d707e29531131253f405f5c62a789f86b396708011307a4e3bb3f7346a426b6a3beb78383461c105c6213fed6af
-  data.tar.gz: c1b1037ba4e4e192a0a46ea149157f141166ceed57ea42062f18ca0b448775ec0f71f6dcfb6dc69cac91d2ae46e641e3d6851d4aab96882c15905c9db894ab11
+  metadata.gz: 8cab8dae514a9c0b5a16a061a14aee10575d0540270f42235fac3db27f4b5699118458791686556c043ce14bb1770430d1101f6dcb98570a263a5fe51c7cef8b
+  data.tar.gz: 6e2c93955b60e7bd0efb731d218d2ede540c67b77cc90f7cb4e0eaa814f66554692b1d1023e9fabed4d232d9d76a5de48aad5e99d88226a2d22b0ecce4d461b9

data/README.md

@@ -68,6 +68,8 @@ and can be used with OO-style, for example: `role.permissions.project.create?`
 
 There also support permission groups, and groups support nesting.
 
+**You don't need to any migration when you changing definitions.**
+
 I18n is supported too.
 
 In fact, the essence of permissions is Hash, keys are permissions, and values are booleans. so computing of permissions with many roles, can be understood as computing of Hashes.
@@ -345,6 +347,57 @@ You can check dummy app for better understanding.
 See [RolesController in dummy app](https://github.com/rails-engine/role_core/blob/master/test/dummy/app/controllers/roles_controller.rb)
 and relates [view](https://github.com/rails-engine/role_core/blob/master/test/dummy/app/views/roles/_form.html.erb) for details.
 
+## Hacking
+
+RoleCore is a Rails engine, and following [the official best practice](http://guides.rubyonrails.org/engines.html#overriding-models-and-controllers), so you can  extend RoleCore by the article suggests.
+
+### Integrate to existing role model
+
+For some reason, you want to use RoleCore's ability and keeping use your own role model, e.g: integrate with [rolify](https://github.com/RolifyCommunity/rolify).
+
+You can archive this goal by:
+
+- Modify the migration file which RoleCore generated, changing the role table name
+- Add `include RoleCore::Concerns::Models::Role` to your role model
+
+*Note: If you want another column name or there's no name in your role model, you need to lookup `RoleCore::Concerns::Models::Role` source code, copy and modify to fit your needs*
+
+### Dynamic permissions
+
+By design, RoleCore is for static permissions, but dynamic permissions is easy to support.
+
+The key is `RoleCore::PermissionSet#derive`, that will generate a new anonymous sub-class of `PermissionSet`.
+
+There's a example:
+
+- Design a model to persisting dynamic permissions, e.g `DynamicPermission(id: bigint, name: string, default: bool)`
+- Add `dynamic_permissions` column (`text` type) to Role model to persisting dynamic permissions' configuration, and in your model `serialize :dynamic_permissions, Hash`
+- Generate dynamic permissions set in runtime
+  ```ruby
+  # Create a new permission set to containerize dynamic permissions
+  # `"Dynamic"` can be named to other but must be a valid Ruby class name, 
+  # that's a hacking for `ActiveModel::Naming`,
+  # and can be used as I18n key, in this case, the key is `role_core/models/dynamic`.
+  dynamic_permission_set_class = PermissionSet.derive "Dynamic"
+
+  # Fetching dynamic permissions
+  dynamic_permissions = DynamicPermission.all
+
+  # Mapping dynamic permissions to permission set
+  dynamic_permission_set_class.draw do
+    dynamic_permissions.each do |p|
+      permission p.name, default: p.default
+    end
+  end
+  ```
+- Create a instance of this dynamic permission set
+  ```ruby
+  dynamic_permissions = dynamic_permission_set_class.new(role.dynamic_permissions)
+  ```
+- You can use the `dynamic_permissions` now
+
+Rails' `serialize` is static so you must do serialize and deserialize manually, you can wrap these logic into model.
+
 ## Contributing
 
 Bug report or pull request are welcome.

data/lib/generators/role_core/config/templates/role_core.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
-# YOU NEED TO RESTART APP AFTER CHANGING THIS FILE
+# Be sure to restart your server when you modify this file.
+
+# For I18n, see `config/locales/role_core.en.yml` for details which followed the rule of ActiveRecord's I18n,
+# See <http://guides.rubyonrails.org/i18n.html#translations-for-active-record-models>.
 
 # Uncomment below if you want to integrate with CanCanCan
 #

data/lib/role_core/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RoleCore
-  VERSION = "0.0.20"
+  VERSION = "0.0.21"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: role_core
 version: !ruby/object:Gem::Version
-  version: 0.0.20
+  version: 0.0.21
 platform: ruby
 authors:
 - jasl
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-13 00:00:00.000000000 Z
+date: 2018-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -34,16 +34,22 @@ dependencies:
   name: options_model
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.10
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.10
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 description: RoleCore is a Rails engine which could provide essential industry of
   Role-based access control.
 email: