permissify 0.0.15 → 0.0.16

data/lib/generators/permissify/ability/template/abilities.rb

@@ -1,9 +1,12 @@
 module SystemFixtures::Abilities
+  
+  # required interface method : app Ability class must implement
+  # - use Permissify::AbilityClass builder methods or *ml or whatever : just get @@abilities set
   def seed
     SPECIFY_ABILITIES_IN__APP__MODELS__SYSTEM_FIXTURES__ABILITIES
-    # and remember to trigger in seed process by including in, for example, Ability.seed in your db/seed.rb file
 
-    # # organize permissions into categories that correspond to your client's/product team's view of the system
+    # can organize permissions into categories that correspond to your client's/product team's view of app.
+    # suggest playing with your Ability class and the builder methods in console.
     # add_category('Tabs', 'Tabs', ['Role'], %w(Admin Dealer Corporate Brand Merchant))
     # { 'Roles'                 => 'Admin',
     #   'Admin Users'           => 'Admin',
@@ -13,4 +16,5 @@ module SystemFixtures::Abilities
     #   'Merchant Users'        => 'Merchant Admin',
     # }.each{ |category, section| add_category(category, section) }
   end
+  
 end

data/lib/generators/permissify/ability/template/ability.rb

@@ -1,5 +1,5 @@
-# TODO : this could be an activerecord, does not need to be.
-# - needs to support interface(s) : seed     ?also: all, all_for, others?
+# NOTE : this could be an activerecord, does not need to be.
+# - requires implementation of 'seed' interface method : see SystemFixtures::Abilities
 class Ability
   
   class << self

data/lib/generators/permissify/role/template/roles.rb

@@ -29,14 +29,14 @@ module SystemFixtures::Roles
   end
   
   def super_user_permissions
-    @@permissions = Ability.create_permissions_hash
+    Ability.create_permissions_hash
   end
   def system_admin_permissions
-    @@permissions = Ability.create_permissions_hash 'roles'
+    Ability.create_permissions_hash 'roles'
   end
   def dealer_admin_permissions
-    @@permissions = Ability.create_permissions_hash( [], %w(roles admin))
-    remove %w(tabs_admin)
+    Ability.create_permissions_hash( [], %w(roles admin))
+    Ability.remove_permissions %w(tabs_admin)
   end
   
   def corporate_admin_permissions
@@ -44,17 +44,15 @@ module SystemFixtures::Roles
   end
   def brand_admin_permissions
     msa_permissions %w(corporate brand_portal_create brand_portal_update)
-    remove %w(tabs_corporate)
+    Ability.remove_permissions %w(tabs_corporate)
   end
   def merchant_admin_permissions
     msa_permissions %w(corporate brand)
-    remove %w(tabs_brand tabs_corporate)
+    Ability.remove_permissions %w(tabs_brand tabs_corporate)
   end
   def msa_permissions(exclude_abilities)
     no_abilities = exclude_abilities + %w(admin roles dealer)
-    @@permissions = Ability.create_permissions_hash([], no_abilities)
-    remove %w(tabs_admin tabs_dealer)
+    Ability.create_permissions_hash([], no_abilities)
+    Ability.remove_permissions %w(tabs_admin tabs_dealer)
   end
-
-  def remove(permissions); permissions.each{|permission| @@permissions.delete(permission.to_s)}; @@permissions; end
 end

data/lib/permissify/ability_class.rb

@@ -3,38 +3,61 @@ module Permissify
     
     @@abilities = []
 
-    def clear; @@abilities = []; end
-    def all; seed if @@abilities.empty?; @@abilities; end
+    def reset
+      @@abilities = []
+    end
+    
+    def current
+      @@abilities
+    end
+    
+    def all
+      seed if @@abilities.empty?
+      current
+    end
   
     def all_for(applicability_types)
       applicability_types = [applicability_types] if applicability_types.kind_of?(String)
       all.select{|a| (a[:applicability] & applicability_types) == applicability_types}
     end
 
+    def add(key, category, section, action, applicability, number_of_values, position, default_values, admin_expression='', category_allows = :multiple)
+      @@abilities <<  { :key => key, :category => category, :section => section, :action => action,
+                        :applicability => applicability, :number_of_values => number_of_values, :position => position,
+                        :default_values => default_values, :administration_expression => admin_expression, :category_allows => category_allows}
+    end
+
     def add_category(category, section, applicability=['Role'], actions=%w(View Create Update Delete), category_allows = :multiple)
       actions = [actions] unless actions.kind_of?(Array)
       actions.collect do |action|
         add("#{key_token(category)}_#{key_token(action)}", category, section, action, applicability, 1, actions.index(action)+1, [false], '', category_allows)
       end
     end
-  
+
     def create_permissions_hash(view_only_categories=[], remove_categories=[], applicability_types = 'Role')
       @@permissions = {}
       all_for(applicability_types).each{|permission| @@permissions[permission[:key]] = {'0' => '1'}}
       view_only_categories.each{|category| view_only(category)}
-      remove_categories.each{|category| remove(category)}
+      remove_categories.each{|category| remove_permission(category)}
+      @@permissions
+    end
+
+    def remove_permission(key_prefix)
+      @@permissions.keys.each{ |key| @@permissions.delete(key) if key.start_with?(key_prefix) }
+      @@permissions
+    end
+    
+    def current_permissions_hash
       @@permissions
     end
   
     private
-    def key_token(token); token.downcase.gsub('-','_').gsub(':','').gsub('  ',' ').gsub(' ','_'); end
-    def view_only(category); %w(create update delete).each{|action| @@permissions.delete("#{category}_#{action}")};  end
-    def remove(permission_prefix); @@permissions.keys.each{|key| @@permissions.delete(key) if key.starts_with?(permission_prefix)}; end
-    def add(key, category, section, action, applicability, number_of_values, position, default_values, admin_expression='', category_allows = :multiple)
-      @@abilities <<  { :key => key, :category => category, :section => section, :action => action,
-                        :applicability => applicability, :number_of_values => number_of_values, :position => position,
-                        :default_values => default_values, :administration_expression => admin_expression, :category_allows => category_allows}
+    def key_token(token)
+      token.downcase.gsub('-','_').gsub(':','').gsub('  ',' ').gsub(' ','_')
+    end
+    
+    def view_only(category)
+      %w(create update delete).each{|action| @@permissions.delete("#{category}_#{action}")}
     end
-
   end
 end

data/spec/permissify/ability_class_spec.rb

@@ -0,0 +1,83 @@
+require 'spec_helper'
+
+describe Permissify::AbilityClass do
+  describe 'all' do
+    describe 'and interface seed not implemented' do
+      it 'should raise NameError' do
+        expect{NoSeedAbility.all}.to raise_error(NameError)
+      end
+    end
+
+    describe 'and interface seed implemented' do
+      it 'should return the correct number of abilities' do
+        (a = Ability.all).size.should == 29
+        a.first.should == {:default_values=>[false], :applicability=>["Role"], :category=>"Tabs", :administration_expression=>"", :section=>"Tabs", :category_allows=>:multiple, :number_of_values=>1, :key=>"tabs_admin", :position=>1, :action=>"Admin"}
+      end
+    end
+  end
+      
+  describe 'abilities builder method' do
+    before(:each) { Ability.reset }
+
+    describe 'reset' do
+      it 'should reset abilities' do
+        Ability.current.should == []
+      end
+    end
+
+    describe 'add_category' do
+      it 'should establish correct ability expression for fully specified category and action' do
+        add_category1_section1
+        Ability.current.should == [{:section=>"section1", :category=>"category1", :action=>"view", :position=>1, :key=>"category1_view", :applicability=>["Role", "Product"], :category_allows=>:one_or_none, :administration_expression=>"", :number_of_values=>1, :default_values=>[false]}]
+      end
+
+      it 'should establish correct ability expression for category and action with defaulted values' do
+        Ability.add_category('category2', 'section2')
+        Ability.current.should == [ {:section=>"section2", :category=>"category2", :action=>"View",   :position=>1, :key=>"category2_view",   :applicability=>["Role"], :category_allows=>:multiple, :administration_expression=>"", :number_of_values=>1, :default_values=>[false]},
+                                    {:section=>"section2", :category=>"category2", :action=>"Create", :position=>2, :key=>"category2_create", :applicability=>["Role"], :category_allows=>:multiple, :administration_expression=>"", :number_of_values=>1, :default_values=>[false]},
+                                    {:section=>"section2", :category=>"category2", :action=>"Update", :position=>3, :key=>"category2_update", :applicability=>["Role"], :category_allows=>:multiple, :administration_expression=>"", :number_of_values=>1, :default_values=>[false]},
+                                    {:section=>"section2", :category=>"category2", :action=>"Delete", :position=>4, :key=>"category2_delete", :applicability=>["Role"], :category_allows=>:multiple, :administration_expression=>"", :number_of_values=>1, :default_values=>[false]} ]
+      end
+    end
+  end
+
+  # TODO : specs for just Product, and Role and Product, applicabilities
+  describe 'permission builder method' do
+
+    describe 'create_permissions_hash(view_only_categories=[], remove_categories=[], applicability_types = "Role")' do
+      before(:each) { Ability.seed; @ability_key_set = Ability.current.collect{|a| a[:key]}.to_set }
+
+      it 'should express each current ability when invoked with no arguments' do
+        @ability_key_set.should == Ability.create_permissions_hash.keys.to_set
+      end
+      
+      it 'should exclude respective permissions to create, update and delete when a view only category is specified' do
+        expected_keys.should == Ability.create_permissions_hash(['roles']).keys.to_set
+      end
+      
+      it 'should exclude permissions for all permissions keys that begin with string in input remove categories arg' do
+        expected_keys('roles_view').should == Ability.create_permissions_hash([], ['ro']).keys.to_set
+      end
+      
+      def expected_keys(other_excluded_key = nil, excluded_keys = %w(roles_create roles_update roles_delete))
+        @ability_key_set - [other_excluded_key] - excluded_keys
+      end
+    end
+
+    describe 'remove_permission' do
+      before(:each) { Ability.reset }
+
+      it 'should remove all keys in the permissions hash that start with the input prefix' do
+        Ability.reset
+        add_category1_section1 %w(view1 view2 bill)
+        Ability.create_permissions_hash
+        Ability.remove_permission('category1_view')
+        Ability.current_permissions_hash.should == {"category1_bill"=>{"0"=>"1"}}
+      end
+    end
+  end
+  
+  def add_category1_section1(actions = 'view')
+    Ability.add_category('category1', 'section1', %w(Role Product), actions, :one_or_none)
+  end
+end

data/spec/spec_helper.rb

@@ -8,6 +8,7 @@ require 'rubygems'
 require 'bundler/setup'
 
 require 'permissify'
+require 'permissify/ability_class'
 
 RSpec.configure do |config|
   config.treat_symbols_as_metadata_keys_with_true_values = true
@@ -17,11 +18,23 @@ end
 
 class Ability
   class << self
-    include Permissify::Ability
+    include Permissify::AbilityClass
     
     def seed
-      # required interface method : app Ability class must implement
-      # - use Permissify::Abilities helper methods or *ml or whatever : just get @@abilities set
+      add_category('Tabs', 'Tabs', ['Role'], %w(Admin Dealer Corporate Brand Merchant))
+      { 'Roles'                 => 'Admin',
+        'Admin Users'           => 'Admin',
+        'Dealer Users'          => 'Dealer Admin',
+        'Corporate Users'       => 'Corporate Admin',
+        'Brand Users'           => 'Brand Admin',
+        'Merchant Users'        => 'Merchant Admin',
+      }.each{ |category, section| add_category(category, section) }
     end
   end
 end
+
+class NoSeedAbility
+  class << self
+    include Permissify::AbilityClass
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: permissify
 version: !ruby/object:Gem::Version 
-  hash: 1
+  hash: 63
   prerelease: 
   segments: 
   - 0
   - 0
-  - 15
-  version: 0.0.15
+  - 16
+  version: 0.0.16
 platform: ruby
 authors: 
 - Frederick Fix
@@ -108,7 +108,7 @@ files:
 - lib/permissify/model_class.rb
 - lib/permissify/roles.rb
 - lib/permissify.rb
-- spec/permissify/ability_spec.rb
+- spec/permissify/ability_class_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
 - CHANGELOG.rdoc

data/spec/permissify/ability_spec.rb

@@ -1,42 +0,0 @@
-require 'spec_helper'
-
-describe Ability do
-  describe "all" do
-    it "should return the correct number of abilities" do
-      Ability.all.size.should == 189
-    end
-  end
-  
-  # describe "all_for" do
-  #   it "should return the correct number of abilities when invoked with 'Product' applicability type" do
-  #     Ability.all_for('Product').size.should == 50
-  #   end
-  # 
-  #   it "should return the correct number of abilities when invoked with 'Role' applicability type" do
-  #     Ability.all_for('Role').size.should == 179
-  #   end
-  # 
-  #   it "should return the correct number of abilities when invoked with both 'Product' and 'Role' applicability types" do
-  #     Ability.all_for(%w(Product Role)).size.should == 40
-  #   end
-  #   
-  #   it "should do the right set logic" do
-  #     (Ability.all_for('Product') & Ability.all_for('Role')).should == Ability.all_for(%w(Product Role))
-  #   end
-  # end
-  # 
-  # describe "create_permissions_hash" do
-  #   it "should return the correct number of entries when full access to all Role permissions" do
-  #     Ability.create_permissions_hash([], [], 'Role').keys.size.should == 179
-  #   end
-  #   it "should return the correct number of entries when full access to all Role permissions except view only to a single category" do
-  #     Ability.create_permissions_hash(['loyalty_id'], [], 'Role').keys.size.should == 176
-  #   end
-  #   it "should return the correct number of entries when full access to all Role permissions except view only to a single category" do
-  #     Ability.create_permissions_hash([], ['loyalty_id'], 'Role').keys.size.should == 175
-  #   end
-  #   it "should yield the expected difference" do
-  #     (Ability.create_permissions_hash(['loyalty_id'], [], 'Role') - Ability.create_permissions_hash([], ['loyalty_id'], 'Role')).should == {"loyalty_id_view"=>{"0"=>"1"}}
-  #   end
-  # end
-end