monarchy 2.2.2 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 815ca965ee47bec334658cc90ce50557a8d0154e
-  data.tar.gz: 8353cc02f268a429bf61b117c421b5481942a2c4
+  metadata.gz: 37446023d193a35f3d1989848c858d173810af90
+  data.tar.gz: 4db1f53bf50bb8f75995d10d6e4da232f042b1d9
 SHA512:
-  metadata.gz: 3a11658a76ea5dc9cf75567c7c2485c0501fb95cc8003ed64b650bfdc13c6ae64db63037ee30b8c79d7c9b2c48a55e585faec53a99e26483f5d260568b55d143
-  data.tar.gz: aa8c93f91f7a4bcf48154e1207bd7bdfd81f58f5391a8488eade7a16da410a9507286f3425442ab928ff91b1f087b1f4a5646ad9de65d9c6f52fef81796c1a82
+  metadata.gz: 7f1f23cb2bde8c85ef10b201e8ae337b70abacdf927cedf9586b8c46a839ca41118d106c925c7ebe163e7ad3ead9e4b0f8e389d6e536d3e34935d3442cacc95f
+  data.tar.gz: 7dcbd125eda5e4bc2c6c1afbd94d8382c70f89b54ee176fefad54e893fc84a1e0d6706f9fd802af11ac098ca2b3cd1d25d584ae09319cde4ca08093ce8207b2c

data/.github_changelog_generator

@@ -1 +1 @@
-future-release=2.2.2
+future-release=2.3.0

data/CHANGELOG.md

@@ -1,7 +1,18 @@
 # Change Log
 
