role_core 0.0.11

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ea0cbcc5a32c18136f5916bf1e58639590304226
+  data.tar.gz: a66fd20532ea7c6504b279da9d3d540cf5860f11
+SHA512:
+  metadata.gz: f4115f302c5cfb3c96db4c2c0b136c62b99b3cd9e6bf024dc043edab1964ae6325f7c5fb9afcb4c5a03945c100fe70126cafb9a1c89170c1b83b6b58c2c662f4
+  data.tar.gz: fe55fc4129c60e27a5bf793ea8cc62ee497de1c50e727b350faa3cec1347d49b68df59609c01625d2bf3ded089e99cf69c3b8e1bab2968ff0e235f99a2253c9c

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,92 @@
+RoleCore
+====
+
+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 'role_core'
+```
+
+Or you may want to include the gem directly from GitHub:
+
+```ruby
+gem 'role_core', github: 'jasl-lab/role_core'
+```
+
+And then execute:
+
+```sh
+$ bundle
+```
+
+Copy migrations
+
+```sh
+$ bin/rails role_core:install:migrations
+```
+
+Then do migrate
+
+```sh
+$ bin/rails db:migrate
+```
+
+## Demo
+
+Clone the repository.
+
+```sh
+$ git clone https://github.com/jasl/role_core.git
+```
+
+Change directory
+
+```sh
+$ cd role_core
+```
+
+Run bundler
+
+```sh
+$ bundle install
+```
+
+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,34 @@
+# frozen_string_literal: true
+
+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    = "RoleCore"
+  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/role_core/application_record.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RoleCore
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/role_core/role.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module RoleCore
+  class Role < ApplicationRecord
+    include RoleCore::Concerns::Models::Role
+
+    self.table_name = "roles"
+  end
+end

data/db/migrate/20170705174003_create_roles.rb

@@ -0,0 +1,12 @@
+class CreateRoles < ActiveRecord::Migration[5.1]
+  def change
+    create_table :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/role_core/computed_permissions.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module RoleCore
+  class ComputedPermissions
+    delegate :each, :map, :to_a, :to_ary, to: :@permissions
+
+    def initialize(permissions = [])
+      @permissions = [].concat permissions.to_a
+      regroup!
+    end
+
+    def concat(permissions)
+      @permissions.concat permissions
+      regroup!
+
+      self
+    end
+
+    def call(context, *args)
+      @permissions.each do |permission|
+        permission.call(context, *args)
+      end
+
+      self
+    end
+
+    private
+
+    def regroup!
+      @permissions.uniq!
+      @permissions.sort_by!(&:priority)
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module RoleCore::Concerns
+  module Models
+    module Role
+      extend ActiveSupport::Concern
+
+      included do
+        validates :name,
+                  presence: true
+
+        delegate :permitted_permissions, to: :permissions
+
+        serialize :permissions, RoleCore.permission_set_class
+      end
+
+      def permissions_attributes=(value)
+        permissions.update_attributes value
+      end
+    end
+  end
+end

data/lib/role_core/engine.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RoleCore
+  class Engine < ::Rails::Engine
+    isolate_namespace RoleCore
+  end
+end

data/lib/role_core/mapper.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module RoleCore
+  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/role_core/permission.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module RoleCore
+  class Permission
+    attr_reader :name, :priority
+
+    def initialize(name, priority: 0, **options, &block)
+      @name = name
+      @priority = priority
+    end
+
+    def call(context, *)
+      raise NotImplementedError
+    end
+
+    def hash
+      instance_values.hash
+    end
+
+    def ==(other)
+      unless other.is_a?(RoleCore::Permission)
+        return false
+      end
+
+      instance_values == other.instance_values
+    end
+    alias eql? ==
+  end
+end

data/lib/role_core/permission_set.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module RoleCore
+  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.concat nested_attributes.values.map(&:permitted_permissions).flatten!
+      end
+
+      ComputedPermissions.new(permissions)
+    end
+
+    class << self
+      def i18n_scope
+        :role_core
+      end
+
+      def permission_class
+        @permission_class || RoleCore.permission_class
+      end
+
+      def permission_class=(klass)
+        unless klass && klass < Permission
+          raise ArgumentError, "#{klass} should be sub-class of #{Permission}."
+        end
+
+        @permission_class = klass
+      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] = permission_class.new name, options, &block
+      end
+    end
+  end
+end

data/lib/role_core/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RoleCore
+  VERSION = "0.0.11"
+end

data/lib/role_core.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require "role_core/engine"
+
+require "options_model"
+require "role_core/permission"
+require "role_core/mapper"
+require "role_core/permission_set"
+require "role_core/computed_permissions"
+
+require "role_core/concerns/models/role"
+
+module RoleCore
+  class << self
+    def permission_set_class
+      @permission_set_class ||= PermissionSet.derive "Global"
+    end
+
+    def permission_set_class=(klass)
+      unless klass && klass < PermissionSet
+        raise ArgumentError, "#{klass} should be sub-class of #{PermissionSet}."
+      end
+
+      @permission_set_class = klass
+    end
+
+    def permission_class
+      @permission_class ||= Permission
+    end
+
+    def permission_class=(klass)
+      unless klass && klass < Permission
+        raise ArgumentError, "#{klass} should be sub-class of #{Permission}."
+      end
+
+      @permission_class = klass
+    end
+  end
+end

data/lib/tasks/role_core_tasks.rake

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+# desc "Explaining what the task does"
+# task :role_core do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: role_core
+version: !ruby/object:Gem::Version
+  version: 0.0.11
+platform: ruby
+authors:
+- jasl
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.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/role_core/application_record.rb
+- app/models/role_core/role.rb
+- db/migrate/20170705174003_create_roles.rb
+- lib/role_core.rb
+- lib/role_core/computed_permissions.rb
+- lib/role_core/concerns/models/role.rb
+- lib/role_core/engine.rb
+- lib/role_core/mapper.rb
+- lib/role_core/permission.rb
+- lib/role_core/permission_set.rb
+- lib/role_core/version.rb
+- lib/tasks/role_core_tasks.rake
+homepage: https://github.com/jasl-lab/role_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: []