i_am_i_can 4.2.0 → 4.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: edde7fa4072a2d78c7b5017f9d42e0aab9925f1f
-  data.tar.gz: 99d658e9ce576ed82207f577cfcba96202a6cdfc
+  metadata.gz: 7afc85dd06b6aefeec8da4d575782398aca2f5c0
+  data.tar.gz: f23e1e9768cbfdac758e7df5a3be484ebbebf2e8
 SHA512:
-  metadata.gz: 195ed325b75c8b7a7b7e94cb6cd601214451044f438f25c26c357187d9cd229ca5c37000cf5ca28b03f95b22964be0f3e7131f4c4cc36926036ccc75d9871d2b
-  data.tar.gz: 96a3122e55433bfb0115051c4da61fd465d9909e4d977fb7a84819d8dd88c310aa87e58ea30397c9bdb2fb71bb27362f4fc5ddfa136f3f8ef5d8dc551a2c37dd
+  metadata.gz: 6aa217add1124db25b3f79d5a3ff40ee43b18dcb28dfaad9fc9ebbd4d7eb3997be8bdb18f0ce88492817296b0aaae31963a935a4f54ea180d4c457730b773aca
+  data.tar.gz: ef73fda2b4d9bdcbe779d5a748ddfafe09561943f4520620cf441ae852bc1fa9f2b7db7afd978d5cca845740b0271ed63bb76f27d3781feeba0dd2bd5aca14c6

data/README.md

@@ -168,8 +168,9 @@ Very simple. Really simple. Sooooo Simple.
 
     ```ruby
     class User
-      has_and_belongs_to_many :stored_roles,
-                              join_table: 'users_and_user_roles', foreign_key: 'user_role_id', class_name: 'UserRole', association_foreign_key: 'user_id'
+      has_and_belongs_to_many :stored_roles, -> { where('expire_at IS NULL OR expire_at > ?', Time.current) },
+                              join_table: 'users_and_user_roles', foreign_key: 'user_id', 
+                              class_name: 'UserRole', association_foreign_key: 'user_role_id'
       has_many_temporary_roles
       acts_as_subject
     end
@@ -255,7 +256,7 @@ UserRoleGroup.which(name: :vip).members.names # => %i[vip1 vip2 vip3]
         2. `has_role` / `has_roles`
         3. `role_is` / `role_are`
     2. `is_a_temporary`: just like the name, the assignment occurs only
-       in instance variable (will be in the cache).
+       in **instance variable** not in database (will be in the cache).
 3. cancel assignment by calling:
     1. `falls_from`, or it's aliases:
         1. `removes_role`
@@ -273,6 +274,7 @@ UserRoleGroup.which(name: :vip).members.names # => %i[vip1 vip2 vip3]
     1. relation with stored role, defaults to `stored_roles`.
     2. `temporary_roles` and `valid_temporary_roles`
     3. `roles`
+    4. `assoc_with_<roles>`, like: `assoc_with_stored_roles`
 
 Explanation:
 ```ruby
@@ -284,10 +286,23 @@ User.have_roles :admin, :coder
 # method signature
 becomes_a *roles, which_can: [ ], obj: nil,
                   _d: config.auto_definition,
-                  auto_definition: _d || which_can.present?
-# examples
+                  auto_definition: _d || which_can.present?,
+                  expires_in: nil, expires_at: (expires_in.after if expires_in)
+# 1. example of giving Symbol to `roles` params
 he.becomes_a :admin # => 'Role Assignment Done' or error message
 he.stored_roles     # => [<#UserRole id: 1>]
+# 2. example of giving role instances to `roles` params
+he.becomes_a *UserRole.all # => 'Role Assignment Done' or error message
+he.stored_roles     # => [<#UserRole id: 1>, <#UserRole id: 2>]
+# 3. `expires` (subject assocates roles with a `expire_at` scope)
+he.is_a :visitor, expires_in: 1.hour # or `expires_at: 1.hour.after`
+he.is? :visitor     # => true
+#   an hour later ...
+he.is? :visitor     # => false
+
+# assoc_with_<roles>: for getting the relation records between subject and it's roles
+he.assoc_with_stored_roles # => UsersAndUserRoles::ActiveRecord_Associations_CollectionProxy
+
 
 # === Temporary Assignment ===
 # signature as `becomes_a`
