dynamican 0.1.7 → 0.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d6dd7da02224c7b3e20e8b582f5929657255d33d4ddf81037a09e2c303df7182
-  data.tar.gz: 1c7f34c8b6335a89c21087243bdcaec746966ff76c7bc076204aefa736fce121
+  metadata.gz: 2919c67cd907ca110db119ff27da8eb0ab7dc7fef6d9911de9b2ed04fdd111e2
+  data.tar.gz: 3e89dcbe20185469f70b2d066264f848be3c8ef92b0f9e18771a9b6bc23d69a3
 SHA512:
-  metadata.gz: ea646968f0358bada82722bda78c2895bd6763428823f02ab51866caedbd45e7af0f411b5e77850e2bb71f83751503922aed96cb39b906fd344ebcca453154d9
-  data.tar.gz: 3c29cc459e4aff80101d2ec436deba04c3600410e030cc4e3cf09ad575df8b3cd1f93602a8639937930733c82513a6ea8293eeddbb309cd9cb5afe7159bfd329
+  metadata.gz: f97e9268851d07d730e2d4cada589ed6c35ae57f8d127854d4199cd93b464dd1de342c6b9e674434be535a09ca9be8a52ad811d0fde348c846148b0c62494c3e
+  data.tar.gz: 35b2f9fe8360a9cbd4e9627b9a4249ee6aca206d6a394f2a8909ea8b74e53605eb64cc04119d1c11ad0d871a06d85313c81d2e89c1faa6bba2d17b79714a0411

data/README.md

@@ -1,20 +1,18 @@
 # Dynamican
-Dynamican is a flexible gem to introduce permissions on rails applications. It is very customizable because it stores all the rules inside the database and can be added to multiple models: for example you can add permissions to your Role model or to users. With a couple of overrides you can also add permissions to both Role and User and use role permissions through user.
+Dynamican is a flexible gem which introduces permissions on rails applications. It is very customizable because it stores all the rules inside the database and can be added to multiple models: for example you can add permissions to your Role and User models. With a couple of overrides you can also add permissions to both Role and User and allow user to use its roles permissions.
 
 ## Installation
 Inside your Gemfile put
 
     gem 'dynamican'
 
-then run `bundle install`
+and then run `bundle install`
 
-Once you have the gem, open the source code and look for migrations folder. You need to create in your project those migrations and run them. Obviously if you already have the gem installed and you are only updating, you only need to create the migrations for the later versions of the gem.
-
-In each model you want to have the feature, just put
+In each model you want to have the feature, just put the following.
 
     include Dynamican::Model
 
