permissify 0.0.3 → 0.0.4

data/lib/generators/permissify/controller/USAGE

@@ -0,0 +1,3 @@
+Description:
+  The permissify:product generator creates a Product class in the models directory.
+  You can move this file anywhere you want as long as it is in the load path.

data/lib/generators/permissify/controller/controller_generator.rb

@@ -0,0 +1,11 @@
+module Permissify
+  module Generators
+    class ControllerGenerator < Rails::Generators::Base
+      source_root File.expand_path('../template/interface', __FILE__)
+
+      def generate_controller
+        copy_file "permissified_controller.rb", "app/controllers/permissified_controller.rb"
+      end
+    end
+  end
+end

data/lib/generators/permissify/controller/template/interface/permissified_controller.rb

@@ -0,0 +1,12 @@
+module PermissifiedController
+  
+  # app-specific consideration for whether operating on a 
+  # merchant/business, brand, corporation, dealer or 
+  # admin (special case : nil? null object that defines PERMISSIBLE_PRODUCTS?)
+  def current_entity
+    return @current_entity if @current_entity
+    TODO_IMPLEMENT_PERMISSIFY_CONTROLLER_CURRENT_ENTITY_INTERFACE_METHOD
+    nil
+  end
+
+end

data/lib/generators/permissify/product/product_generator.rb

@@ -0,0 +1,17 @@
+module Permissify
+  module Generators
+    class ProductGenerator < Rails::Generators::Base
+      source_root File.expand_path('../template', __FILE__)
+
+      def generate_product
+        copy_file "product.rb", "app/models/product.rb"
+        copy_file "/interface/permissified_merchant.rb", "app/models/permissified_merchant.rb"
+        copy_file "/interface/permissified_brand.rb", "app/models/permissified_brand.rb"
+        # directory instead?
+        # d app/models/permissfy_interfaces
+        # f app/models/permissfy_interfaces/merchant.rb
+        # f app/models/permissfy_interfaces/brand.rb
+      end
+    end
+  end
+end

data/lib/generators/permissify/product/template/interface/permissified_brand.rb

@@ -0,0 +1,7 @@
+module Permissified
+  module Brand
+    def permissible_products
+      self.corporation.products + self.products
+    end
+  end
+end

data/lib/generators/permissify/product/template/interface/permissified_merchant.rb

@@ -0,0 +1,7 @@
+module Permissified
+  module Merchant
+    def permissible_products
+      self.corporation.products + self.brand.products + self.products
+    end
+  end
+end

data/lib/generators/permissify/role/role_generator.rb

@@ -3,7 +3,7 @@ module Permissify
     class RoleGenerator < Rails::Generators::Base
       source_root File.expand_path('../template', __FILE__)
 
-      def generate_ability
+      def generate_role
         copy_file "role.rb", "app/models/role.rb"
         # also make the following?
         # d app/models/system_fixtures

data/lib/permissify/aggregate.rb

@@ -1,79 +1,85 @@
-module Permissify::Aggregate
-  attr_accessor :abilities
+module Permissify
+  module Aggregate
+    attr_accessor :abilities
   
-  def permissions_union # [integer values].max
-    @union ||= construct_union
-  end
+    def permissions_union # [integer values].max
+      @union ||= construct_union
+    end
   
-  def construct_union
-    union = {}
-    self.send(permissions_association).collect(&:permissions).each do |permissions_hash|
-      permissions_hash.each do |key, descriptor|
-        descriptor ||= {'0' => false}
-        if union[key].nil?
-          union[key] = descriptor
-        else
-          arbitrate(union, descriptor, key, :max)
+    def construct_union
+      union = {}
+      self.send(self.class::PERMISSIFIED_ASSOCIATION).collect(&:permissions).each do |permissions_hash|
+        permissions_hash.each do |key, descriptor|
+          descriptor ||= {'0' => false}
+          if union[key].nil?
+            union[key] = descriptor
+          else
+            arbitrate(union, descriptor, key, :max)
+          end
+          union[key]['0'] = (union[key]['0'] == '1' || descriptor['0'] == '1')
         end
-        union[key]['0'] = (union[key]['0'] == '1' || descriptor['0'] == '1')
       end
+      union
     end
-    union
-  end
   
-  def permissions_intersection(product_permissions) # [integer values].min
-    return @intersection if @intersection
-    @intersection = {}
-    permissions_union
+    def permissions_intersection(product_permissions)
+      return @intersection if @intersection
+      @intersection = {}
+      permissions_union
 
-    Ability.all_for(%w(Product Role)).each do |ability|
-      key = ability[:key]
-      descriptor = @union[key]
-      product_descriptor = product_permissions[key]
-      if permissable?(descriptor) && permissable?(product_descriptor)
-        @intersection[key] = descriptor
-        arbitrate(@intersection, product_descriptor, key, :min)
-      else
-        @intersection[key] = null_permission
+      # TODO : Product/Role references should be plugged-in...
+      # - could aggregate keep track of class names that it is included in?
+      # - there is a lot tangled up in here...
+      Ability.all_for(%w(Product Role)).each do |ability|
+        key = ability[:key]
+        descriptor = @union[key]
+        product_descriptor = product_permissions[key]
+        if permissable?(descriptor) && permissable?(product_descriptor)
+          @intersection[key] = descriptor
+          arbitrate(@intersection, product_descriptor, key, :min)
+        else
+          @intersection[key] = null_permission
+        end
       end
-    end
 
-    include_permissions_unless_common_to_role_and_product('Product', product_permissions)
-    include_permissions_unless_common_to_role_and_product('Role', @union)
-    @intersection
-  end
+      include_permissions_unless_common_to_role_and_product('Product', product_permissions)
+      include_permissions_unless_common_to_role_and_product('Role', @union)
+      @intersection
+    end
   
-  def permissable?(descriptor); descriptor && (descriptor['0'] == true || descriptor['0'] == '1'); end
-  def subscribed_to?(feature); allowed_to?('on', feature); end
-  def allowed_to?(action, feature); (permissions_union["#{feature}_#{action}"]['0'] == true rescue false); end
+    def permissable?(descriptor); descriptor && (descriptor['0'] == true || descriptor['0'] == '1'); end
+    def subscribed_to?(feature); allowed_to?('on', feature); end
+    def allowed_to?(action, feature); (permissions_union["#{feature}_#{action}"]['0'] == true rescue false); end
   
-  def include_permissions_unless_common_to_role_and_product(applicability_type, applicable_permissions)
-    Ability.all_for(applicability_type).each do |ability|
-      key = ability[:key]
-      descriptor = applicable_permissions[key]
-      unless @intersection.has_key?(key)
-        if permissable?(descriptor)
-          descriptor['0'] = true
-          @intersection[key] = descriptor
-          arbitrate(@intersection, descriptor, key, :min)
-        else
-          @intersection[key] = null_permission
+    def include_permissions_unless_common_to_role_and_product(applicability_type, applicable_permissions)
+      Ability.all_for(applicability_type).each do |ability|
+        key = ability[:key]
+        descriptor = applicable_permissions[key]
+        unless @intersection.has_key?(key)
+          if permissable?(descriptor)
+            descriptor['0'] = true
+            @intersection[key] = descriptor
+            arbitrate(@intersection, descriptor, key, :min)
+          else
+            @intersection[key] = null_permission
+          end
         end
       end
     end
-  end
   
-  private
-  def arbitrate(aggregation, other_descriptor, key, min_or_max) # assuming all permission 'args' are integers stored as strings
-    1.upto(other_descriptor.size-1) do |i|
-      is = i.to_s; aggregation[key][is] = [aggregation[key][is].to_i, other_descriptor[is].to_i].send(min_or_max) # .to_s ?
+    private
+    def arbitrate(aggregation, other_descriptor, key, min_or_max) # assuming all permission 'args' are integers stored as strings
+      1.upto(other_descriptor.size-1) do |i|
+        is = i.to_s; aggregation[key][is] = [aggregation[key][is].to_i, other_descriptor[is].to_i].send(min_or_max) # .to_s ?
+      end
     end
-  end
-  def null_permission; {'0' => false, '1' => 0}; end
+    def null_permission; {'0' => false, '1' => 0}; end
   
-  def permissions_association # kinda icky
-    klass = self.respond_to?(:product_tiers) ? self.class : Business
-    @permissions_association ||= {User => :roles, klass => :product_tiers}[self.class]
-    @permissions_association ||= :permission_objects
+    # # TODO : need to do this differently : specify in model? discern from
+    # def permissions_association # kinda icky
+    #   klass = self.respond_to?(:products) ? self.class : Business
+    #   @permissions_association ||= {User => :roles, klass => :products}[self.class]
+    #   @permissions_association ||= :permission_objects
+    # end
   end
 end