@@ -394,6 +409,8 @@ can *actions, resource: nil, obj: resource, # you can use `resource` or `obj`
 # examples
 role.can :fly # => 'Permission Assignment Done' or error message
 role.permissions # => [<#UserPermission id: ..>]
+# you can also passing permission instances to `actions` params, like:
+role.can *UserPermission.all
 
 # === Cancel Assignment ===
 # method signature

data/lib/generators/i_am_i_can/setup_generator.rb

@@ -52,8 +52,9 @@ module IAmICan
         puts "\nAdd the code below to #{name_c}:".green
         puts <<~TIPS
           |
-          |  has_and_belongs_to_many :stored_roles,
-          |                          join_table: '#{subj_role_tb}', foreign_key: '#{role_u}_id', class_name: '#{role_c}', association_foreign_key: '#{name_u}_id'
+          |  has_and_belongs_to_many :stored_roles, -> { where('expire_at IS NULL OR expire_at > ?', Time.current) },
+          |                          join_table: '#{subj_role_tb}', foreign_key: '#{name_u}_id', 
+          |                          class_name: '#{role_c}', association_foreign_key: '#{role_u}_id'
           |
           |  has_many_temporary_roles  
           |

data/lib/generators/i_am_i_can/templates/migrations/i_am_i_can.erb

@@ -41,11 +41,12 @@ class <%= name_c %>Am<%= name_c %>Can < ActiveRecord::Migration::Current
     create_table :<%= subj_role_tb %>, id: false, force: :cascade do |t|
       t.belongs_to :<%= name_u %>, null: false#, index: false
       t.belongs_to :<%= role_u %>, null: false#, index: false
+      t.datetime   :expire_at
     end
 
     # add_index :<%= subj_role_tb %>, :<%= name_u %>_id, name: ':<%= subj_role_tb %>_index1'
     # add_index :<%= subj_role_tb %>, :<%= role_u %>_id, name: ':<%= subj_role_tb %>_index2'
-    add_index :<%= subj_role_tb %>, [ :<%= name_u %>_id, :<%= role_u %>_id ],
+    add_index :<%= subj_role_tb %>, [ :<%= name_u %>_id, :<%= role_u %>_id, :expire_at ],
               unique: true, name: '<%= subj_role_tb %>_uniq_index'
 
     # === end of subject-role table ===

data/lib/generators/i_am_i_can/templates/models/permission.erb

@@ -1,9 +1,11 @@
 class <%= permission_c %> < ActiveRecord::Base
   has_and_belongs_to_many :related_roles,
-                          join_table: '<%= role_pms_tb %>', foreign_key: :<%= role_u %>_id, class_name: '<%= role_c %>', association_foreign_key: :<%= permission_u %>_id
+                          join_table: '<%= role_pms_tb %>', foreign_key: :<%= permission_u %>_id,
+                          class_name: '<%= role_c %>', association_foreign_key: :<%= role_u %>_id
 <% unless @ii_opts[:without_group] %>
   has_and_belongs_to_many :related_role_groups,
-                          join_table: '<%= group_pms_tb %>', foreign_key: :<%= group_u %>_id, class_name: '<%= group_c %>', association_foreign_key: :<%= permission_u %>_id
+                          join_table: '<%= group_pms_tb %>', foreign_key: :<%= permission_u %>_id,
+                          class_name: '<%= group_c %>', association_foreign_key: :<%= group_u %>_id
 <% end %>
   belongs_to :resource, polymorphic: true
 

data/lib/generators/i_am_i_can/templates/models/role.erb

@@ -1,12 +1,15 @@
 class <%= role_c %> < ActiveRecord::Base
   has_and_belongs_to_many :related_users,
-                          join_table: '<%= subj_role_tb %>', foreign_key: :<%= name_u %>_id, class_name: '<%= name_c %>', association_foreign_key: :<%= role_u %>_id
+                          join_table: '<%= subj_role_tb %>', foreign_key: :<%= role_u %>_id,
+                          class_name: '<%= name_c %>', association_foreign_key: :<%= name_u %>_id
 <% unless @ii_opts[:without_group] %>
   has_and_belongs_to_many :related_groups,
