cantango-roles 0.1.0

data/lib/generators/cantango/base.rb

@@ -0,0 +1,71 @@
+require 'generators/cantango/basic'
+
+module Cantango
+  module Generators
+    class Base < ::Rails::Generators::Base
+
+      include Cantango::Generators::Basic
+
+      CAN_ACTIONS = [:create, :update, :manage, :read, :access]
+
+      CAN_ACTIONS.each do |action|
+        class_eval %{
+          class_option :#{action},      :type => :array,     :default => [],  :desc => "Models allowed to #{action}"
+          class_option :not_#{action},  :type => :array,     :default => [],  :desc => "Models not allowed to #{action}"
+        }
+      end
+
+      protected
+
+      [:user, :account].each do |name|
+        define_method :"#{name}?" do
+          false
+        end
+      end
+
+      CAN_ACTIONS.each do |action|
+        class_eval %{
+          def #{action}
+            options[:#{action}]
+          end
+        }
+      end
+
+      CAN_ACTIONS.each do |action|
+        class_eval %{
+          def not_#{action}
+            options[:not_#{action}]
+          end
+        }
+      end
+
+      def rules_logic
+        can_logic
+        cannot_logic
+      end
+
+      def can_logic
+        CAN_ACTIONS.map do |action|
+          send(action).map do |c|
+            "can(:#{action}, #{act_model(c)})"
+          end.join("\n    ")
+        end.join("\n")
+      end
+
+      def cannot_logic
+        CAN_ACTIONS.map do |action|
+          send(action).map do |c|
+            "can(:#{action}, #{act_model(c)})"
+          end.join("\n    ")
+        end.join("\n")
+      end
+
+      def act_model name
+        return ':all' if name == 'all'
+        name.camelize
+      end
+    end
+  end
+end
+
+

data/lib/generators/cantango/basic.rb

@@ -0,0 +1,41 @@
+module Cantango
+  module Generators
+    module Basic
+      def rules_logic
+        ''
+      end
+
+      def license_logic
+        ''
+      end
+
+      def base_logic
+        %{
+   }
+      end
+
+      def admin_logic
+        %{
+          can :manage, :all
+    }
+      end
+
+      def guest_logic
+        %{
+          can :read, :all
+    }
+      end
+
+      def account
+        options[:account]
+      end
+
+      [:is_user, :is_account, :is_group].each do |name|
+        define_method :"#{name}?" do
+          false
+        end
+      end
+    end
+  end
+end
+

data/lib/generators/cantango/license_base.rb

@@ -0,0 +1,15 @@
+module Cantango
+  module Generators
+    module LicenseBase
+      def licenses
+        options[:licenses]
+      end
+
+      def license_logic
+        return ' # use any licenses here' if licenses.empty?
+        ls = licenses.map{|c| ":#{c}"}.join(", ")
+        "licenses #{ls}"
+      end
+    end
+  end
+end

data/lib/generators/cantango/permit_generator.rb

@@ -0,0 +1,58 @@
+require 'generators/cantango/basic'
+
+module Cantango
+  module Generators
+    module PermitGenerator
+      attr_accessor :permit_name, :permit_logic
+
+      include Cantango::Generators::Basic
+
+      def template_permit name, account = nil
+        @permit_name = name
+        set_logic name
+        account.present? ? template_account_permit(name, account) : template_simple_permit(name)
+      end
+
+      def template_simple_permit name
+        template permit_source, "app/permits/#{permit_target(name)}"
+      end
+
+      def template_account_permit name, account
+        template "account_permit.erb" , "app/permits/#{account}/#{permit_target(name)}"
+      end
+
+      def load_permit_template name
+        template = ERB.new File.open(template_filepath).read.gsub(/\n/, "\n\s\s")
+        template.result(binding)
+      end
+
+      def template_filepath
+        File.join source_path, permit_source
+      end
+
+      def source_path
+        source_paths.first
+      end
+
+      def permit_source
+        return "user_permit.erb" if is_user?
+        return "account_permit.erb" if is_account?
+
+        is_group? ? "role_group_permit.erb" : "role_permit.erb"
+      end
+
+      def permit_target name
+        name = name.to_s.underscore
+        return "#{name}_permit.rb" if is_user?
+        return "#{name}_account_permit.rb" if is_account?
+
+        is_group? ? "#{name}_role_group_permit.rb" : "#{name}_role_permit.rb"
+      end
+
+      def set_logic name
+        meth = "#{name}_logic"
+        @permit_logic = respond_to?(meth) ? send(meth) : base_logic
+      end
+    end
+  end
+end

data/lib/generators/cantango/role_permit/role_permit_generator.rb

@@ -0,0 +1,39 @@
+require 'generators/cantango/base'
+require 'generators/cantango/license_base'
+require 'generators/cantango/permit_generator'
+
+module Cantango
+  module Generators
+    class RolePermitGenerator < Cantango::Generators::Base
+      desc "Creates a Permit for a role in 'app/permits' with specific permissions and/or licenses"
+
+      argument     :role,       :type => :string,
+          :desc => "Role to create permit for"
+
+      class_option :licenses,   :type => :array,    :default => [],
+          :desc => "Licenses to use in Permit"
+
+      class_option :account,          :type => :string,
+          :desc => "Generate permits for a specific user account"
+
+      class_option :group,      :type => :boolean,  :default => false,  :desc => "Generate permit for a role group"
+
+      source_root File.dirname(__FILE__) + '/templates'
+
+      def main_flow
+        template_permit role
+      end
+
+      protected
+
+      include Cantango::Generators::LicenseBase
+      include Cantango::Generators::PermitGenerator
+
+      alias_method :role_group, :role
+
+      def is_group?
+        options[:group]
+      end
+    end
+  end
+end

data/lib/generators/cantango/role_permit/templates/account_permit.erb

@@ -0,0 +1,4 @@
+module <%= account.to_s.camelize%>AccountPermits
+<%= load_permit_template :role_permit %>
+end
+

data/lib/generators/cantango/role_permit/templates/role_group_permit.erb

@@ -0,0 +1,24 @@
+class <%= permit_name.to_s.camelize %>RoleGroupPermit < CanTango::RoleGroupPermit
+  def initialize ability
+    super
+  end
+
+  protected
+
+  def permit_rules
+    # insert your can, cannot and any other rule statements here
+    <%= rules_logic.strip %>
+    <%= license_logic %>
+  end
+
+  module Cached
+    def permit_rules
+    end
+  end
+
+  module NonCached
+    def permit_rules
+    end
+  end
+end
+

data/lib/generators/cantango/role_permit/templates/role_permit.erb

@@ -0,0 +1,23 @@
+class <%= permit_name.to_s.camelize %>RolePermit < CanTango::RolePermit
+  def initialize ability
+    super
+  end
+
+  protected
+
+  def permit_rules
+    # insert your can, cannot and any other rule statements here
+    <%= rules_logic.strip %>
+    <%= license_logic %>
+  end
+
+  module Cached
+    def permit_rules
+    end
+  end
+
+  module NonCached
+    def permit_rules
+    end
+  end
+end

data/lib/generators/cantango/role_permits/role_permits_generator.rb

@@ -0,0 +1,45 @@
+require 'generators/cantango/permit_generator'
+
+module Cantango
+  module Generators
+    class RolePermitsGenerator < Rails::Generators::Base
+      desc "Creates a Permit for each role in 'app/permits' and ensures that the permit folder is added to Rails load path."
+
+      argument     :roles,            :type => :array,
+          :desc => "Roles to create permits for"
+
+      class_option :special_permits,  :type => :boolean,    :default => false,
+          :desc => "Create special permits Syatem and Any"
+
+      class_option :account,          :type => :string,
+          :desc => "Generate permits for a specific user account"
+
+      class_option :group,            :type => :boolean,    :default => false,  
+          :desc => "Generate permits for role groups"
+
+      source_root File.dirname(__FILE__) + '/../role_permit/templates'
+
+      def main_flow
+        create_special_permits if special_permits?
+        create_permits
+      end
+
+      protected
+
+      include Cantango::Generators::PermitGenerator
+
+      def create_special_permits
+        template_permit :any
+        template_permit :system
+      end
+
+      def create_permits
+        roles.each { |role| template_permit role }
+      end
+
+      def special_permits?
+        options[:special_permits]
+      end
+    end
+  end
+end

data/spec/cantango/ability/helper/role_group_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+require 'fixtures/models'
+require 'helpers/current_users'
+
+class Permits
+  include CanTango::Ability::Helper::RoleGroup
+  
+  attr_accessor :subject
+  
+  def initialize subject
+    @subject = subject
+  end
+  
+  def role_groups_list_meth
+    :role_groups_list
+  end  
+end
+
+class User
+  include_and_extend SimpleRoles
+end  
+
+describe CanTango::Ability::Helper::RoleGroup do
+  before do
+    @user = User.new 'mike', 'mike@mail.ru', :role_groups => [:admins, :editors]
+  end
+  
+  subject { Permits.new @user }
+  
+  describe 'role_groups' do    
+    specify { subject.role_groups.should == [:admins, :editors] }
+  end
+end

data/spec/cantango/ability/helper/role_spec.rb

@@ -0,0 +1,33 @@
+require 'spec_helper'
+require 'fixtures/models'
+require 'helpers/current_users'
+
+class Permits
+  include CanTango::Ability::Helper::Role
+  
+  attr_accessor :subject
+  
+  def initialize subject
+    @subject = subject
+  end
+  
+  def roles_list_meth
+    :roles_list
+  end
+end
+
+class User
+  include_and_extend SimpleRoles
+end  
+
+describe CanTango::Ability::Helper::Role do
+  before do
+    @user = User.new 'mike', 'mike@mail.ru', :roles => [:admin, :editor]
+  end
+  
+  subject { Permits.new @user }
+  
+  describe 'roles' do    
+    specify { subject.roles.should == [:admin, :editor] }
+  end
+end

data/spec/cantango/builder/role_group_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe CanTango::Builder::Permit::RoleGroup do
+  pending
+end

data/spec/cantango/builder/role_spec.rb

@@ -0,0 +1,5 @@
+require 'spec_helper'
+
+describe CanTango::Builder::Permit::Role do
+  pending
+end

data/spec/cantango/configuration/role_groups_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+require 'cantango/configuration/shared/role_registry_ex'
+
+describe CanTango::Configuration::RoleGroups do
+  subject { CanTango.config.role_groups }
+
+  it_should_behave_like "Role Registry" do
+    specify { subject.system_api[:list].should == :role_group_list }
+    specify { subject.system_api[:has].should == :in_role_group? }
+  end
+end
+
+

data/spec/cantango/configuration/role_registry_spec.rb

@@ -0,0 +1,9 @@
+require 'spec_helper'
+require 'cantango/configuration/shared/role_registry_ex'
+
+describe CanTango::Configuration::Registry::Role do
+  subject { CanTango.config.roles }
+
+  it_should_behave_like "Role Registry" do
+  end
+end

data/spec/cantango/configuration/roles_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+require 'cantango/configuration/shared/role_registry_ex'
+
+describe CanTango::Configuration::Roles do
+  subject { CanTango.config.roles }
+
+  it_should_behave_like "Role Registry" do
+    let (:has) { :has_role? }
+    let (:list) { :roles_list }
+  end
+end