rolify 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+gem "activerecord", :require => "active_record"
+
+# Specify your gem's dependencies in rolify.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Florent Monbillard
+
+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.rdoc

@@ -0,0 +1,80 @@
+= rolify
+
+Very simple Roles library without any authorization enforcement (built to use with cancan) supporting scope on object.
+
+Let's see an example:  
+
+  user.is_moderator?(Forum.first) => # return false if user is moderator of another Forum
+
+This library was intended to be used with CanCan[https://github.com/ryanb/cancan] and devise[https://github.com/plataformatec/devise/] but should be generic enough to be used by any other authentication/authorization solutions.
+
+== Requirements
+
+* >= Rails 3
+* ActiveRecord ORM
+
+== Installation
+
+In <b>Rails 3</b>, add this to your Gemfile and run the +bundle+ command.
+
+  gem "rolify"
+
+Alternatively, you can install it as a plugin.
+
+  rails plugin install git://github.com/EppO/rolify.git
+
+== Getting Started
+
+=== 1. Generate Role Modle
+
+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
+
+Let's migrate !
+
+  rake db:migrate
+
+=== 3. Add a role to a user
+
+To define a global role:
+
+  user = User.find(1)
+  user.has_role "admin"
+
+To define a role scoped to a resource
+
+  user = User.find(2)
+  user.has_role "moderator", Forum.first
+
+That's it !
+
+=== 4. Check roles
+
+To check if a user has a global role
+
+  user = User.find(1)
+  user.has_role? "admin"
+  # => true
+
+To check if a user has a role scoped to a resource
+
+  user = User.find(2)
+  user.has_role "moderator", Forum.first
+  # => true
+  user.has_role "moderator", Forum.last
+  # => false
+
+== Questions or Problems?
+
+If you have any issues with rolify which you cannot find the solution to in the tiny README[https://github.com/EppO/rolify], please add an {issue on GitHub}[https://github.com/EppO/rolify/issues] or fork the project and send a pull request.
+
+== TODO
+
+* Write specs
+* Write code

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

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

@@ -0,0 +1,34 @@
+require 'rails/generators/migration'
+
+module Rolify
+  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"
+
+      desc "Generates a model with the given NAME and a migration file."
+
+      def generate_role
+        template "role.rb", "app/models/role.rb"
+        inject_into_class(model_path, user_cname.camelize) do  
+          "  has_and_belongs_to_many :#{role_cname.tableize}\n"
+        end
+      end
+
+      def copy_role_file
+        migration_template "migration.rb", "db/migrate/rolify_create_#{role_cname.tableize}"
+      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
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+class RolifyCreate<%= role_cname.camelize %> < ActiveRecord::Migration
+  def change
+    create_table(<%= role_cname.tableize.to_sym %>) do |t|
+      t.string :name
+      t.references :resource, :polymorphic => true
+
+      t.timestamps
+    end
+
+    create_table(<%= (user_cname.tableize + "_" + role_cname.tableize).to_sym %>, :id => false) do |t|
+      t.references :<%= user_cname.underscore.singularize %>
+      t.references :<%= role_cname.underscore.singularize %>
+    end
+  end
+end

data/lib/generators/rolify/role/templates/role.rb

@@ -0,0 +1,3 @@
+class <%= role_cname.camelize %> < ActiveRecord::Base
+  has_and_belongs_to_many :<%= user_cname.tableize %>
+end

data/lib/rolify.rb

@@ -0,0 +1,3 @@
+module Rolify
+  # Your code goes here...
+end

data/lib/rolify/version.rb

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

data/rolify.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "rolify/version"
+
+Gem::Specification.new do |s|
+  s.name        = "rolify"
+  s.version     = Rolify::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Florent Monbillard"]
+  s.email       = ["f.monbillard@gmail.com"]
+  s.homepage    = "https://github.com/EppO/rolify"
+  s.summary     = %q{Roles library with object scoping}
+  s.description = %q{Very simple Roles library without any authorization enforcement (built to use with cancan) supporting scope on object: user.is_moderator?(Forum.first) => # return false if user is moderator of another Forum }
+
+  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"]
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+re 'rubygems'
+require 'bundler/setup'
+
+Bundler.require(:default)

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification 
+name: rolify
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Florent Monbillard
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-03 00:00:00 Z
+dependencies: []
+
+description: "Very simple Roles library without any authorization enforcement (built to use with cancan) supporting scope on object: user.is_moderator?(Forum.first) => # return false if user is moderator of another Forum "
+email: 
+- f.monbillard@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- LICENSE
+- README.rdoc
+- Rakefile
+- lib/generators/rolify/role/role_generator.rb
+- lib/generators/rolify/role/templates/migration.rb
+- lib/generators/rolify/role/templates/role.rb
+- lib/rolify.rb
+- lib/rolify/version.rb
+- rolify.gemspec
+- spec/spec.opts
+- spec/spec_helper.rb
+homepage: https://github.com/EppO/rolify
+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: rolify
+rubygems_version: 1.7.2
+signing_key: 
+specification_version: 3
+summary: Roles library with object scoping
+test_files: []
+