average_roles 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d77d5c88f35e3f89d9a1ba1a848f2dd0f7b7db62
+  data.tar.gz: 8cec02983a17eeb5e44eae869bae4a8956636e5a
+SHA512:
+  metadata.gz: 42ac6be770264d131a87446e36c2ebae9e452183975f99fd49d46da8c6209568c04916abc0a4afd1036591edc0d69dea56d2a199cc8a6fcfa71eddc5797cdd02
+  data.tar.gz: cb908a9f0ea7de1d5da4b592ddbddb6f016cbddae8bb8d92160938145245096005c59d28c4be3bc11d95cc9c41e56227828470b8b9abc37781bc15d7d603743c

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'AverageRoles'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/config/initializers/average_roles.rb

@@ -0,0 +1,8 @@
+# Uncomment and change the defaults below to use different models
+# and to set a super user role which if someone has, will return all checks
+# for roles true.
+# AverageRoles.configure do |config|
+#   config.user_model = 'User'
+#   config.role_model = 'Role'
+#   config.super_user = nil # or identifier as symbol
+# end

data/lib/average_roles.rb

@@ -0,0 +1,25 @@
+require "average_roles/engine"
+require "average_roles/models/concerns/role"
+require "average_roles/models/concerns/user"
+
+module AverageRoles
+
+  def self.configuration
+    @configuration ||=  Configuration.new
+  end
+
+  def self.configure
+    yield(configuration) if block_given?
+  end
+
+  class Configuration
+    attr_accessor :user_model, :role_model, :super_user
+
+    def initialize
+      @user_model = 'User'
+      @role_model = 'Role'
+      @super_user = nil
+    end
+  end
+
+end

data/lib/average_roles/engine.rb

@@ -0,0 +1,4 @@
+module AverageRoles
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/average_roles/models/concerns/role.rb

@@ -0,0 +1,22 @@
+require 'active_support/concern'
+
+module AverageRoles::RoleConcern
+
+  extend ActiveSupport::Concern
+
+  included do
+    include PostgresTree::ActiveRecordConcern
+
+    has_and_belongs_to_many AverageRoles.configuration.user_model.downcase.pluralize.to_sym
+
+    # Associations for tree
+    belongs_to :parent, class_name: AverageRoles.configuration.role_model
+    has_many :children, class_name: AverageRoles.configuration.role_model, foreign_key: 'parent_id'
+
+    # Validations
+    validates :name, presence: true, uniqueness: true
+    validates :identifier, presence: true, uniqueness: true
+    validates :description, presence: true
+  end
+
+end

data/lib/average_roles/models/concerns/user.rb

@@ -0,0 +1,130 @@
+require 'active_support/concern'
+
+module AverageRoles::UserConcern
+
+  # TODO: Add a super user identifier that always returns true when checking if has role. This needs
+  #       to be a configuration option.
+
+  extend ActiveSupport::Concern
+
+  included do
+    has_and_belongs_to_many AverageRoles.configuration.role_model.downcase.pluralize.to_sym
+
+    # Get roles by type
+    define_method AverageRoles.configuration.role_model.downcase.pluralize + '_as' do |type|
+      average_roles_check_type type
+      case type
+      when :identifiers
+        roles = []
+        self.send(AverageRoles.configuration.role_model.downcase.pluralize.to_sym).where(active: true).load.each do |role|
+          roles << role.identifier.to_sym
+        end
+        roles
+      when :ids
+        return self.send (AverageRoles.configuration.role_model.downcase + '_ids').to_sym
+      when :objects
+        return self.send AverageRoles.configuration.role_model.downcase.pluralize.to_sym
+      end
+    end
+
+    # Check if has role
+    define_method 'has_' + AverageRoles.configuration.role_model.downcase + '?' do |role|
+      return true if average_roles_has_super_user?
+      if role.is_a? Symbol
+        self.roles_as(:identifiers).include? role
+      elsif role.is_a? Numeric
+        self.send(AverageRoles.configuration.role_model.downcase + '_ids').include? role
+      elsif role.is_a? AverageRoles.configuration.role_model.constantize.new.class
+        self.send(AverageRoles.configuration.role_model.downcase + '_ids').include? role.id
+      else
+        raise ArgumentError, "Role must be a symbol, number or object of same type"
+      end
+    end
+
+    # Check if has all roles
+    define_method 'has_' + AverageRoles.configuration.role_model.downcase.pluralize + '?' do |roles|
+      return true if average_roles_has_super_user?
+      roles.each do |role|
+        return false unless self.has_role? role
+      end
+      true
+    end
+
+    # Check if has at least one role
+    define_method 'has_at_least_one_' + AverageRoles.configuration.role_model.downcase + '?' do |roles|
+      return true if average_roles_has_super_user?
+      roles.each do |role|
+        return true if self.has_role? role
+      end
+      false
+    end
+
+    # Get roles and descendent roles by type
+    define_method AverageRoles.configuration.role_model.downcase.pluralize + '_and_descendents_as' do |type|
+      average_roles_check_type type
+      roles = []
+      self.send(AverageRoles.configuration.role_model.pluralize.downcase.to_sym).where(active: true).load.each do |role|
+        role.self_and_descendents.each do |r|
+          case type
+          when :identifiers
+            roles << r.identifier.to_sym
+          when :ids
+            roles << r.id
+          when :objects
+            roles << r
+          end
+        end
+      end
+      roles.uniq
+    end
+
+    # Check if object has role or a ancestors ancestor role
+    define_method 'has_' + AverageRoles.configuration.role_model.downcase + '_by_descendents?' do |role|
+      return true if average_roles_has_super_user?
+      if role.is_a? Symbol
+        self.roles_and_descendents_as(:identifiers).include? role
+      elsif role.is_a? Numeric
+        self.roles_and_descendents_as(:ids).include? role
+      elsif role.is_a? AverageRoles.configuration.role_model.constantize.new.class
+        self.roles_and_descendents_as(:ids).include? role.id # Use ids to save some memory
+      else
+        raise ArgumentError, "Role must be a symbol, number or object of same type"
+      end
+    end
+
+    # Check if has all roles or at least a ancestor of each role
+    define_method 'has_' + AverageRoles.configuration.role_model.downcase.pluralize + '_by_descendents?' do |roles|
+      return true if average_roles_has_super_user?
+      roles.each do |role|
+        return false unless self.has_role_by_descendents? role
+      end
+      true
+    end
+
+    # Check if has at least one role or at least one ancestor of one role
+    define_method 'has_at_least_one_' + AverageRoles.configuration.role_model.downcase + '_by_descendents?' do |roles|
+      return true if average_roles_has_super_user?
+      roles.each do |role|
+        return true if self.has_role_by_descendents? role
+      end
+      false
+    end
+
+  end
+
+  private
+
+    # check type
+    def average_roles_check_type(type)
+      if not [:identifiers, :ids, :objects].include? type
+        raise ArgumentError, "Type must be :identifiers, :ids or :objects"
+      end
+    end
+
+    # check if the user has the super user role
+    def average_roles_has_super_user?
+      return self.roles_as(:identifiers).include?(AverageRoles.configuration.super_user) unless AverageRoles.configuration.super_user == nil
+      return false
+    end
+
+end