data/lib/permissify/controller.rb

@@ -0,0 +1,27 @@
+module Permissify
+  module Controller # Interface : override/rewrite as needed
+    
+    # is this going to work?
+    # generator creates app/controllers/permissified_controller.rb
+    # - if not, remedy by having both Permissify::Controller and PermissifedController in application_controller?
+    include PermissifiedController
+    
+    def current_entity # merchant/business, brand, corporation, dealer or special case (all? none? products) for admin
+      return @current_entity if @current_entity
+      TODO_IMPLEMENT_PERMISSIFY_CONTROLLER_CURRENT_ENTITY_INTERFACE_METHOD
+      nil
+    end
+    
+    def domain_permissions
+      return entity.permissions_union if current_user.nil? # public pages allow corp/brand/merchant product permissions
+      return current_user.permissions_union unless current_entity # admin, by convention, not subscribed to any products
+      current_user.permissions_intersection(current_entity.permissions_union)
+    end
+
+    def allowed_to?(action, permission_category)
+      @permissions ||= domain_permissions
+      (@permissions["#{permission_category}_#{action}"]['0'] == true rescue false)
+    end
+    
+  end
+end

data/lib/permissify/model.rb

@@ -1,26 +1,28 @@
-module Permissify::Model
-  attr_accessor :from, :from_permissions_model
+module Permissify
+  module Model
+    attr_accessor :from, :from_permissions_model
   
-  def establish_from_permissions_model
-    self.from_permissions_model ||= self.from.nil? ? nil : self.class.find(self.from)
-  end
+    def establish_from_permissions_model
+      self.from_permissions_model ||= self.from.nil? ? nil : self.class.find(self.from)
+    end
   
-  def initialize_permissions
-    self.permissions ||= self.from.nil? ? {} : establish_from_permissions_model.permissions
-  end
+    def initialize_permissions
+      self.permissions ||= self.from.nil? ? {} : establish_from_permissions_model.permissions
+    end
   
-  def allows?(ability_key) ; logger.debug(ability_key.inspect.to_s); 
-    allowed = self.permissions[ability_key];
-    allowed && allowed['0']; 
+    def allows?(ability_key) ; logger.debug(ability_key.inspect.to_s); 
+      allowed = self.permissions[ability_key];
+      allowed && allowed['0']; 
+      end
+    def remove_permissions(keys)
+      keys = [keys] if keys.class == String
+      keys.each{ |k| self.permissions[k] = nil}
+      self.save
     end
-  def remove_permissions(keys)
-    keys = [keys] if keys.class == String
-    keys.each{ |k| self.permissions[k] = nil}
-    self.save
-  end
-  def update_permissions(new_or_updated_permissions)
-    self.permissions = self.permissions.merge(new_or_updated_permissions)
-    self.save
+    def update_permissions(new_or_updated_permissions)
+      self.permissions = self.permissions.merge(new_or_updated_permissions)
+      self.save
+    end
+    def underscored_name_symbol; self.class.underscored_name_symbol(self.name); end
   end
-  def underscored_name_symbol; self.class.underscored_name_symbol(self.name); end
 end

data/lib/permissify/model_class.rb

@@ -1,34 +1,36 @@
-module Permissify::ModelClass
-  def retire_permissions_objects(retire_sql)
-    ActiveRecord::Base.connection.execute retire_sql
-  end
+module Permissify
+  module ModelClass
+    def retire_permissions_objects(retire_sql)
+      ActiveRecord::Base.connection.execute retire_sql
+    end
 
-  def create_seeds(table_name, seed_specifications)
-    @model_class_seed_specifications = seed_specifications
-    seed_specifications.each do |id, name|
-      permissions_model = locate(id, name)
-      permissions_model.permissions = send("#{underscored_name_symbol(name)}_permissions")
-      permissions_model.save
+    def create_seeds(table_name, seed_specifications)
+      @model_class_seed_specifications = seed_specifications
+      seed_specifications.each do |id, name|
+        permissions_model = locate(id, name)
+        permissions_model.permissions = send("#{underscored_name_symbol(name)}_permissions")
+        permissions_model.save
+      end
+      ActiveRecord::Base.connection.execute "ALTER TABLE #{table_name} AUTO_INCREMENT = 101;"
     end
