monarchy 1.1.5 → 2.0.0.pre.beta.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ae3074e01b50dd43b63d376ebb3f2410a9e6f588
-  data.tar.gz: c37f5e0d3bb7dd2998bbab3b0624c989e3027b38
+  metadata.gz: 9c68ab46ff143acf0dbf4724039a5eda03caad6a
+  data.tar.gz: 7bffa186ec4eddd5c42e08d9217197329f223c77
 SHA512:
-  metadata.gz: ba65132a3f0e45e64ceec663be0a0c030013aea2d3c66e8bf5495b908a9e79f8bf04509b0a5a4163728db1828007e707be5cfc1e69de3e946df1ee270bad6cf8
-  data.tar.gz: 9139f0b7de797402b124f2eb31fdb213bd72c317ebe30ef90bedbb4c755297424f7f30bcadf56b243279200b1b09d9958f44c78b9ef2b33c7f983d5c564471a5
+  metadata.gz: 2e2f56e8b44dc277700951c9fda570907ea47b1ba98e6050d3e2a256f2f42b5620b8e158087292f1c797255f0fda311fa2f43ccabf3eacb63ec635d9349e4dba
+  data.tar.gz: 406793fd9ad57d2c65872594840a7761c5592801ab536cd006b9fde3936b914177b61e78c1809c09fc9e12cb6f2d9ec80bf9d12de11ece9b92ba3a644f349f90

data/.codeclimate.yml

@@ -0,0 +1,26 @@
+---
+engines:
+  brakeman:
+    enabled: true
+  bundler-audit:
+    enabled: true
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby
+    checks:
+      Similar code:
+        enabled: false
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+ratings:
+  paths:
+  - Gemfile.lock
+  - "**.rb"
+exclude_paths:
+- spec/
+- dummy/
+- docs/

data/.gitignore

@@ -1,12 +1,12 @@
 .bundle/
 log/*.log
 pkg/
-spec/dummy/log/*.log
-spec/dummy/db/*.sqlite3
-spec/dummy/db/*.sqlite3-journal
-spec/dummy/log/*.log
-spec/dummy/tmp/
-spec/dummy/.sass-cache
+dummy/log/*.log
+dummy/db/*.sqlite3
+dummy/db/*.sqlite3-journal
+dummy/log/*.log
+dummy/tmp/
+dummy/.sass-cache
 .DS_Store
 coverage/
 .lock-*

data/.rubocop.yml

@@ -1,9 +1,9 @@
 AllCops:
   TargetRubyVersion: 2.3
   Exclude:
-   - 'spec/dummy/db/seeds.rb'
-   - 'spec/dummy/db/migrate/**'
-   - 'spec/dummy/db/schema.rb'
+   - 'dummy/db/seeds.rb'
+   - 'dummy/db/migrate/**'
+   - 'dummy/db/schema.rb'
    - 'lib/generators/templates/**/*'
 Documentation:
   Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+### 2.0.x LTS
+- Docs in files
+- Improve `.in` scope in AAR
+- Change `.in` scope in AAH
+  - Now it takes `hierarchy` and returns array of `hierarchies`
+- Update gems
+- Add dynamic `hierarchy` class
+- Add `users` relationship to AAH
+- Add a validator for `hierarchy`
+- Add new exceptions for `hierarchy`
+- Fix scopes in `hierarchy`

data/Gemfile

@@ -16,11 +16,11 @@ gemspec
 # gem 'byebug', group: [:development, :test]
 
 group :development, :test do
-  gem 'sqlite3', '1.3.11'
-  gem 'rubocop', '0.42.0'
+  gem 'sqlite3', '1.3.12'
+  gem 'rubocop', '0.43.0'
   gem 'pry-rails', '0.3.4'
   gem 'shoulda-matchers', '3.1.1'
-  gem 'rspec-rails', '3.5.1'
+  gem 'rspec-rails', '3.5.2'
   gem 'factory_girl_rails', '4.7.0'
   gem 'ffaker', '2.2.0'
   gem 'database_cleaner', '1.5.3'
