roles 0.0.1

data/.gitignore

@@ -0,0 +1,8 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+tmp/*
+log*/*
+.rbx/*
+.rspec

data/.travis.yml

@@ -0,0 +1,14 @@
+rvm:
+    - 1.9.3
+    - ruby-head
+    - rbx-19mode
+    - jruby-19mode
+
+env:
+    - ADAPTER=active_record
+    - ADAPTER=mongoid
+
+before_install:
+  - gem update --system
+  - gem --version
+  - ruby -v

data/CHANGELOG.rdoc

@@ -0,0 +1,2 @@
+= v0.1 (Aug 17, 2012)
+* first release

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Liu Fengyun
+
+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,103 @@
+# Roles
+
+Roles is an extremely simple roles gem inspired by rolify.
+
+This library is recommended to be used with [CanCan](https://github.com/ryanb/cancan) and [devise](https://github.com/plataformatec/devise).
+
+## Quick Start
+
+```ruby
+
+# query roles
+user.has_role?(:admin)  # if user is admin globally
+user.has_role?(:admin, Organization)  # if user is admin for Organization type
+user.has_role?(:admin, Organization.first) # if user is not admin of the first organization
+
+# grant roles
+user.add_role(:admin) # a global admin
+user.add_role(:admin, Organization) # admin for type Organization
+user.add_role(:admin, Organization.first) #  admin for the first organization
+
+# revoke roles
+user.remove_role(:admin) # remove global admin
+user.remove_role(:admin, Organization) # remove admin for type Organization
+user.remove_role(:admin, Organization.first) # remove admin for the first organization
+
+# global role DON'T overrides resource role request
+user = User.find(4)
+user.add_role :moderator # sets a global role
+user.has_role? :moderator, Forum # => false
+user.add_role :moderator, Forum # sets a role on resource type
+user.has_role? :moderator, Forum.first # => false
+user.has_role? :moderator, Forum.last  # => false
+
+# query about users
+Forum.users_with_role(role = nil) => returns all users with roles defined on Forum
+forum.users_with_role => returns users with a role defined of current instance
+User.with_role(role, resource = nil) => returns all users with the given role, optionally scoped by Class, instance or non-scoped(globally)
+
+# query about resources
+user.resouces(resource_class, :role_name = nil) => returns all resources of type resource_class for a given user, optionally filtered by role_name.
+
+```
+
+## Requirements
+
+* Rails >= 3.1
+* ActiveRecord >= 3.1
+* supports ruby 1.9, JRuby 1.6.0+ (in 1.9 mode) and Rubinius 2.0.0dev (in 1.9 mode)
+
+## Installation
+
+Add this to your Gemfile and run the +bundle+ command.
+
+```ruby
+  gem "roles"
+```
+
+## Getting Started
+
+### 1. Generate Role Model
+
+First, create your Role model and migration file using this generator:
+
+```
+  rails g rolify:role Role User
+```
+
+Role and User classes are the default. You can specify any Role class name you want. This is completly a new file so any name can do the job.
+For the User class name, you would probably use the one provided by your authentication solution. rolify just adds some class methods in an existing User class.
+
+
+### 2. Run the migration
+
+```
+  rake db:migrate
+```
+
+### 3.1 Configure your user model
+
+This gem adds the `rolify` method to your User class.
+
+```ruby
+  class User < ActiveRecord::Base
+    rolify
+  end
+```
+
+### 3.2 Configure your resource models
+
+In the resource models you want to apply roles on, just add ``resourcify`` method.
+For example, on this ActiveRecord class:
+
+```ruby
+class Forum < ActiveRecord::Base
+  resourcify
+end
+```
+
+## Resources
+
+* [Rolify](https://github.com/EppO/rolify)
+* [Amazing tutorial](http://railsapps.github.com/tutorial-rails-bootstrap-devise-cancan.html) provided by [RailsApps](http://railsapps.github.com/)
+

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+task :default => :spec
+
+desc "Run all specs"
+task "spec" do
+  exec "bundle exec rspec spec"
+end

data/UPGRADE.rdoc

@@ -0,0 +1,2 @@
+= Upgrade instructions for Roles library
+

data/lib/generators/roles/role/role_generator.rb

@@ -0,0 +1,47 @@
+require 'rails/generators/migration'
+
+module Roles
+  module Generators
+    class RoleGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      source_root File.expand_path('../templates', __FILE__)
+      argument :role_cname, :type => :string, :default => "Role"
+      argument :user_cname, :type => :string, :default => "User"
+      argument :orm_adapter, :type => :string, :default => "active_record"
+
+      desc "Generates a model with the given NAME and a migration file."
+
+      def generate_role
+        template "role-#{orm_adapter}.rb", "app/models/#{role_cname.underscore}.rb"
+        inject_into_file(model_path, :after => inject_roles_method) do
+          "  roles" + (role_cname == "Role" ? "" : " :role_cname => '#{role_cname.camelize}'") + "\n"
+        end
+      end
+
+      def copy_role_file
+        migration_template "migration.rb", "db/migrate/roles_create_#{role_cname.tableize}" if orm_adapter == "active_record"
+      end
+
+      def model_path
+        File.join("app", "models", "#{user_cname.underscore}.rb")
+      end
+      
+      def self.next_migration_number(path)
+        Time.now.utc.strftime("%Y%m%d%H%M%S")
+      end
+      
+      def show_readme
+        readme "README-#{orm_adapter}" if behavior == :invoke
+      end
+      
+      def inject_roles_method
+        if orm_adapter == "active_record"
+          /class #{user_cname.camelize}\n|class #{user_cname.camelize} .*\n/
+        else
+          /include Mongoid::Document\n|include Mongoid::Document .*\n/
+        end
+      end
+    end
+  end
+end

data/lib/generators/roles/role/templates/README

@@ -0,0 +1,7 @@
+===============================================================================
+
+Now, you just have to run the migration using rake command:
+
+   rake db:migrate
+
+===============================================================================

data/lib/generators/roles/role/templates/README-active_record

@@ -0,0 +1,17 @@
+===============================================================================
+
+A Role class has been been created in app/models (with the name you gave as 
+argument otherwise the default is role.rb), you can add your own business logic 
+inside.
+
+Inside your User class (or the name you gave as argument otherwise the default 
+is user.rb), roles method has been inserted to provide roles methods.
+
+Now, if you just have to run the migration using rake command:
+
+   rake db:migrate
+
+and you will be able to add the resourcify method inside all models you want 
+scoped by a role.
+
+===============================================================================

data/lib/generators/roles/role/templates/migration.rb

@@ -0,0 +1,15 @@
+class RolesCreate<%= role_cname.pluralize.camelize %> < ActiveRecord::Migration
+  def change
+    create_table(:<%= role_cname.tableize %>) do |t|
+      t.string :name
+      t.references :resource, :polymorphic => true
+      t.references :<%= user_cname.underscore.singularize %>
+
+      t.timestamps
+    end
+
+    add_index(:<%= role_cname.tableize %>, :name)
+    add_index(:<%= role_cname.tableize %>, [ :name, :resource_type, :resource_id ])
+    add_index(:<%= role_cname.tableize %>, [ :<%= user_cname.underscore.singularize %>_id, :name ])
+  end
+end

data/lib/generators/roles/role/templates/role-active_record.rb

@@ -0,0 +1,5 @@
+class <%= role_cname.camelize %> < ActiveRecord::Base
+  belongs_to :<%= user_cname.tableize %>
+  belongs_to :resource, :polymorphic => true
+  
+end

data/lib/roles/railtie.rb

@@ -0,0 +1,20 @@
+require 'roles'
+require 'rails'
+
+module Rolies
+  class Railtie < Rails::Railtie
+    initializer 'roles.initialize' do
+      ActiveSupport.on_load(:active_record) do
+        ActiveRecord::Base.send :extend, Roles
+      end
+      
+      config.before_initialize do
+        ::Mongoid::Document.module_eval do
+          def self.included(base)
+            base.extend Roles
+          end
+        end
+      end if defined?(Mongoid)
+    end
+  end
+end

data/lib/roles/resource.rb

@@ -0,0 +1,25 @@
+module Roles
+  module Resource
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods 
+      def users_with_role(role_name = nil)
+        if role_name.nil?
+          self.user_class.joins(:roles).where("roles.resource_type LIKE '%s'", self.to_s).where("roles.resource_id IS NULL")
+        else
+          self.user_class.joins(:roles).where("roles.resource_type LIKE '%s'", self.to_s).where("roles.resource_id IS NULL").where("roles.name LIKE '%s'", role_name.to_s)
+        end
+      end
+    end
+
+    def users_with_role(role_name = nil)
+      if role_name.nil?
+        self.class.user_class.joins(:roles).where("roles.resource_type LIKE '%s'", self.class.to_s).where("roles.resource_id = %s", self.id)
+      else
+        self.class.user_class.joins(:roles).where("roles.resource_type LIKE '%s'", self.class.to_s).where("roles.resource_id = %s", self.id).where("roles.name LIKE '%s'", role_name.to_s)
+      end
+    end
+  end
+end

data/lib/roles/role.rb

@@ -0,0 +1,85 @@
+module Roles
+  module Role
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def with_role(role_name, resource = nil)
+        if resource.nil?
+          self.joins(:roles).where("roles.name LIKE '%s'", role_name.to_s).where("roles.resource_type IS NULL").where("roles.resource_id IS NULL")
+        elsif resource.is_a? Class
+          self.joins(:roles).where("roles.name LIKE '%s'", role_name.to_s).where("roles.resource_type = '%s'", resource.to_s).where("roles.resource_id IS NULL")
+        else
+          self.joins(:roles).where("roles.name LIKE '%s'", role_name.to_s).where("roles.resource_type = '%s'", resource.to_s).where("roles.resource_id = %s", resource.id)
+        end
+      end
+    end
+
+    def add_role(role_name, resource = nil)
+      if resource.nil?
+        self.roles.where(:resource_type => nil).where(:resource_id => nil).find_or_create_by_name(:name => role_name.to_s)
+      elsif resource.is_a? Class
+        self.roles.where(:resource_type => resource.to_s).where(:resource_id => nil).find_or_create_by_name(:name => role_name.to_s)
+      else
+        self.roles.where(:resource_type => resource.class.to_s).where(:resource_id => resource.id).find_or_create_by_name(:name => role_name.to_s)
+      end
+    end
+    alias_method :grant, :add_role
+
+    def has_role?(role_name, resource = nil)
+      if new_record?
+        self.roles.detect { |r| r.name == role_name.to_s && (r.resource == resource || resource.nil?) }.present?
+      else
+        if resource.nil?
+          self.roles.where(:name => role_name.to_s).where(:resource_type => nil).where(:resource_id => nil).size > 0
+        elsif resource.is_a? Class
+          self.roles.where(:name => role_name.to_s).where(:resource_type => resource.to_s).where(:resource_id => nil).size > 0
+        else
+          self.roles.where(:name => role_name.to_s).where(:resource_type => resource.class.to_s).where(:resource_id => resource.id).size > 0
+        end
+      end
+    end
+
+    def remove_role(role_name, resource = nil)
+      if resource.nil?
+        self.roles.where(:name => role_name.to_s).where(:resource_type => nil).where(:resource_id => nil).destroy_all
+      elsif resource.is_a? Class
+        self.roles.where(:name => role_name.to_s).where(:resource_type => resource.to_s).where(:resource_id => nil).destroy_all
+      else
+        self.roles.where(:name => role_name.to_s).where(:resource_type => resource.class.to_s).where(:resource_id => resource.id).destroy_all
+      end
+    end
+    
+    alias_method :revoke, :remove_role
+
+    def role_names(resource = nil)
+      if resource.nil?
+        self.roles.where(:resource_type => nil).where(:resource_id => nil).select(:name).map { |r| r.name }
+      elsif resource.is_a? Class
+        self.roles.where(:resource_type => resource.name).where(:resource_id => nil).select(:name).map { |r| r.name }
+      else
+        self.roles.where(:resource_type => resource.class.to_s).where(:resource_id => resource.id).select(:name).map { |r| r.name }
+      end
+    end
+
+    def resources(resource_class, role_name = nil)
+      if role_name.nil?
+        resource_class.joins(:roles).where("roles.#{self.class.user_cname.underscore.singularize}_id = %s", self.id).where("roles.resource_type LIKE '%s'", resource_class.to_s)
+      else
+        resource_class.joins(:roles).where("roles.#{self.class.user_cname.underscore.singularize}_id = %s", self.id).where("roles.resource_type LIKE '%s'", resource_class.to_s).where("roles.name LIKE '%s'", role_name.to_s)
+      end
+    end
+
+    def method_missing(method, *args, &block)
+      if method.to_s.match(/^is_(\w+)_of[?]$/) || method.to_s.match(/^is_(\w+)[?]$/)
+        if self.class.role_class.where(:name => $1).count > 0
+          resource = args.first
+          return has_role?("#{$1}", resource)
+        end
+      end
+      super
+    end
+
+  end
+end

data/lib/roles/version.rb

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

data/lib/roles.rb

@@ -0,0 +1,40 @@
+require 'roles/railtie' if defined?(Rails)
+require 'roles/role'
+require 'roles/resource'
+
+module Roles
+  attr_accessor :role_cname
+  attr_accessor :user_cname
+
+  def roles(options = {})
+    include Role
+    
+    options.reverse_merge!({:role_cname => 'Role'})
+
+    roles_options = { :class_name => options[:role_cname].camelize }
+    roles_options.merge!(options.select{ |k,v| [:before_add, :after_add, :before_remove, :after_remove].include? k.to_sym })
+
+    has_many :roles, roles_options
+
+    self.role_cname = options[:role_cname]
+  end
+
+  def resourcify(options = {})
+    include Resource
+    
+    options.reverse_merge!({ :role_cname => 'Role', :dependent => :destroy })
+    resourcify_options = { :class_name => options[:role_cname].camelize, :as => :resource, :dependent => options[:dependent] }
+    has_many :roles, resourcify_options
+    
+    self.role_cname = options[:role_cname]
+    self.user_cname = options[:user_cname] || 'User'
+  end
+  
+  def user_class
+    self.user_cname.constantize
+  end
+
+  def role_class
+    self.role_cname.constantize
+  end
+end

data/roles.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "roles/version"
+
+Gem::Specification.new do |s|
+  s.name        = "roles"
+  s.version     = Roles::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["liufengyun"]
+  s.email       = ["liufengyunchina@gmail.com"]
+  s.homepage    = "http://github.com/liufengyun/roles"
+  s.summary     = %q{Roles library with resource scoping}
+  s.description = %q{An extremely simple roles library inspired by rolify}
+
+  s.rubyforge_project = s.name
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  if defined?(RUBY_ENGINE) && RUBY_ENGINE == "jruby"
+    s.add_development_dependency "activerecord-jdbcsqlite3-adapter"
+  else
+    s.add_development_dependency "sqlite3"
+  end
+  s.add_development_dependency "activerecord", ">= 3.1.0"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec", ">= 2.0"
+  s.add_development_dependency "rspec-rails", ">= 2.0"
+  s.add_development_dependency "bundler" 
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: roles
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- liufengyun
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: An extremely simple roles library inspired by rolify
+email:
+- liufengyunchina@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- CHANGELOG.rdoc
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- UPGRADE.rdoc
+- lib/generators/roles/role/role_generator.rb
+- lib/generators/roles/role/templates/README
+- lib/generators/roles/role/templates/README-active_record
+- lib/generators/roles/role/templates/migration.rb
+- lib/generators/roles/role/templates/role-active_record.rb
+- lib/roles.rb
+- lib/roles/railtie.rb
+- lib/roles/resource.rb
+- lib/roles/role.rb
+- lib/roles/version.rb
+- roles.gemspec
+homepage: http://github.com/liufengyun/roles
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: roles
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Roles library with resource scoping
+test_files: []