-                          join_table: '<%= group_role_tb %>', foreign_key: :<%= group_u %>_id, class_name: '<%= group_c %>', association_foreign_key: :<%= role_u %>_id
+                          join_table: '<%= group_role_tb %>', foreign_key: :<%= role_u %>_id,
+                          class_name: '<%= group_c %>', association_foreign_key: :<%= group_u %>_id
 <% end %>
   has_and_belongs_to_many :permissions,
-                          join_table: '<%= role_pms_tb %>', foreign_key: :<%= permission_u %>_id, class_name: '<%= permission_c %>', association_foreign_key: :<%= role_u %>_id
+                          join_table: '<%= role_pms_tb %>', foreign_key: :<%= role_u %>_id,
+                          class_name: '<%= permission_c %>', association_foreign_key: :<%= permission_u %>_id
 
   acts_as_role
 

data/lib/generators/i_am_i_can/templates/models/role_group.erb

@@ -1,9 +1,11 @@
 class RoleGroup < ActiveRecord::Base
   has_and_belongs_to_many :permissions,
-                          join_table: '<%= group_pms_tb %>', foreign_key: :<%= permission_u %>_id, class_name: '<%= permission_c %>', association_foreign_key: :<%= group_u %>_id
+                          join_table: '<%= group_pms_tb %>', foreign_key: :<%= group_u %>_id,
+                          class_name: '<%= permission_c %>', association_foreign_key: :<%= permission_u %>_id
 
   has_and_belongs_to_many :members,
-                          join_table: '<%= group_role_tb %>', foreign_key: :<%= role_u %>_id, class_name: '<%= role_c %>', association_foreign_key: :<%= group_u %>_id
+                          join_table: '<%= group_role_tb %>', foreign_key: :<%= group_u %>_id,
+                          class_name: '<%= role_c %>', association_foreign_key: :<%= role_u %>_id
 
   acts_as_role_group
 

data/lib/i_am_i_can/permission/definition.rb

@@ -1,8 +1,8 @@
 module IAmICan
   module Permission
     module Definition
-      def have_permission *actions, obj: nil
-        permissions = actions.product(Array[obj]).map { |(p, o)| { action: p, **deconstruct_obj(o) } }
+      def have_permission *actions, obj: nil, remarks: nil
+        permissions = actions.product(Array[obj]).map { |(p, o)| { action: p, **deconstruct_obj(o), remarks: remarks } }
         definition = _create_permissions(permissions)
         ResultOf.roles definition, i_am_i_can, given: permissions.map { |pms| pms.values.compact.join('_').to_sym }
       end

data/lib/i_am_i_can/role/assignment.rb

@@ -2,12 +2,11 @@ module IAmICan
   module Role
     module Assignment
       def becomes_a *roles, which_can: [ ], obj: nil,
-                    _d: i_am_i_can.auto_definition,
-                    auto_definition: _d || which_can.present?,
-                    save: true
+                    _d: i_am_i_can.auto_definition, auto_definition: _d || which_can.present?,
+                    expires_in: nil, expires_at: (expires_in.after if expires_in), save: true
         self.class.have_roles *roles, which_can: which_can, obj: obj if auto_definition
         run_callbacks(:role_assign) do
-          _roles_assignment(roles, save)
+          _roles_assignment(roles, save, exp: expires_at)
         end
       end
 
@@ -35,10 +34,11 @@ module IAmICan
       %i[ is_not_a will_not_be removes_role leaves has_not_role has_not_roles ].each { |aname| alias_method aname, :falls_from }
       %i[ currently_is_a ].each { |aname| alias_method aname, :is_only_a }
 
-      def _roles_assignment(action = :assign, roles, save)
+      def _roles_assignment(action = :assign, roles, save, exp: nil)
         instances, names = Role.extract(roles, i_am_i_can)
         if save
           assignment = _stored_roles_exec(action, instances, name: names)
+          _set_roles_expire(exp, assignment.map(&:id)) if exp
         else
           to_be_assigned_names = (instances.map(&:name).map(&:to_sym) + names).uniq
           assignment = _temporary_roles_exec(action, to_be_assigned_names)
@@ -46,6 +46,12 @@ module IAmICan
 
         ResultOf.role assignment, i_am_i_can, given: [instances, names]
       end
