role_core 0.0.25 → 0.0.28

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 588687072ceb69fb165d2c7f86d8bb0dae0c814d33049221466dc4c0adcacfb0
-  data.tar.gz: 2c0cf9515890e0389246d4fb4f570b3f39aae95781ad616d0c6306917df25a55
+  metadata.gz: 39af11ea76fcb0c8a0ff489e44f929ed64fbdd18ae64f5f59f6768a000f8895a
+  data.tar.gz: 4d7b1901033d603da7c7f2b6247f19f120cc18ee1ccf3dbab5045a7b2a385098
 SHA512:
-  metadata.gz: 1c1419d298d3664ea384f88d68db83fd4209bda7827e826ede86c5720d170b3d83874e8df9650917a5ca93dac0ff79c4bda3a5f1e7d67c1cc292396ef46d6a14
-  data.tar.gz: 83d4392b01a8766946f8c1e8fd1695d481f351d24628feab71724982c0c7d883b5b691ea961e29e73809ff73974fbcaab4c1158772a392ebd8d5ae56aecf3f52
+  metadata.gz: 8649c664d4da57eb8665308dd58d2b1795dd619ff6b5e9be9611904b816e66ecbb28482bf25fa857e51a2b964966f655f2e9bddfb55a2c6c36a3506f86b927ab
+  data.tar.gz: d020474094ece60f11a0a8aa350acfa97598eecd492d106799327a10942966d4287fc0ffe4792658143a7d269b7e023e130b6d478723857be273151e95ffd000

data/README.md

@@ -76,8 +76,8 @@ In fact, the essence of permissions is Hash, keys are permissions, and values ar
 
 ### Management UI
 
-Building a management UI is difficult, 
-but virtual model technique will translates permissions to a virtual model's (a class that conforms to ActiveModel) attributes, 
+Building a management UI is difficult,
+but virtual model technique will translates permissions to a virtual model's (a class that conforms to ActiveModel) attributes,
 and groups will translates to nested virtual models,
 that means you can use all Rails view helpers including the mighty form builder,
 and can benefit to Strong Parameter.
@@ -98,7 +98,13 @@ RoleCore can be working with CanCanCan, Pundit easily and happily.
 Add this line to your Gemfile:
 
 ```ruby
-gem 'role_core'
+gem "role_core"
+```
+
+if your Rails < 7 or met `visit_Psych_Nodes_Alias': Unknown alias: redis (Psych::BadAlias)`, add this line:
+
+```ruby
+gem "psych", "~> 3.3"
 ```
 
 Then execute:
@@ -138,6 +144,8 @@ $ bin/rails g role_core:model
 Permissions are defined in `config/initializers/role_core.rb`,
 checking it to know how to define permissions.
 
