cbac 0.6.1 → 0.6.2

data/lib/cbac/privilege_new_api.rb

@@ -1,56 +1,56 @@
-# New API interface for CBAC system
-#
-# Changelog
-# 101022  Bert Meerman    Initial commit
-#
-
-module Cbac
-  # Starts a privileges and privilegeset declaration block
-  def cbac(&block)
-    # Defines a new privilegeset
-    def set(name, description, &block)
-
-      # Adds a post declaration
-      def post(controller, *methods)
-        raise "Cannot add privilege without a set" unless @current_set_name
-        methods.each {|method|
-          Privilege.resource @current_set_name, @cbac_namespace.to_s + controller.to_s + "/" + method.to_s, :post
-        }
-      end
-
-      # Adds a get declaration
-      def get(controller, *methods)
-        raise "Cannot add privilege without a set" unless @current_set_name
-        methods.each {|method|
-          Privilege.resource @current_set_name, @cbac_namespace.to_s + controller.to_s + "/" + method.to_s, :get
-        }
-      end
-
-      # Includes the stuff from another set
-      def includes(*set)
-        raise "includes is not yet supported"
-      end
-
-      raise "Cannot embed a set in another set"  if @current_set
-      name = name.to_sym
-      description = description.to_str
-      PrivilegeSet.add(name, description)
-      @current_set = PrivilegeSet.sets[name]
-      @current_set_name = name
-      yield block
-      @current_set = nil
-      @current_set_name = nil
-    end
-
-    # Start an additional namespace declaration
-    def in_module (name, &block)
-      current_namespace = @cbac_namespace
-      @cbac_namespace = @cbac_namespace.to_s + name.to_s + "/"
-      yield block
-      @cbac_namespace = current_namespace
-    end
-
-    # Runs the block
-    yield block
-  end
-end
+# New API interface for CBAC system
+#
+# Changelog
+# 101022  Bert Meerman    Initial commit
+#
+
+module Cbac
+  # Starts a privileges and privilegeset declaration block
+  def cbac(&block)
+    # Defines a new privilegeset
+    def set(name, description, &block)
+
+      # Adds a post declaration
+      def post(controller, *methods)
+        raise "Cannot add privilege without a set" unless @current_set_name
+        methods.each {|method|
+          Privilege.resource @current_set_name, @cbac_namespace.to_s + controller.to_s + "/" + method.to_s, :post
+        }
+      end
+
+      # Adds a get declaration
+      def get(controller, *methods)
+        raise "Cannot add privilege without a set" unless @current_set_name
+        methods.each {|method|
+          Privilege.resource @current_set_name, @cbac_namespace.to_s + controller.to_s + "/" + method.to_s, :get
+        }
+      end
+
+      # Includes the stuff from another set
+      def includes(*set)
+        raise "includes is not yet supported"
+      end
+
+      raise "Cannot embed a set in another set"  if @current_set
+      name = name.to_sym
+      description = description.to_str
+      PrivilegeSet.add(name, description)
+      @current_set = PrivilegeSet.sets[name]
+      @current_set_name = name
+      yield block
+      @current_set = nil
+      @current_set_name = nil
+    end
+
+    # Start an additional namespace declaration
+    def in_module (name, &block)
+      current_namespace = @cbac_namespace
+      @cbac_namespace = @cbac_namespace.to_s + name.to_s + "/"
+      yield block
+      @cbac_namespace = current_namespace
+    end
+
+    # Runs the block
+    yield block
+  end
+end

data/lib/cbac/privilege_set.rb

@@ -1,29 +1,29 @@
-# Defines sets of privileges
-#
-# To create a new set: PrivilegeSet.add :set_name, "Some comment on what this
-# set does"
-#
-# To retrieve a privilegeset, use the sets attribute. This is a Hash containing
-# PrivilegeSetRecords. Usage: PrivilegeSet.sets(:set_name). If the PrivilegeSet
-# already exists, an ArgumentError is thrown stating the set was already
-# defined.
-class Cbac::PrivilegeSet
-  class << self
-    # Hash containing all the PrivilegeSetRecords
-    attr_reader :sets
-
-    # Create a new PrivilegeSet
-    def add(symbol, comment)
-      # initialize variables (if applicable)
-      @sets = Hash.new if @sets.nil?
-      # check for double creation
-      raise ArgumentError, "CBAC: PrivilegeSet was already defined: #{symbol.to_s}" if @sets.include?(symbol)
-      # Create record if privilege set doesn't exist
-      record = Cbac::PrivilegeSetRecord.find_or_create_by_name(symbol.to_s)
-      record.set_comment(comment)
-      record.save
-
-      @sets[symbol] = record
-    end
-  end
-end
+# Defines sets of privileges
+#
+# To create a new set: PrivilegeSet.add :set_name, "Some comment on what this
+# set does"
+#
+# To retrieve a privilegeset, use the sets attribute. This is a Hash containing
+# PrivilegeSetRecords. Usage: PrivilegeSet.sets(:set_name). If the PrivilegeSet
+# already exists, an ArgumentError is thrown stating the set was already
+# defined.
+class Cbac::PrivilegeSet
+  class << self
+    # Hash containing all the PrivilegeSetRecords
+    attr_reader :sets
+
+    # Create a new PrivilegeSet
+    def add(symbol, comment)
+      # initialize variables (if applicable)
+      @sets = Hash.new if @sets.nil?
+      # check for double creation
+      raise ArgumentError, "CBAC: PrivilegeSet was already defined: #{symbol.to_s}" if @sets.include?(symbol)
+      # Create record if privilege set doesn't exist
+      record = Cbac::PrivilegeSetRecord.find_or_create_by_name(symbol.to_s)
+      record.set_comment(comment)
+      record.save
+
+      @sets[symbol] = record
+    end
+  end
+end

data/lib/cbac/privilege_set_record.rb

@@ -1,7 +1,7 @@
-class Cbac::PrivilegeSetRecord < ActiveRecord::Base
-  set_table_name "cbac_privilege_set"
-
-  def set_comment(comment)
-    self.comment = comment if has_attribute?("comment")    
-  end
+class Cbac::PrivilegeSetRecord < ActiveRecord::Base
+  set_table_name "cbac_privilege_set"
+
+  def set_comment(comment)
+    self.comment = comment if has_attribute?("comment")    
+  end
 end

data/lib/cbac/setup.rb

@@ -1,38 +1,38 @@
-
-module Cbac
-  # Class performs various functions specific to the CBAC system itself. Most
-  # important function is to check if the system is initialized; without proper
-  # initialization, the bootstrapper will crash.
-  class Setup
-    class << self
-
-      # Check to see if the tables are correctly migrated. If the tables are not
-      # migrated, CBAC should terminate immediately.
-      def check_tables
-        # It is possible that there is no database connection yet. In that case, the table_exist call will fail
-        begin
-          return false unless Cbac::PrivilegeSetRecord.table_exists?
-        rescue ActiveRecord::ConnectionNotEstablished
-          puts "CBAC: Connection to database not established when initializing Cbac. Cbac is *not* running."
-          return false
-        end
-        return false unless Cbac::GenericRole.table_exists?
-        return false unless Cbac::Membership.table_exists?
-        return false unless Cbac::Permission.table_exists?
-        true
-      end
-
-      # Checks if the system is properly setup. This method is used by the
-      # bootstrapper to see if the system should be initialized. If the system
-      # is not properly setup, the bootstrapper will crash. Checks are performed
-      # to see if all the tables exists.
-      def check
-        if check_tables == false
-          puts "CBAC: not properly initialized: one or more tables are missing. Did you install it correctly? (run generate)"
-          return false
-        end
-        true
-      end
-    end
-  end
+
+module Cbac
+  # Class performs various functions specific to the CBAC system itself. Most
+  # important function is to check if the system is initialized; without proper
+  # initialization, the bootstrapper will crash.
+  class Setup
+    class << self
+
+      # Check to see if the tables are correctly migrated. If the tables are not
+      # migrated, CBAC should terminate immediately.
+      def check_tables
+        # It is possible that there is no database connection yet. In that case, the table_exist call will fail
+        begin
+          return false unless Cbac::PrivilegeSetRecord.table_exists?
+        rescue ActiveRecord::ConnectionNotEstablished
+          puts "CBAC: Connection to database not established when initializing Cbac. Cbac is *not* running."
+          return false
+        end
+        return false unless Cbac::GenericRole.table_exists?
+        return false unless Cbac::Membership.table_exists?
+        return false unless Cbac::Permission.table_exists?
+        true
+      end
+
+      # Checks if the system is properly setup. This method is used by the
+      # bootstrapper to see if the system should be initialized. If the system
+      # is not properly setup, the bootstrapper will crash. Checks are performed
+      # to see if all the tables exists.
+      def check
+        if check_tables == false
+          puts "CBAC: not properly initialized: one or more tables are missing. Did you install it correctly? (run generate)"
+          return false
+        end
+        true
+      end
+    end
+  end
 end

data/lib/generators/cbac/USAGE

@@ -1,34 +1,34 @@
-NAME
-     cbac - Generator scripts for the Context Based Access Control system
-
-SYNOPSIS
-     cbac
-     
-DESCRIPTION
-     This generator creates the basic setup for the CBAC system.
-
-     Included:
-      - config/privileges.rb
-      - config/context_roles.rb
-      - db/migrate/create_cbac.rb
-      - app/controllers/cbac/generic_roles_controller.rb
-      - app/controllers/cbac/memberships_controller.rb
-      - app/controllers/cbac/permissions_controller.rb
-      - app/views/layouts/cbac.html.erb
-      - app/views/cbac/generic_roles/index.html.erb
-      - app/views/cbac/memberships/index.html.erb
-      - app/views/cbac/memberships/_update.html.erb
-      - app/views/cbac/permissions/index.html.erb
-      - app/views/cbac/permissions/_update.html.erb
-      - public/stylesheets/cbac.css
-      - test/fixtures/cbac_permissions.yml
-      - test/fixtures/cbac_generic_roles.yml
-      - test/fixtures/cbac_memberships.yml
-
-            
-EXAMPLE
-      ./script/generate cbac
-
-MORE INFO
-	http://cbac.rubyforge.org/
+NAME
+     cbac - Generator scripts for the Context Based Access Control system
+
+SYNOPSIS
+     cbac
+     
+DESCRIPTION
+     This generator creates the basic setup for the CBAC system.
+
+     Included:
+      - config/privileges.rb
+      - config/context_roles.rb
+      - db/migrate/create_cbac.rb
+      - app/controllers/cbac/generic_roles_controller.rb
+      - app/controllers/cbac/memberships_controller.rb
+      - app/controllers/cbac/permissions_controller.rb
+      - app/views/layouts/cbac.html.erb
+      - app/views/cbac/generic_roles/index.html.erb
+      - app/views/cbac/memberships/index.html.erb
+      - app/views/cbac/memberships/_update.html.erb
+      - app/views/cbac/permissions/index.html.erb
+      - app/views/cbac/permissions/_update.html.erb
+      - public/stylesheets/cbac.css
+      - test/fixtures/cbac_permissions.yml
+      - test/fixtures/cbac_generic_roles.yml
+      - test/fixtures/cbac_memberships.yml
+
+            
+EXAMPLE
+      ./script/generate cbac
+
+MORE INFO
+	http://cbac.rubyforge.org/
 	

data/lib/generators/cbac/cbac_generator.rb