+
+      def _set_roles_expire(exp, ids)
+        send("assoc_with_#{__roles}")
+            .where("#{i_am_i_can.role_class.underscore}_id" => ids)
+            .update_all(expire_at: exp)
+      end
     end
   end
 end

data/lib/i_am_i_can/role/definition.rb

@@ -1,10 +1,10 @@
 module IAmICan
   module Role
     module Definition
-      def have_role *roles, which_can: [ ], obj: nil
+      def have_role *roles, which_can: [ ], obj: nil, remarks: nil
         return unless roles.first.class.in?([ Symbol, String ])
         roles.map!(&:to_sym) ; i = i_am_i_can
-        definition = _create_roles(roles.map { |role| { name: role } })
+        definition = _create_roles(roles.map { |role| { name: role, remarks: remarks } })
 
         Role.modeling(roles, i).each { |r| r.can *which_can, obj: obj, auto_definition: true } if which_can.present?
         ResultOf.roles definition, i, given: roles

data/lib/i_am_i_can/subject.rb

@@ -10,6 +10,11 @@ module IAmICan
 
     included do
       define_model_callbacks :role_assign, :cancel_role_assign, :role_update
+
+      Object.const_set (role_assoc_class = reflections[__roles].options[:join_table].camelize),
+                       Class.new(ActiveRecord::Base)
+      has_many :"assoc_with_#{__roles}", -> { where('expire_at IS NULL OR expire_at > ?', Time.current) },
+               class_name: role_assoc_class
     end
   end
 end

data/lib/i_am_i_can/support/reflection.rb

@@ -27,8 +27,10 @@ module IAmICan
     included do
       # user._roles => Association CollectionProxy, same as: `user.stored_roles`
       %w[ subjects roles role_groups permissions ].each do |k|
+        delegate "__#{k}", to: self
+
         define_method "_#{k}" do
-          send(self.class.send("__#{k}")) rescue (raise NoMethodError)
+          send(send("__#{k}")) rescue (raise NoMethodError)
         end
       end
     end

data/lib/i_am_i_can/version.rb

@@ -1,3 +1,3 @@
 module IAmICan
-  VERSION = '4.2.0'
+  VERSION = '4.3.0'
 end

data/lib/i_am_i_can.rb

@@ -16,6 +16,7 @@ require 'i_am_i_can/resource'
 module IAmICan
   def acts_as_subject
     i_am_i_can&.act = :subject
+    include Reflection
     include Subject
 
     extend  Role::Definition
@@ -24,7 +25,6 @@ module IAmICan
     include Subject::RoleQuerying
     include Subject::PermissionQuerying
 
-    include Reflection
     instance_exec(%i[ role ], &Dynamic.scopes)
     instance_exec(&Dynamic.class_reflections)
     instance_exec(%w[ role ], &Dynamic.assignment_helpers)
@@ -33,12 +33,12 @@ module IAmICan
 
   def acts_as_role
     i_am_i_can&.act = :role
+    include Reflection
     include Role
 
     extend  Permission::Definition
     include Permission::Assignment
 
-    include Reflection
     instance_exec(%i[ subject role_group permission ], &Dynamic.scopes)
     instance_exec(&Dynamic.class_reflections)
     instance_exec(%w[ permission ], &Dynamic.assignment_helpers)
@@ -50,6 +50,7 @@ module IAmICan
 
   def acts_as_role_group
     i_am_i_can&.act = :role_group
+    include Reflection
     include Role
     # include RoleGroup
 
@@ -57,7 +58,6 @@ module IAmICan
     extend  Permission::Definition
     include Permission::Assignment
 
-    include Reflection
     instance_exec(%i[ permission role ], &Dynamic.scopes)
     instance_exec(&Dynamic.class_reflections)
     instance_exec(%w[ role permission ], &Dynamic.assignment_helpers)
@@ -69,9 +69,9 @@ module IAmICan
 
   def acts_as_permission
     i_am_i_can&.act = :permission
+    include Reflection
     include Permission
 
-    include Reflection
     instance_exec(%i[ role role_group ], &Dynamic.scopes)
     instance_exec(&Dynamic.class_reflections)
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: i_am_i_can
 version: !ruby/object:Gem::Version
-  version: 4.2.0
+  version: 4.3.0
 platform: ruby
 authors:
 - zhandao
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-12-10 00:00:00.000000000 Z
+date: 2018-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler