cantango 0.8.0

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

@@ -0,0 +1,10 @@
+class <%= name.to_s.camelize %>License < CanTango::PermitEngine::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 '' 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,31 @@
+require 'rails/generators/base'
+require 'sugar-high/array'
+require 'active_support/inflector'
+require 'rails_artifactor'
+
+module CanTango
+  module Generators
+    class LicensesGenerator < Rails::Generators::Base
+      desc "Creates Licenses for use with CanCan Permits"
+
+      argument     :licenses,           :type => :array,      :default => [],     :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,36 @@
+module CanTango
+  module Generators
+    module PermitGenerator
+
+      def template_permit role, account = nil
+        template_account_permit role, account if account
+        template permit_source, "app/permits/#{permit_target(role)}" unless account
+      end
+
+      def template_account_permit role, account
+        template "account_permit.erb" , "app/permits/#{account}_permits/#{permit_target(role)}"
+      end
+
+      def load_permit_template name
+        template = ERB.new File.open(template_filepath).read
+        template.result(binding)
+      end
+
+      def template_filepath
+        File.join source_path, permit_source
+      end
+
+      def source_path
+        source_paths.first
+      end
+
+      def permit_source
+        group? ? "role_group_permit.erb" : "role_permit.erb"
+      end
+
+      def permit_target role
+        group? ? "#{role}_group_permit.rb" : "#{role}_permit.rb"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+require 'rails/generators/base'
+require 'sugar-high/array'
+require 'active_support/inflector'
+require 'rails_artifactor'
+# require 'logging_assist'
+#
+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,   :default => '',     :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
+        return if role.empty?
+        template_permit role
+      end
+
+      protected
+
+      include CanTango::Generators::Base
+      include CanTango::Generators::LicenceBase
+
+      def group?
+        options[:group]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,4 @@
+module <%= account%>Permits
+  <%= load_permit_template :role_permit %>
+end
+

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

@@ -0,0 +1,14 @@
+class <%= role_group.to_s.camelize %>RoleGroupPermit < CanTango::PermitEngine::RoleGroupPermit
+  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
+end
+

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

@@ -0,0 +1,13 @@
+class <%= role.to_s.camelize %>RolePermit < CanTango::PermitEngine::RolePermit
+  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
+end

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

@@ -0,0 +1,127 @@
+require 'rails/generators/base'
+require 'sugar-high/array'
+require 'active_support/inflector'
+require 'rails_artifactor'
+# require 'logging_assist'
+
+module CanTango
+  module Generators
+    class PermitsGenerator < 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,      :default => [],
+          :desc => "Roles to create permits for"
+
+      # ORM to use
+      class_option :orm,              :type => :string,     :default => 'active_record',
+          :desc => "ORM to use"
+
+      class_option :initializer,      :type => :boolean,    :default => true,
+          :desc => "Create Permits initializer"
+
+      class_option :default_permits,  :type => :boolean,    :default => true,
+          :desc => "Create default permits for guest and admin roles"
+
+      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
+        default_roles.each do |role|
+          template_permit role
+        end
+
+        template_permit :any
+        template_permit :system
+
+        permit_logic = base_logic
+        get_roles.each do |role|
+          template_permit(role) if !skip_permit?(role)
+        end
+
+        permits_initializer if permits_initializer?
+      end
+
+      protected
+
+      include PermitGenerator
+
+      extend RailsAssist::UseMacro
+
+      use_helpers :app, :file, :special
+
+      attr_accessor :permit_name, :permit_logic
+
+      def default_roles
+        [:guest, :admin]
+      end
+
+      def permits_initializer?
+        options[:initializer]
+      end
+
+      def skip_permit? permit
+        default_permits? && default_roles.include?(permit.to_sym) 
+      end
+
+
+      # TODO: merge with any registered roles in application
+      def get_roles
+        roles.uniq.to_symbols
+      end
+
+      def default_permits?
+        options[:default_permits]
+      end
+
+      def orm
+        options[:orm]
+      end
+
+      def permits_initializer
+        create_initializer :permits do
+          %Q{CanTango.configure do |config|
+  config.orm = :#{orm}
+end
+}
+        end
+      end
+
+      def template_permit role, template_name=nil
+        if permit_roles.include?(role)
+          meth = "#{role}_logic"
+          self.permit_logic = respond_to?(meth) ? send(meth) : base_logic
+        end
+        self.permit_name = role
+        template_permit role
+      end 
+
+      private
+
+      def permit_roles
+        [:admin, :guest, :any, :system]
+      end
+
+      def base_logic
+        %{
+   }
+      end
+
+      def admin_logic
+        %{
+          can :manage, :all
+    }
+      end
+
+      def guest_logic
+        %{
+          can :read, :all
+    }
+      end
+    end
+  end
+end

