cantango 0.8.0

data/spec/TODO

@@ -0,0 +1,7 @@
+The main things left I think.
+
+To provide configuration options (global engines) and options on configuration macros tango_user and tango_user_account.
+
+Don't know for now what are the options should be except turning off permission and permit engines!
+
+Fx present CanTango.permission_engine = false -- it is only a stub - don't know if it is enough for real configuration needs.

data/spec/active_record/AR_README.textile

@@ -0,0 +1,20 @@
+h1. Active Record specs for CanTango
+
+Please see config_helper.rb for how to use Shared examples in scenarios!
+
+This is key, using let instead of @x instance vars !!!
+
+<pre>
+  def define_users
+    let(:no_roles_user) { create_no_roles_user  }
+    let(:user)          { create_user  }
+    let(:admin_user)    { create_admin_user  }
+  end  
+
+  shared_examples_for "Troles API" do
+    include UserSetup 
+
+    it_behaves_like "Troles Core API" do
+      define_users
+    end    
+</pre>

data/spec/active_record/config_helper.rb

@@ -0,0 +1,108 @@
+# These modules can be included into a describe block (see troles)
+
+# shared_examples_for "Common API for multiple roles" do
+#   include UserSetup 
+#     
+#   it_behaves_like "Common Write API for multiple roles" do
+#     define_users
+#   end  
+# end
+# 
+# shared_examples_for "Common Core API" do
+#   # Core API
+#   specify             { lambda { user.role_field }.should raise_error } # no, role_field is a class method    
+#   specify             { User.role_field.should_not be_nil } # yes, role_field is a class method    
+# 
+#   subject { user }
+#     its(:role_list)     { should include(:user) }
+#     its(:roles)         { should be_a Troles::Operations }
+# 
+#   specify             { user.static_roles?.should be_false }
+#   specify             { User.static_roles?.should be_false }  
+#   
+#   # TODO: Add examples with other users?
+# end
+
+# def define_users
+#   let(:no_roles_user) { create_no_roles_user  }
+#   let(:user)          { create_user  }
+#   let(:admin_user)    { create_admin_user  }
+# end  
+# 
+# shared_examples_for "Troles API" do
+#   include UserSetup 
+#      
+#   it_behaves_like "Troles Core API" do
+#     define_users
+#   end  
+
+
+module Config
+  def self.create_role name
+    Role.create(:name => name.to_s)
+  end
+
+  def self.create_rolegroup name, options = {}
+    RoleGroup.create(:name => name.to_s, :roles => options[:roles])
+  end
+
+  def self.add_rolegroups hash
+    hash.each_pair {|name, roles| create_rolegroup(name, :roles => roles) }
+  end
+
+
+  def self.add_roles *names
+    names.flatten.each {|n| create_role(n) }
+  end
+end
+
+
+
+module Config
+  module Basic
+    def basic_config context
+      send :"#{context}_config"
+    end
+
+    def guest_config
+      @guest    = User.new(1, :guest)
+      @ability  = Permits::Ability.new @guest 
+      @comment  = Comment.new(1)
+      @post     = Post.new(1)
+    end
+
+    def admin_config
+      @admin = User.new(1, :admin, 'kristian')
+      @ability = Permits::Ability.new(@admin)
+    end
+
+    def admin_account_config
+      @user = User.new(1, :admin, 'kristian')
+      @admin = AdminAccount.new(@user.id, :admin)
+      @ability = Permits::Ability.new(@admin)
+    end
+  end
+
+  module Ownership
+    def two_users_config 
+      @editor         = User.create(:name => "Kristian", :role => "editor")
+      @other_guy      = User.create(:name => "Random dude", :role => "admin")
+      @ability        = Permits::Ability.new(@editor)
+
+      @own_post       = Post.create(:writer => @editor.id)
+      @other_post     = Post.create(:writer => @other_guy.id)      
+    end
+
+    def editor_config
+      @editor         = User.create(:name => "Kristian", :role => "editor")
+      @other_guy      = User.create(:name => "Random dude", :role => "admin")
+
+      @ability        = Permits::Ability.new(@editor)
+
+      @own_comment    = Comment.create(:user_id => @editor.id)
+      @other_comment  = Comment.create(:user_id => @other_guy.id)      
+      # @post     = Post.create(:writer => @editor.id)
+      # @article  = Article.create(:author => @editor.id)
+    end  
+  end
+end

data/spec/active_record/db/database.yml