-## [2.2.2](https://github.com/Exelord/Monarchy/tree/2.2.2) (2017-06-14)
-[Full Changelog](https://github.com/Exelord/Monarchy/compare/v2.2.1...2.2.2)
+## [2.3.0](https://github.com/Exelord/Monarchy/tree/2.3.0) (2017-06-14)
+[Full Changelog](https://github.com/Exelord/Monarchy/compare/v2.2.2...2.3.0)
+
+**Closed issues:**
+
+- Remove potential n-query [\#79](https://github.com/Exelord/Monarchy/issues/79)
+
+**Merged pull requests:**
+
+- Improve performance and specs [\#76](https://github.com/Exelord/Monarchy/pull/76) ([Exelord](https://github.com/Exelord))
+
+## [v2.2.2](https://github.com/Exelord/Monarchy/tree/v2.2.2) (2017-06-14)
+[Full Changelog](https://github.com/Exelord/Monarchy/compare/v2.2.1...v2.2.2)
 
 **Fixed bugs:**
 

data/Gemfile

@@ -18,6 +18,7 @@ gemspec
 
 group :development, :test do
   gem 'database_cleaner', '1.5.3'
+  gem 'db-query-matchers', '0.8.0'
   gem 'factory_girl_rails', '4.8.0'
   gem 'ffaker', '2.5.0'
   gem 'pry-rails', '0.3.6'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    monarchy (2.2.2)
+    monarchy (2.3.0)
       active_record_union (= 1.2.0)
       activerecord (>= 4.2.7.1)
       closure_tree (= 6.5.0)
@@ -62,6 +62,7 @@ GEM
     concurrent-ruby (1.0.5)
     configurations (2.2.2)
     database_cleaner (1.5.3)
+    db-query-matchers (0.8.0)
     diff-lcs (1.3)
     docile (1.1.5)
     erubis (2.7.0)
@@ -190,6 +191,7 @@ DEPENDENCIES
   bundler (~> 1.12)
   codeclimate-test-reporter (~> 1.0.8)
   database_cleaner (= 1.5.3)
+  db-query-matchers (= 0.8.0)
   factory_girl_rails (= 4.8.0)
   ffaker (= 2.5.0)
   monarchy!

data/docs/acts_as_hierarchy.md

@@ -18,6 +18,51 @@ We are using [Closure Tree][e5c808aa] behind `Hierarchy` class. There is a bunch
 
   [e5c808aa]: https://github.com/mceachen/closure_tree "Closure Tree"
 
+#### .hierarchies_for
+You can use this method if you want to get all hierarchies for specific resources, eg:
+
+```
+  Monarchy.hierarchy_class.hierarchies_for(Project.all) # returns hierarchies
+```
+
+** Remember: `hierarchies_for` can receive only `ActiveRecord` class argument! **
+
+#### .children_for
+You can use this method if you want to get all explicit children for specific hierarchies, eg:
+
+```
+  Monarchy.hierarchy_class.children_for(my_hierarchy) # returns children hierarchies
+```
+
+** Remember: `children_for` can receive only `ActiveRecord` class argument! **
+
+#### .parents_for
+You can use this method if you want to get all explicit parents for specific hierarchies, eg:
+
+```
+  Monarchy.hierarchy_class.parents_for(my_hierarchy) # returns parents hierarchies
+```
+
+** Remember: `parents_for` can receive only `ActiveRecord` class argument! **
+
+#### .descendants_for
+You can use this method if you want to get all descendants for specific hierarchies, eg:
+
+```
+  Monarchy.hierarchy_class.descendants_for(my_hierarchy) # returns descendants hierarchies
+```
+
+** Remember: `descendants_for` can receive only `ActiveRecord` class argument! **
+
+#### .ancestors_for
+You can use this method if you want to get all ancestors for specific hierarchies, eg:
+
+```
+  Monarchy.hierarchy_class.ancestors_for(my_hierarchies) # returns ancestors hierarchies
+```
+
+** Remember: `ancestors_for` can receive only `ActiveRecord` class argument! **
+
 ## Scopes:
 
 ### .accessible_for

data/dummy/db/migrate/20160220215254_monarchy_create_users.rb

@@ -1,7 +1,6 @@
 class MonarchyCreateUsers < ActiveRecord::Migration
   def change
     create_table :users do |t|
-      t.timestamps null: false
     end
   end
 end

data/lib/monarchy/acts_as_hierarchy.rb

@@ -10,15 +10,11 @@ module Monarchy
         self.table_name = 'monarchy_hierarchies'
         has_closure_tree dependent: :destroy
 
-        has_many :members, class_name: "::#{Monarchy.member_class}", dependent: :destroy
-        has_many :users, through: :members, class_name: "::#{Monarchy.user_class}"
-        belongs_to :resource, polymorphic: true
-
+        include_relations
         include_scopes
+        include_validators
 
-        validates :resource_type, presence: true
-        validates :resource_id, uniqueness: { scope: [:resource_type] }, presence: true
-
+        extend Monarchy::ActsAsHierarchy::ClassMethods
         include Monarchy::ActsAsHierarchy::InstanceMethods
       end
     end
@@ -29,23 +25,75 @@ module Monarchy
       end
     end
 
+    module ClassMethods
+      def hierarchies_for(resources)
+        check_argument_type(resources)
+        resources ? unscoped.where(resource: resources) : none
+      end
+
+      def children_for(hierarchies)
+        check_argument_type(hierarchies)
+        hierarchies ? unscoped.where(parent: hierarchies) : none
+      end
+
+      def parents_for(hierarchies)
+        check_argument_type(hierarchies)
+        return none unless hierarchies
+
+        unscoped.joins('INNER JOIN monarchy_hierarchies AS hierarchies_children ON '\
+                       'monarchy_hierarchies.id = hierarchies_children.parent_id')
+                .where(hierarchies_children: { id: hierarchies })
+      end
+
+      def descendants_for(hierarchies)
+        check_argument_type(hierarchies)
+        hierarchies ? unscoped.with_ancestor(hierarchies) : none
+      end
+
+      def ancestors_for(hierarchies)
+        check_argument_type(hierarchies)
+        return none unless hierarchies
+
+        unscoped.joins('INNER JOIN monarchy_hierarchy_hierarchies ON '\
+                       'monarchy_hierarchies.id = monarchy_hierarchy_hierarchies.ancestor_id')
+                .where(monarchy_hierarchy_hierarchies: { descendant_id: hierarchies.select(:id) })
+                .where('monarchy_hierarchy_hierarchies.generations > 0')
+      end
+
+      private
+
+      def check_argument_type(argument)
+        condition = argument.nil? || argument.is_a?(ActiveRecord::Base) || argument.is_a?(ActiveRecord::Relation)
+        raise(ArgumentError, 'Argument has to be ActiveRecord!') unless condition
+      end
+    end
+
     module SupportMethods
       private
 
+      def include_relations
+        belongs_to :resource, polymorphic: true
+        has_many :members, class_name: "::#{Monarchy.member_class}", dependent: :destroy
+        has_many :users, through: :members, class_name: "::#{Monarchy.user_class}"
+      end
+
+      def include_validators
+        validates :resource_type, presence: true
+        validates :resource_id, uniqueness: { scope: [:resource_type] }, presence: true
+      end
+
       # rubocop:disable all
       def include_scopes
         scope :in, (lambda do |hierarchy, descendants = true|
-          Monarchy::Validators.hierarchy(hierarchy)
-          where(id: descendants ? hierarchy.descendants : hierarchy.children)
+          where(id: descendants ? descendants_for(hierarchy) : children_for(hierarchy))
         end)
 
         scope :accessible_for, (lambda do |user, options = {}|
-          Monarchy::Validators.user(user)
           user_id = user.id
 
           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])))
+               .union_all(accessible_leaves_ids(user_id, custom_options[:inherited_roles])))
         end)
       end
       # rubocop:enable all

