rolify_hier 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d3ed039bc8965adbed428dde0cc5f9e14cf1d876
+  data.tar.gz: eacfdae97a24d08305851f3b73b5f3c8eae638ba
+SHA512:
+  metadata.gz: 29175aff3541dfea6e8500c0b96353a6a797db48c9ec0ff5f7bc0f5634a8ebff37b7ffb936904bdfb1b16f258ff84918ad647f2a5c4288fbb985094d6e3afcdd
+  data.tar.gz: 0d6692bde1a7f2eb5daedd875536acbc11a4f7a69219050dcc3d3d33324bdf5fbe8fe2898de40f40fdb61caafe8fe3db9a4b56dda0e642d76168e9eb70cd5c15

data/README.md

@@ -0,0 +1,91 @@
+# Rolify Hier
+
+The very simple role hierarchy library for [rolify](https://github.com/RolifyCommunity/rolify)
+
+## Requirements
+
+* Rails >= 3.2
+* [rolify](https://github.com/RolifyCommunity/rolify)
+
+## Installation
+
+Add this to your Gemfile.
+
+```ruby
+gem 'rolify_hier'
+```
+
+## Getting Started
+
+### 1. Configure role hierarchy
+
+```ruby
+rails g rolify_hier:initializer
+```
+
+generates `config/initializers/rolify_hier.rb`:
+
+```ruby
+RolifyHier.config do
+	# role(:root) << role(:admin) << role(:user)
+	## or
+	# role(:root) << role(:admin)
+	# role(:admin) << role(:user)
+	## ->
+	## root has root, admin, user
+	## admin has admin, user
+	## user has user
+end
+```
+
+If you want to configure 'king > bishop > knight > pawn' hierarchy, then write like below.
+
+```ruby
+RolifyHier.config do
+	role(:king) << role(:bishop) << role(:knight) << role(:pawn)
+	
+	## Also works equally
+	# role(:king) << role(:bishop)
+	# role(:bishop) << role(:knight) << role(:pawn)
+end
+```
+
+### 2. Example
+I assume that you already know rolify.
+
+```ruby
+RolifyHier.config do
+	role(:king) << role(:bishop) << role(:knight) << role(:pawn)
+end
+
+class User < ActiveRecord::Base
+  include RolifyHier
+  rolify # for rolify
+end
+
+user = User.new
+user.add_role :knight
+user.hier_role? :pawn # true
+user.hier_roles.has_role? :pawn # true. `hier_role?` equals `hier_roles.has_role?`
+user.hier_role? :knight # true
+user.hier_role? :bishop # false
+user.hier_role? :king # false
+
+# Multiple roles work
+user2 = User.new
+user2.add_role :pawn
+user2.add_role :bishop
+user2.hier_role? :pawn # true
+user2.hier_role? :knight # true (because of bishop role)
+user2.hier_role? :bishop # true
+user2.hier_role? :king # false
+```
+
+## Author
+Sputnik Gugja (sputnikgugja@gmail.com)
+
+## License
+
+This is free software released into the public domain (CC0 license).
+
+See the `LICENSE` file.

data/Rakefile

@@ -0,0 +1,37 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Rolify Hier'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/generators/rolify_hier/initializer_generator.rb

@@ -0,0 +1,13 @@
+module RolifyHier
+	module Generators
+		class InitializerGenerator < Rails::Generators::Base
+			desc "Creates a RolifyHier initializer in your application"
+			
+			source_root File.expand_path("../templates", __FILE__)
+		
+			def copy_initializer
+				template "initializer.rb", "config/initializers/rolify_hier.rb"
+			end
+		end
+	end
+end

data/lib/generators/rolify_hier/templates/initializer.rb

@@ -0,0 +1,10 @@
+RolifyHier.config do
+	# role(:root) << role(:admin) << role(:user)
+	## or
+	# role(:root) << role(:admin)
+	# role(:admin) << role(:user)
+	## ->
+	## root has root, admin, user
+	## admin has admin, user
+	## user has user
+end

data/lib/rolify_hier/engine.rb

@@ -0,0 +1,5 @@
+module RolifyHier
+  class Engine < ::Rails::Engine
+		config.autoload_paths << File.expand_path("../../", __FILE__)
+  end
+end

data/lib/rolify_hier/hier_role.rb

@@ -0,0 +1,59 @@
+module RolifyHier
+	class HierRole
+		@@roles = {}.with_indifferent_access
+
+		def self.[](name)
+			if @@roles.key? name
+				@@roles[name]
+			else
+				role = self.new(name)
+				@@roles[name] = role
+				role
+			end
+		end
+
+		attr_reader :name
+		attr_reader :sub
+
+		def initialize(name)
+			raise ArgumentError, 'name is nil' if name.nil?
+			@name = name
+			@sub = Set.new
+		end
+
+		def <<(o)
+			check_arg_type(o)
+			include(o)
+		end
+
+		def include(o)
+			check_arg_type(o)
+			@sub << o
+			o
+		end
+
+		def include?(o)
+			check_arg_type(o)
+			@sub.include?(o)
+		end
+
+		# Not hierarchic
+		def remove(o)
+			check_arg_type(o)
+			@sub.remove(o)
+		end
+
+		def reachable_roles
+			list = [self]
+			@sub.each do |e|
+				list += e.reachable_roles
+			end
+			list
+		end
+
+		private
+			def check_arg_type(o)
+				raise 'the argument is not an HierRole class instance' unless o.instance_of?(HierRole)
+			end
+	end
+end

data/lib/rolify_hier/hier_roles.rb

@@ -0,0 +1,24 @@
+module RolifyHier
+	class HierRoles
+		attr_reader :roles
+		
+		def initialize(hier_role_list)
+			@roles = hier_role_list
+		end
+
+		def has_role?(role_name)
+			reachable_roles.each do |e|
+				return true if e.name == role_name
+			end
+			false
+		end
+
+		def reachable_roles
+			list = []
+			@roles.each do |e|
+				list += e.reachable_roles
+			end
+			list
+		end
+	end
+end

data/lib/rolify_hier/version.rb

@@ -0,0 +1,3 @@
+module RolifyHier
+  VERSION = "0.0.2".freeze
+end

data/lib/rolify_hier.rb

@@ -0,0 +1,21 @@
+require "rolify_hier/engine"
+
+module RolifyHier
+	def self.config(&block)
+		class_eval(&block)
+	end
+	
+	def self.role(name)
+		HierRole[name.to_sym]
+	end
+	
+	# means 'has role hierarchically?'
+	def hier_role?(role_name)
+		hier_roles.has_role? role_name
+	end
+	
+	def hier_roles
+		roles = roles(:select => :name).collect( HierRole[&:name] )
+		HierRoles.new roles
+	end
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: rolify_hier
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Sputnik Gugja
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-01-30 00:00:00.000000000 Z
+dependencies: []
+description: The very simple role hierarchy library for rolify. fin
+email:
+- sputnikgugja@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/generators/rolify_hier/initializer_generator.rb
+- lib/generators/rolify_hier/templates/initializer.rb
+- lib/rolify_hier.rb
+- lib/rolify_hier/engine.rb
+- lib/rolify_hier/hier_role.rb
+- lib/rolify_hier/hier_roles.rb
+- lib/rolify_hier/version.rb
+homepage: https://github.com/sputnikgugja/rolify_hier
+licenses:
+- CC0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: The very simple role hierarchy library for rolify
+test_files: []