canable 0.2.0 → 0.3.0

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,9 @@
+source 'http://rubygems.org'
+gemspec
+
+gem 'shoulda', '~> 2.10.2'
+gem 'mocha',   '~> 0.9.8'
+gem 'yard',    '>= 0'
+gem 'rake',    '0.8.7'
+gem 'activesupport'
+gem 'i18n'

data/README.rdoc

@@ -43,7 +43,7 @@ Lets say an article can be viewed and created by anyone, but only updated or des
 Lets look at some sample code now:
 
     john = User.create(:name => 'John')
-    steve = User.create(:name =. 'Steve')
+    steve = User.create(:name => 'Steve')
     
     ruby = Article.new(:title => 'Ruby')
     john.can_create?(ruby) # true
@@ -103,6 +103,28 @@ You can add your own actions like this:
 
 The first parameter is the can method (ie: can_publish?) and the second is the able method (ie: publishable_by?). 
 
+Ables can also be added as class methods. For example, to restrict access to an index action:
+
+    Canable.add(:index, :indexable)
+    
+Then enforce by passing the class instead of the instance:
+
+    class ArticlesController < ApplicationController
+      def index
+        @articles = Article.all
+        enforce_index_permission(Article)
+      end
+    end
+
+Then in the article model, add the able check as a class method:
+
+    class Article
+      ...
+      def self.indexable_by?(user)
+        !user.nil?
+      end
+    end
+
 == Review
 
 So, lets review: cans go on user model, ables go on everything, you override ables in each model where you want to enforce permissions, and enforcers go after each time you find or initialize an object in a controller. Bing, bang, boom.

data/Rakefile

@@ -1,27 +1,5 @@
-require 'rubygems'
-require 'rake'
-
-require File.dirname(__FILE__) + '/lib/canable'
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name        = "canable"
-    gem.summary     = %Q{Simple permissions that I have used on my last several projects so I figured it was time to abstract and wrap up into something more easily reusable.}
-    gem.description = %Q{Simple permissions that I have used on my last several projects so I figured it was time to abstract and wrap up into something more easily reusable.}
-    gem.email       = "nunemaker@gmail.com"
-    gem.homepage    = "http://github.com/jnunemaker/canable"
-    gem.authors     = ["John Nunemaker"]
-    gem.version     = Canable::Version
-    gem.add_development_dependency "shoulda", "~> 2.10.2"
-    gem.add_development_dependency "mocha", "~> 0.9.8"
-    gem.add_development_dependency "mongo_mapper"
-    gem.add_development_dependency "yard", ">= 0"
-  end
-  Jeweler::GemcutterTasks.new
-rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
-end
+require 'bundler'
+Bundler::GemHelper.install_tasks
 
 require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
@@ -31,14 +9,4 @@ Rake::TestTask.new(:test) do |test|
   test.verbose = true
 end
 
-task :test => :check_dependencies
 task :default => :test
-
-begin
-  require 'yard'
-  YARD::Rake::YardocTask.new
-rescue LoadError
-  task :yardoc do
-    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
-  end
-end

data/canable.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "canable/version"
+
+Gem::Specification.new do |s|
+  s.name        = "canable"
+  s.version     = Canable::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["John Nunemaker"]
+  s.email       = ["nunemaker@gmail.com"]
+  s.homepage    = "http://github.com/jnunemaker/canable"
+  s.summary     = %Q{Simple permissions that I have used on my last several projects so I figured it was time to abstract and wrap up into something more easily reusable.}
+  s.description = %Q{Simple permissions that I have used on my last several projects so I figured it was time to abstract and wrap up into something more easily reusable.}
+
+  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/lib/canable.rb

@@ -1,6 +1,4 @@
 module Canable
-  Version = '0.2.0'
-
   # Module that holds all the can_action? methods.
   module Cans; end
 
@@ -67,7 +65,7 @@ module Canable
     def self.add_enforcer_method(can)
       Enforcers.module_eval <<-EOM
         def can_#{can}?(resource)
-          current_user.can_#{can}?(resource)
+          current_user && current_user.can_#{can}?(resource)
         end
 
         def enforce_#{can}_permission(resource, message="")

data/lib/canable/version.rb

@@ -0,0 +1,3 @@
+module Canable
+  VERSION = '0.3.0'
+end

data/specs.watchr