data/lib/monarchy/acts_as_resource.rb

@@ -45,18 +45,22 @@ module Monarchy
         @parentize_name = name
       end
 
+      # rubocop:disable all
       def include_scopes
         scope :in, (lambda do |resource, descendants = true|
           Monarchy::Validators.resource(resource)
-          hierarchies = Monarchy.hierarchy_class.in(resource.hierarchy, descendants)
+          hierarchy = Monarchy.hierarchy_class.hierarchies_for(resource)
+          hierarchies = Monarchy.hierarchy_class.in(hierarchy, descendants)
           joins(:hierarchy).where(monarchy_hierarchies: { id: hierarchies })
         end)
 
         scope :accessible_for, (lambda do |user, options = {}|
+          Monarchy::Validators.user(user)
           joins(:hierarchy).where(monarchy_hierarchies: { id: Monarchy.hierarchy_class
                                                                       .accessible_for(user, options) })
         end)
       end
+      # rubocop:enable all
 
       def include_relationships
         has_many :members, through: :hierarchy, class_name: "::#{Monarchy.member_class}"
@@ -67,7 +71,7 @@ module Monarchy
 
     module InstanceMethods
       def parent
-        @parent = hierarchy.try(:parent).try(:resource) || @parent
+        @parent = parent_resource || @parent
       end
 
       def parent=(resource)
@@ -81,7 +85,7 @@ module Monarchy
       end
 
       def children=(array)
-        hierarchy&.update(children: hierarchies_for(array))
+        hierarchy&.update(children: children_hierarchies(array))
         @children = array
       end
 
@@ -91,12 +95,13 @@ module Monarchy
         self.hierarchy ||= Monarchy.hierarchy_class.create(
           resource: self,
           parent: parent.try(:hierarchy),
-          children: hierarchies_for(children)
+          children: children_hierarchies(children)
         )
       end
 
-      def accessible_for(user)
-        hierarchy.accessible_for(user)
+      def accessible_for(user, options = {})
+        Monarchy::Validators.user(user)
+        hierarchy.accessible_for(user, options)
       end
 
       private
@@ -117,12 +122,18 @@ module Monarchy
       end
 
       def children_resources
-        c = hierarchy.try(:children)
-        return nil if c.nil?
-        c.includes(:resource).map(&:resource)
+        resource_hierarchy = Monarchy.hierarchy_class.hierarchies_for(self)
+        hierarchy_children = Monarchy.hierarchy_class.children_for(resource_hierarchy)
+        hierarchy_children.includes(:resource).map(&:resource)
       end
 
-      def hierarchies_for(array)
+      def parent_resource
+        resource_hierarchy = Monarchy.hierarchy_class.hierarchies_for(self)
+        hierarchy_parent = Monarchy.hierarchy_class.parents_for(resource_hierarchy)
+        hierarchy_parent.first&.resource
+      end
+
+      def children_hierarchies(array)
         array&.compact!
         Array(array).map { |resource| Monarchy::Validators.resource(resource).hierarchy }
       end

data/lib/monarchy/acts_as_user.rb

@@ -88,8 +88,7 @@ module Monarchy
       end
 
       def resource_roles(resource)