+(If you want to define permissions in runtime, check [Dynamic Permissions](https://github.com/rails-engine/role_core#dynamic-permissions))
+
 In addition, there also includes a directive about how to integrate with CanCanCan.
 
 #### I18n
@@ -305,7 +313,7 @@ class PostPolicy
   def update?
     user.permissions.post.update?
   end
-  
+
   def update_my_own?
     return true if user.permissions.post.update?
     return unless user.permissions.post.update_my_own?
@@ -325,7 +333,7 @@ Open your User model:
   Add a delegate to User model:
 
   ```ruby
-  delegate :computed_permissions, to: :role
+    delegate :computed_permissions, to: :role
   ```
 
 - For a user who has multiple roles:
@@ -340,6 +348,20 @@ Open your User model:
 
 Open `app/models/ability.rb`, add `user.computed_permissions.call(self, user)` to `initialize` method.
 
+```ruby
+class Ability
+  include CanCan::Ability
+
+  def initialize(user)
+    # Apply RoleCole managing permissions
+    user.computed_permissions.call(self, user)
+
+    # You still can add other permissions
+    can :read_public, :all
+  end
+end
+```
+
 You can check dummy app for better understanding.
 
 ### Management UI
@@ -366,37 +388,7 @@ You can archive this goal by:
 
 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`.
-
-Here's an 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.
+See [example](test/dummy/app/models/team.rb) in dummy app and relates [view](test/dummy/app/views/teams/_permissions.html.erb) for details.
 
 ## Contributing
 

data/Rakefile

@@ -16,7 +16,7 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include("lib/**/*.rb")
 end
 
-APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+APP_RAKEFILE = File.expand_path("test/dummy/Rakefile", __dir__)
 load "rails/tasks/engine.rake"
 
 load "rails/tasks/statistics.rake"

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

@@ -3,7 +3,7 @@
 module RoleCore
   module Generators
     class ConfigGenerator < Rails::Generators::Base
-      source_root File.expand_path("../templates", __FILE__)
+      source_root File.expand_path("templates", __dir__)
 
       def generate_config
         copy_file "role_core.rb", "config/initializers/role_core.rb"

data/lib/generators/role_core/model/model_generator.rb

@@ -3,7 +3,7 @@
 module RoleCore
   module Generators
     class ModelGenerator < Rails::Generators::Base
-      source_root File.expand_path("../templates", __FILE__)
+      source_root File.expand_path("templates", __dir__)
 
       def generate_model
         copy_file "role.rb", "app/models/role.rb"

data/lib/role_core/computed_permissions.rb

@@ -26,9 +26,9 @@ module RoleCore
 
     private
 
-    def regroup!
-      @permissions.uniq!
-      @permissions.sort_by!(&:priority)
-    end
+      def regroup!
+        @permissions.uniq!
+        @permissions.sort_by!(&:priority)
+      end
   end
 end

data/lib/role_core/concerns/models/role.rb

@@ -15,7 +15,7 @@ module RoleCore::Concerns
       end
 
       def permissions_attributes=(value)
-        permissions.update_attributes value
+        self[:permissions].replace value
       end
     end
   end

data/lib/role_core/contrib/can_can_can_permission.rb

@@ -11,7 +11,7 @@ module RoleCore
       @model_name = options[:model_name]
       @subject = options[:subject]
       @action = options[:action] || name
-      @options = options.except(:model, :model_name, :subject, :action)
+      @options = options.except(:model, :model_name, :subject, :action, :_namespace, :_priority, :_callable)
       @block = block
     end
 

data/lib/role_core/mapper.rb

@@ -2,7 +2,7 @@
 
 module RoleCore
   class Mapper
-    def initialize(set, **constraints) #:nodoc:
+    def initialize(set, constraints = {}) # :nodoc:
       @constraints = constraints
       @constraints[:_namespace] ||= []
       @set = set
@@ -13,7 +13,7 @@ module RoleCore
       self
     end
 
-    def group(name, **constraints, &block)
+    def group(name, constraints = {}, &block)
       raise ArgumentError, "`name` can't be blank" if name.blank?
       raise ArgumentError, "must provide a block" unless block_given?
 
@@ -21,7 +21,7 @@ module RoleCore
       constraints[:_namespace] << name
 
       sub_permission_set_class =
-        if @set.nested_classes.has_key?(name)
+        if @set.nested_classes.key?(name)
           @set.nested_classes[name]
         else
           klass_name = constraints[:_namespace].map { |n| n.to_s.classify }.join("::")

data/lib/role_core/permission.rb

@@ -4,25 +4,21 @@ module RoleCore
   class Permission
     attr_reader :name, :namespace, :priority, :callable
 
-    def initialize(name, _namespace: [], _priority: 0, _callable: false, **options, &block)
+    def initialize(name, _namespace: [], _priority: 0, _callable: false, **_options, &_block)
       @name = name
       @namespace = _namespace
       @priority = _priority
       @callable = _callable
     end
 
-    def call(context, *)
+    def call(_context, *)
       raise NotImplementedError
     end
 
-    def hash
-      instance_values.hash
-    end
+    delegate :hash, to: :instance_values
 
     def ==(other)
-      unless other.is_a?(RoleCore::Permission)
-        return false
-      end
+      return false unless other.is_a?(RoleCore::Permission)
 
       instance_values == other.instance_values
     end

data/lib/role_core/permission_set.rb

@@ -8,9 +8,7 @@ module RoleCore
 
     def computed_permissions(include_nesting: true)
       permissions = self.class.registered_permissions.slice(*permitted_permission_names).values
-      if include_nesting && nested_attributes.any?
-        permissions.concat nested_attributes.values.map(&:computed_permissions).flatten!
-      end
+      permissions.concat nested_attributes.values.map(&:computed_permissions).flatten! if include_nesting && nested_attributes.any?
 
       ComputedPermissions.new(permissions)
     end
@@ -29,17 +27,13 @@ module RoleCore
       end
 
       def permission_class=(klass)
-        unless klass && klass < Permission
-          raise ArgumentError, "#{klass} should be sub-class of #{Permission}."
-        end
+        raise ArgumentError, "#{klass} should be sub-class of #{Permission}." unless klass && klass < Permission
 
         @permission_class = klass
       end
 
-      def draw(**constraints, &block)
-        unless block_given?
-          raise ArgumentError, "must provide a block"
-        end
+      def draw(constraints = {}, &block)
+        raise ArgumentError, "must provide a block" unless block_given?
 
         Mapper.new(self, constraints).instance_exec(&block)
 
@@ -50,11 +44,16 @@ module RoleCore
         @registered_permissions ||= ActiveSupport::HashWithIndifferentAccess.new
       end
 
-      def register_permission(name, default = false, **options, &block)
+      def register_permission(name, default = false, options = {}, &block)
         raise ArgumentError, "`name` can't be blank" if name.blank?
 
         attribute name, :boolean, default: default
-        registered_permissions[name] = permission_class.new name, options, &block
+        registered_permissions[name] = permission_class.new name, **options, &block
+      end
+
+      PERMITTED_ATTRIBUTE_CLASSES = [Symbol].freeze
+      def permitted_attribute_classes
+        PERMITTED_ATTRIBUTE_CLASSES
       end
     end
   end

data/lib/role_core/version.rb

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

data/lib/role_core.rb

@@ -17,9 +17,7 @@ module RoleCore
     end
 
     def permission_set_class=(klass)
-      unless klass && klass < PermissionSet
-        raise ArgumentError, "#{klass} should be sub-class of #{PermissionSet}."
-      end
+      raise ArgumentError, "#{klass} should be sub-class of #{PermissionSet}." unless klass && klass < PermissionSet
 
       @permission_set_class = klass.derive "Global"
     end
@@ -29,9 +27,7 @@ module RoleCore
     end
 
     def permission_class=(klass)
-      unless klass && klass < Permission
-        raise ArgumentError, "#{klass} should be sub-class of #{Permission}."
-      end
+      raise ArgumentError, "#{klass} should be sub-class of #{Permission}." unless klass && klass < Permission
 
       @permission_class = klass
     end

metadata

@@ -1,55 +1,55 @@
 --- !ruby/object:Gem::Specification
 name: role_core
 version: !ruby/object:Gem::Version
-  version: 0.0.25
+  version: 0.0.28
 platform: ruby
 authors:
 - jasl
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-04-14 00:00:00.000000000 Z
+date: 2022-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: options_model
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
+        version: 0.0.15
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
+        version: 0.0.15
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: options_model
+  name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.12
+        version: '5'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.0.12
+        version: '5'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '8'
 description: RoleCore is a Rails engine which could provide essential industry of
   Role-based access control.
 email:
@@ -85,7 +85,7 @@ homepage: https://github.com/rails-engine/role_core
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -100,8 +100,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.3.4
+signing_key:
 specification_version: 4
 summary: RoleCore is a Rails engine which could provide essential industry of Role-based
   access control.