monarchy 2.0.7 → 2.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 387d2b45a06426e506849cb93e65233de8eb28f2
-  data.tar.gz: 7d5bc881940cb9b75831e01fee258a30409bd277
+  metadata.gz: 9a877a7ac740060484a3f64d5d0f9fbb7fcf310b
+  data.tar.gz: f26a5bd2af7906227bb78e9a35937e9bfd2ebe4a
 SHA512:
-  metadata.gz: d3254e9c61cce95221d874bbce2b4f62857f504ba0442f079a24e59d1f37b75f97121482cc2806ee89e9563a6ad8d064b3597a16399312d393c8d3ca34549975
-  data.tar.gz: 791954cbe20ab2d4bbb7ac3c9ebd0a26d1ca7252a8a5e5b265cbfd65303b94adfbe86ee18950c9862a6e43883d98be1b2253819cc46d8b021eb8d2d94ddb14aa
+  metadata.gz: 8727e6be4d706c8117fc1dae73f19bff9cab7e57269c2c85e942f14b4dbf7e9e761a065ecd8d031fe13c39ce1b6961073dd8e4d6e4937e2c558253bc910668e0
+  data.tar.gz: 2fd0924823fba6765740c972246a1db28cb358be122c290a28957451b85bc886e306ad89d1c6797436f0a74e763de5f0c70255fb10fdcf0b6dce8c84974c1b8f

data/.github_changelog_generator

@@ -1 +1 @@
-future-release=2.0.7
+future-release=2.0.8

data/CHANGELOG.md

@@ -1,7 +1,14 @@
 # Change Log
 
