zuul 0.1.1 → 0.2.0

data/lib/generators/zuul/orm_helpers.rb

@@ -0,0 +1,21 @@
+module Zuul
+  module Generators
+    module OrmHelpers
+      def model_exists?
+        File.exists?(File.join(destination_root, model_path))
+      end
+      
+      def migration_exists?(type, table_name)
+        Dir.glob("#{File.join(destination_root, migration_path)}/[0-9]*_*.rb").grep(/\d+_add_zuul_#{type.to_s}_to_#{table_name}.rb$/).first
+      end
+      
+      def migration_path
+        @migration_path ||= File.join("db", "migrate")
+      end
+
+      def model_path
+        @model_path ||= File.join("app", "models", "#{name.underscore}.rb")
+      end
+    end
+  end
+end

data/lib/generators/zuul/permission_generator.rb

@@ -0,0 +1,57 @@
+require 'rails/generators/active_record'
+require 'generators/zuul/orm_helpers'
+
+module ActiveRecord
+  module Zuul
+    module Generators
+      class PermissionGenerator < ActiveRecord::Generators::Base
+        remove_argument :name, :undefine => true
+        argument :name, :type => :string, :default => "Permission"
+        argument :attributes, :type => :array, :default => [], :banner => "field:type field:type"
+        namespace "zuul:permission"
+
+        include ::Zuul::Generators::OrmHelpers
+        source_root File.expand_path("../templates", __FILE__)
+
+        def copy_zuul_migration
+          if (behavior == :invoke && model_exists?) || (behavior == :revoke && migration_exists?(:permission, table_name))
+            migration_template "permission_existing.rb", "db/migrate/add_zuul_permission_to_#{table_name}"
+          else
+            migration_template "permission.rb", "db/migrate/zuul_permission_create_#{table_name}"
+          end
+        end
+
+        def generate_model
+          invoke "active_record:model", [name].concat(attributes.map {|attr| "#{attr.name}:#{attr.type}" }), :migration => false unless model_exists? && behavior == :invoke
+        end
+
+        def inject_zuul_content
+        content = <<CONTENT
+  # Setup authorization for your permission model
+  acts_as_authorization_permission
+CONTENT
+
+          class_path = if namespaced?
+            class_name.to_s.split("::")
+          else
+            [class_name]
+          end
+
+          indent_depth = class_path.size - 1
+          content = content.split("\n").map { |line| "  " * indent_depth + line } .join("\n") << "\n"
+
+          inject_into_class(model_path, class_path.last, content) if model_exists?
+        end
+
+        def migration_data
+<<RUBY
+      # Authorization permission columns
+      t.string  :slug
+      t.string  :context_type
+      t.integer :context_id
+RUBY
+        end
+      end
+    end
+  end
+end

data/lib/generators/zuul/permission_role_generator.rb

@@ -0,0 +1,40 @@
+require 'rails/generators/active_record'
+require 'generators/zuul/orm_helpers'
+
+module ActiveRecord
+  module Zuul
+    module Generators
+      class PermissionRoleGenerator < ActiveRecord::Generators::Base
+        remove_argument :name, :undefine => true
+        argument :permission_model, :type => :string, :default => "Permission"
+        argument :role_model, :type => :string, :default => "Role"
+        argument :attributes, :type => :array, :default => [], :banner => "field:type field:type"
+        namespace "zuul:permission_role"
+
+        include ::Zuul::Generators::OrmHelpers
+        source_root File.expand_path("../templates", __FILE__)
+
+        def name
+          [permission_model, role_model].sort.map(&:to_s).map(&:camelize).map(&:singularize).join("")
+        end
+        
+        def copy_permission_role_migration
+          attributes << Rails::Generators::GeneratedAttribute.new("#{permission_model.to_s.underscore.singularize}_id", :integer)
+          attributes << Rails::Generators::GeneratedAttribute.new("#{role_model.to_s.underscore.singularize}_id", :integer)
+          attributes << Rails::Generators::GeneratedAttribute.new("context_type", :string)
+          attributes << Rails::Generators::GeneratedAttribute.new("context_id", :integer)
+          
+          if (behavior == :invoke && model_exists?) || (behavior == :revoke && migration_exists?(:permission_role, table_name))
+            migration_template "permission_role_existing.rb", "db/migrate/add_zuul_permission_role_to_#{table_name}"
+          else
+            migration_template "permission_role.rb", "db/migrate/zuul_permission_role_create_#{table_name}"
+          end
+        end
+
+        def generate_model
+          invoke "active_record:model", [name].concat(attributes.map {|attr| "#{attr.name}:#{attr.type}" }), :migration => false unless model_exists? && behavior == :invoke
+        end
+      end
+    end
+  end
+end

data/lib/generators/zuul/permission_subject_generator.rb

@@ -0,0 +1,40 @@
+require 'rails/generators/active_record'
+require 'generators/zuul/orm_helpers'
+
+module ActiveRecord
+  module Zuul
+    module Generators
+      class PermissionSubjectGenerator < ActiveRecord::Generators::Base
+        remove_argument :name, :undefine => true
+        argument :permission_model, :type => :string, :default => "Permission"
+        argument :subject_model, :type => :string, :default => "User"
+        argument :attributes, :type => :array, :default => [], :banner => "field:type field:type"
+        namespace "zuul:permission_subject"
+
+        include ::Zuul::Generators::OrmHelpers
+        source_root File.expand_path("../templates", __FILE__)
+
+        def name
+          [permission_model, subject_model].sort.map(&:to_s).map(&:camelize).map(&:singularize).join("")
+        end
+        
+        def copy_permission_subject_migration
+          attributes << Rails::Generators::GeneratedAttribute.new("#{permission_model.to_s.underscore.singularize}_id", :integer)
+          attributes << Rails::Generators::GeneratedAttribute.new("#{subject_model.to_s.underscore.singularize}_id", :integer)
+          attributes << Rails::Generators::GeneratedAttribute.new("context_type", :string)
+          attributes << Rails::Generators::GeneratedAttribute.new("context_id", :integer)
+          
+          if (behavior == :invoke && model_exists?) || (behavior == :revoke && migration_exists?(:permission_subject, table_name))
+            migration_template "permission_subject_existing.rb", "db/migrate/add_zuul_permission_subject_to_#{table_name}"
+          else
+            migration_template "permission_subject.rb", "db/migrate/zuul_permission_subject_create_#{table_name}"
+          end
+        end
+
+        def generate_model
+          invoke "active_record:model", [name].concat(attributes.map {|attr| "#{attr.name}:#{attr.type}" }), :migration => false unless model_exists? && behavior == :invoke
+        end
+      end
+    end
+  end
+end

data/lib/generators/zuul/role_generator.rb

@@ -0,0 +1,58 @@
+require 'rails/generators/active_record'
+require 'generators/zuul/orm_helpers'
+
+module ActiveRecord
+  module Zuul
+    module Generators
+      class RoleGenerator < ActiveRecord::Generators::Base
+        remove_argument :name, :undefine => true
+        argument :name, :type => :string, :default => "Role"
+        argument :attributes, :type => :array, :default => [], :banner => "field:type field:type"
+        namespace "zuul:role"
+
+        include ::Zuul::Generators::OrmHelpers
+        source_root File.expand_path("../templates", __FILE__)
+        
+        def copy_role_migration
+          if (behavior == :invoke && model_exists?) || (behavior == :revoke && migration_exists?(:role, table_name))
+            migration_template "role_existing.rb", "db/migrate/add_zuul_role_to_#{table_name}"
+          else
+            migration_template "role.rb", "db/migrate/zuul_role_create_#{table_name}"
+          end
+        end
+
+        def generate_model
+          invoke "active_record:model", [name].concat(attributes.map {|attr| "#{attr.name}:#{attr.type}" }), :migration => false unless model_exists? && behavior == :invoke
+        end
+
+        def inject_role_content
+          content = <<CONTENT
+  # Setup authorization for your role model
+  acts_as_authorization_role
+CONTENT
+
+          class_path = if namespaced?
+            class_name.to_s.split("::")
+          else
+            [class_name]
+          end
+
+          indent_depth = class_path.size - 1
+          content = content.split("\n").map { |line| "  " * indent_depth + line } .join("\n") << "\n"
+
+          inject_into_class(model_path, class_path.last, content) if model_exists?
+        end
+
+        def migration_data
+<<RUBY
+      ## Authorization role columns
+      t.string  :slug
+      t.integer :level
+      t.string  :context_type
+      t.integer :context_id
+RUBY
+        end
+      end
+    end
+  end
+end

data/lib/generators/zuul/role_subject_generator.rb

@@ -0,0 +1,40 @@
+require 'rails/generators/active_record'
+require 'generators/zuul/orm_helpers'
+
+module ActiveRecord
+  module Zuul
+    module Generators
+      class RoleSubjectGenerator < ActiveRecord::Generators::Base
+        remove_argument :name, :undefine => true
+        argument :role_model, :type => :string, :default => "Role"
+        argument :subject_model, :type => :string, :default => "User"
+        argument :attributes, :type => :array, :default => [], :banner => "field:type field:type"
+        namespace "zuul:role_subject"
+
+        include ::Zuul::Generators::OrmHelpers
+        source_root File.expand_path("../templates", __FILE__)
+
+        def name
+          [role_model, subject_model].sort.map(&:to_s).map(&:camelize).map(&:singularize).join("")
+        end
+        
+        def copy_role_subject_migration
+          attributes << Rails::Generators::GeneratedAttribute.new("#{role_model.to_s.underscore.singularize}_id", :integer)
+          attributes << Rails::Generators::GeneratedAttribute.new("#{subject_model.to_s.underscore.singularize}_id", :integer)
+          attributes << Rails::Generators::GeneratedAttribute.new("context_type", :string)
+          attributes << Rails::Generators::GeneratedAttribute.new("context_id", :integer)
+          
+          if (behavior == :invoke && model_exists?) || (behavior == :revoke && migration_exists?(:role_subject, table_name))
+            migration_template "role_subject_existing.rb", "db/migrate/add_zuul_role_subject_to_#{table_name}"
+          else
+            migration_template "role_subject.rb", "db/migrate/zuul_role_subject_create_#{table_name}"
+          end
+        end
+
+        def generate_model
+          invoke "active_record:model", [name].concat(attributes.map {|attr| "#{attr.name}:#{attr.type}" }), :migration => false unless model_exists? && behavior == :invoke
+        end
+      end
+    end
+  end
+end

data/lib/generators/zuul/subject_generator.rb

@@ -0,0 +1,39 @@
+require 'rails/generators/active_record'
+require 'generators/zuul/orm_helpers'
+
+module ActiveRecord
+  module Zuul
+    module Generators
+      class SubjectGenerator < ActiveRecord::Generators::Base
+        remove_argument :name, :undefine => true
+        argument :name, :type => :string, :default => "User"
+        argument :attributes, :type => :array, :default => [], :banner => "field:type field:type"
+        namespace "zuul:subject"
+
+        include ::Zuul::Generators::OrmHelpers
+
+        def generate_model
+          invoke "active_record:model", [name].concat(attributes.map {|attr| "#{attr.name}:#{attr.type}" }), :migration => true unless model_exists? && behavior == :invoke
+        end
+
+        def inject_zuul_content
+          content = <<CONTENT
+  # Setup authorization for your subject model
+  acts_as_authorization_subject
+CONTENT
+
+          class_path = if namespaced?
+            class_name.to_s.split("::")
+          else
+            [class_name]
+          end
+
+          indent_depth = class_path.size - 1
+          content = content.split("\n").map { |line| "  " * indent_depth + line } .join("\n") << "\n"
+
+          inject_into_class(model_path, class_path.last, content) if model_exists?
+        end
+      end
+    end
+  end
+end

data/lib/generators/zuul/templates/permission.rb

@@ -0,0 +1,18 @@
+class ZuulPermissionCreate<%= table_name.camelize %> < ActiveRecord::Migration
+  def change
+    create_table(:<%= table_name %>) do |t|
+<%= migration_data -%>
+
+<% attributes.each do |attribute| -%>
+      t.<%= attribute.type %> :<%= attribute.name %>
+<% end -%>
+
+      t.timestamps
+    end
+
+    add_index :<%= table_name %>, :slug
+    add_index :<%= table_name %>, :context_type
+    add_index :<%= table_name %>, :context_id
+    add_index :<%= table_name %>, [:slug, :context_type, :context_id],  :unique => true
+  end
+end

data/lib/generators/zuul/templates/permission_existing.rb

@@ -0,0 +1,25 @@
+class AddZuulPermissionTo<%= table_name.camelize %> < ActiveRecord::Migration
+  def self.up
+    change_table(:<%= table_name %>) do |t|
+<%= migration_data -%>
+
+<% attributes.each do |attribute| -%>
+      t.<%= attribute.type %> :<%= attribute.name %>
+<% end -%>
+
+      # Uncomment below if timestamps were not included in your original model.
+      # t.timestamps
+    end
+
+    add_index :<%= table_name %>, :slug
+    add_index :<%= table_name %>, :context_type
+    add_index :<%= table_name %>, :context_id
+    add_index :<%= table_name %>, [:slug, :context_type, :context_id],  :unique => true
+  end
+
+  def self.down
+    # By default, we don't want to make any assumption about how to roll back a migration when your
+    # model already existed. Please edit below which fields you would like to remove in this migration.
+    raise ActiveRecord::IrreversibleMigration
+  end
+end

data/lib/generators/zuul/templates/permission_role.rb

@@ -0,0 +1,17 @@
+class ZuulPermissionRoleCreate<%= table_name.camelize %> < ActiveRecord::Migration
+  def change
+    create_table(:<%= table_name %>) do |t|
+<% attributes.each do |attribute| -%>
+      t.<%= attribute.type %> :<%= attribute.name %>
+<% end -%>
+
+      t.timestamps
+    end
+
+    add_index :<%= table_name %>, :<%= permission_model.to_s.underscore.singularize %>_id
+    add_index :<%= table_name %>, :<%= role_model.to_s.underscore.singularize %>_id
+    add_index :<%= table_name %>, :context_type
+    add_index :<%= table_name %>, :context_id
+    add_index :<%= table_name %>, [:<%= permission_model.to_s.underscore.singularize %>_id, :<%= role_model.to_s.underscore.singularize %>_id, :context_type, :context_id], :unique => true, :name => 'index_<%= table_name %>_on_<%= permission_model.to_s.underscore.singularize %>_and_<%= role_model.to_s.underscore.singularize %>_and_context'
+  end
+end

data/lib/generators/zuul/templates/permission_role_existing.rb

@@ -0,0 +1,24 @@
+class AddZuulPermissionRoleTo<%= table_name.camelize %> < ActiveRecord::Migration
+  def self.up
+    change_table(:<%= table_name %>) do |t|
+<% attributes.each do |attribute| -%>
+      t.<%= attribute.type %> :<%= attribute.name %>
+<% end -%>
+
+      # Uncomment below if timestamps were not included in your original model.
+      # t.timestamps
+    end
+
+    add_index :<%= table_name %>, :<%= permission_model.to_s.underscore.singularize %>_id
+    add_index :<%= table_name %>, :<%= role_model.to_s.underscore.singularize %>_id
+    add_index :<%= table_name %>, :context_type
+    add_index :<%= table_name %>, :context_id
+    add_index :<%= table_name %>, [:<%= permission_model.to_s.underscore.singularize %>_id, :<%= role_model.to_s.underscore.singularize %>_id, :context_type, :context_id], :unique => true, :name => 'index_<%= table_name %>_on_<%= permission_model.to_s.underscore.singularize %>_and_<%= role_model.to_s.underscore.singularize %>_and_context'
+  end
+
+  def self.down
+    # By default, we don't want to make any assumption about how to roll back a migration when your
+    # model already existed. Please edit below which fields you would like to remove in this migration.
+    raise ActiveRecord::IrreversibleMigration
+  end
+end

data/lib/generators/zuul/templates/permission_subject.rb

@@ -0,0 +1,17 @@
+class ZuulPermissionSubjectCreate<%= table_name.camelize %> < ActiveRecord::Migration
+  def change
+    create_table(:<%= table_name %>) do |t|
+<% attributes.each do |attribute| -%>
+      t.<%= attribute.type %> :<%= attribute.name %>
+<% end -%>
+
+      t.timestamps
+    end
+
+    add_index :<%= table_name %>, :<%= permission_model.to_s.underscore.singularize %>_id
+    add_index :<%= table_name %>, :<%= subject_model.to_s.underscore.singularize %>_id
+    add_index :<%= table_name %>, :context_type
+    add_index :<%= table_name %>, :context_id
+    add_index :<%= table_name %>, [:<%= permission_model.to_s.underscore.singularize %>_id, :<%= subject_model.to_s.underscore.singularize %>_id, :context_type, :context_id], :unique => true, :name => 'index_<%= table_name %>_on_<%= permission_model.to_s.underscore.singularize %>_and_<%= subject_model.to_s.underscore.singularize %>_and_context'
+  end
+end

data/lib/generators/zuul/templates/permission_subject_existing.rb

@@ -0,0 +1,24 @@
+class AddZuulPermissionSubjectTo<%= table_name.camelize %> < ActiveRecord::Migration
+  def self.up
+    change_table(:<%= table_name %>) do |t|
+<% attributes.each do |attribute| -%>
+      t.<%= attribute.type %> :<%= attribute.name %>
+<% end -%>
+
+      # Uncomment below if timestamps were not included in your original model.
+      # t.timestamps
+    end
+
+    add_index :<%= table_name %>, :<%= permission_model.to_s.underscore.singularize %>_id
+    add_index :<%= table_name %>, :<%= subject_model.to_s.underscore.singularize %>_id
+    add_index :<%= table_name %>, :context_type
+    add_index :<%= table_name %>, :context_id
+    add_index :<%= table_name %>, [:<%= permission_model.to_s.underscore.singularize %>_id, :<%= subject_model.to_s.underscore.singularize %>_id, :context_type, :context_id], :unique => true, :name => 'index_<%= table_name %>_on_<%= permission_model.to_s.underscore.singularize %>_and_<%= subject_model.to_s.underscore.singularize %>_and_context'
+  end
+
+  def self.down
+    # By default, we don't want to make any assumption about how to roll back a migration when your
+    # model already existed. Please edit below which fields you would like to remove in this migration.
+    raise ActiveRecord::IrreversibleMigration
+  end
+end

data/lib/generators/zuul/templates/role.rb

@@ -0,0 +1,20 @@
+class ZuulRoleCreate<%= table_name.camelize %> < ActiveRecord::Migration
+  def change
+    create_table(:<%= table_name %>) do |t|
+<%= migration_data -%>
+
+<% attributes.each do |attribute| -%>
+      t.<%= attribute.type %> :<%= attribute.name %>
+<% end -%>
+
+      t.timestamps
+    end
+
+    add_index :<%= table_name %>, :slug
+    add_index :<%= table_name %>, :level
+    add_index :<%= table_name %>, :context_type
+    add_index :<%= table_name %>, :context_id
+    add_index :<%= table_name %>, [:slug, :context_type, :context_id],  :unique => true
+    add_index :<%= table_name %>, [:level, :context_type, :context_id], :unique => true
+  end
+end