data/lib/average_roles/version.rb

@@ -0,0 +1,3 @@
+module AverageRoles
+  VERSION = "0.0.1"
+end

data/lib/tasks/average_roles_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :average_roles do
+#   # Task goes here
+# end

data/test/average_roles_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class AverageRolesTest < ActiveSupport::TestCase
+  test "truth" do
+    assert_kind_of Module, AverageRoles
+  end
+end

data/test/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>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/models/role.rb

@@ -0,0 +1,3 @@
+class Role < ActiveRecord::Base
+  include AverageRoles::RoleConcern
+end

data/test/dummy/app/models/user.rb

@@ -0,0 +1,3 @@
+class User < ActiveRecord::Base
+  include AverageRoles::UserConcern
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Rails.application

data/test/dummy/config/application.rb

@@ -0,0 +1,24 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'rails/all'
+
+Bundler.require(*Rails.groups)
+require "average_roles"
+require "postgres_tree"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+  end
+end
+

data/test/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exist?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/test/dummy/config/database.yml

@@ -0,0 +1,89 @@
+# PostgreSQL. Versions 8.2 and up are supported.
+#
+# Install the pg driver:
+#   gem install pg
+# On OS X with Homebrew:
+#   gem install pg -- --with-pg-config=/usr/local/bin/pg_config
+# On OS X with MacPorts:
+#   gem install pg -- --with-pg-config=/opt/local/lib/postgresql84/bin/pg_config
+# On Windows:
+#   gem install pg
+#       Choose the win32 build.
+#       Install PostgreSQL and put its /bin directory on your path.
+#
+# Configure Using Gemfile
+# gem 'pg'
+#
+default: &default
+  adapter: postgresql
+  encoding: unicode
+  # For details on connection pooling, see rails configuration guide
+  # http://guides.rubyonrails.org/configuring.html#database-pooling
+  pool: 5
+
+development:
+  <<: *default
+  database: average_roles_development
+  username: postgres
+  password: postgres
+
+  # The specified database role being used to connect to postgres.
+  # To create additional roles in postgres see `$ createuser --help`.
+  # When left blank, postgres will use the default role. This is
+  # the same name as the operating system user that initialized the database.
+  #username: dummy
+
+  # The password associated with the postgres role (username).
+  #password:
+
+  # Connect on a TCP socket. Omitted by default since the client uses a
+  # domain socket that doesn't need configuration. Windows does not have
+  # domain sockets, so uncomment these lines.
+  #host: localhost
+
+  # The TCP port the server listens on. Defaults to 5432.
+  # If your server runs on a different port number, change accordingly.
+  #port: 5432
+
+  # Schema search path. The server defaults to $user,public
+  #schema_search_path: myapp,sharedapp,public
+
+  # Minimum log levels, in increasing order:
+  #   debug5, debug4, debug3, debug2, debug1,
+  #   log, notice, warning, error, fatal, and panic
+  # Defaults to warning.
+  #min_messages: notice
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  <<: *default
+  database: average_roles_test
+  username: postgres
+  password: postgres
+
+# As with config/secrets.yml, you never want to store sensitive information,
+# like your database password, in your source code. If your source code is
+# ever seen by anyone, they now have access to your database.
+#
+# Instead, provide the password as a unix environment variable when you boot
+# the app. Read http://guides.rubyonrails.org/configuring.html#configuring-a-database
+# for a full rundown on how to provide these environment variables in a
+# production deployment.
+#
+# On Heroku and other platform providers, you may have a full connection URL
+# available as an environment variable. For example:
+#
+#   DATABASE_URL="postgres://myuser:mypass@localhost/somedatabase"
+#
+# You can use this database configuration with:
+#
+#   production:
+#     url: <%= ENV['DATABASE_URL'] %>
+#
+production:
+  <<: *default
+  database: average_roles_production
+  username: postgres
+  password: <%= ENV['DUMMY_DATABASE_PASSWORD'] %>