@@ -28,3 +28,4 @@ group :development, :test do
 end
 
 gem 'simplecov', '0.12.0', require: false, group: :test
+gem 'codeclimate-test-reporter', group: :test, require: nil

data/Gemfile.lock

@@ -1,48 +1,48 @@
 PATH
   remote: .
   specs:
-    monarchy (1.1.5)
+    monarchy (2.0.0.pre.beta.1)
       active_record_union (= 1.2.0)
-      closure_tree (= 6.1.0)
-      configurations (= 2.2.0)
-      rails (~> 4.2, >= 4.2.4)
+      closure_tree (= 6.2.0)
+      configurations (= 2.2.1)
+      rails (~> 4.2, >= 4.2.7.1)
       tqdm (= 0.3.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionmailer (4.2.7)
-      actionpack (= 4.2.7)
-      actionview (= 4.2.7)
-      activejob (= 4.2.7)
+    actionmailer (4.2.7.1)
+      actionpack (= 4.2.7.1)
+      actionview (= 4.2.7.1)
+      activejob (= 4.2.7.1)
       mail (~> 2.5, >= 2.5.4)
       rails-dom-testing (~> 1.0, >= 1.0.5)
-    actionpack (4.2.7)
-      actionview (= 4.2.7)
-      activesupport (= 4.2.7)
+    actionpack (4.2.7.1)
+      actionview (= 4.2.7.1)
+      activesupport (= 4.2.7.1)
       rack (~> 1.6)
       rack-test (~> 0.6.2)
       rails-dom-testing (~> 1.0, >= 1.0.5)
       rails-html-sanitizer (~> 1.0, >= 1.0.2)
-    actionview (4.2.7)
-      activesupport (= 4.2.7)
+    actionview (4.2.7.1)
+      activesupport (= 4.2.7.1)
       builder (~> 3.1)
       erubis (~> 2.7.0)
       rails-dom-testing (~> 1.0, >= 1.0.5)
       rails-html-sanitizer (~> 1.0, >= 1.0.2)
     active_record_union (1.2.0)
       activerecord (>= 4.0)
-    activejob (4.2.7)
-      activesupport (= 4.2.7)
+    activejob (4.2.7.1)
+      activesupport (= 4.2.7.1)
       globalid (>= 0.3.0)
-    activemodel (4.2.7)
-      activesupport (= 4.2.7)
+    activemodel (4.2.7.1)
+      activesupport (= 4.2.7.1)
       builder (~> 3.1)
-    activerecord (4.2.7)
-      activemodel (= 4.2.7)
-      activesupport (= 4.2.7)
+    activerecord (4.2.7.1)
+      activemodel (= 4.2.7.1)
+      activesupport (= 4.2.7.1)
       arel (~> 6.0)
-    activesupport (4.2.7)
+    activesupport (4.2.7.1)
       i18n (~> 0.7)
       json (~> 1.7, >= 1.7.7)
       minitest (~> 5.1)
@@ -51,12 +51,14 @@ GEM
     arel (6.0.3)
     ast (2.3.0)
     builder (3.2.2)
-    closure_tree (6.1.0)
+    closure_tree (6.2.0)
       activerecord (>= 4.1.0)
       with_advisory_lock (>= 3.0.0)
+    codeclimate-test-reporter (0.6.0)
+      simplecov (>= 0.7.1, < 1.0.0)
     coderay (1.1.1)
     concurrent-ruby (1.0.2)
-    configurations (2.2.0)
+    configurations (2.2.1)
     database_cleaner (1.5.3)
     diff-lcs (1.2.5)
     docile (1.1.5)
@@ -80,13 +82,11 @@ GEM
       mime-types-data (~> 3.2015)
     mime-types-data (3.2016.0521)
     mini_portile2 (2.1.0)
-    minitest (5.9.0)
-    nokogiri (1.6.8)
+    minitest (5.9.1)
+    nokogiri (1.6.8.1)
       mini_portile2 (~> 2.1.0)
-      pkg-config (~> 1.1.7)
-    parser (2.3.1.2)
+    parser (2.3.1.4)
       ast (~> 2.2)
-    pkg-config (1.1.7)
     powerpack (0.1.1)
     pry (0.10.4)
       coderay (~> 1.1.0)
@@ -97,16 +97,16 @@ GEM
     rack (1.6.4)
     rack-test (0.6.3)
       rack (>= 1.0)
-    rails (4.2.7)
-      actionmailer (= 4.2.7)
-      actionpack (= 4.2.7)
-      actionview (= 4.2.7)
-      activejob (= 4.2.7)
-      activemodel (= 4.2.7)
-      activerecord (= 4.2.7)
-      activesupport (= 4.2.7)
+    rails (4.2.7.1)
+      actionmailer (= 4.2.7.1)
+      actionpack (= 4.2.7.1)
+      actionview (= 4.2.7.1)
+      activejob (= 4.2.7.1)
+      activemodel (= 4.2.7.1)
+      activerecord (= 4.2.7.1)
+      activesupport (= 4.2.7.1)
       bundler (>= 1.3.0, < 2.0)
-      railties (= 4.2.7)
+      railties (= 4.2.7.1)
       sprockets-rails
     rails-deprecated_sanitizer (1.0.3)
       activesupport (>= 4.2.0.alpha)
@@ -116,18 +116,18 @@ GEM
       rails-deprecated_sanitizer (>= 1.0.1)
     rails-html-sanitizer (1.0.3)
       loofah (~> 2.0)
-    railties (4.2.7)
-      actionpack (= 4.2.7)
-      activesupport (= 4.2.7)
+    railties (4.2.7.1)
+      actionpack (= 4.2.7.1)
+      activesupport (= 4.2.7.1)
       rake (>= 0.8.7)
       thor (>= 0.18.1, < 2.0)
     rainbow (2.1.0)
-    rake (11.2.2)
+    rake (11.3.0)
     rspec (3.5.0)
       rspec-core (~> 3.5.0)
       rspec-expectations (~> 3.5.0)
       rspec-mocks (~> 3.5.0)
-    rspec-core (3.5.2)
+    rspec-core (3.5.4)
       rspec-support (~> 3.5.0)
     rspec-expectations (3.5.0)
       diff-lcs (>= 1.2.0, < 2.0)
@@ -135,7 +135,7 @@ GEM
     rspec-mocks (3.5.0)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.5.0)
