roleplayer 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 András Tarsoly
+
+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

@@ -0,0 +1,13 @@
+== Roleplayer
+
+Role management gem for Ruby on Rails 3.0. Not backwards compatible.
+
+=== Examples
+
+TODO
+
+=== See also
+
+=== Author
+
+Copyright (c) 2010 András Tarsoly, released under the MIT license

data/Rakefile

@@ -0,0 +1,41 @@
+# encoding: utf-8
+require 'rake'
+require 'yaml'
+
+require 'rake/rdoctask'
+require 'rspec/core/rake_task'
+require 'rspec/core/version'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "roleplayer"
+    gem.summary = "Add simple role support to your models."
+    gem.email = "tarsolya@gmail.com"
+    gem.homepage = "http://github.com/tarsolya/roleplayer"
+    gem.authors = ["Tarsoly András"]
+    gem.files = Dir["*", "{lib}/**/*"]
+    gem.add_development_dependency 'rspec-expectations'
+    gem.add_development_dependency 'rspec-mocks'
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+Rspec::Core::RakeTask.new(:spec)
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+desc 'Generate documentation for the has_roles plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Roleplayer'
+  rdoc.options << '--line-numbers' << '--inline-source' << '--format=html' << '--template=hanna'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/*.rb')
+  rdoc.rdoc_files.include('app/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/init.rb

@@ -0,0 +1,2 @@
+#:nodoc:#
+require File.join( File.dirname(__FILE__), 'lib', 'roleplayer' )

data/install.rb

@@ -0,0 +1,2 @@
+#:nodoc:#
+# No install necessary

data/lib/generators/roleplayer.rb

@@ -0,0 +1,27 @@
+require 'rails/generators/base'
+require 'rails/generators/migration'
+require 'active_record'
+
+module Roleplayer #:nodoc:
+  module Generators #:nodoc:
+    class Base < Rails::Generators::Base #:nodoc:
+      include Rails::Generators::Migration
+      
+      def self.source_root
+        @_roleplayer_source_root ||= File.expand_path(File.join(File.dirname(__FILE__), 'roleplayer', generator_name, 'templates'))
+      end
+      
+      # Required interface for Rails::Generators::Migration
+      def self.next_migration_number(dirname) #:nodoc:
+        if ActiveRecord::Base.timestamped_migrations
+          Time.now.utc.strftime("%Y%m%d%H%M%S")
+        else
+          "%.3d" % (current_migration_number(dirname) + 1)
+        end
+      end
+      
+    end
+  end
+end
+
+    

data/lib/generators/roleplayer/migration/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    rails generate roleplayer Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/roleplayer/migration/migration_generator.rb

@@ -0,0 +1,14 @@
+require 'generators/roleplayer'
+
+module Roleplayer #:nodoc:#
+  module Generators #:nodoc:#
+    class MigrationGenerator < Base #:nodoc:
+      include Rails::Generators::Migration
+      
+      def create_migration_file
+        migration_template "migration.rb", "db/migrate/roleplayer_migration"
+      end
+      
+    end
+  end
+end

data/lib/generators/roleplayer/migration/templates/migration.rb

@@ -0,0 +1,28 @@
+class RoleplayerMigration < ActiveRecord::Migration #:nodoc:
+  
+  def self.up
+    
+    # Role table
+    create_table :roles do |t|
+      t.string :name, :null => false
+    end
+
+    # Assignments table
+    create_table :role_assignments do |t|
+      t.references :role, :null => false
+      t.references :assignee, :polymorphic => true, :null => false
+    end
+    
+    # Create a unique index for fast lookups and for some ref. integrity
+    add_index :role_assignments, 
+              [ :role_id, :assignee_id, :assignee_type ],
+              :unique => true, 
+              :name => 'index_role_assigns_by_assignee'
+    
+  end
+  
+  def self.down
+    drop_table :roles, :role_assignments
+  end
+  
+end

data/lib/roleplayer.rb

@@ -0,0 +1,139 @@
+require 'active_support/core_ext'
+require 'active_record'
+
+# Simple role management implementation for ActiveRecord models.
+module Roleplayer
+  
+  #:stopdoc:
+  DEFAULT_OPTIONS = {
+  }.freeze
+  #:startdoc:
+  
+  attr_accessor_with_default( :options, {}.merge( Roleplayer::DEFAULT_OPTIONS ) )
+  
+  # Defines a model as a roleplayer.
+  #
+  # === Associations
+  #
+  # * +roles+ - Contains the roles assigned to the model instance.
+  # * +role_assignments+ - Polymorphic join model for roles.
+  #
+  # === Scopes
+  #
+  # * <tt>with_any_roles( *args )</tt> - Scope for filtering results based on a list of roles
+  #   using the OR operator.
+  #   
+  # * <tt>with_all_roles( *args )</tt> - Scope for filtering results based on a list of roles
+  #   using the AND operator.
+  #
+  # === Examples
+  #
+  #   Foo.find(1).roles                                 #=> [ :editor ]
+  #   Foo.find(2).roles                                 #=> [ :admin ]
+  #   Foo.find(3).roles                                 #=> [ :editor, :admin ]
+  #
+  #   Foo.with_any_roles( :editor, :admin )             #=> [ <Foo:1 ...>, <Foo:2 ...>, <Foo:3 ...> ]
+  #   Foo.with_any_roles( :editor )                     #=> [ <Foo:1 ...>, <Foo:3 ...> ]
+  #   Foo.with_all_roles( :editor, :admin )             #=> [ <Foo:3 ...> ]
+  #
+  # Scopes are chainable:
+  #
+  #   Foo.with_any_roles( :editor, :admin ).limit( 1 )  #=> [ <Foo:1 ...> ]
+  #
+  def roleplayer( *args )
+    
+    self.options.merge!( args.extract_options! )
+    
+    has_many :role_assignments, :class_name => 'RoleAssignment', :as => :assignee, :dependent => :destroy
+    has_many :roles, :through => :role_assignments
+
+    scope :with_any_roles, lambda { |*args|
+      joins( :roles ).
+      where( "roles.name IN (?) ", args.collect { |arg| arg.to_s } )
+    }
+    
+    scope :with_all_roles, lambda { |*args|
+      joins(:roles).
+      where( "roles.name IN (?) ", args.collect { |arg| arg.to_s } ).
+      group( "accounts.id" ).
+      having( "count(*) = ?", args.size )
+    }
+
+    include Roleplayer::InstanceMethods
+    
+  end
+  
+  module InstanceMethods
+    
+    # Compatibility method for +declarative_authorization+, which expect roles
+    # from a model instance as a list of symbols.
+    def role_symbols
+      roles.map { |r| r.name.to_sym }
+    end
+    
+    # Returns true, if the model instance has +role+ assigned to it.
+    #
+    # === Examples
+    #
+    #   foo.roles #=> [ :admin, :vip ]
+    #
+    #   foo.has_role? ( :admin )        #=> true
+    #   foo.has_role? ( "vip" )         #=> true
+    #   foo.has_role? ( :invited )      #=> false
+    #   
+    def has_role?( role = nil )
+      return false if role.nil?
+      roles.exists?( :name => role.to_s )
+    end
+    
+    # Assigns a list of roles to the model instance.
+    # You can use any combination of arguments: they will be flattened
+    # and only previously existing roles will be added.
+    #
+    # === Examples
+    #   
+    #   foo.add_roles( :admin )                               #=> [ :admin ]
+    #   foo.add_roles( :admin, :editor )                      #=> [ :admin, :editor ]
+    #   
+    # When the <tt>:invited</tt> role doesn't exist:
+    #   
+    #   foo.add_roles( [:admin, :editor], [:invited, :vip] )  #=> [ :admin, :editor, :vip ]
+    #   
+    def add_roles( *args )
+      args.flatten!
+      args.each { |arg| roles.push( Role.find_by_name( arg.to_s ) ) if Role.valid?( arg ) }
+    end
+    
+    # Delete a list of assigned roles from a model instance.
+    # Same as +add_roles+, arguments will be flattened before performing the delete,
+    # so you can pass multiple arguments at once for convenience.
+    #
+    # === Examples
+    #
+    #   foo.roles                                             #=> [ :admin, :editor, :vip ]
+    #
+    #   foo.delete_roles( :admin )                            #=> [ :editor, :vip ]
+    #   foo.delete_roles( [ :editor ], [ :vip, :invited ] )   #=> []
+    #
+    def delete_roles( *args )
+      args.flatten!
+      args.each { |arg| roles.delete( Role.find_by_name( arg.to_s ) ) if has_role?( arg ) }
+    end
+    
+    # Removes all roles from the model instance.
+    #
+    # === Examples
+    #
+    #   foo.roles         #=> [ :admin, :editor, :vip ]
+    #
+    #   foo.reset_roles!
+    #   foo.roles         #=> []
+    #
+    def reset_roles!
+      roles.clear
+    end
+    
+  end
+end
+
+ActiveRecord::Base.class_eval { extend Roleplayer }

data/roleplayer.gemspec

@@ -0,0 +1,58 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{roleplayer}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Tarsoly András"]
+  s.date = %q{2010-04-22}
+  s.email = %q{tarsolya@gmail.com}
+  s.extra_rdoc_files = [
+    "README"
+  ]
+  s.files = [
+    "MIT-LICENSE",
+     "README",
+     "Rakefile",
+     "VERSION",
+     "init.rb",
+     "install.rb",
+     "lib/generators/roleplayer.rb",
+     "lib/generators/roleplayer/migration/USAGE",
+     "lib/generators/roleplayer/migration/migration_generator.rb",
+     "lib/generators/roleplayer/migration/templates/migration.rb",
+     "lib/roleplayer.rb",
+     "roleplayer.gemspec",
+     "uninstall.rb"
+  ]
+  s.homepage = %q{http://github.com/tarsolya/roleplayer}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Add simple role support to your models.}
+  s.test_files = [
+    "spec/roleplayer/roleplayer_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec-expectations>, [">= 0"])
+      s.add_development_dependency(%q<rspec-mocks>, [">= 0"])
+    else
+      s.add_dependency(%q<rspec-expectations>, [">= 0"])
+      s.add_dependency(%q<rspec-mocks>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rspec-expectations>, [">= 0"])
+    s.add_dependency(%q<rspec-mocks>, [">= 0"])
+  end
+end
+

data/spec/roleplayer/roleplayer_spec.rb

@@ -0,0 +1,7 @@
+require 'spec/spec_helper'
+
+describe "Roleplayer" do
+  it "true" do
+    false
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,48 @@
+$LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
+require 'rspec/core'
+
+$LOAD_PATH << File.expand_path('../../../rspec-expectations/lib', __FILE__)
+$LOAD_PATH << File.expand_path('../../../rspec-mocks/lib', __FILE__)
+require 'rspec/expectations'
+require 'rspec/mocks'
+
+begin
+  require 'autotest'
+rescue LoadError
+  raise "You must install autotest to use it"
+end
+
+require 'autotest/rspec2'
+
+module Rspec
+  module Core
+    module Matchers
+      def fail
+        raise_error(::Rspec::Expectations::ExpectationNotMetError)
+      end
+
+      def fail_with(message)
+        raise_error(::Rspec::Expectations::ExpectationNotMetError, message)
+      end
+    end
+  end
+end
+
+def use_formatter(new_formatter)
+  original_formatter = Rspec.configuration.formatter
+  Rspec.configuration.instance_variable_set(:@formatter, new_formatter)
+  yield
+ensure
+  Rspec.configuration.instance_variable_set(:@formatter, original_formatter)
+end
+
+def in_editor?
+  ENV.has_key?('TM_MODE') || ENV.has_key?('EMACS') || ENV.has_key?('VIM')
+end
+
+Rspec.configure do |c|
+  c.color_enabled = !in_editor?
+  c.exclusion_filter = { :ruby => lambda {|version|
+    !(RUBY_VERSION.to_s =~ /^#{version.to_s}/)
+  }}
+end

data/uninstall.rb

@@ -0,0 +1 @@
+# No uninstall necessary

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification 
+name: roleplayer
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- "Tarsoly Andr\xC3\xA1s"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-22 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec-expectations
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec-mocks
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+description: 
+email: tarsolya@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- MIT-LICENSE
+- README
+- Rakefile
+- VERSION
+- init.rb
+- install.rb
+- lib/generators/roleplayer.rb
+- lib/generators/roleplayer/migration/USAGE
+- lib/generators/roleplayer/migration/migration_generator.rb
+- lib/generators/roleplayer/migration/templates/migration.rb
+- lib/roleplayer.rb
+- roleplayer.gemspec
+- uninstall.rb
+has_rdoc: true
+homepage: http://github.com/tarsolya/roleplayer
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Add simple role support to your models.
+test_files: 
+- spec/roleplayer/roleplayer_spec.rb
+- spec/spec_helper.rb