permissionable 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2b3291aed21cc9e20392419b0ee512fa578fd335
-  data.tar.gz: ca2dfd9bad69191f9ad342b01c721f4dbf23b42f
+  metadata.gz: 3f3fae2297371971e0aad5ccd33ad1c829e13138
+  data.tar.gz: 08999968d5e6a368127b7bed81b07825eb47c138
 SHA512:
-  metadata.gz: c6fd05d537db592239652ed21919ca18f93c2ccfd918cfe6b789c012b5c521643d539b3c262b54bbdbedd7f1f4adc593018914cefd2221a5e2dfd48d9dbcac1d
-  data.tar.gz: e819ee8e617b32b194036c8f9fd4c1acd79ec5e93450e050ebce154f859048f5cb946ec898997ec1bcc0d04261022486200a729430603df35efe5ad33964b5a7
+  metadata.gz: 7ca28cb7275e551aa82f4ee0c0149ca278f5ccf94d746915d574b2f4143c217dce794da58fe4b825b3e827632a1fcac7e49a1343b2e91984dd9e0f0ea59f2708
+  data.tar.gz: 5c70cbd690a1237cc9ff520a72c0d6b936ebe0b3384ee9155797a46206e7c4066db44c90ef329eb1312ac31201cb1933bd9da829fc2288c688e595bec8cfc994

data/README.md

@@ -4,7 +4,7 @@
 ## Installation
 
 Permissionable is distributed as a gem. To install, just add this line to your Gemfile:  
-`gem 'permissionable', '~> 0.1.2'`
+`gem 'permissionable', '~> 0.1.3'`
 
 
 ## Usage
@@ -17,16 +17,16 @@ permissions read: 1,
             delete: 3
 ```
 
-Your model doesn't have to be an ActiveRecord (AR) model, but Permissionable works out of the box with AR to persist the permissions. Just throw in a `permissions` column in the mix.
+Your model doesn't have to be an ActiveRecord (AR) model, but Permissionable works out of the box with AR to persist the permissions. Just throw in a `permissions_integer` column in the mix.
 ```
 class AddPermissionsToResource < ActiveRecord::Migration
   def change
-    add_column :resources, :permissions, :integer
+    add_column :resources, :permissions_integer, :integer
   end
 end
 ```
 
-If your're not using AR can also implement your own `#read_attribute` and `#update_column` methods to handle `read_attribute(:permissions)` and `update_column(:permissions, permissions_integer)`
+If your're not using AR can also implement your own `#read_attribute` and `#update_column` methods to handle `read_attribute(:permissions_integer)` and `update_column(:permissions_integer, permissions_integer)`
 
 ### Working with permissions
 #### Check for permissions
@@ -55,6 +55,9 @@ You can also add an array of permissions yo your array of permissions:
 Removing permissions from your resource is pretty straight forward:  
 `user.permissions.remove(:delete_books)`
 
+Or, if you would like to remove all permissions:  
+`user.permissions.clear!`
+
 ### Examples
 ```
 class User < ActiveRecord::Base

data/lib/permissionable.rb

@@ -1,4 +1,5 @@
 require "permissionable/version"
+require "permissionable/exceptions"
 require "permissionable/permissions"
 
 module Permissionable
@@ -6,14 +7,21 @@ module Permissionable
   def permissions
     @permissions ||= Permissions.new(self)
   end
+  
+  def permissions=(*permissions)
+    permissions.flatten!
+    self.permissions.clear!
+    self.permissions << permissions
+    self.permissions.send(:sync_with_owner)
+  end
 
   # Class methods from here on
   module ClassMethods
+
     def permissions(permission_definitions)
       @permissions = {}
       permission_definitions.each do |permission,i|
-        raise 'Can not assign 0' if i == 0
-        raise "#{i} is not an integer" unless i.is_a?(Fixnum)
+        raise InvalidPermissionAssignment.new(i) if i == 0 || !i.is_a?(Fixnum)
         if i == 1
           @permissions[permission] = 1 
         else

data/lib/permissionable/exceptions.rb

@@ -0,0 +1,11 @@
+module Permissionable
+  class InvalidPermissionAssignment < StandardError
+    def initialize(object)
+      if object == 0
+        super "Can not assign a permission the value 0" 
+      elsif !object.is_a?(Fixnum)
+        super "Can not assign permissions to values of type #{object.class.name} (only Fixnum allowed)"
+      end
+    end
+  end
+end

data/lib/permissionable/permissions.rb

@@ -3,14 +3,14 @@ module Permissionable
     def initialize(owner)
       @owner = owner
       if @owner.respond_to?(:read_attribute)
-        @permission_integer = @owner.read_attribute(:permissions)
+        @permissions_integer = @owner.read_attribute(:permissions_integer)
       else
-        @permission_integer = 0
+        @permissions_integer = 0
       end
     end
 
     def to_i
-      @permission_integer
+      @permissions_integer
     end
 
     # Add new permissions
@@ -23,7 +23,7 @@ module Permissionable
       control_definitions(permissions)
       permissions.each do |permission|
         new_permission = defined_permissions[permission]
-        @permission_integer += new_permission unless include?(permission)
+        @permissions_integer += new_permission unless include?(permission)
       end
       sync_with_owner
     end
@@ -38,7 +38,7 @@ module Permissionable
       permissions.flatten!
       control_definitions(permissions)
       permissions.each do |permission|
-        @permission_integer -= defined_permissions[permission] if include?(permission)
+        @permissions_integer -= defined_permissions[permission] if include?(permission)
       end
       sync_with_owner
     end
@@ -55,10 +55,15 @@ module Permissionable
       # Sum the corresponding int value of all 
       # permissions provided in the argument list
       asserted = permissions.inject(0){ |mem, permission| mem + defined_permissions[permission] }
-      @permission_integer & asserted == asserted
+      @permissions_integer & asserted == asserted
     end
     alias_method :[], :include?
 
+    def clear!
+      @permissions_integer = 0
+      sync_with_owner
+    end
+
     private 
 
     def control_definitions(permissions)
@@ -68,8 +73,13 @@ module Permissionable
     end
 
     def sync_with_owner
+      if @owner.respond_to?(:permissions_integer=)
+        @owner.permissions_integer = @permissions_integer
+      end
       if @owner.respond_to?(:update_column)
-        @owner.update_column(:permissions, @permission_integer)
+        if @owner.respond_to?(:persisted?) && @owner.persisted?
+          @owner.update_column(:permissions_integer, @permissions_integer)
+        end
       end
     end
 

data/lib/permissionable/version.rb

@@ -1,3 +1,3 @@
 module Permissionable
-  VERSION = "0.1.3"
+  VERSION = "0.1.4"
 end

data/spec/dummy.rb

@@ -1,3 +1,4 @@
+require 'pry'
 class Dummy
   include Permissionable
 
@@ -7,4 +8,15 @@ class Dummy
               play: 4,
               eat: 5
 
+  def persisted?
+    true
+  end
+
+  def initialize(attributes={})
+    attributes.each do |attribute,value|
+      setter_method = "#{attribute}=".to_sym
+      self.send(setter_method, value)
+    end
+  end
+
 end

data/spec/permissionable_spec.rb

@@ -2,6 +2,8 @@ require 'permissionable'
 require 'dummy'
 
 
+# This class is a bit unreliable because 
+# it has its permissions redefined in the tests
 class FlakyDummy
   include Permissionable
 end
@@ -31,13 +33,13 @@ describe Permissionable do
       it 'can not assign 0' do
         expect{
           FlakyDummy.permissions(nope: 0)
-        }.to raise_exception
+        }.to raise_exception(Permissionable::InvalidPermissionAssignment)
       end
 
-      it 'can only assign integers' do
+      it 'can not assign strings' do
         expect{
           FlakyDummy.permissions(nope: '1')
-        }.to raise_exception
+        }.to raise_exception(Permissionable::InvalidPermissionAssignment)
       end
     end
   end
@@ -49,6 +51,10 @@ describe Permissionable do
       expect(dummy.permissions).to be_an_instance_of(Permissionable::Permissions)
     end
 
+    it 'can assign permissions on initializing' do
+      dummy = Dummy.new(permissions: [:sit, :eat])
+      expect(dummy.permissions[:sit, :eat]).to be true
+    end
   end
 
 end

data/spec/permissions_spec.rb

@@ -6,7 +6,7 @@ class DummyWithPermissions
   permissions walk: 1
 
   def read_attribute(attribute)
-    1 if attribute == :permissions
+    1 if attribute == :permissions_integer
   end
 end
 
@@ -53,7 +53,7 @@ describe Permissionable::Permissions do
     expect(@permissions.include?(:run, :walk)).to be true
   end
 
-  it 'it is false when one of asserted is missing' do
+  it 'is false when one of asserted is missing' do
     @permissions << :run
     @permissions << :walk
     expect(@permissions.include?(:run, :play)).to be false
@@ -68,18 +68,27 @@ describe Permissionable::Permissions do
   end
 
   it 'updates column when adding permission' do
-    @owner = Dummy.new
-    @permissions = Permissionable::Permissions.new(@owner)
-    expect(@owner).to receive(:update_column).with(:permissions, 2)
-    @permissions << :walk
+    owner = Dummy.new
+    permissions = Permissionable::Permissions.new(owner)
+    expect(owner).to receive(:update_column).with(:permissions_integer, 2)
+    permissions << :walk
   end
 
   it 'updates column when removing permission' do
-    @owner = Dummy.new
-    @permissions = Permissionable::Permissions.new(@owner)
-    @permissions << :run
-    expect(@owner).to receive(:update_column).with(:permissions, 0)
-    @permissions.remove :run
+    owner = Dummy.new
+    permissions = Permissionable::Permissions.new(owner)
+    permissions << :run
+    expect(owner).to receive(:update_column).with(:permissions_integer, 0)
+    permissions.remove :run
+  end
+
+  it 'can clear permissions' do
+    owner = Dummy.new
+    permissions = Permissionable::Permissions.new(owner)
+    permissions << :run
+    expect(permissions[:run]).to be true
+    permissions.clear!
+    expect(permissions.to_i).to be_zero
   end
 
   it 'can read permissions from owner' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: permissionable
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Robert Falkén
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-08 00:00:00.000000000 Z
+date: 2015-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,7 @@ files:
 - README.md
 - Rakefile
 - lib/permissionable.rb
+- lib/permissionable/exceptions.rb
 - lib/permissionable/permissions.rb
 - lib/permissionable/version.rb
 - permissionable.gemspec