-    rspec-rails (3.5.1)
+    rspec-rails (3.5.2)
       actionpack (>= 3.0)
       activesupport (>= 3.0)
       railties (>= 3.0)
@@ -144,7 +144,7 @@ GEM
       rspec-mocks (~> 3.5.0)
       rspec-support (~> 3.5.0)
     rspec-support (3.5.0)
-    rubocop (0.42.0)
+    rubocop (0.43.0)
       parser (>= 2.3.1.1, < 3.0)
       powerpack (~> 0.1)
       rainbow (>= 1.99.1, < 3.0)
@@ -162,17 +162,17 @@ GEM
     sprockets (3.7.0)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
-    sprockets-rails (3.1.1)
+    sprockets-rails (3.2.0)
       actionpack (>= 4.0)
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
-    sqlite3 (1.3.11)
+    sqlite3 (1.3.12)
     thor (0.19.1)
     thread_safe (0.3.5)
     tqdm (0.3.0)
     tzinfo (1.2.2)
       thread_safe (~> 0.1)
-    unicode-display_width (1.1.0)
+    unicode-display_width (1.1.1)
     with_advisory_lock (3.0.0)
       activerecord (>= 3.2)
       thread_safe
@@ -182,22 +182,23 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.12)
+  codeclimate-test-reporter
   database_cleaner (= 1.5.3)
   factory_girl_rails (= 4.7.0)
   ffaker (= 2.2.0)
   monarchy!
   pry-rails (= 0.3.4)
-  rake (~> 11.1)
+  rake (~> 11.3)
   rspec (= 3.5.0)
-  rspec-rails (= 3.5.1)
-  rubocop (= 0.42.0)
+  rspec-rails (= 3.5.2)
+  rubocop (= 0.43.0)
   shoulda-matchers (= 3.1.1)
   simplecov (= 0.12.0)
-  sqlite3 (= 1.3.11)
+  sqlite3 (= 1.3.12)
   tqdm (= 0.3.0)
 
 RUBY VERSION
-   ruby 2.3.0p0
+   ruby 2.3.1p112
 
 BUNDLED WITH
-   1.12.5
+   1.13.6

data/README.md

@@ -1,6 +1,7 @@
 [![Build Status](https://travis-ci.org/Exelord/Monarchy.svg?branch=master)](https://travis-ci.org/Exelord/Monarchy)
 [![Dependency Status](https://gemnasium.com/badges/github.com/Exelord/Monarchy.svg)](https://gemnasium.com/github.com/Exelord/Monarchy)
 [![Gitter](https://badges.gitter.im/Exelord/Monarchy.svg)](https://gitter.im/Exelord/Monarchy?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
+[![Code Climate](https://codeclimate.com/github/Exelord/Monarchy/badges/gpa.svg)](https://codeclimate.com/github/Exelord/Monarchy)
 
 <p align="center">
   <img align="center" src="monarchy.png?raw=true" alt="Sublime's custom image"/>

data/app/models/monarchy/hierarchy.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
 class Monarchy::Hierarchy < ActiveRecord::Base
-  self.table_name = 'monarchy_hierarchies'
   acts_as_hierarchy
 end

data/docs/acts_as_hierarchy.md

@@ -0,0 +1,45 @@
+## Hierarchy
+`Hierarchy` is an internal model of `Monarchy` and should not be used unless it is really necessary.
+
+> hmm... sounds like `private`
+
+### Methods
+** We do not recommend to use it but if yo have to: **
+We are using [Closure Tree][e5c808aa] behind `Hierarchy` class. There is a bunch of methods and functions available behind the hood. Check their documentation.
+
+  [e5c808aa]: https://github.com/mceachen/closure_tree "Closure Tree"
+
+### Scopes:
+
+#### .accessible_for
+You can select all hierarchies accessible for specific user by using a scope: `accessible_for`, eg:
+``` ruby
+Monarchy::Hierarchy.accessible_for(current_user)   # returns [hierarchy1, hierarchy2, hierarchy5]
+```
+
+#### .in(resource, true)
+You can select all hierarchies scoped into another by using scope: `in`:
+
+- If the second argument is `true` (`true` is by default):
+``` ruby
+Monarchy::Hierarchy.in(project.hierarchy) # returns [hierarchy1, hierarchy2, hierarchy5]
+```
+It will returns for you all `hierarchies` which parent is `project.hierarchy` or one of his children.
+
+- If the second argument is `false`:
+``` ruby
+Monarchy::Hierarchy.in(project.hierarchy, false) # returns [hierarchy1, hierarchy2]
+```
+It will returns for you all `hierarchies` which parent is `project.hierarchy`
+
+
+## Relations
+
+#### #members
+Return all members explicitly granted to the hierarchy.
+
+#### #users
+Returns all users which have been granted explicitly to the hierarchy.
+
+#### #resource
+Returns a resource model of the hierarchy.

data/docs/acts_as_resource.md

@@ -0,0 +1,103 @@
+To generate a new resource you can use:
+```
+rails g monarchy:resource [resource_name]
+```
+or add to an existing model `acts_as_resource`, eg:
+```ruby
+class Resource < ActiveRecord::Base
+  acts_as_resource
+end
+```
+
+##### - Options
+You can pass an options to `acts_as_resource`:
+- `parent_as: :association_name`
+
+  This let you directly assign parent when you assign an association,
+  eg:
+  ``` ruby
+  class Task << ActiveRecord::Base
+    acts_as_resource parent_as: :project
+    belongs_to :project
+  end
+
+  task.update(project: Project.last)
+  task.parent  # returns Project.last
+  ```
+
+## Methods
+
+#### #parent
+You can easily assign parent by using `parent=` method, eg:
+``` ruby
+resource.parent = Project.last
+```
+and read value by using `parent` method:
+``` ruby
+resource.parent   # returns Project.last
+```
+
+Parents can be only models which have `acts_as_resource`
+
+#### #children
+You can easily assign children by using `children=` method, eg:
+``` ruby
+resource.children = [child1, child2, child3]
+```
+and read value by using `parent` method:
+``` ruby
+resource.children   # returns [child1, child2, child3]
+```
+Children can be only models which have `acts_as_resource`
+
+#### #ensure_hierarchy
+It creates a hierarchy for resource model if it not exist and `automatic_hierarchy` flag is set to true.
+If you want to bypass `automatic_hierarchy` flag you can pass `true` to the method params.
+
+#### .default_role_name
+Returns default role name for the class
+
+#### .default_role
+Returns default role object `Monarchy::Role` for the class
+
+### Scopes:
+
+#### .accessible_for
+You can select all resources accessible for specyfic user by using scope: `accessible_for`, eg:
+``` ruby
+Resource.accessible_for(current_user)   # returns [resource1, resource2, resource5]
+```
+
+#### .in(resource, true)
+You can select all resources scoped into another by using scope: `in`:
+
+- If the second argument is `true` (`true` is by default):
+``` ruby
+Resource.in(Project.first) # returns [resource1, resource5, resource6]
+```
+It will return for you all `resources` which parent is `Project.first` or one of his children.
+
+- If the second argument is `false`:
+``` ruby
+Resource.in(Project.first, false) # returns [resource1, resource5]
+```
+It will return for you all `resources` which parent is `Project.first`
+
+
+## Relations
+
+#### #members
+Return all members explicitly granted to the resource.
+
+#### #users
+Returns all users which have been granted explicitly to the resource.
+
+#### #hierarchy
+Returns a hierarchy model of the resource. (DO NOT USE UNLESS IS NECESSARY)
+
+## Flags
+Every class which is actually the resource (`acts_as_resource`) has available flags.
+### .acting_as_resource
+If a model class has `acts_as_resource` it returns `true` otherwise method is undefined.
+### .parentize_name
+If a model class has `acts_as_resource` it returns class name of the parent if has been set by 'parent_as' option.

data/docs/acts_as_user.md

@@ -0,0 +1,52 @@
+You have to add it to your user model or the custom one specified in a config file.
+
+``` ruby
+class User < ActiveRecord::Base
+  acts_as_user
+end
+```
+
+## Relations
+
+#### .hierarchies
+Return all hierarchies in which user is explicitly granted.
+
+#### .members
+Returns all memberships (`member` model) of the user
+
+## Scopes
+
+#### .accessible_for (user)
+Returns all users accessible for the specific user
+It includes all users from all resource which the user has any access.
+
+## Methods
+
+#### #roles_for(resource, inheritance = true)
+Returns all roles for the user to the specific `resource`.
+You can choose if this method should return also inherited roles or just these, granted explicitly.
+
+#### #member_for(resource)
+Returns a `member` object for the user in specyfic resource.
+
+#### #grant(role_names, resource)
+By this method, you can give the user an access to a specific resource.
+You can specify a role name or an array of roles names.
+**Remember to use `symbols`!**
+
+#### #revoke_access(resource)
+You can revoke total access of a user from the resource and his children by using this method.
+Optionally you can specify `hierarchies` as the second argument from which user's members should be deleted.
+
+#### #revoke_role(role_name, resource)
+It revokes specified role from a user's member of the resource.
+If is it last role and the default for the resource it will raise an error `Monarchy::Exceptions::RoleNotRevokable`. Otherwise, if it's just a last role it will remove the one and grant a user with default one.
+
+**It guaranty that user will have always last role or a default one**
+
+#### #revoke_role!(role_name, resource)
+It behaves exactly like `#revoke_role` but with one difference during revoking last_role.
+Depend on which `revoke_strategy` did you choose in configuration,
+it will delete a member after revoking the last role or will revoke an access to the resource.
+
+For more information check the [configuration page](https://github.com/Exelord/Monarchy/wiki/Configuration) and `revoke_strategy` property.

data/docs/configuration.md

@@ -0,0 +1,54 @@
+# Configuration file
+
+You can configure Monarchy in `config/initializers/monarchy.rb` file. All available configuration options are already there and waiting for your orders.
+
+``` ruby
+Monarchy.configure do |config|
+  # REQUIRED SETTINGS
+
+  # You have to define which role will be the default one (read only) during inheritance.
+  # Example role: :guest
+  # Real case on resources:
+  # project: (you have no roles)
+  #   section: (you have no roles)
+  #     task: (you have a member role here)
+  # When you ask for user.roles_for(project) you will get a default role (:guest)
+  # in case when member role has inherited flag set to true
+  # Remember to create that role before setting it up eg:
+  # Monarchy::Role.create(name: :guest, inherited: false, level: 0)
+  config.inherited_default_role = nil # symbol
+
+  # You have to define user class name or an actor class which respond to acts_as_user in your model.
+  # Example of model:
+  # class User < ActiveRecord::Base
+  #   acts_as_user
+  # end
+  config.user_class_name = '' # string
+
+
+  # OPTIONAL SETTINGS
+
+  # If you want to override Member or Role class you have add correct actors to class definition
+  # Available: acts_as_member, acts_as_role, acts_as_hierarchy
+  # Example:
+  # class Member < ActiveRecord::Base
+  #   acts_as_member
+  # end
+  config.role_class_name = 'Monarchy::Role' # string
+  config.member_class_name = 'Monarchy::Member' # string
+  config.hierarchy_class_name = 'Monarchy::Hierarchy' # string
+
+
+  # If this option is setup to true all members bellow the destroying one, will be deleted.
+  config.members_access_revoke = false # boolean
+
+  # Set the revoke strategy using during '#revoke_role!' method
+  # Available: :revoke_member, :revoke_access
+  # Default: :revoke_member
+  # Info:
+  # :revoke_member - after revoking the last role from user's member remove the member
+  # :revoke_access - after revoking the last role from user's member
+  #                  remove the member, and all members bellow which belongs to the user
+  config.revoke_strategy = :revoke_member # symbol
+end
+```

data/docs/installation.md

@@ -0,0 +1,30 @@
+# Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'monarchy'
+```
+
+And then execute:
+
+    $ bundle
+
+To create initials migrations and necessary files run:
+```
+rails g monarchy:setup
+```
+
+This will create for you:
+
+1. Migrations:
+  - `monarchy_create_users`
+  - `monarchy_create_hierarchies`
+  - `monarchy_create_memberships`
+2. Configuration file in `config/initializers/monarchy`
+3. Default `User` model (optional)
+
+**If you want to use your current `User` model just skip generation of: **
+ - `db/migrate/monarchy_create_users.rb`
+ - `app/models/user.rb`
+
+And add to your current `User` model `acts_as_user`

data/docs/usage.md

@@ -0,0 +1,22 @@
+# Usage
+The only think you have to do is mark models to be one of part of Monarchy.
+
+You can use 2 available markers:
+
+1. `acts_as_user`
+2. `acts_as_resource`
+
+## Acts as user
+For your current `User` model or freshly generated one, add or check if exist, `acts_as_user`.
+``` ruby
+class User < ActiveRecord::Base
+  acts_as_user
+end
+```
+
+> Check documentation of [Acts as user] (https://github.com/Exelord/Monarchy/wiki/Acts-as-user)
+
+## Acts as resource
+For all models that you want to be accessible for users add `acts_as_resource`.
+
+> Check documentation of [Acts as resource] (https://github.com/Exelord/Monarchy/wiki/Acts-as-resource)

data/dummy/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.