-## [2.0.7](https://github.com/Exelord/Monarchy/tree/2.0.7) (2017-01-09)
-[Full Changelog](https://github.com/Exelord/Monarchy/compare/v2.0.6...2.0.7)
+## [2.0.8](https://github.com/Exelord/Monarchy/tree/2.0.8) (2017-01-12)
+[Full Changelog](https://github.com/Exelord/Monarchy/compare/v2.0.7...2.0.8)
+
+**Merged pull requests:**
+
+- Feature parent access [\#67](https://github.com/Exelord/Monarchy/pull/67) ([Exelord](https://github.com/Exelord))
+
+## [v2.0.7](https://github.com/Exelord/Monarchy/tree/v2.0.7) (2017-01-09)
+[Full Changelog](https://github.com/Exelord/Monarchy/compare/v2.0.6...v2.0.7)
 
 **Merged pull requests:**
 

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    monarchy (2.0.7)
+    monarchy (2.0.8)
       active_record_union (= 1.2.0)
       activerecord (>= 4.2.7.1)
       closure_tree (= 6.2.0)
@@ -74,7 +74,7 @@ GEM
     globalid (0.3.7)
       activesupport (>= 4.1.0)
     i18n (0.7.0)
-    json (2.0.2)
+    json (2.0.3)
     loofah (2.0.3)
       nokogiri (>= 1.5.9)
     mail (2.6.4)

data/docs/acts_as_hierarchy.md

@@ -16,9 +16,27 @@ You can select all hierarchies accessible for specific user by using a scope: `a
 ``` ruby
 Monarchy.hierarchy_class.accessible_for(current_user)   # returns [hierarchy1, hierarchy2, hierarchy5]
 ```
+
+#### Options
 Optionally you can pass extra allowed roles which should be inherited for this request
 ``` ruby
-Monarchy.hierarchy_class.accessible_for(current_user, [:blocked, :visitors])   # returns [hierarchy1, hierarchy2, hierarchy5, hierarchy6]
+Monarchy.hierarchy_class.accessible_for(current_user, { inherited_roles: [:blocked, :visitors] })   # returns [hierarchy1, hierarchy2, hierarchy5, hierarchy6]
+```
+
+You can also determine if read (default role) access in resource should allow to access theirs children
+
+```ruby
+Monarchy.hierarchy_class.accessible_for(current_user, { parent_access: true })
+#                     (GRANTED) hierarchy1
+#                                   |
+#                                   |
+#              (GRANTED) hierarchy2   hierarchy4 (GRANTED cuz it's a parent of granted resource)
+#                            |            |
+#                            |            |
+#                            |       hierarchy5 (NOT granted - it's not a child of granted resource)
+#                            |
+#                            |
+#                        hierarchy3 (member role - GRANTED)
 ```
 
 ### .in(resource, true)

data/docs/acts_as_resource.md

@@ -69,11 +69,29 @@ You can select all resources accessible for specyfic user by using scope: `acces
 ``` ruby
 Resource.accessible_for(current_user)   # returns [resource1, resource2, resource5]
 ```
+
+#### Options
 Optionally you can pass extra allowed roles which should be inherited for this request
 ``` ruby
 Resource.accessible_for(current_user, [:blocked, :visitors])   # returns [resource1, resource2, resource5, resource6]
 ```
 
+You can also determine if read (default role) access in resource should allow to access theirs children
+
+```ruby
+Resource.accessible_for(current_user, { parent_access: true })
+#                     (GRANTED) project1
+#                                  |
+#                                  |
+#              (GRANTED) project2   project4 (GRANTED cuz it's a parent of granted resource)
+#                           |          |
+#                           |          |
+#                           |       project5 (NOT granted - it's not a child of granted resource)
+#                           |
+#                           |
+#                        project3 (member role - GRANTED)
+```
+
 ### .in(resource, true)
 You can select all resources scoped into another by using scope: `in`:
 

data/dummy/db/schema.rb

@@ -1,4 +1,3 @@
-# encoding: UTF-8
 # This file is auto-generated from the current state of the database. Instead
 # of editing this file, please use the migrations feature of Active Record to
 # incrementally modify your database, and then regenerate this schema definition.
@@ -26,41 +25,37 @@ ActiveRecord::Schema.define(version: 20160818205534) do
     t.string   "resource_type", null: false
     t.datetime "created_at",    null: false
     t.datetime "updated_at",    null: false
+    t.index ["parent_id"], name: "index_monarchy_hierarchies_on_parent_id"
+    t.index ["resource_id"], name: "index_monarchy_hierarchies_on_resource_id"
   end
 
-  add_index "monarchy_hierarchies", ["parent_id"], name: "index_monarchy_hierarchies_on_parent_id"
-  add_index "monarchy_hierarchies", ["resource_id"], name: "index_monarchy_hierarchies_on_resource_id"
-
   create_table "monarchy_hierarchy_hierarchies", id: false, force: :cascade do |t|
     t.integer "ancestor_id",   null: false
     t.integer "descendant_id", null: false
     t.integer "generations",   null: false
+    t.index ["ancestor_id", "descendant_id", "generations"], name: "hierarchy_anc_desc_idx", unique: true
+    t.index ["descendant_id"], name: "hierarchy_desc_idx"
   end
 
-  add_index "monarchy_hierarchy_hierarchies", ["ancestor_id", "descendant_id", "generations"], name: "hierarchy_anc_desc_idx", unique: true
-  add_index "monarchy_hierarchy_hierarchies", ["descendant_id"], name: "hierarchy_desc_idx"
-
   create_table "monarchy_members", force: :cascade do |t|
     t.integer  "user_id"
     t.integer  "hierarchy_id"
     t.datetime "created_at",   null: false
     t.datetime "updated_at",   null: false
+    t.index ["hierarchy_id"], name: "index_monarchy_members_on_hierarchy_id"
+    t.index ["user_id"], name: "index_monarchy_members_on_user_id"
   end
 
-  add_index "monarchy_members", ["hierarchy_id"], name: "index_monarchy_members_on_hierarchy_id"
-  add_index "monarchy_members", ["user_id"], name: "index_monarchy_members_on_user_id"
-
   create_table "monarchy_members_roles", force: :cascade do |t|
     t.integer  "role_id"
     t.integer  "member_id"
     t.datetime "created_at", null: false
     t.datetime "updated_at", null: false
+    t.index ["member_id"], name: "index_monarchy_members_roles_on_member_id"
+    t.index ["role_id", "member_id"], name: "index_monarchy_members_roles_on_role_id_and_member_id", unique: true
+    t.index ["role_id"], name: "index_monarchy_members_roles_on_role_id"
   end
 
-  add_index "monarchy_members_roles", ["member_id"], name: "index_monarchy_members_roles_on_member_id"
-  add_index "monarchy_members_roles", ["role_id", "member_id"], name: "index_monarchy_members_roles_on_role_id_and_member_id", unique: true
-  add_index "monarchy_members_roles", ["role_id"], name: "index_monarchy_members_roles_on_role_id"
-
   create_table "monarchy_roles", force: :cascade do |t|
     t.string   "name",                              null: false
     t.integer  "level",             default: 0,     null: false
@@ -68,13 +63,12 @@ ActiveRecord::Schema.define(version: 20160818205534) do
     t.boolean  "inherited",         default: false, null: false
     t.datetime "created_at",                        null: false
     t.datetime "updated_at",                        null: false
+    t.index ["inherited"], name: "index_monarchy_roles_on_inherited"
+    t.index ["inherited_role_id"], name: "index_monarchy_roles_on_inherited_role_id"
+    t.index ["level"], name: "index_monarchy_roles_on_level"
+    t.index ["name"], name: "index_monarchy_roles_on_name", unique: true
   end
 
-  add_index "monarchy_roles", ["inherited"], name: "index_monarchy_roles_on_inherited"
-  add_index "monarchy_roles", ["inherited_role_id"], name: "index_monarchy_roles_on_inherited_role_id"
-  add_index "monarchy_roles", ["level"], name: "index_monarchy_roles_on_level"
-  add_index "monarchy_roles", ["name"], name: "index_monarchy_roles_on_name", unique: true
-
   create_table "projects", force: :cascade do |t|
     t.string   "name"
     t.datetime "created_at",  null: false

data/lib/monarchy/acts_as_hierarchy.rb

@@ -23,25 +23,37 @@ module Monarchy
     module SupportMethods
       private
 
+      # rubocop:disable all
       def include_scopes
         scope :in, (lambda do |hierarchy, descendants = true|
           Monarchy::Validators.hierarchy(hierarchy)
           where(id: descendants ? hierarchy.descendants : hierarchy.children)
         end)
 
-        scope :accessible_for, (lambda do |user, inherited_roles = []|
+        scope :accessible_for, (lambda do |user, options = {}|
           Monarchy::Validators.user(user)
           user_id = user.id
-          where(id: accessible_roots_ids(user_id).union_all(accessible_leaves_ids(user_id, inherited_roles)))
+
+          custom_options = accessible_for_options(options)
+          where(id: accessible_roots_ids(user_id, custom_options[:parent_access])
+                      .union_all(accessible_leaves_ids(user_id, custom_options[:inherited_roles])))
         end)
       end
+      # rubocop:enable all
 
-      def accessible_roots_ids(user_id)
-        unscoped.joins('INNER JOIN monarchy_hierarchy_hierarchies ON ' \
+      def accessible_roots_ids(user_id, parent_access)
+        accessible_roots = unscoped.joins('INNER JOIN monarchy_hierarchy_hierarchies ON ' \
           'monarchy_hierarchies.id = monarchy_hierarchy_hierarchies.ancestor_id')
-                .joins('INNER JOIN (SELECT hierarchy_id FROM monarchy_members ' \
+                                   .joins('INNER JOIN (SELECT hierarchy_id FROM monarchy_members ' \
               "WHERE monarchy_members.user_id = #{user_id}) as members ON " \
                 'members.hierarchy_id = monarchy_hierarchy_hierarchies.descendant_id').select(:id)
+
+        parent_access ? roots_with_children(accessible_roots) : accessible_roots
+      end
+
+      def roots_with_children(accessible_roots)
+        accessible_children = unscoped.where(parent_id: accessible_roots).select(:id)
+        accessible_roots.union_all(accessible_children)
       end
 
       def accessible_leaves_ids(user_id, inherited_roles = [])
@@ -76,6 +88,10 @@ module Monarchy
           Monarchy.role_class.select(:id, :inherited).where(inherited: inherited).to_sql
         end
       end
+
+      def accessible_for_options(options = {})
+        Monarchy.configuration.accessible_for_options.to_h.merge(options)
+      end
     end
   end
 end

data/lib/monarchy/acts_as_resource.rb

@@ -51,9 +51,9 @@ module Monarchy
           joins(:hierarchy).where(monarchy_hierarchies: { id: hierarchies })
         end)
 
-        scope :accessible_for, (lambda do |user, inherited_roles = []|
+        scope :accessible_for, (lambda do |user, options = {}|
           joins(:hierarchy).where(monarchy_hierarchies: { id: Monarchy.hierarchy_class
-                                                                      .accessible_for(user, inherited_roles) })
+                                                                      .accessible_for(user, options) })
         end)
       end
 

data/lib/monarchy/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Monarchy
-  VERSION = '2.0.7'
+  VERSION = '2.0.8'
 end

data/lib/monarchy.rb

@@ -29,6 +29,8 @@ module Monarchy
     config.hierarchy_class_name = 'Monarchy::Hierarchy'
     config.members_access_revoke = false
     config.revoke_strategy = :revoke_member
+    config.accessible_for_options.parent_access = false
+    config.accessible_for_options.inherited_roles = []
   end
 
   not_configured do |property|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: monarchy
 version: !ruby/object:Gem::Version
-  version: 2.0.7
+  version: 2.0.8
 platform: ruby
 authors:
 - Exelord
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-09 00:00:00.000000000 Z
+date: 2017-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord