mongoid_ability 0.0.1

data/test/mongoid_ability/lock_test.rb

@@ -0,0 +1,57 @@
+require 'test_helper'
+
+module MongoidAbility
+  describe Lock do
+
+    subject { TestLock.new }
+    
+    # =====================================================================
+
+    describe 'fields' do
+      it 'has :action' do
+        subject.must_respond_to :action
+        subject.action.must_be_kind_of Symbol
+      end
+
+      it 'has :outcome' do
+        subject.must_respond_to :outcome
+        subject.outcome.must_equal false
+      end
+    end
+
+    # =====================================================================
+      
+    describe 'associations' do
+      it 'embedded in :owner' do
+        subject.must_respond_to :owner
+        subject.relations['owner'].macro.must_equal :embedded_in
+      end
+
+      it 'belongs to :subject' do
+        subject.must_respond_to :subject
+        subject.must_respond_to :subject_type
+        subject.must_respond_to :subject_id
+      end
+    end
+    
+    # =====================================================================
+
+    describe 'instance methods' do
+      it 'has #open?' do
+        subject.must_respond_to :open?
+        subject.open?.must_equal false
+      end
+      it 'has #closed?' do
+        subject.must_respond_to :closed?
+        subject.closed?.must_equal true
+      end
+      it 'has #class_lock?' do
+        subject.must_respond_to :class_lock?
+      end
+      it 'has #id_lock?' do
+        subject.must_respond_to :id_lock?
+      end
+    end
+
+  end
+end

data/test/mongoid_ability/owner_test.rb

@@ -0,0 +1,53 @@
+require 'test_helper'
+
+module MongoidAbility
+  describe Owner do
+
+    subject { TestOwner.new }
+
+    # =====================================================================
+
+    describe 'fields' do
+    end
+
+    # =====================================================================
+
+    describe 'associations' do
+    end
+
+    # =====================================================================
+
+    describe 'class methods' do
+      describe 'lock_class_name' do
+        it 'finds class that includes the MongoidAbility::Lock module' do
+          TestOwner.lock_class_name.must_equal 'TestLock'
+        end
+      end
+
+      describe 'locks_relation_name' do
+        it 'finds the name of relation that contains locks' do
+          TestOwner.locks_relation_name.must_equal :test_locks
+        end
+      end
+    end
+
+    # =====================================================================
+
+    describe 'instance methods' do
+      describe 'cleanup_locks' do
+        let(:closed_lock) { TestLock.new(action: :read, outcome: false, subject_type: Object.to_s) }
+        let(:open_lock) { TestLock.new(action: :read, outcome: true, subject_type: Object.to_s) }
+
+        before do
+          subject.test_locks = [open_lock, closed_lock].shuffle
+          subject.run_callbacks(:save)
+        end
+
+        it 'prefers closed locks' do
+          subject.test_locks.sort.must_equal [closed_lock].sort
+        end
+      end
+    end
+
+  end
+end

data/test/mongoid_ability/subject_test.rb

