rbac_core 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 161e743a58e60da6c8d98560491955bf4ab1fafa
+  data.tar.gz: 4daa1438a6b8cbeb205fddc51bbd3542be49341d
+SHA512:
+  metadata.gz: 9580bdcdab91ddddfa54bb06d9d5d55b890d34247ffe2ac06daec009f58012cf656d24e6d68f096241c5c552063599007b12100d42f78c9ac9e2958825315016
+  data.tar.gz: 600aef20185cea548453aee2046426ed50937098f5ba090148c09c4ea4b2717e08369209eddb091ba6cf4309547b2072f5395c6f97c3c3acae5448c679af910d

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Jun Jiang
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,98 @@
+RBAC Core
+====
+
+A Rails engine providing essential industry of Role-based access control.
+
+## Usage
+
+See demo for now.
+
+## Installation
+
+Add this line to your Gemfile:
+
+```ruby
+gem 'rbac_core'
+```
+
+Or you may want to include the gem directly from GitHub:
+
+```ruby
+gem 'rbac_core', github: 'jasl-lab/rbac_core'
+```
+
+And then execute:
+
+```sh
+$ bundle
+```
+
+Copy migrations
+
+```sh
+$ bin/rails rbac_core:install:migrations
+```
+
+Then do migrate
+
+```sh
+$ bin/rails db:migrate
+```
+
+## Demo
+
+Clone the repository.
+
+```sh
+$ git clone https://github.com/jasl/rbac_core.git
+```
+
+Change directory
+
+```sh
+$ cd rbac_core
+```
+
+Run bundler
+
+```sh
+$ bundle install
+```
+
+Run yarn
+
+```sh
+$ test/dummy/bin/yarn
+```
+
+Preparing database
+
+```sh
+$ bin/rails db:migrate
+```
+
+Start the Rails server
+
+```sh
+$ bin/rails s
+```
+
+Open your browser, and visit `http://localhost:3000`
+
+## Contributing
+
+Bug report or pull request are welcome.
+
+### Make a pull request
+
+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
+
+Please write unit test with your code if necessary.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,36 @@
+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    = 'RbacCore'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  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'
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/models/rbac_core/application_record.rb

@@ -0,0 +1,5 @@
+module RbacCore
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/rbac_core/role.rb

@@ -0,0 +1,5 @@
+module RbacCore
+  class Role < ApplicationRecord
+    include RbacCore::Concerns::Models::Role
+  end
+end

data/db/migrate/20170705174003_create_rbac_core_roles.rb

@@ -0,0 +1,12 @@
+class CreateRbacCoreRoles < ActiveRecord::Migration[5.1]
+  def change
+    create_table :rbac_core_roles do |t|
+      t.string :name, null: false
+      t.text :permissions, null: false, default: ""
+
+      t.string :type, null: false
+
+      t.timestamps
+    end
+  end
+end

data/lib/rbac_core/concerns/models/role.rb

@@ -0,0 +1,24 @@
+module RbacCore::Concerns
+  module Models
+    module Role
+      extend ActiveSupport::Concern
+
+      included do
+        validates :name,
+                  presence: true
+
+        delegate :permitted_permissions, to: :permissions
+
+        after_initialize do
+          self.permissions ||= ::RbacCore.permission_set_class
+        end
+
+        serialize :permissions, RbacCore.permission_set_class
+      end
+
+      def permissions_attributes=(value)
+        permissions.update_attributes value
+      end
+    end
+  end
+end

data/lib/rbac_core/engine.rb

@@ -0,0 +1,5 @@
+module RbacCore
+  class Engine < ::Rails::Engine
+    isolate_namespace RbacCore
+  end
+end

data/lib/rbac_core/mapper.rb

@@ -0,0 +1,32 @@
+module RbacCore
+  class Mapper
+    def initialize(set, **constraints) #:nodoc:
+      @constraints = constraints
+      @set = set
+    end
+
+    def permission(name, default = false, **options, &block)
+      @set.register_permission name, default, @constraints.merge(options), &block
+      self
+    end
+
+    def group(name, **constraints, &block)
+      raise ArgumentError, "`name` can't be blank" if name.blank?
+      raise ArgumentError, "must provide a block" unless block_given?
+
+      sub_permission_set_class =
+        if @set.nested_classes.has_key?(name)
+          @set.nested_classes[name]
+        else
+          klass = PermissionSet.derive "#{name.to_s.classify}"
+          @set.embeds_one(name, anonymous_class: klass)
+
+          klass
+        end
+
+      sub_permission_set_class.draw(@constraints.merge(constraints), &block)
+
+      self
+    end
+  end
+end

