can_opener 0.0.1

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/*
+*.gem
+.bundle

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in can_opener.gemspec
+gemspec

data/README.markdown

@@ -0,0 +1,68 @@
+can-opener
+==========
+
+Split up your CanCan Ability by allowing you to easily create abilities in separate classes which you reference in your main ability model.  This is mainly useful if you want to break down your abilities into smaller classes for organizational purposes.
+
+Usage
+-----
+
+    gem install can_opener
+
+Declare ability classes than inherit from CanOpener::Ability, and implement the `abilities` public instance method.  By default, the method will have access to the the local `user` as per typical use in CanCan.
+
+    require 'can_opener'
+    
+    class AdminAbility < CanOpener::Ability
+      def abilities
+        if user.admin?
+          can :manage, :all
+        end
+      end
+    end
+
+    class SupportAbility < CanOpener::Ability
+      def abilities
+        if user.support?
+          can :read, :all
+          can :write, :all
+        end
+      end
+    end
+
+    class BannedAbility < CanOpener::Ability
+      def abilities
+        if user.banned?
+          cannot do |action, object_class, object|
+            true
+          end
+        end
+      end
+    end
+    
+Then declare your Ability class, but include `CanOpener` rather than `CanCan::Abilities`
+
+    class Ability
+      include CanOpener
+
+      configure_abilities do |c|
+        c.add ReaderAbility
+        c.add SupportAbility
+        c.add AdminAbility, BannedAbility
+      end
+    end
+    
+Remember that CanCan processes abilities in a top down fashion, so add your general abilities up top, and then things you want to override everything (like banning a user) at the bottom.  You can add line by line or multiple on one line if you wish.
+
+### But I want to check the IP Address, Project, etc, in the ability
+
+Just override your Ability#initialize and setup your accessors to be used in the `CanOpener::Ability` subclasses.
+  
+Why?
+----
+
+A couple times when I used CanCan, my abilities definition method got a little long, and I wanted a simple way to break it up for readability.
+
+Todo
+----
+
+* Perhaps a generator for CanOpener::Ability subclasses.

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+desc "Run the specs"
+task :spec do
+  exec "spec spec/can_opener_spec.rb"
+end

data/can_opener.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "can_opener/version"
+
+Gem::Specification.new do |s|
+  s.name        = "can_opener"
+  s.version     = CanOpener::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Brendon Murphy"]
+  s.email       = ["xternal1+github@gmail.com"]
+  s.homepage    = "http://github.com/bemurphy/can-opener"
+  s.summary     = %q{Split up your CanCan Ability}
+  s.description = %q{Split up your CanCan Ability by allowing you to easily create abilities in separate classes which you reference in your main ability model.  This is mainly useful if you want to break down your abilities into smaller classes for organizational purposes.'}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {spec}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/can_opener.rb

@@ -0,0 +1,35 @@
+require "forwardable"
+require "cancan"
+require "can_opener/ability"
+
+module CanOpener
+  include CanCan::Ability
+
+  def self.included(base)
+    base.extend ClassMethods
+    class << base;
+      attr_accessor :ability_classes
+      protected :ability_classes=
+    end
+  end
+
+  module ClassMethods    
+    def configure_abilities(&block)
+      yield self
+    end
+    
+    protected
+
+    def add(*klasses)
+      self.ability_classes ||= []
+      self.ability_classes.concat Array(klasses)
+      self.ability_classes.uniq!
+    end
+  end
+
+  def initialize(user)
+    self.class.ability_classes.each do |ability_class|
+      ability_class.new(self, user)
+    end
+  end
+end

data/lib/can_opener/ability.rb

@@ -0,0 +1,16 @@
+module CanOpener
+  class Ability
+    extend Forwardable
+  
+    def_delegators :@base, *CanCan::Ability.public_instance_methods
+
+    attr_accessor :user
+    protected :user=
+  
+    def initialize(base, user)
+      @base = base
+      self.user = user
+      abilities
+    end
+  end
+end

data/lib/can_opener/version.rb

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

data/spec/can_opener_spec.rb

@@ -0,0 +1,141 @@
+require 'spec_helper'
+require "cancan/matchers"
+
+class AdminAbility < CanOpener::Ability
+  def abilities
+    if user.admin?
+      can :manage, :all
+    end
+  end
+end
+
+class SupportAbility < CanOpener::Ability
+  def abilities
+    if user.support?
+      can :read, :all
+      can :write, :all
+    end
+  end
+end
+
+class ReaderAbility < CanOpener::Ability
+  def abilities
+    can :read, :all
+    alias_action :read, :to => :speed_read
+  end
+end
+
+class BannedAbility < CanOpener::Ability
+  def abilities
+    if user.banned?
+      cannot do |action, object_class, object|
+        true
+      end
+    end
+  end
+end
+
+class Ability
+  include CanOpener
+  
+  configure_abilities do |c|
+    c.add ReaderAbility
+    c.add SupportAbility
+    c.add AdminAbility
+    c.add BannedAbility
+  end
+end
+
+describe CanOpener do
+  def user_double(opts = {})
+    double(:user, 
+      { :admin? => false, :support? => false, :banned? => false }.merge(opts) 
+    )
+  end
+  
+  let(:admin_user) { user_double(:admin? => true) }  
+  let(:support_user) { user_double(:support? => true) }
+  let(:reader_user) { user_double }
+  let(:banned_user) { user_double(:admin? => true, :banned? => true) }
+
+  describe "loading abilities" do
+    before(:each) { @ability = Ability.new(admin_user) }
+    
+    it "should have the abilities loaded in the expected order" do
+      Ability.ability_classes.should == [ReaderAbility, SupportAbility, AdminAbility, BannedAbility]
+    end
+  end
+  
+  describe "checking abilities" do
+    context "for the admin user" do
+      before(:each) { @ability = Ability.new(admin_user) }
+
+      it "should allow management" do
+        @ability.should be_able_to(:manage, :foo)
+      end
+      
+      it "should allow reading" do
+        @ability.should be_able_to(:read, :foo)
+      end
+      
+      it "should allow writing" do
+        @ability.should be_able_to(:write, :foo)
+      end
+    end
+    
+    context "for the support user" do
+      before(:each) { @ability = Ability.new(support_user) }
+      
+      it "should not allow management" do
+        @ability.should_not be_able_to(:manage, :foo)
+      end
+      
+      it "should allow reading" do
+        @ability.should be_able_to(:read, :foo)
+      end
+      
+      it "should not allow writing" do
+        @ability.should be_able_to(:write, :foo)
+      end
+    end
+    
+    context "for the reader user" do
+      before(:each) { @ability = Ability.new(reader_user) }
+      
+      it "should not allow management" do
+        @ability.should_not be_able_to(:manage, :foo)
+      end
+      
+      it "should allow reading" do
+        @ability.should be_able_to(:read, :foo)
+      end
+      
+      it "should not allow writing" do
+        @ability.should_not be_able_to(:write, :foo)
+      end
+    end
+    
+    context "for the banned user" do
+      before(:each) { @ability = Ability.new(banned_user) }
+      
+      it "should not allow management" do
+        @ability.should_not be_able_to(:manage, :foo)
+      end
+      
+      it "should not allow reading" do
+        @ability.should_not be_able_to(:read, :foo)
+      end
+      
+      it "should not allow writing" do
+        @ability.should_not be_able_to(:write, :foo)
+      end
+    end
+  end
+  
+  describe "aliasing actions" do
+    it "should still work" do
+      ability = Ability.new(reader_user)
+      ability.should be_able_to(:read, :foo)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'spec'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
+require 'can_opener'

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: can_opener
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Brendon Murphy
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-20 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: Split up your CanCan Ability by allowing you to easily create abilities in separate classes which you reference in your main ability model.  This is mainly useful if you want to break down your abilities into smaller classes for organizational purposes.'
+email: 
+- xternal1+github@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.markdown
+- Rakefile
+- can_opener.gemspec
+- lib/can_opener.rb
+- lib/can_opener/ability.rb
+- lib/can_opener/version.rb
+- spec/can_opener_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/bemurphy/can-opener
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Split up your CanCan Ability
+test_files: []
+