role_model 0.1.1

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Martin Rehfeld
+
+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,79 @@
+= RoleModel
+
+Ever needed to assign roles to a model, say a User, and build conditional
+behaviour on top of that?
+
+Enter RoleModel -- roles have never been easier! No need to build a separate
+Role model, managing seed data and the like. Just declare your roles and you
+are done.
+
+Assigned roles will be stored as a bitmask in an configurable attribute
+(default: <tt>roles_mask</tt>). Here's everything you need to know:
+
+  # given an User class with a roles_mask attribute
+  class User
+    attr_accessor :roles_mask # in real life this would be an persisted attribute / DB-column
+    
+    include RoleModel
+    # optionally set the integer attribute to store the roles in,
+    # :roles_mask is the default
+    roles_attribute :roles_mask
+    
+    # declare the valid roles -- do not change the order if you add more
+    # roles later, always append them at the end!
+    roles :admin, :manager, :author
+  end
+  
+  >> u = User.new
+  => #<User ...>
+
+  >> u.roles = [:admin] # ['admin'] works as well
+  => [:admin]
+
+  >> u.roles # aliased to role_symbols for DeclarativeAuthorization
+  => [:admin]
+  
+  >> u.has_role? :manager
+  => false
+  
+  >> u.has_role? :admin
+  => true
+  
+  >> u.roles_mask
+  => 1
+
+Once you have included RoleModel, your model is perfectly fit to be used
+together with an role-based authorization solution, such as
+http://github.com/ryanb/cancan or
+http://github.com/stffn/declarative_authorization .
+
+== Reasoning
+
+Whenever I introduce a role-based authorization scheme into a project, the
+code gets coupled somehow to the available roles. So it usually does not make
+any sense to have a separate Role model stored within the database. This Role
+model will contain a predefined set of roles anyhow -- changing that set will
+need to be reflected within the authorization code. Putting the available
+roles right into the model that actually uses them, makes things much easier
+and efficient.
+
+== Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with Rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a
+  commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Credits
+
+RoleModel is an implementation of the Role Based Authorization scheme
+proposed by Ryan Bates
+(http://wiki.github.com/ryanb/cancan/role-based-authorization).
+
+== Copyright
+
+Copyright (c) 2010 Martin Rehfeld. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "role_model"
+    gem.summary = %Q{Declare, assign and query roles with ease}
+    gem.description = %Q{Ever needed to assign roles to a model, say a User, and build conditional behaviour on top of that? Enter RoleModel -- roles have never been easier! Just declare your roles and you are done. Assigned roles will be stored as a bitmask.}
+    gem.email = "martin.rehfeld@glnetworks.de"
+    gem.homepage = "http://github.com/martinrehfeld/role_model"
+    gem.authors = ["Martin Rehfeld"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # 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: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "role_model #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.1

data/lib/role_model.rb

@@ -0,0 +1,33 @@
+module RoleModel
+  def self.included(base) # :nodoc:
+
+    # add class methods
+    base.instance_eval do
+      def roles_attribute(name)
+        @@roles_attribute = name.to_sym
+      end
+      roles_attribute :roles_mask
+
+      def roles(*roles)
+        @@valid_roles = Array[*roles].flatten.map { |r| r.to_sym }
+      end
+    end
+
+    # add instance methods
+    base.class_eval do
+      def roles=(*roles)
+        self.send("#{@@roles_attribute}=", (Array[*roles].flatten.map { |r| r.to_sym } & @@valid_roles).map { |r| 2**@@valid_roles.index(r) }.inject { |sum, bitvalue| sum + bitvalue })
+      end
+
+      def roles
+        @@valid_roles.reject { |r| ((self.send(@@roles_attribute) || 0) & 2**@@valid_roles.index(r)).zero? }
+      end
+      alias_method :role_symbols, :roles
+
+      def has_role?(role)
+        roles.include?(role.to_sym)
+      end
+    end
+
+  end
+end

data/role_model.gemspec

@@ -0,0 +1,55 @@
+# 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{role_model}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Martin Rehfeld"]
+  s.date = %q{2010-05-25}
+  s.description = %q{Ever needed to assign roles to a model, say a User, and build conditional behaviour on top of that? Enter RoleModel -- roles have never been easier! Just declare your roles and you are done. Assigned roles will be stored as a bitmask.}
+  s.email = %q{martin.rehfeld@glnetworks.de}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/role_model.rb",
+     "role_model.gemspec",
+     "spec/role_model_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/martinrehfeld/role_model}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{Declare, assign and query roles with ease}
+  s.test_files = [
+    "spec/role_model_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>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

data/spec/role_model_spec.rb

@@ -0,0 +1,151 @@
+require 'spec_helper'
+
+describe RoleModel do
+
+  let(:model_class) { Class.new }
+
+  before(:each) do
+    model_class.instance_eval do
+      attr_accessor :roles_mask
+      attr_accessor :custom_roles_mask
+      include RoleModel
+      roles :foo, :bar
+    end
+  end
+
+  describe ".roles_attribute" do
+    before(:each) do
+      model_class.instance_eval do
+        roles_attribute :custom_roles_mask
+        roles :sample
+      end
+    end
+    subject { model_class.new }
+
+    it "should change the bitmask attribute used to store the assigned roles" do
+      subject.roles = [:sample]
+      subject.roles_mask.should be_nil
+      subject.custom_roles_mask.should == 1
+    end
+  end
+
+  describe ".roles" do
+    subject { model_class.new }
+
+    it "should define the valid roles" do
+      subject.roles = %w(foo bar baz)
+      subject.roles.should include(:foo)
+      subject.roles.should include(:bar)
+      subject.roles.should_not include(:baz)
+    end
+
+    it "should define the bitvalue of each role by position" do
+      subject.roles = :foo
+      subject.roles_mask.should == 1
+      subject.roles = :bar
+      subject.roles_mask.should == 2
+    end
+  end
+
+  describe "#roles" do
+    subject { model_class.new }
+
+    it "should return the assigned roles as symbols" do
+      subject.roles = [:foo, :bar]
+      subject.roles.should include(:foo)
+      subject.roles.should include(:bar)
+      subject.roles.should have(2).elements
+    end
+
+    it "should return an empty array when no roles have been assigned" do
+      subject.roles.should be_empty
+    end
+  end
+
+  describe "#role_symbols" do
+    subject { model_class.new }
+
+    it "should be an alias to roles" do
+      subject.method(:role_symbols).should == subject.method(:roles)
+    end
+  end
+
+  describe "#roles=" do
+    subject { model_class.new }
+
+    it "should accept an array of symbols" do
+      subject.roles = [:foo, :bar]
+      subject.roles.should include(:foo)
+      subject.roles.should include(:bar)
+      subject.roles.should have(2).elements
+      subject.roles = [:bar]
+      subject.roles.should include(:bar)
+      subject.roles.should have(1).element
+    end
+
+    it "should accept an array of strings" do
+      subject.roles = %w(foo bar)
+      subject.roles.should include(:foo)
+      subject.roles.should include(:bar)
+      subject.roles.should have(2).elements
+      subject.roles = ['bar']
+      subject.roles.should include(:bar)
+      subject.roles.should have(1).element
+    end
+
+    it "should accept a single symbol" do
+      subject.roles = :foo
+      subject.roles.should include(:foo)
+      subject.roles.should have(1).element
+    end
+
+    it "should accept a single string" do
+      subject.roles = 'foo'
+      subject.roles.should include(:foo)
+      subject.roles.should have(1).element
+    end
+
+    it "should accept multiple arguments as symbols" do
+      subject.send(:roles=, :foo, :bar)
+      subject.roles.should include(:foo)
+      subject.roles.should include(:bar)
+      subject.roles.should have(2).elements
+    end
+
+    it "should accept multiple arguments as strings" do
+      subject.send(:roles=, 'foo', 'bar')
+      subject.roles.should include(:foo)
+      subject.roles.should include(:bar)
+      subject.roles.should have(2).elements
+    end
+
+    it "should silently ignore undefined roles" do
+      subject.roles = :baz
+      subject.roles.should be_empty
+    end
+  end
+
+  describe "#has_role?" do
+    subject { model_class.new }
+
+    it "should return true when the given role was assigned" do
+      subject.roles = :foo
+      subject.should have_role(:foo)
+    end
+
+    it "should return false when the given role was not assigned" do
+      subject.roles = :bar
+      subject.should_not have_role(:foo)
+    end
+
+    it "should return false when no role was assigned" do
+      subject.should_not have_role(:foo)
+      subject.should_not have_role(:bar)
+    end
+
+    it "should return false when asked for an undefined role" do
+      subject.should_not have_role(:baz)
+    end
+  end
+
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'role_model'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification 
+name: role_model
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- Martin Rehfeld
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-25 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+description: Ever needed to assign roles to a model, say a User, and build conditional behaviour on top of that? Enter RoleModel -- roles have never been easier! Just declare your roles and you are done. Assigned roles will be stored as a bitmask.
+email: martin.rehfeld@glnetworks.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/role_model.rb
+- role_model.gemspec
+- spec/role_model_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/martinrehfeld/role_model
+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: Declare, assign and query roles with ease
+test_files: 
+- spec/role_model_spec.rb
+- spec/spec_helper.rb