@@ -0,0 +1,4 @@
+adapter: sqlite3
+database: development.sqlite3
+pool: 5
+timeout: 5000

data/spec/active_record/helper/ar_config.rb

@@ -0,0 +1,19 @@
+path = File.dirname(__FILE__) + '/../db/database.yml'
+dbfile = File.open(path)
+dbconfig = YAML::load(dbfile)
+ActiveRecord::Base.establish_connection(dbconfig)
+ActiveRecord::Base.logger = Logger.new(STDERR)
+DatabaseCleaner.strategy = :truncation
+
+def migration_folder name
+  migrations_path = File.dirname(__FILE__)
+  name ? File.join("#{migrations_path}" "#{name}") : "#{migrations_path}/migrations" # adding /migrations here is safer
+end
+
+def migrate name = nil
+  mig_folder = migration_folder(name)
+
+  puts "Migrating folder:" << mig_folder
+
+  ActiveRecord::Migrator.migrate mig_folder
+end

data/spec/active_record/helper/permits_config.rb

@@ -0,0 +1,12 @@
+CanTango::Ability.orm = :active_record
+
+#require_all File.dirname(__FILE__) + '/../fixtures/permits'
+
+require 'simple_roles'
+
+#module CanTango::Permits::Roles
+#  def self.available
+#    User.roles
+#  end
+#end
+

data/spec/active_record/helper/rails_config.rb

@@ -0,0 +1,6 @@
+module Rails
+  def self.config_root_dir
+    File.dirname(__FILE__)
+  end
+end
+

data/spec/active_record/helper/rspec_config.rb

@@ -0,0 +1,20 @@
+RSpec.configure do |config|
+  config.mock_with :mocha
+
+  config.before(:suite) do
+    # Drop all tables including migrtions
+    DatabaseCleaner::ActiveRecord.config_file_location = 'db/database.yml'
+    DatabaseCleaner.strategy = :drop, {:include => ['migrations']}
+    DatabaseCleaner.clean
+
+    migrate("/../migrations")
+  end
+
+  config.before(:each) do
+    DatabaseCleaner.clean_with(:truncation)
+  end
+
+  config.after(:each) do
+  end
+end
+

data/spec/active_record/migrations/001_create_user.rb

@@ -0,0 +1,14 @@
+class CreateUser < ActiveRecord::Migration
+  def self.up
+    create_table :users do |t|
+      t.string  :name
+      t.string  :role      
+      t.string  :email
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :users
+  end
+end

data/spec/active_record/migrations/002_create_comment.rb

@@ -0,0 +1,13 @@
+class CreateComment < ActiveRecord::Migration
+  def self.up
+    create_table :comments do |t|
+      t.integer   :user_id
+      t.string    :body      
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :comments
+  end
+end

data/spec/active_record/migrations/003_create_post.rb

@@ -0,0 +1,13 @@
+class CreatePost < ActiveRecord::Migration
+  def self.up
+    create_table :posts do |t|
+      t.integer   :user_id
+      t.string    :body      
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :posts
+  end
+end

data/spec/active_record/migrations/004_create_article.rb

@@ -0,0 +1,13 @@
+class CreateArticle < ActiveRecord::Migration
+  def self.up
+    create_table :articles do |t|
+      t.integer   :user_id
+      t.string    :body      
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :articles
+  end
+end

data/spec/active_record/migrations/005_create_account.rb

@@ -0,0 +1,13 @@
+class CreateAccount < ActiveRecord::Migration
+  def self.up
+    create_table :accounts do |t|
+      t.integer :user_id
+      t.string :role
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :accounts
+  end
+end

data/spec/active_record/migrations/006_create_todo.rb

@@ -0,0 +1,12 @@
+class CreateTodo < ActiveRecord::Migration
+  def self.up
+    create_table :todos do |t|
+      t.string    :body      
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :todos
+  end
+end

data/spec/active_record/migrations/007_create_user_todos.rb

@@ -0,0 +1,13 @@
+class CreateUserTodos < ActiveRecord::Migration
+  def self.up
+    create_table :user_todos do |t|
+      t.integer :user_id
+      t.integer :todo_id
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :user_todos
+  end
+end

data/spec/active_record/scenarios/SCENARIOS README.textile