@@ -0,0 +1,102 @@
+require 'test_helper'
+
+module MongoidAbility
+  describe Subject do
+
+    subject { TestSubject.new }
+    let(:subject_super) { TestSubjectSuper.new }
+
+    let(:user) { TestUser.new }
+    let(:ability) { Ability.new(user) }
+
+    let(:open_lock) { TestLock.new(outcome: true, action: :read, subject: subject) }
+    let(:closed_lock) { TestLock.new(outcome: false, action: :read, subject: subject) }
+
+    # =====================================================================
+
+    describe 'fields' do
+    end
+
+    # =====================================================================
+
+    describe 'relations' do
+    end
+
+    # =====================================================================
+
+    describe 'class methods' do
+      it 'has .default_locks' do
+        subject.class.must_respond_to :default_locks
+        subject.class.default_locks.must_be_kind_of Array
+      end
+
+      it 'has .default_lock' do
+        subject.class.must_respond_to :default_lock
+      end
+
+      describe '.default_lock' do
+        it 'sets up new Lock' do
+          lock = subject.class.default_locks.first
+          subject.class.default_locks.length.must_equal 1
+          lock.subject_type.must_equal subject.class.model_name
+          lock.subject_id.must_be_nil
+          lock.action.must_equal :read
+        end
+      end
+
+      # ---------------------------------------------------------------------
+        
+      describe '.ancestors_with_default_locks' do
+        it 'lists ancestors with default locks' do
+          subject.class.ancestors_with_default_locks.must_equal [TestSubjectSuper]
+        end
+      end
+
+      describe '.self_and_ancestors_with_default_locks' do
+        it 'lists self and ancestors with default locks' do
+          subject.class.self_and_ancestors_with_default_locks.must_equal [TestSubject, TestSubjectSuper]
+        end
+      end
+
+      # ---------------------------------------------------------------------
+        
+      describe '.accessible_by' do
+        it 'returns Mongoid::Criteria' do
+          subject.class.accessible_by(ability).must_be_kind_of Mongoid::Criteria
+        end
+
+        describe 'when closed lock on user' do
+          before { user.test_locks = [closed_lock] }
+          it 'returns criteria excluding such ids' do
+            subject.class.accessible_by(ability).selector.fetch('_id', {}).fetch('$nin', []).must_include subject.id
+          end
+        end
+
+        describe "when closed lock on user's role" do
+          before { user.roles = [TestRole.new(test_locks: [closed_lock])] }
+          it 'returns criteria excluding such ids' do
+            subject.class.accessible_by(ability).selector.fetch('_id', {}).fetch('$nin', []).must_include subject.id
+          end
+        end
+
+        describe "when class does not permit" do
+          before do
+            user.test_locks = [open_lock]
+          end
+          it 'returns criteria excluding everything but open id_locks' do
+            subject.class.stub(:default_locks, [TestLock.new(outcome: false, action: :read, subject_type: subject.class, outcome: false)]) do
+              subject.class.accessible_by(ability).selector.fetch('_id', {}).fetch('$in', []).must_include subject.id
+            end
+          end
+        end
+        
+      end
+    end
+  end
+
+  # =====================================================================
+
+  describe 'instance methods' do
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,122 @@
+require 'bundler/setup'
+require 'database_cleaner'
+require 'minitest'
+require 'minitest/autorun'
+require 'minitest/spec'
+require 'mongoid'
+
+require 'mongoid_ability'
+
+# =====================================================================
+  
+if ENV["CI"]
+  require "coveralls"
+  Coveralls.wear!
+end
+
+ENV["MONGOID_TEST_HOST"] ||= "localhost"
+ENV["MONGOID_TEST_PORT"] ||= "27017"
+
+HOST = ENV["MONGOID_TEST_HOST"]
+PORT = ENV["MONGOID_TEST_PORT"].to_i
+
+def database_id
+  "mongoid_ability_test"
+end
+
+CONFIG = {
+  sessions: {
+    default: {
+      database: database_id,
+      hosts: [ "#{HOST}:#{PORT}" ]
+    }
+  }
+}
+
+Mongoid.configure do |config|
+  config.load_configuration(CONFIG)
+end
+
+DatabaseCleaner.orm = :mongoid
+DatabaseCleaner.strategy = :truncation
+
+class MiniTest::Spec
+  before(:each) { DatabaseCleaner.start }
+  after(:each) { DatabaseCleaner.clean }
+end
+
+# =====================================================================
+
+class TestLock
+  include Mongoid::Document
+  include MongoidAbility::Lock
+
+  embedded_in :owner, polymorphic: true
+end
+
+class TestLockSub < TestLock
+end
+
+# ---------------------------------------------------------------------
+  
+class TestOwnerSuper
+  include Mongoid::Document
+  include MongoidAbility::Owner
+
+  embeds_many :test_locks, class_name: 'TestLock', as: :owner
+end
+
+class TestOwner < TestOwnerSuper
+end
+
+# ---------------------------------------------------------------------
+  
+class TestSubjectSuper
+  include Mongoid::Document
+  include MongoidAbility::Subject
+end
+
+class TestSubject < TestSubjectSuper
+  default_lock :read, true
+end
+
+# ---------------------------------------------------------------------
+  
+class TestAbilityResolverSubject
+  include Mongoid::Document
+  include MongoidAbility::Subject
+
+  default_lock :read, true
+end
+
+class TestAbilitySubjectSuper2
+  include Mongoid::Document
+  include MongoidAbility::Subject
+
+  default_lock :read, false
+  default_lock :update, true
+end
+
+class TestAbilitySubjectSuper1 < TestAbilitySubjectSuper2
+end
+
+class TestAbilitySubject < TestAbilitySubjectSuper1
+end
+
+class TestRole
+  include Mongoid::Document
+  include MongoidAbility::Owner
+
+  field :name, type: String
+
+  embeds_many :test_locks, class_name: 'TestLock', as: :owner
+  has_and_belongs_to_many :users, class_name: 'TestUser'
+end  
+
+class TestUser
+  include Mongoid::Document
+  include MongoidAbility::Owner
+
+  embeds_many :test_locks, class_name: 'TestLock', as: :owner
+  has_and_belongs_to_many :roles, class_name: 'TestRole'
+end

metadata

@@ -0,0 +1,200 @@
+--- !ruby/object:Gem::Specification
+name: mongoid_ability
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Tomas Celizna
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cancancan
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Custom Ability class that allows CanCanCan authorization library store
+  permissions in MongoDB via the Mongoid gem.
+email:
+- tomas.celizna@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/mongoid_ability.rb
+- lib/mongoid_ability/ability.rb
+- lib/mongoid_ability/ability_resolver.rb
+- lib/mongoid_ability/lock.rb
+- lib/mongoid_ability/owner.rb
+- lib/mongoid_ability/subject.rb
+- lib/mongoid_ability/version.rb
+- mongoid_ability.gemspec
+- test/mongoid_ability/ability_resolver_test.rb
+- test/mongoid_ability/ability_test.rb
+- test/mongoid_ability/lock_test.rb
+- test/mongoid_ability/owner_test.rb
+- test/mongoid_ability/subject_test.rb
+- test/test_helper.rb
+homepage: https://github.com/tomasc/mongoid_ability
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Custom Ability class that allows CanCanCan authorization library store permissions
+  in MongoDB via the Mongoid gem.
+test_files:
+- test/mongoid_ability/ability_resolver_test.rb
+- test/mongoid_ability/ability_test.rb
+- test/mongoid_ability/lock_test.rb
+- test/mongoid_ability/owner_test.rb
+- test/mongoid_ability/subject_test.rb
+- test/test_helper.rb