-    ActiveRecord::Base.connection.execute "ALTER TABLE #{table_name} AUTO_INCREMENT = 101;"
-  end
 
-  def create_with_id(table, id, name)
-    permissions = send("#{underscored_name_symbol(name)}_permissions")
-    permissions_model = new
-    permissions_model.name = name
-    permissions_model.permissions = permissions
-    permissions_model.save
-    ActiveRecord::Base.connection.execute "UPDATE #{table}s SET id=#{id} WHERE id=#{permissions_model.id};"
-    find(id)
-  end
+    def create_with_id(table, id, name)
+      permissions = send("#{underscored_name_symbol(name)}_permissions")
+      permissions_model = new
+      permissions_model.name = name
+      permissions_model.permissions = permissions
+      permissions_model.save
+      ActiveRecord::Base.connection.execute "UPDATE #{table}s SET id=#{id} WHERE id=#{permissions_model.id};"
+      find(id)
+    end
   
-  def locate(id, name)
-    model_with_id   = find_by_id(id)
-    model_with_id ||= send("create_#{underscored_name_symbol(name)}")
-  end
+    def locate(id, name)
+      model_with_id   = find_by_id(id)
+      model_with_id ||= send("create_#{underscored_name_symbol(name)}")
+    end
 
-  def underscored_name_symbol(name)
-    name.to_s.downcase.gsub('-','_').gsub(':','').gsub('  ',' ').gsub(' ','_')    
+    def underscored_name_symbol(name)
+      name.to_s.downcase.gsub('-','_').gsub(':','').gsub('  ',' ').gsub(' ','_')    
+    end
   end
 end

data/lib/permissify/roles.rb

@@ -0,0 +1,24 @@
+module Permissions::Roles
+  include Permissify::Aggregate
+  
+  def primary_domain_type; sorted_domain_types.first; end
+  def primary_role_name; role_list(:description).sort.first; end
+  def sorted_domain_types; role_list(:domain_type).sort; end
+  def manages_roles; role_list(:manages_roles); end
+  def manages_role_names; sorted_role_names(manages_roles); end
+  def role_list(collection_method); roles.collect(&collection_method).flatten.uniq; end
+  
+  def can_create_and_modify(users, app_instance) # TODO : unit test for this
+    role_names_that_this_user_can_manage = manages_role_names
+    # 2 ways to go here : must be able to manage *all* or *any* of a user's roles.
+    # Chose *all* to prevent lower ranking users from demoting higher ranking users
+    users.select do |u|
+      u_role_names = sorted_role_names(u.roles)
+      ! u_role_names.blank? && (role_names_that_this_user_can_manage & u_role_names) == u_role_names
+    end
+    users.delete_if{|u| !u.instances.include?(app_instance)}
+    return users
+  end
+  
+  def sorted_role_names(roles); roles.collect(&:name).sort; end
+end

data/lib/permissify.rb

@@ -1,3 +1,5 @@
 require 'permissify/aggregate'
+require 'permissify/controller'
 require 'permissify/model'
 require 'permissify/model_class'
+require 'permissify/roles'

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: permissify
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 23
   prerelease: 
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Frederick Fix
@@ -61,13 +61,21 @@ files:
 - lib/generators/permissify/ability/ability_generator.rb
 - lib/generators/permissify/ability/template/ability.rb
 - lib/generators/permissify/ability/USAGE
+- lib/generators/permissify/controller/controller_generator.rb
+- lib/generators/permissify/controller/template/interface/permissified_controller.rb
+- lib/generators/permissify/controller/USAGE
+- lib/generators/permissify/product/product_generator.rb
+- lib/generators/permissify/product/template/interface/permissified_brand.rb
+- lib/generators/permissify/product/template/interface/permissified_merchant.rb
 - lib/generators/permissify/product/USAGE
 - lib/generators/permissify/role/role_generator.rb
 - lib/generators/permissify/role/template/role.rb
 - lib/generators/permissify/role/USAGE
 - lib/permissify/aggregate.rb
+- lib/permissify/controller.rb
 - lib/permissify/model.rb
 - lib/permissify/model_class.rb
+- lib/permissify/roles.rb
 - lib/permissify.rb
 - CHANGELOG.rdoc
 - Gemfile