simple_roles 0.0.5

data/.rspec

@@ -0,0 +1 @@
+--color --format nested

data/Gemfile

@@ -0,0 +1,22 @@
+source "http://rubygems.org"
+
+# Declare your gem's dependencies in simple_roles.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+
+gem 'require_all'
+gem 'sugar-high'
+gem 'sweetloader'
+
+group :development, :test do
+  gem 'activerecord'
+  gem 'rake-kit'
+  gem 'devise'
+  gem 'mysql2'
+  gem 'jeweler'
+  gem 'cutter'
+  gem 'rails'
+  gem 'rspec-rails'
+  gem 'capybara'
+  gem 'factory_girl'
+end

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 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/README.md

@@ -0,0 +1,81 @@
+# SimpleRoles
+
+SimpleRoles is a Rails Engine providing simple Role System for any Rails 3 app. It was created as demo role-system to accompany [CanTango gem](https://github.com/kristianmandrup/cantango) initial installiation and usage. Intended to be very easy to setup & use.
+
+It even seems to be good for being used as a real role system inspite of (or due to ;)) its almost maximum simplicity.
+
+If you are looking for a real serious roles system solution try [Troles](https://github.com/kristianmandrup/troles) gem created by [Kristian Mandrup](https://github.com/kristianmandrup)
+
+## Installiation
+
+### Prerequisites
+
+SimpleRoles only assumes you have User model
+
+### Not a Gem yet
+
+include in Gemfile:
+
+```ruby
+gem 'simple_roles', :git => "git://github.com/stanislaw/simple_roles.git"
+bundle update
+```
+
+### Set up valid roles you're gonna have in your app
+
+Create file simple_roles.rb in config/initializers and write there:
+
+```ruby
+# config/initializers/simple_roles.rb
+SimpleRoles.configure do |config|
+  config.valid_roles = [:user, :admin, :editor]
+end
+```
+
+### Copy and migrate SimpleRoles migrations by following rake task:
+
+```ruby
+rake simple_roles_engine:install:migrations
+rake db:migrate
+```
+
+Note! Migrations are based on roles you set up as valid (see previous step). If you do not create initializer with valid_roles, then valid_roles will be set up to defaults: :user and :admin.
+
+### And finally include 'simple_roles' macros in your User model:
+
+```ruby
+class User
+  simple_roles
+end
+```
+
+## Usage
+
+```ruby
+user.roles => #<RolesArray: {}>
+
+user.roles = :admin
+user.roles # => #<RolesArray: {:admin}>
+user.roles_list # => #<RolesArray: {:admin}>
+user.admin? # => true
+user.is_admin? # => true
+
+user.roles << :user
+user.roles # => #<RolesArray: {:admin, :user}>
+user.is_user? # => true
+
+user.add_role :editor
+user.roles # => #<RolesArray: #{:admin, :user, :editor}>
+
+user.remove_role :user
+user.roles # => #<RolesArray: {:admin, :editor}>
+user.has_role?(:admin) # => true
+user.has_any_role?(:admin, :blip) # => true
+user.has_role?(:blogger) # => false
+```
+
+## Todo:
+
+- Write role groups part
+- Provide some more config options
+- More and better tests

data/Rakefile

@@ -0,0 +1,53 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "simple_roles"
+  gem.homepage = "http://github.com/stanislaw/simple_roles"
+  gem.license = "MIT"
+  gem.summary = %Q{Rails Engine providing Role System for Rails apps}
+  gem.description = %Q{Simple Role System for Rails Apps}
+  gem.email = "s.pankevich@gmail.com"
+  gem.authors = ["stanislaw"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SimpleRoles'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/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/VERSION

@@ -0,0 +1 @@
+0.0.5

data/app/models/role.rb

@@ -0,0 +1,4 @@
+class Role < ActiveRecord::Base
+  has_many :user_roles
+  has_many :users, :through => :user_roles
+end

data/app/models/user_role.rb

@@ -0,0 +1,4 @@
+class UserRole < ActiveRecord::Base
+  belongs_to :user
+  belongs_to :role
+end

data/config/routes.rb

@@ -0,0 +1,2 @@
+Rails.application.routes.draw do
+end

data/db/migrate/001_create_user_roles.rb

@@ -0,0 +1,15 @@
+class CreateUserRoles < ActiveRecord::Migration
+  def up
+   create_table :user_roles do |t|
+    t.integer :user_id
+    t.integer :role_id
+
+    t.timestamps
+    end
+    add_index :user_roles, [:user_id, :role_id]
+ end
+
+  def down
+    drop_table :user_roles
+  end
+end

data/db/migrate/002_create_roles.rb

@@ -0,0 +1,22 @@
+class CreateRoles < ActiveRecord::Migration
+  def up
+    create_table :roles do |t|
+      t.string :name
+      t.timestamps
+    end
+
+    create_roles
+  end
+
+  def down
+    drop_table :roles
+  end
+
+
+  def create_roles
+    SimpleRoles::Configuration.valid_roles.each do |role|
+      Role.create(:name => role.to_s)
+    end
+  end
+end
+

data/lib/simple_roles/base.rb

@@ -0,0 +1,111 @@
+module SimpleRoles
+  module Base
+
+    class << self
+      def included base
+        base.class_eval %{
+          has_many :user_roles
+          has_many :db_roles, :through => :user_roles, :class_name => 'Role', :source => :role
+        }
+
+        base.send :include, SimpleRoles::Base::InstanceMethods
+        SimpleRoles::Configuration.user_models << base
+        base.register_roles_methods
+      end
+    end
+
+    module ClassMethods
+      def register_roles_methods
+        valid_roles.each do |role|
+          class_eval %{
+            def self.#{role}s
+              Role.find_by_name("#{role}").users
+            end
+            
+            def self.#{role}s_ids
+              Role.find_by_name("#{role}").user_ids
+            end
+          }
+
+          define_method :"#{role}?" do
+            roles.include?(:"#{role}")
+          end
+
+          alias_method :"is_#{role}?", :"#{role}?"
+        end
+      end
+
+      def valid_roles
+        SimpleRoles::Configuration.valid_roles
+      end
+    end
+
+    module InstanceMethods
+
+      def self.included base
+        base.send :extend, ClassMethods
+      end
+
+      def mass_assignment_authorizer *args
+        super.empty? ? super : (super + [:roles])
+      end
+      
+      def roles
+        roles_array 
+      end
+
+      alias_method :roles_list, :roles
+
+      def has_roles? *rolez
+        rolez.flatten!
+        rolez.each do |role|
+          return false if !roles.include? role
+        end
+        true
+      end
+
+      alias_method :has_role?, :has_roles?
+
+      def has_any_role? *rolez
+        rolez.flatten!
+        rolez.each do |role|
+          return true if roles.include? role
+        end
+        false 
+      end
+
+      def add_roles *rolez
+        roles_array.add *rolez
+      end
+
+      alias_method :add_role, :add_roles
+
+      def remove_roles *rolez
+        roles_array.remove *rolez
+      end
+
+      alias_method :remove_role, :remove_roles
+
+      def roles= *rolez
+        roles_array.roles = *rolez
+      end
+
+      # TODO: implement
+      #
+      def role_groups_list
+        []
+      end
+
+      private
+
+      def roles_array
+        @roles_array ||= SimpleRoles::RolesArray.new self
+      end
+
+    end
+
+  end
+end
+
+
+

data/lib/simple_roles/configuration.rb

@@ -0,0 +1,33 @@
+require 'singleton'
+module SimpleRoles
+  module Configuration
+
+    extend self
+    
+    attr_accessor :valid_roles, :user_models
+
+    def user_models
+      @user_models ||= []
+    end
+
+    def valid_roles= vr
+      raise "There should be an array of valid roles" if !vr.kind_of?(Array)
+      @valid_roles = vr
+      distribute_methods
+    end
+
+    def valid_roles
+      @valid_roles || default_roles
+    end
+
+    def default_roles
+      [:user, :admin]
+    end
+
+    def distribute_methods
+      user_models.each do |um|
+        um.register_roles_methods
+      end
+    end
+  end
+end

data/lib/simple_roles/engine.rb

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

data/lib/simple_roles/macros.rb

@@ -0,0 +1,13 @@
+module SimpleRoles
+  module Macros
+    def self.included(base)
+    end
+
+    def simple_roles &block
+      yield SimpleRoles::Configuration if block
+      include SimpleRoles::Base
+    end
+  end
+end
+
+Module.send :include, SimpleRoles::Macros

data/lib/simple_roles/roles_array.rb

@@ -0,0 +1,63 @@
+module SimpleRoles
+  class RolesArray < Array
+
+    attr_reader :base
+
+    def initialize *args
+      @base = args.delete(args.first)
+      super
+      synchronize
+    end
+
+    def synchronize 
+      replace real_roles
+    end
+    
+    def real_roles_db
+      base.db_roles
+    end
+
+    def real_roles
+      real_roles_db.map(&:name).map(&:to_sym)
+    end
+
+    def roles= *rolez
+      rolez.to_symbols!.flatten!
+      raise "Not a valid role!" if (rolez.to_a - SimpleRoles::Configuration.valid_roles).size > 0
+
+      base.db_roles = rolez.map do |rolle|
+        begin
+          Role.find_by_name!(rolle.to_s)
+        rescue
+          raise "Couldn't find Role for #{rolle}. Maybe you need to re-run migrations?"
+        end
+      end
+
+      synchronize
+    end
+
+    def << *rolez
+      rolez.flatten!
+      self.roles = self.to_a + rolez
+    end
+
+    alias_method :add, :<<
+
+    def remove *rolez
+      rolez.flatten!
+      self.roles = self.to_a - rolez
+    end
+
+    def clear!
+      real_roles_db.clear
+      base.save!
+      clear
+    end
+
+    private
+
+    def clear
+      super
+    end
+  end
+end

data/lib/simple_roles/version.rb

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

data/lib/simple_roles.rb

@@ -0,0 +1,19 @@
+require "sweetloader"
+require "require_all"
+require "sugar-high/array"
+require "sugar-high/dsl"
+
+require "simple_roles/engine" if defined?(Rails)
+require "simple_roles/macros"
+
+require_all File.expand_path("../../app", __FILE__)
+
+module SimpleRoles
+  autoload_modules :Base, :Configuration, :RolesArray
+
+  class << self
+    def configure &block
+      yield SimpleRoles::Configuration
+    end
+  end
+end

data/lib/tasks/simple_roles_tasks.rake

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

data/script/rails

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+#!/usr/bin/env ruby
+# This command will automatically be run when you run "rails" with Rails 3 gems installed from the root of your application.
+
+ENGINE_PATH = File.expand_path('../..',  __FILE__)
+load File.expand_path('../../spec/dummy/script/rails',  __FILE__)