data/lib/rbac_core/permission_adapter.rb

@@ -0,0 +1,27 @@
+module RbacCore
+  class PermissionAdapter
+    attr_reader :action, :priority
+
+    def initialize(action, priority: 0, **options, &block)
+      @action = action
+      @priority = priority
+    end
+
+    def call(context, *)
+      raise NotImplementedError
+    end
+
+    def hash
+      instance_values.hash
+    end
+
+    def ==(other)
+      unless other.is_a?(RbacCore::PermissionAdapter)
+        return false
+      end
+
+      instance_values == other.instance_values
+    end
+    alias eql? ==
+  end
+end

data/lib/rbac_core/permission_set.rb

@@ -0,0 +1,43 @@
+module RbacCore
+  class PermissionSet < OptionsModel::Base
+    def permitted_permission_names
+      attributes.select { |_, v| v }.keys
+    end
+
+    def permitted_permissions(include_nested: true)
+      permissions = self.class.registered_permissions.slice(*permitted_permission_names).values
+      if include_nested && nested_attributes.any?
+        permissions + nested_attributes.values.map(&:permitted_permissions).flatten!
+      else
+        permissions
+      end.sort_by(&:priority)
+    end
+
+    class << self
+      def i18n_scope
+        :rbac_core
+      end
+
+      def draw(**constraints, &block)
+        unless block_given?
+          raise ArgumentError, "must provide a block"
+        end
+
+        Mapper.new(self, constraints).instance_exec(&block)
+
+        self
+      end
+
+      def registered_permissions
+        @registered_permissions ||= ActiveSupport::HashWithIndifferentAccess.new
+      end
+
+      def register_permission(name, default = false, **options, &block)
+        raise ArgumentError, "`name` can't be blank" if name.blank?
+
+        attribute name, :boolean, default: default
+        registered_permissions[name] = RbacCore.permission_adapter_class.new name, options, &block
+      end
+    end
+  end
+end

data/lib/rbac_core/version.rb

@@ -0,0 +1,3 @@
+module RbacCore
+  VERSION = "0.0.1".freeze
+end

data/lib/rbac_core.rb

@@ -0,0 +1,28 @@
+require "rbac_core/engine"
+
+require "options_model"
+require "rbac_core/permission_adapter"
+require "rbac_core/mapper"
+require "rbac_core/permission_set"
+
+require "rbac_core/concerns/models/role"
+
+module RbacCore
+  class << self
+    def permission_set_class
+      @permission_set_class ||= PermissionSet.derive "Global"
+    end
+
+    def permission_adapter_class
+      @permission_adapter_class ||= PermissionAdapter
+    end
+
+    def permission_adapter_class=(klass)
+      unless klass && klass < PermissionAdapter
+        raise ArgumentError, "#{klass} should be sub-class of #{PermissionAdapter}."
+      end
+
+      @permission_adapter_class = klass
+    end
+  end
+end

data/lib/tasks/rbac_core_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :rbac_core do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: rbac_core
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- jasl
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: options_model
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Rails engine providing essential industry of Role-based access control
+email:
+- jasl9187@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/models/rbac_core/application_record.rb
+- app/models/rbac_core/role.rb
+- db/migrate/20170705174003_create_rbac_core_roles.rb
+- lib/rbac_core.rb
+- lib/rbac_core/concerns/models/role.rb
+- lib/rbac_core/engine.rb
+- lib/rbac_core/mapper.rb
+- lib/rbac_core/permission_adapter.rb
+- lib/rbac_core/permission_set.rb
+- lib/rbac_core/version.rb
+- lib/tasks/rbac_core_tasks.rake
+homepage: https://github.com/jasl-lab/rbac_core
+licenses:
+- MIT
+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.6.12
+signing_key: 
+specification_version: 4
+summary: A Rails engine providing essential industry of Role-based access control
+test_files: []