cantango-permits 0.1.1

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/license_generator.rb

@@ -0,0 +1,29 @@
+require 'generators/cantango/base'
+require 'generators/cantango/license_base'
+
+module Cantango
+  module Generators
+    class LicenseGenerator < Cantango::Generators::Base 
+      desc "Creates a License for a Permit in 'app/licenses' with reusable permissions"
+
+      argument     :name,         :type => :string,    :desc => "Name of license"
+
+      class_option :licenses,     :type => :array,     :default => [],  :desc => "Sub licenses"
+
+      source_root File.dirname(__FILE__) + '/templates'
+
+      def main_flow
+        return if name.empty?
+        create_license
+      end
+
+      protected
+
+      def create_license
+        template "license.erb", "app/permits/licenses/#{name}_license.rb"
+      end
+
+      include Cantango::Generators::LicenseBase
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+class <%= name.to_s.camelize %>License < CanTango::License
+  def initialize name
+    super
+  end
+
+  def permit_rules
+    <%= rules_logic.strip %>
+    <%= license_logic %>
+  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/licenses/licenses_generator.rb

@@ -0,0 +1,26 @@
+module Cantango
+  module Generators
+    class LicensesGenerator < Rails::Generators::Base
+      desc "Creates Licenses for use with CanCan Permits"
+
+      argument     :licenses,           :type => :array,      :desc => "Licenses"
+
+      source_root File.dirname(__FILE__) + '/../license/templates'
+
+      def main_flow
+        licenses.each do |license|
+          template_license(license)
+        end
+      end
+
+      protected
+
+      attr_accessor :license_name
+
+      def template_license name
+        self.license_name = name
+        template "license.erb", "app/licenses/#{name}_license.rb"
+      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/lib/generators/cantango/user_permit/templates/account_permit.erb

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

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

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

data/lib/generators/cantango/user_permit/user_permit_generator.rb

@@ -0,0 +1,36 @@
+require 'generators/cantango/base'
+require 'generators/cantango/license_base'
+require 'generators/cantango/permit_generator'
+
+module Cantango
+  module Generators
+    class UserPermitGenerator < Cantango::Generators::Base
+      desc "Creates a Permit for a user in 'app/permits' with specific permissions and/or licenses"
+
+      argument     :user,       :type => :string,   :desc => "User class 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 user, account
+      end
+
+      protected
+
+      def is_user?
+        true
+      end
+
+      include Cantango::Generators::LicenseBase
+      include Cantango::Generators::PermitGenerator
+    end
+  end
+end
+

data/lib/tasks/permits_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :permits do
+#   # Task goes here
+# end

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

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+class Context
+  include CanTango::Ability::Helper::Permits
+end
+
+describe CanTango::Ability::Helper::Permits do
+  subject { Context.new }
+  describe 'permits?' do
+    specify do
+      subject.permits?.should == CanTango.config.permits.on?
+    end
+  end
+end

data/spec/cantango/builder/permit/account_type_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+class AdminAccountPermitBuilder < CanTango::Builder::Permit::AccountType
+end
+
+describe CanTango::Builder::Permit::AccountType do
+  before do 
+    @user = User.new 'kris', 'kris@mail.ru', :roles => [:editor]
+    @ability = CanTango::Ability::Base.new @user
+  end
+
+  subject do
+    AdminAccountPermitBuilder.new @ability
+  end
+  
+  its(:permit_type) { should == :account_type }
+
+  describe 'build' do
+    its(:build) { should be_a CanTango::Permit::AccountType }
+  end
+
+  describe 'self.permit_type' do
+    specify { AdminAccountPermitBuilder.permit_type.should == :account_type }
+  end  
+end