mintdigital-has_roles 1.0.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Krzysztof Zylawy
+
+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/Manifest

@@ -0,0 +1,18 @@
+generators/has_roles/has_roles_generator.rb
+generators/has_roles/templates/migration.rb
+generators/has_roles/USAGE
+has_roles.gemspec
+install.rb
+lib/has_roles.rb
+lib/role.rb
+lib/role_assignment.rb
+Manifest
+MIT-LICENSE
+rails/init.rb
+Rakefile
+README
+tasks/has_roles_tasks.rake
+test/assertions.rb
+test/has_roles_test.rb
+test/test_helper.rb
+uninstall.rb

data/README

@@ -0,0 +1,35 @@
+Install
+=======
+
+    $ gem source -a http://gems.github.com/
+    $ sudo gem install mintdigital-has_roles
+
+    # environment.rb
+    config.gem 'mintdigital-has_roles', :lib => 'has_roles'
+
+Example
+=======
+
+In an ActiveRecord class:
+
+    has_roles :admin, :moderator
+
+Then run:
+
+    ./script/generate has_roles && rake db:migrate
+
+Now your model has these instance methods:
+
+    add_role(:moderator)    #=> true
+    remove_role(:admin)     #=> true (doesn't have role)
+    has_role?(:admin)       #=> false
+    can_have_role?(:writer) #=> false
+
+    # These are auto-generated based on your defined roles.
+    # They just call has_role?(name)
+    admin?      #=> false
+    moderator?  #=> true
+
+---
+
+Copyright (c) 2008 Krzysztof Zylawy, released under the MIT license

data/Rakefile

@@ -0,0 +1,31 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'echoe'
+require File.join(File.dirname(__FILE__), %w[lib/has_roles])
+
+Echoe.new('has_roles') do |a|
+  a.version = HasRoles::Version::STRING
+  a.summary = "Simple roles for ActiveRecord"
+  a.author = "Krzysztof Zylawy"
+  a.email = "krzysztof@mintdigital.com"
+  a.runtime_dependencies = ['activerecord']
+  a.development_dependencies = ['echoe']
+  a.has_rdoc = false
+  a.retain_gemspec = true
+end
+
+desc 'Default: Run Tests'
+Rake::TestTask.new do |t|
+  t.warning = true
+  t.pattern = 'test/**/*_test.rb'
+end
+
+desc 'Generate documentation for the has_roles plugin.'
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'HasRoles'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/generators/has_roles/USAGE

@@ -0,0 +1,7 @@
+Description:
+    This generates migrations for roles and role_assignments models
+
+Example:
+    ./script/generate has_roles && rake db:migrate
+
+    This will create a migration for the roles and role_assignments tables.

data/generators/has_roles/has_roles_generator.rb

@@ -0,0 +1,10 @@
+class HasRolesGenerator < Rails::Generator::Base
+  def manifest
+    recorded_session = record do |m|
+      unless options[:skip_migration]
+        m.migration_template "migration.rb", "db/migrate",
+          :migration_file_name => 'create_roles'
+      end
+    end
+  end
+end

data/generators/has_roles/templates/migration.rb

@@ -0,0 +1,17 @@
+class CreateRoles < ActiveRecord::Migration
+  def self.up
+    create_table :roles do |t|
+      t.string :name
+    end
+
+    create_table :role_assignments do |t|
+      t.integer :roleable_id, :role_id
+      t.string :roleable_type
+    end
+  end
+
+  def self.down
+    drop_table :role_assignments
+    drop_table :roles
+  end
+end

data/has_roles.gemspec