@@ -1,27 +1,7 @@
-def growl(title, msg, img)
-  %x{growlnotify -m #{ msg.inspect} -t #{title.inspect} --image ~/.watchr/#{img}.png}
-end
-
-def form_growl_message(str)
-  results = str.split("\n").last
-  if results =~ /[1-9]\s(failure|error)s?/
-    growl "Test Results", "#{results}", "fail"
-  elsif results != ""
-    growl "Test Results", "#{results}", "pass"
-  end
-end
 
 def run(cmd)
   puts(cmd)
-  output = ""
-  IO.popen(cmd) do |com|
-    com.each_char do |c|
-      print c
-      output << c
-      $stdout.flush
-    end
-  end
-  form_growl_message output
+  system(cmd)
 end
 
 def run_test_file(file)
@@ -38,6 +18,7 @@ watch('lib/.*') { |m| system('clear'); run_all_tests }
 
 # Ctrl-\
 Signal.trap('QUIT') do
+  system('clear')
   puts " --- Running all tests ---\n\n"
   run_all_tests
 end

data/test/helper.rb

@@ -1,12 +1,7 @@
 require 'test/unit'
-
-gem 'mocha', '~> 0.9.8'
-gem 'shoulda', '~> 2.10.2'
-gem 'mongo_mapper'
-
 require 'mocha'
 require 'shoulda'
-require 'mongo_mapper'
+require 'active_support/all'
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
@@ -14,21 +9,8 @@ require 'canable'
 
 class Test::Unit::TestCase
   def Doc(name=nil, &block)
-    klass = Class.new do
-      include MongoMapper::Document
-      set_collection_name "test#{rand(20)}"
-
-      if name
-        class_eval "def self.name; '#{name}' end"
-        class_eval "def self.to_s; '#{name}' end"
-      end
-    end
-
+    klass = Struct.new(:name)
     klass.class_eval(&block) if block_given?
-    klass.collection.remove
     klass
   end
 end
-
-MongoMapper.connection = Mongo::Connection.new('127.0.0.1', 27017)
-MongoMapper.database = 'test'

data/test/test_cans.rb

@@ -7,7 +7,7 @@ class CansTest < Test::Unit::TestCase
         include Canable::Cans
       end
       
-      @user = klass.create(:name => 'John')
+      @user = klass.new(:name => 'John')
     end
 
     context "can_view?" do

data/test/test_enforcers.rb

@@ -9,7 +9,7 @@ class EnforcersTest < Test::Unit::TestCase
 
         # Overriding example
         def can_update?(resource)
-          return false if current_user.nil?
+          return false if current_user && current_user.banned?
           super
         end
 
@@ -42,9 +42,14 @@ class EnforcersTest < Test::Unit::TestCase
       @user.expects(:can_view?).with(@article).returns(false)
       assert_raises(Canable::Transgression) { @controller.show }
     end
-
-    should "be able to override can_xx? method" do
+    
+    should "raise error whenever current_user nil" do
       @controller.current_user = nil
+      assert_raises(Canable::Transgression) { @controller.show }
+    end
+    
+    should "be able to override can_xx? method" do
+      @user.expects(:banned?).returns(true)
       assert_raises(Canable::Transgression) { @controller.update }
     end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: canable
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 19
   prerelease: 
   segments: 
   - 0
-  - 2
+  - 3
   - 0
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors: 
 - John Nunemaker
@@ -15,83 +15,28 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-30 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: shoulda
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 35
-        segments: 
-        - 2
-        - 10
-        - 2
-        version: 2.10.2
-  type: :development
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: mocha
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 43
-        segments: 
-        - 0
-        - 9
-        - 8
-        version: 0.9.8
-  type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: mongo_mapper
-  prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  type: :development
-  version_requirements: *id003
-- !ruby/object:Gem::Dependency 
-  name: yard
-  prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  type: :development
-  version_requirements: *id004
+date: 2011-09-07 00:00:00 Z
+dependencies: []
+
 description: Simple permissions that I have used on my last several projects so I figured it was time to abstract and wrap up into something more easily reusable.
-email: nunemaker@gmail.com
+email: 
+- nunemaker@gmail.com
 executables: []
 
 extensions: []
 
-extra_rdoc_files: 
-- LICENSE
-- README.rdoc
+extra_rdoc_files: []
+
 files: 
 - .document
+- .gitignore
+- Gemfile
 - LICENSE
 - README.rdoc
 - Rakefile
+- canable.gemspec
 - lib/canable.rb
+- lib/canable/version.rb
 - specs.watchr
 - test/helper.rb
 - test/test_ables.rb
@@ -127,7 +72,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.7.2
+rubygems_version: 1.8.9
 signing_key: 
 specification_version: 3
 summary: Simple permissions that I have used on my last several projects so I figured it was time to abstract and wrap up into something more easily reusable.