data/spec/Note_on_licenses.textile

@@ -0,0 +1,44 @@
+h1. Note on licenses.
+
+First, your design "note":https://github.com/kristianmandrup/tango/blob/permission_store/spec/tango/permission/PERMISSION_STORE.textile :
+
+"Note that licenses are just named subsets of rules and can thus be reused for both roles and role_groups."
+
+<pre>
+class AdminPermit
+
+  def set_permission_rules
+    licenses :bloggers, :admins
+    can :manage, User
+  end
+end
+</pre>
+
+
+
+<pre>
+class BloggersLicense
+  def enforce!
+    can :manage, [Article, Post]
+  end
+end
+</pre>
+
+maybe rename method to use the same convention. Maybe the method name _enforce!_ is better? or _enforce_rules!_ perhaps?
+
+User permissions:
+
+<pre>
+users:
+  kmandrup:
+    can:
+      manage: [Article, Pot]
+    cannot
+      read: [Secret]
+  stanislaw
+    can:
+      manage: all
+</pre>
+
+Rules for individual Users. They key needs to be a unique identifier for each user, either email or username.
+

data/spec/Refactor_into_engines.textile

@@ -0,0 +1,115 @@
+h1. Refactoring into engines
+
+Thinking about how to build permissions factory & collection & evaluation stack I realized that some mediator level beetween Ability and Permission is needed:
+
+1) Many classes in permissions folder were really not on the same logical level as permission: fx YamlStore, Factory, Evaluator and some others - they shared not the logical level of permission but some level before/above? it and thus I thought to take a risk creating such level. ;)
+
+2) Obviously, it should be a possibility there (already done!) to turn off permits or/and permissions evaluation. This was the second reason - it is about logical levels management again - consider these nice "if permit_engine_on? and if permission_engine_on?" allowing to turn off one or both of the engines. 
+Doing fx CanTango.permit_engine_on = false - you disable the whole engine level, not the level of permission itself! (see lib/tango/ability.rb)
+
+3) Structure of lib/tango folder before switching to refactor_into_engines branch:
+
+<pre>
+  stanislaw stanislaw   80 Jul 16 15:34 ability
+  stanislaw stanislaw 2283 Jul 18 21:47 ability.rb
+  stanislaw stanislaw   80 Jul 18 21:47 configuration
+  stanislaw stanislaw 1503 Jul 18 21:47 configuration.rb
+  stanislaw stanislaw  128 Jul 16 21:19 license
+  stanislaw stanislaw   83 Jul 13 19:21 license.rb
+  stanislaw stanislaw  136 Jul 18 21:47 loader
+  stanislaw stanislaw   93 Jul 18 21:47 loader.rb
+  stanislaw stanislaw  153 Jul 13 19:21 macros.rb
+  stanislaw stanislaw  304 Jul 13 19:22 masquerade.rb
+  stanislaw stanislaw  112 Jul 18 21:47 parser
+  stanislaw stanislaw   85 Jul 13 19:21 parser.rb
+  stanislaw stanislaw  352 Jul 18 21:47 permission
+  stanislaw stanislaw   88 Jul 18 21:47 permission_engine
+  stanislaw stanislaw  918 Jul 18 21:47 permission.rb
+  stanislaw stanislaw  392 Jul 18 21:47 permit
+  stanislaw stanislaw  181 Jul 18 21:47 permit.rb
+  stanislaw stanislaw  112 Jul 18 21:47 role_group_permit
+  stanislaw stanislaw 1014 Jul 18 21:47 role_group_permit.rb
+  stanislaw stanislaw  112 Jul 18 21:47 role_permit
+  stanislaw stanislaw  989 Jul 18 21:47 role_permit.rb
+  stanislaw stanislaw  136 Jul 16 20:49 rspec
+  stanislaw stanislaw   28 Jul 13 19:21 rspec.rb
+  stanislaw stanislaw  179 Jul 18 21:47 rule_class.rb
+  stanislaw stanislaw  128 Jul 18 21:47 rules
+  stanislaw stanislaw  730 Jul 18 21:47 rules.rb
+  stanislaw stanislaw  389 Jul 13 19:22 user_account.rb
+  stanislaw stanislaw  468 Jul 13 19:22 user.rb
+</pre>
+
+
+Consider present structure of lib/tango folder:
+
+<pre>
+  stanislaw stanislaw   80 Jul 16 15:34 ability
+  stanislaw stanislaw 2435 Jul 18 09:07 ability.rb
+  stanislaw stanislaw   80 Jul 18 04:43 configuration
+  stanislaw stanislaw 1509 Jul 18 08:46 configuration.rb
+  stanislaw stanislaw  128 Jul 16 21:19 license
+  stanislaw stanislaw   83 Jul 13 19:21 license.rb
+  stanislaw stanislaw  153 Jul 13 19:21 macros.rb
+  stanislaw stanislaw  304 Jul 13 19:22 masquerade.rb
+  stanislaw stanislaw  112 Jul 18 05:00 parser
+  stanislaw stanislaw   85 Jul 13 19:21 parser.rb
+  stanislaw stanislaw  480 Jul 18 08:34 permission_engine
+  stanislaw stanislaw  193 Jul 17 01:46 permission_engine.rb
+  stanislaw stanislaw  544 Jul 17 08:07 permit_engine
+  stanislaw stanislaw  242 Jul 17 02:36 permit_engine.rb
+  stanislaw stanislaw  136 Jul 16 20:49 rspec
+  stanislaw stanislaw   28 Jul 13 19:21 rspec.rb
+  stanislaw stanislaw  160 Jul 18 07:58 rules
+  stanislaw stanislaw  749 Jul 18 08:23 rules.rb
+  stanislaw stanislaw  389 Jul 13 19:22 user_account.rb
+  stanislaw stanislaw  468 Jul 13 19:22 user.rb
+</pre>
+
+license* here should be deprecated or removed - they are not used anymore!
+parser* should be moved into PermissionEngine too because of it is dealing only with permissions & categories. I hadn't enough time to do that.
+
+The resulting structure will be like that:
+
+<pre>
+  stanislaw stanislaw   80 Jul 16 15:34 ability
+  stanislaw stanislaw 2435 Jul 18 09:07 ability.rb
+  stanislaw stanislaw   80 Jul 18 04:43 configuration
+  stanislaw stanislaw 1509 Jul 18 08:46 configuration.rb
+  stanislaw stanislaw  153 Jul 13 19:21 macros.rb
+  stanislaw stanislaw  304 Jul 13 19:22 masquerade.rb
+  stanislaw stanislaw  480 Jul 18 08:34 permission_engine
+  stanislaw stanislaw  193 Jul 17 01:46 permission_engine.rb
+  stanislaw stanislaw  544 Jul 17 08:07 permit_engine
+  stanislaw stanislaw  242 Jul 17 02:36 permit_engine.rb
+  stanislaw stanislaw  136 Jul 16 20:49 rspec
+  stanislaw stanislaw   28 Jul 13 19:21 rspec.rb
+  stanislaw stanislaw  160 Jul 18 07:58 rules
+  stanislaw stanislaw  749 Jul 18 08:23 rules.rb
+  stanislaw stanislaw  389 Jul 13 19:22 user_account.rb
+  stanislaw stanislaw  468 Jul 13 19:22 user.rb
+</pre>
+
+This way we have very clean main logical level. Then we can move user, user_account, masquerade and may be macros to some level like "Users" :
+
+<pre>
+  stanislaw stanislaw   80 Jul 16 15:34 ability
+  stanislaw stanislaw 2435 Jul 18 09:07 ability.rb
+  stanislaw stanislaw   80 Jul 18 04:43 configuration
+  stanislaw stanislaw 1509 Jul 18 08:46 configuration.rb
+  stanislaw stanislaw  480 Jul 18 08:34 permission_engine
+  stanislaw stanislaw  193 Jul 17 01:46 permission_engine.rb
+  stanislaw stanislaw  544 Jul 17 08:07 permit_engine
+  stanislaw stanislaw  242 Jul 17 02:36 permit_engine.rb
+  stanislaw stanislaw  136 Jul 16 20:49 rspec
+  stanislaw stanislaw   28 Jul 13 19:21 rspec.rb
+  stanislaw stanislaw  160 Jul 18 07:58 rules
+  stanislaw stanislaw  749 Jul 18 08:23 rules.rb
+  stanislaw stanislaw  389 Jul 13 19:22 users
+  stanislaw stanislaw  468 Jul 13 19:22 users.rb
+</pre>
+
+
+The structure will then impress me the way like I had when I first saw precise devise structure.
+I think it is really makes sense!!!
+