@@ -0,0 +1,37 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{has_roles}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Krzysztof Zylawy"]
+  s.date = %q{2009-02-17}
+  s.description = %q{Simple roles for ActiveRecord}
+  s.email = %q{krzysztof@mintdigital.com}
+  s.extra_rdoc_files = ["lib/has_roles.rb", "lib/role.rb", "lib/role_assignment.rb", "README", "tasks/has_roles_tasks.rake"]
+  s.files = ["generators/has_roles/has_roles_generator.rb", "generators/has_roles/templates/migration.rb", "generators/has_roles/USAGE", "has_roles.gemspec", "install.rb", "lib/has_roles.rb", "lib/role.rb", "lib/role_assignment.rb", "Manifest", "MIT-LICENSE", "rails/init.rb", "Rakefile", "README", "tasks/has_roles_tasks.rake", "test/assertions.rb", "test/has_roles_test.rb", "test/test_helper.rb", "uninstall.rb"]
+  s.homepage = %q{}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Has_roles", "--main", "README"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{has_roles}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{Simple roles for ActiveRecord}
+  s.test_files = ["test/has_roles_test.rb", "test/test_helper.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activerecord>, [">= 0"])
+      s.add_development_dependency(%q<echoe>, [">= 0"])
+    else
+      s.add_dependency(%q<activerecord>, [">= 0"])
+      s.add_dependency(%q<echoe>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activerecord>, [">= 0"])
+    s.add_dependency(%q<echoe>, [">= 0"])
+  end
+end

data/install.rb

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

data/lib/has_roles.rb

@@ -0,0 +1,64 @@
+module HasRoles
+
+  module Version
+    MAJOR = 1
+    MINOR = 0
+    TINY  = 0
+
+    STRING = [MAJOR,MINOR,TINY].join('.')
+  end
+
+  def self.included(base)
+    base.extend HasMethods
+  end
+
+  module HasMethods
+    def has_roles(*roles)
+      roles.flatten!
+      write_inheritable_attribute(:available_roles, roles)
+      class_inheritable_reader :available_roles
+
+      unless included_modules.include? InstanceMethods
+        has_many :role_assignments, :as => :roleable, :dependent => :destroy
+        has_many :roles, :through => :role_assignments
+
+        extend ClassMethods
+        include InstanceMethods
+        available_roles.each do |role|
+          self.class_eval do
+            define_method "#{role}?".to_sym do
+              has_role?(role)
+            end
+          end
+        end
+      end
+    end
+  end
+
+  module ClassMethods
+  end
+
+  module InstanceMethods
+    def can_have_role?(role_name)
+      available_roles.include?(role_name)
+    end
+
+    def has_role?(rolename)
+      !self.roles.find_by_name(rolename.to_s).nil?
+    end
+
+    def add_role rolename
+      return false unless can_have_role?(rolename)
+      return true if has_role?(rolename)
+      self.roles << Role.find_or_create_by_name(rolename.to_s)
+      self.save
+    end
+
+    def remove_role name
+      return true if !has_role?(name)
+      role_assignment = self.role_assignments.detect { |x| x.role.name == name.to_s }
+      role_assignment.destroy if role_assignment
+    end
+
+  end
+end

data/lib/role.rb

@@ -0,0 +1,6 @@
+class Role < ActiveRecord::Base
+  has_many :role_assignments
+  has_many :roleables, :through => :role_assignments
+
+  validates_uniqueness_of :name, :message => "Role with that name already exists"
+end

data/lib/role_assignment.rb

@@ -0,0 +1,6 @@
+class RoleAssignment < ActiveRecord::Base
+  belongs_to :roleable, :polymorphic => true
+  belongs_to :role
+  validates_uniqueness_of :role_id, :scope => [:roleable_id, :roleable_type]
+  validates_presence_of :roleable_id, :roleable_type, :role_id
+end

data/rails/init.rb

@@ -0,0 +1,4 @@
+require File.join(File.dirname(__FILE__), %w[.. lib has_roles])
+
+ActiveRecord::Base.send(:include, HasRoles)
+

data/tasks/has_roles_tasks.rake

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

data/test/assertions.rb

@@ -0,0 +1,82 @@
+# Copyright (c) 2005-2009 David Heinemeier Hansson
+# 
+# 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.
+
+module ActiveSupport
+  module Testing
+    module Assertions
+      # Test numeric difference between the return value of an expression as a result of what is evaluated
+      # in the yielded block.
+      #
+      #   assert_difference 'Article.count' do
+      #     post :create, :article => {...}
+      #   end
+      #
+      # An arbitrary expression is passed in and evaluated.
+      #
+      #   assert_difference 'assigns(:article).comments(:reload).size' do
+      #     post :create, :comment => {...}
+      #   end
+      #
+      # An arbitrary positive or negative difference can be specified. The default is +1.
+      #
+      #   assert_difference 'Article.count', -1 do
+      #     post :delete, :id => ...
+      #   end
+      #
+      # An array of expressions can also be passed in and evaluated.
+      #
+      #   assert_difference [ 'Article.count', 'Post.count' ], +2 do
+      #     post :create, :article => {...}
+      #   end
+      #
+      # A error message can be specified.
+      #
+      #   assert_difference 'Article.count', -1, "An Article should be destroyed" do
+      #     post :delete, :id => ...
+      #   end
+      def assert_difference(expressions, difference = 1, message = nil, &block)
+        expression_evaluations = Array(expressions).collect{ |expression| lambda { eval(expression, block.send(:binding)) } }
+
+        original_values = expression_evaluations.inject([]) { |memo, expression| memo << expression.call }
+        yield
+        expression_evaluations.each_with_index do |expression, i|
+          assert_equal original_values[i] + difference, expression.call, message
+        end
+      end
+
+      # Assertion that the numeric result of evaluating an expression is not changed before and after
+      # invoking the passed in block.
+      #
+      #   assert_no_difference 'Article.count' do
+      #     post :create, :article => invalid_attributes
+      #   end
+      #
+      # A error message can be specified.
+      #
+      #   assert_no_difference 'Article.count', "An Article should not be destroyed" do
+      #     post :create, :article => invalid_attributes
+      #   end
+      def assert_no_difference(expressions, message = nil, &block)
+        assert_difference expressions, 0, message, &block
+      end
+    end
+  end
+end

data/test/has_roles_test.rb

@@ -0,0 +1,144 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class RoleableSample < ActiveRecord::Base
+  has_roles [:sample_role_1, :sample_role_2]
+end
+
+class AnotherRoleable < ActiveRecord::Base
+  has_roles :another1, :another2
+end
+
+class HasRolesTest < Test::Unit::TestCase
+
+  def setup
+    @roleable_sample = RoleableSample.create
+  end
+
+  def teardown
+    [Role, RoleAssignment, RoleableSample].each {|klass| klass.delete_all }
+  end
+
+  def test_active_record_should_respond_to_has_roles
+    assert ActiveRecord::Base.respond_to?(:has_roles)
+  end
+
+  def test_roleable_class_should_return_available_roles
+    assert_equal [:sample_role_1, :sample_role_2], RoleableSample.available_roles
+  end
+
+  def test_roleable_object_can_have_its_class_roles
+    [:sample_role_1, :sample_role_2].each do |role_name|
+      assert_equal(true, @roleable_sample.can_have_role?(role_name))
+    end
+  end
+
+  def test_should_be_able_to_add_valid_role_to_roleable
+    assert_difference "RoleAssignment.count", 1 do
+      assert_difference "Role.count", 1 do
+        @roleable_sample.add_role(:sample_role_1)
+      end
+    end
+  end
+
+  def test_should_return_true_when_role_added
+    assert @roleable_sample.add_role(:sample_role_1)
+  end
+
+  def test_should_not_be_able_to_add_invalid_role_to_roleable
+    assert_no_difference "RoleAssignment.count", 1 do
+      assert_no_difference "Role.count", 1 do
+        @roleable_sample.add_role(:invalid_role)
+      end
+    end
+    assert_equal(false, @roleable_sample.has_role?(:invalid_role))
+  end
+
+  def test_should_return_false_when_invalid_role_not_added
+    assert !@roleable_sample.add_role(:invalid_role)
+  end
+
+  def test_should_not_add_role_nor_assignment_if_already_has_role
+    @roleable_sample.add_role(:sample_role_1)
+    assert_no_difference "RoleAssignment.count" do
+      assert_no_difference "Role.count" do
+        @roleable_sample.add_role(:sample_role_1)
+      end
+    end
+    assert_equal(true, @roleable_sample.has_role?(:sample_role_1))
+  end
+
+  def test_should_return_true_if_already_has_role
+    @roleable_sample.add_role(:sample_role_1)
+    assert @roleable_sample.has_role?(:sample_role_1), 'Precondition: has role'
+    assert @roleable_sample.add_role(:sample_role_1)
+  end
+
+  def test_should_add_assignment_but_not_role_nor_assignment_if_role_exists
+    Role.create(:name => 'sample_role_1')
+    assert_difference "RoleAssignment.count", 1 do
+      assert_no_difference "Role.count" do
+        @roleable_sample.add_role(:sample_role_1)
+      end
+    end
+    assert_equal(true, @roleable_sample.has_role?(:sample_role_1))
+  end
+
+  def test_should_have_added_role
+    @roleable_sample.add_role(:sample_role_1)
+    assert_equal(true, @roleable_sample.has_role?(:sample_role_1))
+  end
+
+  def test_should_not_have_not_added_role
+    @roleable_sample.add_role(:sample_role_1)
+    assert_equal(false, @roleable_sample.has_role?(:sample_role_2))
+  end
+
+  def test_should_remove_role_assignment
+    @roleable_sample.add_role(:sample_role_1)
+    assert_difference "RoleAssignment.count", -1 do
+      assert_no_difference "Role.count" do
+        @roleable_sample.remove_role(:sample_role_1)
+      end
+    end
+    assert_equal(false, @roleable_sample.has_role?(:sample_role_1))
+  end
+
+  def test_should_return_true_when_role_removed
+    @roleable_sample.add_role(:sample_role_1)
+    assert @roleable_sample.has_role?(:sample_role_1), 'Precondition: has role'
+    assert @roleable_sample.remove_role(:sample_role_1)
+  end
+
+  def test_should_not_remove_role_assignment_when_removing_other_role
+    @roleable_sample.add_role(:sample_role_1)
+    assert_no_difference "RoleAssignment.count" do
+      assert_no_difference "Role.count" do
+        @roleable_sample.remove_role(:sample_role_2)
+      end
+    end
+    assert_equal(true, @roleable_sample.has_role?(:sample_role_1))
+  end
+
+  def test_should_return_true_when_trying_to_remove_un_had_role
+    assert !@roleable_sample.has_role?(:sample_role_1), 'Precondition: does not have role'
+    assert @roleable_sample.remove_role(:sample_role_1)
+  end
+
+  def test_should_return_true_when_asking_if_is_existing_role
+    @roleable_sample.add_role(:sample_role_1)
+    assert_equal(true, @roleable_sample.sample_role_1?)
+  end
+
+  def test_should_return_false_when_asking_if_is_unexisting_role
+    @roleable_sample.add_role(:sample_role_1)
+    assert_equal(false, @roleable_sample.sample_role_2?)
+  end
+
+  def test_should_raise_exception_when_asking_if_is_invalid_role
+    @roleable_sample.add_role(:sample_role_1)
+    assert_raise(NoMethodError) {
+      @roleable_sample.invalid_role?
+    }
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,24 @@
+require 'test/unit'
+require File.join(File.dirname(__FILE__), 'assertions')
+require File.join(File.dirname(__FILE__), %w[.. init.rb])
+
+Test::Unit::TestCase.send :include, ActiveSupport::Testing::Assertions
+
+ActiveRecord::Base.establish_connection(
+  :adapter => 'sqlite3', :dbfile => ':memory:'
+)
+
+ActiveRecord::Schema.define(:version => 1) do
+  create_table :roleable_samples do |t|
+  end
+
+  create_table :roles do |t|
+    t.string :name
+  end
+
+  create_table :role_assignments do |t|
+    t.integer :roleable_id
+    t.string :roleable_type
+    t.integer :role_id
+  end
+end

data/uninstall.rb

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

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification 
+name: mintdigital-has_roles
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Krzysztof Zylawy
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-02-17 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: echoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Simple roles for ActiveRecord
+email: krzysztof@mintdigital.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- lib/has_roles.rb
+- lib/role.rb
+- lib/role_assignment.rb
+- README
+- tasks/has_roles_tasks.rake
+files: 
+- generators/has_roles/has_roles_generator.rb
+- generators/has_roles/templates/migration.rb
+- generators/has_roles/USAGE
+- has_roles.gemspec
+- install.rb
+- lib/has_roles.rb
+- lib/role.rb
+- lib/role_assignment.rb
+- Manifest
+- MIT-LICENSE
+- rails/init.rb
+- Rakefile
+- README
+- tasks/has_roles_tasks.rake
+- test/assertions.rb
+- test/has_roles_test.rb
+- test/test_helper.rb
+- uninstall.rb
+has_rdoc: false
+homepage: ""
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Has_roles
+- --main
+- README
+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: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: has_roles
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Simple roles for ActiveRecord
+test_files: 
+- test/has_roles_test.rb
+- test/test_helper.rb