rend-acl 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rend-acl.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,26 @@
+Copyright (c) 1999 - 2013, Daniel Doezema All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+  * Redistributions of source code must retain the above copyright notice, this
+    list of conditions and the following disclaimer.
+
+  * Redistributions in binary form must reproduce the above copyright notice,
+    this list of conditions and the following disclaimer in the documentation
+    and/or other materials provided with the distribution.
+
+  * The names of the contributors and/or copyright holder may not be used to
+    endorse or promote products derived from this software without specific
+    prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL DANIEL DOEZEMA BE LIABLE FOR ANY DIRECT, INDIRECT,
+INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
+LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
+OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,25 @@
+# Rend Acl
+
+Rend-Acl is a port of [Zend_Acl](http://framework.zend.com/manual/1.12/en/zend.acl.html) with modifications made to bring the api more inline with Ruby conventions.
+
+## Installation
+
+    gem install rend-acl
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Licensing
+
+* All ported Ruby code and assoicated 'Rend' gems are under a simple [New-BSD License](http://dan.doezema.com/licenses/new-bsd).
+* Original PHP code is licensed under [Zend's New-BSD License](http://framework.zend.com/license/).
+    * This license can be found in `./ZEND_FRAMEWORK_LICENSE.txt`
+
+## Acknowledgements
+* This project is **not** associated with, or endorsed by, Zend Technologies USA, Inc., nor any of its contributors.
+* Rend's modular design was heavily influced by [RSpec](https://github.com/rspec/rspec) approach.

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/ZEND_FRAMEWORK_LICENSE.txt

@@ -0,0 +1,27 @@
+New BSD License
+Copyright (c) 2005-2013, Zend Technologies USA, Inc. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+  * Redistributions of source code must retain the above copyright notice, this
+    list of conditions and the following disclaimer.
+
+  * Redistributions in binary form must reproduce the above copyright notice, this
+    list of conditions and the following disclaimer in the documentation and/or
+    other materials provided with the distribution.
+
+  * Neither the name of Zend Technologies USA, Inc. nor the names of its
+    contributors may be used to endorse or promote products derived from this
+    software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/lib/rend/acl/exception.rb

@@ -0,0 +1,6 @@
+module Rend
+  class Acl
+    class Exception < Rend::Core::Exception
+    end
+  end
+end

data/lib/rend/acl/resource.rb

@@ -0,0 +1,14 @@
+module Rend
+  class Acl
+    class Resource
+
+      # Unique id of Resource
+      attr_reader :id # @var string
+
+      def initialize(id)
+        @id = id.to_s
+      end
+
+    end
+  end
+end

data/lib/rend/acl/role/registry/exception.rb

@@ -0,0 +1,10 @@
+module Rend
+  class Acl
+    class Role
+      class Registry
+        class Exception < Rend::Acl::Exception
+        end
+      end
+    end
+  end
+end

data/lib/rend/acl/role/registry.rb

@@ -0,0 +1,168 @@
+require 'rend/acl/role/registry/exception'
+module Rend
+  class Acl
+    class Role
+      class Registry
+        include Rend::Core::Helpers::Php
+
+        # Internal Role registry data storage
+        # @var hash
+        attr_accessor :roles
+
+        def initialize
+          self.roles = {}
+        end
+
+        # Adds a Role having an identifier unique to the registry
+        #
+        # The parents parameter may be a reference to, or the string identifier for,
+        # a Role existing in the registry, or parents may be passed as an array of
+        # these - mixing string identifiers and objects is ok - to indicate the Roles
+        # from which the newly added Role will directly inherit.
+        #
+        # In order to resolve potential ambiguities with conflicting rules inherited
+        # from different parents, the most recently added parent takes precedence over
+        # parents that were previously added. In other words, the first parent added
+        # will have the least priority, and the last parent added will have the
+        # highest priority.
+        #
+        # @param  Rend::Acl::Role              role
+        # @param  Rend::Acl::Role|string|array parents
+        # @throws Rend::Acl::Role::Registry::Exception
+        # @return Rend::Acl::Role::Registry Provides a fluent interface
+        def add!(role, parents = nil)
+          type_hint! Rend::Acl::Role, role, :is_required => true
+
+          role_id = role.id
+          raise Exception, "Role id 'role_id' already exists in the registry" if has?(role_id)
+
+          role_parents = {}
+
+          if parents
+            Array(parents).each do |parent|
+              begin
+                role_parent_id  = (parent.class <= Rend::Acl::Role) ? parent.id : parent
+                role_parent     = get!(role_parent_id)
+              rescue Exception
+                raise Exception, "Parent Role id 'role_parent_id' does not exist"
+              end
+              role_parents[role_parent_id] = role_parent
+              roles[role_parent_id][:children][role_id] = role
+              # roles[role_parent_id][:instance].children[role_id] = role # future
+            end
+          end
+
+          # role.parents = role_parents -- future
+
+          roles[role_id] = {
+            :instance   => role,
+            :parents    => role_parents,
+            :children   => {}
+          }
+
+          self
+        end
+
+
+        # Returns the identified Role
+        #
+        # The role parameter can either be a Role or a Role identifier.
+        #
+        # @param  Rend::Acl::Role|string role
+        # @throws Rend::Acl::Role::Registry::Exception
+        # @return Rend::Acl::Role
+        def get!(role)
+          raise Exception, "Role 'role_id' not found" unless has?(role)
+          role_id = (role.class <= Rend::Acl::Role) ? role.id : role.to_s
+          roles[role_id][:instance]
+        end
+
+
+        # Returns true if and only if the Role exists in the registry
+        #
+        # The role parameter can either be a Role or a Role identifier.
+        #
+        # @param  Rend::Acl::Role|string role
+        # @return boolean
+        def has?(role)
+          role_id = (role.class <= Rend::Acl::Role) ? role.id : role.to_s
+          roles.has_key?(role_id)
+        end
+
+
+        # Returns an array of an existing Role's parents
+        #
+        # The array keys are the identifiers of the parent Roles, and the values are
+        # the parent Role instances. The parent Roles are ordered in this array by
+        # ascending priority. The highest priority parent Role, last in the array,
+        # corresponds with the parent Role most recently added.
+        #
+        # If the Role does not have any parents, then an empty array is returned.
+        #
+        # @param  Rend::Acl::Role|string role
+        # @uses   Rend::Acl::Role::Registry::get!
+        # @return array
+        def parents(role)
+          roles[get!(role).id][:parents]
+        end
+
+
+        # Returns true if and only if role inherits from inherit
+        #
+        # Both parameters may be either a Role or a Role identifier. If
+        # only_parents is true, then role must inherit directly from
+        # inherit in order to return true. By default, this method looks
+        # through the entire inheritance DAG to determine whether role
+        # inherits from inherit through its ancestor Roles.
+        #
+        # @param  Rend::Acl::Role|string role
+        # @param  Rend::Acl::Role|string inherit
+        # @param  boolean                        only_parents
+        # @throws Rend::Acl::Role::Registry::Exception
+        # @return boolean
+        def inherits?(role, inherit, only_parents = false)
+          role_id     = get!(role).id
+          inherit_id  = get!(inherit).id
+          inherits    = roles[role_id][:parents].has_key?(inherit_id)
+
+          return inherits if inherits || only_parents
+
+          roles[role_id][:parents].each do |parent_id, parent|
+              return true if inherits?(parent_id, inherit_id)
+          end
+          false
+        end
+
+
+        # Removes the Role from the registry
+        #
+        # The role parameter can either be a Role or a Role identifier.
+        #
+        # @param  Rend::Acl::Role|string role
+        # @throws Rend::Acl::Role::Registry::Exception
+        # @return Rend::Acl::Role::Registry Provides a fluent interface
+        def remove!(role)
+          role_id = get!(role).id
+
+          roles[role_id][:children].each do |child_id, child|
+            roles[child_id][:parents].delete(role_id)
+          end
+
+          roles[role_id][:parents].each do |parent_id, parent|
+            roles[parent_id][:children][role_id]
+          end
+
+          roles.delete(role_id)
+
+          self
+        end
+
+        def remove_all!
+          roles.replace({})
+          self
+        end
+
+      end
+    end
+  end
+end

data/lib/rend/acl/role.rb

@@ -0,0 +1,19 @@
+require 'rend/acl/role/registry'
+module Rend
+  class Acl
+    class Role
+
+      # Unique id of Role
+      attr_reader :id # @var string
+      # attr_accessor :parents  -- future
+      # attr_accessor :children -- future
+
+      def initialize(id)
+        @id = id.to_s
+        # @parents = {}  -- future
+        # @children = {} -- future
+      end
+
+    end
+  end
+end

data/lib/rend/acl/version.rb

@@ -0,0 +1,7 @@
+module Rend
+  class Acl
+    module Version
+      STRING = "0.0.1"
+    end
+  end
+end