objectreload-roles 0.1.0

data/.gitignore

@@ -0,0 +1,3 @@
+*.gemspec
+*.log
+pkg/

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 [name of plugin creator]
+
+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,39 @@
+Roles
+=====
+
+Simple roles system.
+
+Migrations
+=====
+
+  create_table :roles do |t|
+    t.string :name
+  end
+  Role.create(:name => "administrator")
+
+
+  create_table :privileges, :id => false do |t|
+    t.integer :user_id
+    t.integer :role_id
+  end
+
+
+Examples
+=======
+
+Available methods if administrator role has been created: 
+    user.administrator? 
+    user.is?(:administrator)
+    user.is_not?(:administrator)
+
+Add more roles in the migration: moderator, uploader etc.
+    user.moderator?
+    user.is?(:uploader)
+
+Find all users with moderator role
+    User.find_with_role(:moderator)
+or
+    Role[:moderator].users
+
+
+Copyright (c) 2008 [name of plugin creator], released under the MIT license

data/Rakefile

@@ -0,0 +1,55 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "objectreload-roles"
+    gem.summary = "Simple way to create roles for users."
+    gem.email = "gems@objectreload.com"
+    gem.homepage = "http://github.com/objectreload/roles"
+    gem.authors = ["Mateusz Drozdzynski"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "roles_gem #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/init.rb

@@ -0,0 +1,9 @@
+require 'role'
+
+if Role.table_exists?
+  require 'action_filters'
+  ActiveRecord::Base.send(:include, ActiveRecord::Aggregations::HasRoles)
+  ActionController::Base.send(:extend, Roles::ActionFilters)
+else
+  ActiveRecord::Base.class_eval { def self.has_roles; end }
+end

data/install.rb

@@ -0,0 +1 @@
+# Install hook code here

data/lib/action_filters.rb

@@ -0,0 +1,15 @@
+module Roles
+  module ActionFilters
+    def require_role(role, options = {})
+      method = "_require_role_#{role}_#{Time.now.to_i}"
+      
+      define_method method do
+        raise Unauthorized unless send(:current_user) and send(:current_user).is?(:"#{role}")
+      end
+      
+      before_filter method, options
+    end
+  end
+  
+  class Unauthorized < Exception; end
+end

data/lib/active_record/aggregations/has_roles.rb

@@ -0,0 +1,61 @@
+module ActiveRecord
+  module Aggregations
+    module HasRoles
+      def self.included(base)
+        base.extend Macro
+      end
+      
+      module Macro
+        def has_roles(options = {})
+          write_inheritable_attribute :privileges_table_name, options[:join_table] || "privileges"
+          
+          has_and_belongs_to_many :roles, :join_table => read_inheritable_attribute(:privileges_table_name), :uniq => true
+
+          include InstanceMethods
+          extend ClassMethods
+
+          Role.all.each do |role|
+            define_method("#{role}?") do
+              is?(role.to_s) 
+            end
+          end
+          
+          Role.instance_eval <<-TXT
+            has_and_belongs_to_many :#{class_name.downcase.pluralize}, :join_table => :#{read_inheritable_attribute(:privileges_table_name)}, :uniq => true
+          TXT
+        end
+      end
+      
+      module ClassMethods
+        def self.extended(base)
+          Role.all.each do |role|
+            base.named_scope role.to_s.pluralize.to_sym, :include => :roles, :conditions => ["roles.id = ?", role.id]
+          end
+        end
+        
+        def roles
+          Role.all
+        end
+        
+        def find_with_role(*role_names)
+          find(:all, :include => :roles, :conditions => ["roles.name IN (?)", role_names.map(&:to_s)]).uniq
+        end
+      end
+      
+      module InstanceMethods
+        # returns true 
+        #  - when user has administrator role
+        #  - when user has one of the supplied roles
+        def is?(*role_names)
+          roles = Rails.cache.fetch("/#{self.class.to_s.tableize}/#{id}/roles") { self.roles.map }
+          return true if roles.include?(Role[:administrator])
+          Array(role_names).any? { |name| roles.include?(Role[name]) }
+        end
+        
+        def is_not?(*role_names)
+          not is?(*role_names)
+        end
+      end
+    end
+  end
+end

data/lib/role.rb

@@ -0,0 +1,10 @@
+class Role < ActiveRecord::Base
+  validates_presence_of :name
+  validates_uniqueness_of :name
+    
+  def self.[](name)
+    Rails.cache.fetch("/roles/#{name}") { find_by_name(name.to_s) }
+  end
+
+  def to_s; name; end
+end

data/tasks/roles_tasks.rake

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

data/test/blueprints.rb

@@ -0,0 +1,16 @@
+require "machinist/active_record"
+require "sham"
+require "faker"
+
+Sham.define do
+  login { Faker::Name.first_name.downcase }
+  name { ['administrator', 'moderator', 'editor', 'uploader'].rand }
+end
+
+User.blueprint do
+  login { Sham.login }
+end
+
+Role.blueprint do
+  name { Sham.name }
+end

data/test/config/boot.rb

@@ -0,0 +1,110 @@
+# Don't change this file!
+# Configure your app in config/environment.rb and config/environments/*.rb
+ 
+RAILS_ROOT = "#{File.dirname(__FILE__)}/.." unless defined?(RAILS_ROOT)
+
+module Rails
+  class << self
+    def boot!
+      unless booted?
+        preinitialize
+        pick_boot.run
+      end
+    end
+
+    def booted?
+      defined? Rails::Initializer
+    end
+
+    def pick_boot
+      (vendor_rails? ? VendorBoot : GemBoot).new
+    end
+
+    def vendor_rails?
+      File.exist?("#{RAILS_ROOT}/vendor/rails")
+    end
+
+    def preinitialize
+      load(preinitializer_path) if File.exist?(preinitializer_path)
+    end
+
+    def preinitializer_path
+      "#{RAILS_ROOT}/config/preinitializer.rb"
+    end
+  end
+
+  class Boot
+    def run
+      load_initializer
+      Rails::Initializer.run(:set_load_path)
+    end
+  end
+
+  class VendorBoot < Boot
+    def load_initializer
+      require "#{RAILS_ROOT}/vendor/rails/railties/lib/initializer"
+      Rails::Initializer.run(:install_gem_spec_stubs)
+      Rails::GemDependency.add_frozen_gem_path
+    end
+  end
+
+  class GemBoot < Boot
+    def load_initializer
+      self.class.load_rubygems
+      load_rails_gem
+      require 'initializer'
+    end
+
+    def load_rails_gem
+      if version = self.class.gem_version
+        gem 'rails', version
+      else
+        gem 'rails'
+      end
+    rescue Gem::LoadError => load_error
+      $stderr.puts %(Missing the Rails #{version} gem. Please `gem install -v=#{version} rails`, update your RAILS_GEM_VERSION setting in config/environment.rb for the Rails version you do have installed, or comment out RAILS_GEM_VERSION to use the latest version installed.)
+      exit 1
+    end
+
+    class << self
+      def rubygems_version
+        Gem::RubyGemsVersion rescue nil
+      end
+
+      def gem_version
+        if defined? RAILS_GEM_VERSION
+          RAILS_GEM_VERSION
+        elsif ENV.include?('RAILS_GEM_VERSION')
+          ENV['RAILS_GEM_VERSION']
+        else
+          parse_gem_version(read_environment_rb)
+        end
+      end
+
+      def load_rubygems
+        require 'rubygems'
+        min_version = '1.3.1'
+        unless rubygems_version >= min_version
+          $stderr.puts %Q(Rails requires RubyGems >= #{min_version} (you have #{rubygems_version}). Please `gem update --system` and try again.)
+          exit 1
+        end
+
+      rescue LoadError
+        $stderr.puts %Q(Rails requires RubyGems >= #{min_version}. Please install RubyGems and try again: http://rubygems.rubyforge.org)
+        exit 1
+      end
+
+      def parse_gem_version(text)
+        $1 if text =~ /^[^#]*RAILS_GEM_VERSION\s*=\s*["']([!~<>=]*\s*[\d.]+)["']/
+      end
+
+      private
+        def read_environment_rb
+          File.read("#{RAILS_ROOT}/config/environment.rb")
+        end
+    end
+  end
+end
+
+# All that for this:
+Rails.boot!

data/test/config/database.yml

@@ -0,0 +1,3 @@
+test:
+  adapter: sqlite3
+  database: ":memory:"

data/test/config/environment.rb

@@ -0,0 +1,13 @@
+# Specifies gem version of Rails to use when vendor/rails is not present
+RAILS_GEM_VERSION = '2.3.5' unless defined? RAILS_GEM_VERSION
+
+# Bootstrap the Rails environment, frameworks, and default configuration
+require File.join(File.dirname(__FILE__), 'boot')
+
+Rails::Initializer.run do |config|
+  
+  config.gem "mhennemeyer-matchy", :lib => false, :source => "http://gems.github.com"
+  config.gem "machinist", :lib => false
+
+  config.action_controller.session = { :session_key => "_myapp_session", :secret => "6c1372e61789239a727cdbc8252eb6da" }
+end

data/test/config/environments/test.rb

@@ -0,0 +1,21 @@
+# Settings specified here will take precedence over those in config/environment.rb
+
+# The test environment is used exclusively to run your application's
+# test suite. You never need to work with it otherwise. Remember that
+# your test database is "scratch space" for the test suite and is wiped
+# and recreated between test runs. Don't rely on the data there!
+config.cache_classes = true
+
+# Log error messages when you accidentally call methods on nil.
+config.whiny_nils = true
+
+# Show full error reports and disable caching
+config.action_controller.consider_all_requests_local = true
+config.action_controller.perform_caching = false
+
+# Tell ActionMailer not to deliver emails to the real world.
+# The :test delivery method accumulates sent emails in the
+# ActionMailer::Base.deliveries array.
+config.action_mailer.delivery_method = :test
+
+config.gem "thoughtbot-shoulda", :lib => false, :source => "http://gems.github.com"

data/test/config/routes.rb

@@ -0,0 +1,6 @@
+ActionController::Routing::Routes.draw do |map|
+
+  # Install the default route as the lowest priority.
+  map.connect ':controller/:action/:id.:format'
+  map.connect ':controller/:action/:id'
+end

data/test/models/user.rb

@@ -0,0 +1,3 @@
+class User < ActiveRecord::Base
+  has_roles
+end

data/test/role_test.rb

@@ -0,0 +1,41 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class RoleTest < ActiveSupport::TestCase
+  context "Role" do
+    setup do
+      #sham.reset doesn't work
+      @admin = Role.find_by_name('administrator')
+      @moderator = Role.find_by_name('moderator')
+      @uploader = Role.find_by_name('uploader')
+      @editor = Role.find_by_name('editor')
+      @john = User.find_by_login('John') || User.make(:login => 'John')
+      @kate = User.find_by_login('Kate') || User.make(:login => 'Kate')
+    end
+    context "Role model" do
+      setup do
+        @john.roles << @admin
+        @kate.roles = [@moderator, @uploader]
+      end
+      subject {@admin}
+      
+      should_validate_presence_of :name
+      should_validate_uniqueness_of :name
+      
+      should "find_by_name method" do
+        Role.find_by_name("administrator").should == Role[:administrator]
+      end
+
+      should "role has association to user" do
+        Role[:administrator].users.size.should == 1
+        Role[:moderator].users.size.should == 1
+        Role[:uploader].users.size.should == 1
+        Role[:editor].users.size.should == 0
+      end
+
+      should "check to_s method" do
+        @admin.to_s.should == @admin.name
+        @admin.to_s.should == "administrator"
+      end
+   end
+  end
+end

data/test/schema.rb

@@ -0,0 +1,19 @@
+ActiveRecord::Schema.define(:version => 3) do
+  create_table :roles do |t|
+    t.string :name
+  end
+
+  Role.create(:name => 'administrator')
+  Role.create(:name => 'uploader')
+  Role.create(:name => 'moderator')
+  Role.create(:name => 'editor')
+
+  create_table :privileges, :id => false do |t|
+    t.integer :user_id
+    t.integer :role_id
+  end
+
+  create_table :users do |t|
+    t.string :login
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,28 @@
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+
+ENV["RAILS_ENV"] = "test"
+require File.expand_path(File.dirname(__FILE__) + "/config/environment")
+
+require 'test/unit'
+require 'rubygems'
+require 'active_record'
+require 'active_support'
+require "#{File.dirname(__FILE__)}/../lib/role"
+require "#{File.dirname(__FILE__)}/../lib/active_record/aggregations/has_roles"
+
+load(File.dirname(__FILE__) + "/schema.rb")
+
+ActiveRecord::Base.send(:include, ActiveRecord::Aggregations::HasRoles)
+
+require 'action_filters'
+require 'test/models/user'
+
+require File.expand_path(File.dirname(__FILE__) + "/blueprints")
+require 'mocha'
+require 'shoulda'
+require 'matchy'
+
+class ActiveSupport::TestCase
+  setup { Sham.reset }
+end
+

data/test/user_test.rb

@@ -0,0 +1,58 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class UserTest < ActiveSupport::TestCase
+  context "User" do
+    setup do
+      #sham.reset doesn't work
+      @admin = Role.find_by_name('administrator') 
+      @moderator = Role.find_by_name('moderator') 
+      @uploader = Role.find_by_name('uploader') 
+      @editor = Role.find_by_name('editor')
+      @john = User.find_by_login('John') || User.make(:login => 'John')
+      @kate = User.find_by_login('Kate') || User.make(:login => 'Kate')
+    end
+
+    context "User model" do
+      setup do
+        @john.roles << @admin
+        @kate.roles = [@moderator, @uploader]
+      end
+      subject { @john }
+
+      should_have_and_belong_to_many :roles
+
+      should "user has roles" do
+        @john.roles.count.should == 1
+        @kate.roles.count.should == 2
+      end
+
+      should "is and is_not methods" do
+        # john.roles => :administrator
+        @john.is?(:administrator).should == true
+        @john.is?(:uploader).should == true
+        @john.is_not?(:editor).should == false
+
+        # kate.roles => :moderator, :uploader
+        @kate.is_not?(:uploader).should == false
+        @kate.is_not?(:uploader, :moderator, :administrator).should == false
+        @kate.is_not?(:editor).should == true
+        @kate.is?(:uploader).should == true
+      end
+
+      should "generating methods" do
+        @john.respond_to?(:administrator?).should == true
+        @john.administrator?.should == true
+        @john.uploader?.should == true
+
+        @kate.administrator?.should_not == true
+        @kate.moderator?.should == true
+        @kate.uploader?.should == true
+      end
+
+      should "find_with_role method" do
+        User.find_with_role(:moderator, :uploader, :administrator).size.should == 2
+        User.find_with_role(:moderator).size.should == 1
+      end
+    end
+  end
+end

data/uninstall.rb

@@ -0,0 +1 @@
+# Uninstall hook code here

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification 
+name: objectreload-roles
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Mateusz Drozdzynski
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-21 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: 
+email: gems@objectreload.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- .gitignore
+- MIT-LICENSE
+- README
+- Rakefile
+- VERSION
+- init.rb
+- install.rb
+- lib/action_filters.rb
+- lib/active_record/aggregations/has_roles.rb
+- lib/role.rb
+- tasks/roles_tasks.rake
+- test/blueprints.rb
+- test/config/boot.rb
+- test/config/database.yml
+- test/config/environment.rb
+- test/config/environments/test.rb
+- test/config/routes.rb
+- test/models/user.rb
+- test/role_test.rb
+- test/schema.rb
+- test/test_helper.rb
+- test/user_test.rb
+- uninstall.rb
+has_rdoc: true
+homepage: http://github.com/objectreload/roles
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Simple way to create roles for users.
+test_files: 
+- test/blueprints.rb
+- test/config/boot.rb
+- test/config/environment.rb
+- test/config/environments/test.rb
+- test/config/routes.rb
+- test/models/user.rb
+- test/role_test.rb
+- test/schema.rb
+- test/test_helper.rb
+- test/user_test.rb