@@ -0,0 +1,19 @@
+h1. Scenarios
+
+This scenarios folder should contain the specs, shared examples and models for various common User scenarios.
+
+All scenarios should have a User and Guest (user), where the User is persisted and the Guest is not.
+
+Scenarios:
+
+* User and Guest only : 'guest_user'
+* User, Admin and Guest : 'guest_admin_user'
+* User, Guest and Admin with UserAccount, GuestAccount and AdminAccount : 'user_accounts'
+
+Note that the GuestAccount should also not be persisted.
+
+CanTango should be able to handle cases where the ability is either created with a user or a user account. In case there is no user account, the user_account variable should just point to the user.
+
+The User and Account model classes must each be exended to allow can? and cannot? with the CanTango::Ability
+
+

data/spec/active_record/scenarios/engines/permission_engine/cantango_permissions.yml

@@ -0,0 +1,63 @@
+roles:
+  admin:
+    can:
+      manage:
+      - all
+
+  musician: 
+    can: 
+      read:
+      - Song
+      - /Concerto/
+      create:
+      - Tune
+      write:
+      - /Song/
+      manage:
+      - /Improvisation/
+    cannot: 
+      write: 
+      - Concerto
+
+role_groups:
+  bloggers: 
+    can: 
+      read: 
+      - Article
+      - Comment
+    cannot: 
+      write: 
+      - ^another_articles
+  editors: 
+    can: 
+      read: 
+      - Article
+      - Comment
+    cannot: 
+      write: 
+      - Article
+      - Post
+
+licenses:
+  editors:
+    can:
+      manage:
+      - all
+
+users:
+  kris@gmail.com:
+    can:
+      read:
+        - /Comment/ 
+      write:
+        - Comment#author
+        - Article#author
+        - Post#body="Nice!"
+        - Todo#authors
+  stan@gmail.com:
+    can:
+      read:
+        - Comment
+      write:
+        - Article
+        - Comment

data/spec/active_record/scenarios/engines/permission_engine/categories.yml

@@ -0,0 +1,6 @@
+another_articles:
+  [Post, Article]
+articles: 
+  [Article, Post, Comment]
+user_models: 
+  [Admin, Guest, User]

data/spec/active_record/scenarios/engines/permission_engine/tango_permission_yml_spec.rb

@@ -0,0 +1,77 @@
+require 'active_record/spec_helper'
+require_all File.dirname(__FILE__) + "/../../shared/" 
+
+describe 'Cantango config: tango_permissions.yml' do
+
+  before(:each) {
+    CanTango.configure do |config|
+      config.permits.set :off
+      config.permissions.config_path = File.dirname(__FILE__)
+      config.permissions.set :on
+    end
+    @user ||= User.create!(:email => "kris@gmail.com", :role => 'musician')
+    @own_todo = Todo.create!
+    @own_todo.authors << @user
+    @own_todo.save!
+
+  }
+
+  after(:each) { 
+    CanTango.configure do |config|
+      config.permits.set :on
+      config.permissions.set :off
+    end
+  }
+
+  let(:current_user) { @user }
+  let(:ability) { current_ability(:user) }
+  let(:own_comment) { Comment.create(:user_id => @user.id) }
+  let(:specific_post) { Post.create(:body => "Nice!") }
+
+  context ":users group testing" do
+    it "should be allowed to read Comment" do
+      ability.should be_allowed_to(:read, Comment)
+    end
+  
+    it "should be allowed to write own Comment" do
+      ability.should be_allowed_to(:write, own_comment)
+    end
+    
+    it "should be not be allowed to write not-own Comment" do
+      ability.should_not be_allowed_to(:write, Comment.new)
+    end
+
+    it "should be allowed to write Post with :body => 'Nice!'" do
+      ability.should be_allowed_to(:write, specific_post)
+    end
+
+    it "should not be allowed to write Post except specific_post" do
+      ability.should_not be_allowed_to(:write, Post.new)
+    end
+
+  end
+
+  context "various musical rules to ensure that all rules are evaluated" do
+    it "should contain rules for musician role" do
+      ability.should be_allowed_to(:read, Song)
+      ability.should be_allowed_to(:read, Concerto)
+      ability.should be_allowed_to(:create, Tune)
+      ability.should be_allowed_to(:write, Song)
+      ability.should be_allowed_to(:manage, Improvisation)
+      ability.should_not be_allowed_to(:write, Concerto)
+    end
+  end
+
+    it "should allow :write of own Todos" do
+      @user.should be_allowed_to(:write, @own_todo)
+    end
+
+    it "should not allow :write of not-own Todos" do
+      @user.should_not be_allowed_to(:write, Todo.new)
+    end
+
+
+end
+
+CanTango.config.permissions.set :off
+CanTango.config.permits.set :on