acts_as_roleable 0.3.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cc44fb4bf1aad235f91f8ff37c2f26c4a9da3972
+  data.tar.gz: 1e46bf8f7eba907cf78723702a7c08507c520ac7
+SHA512:
+  metadata.gz: 194d2d42390ead17f298dae6cf7729b8a13fe6414df91d184cc1f3b65cc17e6b396b6d573c9182d1aad5b9aa141274402f6728081cc497a4971afa8146bed7e5
+  data.tar.gz: 89b6e9514f882b927cf4d398c24706e790ff1e028125511b5fab14f079a24b14479dd2f1a2740d5d06f5380b51088dac4a43ab94ba9de63aa810da10ef9812f1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in acts_as_roleable.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,11 @@
+guard :minitest do
+  # watch /lib/ files
+  watch(%r{^lib/(.+).rb$}) do |m|
+    "test/#{m[1]}_test.rb"
+  end
+
+  # watch /test/ files
+  watch(%r{^test/(.+).rb$}) do |m|
+    "test/#{m[1]}.rb"
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Jesse McGinnis
+
+MIT License
+
+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/README.md

@@ -0,0 +1,41 @@
+[![Build Status](https://travis-ci.org/elsom25/acts_as_roleable.png?branch=master)](https://travis-ci.org/elsom25/acts_as_roleable)
+[![Code Climate](https://codeclimate.com/github/elsom25/acts_as_roleable.png)](https://codeclimate.com/github/elsom25/acts_as_roleable)
+[![Coverage Status](https://coveralls.io/repos/elsom25/acts_as_roleable/badge.png)](https://coveralls.io/r/elsom25/acts_as_roleable)
+
+# ActsAsRoleable
+
+Adds role based authorization to Rails using the lovely [RoleModel](https://github.com/martinrehfeld/role_model) and the scopes of [Canard](https://github.com/james2m/canard). No Authorization, just roles.
+
+To be renamed and released.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'acts_as_roleable'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install acts_as_roleable
+
+## Usage
+
+Any model you want to support roles and handy role scopes for, add:
+
+    acts_as_roleable roles: [:tester, :user, :owner]
+
+And be sure to add a `roles_mask:integer` column to the associated table. You can change the name of this column by passing the `roles_mask` attribute:
+
+    acts_as_roleable roles: [:tester, :user, :owner], roles_mask: :internal_mask
+
+## Contributing
+
+1. Fork it (`http://github.com/<my-github-username>/acts_as_roleable/fork`)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,17 @@
+require 'rake'
+require 'rake/testtask'
+require 'bundler/gem_tasks'
+
+Rake::TestTask.new do |t|
+  t.pattern = 'test/**/*_test.rb'
+  t.libs.push 'test'
+end
+
+namespace :test do
+  task :coverage do
+    ENV['COVERAGE'] = 'true'
+    Rake::Task['test'].invoke
+  end
+end
+
+task default: :test

data/acts_as_roleable.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'acts_as_roleable/version'
+
+Gem::Specification.new do |spec|
+  spec.name                  = 'acts_as_roleable'
+  spec.version               = ActsAsRoleable::VERSION
+  spec.authors               = ['Jesse McGinnis']
+  spec.email                 = ['jesse@jcmcginnis.com']
+  spec.summary               = %q{Adds role based authorization to Rails with RoleModel.}
+  spec.description           = %q{Wraps RoleModel up to make role based authorization really easy in Rails >= 3.2.}
+  spec.homepage              = 'https://github.com/elsom25/acts_as_roleable'
+  spec.license               = 'MIT'
+
+  spec.files                 = `git ls-files -z`.split("\x0")
+  spec.executables           = spec.files.grep(%r{^bin/}){ |f| File.basename(f) }
+  spec.test_files            = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths         = ['lib']
+  spec.required_ruby_version = '>= 1.9.3'
+
+  # development dependencies
+  spec.add_development_dependency 'bundler',             '~> 1.6'
+  spec.add_development_dependency 'rake',                '~> 10'
+  spec.add_development_dependency 'rails',               '~> 3.2'
+
+  spec.add_development_dependency 'minitest',            '~> 5'
+  spec.add_development_dependency 'minitest-reporters'
+  spec.add_development_dependency 'guard'
+  spec.add_development_dependency 'guard-minitest'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry-remote'
+  spec.add_development_dependency 'pry-nav'
+  spec.add_development_dependency 'coveralls'
+
+  # gem dependencies
+  spec.add_runtime_dependency     'role_model'
+end

data/lib/acts_as_roleable.rb

@@ -0,0 +1,6 @@
+require 'role_model'
+
+require 'acts_as_roleable/version'
+require 'acts_as_roleable/implementation'
+
+require 'acts_as_roleable/railtie' if defined?(Rails) && Rails::VERSION::MAJOR >= 3

data/lib/acts_as_roleable/implementation.rb

@@ -0,0 +1,58 @@
+module ActsAsRoleable::Implementation
+  def acts_as_roleable(*args)
+    include RoleModel
+    options = args.extract_options!
+
+    roles_attribute options[:roles_mask] if options.has_key?(:roles_mask)
+    roles options[:roles] if options.has_key?(:roles)
+    add_role_scopes
+  end
+
+private
+
+  def add_role_scopes
+    return unless active_record_table?
+    valid_roles.each do |role|
+      define_scopes_for_role role
+    end
+
+    define_scope_method(:with_any_role) do |*roles|
+      where "#{role_mask_column} & :role_mask > 0", role_mask: mask_for(*roles)
+    end
+
+    define_scope_method(:with_all_roles) do |*roles|
+      where "#{role_mask_column} & :role_mask = :role_mask", role_mask: mask_for(*roles)
+    end
+
+    define_scope_method(:with_only_roles) do |*roles|
+      where "#{role_mask_column} = :role_mask", role_mask: mask_for(*roles)
+    end
+  end
+
+  def active_record_table?
+    respond_to?(:table_exists?) && table_exists?
+  end
+
+  def define_scopes_for_role(role)
+    include_scope   = role.to_s.pluralize
+    exclude_scope   = "non_#{include_scope}"
+
+    define_scope_method(include_scope) do
+      where "#{role_mask_column} & :role_mask > 0", role_mask: mask_for(role)
+    end
+
+    define_scope_method(exclude_scope) do
+      where "#{role_mask_column} & :role_mask = 0 OR #{role_mask_column} IS NULL", role_mask: mask_for(role)
+    end
+  end
+
+  def define_scope_method(method, &block)
+    (class << self; self end).class_eval do
+      define_method(method, block)
+    end
+  end
+
+  def role_mask_column
+    "#{quoted_table_name}.#{connection.quote_column_name roles_attribute_name}"
+  end
+end

data/lib/acts_as_roleable/railtie.rb

@@ -0,0 +1,10 @@
+require 'acts_as_roleable'
+require 'rails'
+
+module ActsAsRoleable
+  class Railtie < Rails::Railtie
+    config.to_prepare do
+      ActiveRecord::Base.extend ActsAsRoleable::Implementation
+    end
+  end
+end

data/lib/acts_as_roleable/version.rb

@@ -0,0 +1,3 @@
+module ActsAsRoleable
+  VERSION = '0.3.2'
+end

data/test/lib/roleable_test.rb

@@ -0,0 +1,13 @@
+require 'test_helper'
+
+describe ActsAsRoleable do
+  subject{ ActsAsRoleable }
+
+  it 'should not raise an error' do
+    subject
+  end
+
+  it 'does stuff' do
+    skip('no tests yet')
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,11 @@
+require 'coveralls'
+Coveralls.wear!
+
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'minitest/reporters'
+
+require 'pry'
+
+require 'acts_as_roleable'

metadata

@@ -0,0 +1,228 @@
+--- !ruby/object:Gem::Specification
+name: acts_as_roleable
+version: !ruby/object:Gem::Version
+  version: 0.3.2
+platform: ruby
+authors:
+- Jesse McGinnis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-remote
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: role_model
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Wraps RoleModel up to make role based authorization really easy in Rails
+  >= 3.2.
+email:
+- jesse@jcmcginnis.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- acts_as_roleable.gemspec
+- lib/acts_as_roleable.rb
+- lib/acts_as_roleable/implementation.rb
+- lib/acts_as_roleable/railtie.rb
+- lib/acts_as_roleable/version.rb
+- test/lib/roleable_test.rb
+- test/test_helper.rb
+homepage: https://github.com/elsom25/acts_as_roleable
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Adds role based authorization to Rails with RoleModel.
+test_files:
+- test/lib/roleable_test.rb
+- test/test_helper.rb