@@ -1,75 +1,75 @@
-require 'rbconfig'
-
-class CbacGenerator < Rails::Generators::Base
-  include Rails::Generators::Migration
-
-  def self.source_root
-    @source_root ||= File.join(File.dirname(__FILE__), 'copy_files')
-  end
-
-  # Implement the required interface for Rails::Generators::Migration.
-  # taken from http://github.com/rails/rails/blob/master/activerecord/lib/generators/active_record.rb
-  def self.next_migration_number(dirname)
-    if ActiveRecord::Base.timestamped_migrations
-      Time.now.utc.strftime("%Y%m%d%H%M%S")
-    else
-      "%.3d" % (current_migration_number(dirname) + 1)
-    end
-  end
-   
-  def manifest
-    puts Dir.getwd
-
-    # developer files
-    empty_directory "config/cbac"
-    copy_file "config/privileges.rb", "config/cbac/privileges.rb", :collision => :skip
-    copy_file "config/context_roles.rb", "config/cbac/context_roles.rb", :collision => :skip
-
-    # deployment file
-    copy_file "config/cbac.pristine", "config/cbac/cbac.pristine", :collision => :skip
-
-    # administration pages
-    empty_directory "app/controllers/cbac"
-    copy_file "controllers/permissions_controller.rb", "app/controllers/cbac/permissions_controller.rb"
-    copy_file "controllers/generic_roles_controller.rb", "app/controllers/cbac/generic_roles_controller.rb"
-    copy_file "controllers/memberships_controller.rb", "app/controllers/cbac/memberships_controller.rb"
-    copy_file "controllers/upgrade_controller.rb", "app/controllers/cbac/upgrade_controller.rb"
-    empty_directory "app/views/layouts"
-    copy_file "views/layouts/cbac.html.erb", "app/views/layouts/cbac.html.erb"
-    empty_directory "app/views/cbac"
-    empty_directory "app/views/cbac/permissions"
-    empty_directory "app/views/cbac/generic_roles"
-    empty_directory "app/views/cbac/memberships"
-    empty_directory "app/views/cbac/upgrade"
-    copy_file "views/permissions/index.html.erb", "app/views/cbac/permissions/index.html.erb"
-    copy_file "views/permissions/_update_context_role.html.erb", "app/views/cbac/permissions/_update_context_role.html.erb"
-    copy_file "views/permissions/_update_generic_role.html.erb", "app/views/cbac/permissions/_update_generic_role.html.erb"
-    copy_file "views/generic_roles/index.html.erb", "app/views/cbac/generic_roles/index.html.erb"
-    copy_file "views/memberships/index.html.erb", "app/views/cbac/memberships/index.html.erb"
-    copy_file "views/memberships/_update.html.erb", "app/views/cbac/memberships/_update.html.erb"
-    copy_file "views/upgrade/index.html.erb", "app/views/cbac/upgrade/index.html.erb"
-    empty_directory "public/stylesheets"
-    copy_file "stylesheets/cbac.css", "public/stylesheets/cbac.css"
-
-    # migrations
-    #puts "type of m: " + class.name
-    if self.class.migration_exists?("#{::Rails.root.to_s}/db/migrate", "create_cbac")
-      # This is an upgrade from a previous version of CBAC
-      migration_template "migrate/create_cbac_upgrade_path.rb", "db/migrate/create_cbac_upgrade_path" unless self.class.migration_exists?("#{::Rails.root.to_s}/db/migrate", "create_cbac_upgrade_path")
-    else
-      # This is the first install of CBAC into the current project
-      migration_template "migrate/create_cbac_from_scratch.rb", "db/migrate/create_cbac_from_scratch" unless self.class.migration_exists?("#{::Rails.root.to_s}/db/migrate", "create_cbac_from_scratch")
-    end
-    # default fixtures
-    copy_file "fixtures/cbac_permissions.yml", "test/fixtures/cbac_permissions.yml"
-    copy_file "fixtures/cbac_generic_roles.yml", "test/fixtures/cbac_generic_roles.yml"
-    copy_file "fixtures/cbac_memberships.yml", "test/fixtures/cbac_memberships.yml"
-
-    # initializer
-    copy_file "initializers/cbac_config.rb", "config/initializers/cbac_config.rb"
-
-    # Rake task
-    empty_directory "lib/tasks"
-    copy_file "tasks/cbac.rake", "lib/tasks/cbac.rake"
-  end
-end
+require 'rbconfig'
+
+class CbacGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+
+  def self.source_root
+    @source_root ||= File.join(File.dirname(__FILE__), 'copy_files')
+  end
+
+  # Implement the required interface for Rails::Generators::Migration.
+  # taken from http://github.com/rails/rails/blob/master/activerecord/lib/generators/active_record.rb
+  def self.next_migration_number(dirname)
+    if ActiveRecord::Base.timestamped_migrations
+      Time.now.utc.strftime("%Y%m%d%H%M%S")
+    else
+      "%.3d" % (current_migration_number(dirname) + 1)
+    end
+  end
+   
+  def manifest
+    puts Dir.getwd
+
+    # developer files
+    empty_directory "config/cbac"
+    copy_file "config/privileges.rb", "config/cbac/privileges.rb", :collision => :skip
+    copy_file "config/context_roles.rb", "config/cbac/context_roles.rb", :collision => :skip
+
+    # deployment file
+    copy_file "config/cbac.pristine", "config/cbac/cbac.pristine", :collision => :skip
+
+    # administration pages
+    empty_directory "app/controllers/cbac"
+    copy_file "controllers/permissions_controller.rb", "app/controllers/cbac/permissions_controller.rb"
+    copy_file "controllers/generic_roles_controller.rb", "app/controllers/cbac/generic_roles_controller.rb"
+    copy_file "controllers/memberships_controller.rb", "app/controllers/cbac/memberships_controller.rb"
+    copy_file "controllers/upgrade_controller.rb", "app/controllers/cbac/upgrade_controller.rb"
+    empty_directory "app/views/layouts"
+    copy_file "views/layouts/cbac.html.erb", "app/views/layouts/cbac.html.erb"
+    empty_directory "app/views/cbac"
+    empty_directory "app/views/cbac/permissions"
+    empty_directory "app/views/cbac/generic_roles"
+    empty_directory "app/views/cbac/memberships"
+    empty_directory "app/views/cbac/upgrade"
+    copy_file "views/permissions/index.html.erb", "app/views/cbac/permissions/index.html.erb"
+    copy_file "views/permissions/_update_context_role.html.erb", "app/views/cbac/permissions/_update_context_role.html.erb"
+    copy_file "views/permissions/_update_generic_role.html.erb", "app/views/cbac/permissions/_update_generic_role.html.erb"
+    copy_file "views/generic_roles/index.html.erb", "app/views/cbac/generic_roles/index.html.erb"
+    copy_file "views/memberships/index.html.erb", "app/views/cbac/memberships/index.html.erb"
+    copy_file "views/memberships/_update.html.erb", "app/views/cbac/memberships/_update.html.erb"
+    copy_file "views/upgrade/index.html.erb", "app/views/cbac/upgrade/index.html.erb"
+    empty_directory "public/stylesheets"
+    copy_file "stylesheets/cbac.css", "public/stylesheets/cbac.css"
+
+    # migrations
+    #puts "type of m: " + class.name
+    if self.class.migration_exists?("#{::Rails.root.to_s}/db/migrate", "create_cbac")
+      # This is an upgrade from a previous version of CBAC
+      migration_template "migrate/create_cbac_upgrade_path.rb", "db/migrate/create_cbac_upgrade_path" unless self.class.migration_exists?("#{::Rails.root.to_s}/db/migrate", "create_cbac_upgrade_path")
+    else
+      # This is the first install of CBAC into the current project
+      migration_template "migrate/create_cbac_from_scratch.rb", "db/migrate/create_cbac_from_scratch" unless self.class.migration_exists?("#{::Rails.root.to_s}/db/migrate", "create_cbac_from_scratch")
+    end
+    # default fixtures
+    copy_file "fixtures/cbac_permissions.yml", "test/fixtures/cbac_permissions.yml"
+    copy_file "fixtures/cbac_generic_roles.yml", "test/fixtures/cbac_generic_roles.yml"
+    copy_file "fixtures/cbac_memberships.yml", "test/fixtures/cbac_memberships.yml"
+
+    # initializer
+    copy_file "initializers/cbac_config.rb", "config/initializers/cbac_config.rb"
+
+    # Rake task
+    empty_directory "lib/tasks"
+    copy_file "tasks/cbac.rake", "lib/tasks/cbac.rake"
+  end
+end