-        resource_hierarchy = hierarchies_for(resource).select(:id)
-
+        resource_hierarchy = Monarchy.hierarchy_class.hierarchies_for(resource).select(:id)
         user_memberships = Monarchy.member_class
                                    .where(hierarchy_id: resource_hierarchy, user_id: id)
                                    .select(:id, :hierarchy_id).to_sql
@@ -156,34 +155,18 @@ module Monarchy
         @inherited_default_role ||= Monarchy.role_class.find_by(name: Monarchy.configuration.inherited_default_role)
       end
 
-      # TODO: Make these methods public in related interfaces
-
       def members_for(hierarchies)
         Monarchy.member_class.where(hierarchy: hierarchies, user_id: id)
       end
 
-      def hierarchies_for(resources)
-        Monarchy.hierarchy_class.where(resource: resources)
-      end
-
       def descendants_for(resources)
-        resources_hierarchies = hierarchies_for(resources).select(:id)
-
-        Monarchy.hierarchy_class
-                .joins('INNER JOIN monarchy_hierarchy_hierarchies ON ' \
-                  'monarchy_hierarchies.id = monarchy_hierarchy_hierarchies.descendant_id')
-                .where(monarchy_hierarchy_hierarchies: { ancestor_id: resources_hierarchies })
-                .where.not(monarchy_hierarchies: { id: resources_hierarchies })
+        resources_hierarchies = Monarchy.hierarchy_class.hierarchies_for(resources).select(:id)
+        Monarchy.hierarchy_class.descendants_for(resources_hierarchies)
       end
 
       def ancestors_for(resources)
-        resources_hierarchies = hierarchies_for(resources).select(:id)
-
-        Monarchy.hierarchy_class
-                .joins('INNER JOIN monarchy_hierarchy_hierarchies ON ' \
-                  'monarchy_hierarchies.id = monarchy_hierarchy_hierarchies.ancestor_id')
-                .where(monarchy_hierarchy_hierarchies: { descendant_id: resources_hierarchies })
-                .where.not(monarchy_hierarchies: { id: resources_hierarchies })
+        resources_hierarchies = Monarchy.hierarchy_class.hierarchies_for(resources).select(:id)
+        Monarchy.hierarchy_class.ancestors_for(resources_hierarchies)
       end
     end
   end

data/lib/monarchy/exceptions.rb

@@ -44,16 +44,6 @@ module Monarchy
       end
     end
 
-    class ModelNotHierarchy < Error
-      def initialize(resource)
-        @resource = resource
-      end
-
-      def message
-        "Model '#{@resource.class}' is not a hierarchy!"
-      end
-    end
-
     class ModelNotMember < Error
       def initialize(member)
         @member = member
@@ -97,12 +87,6 @@ module Monarchy
       end
     end
 
-    class HierarchyIsNil < Error
-      def message
-        'Hierarchy can NOT be nil!'
-      end
-    end
-
     class UserIsNil < Error
       def message
         'User can NOT be nil!'
@@ -126,11 +110,5 @@ module Monarchy
         'Resource has to persisted!'
       end
     end
-
-    class HierarchyNotPersist < Error
-      def message
-        'Resource has to persisted!'
-      end
-    end
   end
 end

data/lib/monarchy/validators.rb

@@ -39,16 +39,6 @@ module Monarchy
         persistance && resource && !resource.persisted? ? raise(Monarchy::Exceptions::ResourceNotPersist) : model
       end
 
-      def hierarchy(hierarchy, allow_nil = false, persistance = true)
-        raise Monarchy::Exceptions::HierarchyIsNil if !hierarchy && !allow_nil
-
-        model = check_model_class(hierarchy, 'ModelNotHierarchy') do
-          hierarchy.is_a?(Monarchy.hierarchy_class)
-        end
-
-        persistance && hierarchy && !hierarchy.persisted? ? raise(Monarchy::Exceptions::HierarchyNotPersist) : model
-      end
-
       def user(user, allow_nil = false)
         raise Monarchy::Exceptions::UserIsNil if !user && !allow_nil
         model_is_class(user, Monarchy.user_class, 'ModelNotUser')

data/lib/monarchy/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Monarchy
-  VERSION = '2.2.2'
+  VERSION = '2.3.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: monarchy
 version: !ruby/object:Gem::Version
-  version: 2.2.2
+  version: 2.3.0
 platform: ruby
 authors:
 - Exelord