-Create `config/dynamican.yml` file and compile it as follows for each of the models you included the code above into (let's say for instance you included Dynamican::Model into User and Role models)
+Create `config/dynamican.yml` file in your project and compile it as follows for each of the models you included the code above into (let's say for instance you included Dynamican::Model into User and Role models).
 
     associations:
       role:
@@ -22,9 +20,15 @@ Create `config/dynamican.yml` file and compile it as follows for each of the mod
       user:
         class_name: 'User'
 
-### Using permissions on one model through another model
+Once this config file is created, you can launch the following command.
+
+    rails generate dynamican_migration
+
+This command will generate a migration file in your project. Inside this migration, the `permission_connectors` table will have a reference column for the models you configured in the config file. If you want to add the feature to a new model after your migrations are already run (and cannot be rollbacked) you need to create a new migration to add the corresponding columns in the `permission_connectors` table.
+
+### Using a model permissions on another model
 
-I wanted to have the possibility to assign permissions both directly to my User model and my Role model, so that if the User had one permission and one of its Role had another, the User could benefit from both. So i assigned the feature (as explained above) to both models and then decorated my User model like this
+I wanted to have the possibility to assign permissions both directly to my User model and my Role model, so that if the User had one permission and one of its Role had another, the User could benefit from both. So i assigned the feature (as explained above) to both models and then decorated my User model like following.
 
     module Decorators
       module Models
@@ -52,7 +56,9 @@ I wanted to have the possibility to assign permissions both directly to my User
       end
     end
 
-I personally have put this in `app/decorators/models/user/dynamican_overrides.rb` (you need to load the folder if you don't already have it) but you can make it work as you please. I recommend to keep it separate from the original User model though.
+I personally have put this in `app/decorators/models/user/dynamican_overrides.rb` (you need to make rails load the folder if); you can make it work as you please but i recommend to keep it separate from the original User model.
+
+WARNING: if you have done this override, User `permissions` and `permission_connectors` methods are not relations anymore, so methods like `<<` and `create` won't work on them.
 
 ## Usage
 
@@ -65,25 +71,27 @@ Create one `Dynamican::Permission` for each pair of action-object you need. For
     p3 = Dynamican::Permission.create(action: 'update', object_name: 'order')
     p4 = Dynamican::Permission.create(action: 'delete', object_name: 'order')
 
-To assign one of these permissions to your Role or User, you need to create a `Dynamican::PermissionConnector` like this
+To assign one of these permissions to your Role or User, you need to create a `Dynamican::PermissionConnector` like follows.
 
-    user.permission_connectors.create(permission: p1)
+    role.permission_connectors.create(permission: p1)
 
 Or simply
 
-    user.permissions << p1
+    role.permissions << p1
+
+Now your Role is considered able to create orders and you can evaluate permissions with `can?` method.
 
-Now your user is considered able to create orders and you can check the permissions:
+    role.can? :create, :order
 
-    user.can? :create, :order
     # Returns true
 
-    user.can? :read, :order
+    role.can? :read, :order
+
     # Returns false
 
 You can pass as second argument (the object) a symbol, a string, the class itself and also the instance (instances are used for condition evaluations).
-You can also pass an array of these elements and permissions for all elements will be evaluated. The `can?` method will return true only if all permissions are evaluated positively.
-You can also create custom permissions which don't need an object, simply leaving the `object_name` empty. Let's say you want to give permission to a certain user to dance
+If you pass an array of these elements, permissions for all single element will be evaluated. The `can?` method will return true only if permissions to all objects are evaluated positively.
+You can also create custom permissions which don't need an object, simply leaving the `object_name` empty. Let's say you want to give permission to a certain user to dance.
 
     p5 = Dynamican::Permission.create(action: 'dance')
 
@@ -96,23 +104,23 @@ Call the `can?` method without any second argument
     # Returns true
 
 
-## Conditions
+### Conditions
 
-You can link a `Dynamican::PermissionConnector` to as many conditions as you want.
+You can link a `Dynamican::PermissionConnector` to as many conditions as you want. In order to evaluate its conditions, the `conditional` property of the permission_connector needs to be set as `true` (default to `false`)
 
-Conditions are created like this
+Conditions are created like this.
 
     permission_connector.conditions.create(statement: '@user.orders.count < 5')
     permission_connector.conditions.create(statement: '@object.field.present?')
 
-You can store in conditions statements whatever conditions you like in plain ruby and the string will be evaulated. Inside the statements, object have to be called as instance variables. These instance variables need to be present and can be declared as follows:
+You can store in conditions statements whatever conditions you like in plain ruby and the string will be evaulated. Inside the statements, object have to be called as instance variables. These instance variables indeed need to be present and can be declared in a few ways.
 
-1. The model name of the instance you called `can?` from, like the user, will be defined automatically based on model name so if you call `user.can?` you will have `@user` variable defined.
+1. The model name of the instance you called `can?` from, like the user, will be defined automatically based on model name, so if you call `user.can?` you will have `@user` variable defined.
 2. The object you pass as second argument (which should match the `object_name` of your permission) will be defined as `@object`, so if you call `user.can? :read, @order` you will have `@object` variable defined containing your `@order`.
 3. You can pass as third argument an hash of objects like this `user.can? :read, @order, time: Time.zone.now, whatever: @you_want` and you will have `@time` and `@whatever` variables defined.
 
-WARNING: since the condition statement gets evaluated, i recommend not to allow anyone except project developers to create conditions to prevent malicious code from being executed.
+WARNING: since the condition statement gets evaluated, i recommend not to allow anyone except project developers to create conditions, in order to prevent malicious code from being executed.
 
-If one `Dynamican::PermissionConnector` is linked to many conditions, the model will be allowed to make that action only if all conditions are true. If you want to set alternative conditions, you should store the or conditions inside the same statement, like this:
+If one `Dynamican::PermissionConnector` is linked to many conditions, the model will be allowed to make that action only if all conditions are true. If you want to set alternative conditions, you should store the `or` conditions inside the same condition statement, like this:
 
     condition.statement = '@user.nice? || @user.polite?'

data/dynamican.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
   s.name        = 'dynamican'
-  s.version     = '0.1.7'
-  s.date        = '2020-04-12'
+  s.version     = '0.1.9'
+  s.date        = '2020-04-18'
   s.summary     = "Dynamic permissions"
   s.description = "Dynamic and flexible database configurable permissions for your application"
   s.authors     = ["Valerio Bellaveglia"]

data/lib/dynamican.rb

@@ -4,3 +4,4 @@ require 'dynamican/model'
 require 'models/dynamican/condition'
 require 'models/dynamican/permission_connector'
 require 'models/dynamican/permission'
+require 'generators/create_dynamican_migration'

data/lib/generators/dynamican_migration_generator.rb

@@ -0,0 +1,59 @@
+require 'rails/generators'
+
+class DynamicanMigrationGenerator < Rails::Generators::Base
+
+  def create_migration_file
+    create_file "db/migrate/#{Time.zone.now.strftime("%Y%m%d%H%M%S")}_dynamican_migration.rb", migration_data
+  end
+
+  private
+
+  def migration_data
+<<MIGRATION
+  class DynamicanMigration < ActiveRecord::Migration[5.2]
+    # 0.1.2 Release
+    def change
+      unless table_exists? :permissions
+        create_table :conditions do |t|
+          t.string :description
+          t.string :statement
+
+          t.timestamps
+        end
+
+        create_table :permissions do |t|
+          t.string :action
+          t.string :object_name
+
+          t.timestamps
+        end
+
+        create_table :permission_connectors do |t|
+          #{create_migration_associations_data}
+          t.references :permission
+          t.boolean :conditional, default: false
+
+          t.timestamps
+        end
+
+        create_table :conditions_permission_connectors do |t|
+          t.bigint :condition_id
+          t.bigint :permission_connector_id
+        end
+      end
+    end
+  end
+MIGRATION
+  end
+
+  def create_migration_associations_data
+    migration_associations_data = ""
+    associations = Dynamican.configuration.associations.keys
+
+    associations.each do |association|
+      migration_associations_data += "t.references :#{association}#{"\n          " unless association == associations.last}"
+    end
+
+    migration_associations_data
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dynamican
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.9
 platform: ruby
 authors:
 - Valerio Bellaveglia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-12 00:00:00.000000000 Z
+date: 2020-04-18 00:00:00.000000000 Z
 dependencies: []
 description: Dynamic and flexible database configurable permissions for your application
 email: 
@@ -23,10 +23,10 @@ files:
 - lib/dynamican/configuration.rb
 - lib/dynamican/evaluator.rb
 - lib/dynamican/model.rb
+- lib/generators/dynamican_migration_generator.rb
 - lib/models/dynamican/condition.rb
 - lib/models/dynamican/permission.rb
 - lib/models/dynamican/permission_connector.rb
-- migrations/0.1.2/dynamican_create_database_structure.rb
 homepage: https://github.com/ValerioBellaveglia/Dynamican
 licenses:
 - MIT

data/migrations/0.1.2/dynamican_create_database_structure.rb

@@ -1,31 +0,0 @@
-class DynamicanCreateDatabaseStructure < ActiveRecord::Migration[5.2]
-  def change
-    create_table :conditions do |t|
-      t.string :description
-      t.string :statement
-
-      t.timestamps
-    end
-
-    create_table :permissions do |t|
-      t.string :action
-      t.string :object_name
-
-      t.timestamps
-    end
-
-    create_table :permission_connectors do |t|
-      t.references :user
-      t.references :role
-      t.references :permission
-      t.boolean :conditional, default: false
-
-      t.timestamps
-    end
-
-    create_table :conditions_permission_connectors do |t|
-      t.bigint :condition_id
-      t.bigint :permission_connector_id
-    end
-  end
-end