permisi 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47559ea904f406010a7979cd77de853bf8c3628c7e4c1020e45742ae439a7e06
-  data.tar.gz: b8c814331a90cbc7e4d2d3560cfb939419b001f1e88e731a3e67e9b180ead167
+  metadata.gz: 50d92f00f694bb0b93a36125736bbd3afae15446c6fe5c71e0a83027a136c5e8
+  data.tar.gz: f214d63982175a708e99f7c9238a778b10ec4b599b8baed0dbf09e62a3ad0ae4
 SHA512:
-  metadata.gz: bdfbfbadcc257c15ded64521607e062d2d51ba3c9fc5209f4af273f69473df981e2bbbc74457e0bbd3cc0576e9c51e67895f66685bba7dada2e88d3b4513199c
-  data.tar.gz: a095961d001eb1495f7d084434f8bef182add89e86f9a147013a34f0b7c171cff4da65373798442e45e962264f03c6d0c07eb23f58ca520e742c61adbd94d8e6
+  metadata.gz: ea1cedd52afd42383027297028974947aa338eff64d0bb12daee7f3e73663dc054c983f792f6ec8a917f2273745cbb212ea17d12271d11de003a509f53111803
+  data.tar.gz: 395586b6b62fdedfe3c9ffc0ea824868cf27d76922af4a7501f161eabd06561c9d44d251a114685552e4d5a37c50923b721621d212ef3d956f98a025e93f4649

data/.github/workflows/ci.yml

@@ -0,0 +1,46 @@
+name: Lint and test
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Set up Ruby 2.7
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7
+
+    - name: Generate lockfile for cache key
+      run: bundle lock
+
+    - name: Cache gems
+      uses: actions/cache@v1
+      with:
+        path: vendor/bundle
+        key: ${{ runner.os }}-rspec-${{ hashFiles('**/Gemfile.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-rspec-
+
+    - name: Install gems
+      run: |
+        bundle config path vendor/bundle
+        bundle install --jobs 4 --retry 3
+
+    - name: Run RuboCop
+      uses: reviewdog/action-rubocop@v1
+      with:
+        rubocop_version: gemfile
+        rubocop_extensions: rubocop-rails:gemfile rubocop-rspec:gemfile
+        github_token: ${{ secrets.github_token }}
+        reporter: github-pr-check # Default is github-pr-check
+
+    - name: Run RSpec
+      run: bundle exec rake spec

data/.rubocop.yml

@@ -1,5 +1,10 @@
 AllCops:
   TargetRubyVersion: 2.4
+  NewCops: enable
+  Exclude:
+    - "lib/generators/**/*"
+    - "spec/**/*" # stuff for later
+    - "lib/permisi/permission_util.rb" # The necessary evil (for now)
 
 Style/StringLiterals:
   Enabled: true
@@ -11,3 +16,7 @@ Style/StringLiteralsInInterpolation:
 
 Layout/LineLength:
   Max: 120
+
+# Stuff for later
+Documentation:
+  Enabled: false

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+# 0.1.1
+
+- General code refactoring
+- Improvements on ActiveRecord backend:
+  - Code refactoring
+  - Implement cache invalidation
+
 # 0.1.0
 
 Finished extraction work from my past projects.

data/CONTRIBUTING.md

@@ -0,0 +1,25 @@
+# How to contribute
+
+This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/ukazap/permisi/blob/master/CODE_OF_CONDUCT.md).
+
+## Found a bug?
+
+- Search the [issues labeled "bug"](https://github.com/ukazap/permisi/issues?q=is%3Aissue+label%3Abug) to see if it's already reported.
+- Make sure you are using the latest version of Permisi [![Gem Version](https://badge.fury.io/rb/permisi.svg)](https://badge.fury.io/rb/permisi)
+- If you are still having an issue, create an issue including:
+  - Ruby version
+  - Gemfile.lock contents or at least major gem versions, such as Rails version
+  - Steps to reproduce the issue
+  - Full backtrace for any errors encountered
+
+## Submitting changes
+
+If you want to contribute an enhancement or a fix:
+
+- Fork the project on GitHub
+- After checking out the repo, run `bin/setup` to install dependencies
+- Make your changes with tests
+- Run `bundle exec rubocop -A` to auto-format your code
+- Run `rake spec` to run the tests
+- Commit the changes without making changes to the Rakefile or any other files that aren't related to your enhancement or fix
+- Send a pull request

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    permisi (0.1.0)
+    permisi (0.1.1)
       activemodel (>= 3.2.0)
       activerecord (>= 3.2.0)
       activesupport (>= 3.2.0)
@@ -10,12 +10,12 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (6.1.2.1)
-      activesupport (= 6.1.2.1)
-    activerecord (6.1.2.1)
-      activemodel (= 6.1.2.1)
-      activesupport (= 6.1.2.1)
-    activesupport (6.1.2.1)
+    activemodel (6.1.3)
+      activesupport (= 6.1.3)
+    activerecord (6.1.3)
+      activemodel (= 6.1.3)
+      activesupport (= 6.1.3)
+    activesupport (6.1.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)

data/README.md

@@ -172,15 +172,9 @@ user.permisi.has_role? :admin # == true
 user.permisi.may? "books.delete" # == true
 ```
 
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/ukazap/permisi. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/ukazap/permisi/blob/master/CODE_OF_CONDUCT.md).
+For development and how to submit improvements, please refer to the [contribution guide](https://github.com/ukazap/permisi/blob/main/CONTRIBUTING.md).
 
 ## License
 
@@ -188,4 +182,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Permisi project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ukazap/permisi/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Permisi project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ukazap/permisi/blob/main/CODE_OF_CONDUCT.md).

data/lib/generators/permisi/install_generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "rails/generators"
 require "rails/generators/migration"
 require "rails/generators/active_record"
@@ -7,26 +9,24 @@ module Permisi
     class InstallGenerator < Rails::Generators::Base
       include Rails::Generators::Migration
 
-      source_root File.expand_path('../templates', __FILE__)
+      source_root File.expand_path("templates", __dir__)
 
       def self.next_migration_number(path)
         ActiveRecord::Generators::Base.next_migration_number(path)
       end
 
       def create_initializer
-        template 'initializer.rb', 'config/initializers/permisi.rb'
+        template "initializer.rb", "config/initializers/permisi.rb"
       end
 
       def create_migrations
-        migration_template 'migration.rb', 'db/migrate/create_permisi_tables.rb', migration_version: migration_version
+        migration_template "migration.rb", "db/migrate/create_permisi_tables.rb", migration_version: migration_version
       end
 
       private
 
       def migration_version
-        if ActiveRecord.version.version > '5'
-          "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
-        end
+        "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]" if ActiveRecord.version.version > "5"
       end
     end
   end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "permisi"
 
 Permisi.init do |config|

data/lib/permisi.rb

@@ -1,41 +1,35 @@
 # frozen_string_literal: true
 
+require "active_model/type"
+require "active_support/hash_with_indifferent_access"
 require "zeitwerk"
-$permisi_loader = Zeitwerk::Loader.for_gem
-$permisi_loader.ignore("#{__dir__}/generators")
-$permisi_loader.ignore("#{__dir__}/permisi/backend/mongoid.rb") # todo
-$permisi_loader.setup
 
 module Permisi
+  LOADER = Zeitwerk::Loader.for_gem
+
   class << self
-    def init(&block)
+    def init
       yield config if block_given?
     end
 
     def config
-      @@config ||= Config.new
+      @config ||= Config.new
     end
 
     def actors
-      __backend.actors
+      config.backend.actors
     end
 
     def actor(aka)
-      __backend.findsert_actor(aka)
+      config.backend.findsert_actor(aka)
     end
 
     def roles
-      __backend.roles
-    end
-
-    private
-
-    def __backend
-      if config.backend.nil? || !(config.backend <= Backend::Base)
-        raise Backend::InvalidBackend
-      end
-
-      config.backend
+      config.backend.roles
     end
   end
 end
+
+Permisi::LOADER.ignore("#{__dir__}/generators")
+Permisi::LOADER.ignore("#{__dir__}/permisi/backend/mongoid.rb") # todo
+Permisi::LOADER.setup

data/lib/permisi/actable.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Permisi
   module Actable
     def permisi_actor

data/lib/permisi/backend.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Permisi
+  module Backend
+    class InvalidBackend < StandardError
+      def initialize(message = "Please check https://github.com/ukazap/permisi#configuring-backend")
+        super
+      end
+    end
+
+    module NullBackend
+      class << self
+        def findsert_actor(_aka)
+          raise InvalidBackend
+        end
+
+        def actors
+          raise InvalidBackend
+        end
+
+        def roles
+          raise InvalidBackend
+        end
+      end
+    end
+  end
+end

data/lib/permisi/backend/active_record.rb

@@ -1,22 +1,26 @@
+# frozen_string_literal: true
+
 require "active_record"
 
 module Permisi
-  class Backend::ActiveRecord < Backend::Base
-    class << self
-      def table_name_prefix
-        "permisi_"
-      end
+  module Backend
+    module ActiveRecord
+      class << self
+        def table_name_prefix
+          "permisi_"
+        end
 
-      def findsert_actor(aka)
-        Actor.find_or_create_by(aka: aka)
-      end
+        def findsert_actor(aka)
+          Actor.find_or_create_by(aka: aka)
+        end
 
-      def actors
-        Actor.all
-      end
+        def actors
+          Actor.all
+        end
 
-      def roles
-        Role.all
+        def roles
+          Role.all
+        end
       end
     end
   end

data/lib/permisi/backend/active_record/actor.rb

@@ -1,15 +1,24 @@
+# frozen_string_literal: true
+
 module Permisi
-  class Backend::ActiveRecord::Actor < ::ActiveRecord::Base
-    belongs_to :aka, polymorphic: true
-    has_many :actor_roles
-    has_many :roles, through: :actor_roles
+  module Backend
+    module ActiveRecord
+      class Actor < ::ActiveRecord::Base
+        belongs_to :aka, polymorphic: true, touch: true
+        has_many :actor_roles, dependent: :destroy
+        has_many :roles, through: :actor_roles
 
-    def has_role?(role_slug)
-      roles.load.any? { |role| role.slug == role_slug.to_s }
-    end
+        def role?(role_slug)
+          roles.load.any? { |role| role.slug == role_slug.to_s }
+        end
+
+        def may?(action_path)
+          roles.load.any? { |role| role.allows?(action_path) }
+        end
 
-    def may?(action_path)
-      roles.load.any? { |role| role.allows?(action_path) }
+        alias may_i? may?
+        alias has_role? role?
+      end
     end
   end
 end

data/lib/permisi/backend/active_record/actor_role.rb

@@ -1,6 +1,20 @@
+# frozen_string_literal: true
+
 module Permisi
-  class Backend::ActiveRecord::ActorRole < ::ActiveRecord::Base
-    belongs_to :actor
-    belongs_to :role
+  module Backend
+    module ActiveRecord
+      class ActorRole < ::ActiveRecord::Base
+        belongs_to :actor, touch: true
+        belongs_to :role
+
+        after_destroy :touch_actor
+
+        private
+
+        def touch_actor
+          actor.touch
+        end
+      end
+    end
   end
 end

data/lib/permisi/backend/active_record/role.rb

@@ -1,27 +1,41 @@
+# frozen_string_literal: true
+
 module Permisi
-  class Backend::ActiveRecord::Role < ::ActiveRecord::Base
-    has_many :actor_roles
-    has_many :actors, through: :actor_roles
-    has_many :akas, through: :actors
+  module Backend
+    module ActiveRecord
+      class Role < ::ActiveRecord::Base
+        has_many :actor_roles, dependent: :destroy
+        has_many :actors, through: :actor_roles
+        has_many :akas, through: :actors
 
-    validates_presence_of :name, :slug
-    validates_uniqueness_of :name, :slug
+        validates_presence_of :name, :slug
+        validates_uniqueness_of :name, :slug
 
-    after_initialize :set_default_permissions
-    before_validation :sanitize_permissions
+        after_initialize :set_default_permissions
+        before_validation :sanitize_attributes
+        after_update :touch_actor_roles
 
-    serialize :permissions, Permisi::PermissionUtil::Serializer
+        serialize :permissions, Permisi::PermissionUtil::Serializer
 
-    def allows?(action_path)
-      Permisi::PermissionUtil.allows?(self.permissions, action_path)
-    end
+        def allows?(action_path)
+          Permisi::PermissionUtil.allows?(permissions, action_path)
+        end
 
-    def set_default_permissions
-      self.permissions ||= Permisi.config.default_permissions if self.new_record?
-    end
+        private
+
+        def set_default_permissions
+          self.permissions ||= HashWithIndifferentAccess.new if new_record?
+        end
+
+        def sanitize_attributes
+          self.name ||= slug.try(:titleize)
+          self.permissions = Permisi::PermissionUtil.sanitize_permissions(self.permissions)
+        end
 
-    def sanitize_permissions
-      self.permissions = Permisi::PermissionUtil.sanitize_permissions(self.permissions)
+        def touch_actor_roles
+          actor_roles.each(&:touch)
+        end
+      end
     end
   end
 end

data/lib/permisi/backend/mongoid.rb

@@ -1,5 +1,9 @@
+# frozen_string_literal: true
+
 module Permisi
-  class Backend::Mongoid < Backend::Base
-    raise "under construction"
+  module Backend
+    module Mongoid
+      raise "under construction"
+    end
   end
 end

data/lib/permisi/config.rb

@@ -1,9 +1,10 @@
+# frozen_string_literal: true
+
 require "active_support/core_ext/class/attribute_accessors"
 
 module Permisi
   class Config
-    attr_accessor :backend, :permissions
-    attr_reader :default_permissions
+    attr_reader :permissions, :default_permissions
 
     def initialize
       @permissions = ::HashWithIndifferentAccess.new
@@ -11,15 +12,16 @@ module Permisi
     end
 
     def backend=(chosen_backend)
-      if chosen_backend.is_a? Symbol
-        chosen_backend = "::Permisi::Backend::#{chosen_backend.to_s.classify}".constantize
-      end
-
+      chosen_backend = "::Permisi::Backend::#{chosen_backend.to_s.classify}".constantize if chosen_backend.is_a? Symbol
       @backend = chosen_backend
     rescue NameError
       raise Backend::InvalidBackend
     end
 
+    def backend
+      @backend || Backend::NullBackend
+    end
+
     def permissions=(permissions_hash)
       permissions_hash = HashWithIndifferentAccess.new(permissions_hash)
       @default_permissions = PermissionUtil.transform_namespace(permissions_hash)

data/lib/permisi/permission_util.rb

@@ -1,5 +1,4 @@
-require "active_model/type"
-require "active_support/hash_with_indifferent_access"
+# frozen_string_literal: true
 
 module Permisi
   module PermissionUtil
@@ -7,32 +6,39 @@ module Permisi
 
     class << self
       def allows?(hash, action_path)
-        return false unless hash.kind_of?(Hash)
+        return false unless hash.is_a?(Hash)
 
         action_path_arr = action_path.split(".")
-        (!Permisi.config.default_permissions.dig(*action_path_arr).nil? rescue false) &&
+        begin
+          !Permisi.config.default_permissions.dig(*action_path_arr).nil?
+        rescue StandardError
+          false
+        end &&
           hash.dig(*action_path_arr) == true
       end
 
       def transform_namespace(namespace, current_path: nil)
         HashWithIndifferentAccess.new.tap do |transformed|
           namespace.each_pair do |key, value|
-            raise InvalidNamespace,
-                  "`#{[current_path, key].compact.join(".")}` should be an array" unless value.is_a? Array
+            unless value.is_a? Array
+              raise InvalidNamespace,
+                    "`#{[current_path, key].compact.join(".")}` should be an array"
+            end
 
             value.each.with_index do |arr_v, arr_i|
-              if arr_v.is_a?(Symbol)
+              case arr_v
+              when Symbol
                 transformed[key] ||= ::HashWithIndifferentAccess.new
-                if transformed[key].has_key? arr_v
+                if transformed[key].key? arr_v
                   raise InvalidNamespace, "duplicate entry: `#{[current_path, key, arr_v].compact.join(".")}`"
                 end
 
                 transformed[key][arr_v] = false
-              elsif arr_v.is_a?(Hash)
+              when Hash
                 transform_namespace(arr_v,
                                     current_path: [current_path, key].compact.join(".")).each_pair do |ts_k, ts_v|
                   transformed[key] ||= ::HashWithIndifferentAccess.new
-                  if transformed[key].has_key? ts_k
+                  if transformed[key].key? ts_k
                     raise InvalidNamespace, "duplicate entry: `#{[current_path, key, ts_k].compact.join(".")}`"
                   end
 
@@ -56,13 +62,13 @@ module Permisi
       def __deeply_sanitize_permissions(permission_hash, template: {})
         HashWithIndifferentAccess.new.tap do |sanitized|
           permission_hash.each_pair do |key, value|
-            next unless template.has_key?(key)
+            next unless template.key?(key)
 
-            if value.is_a?(Hash)
-              sanitized[key] = __deeply_sanitize_permissions(value, template: template[key])
-            else
-              sanitized[key] = __cast_value_to_boolean(value)
-            end
+            sanitized[key] = if value.is_a?(Hash)
+                               __deeply_sanitize_permissions(value, template: template[key])
+                             else
+                               __cast_value_to_boolean(value)
+                             end
           end
         end
       end

data/lib/permisi/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Permisi
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/permisi.gemspec

@@ -33,9 +33,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "activesupport", ">= 3.2.0"
-  spec.add_dependency "activerecord", ">= 3.2.0"
   spec.add_dependency "activemodel", ">= 3.2.0"
+  spec.add_dependency "activerecord", ">= 3.2.0"
+  spec.add_dependency "activesupport", ">= 3.2.0"
   spec.add_dependency "zeitwerk", ["~> 2.4", ">= 2.4.2"]
 
   # For more information and examples about making a new gem, checkout our

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: permisi
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Ukaza Perdana
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-15 00:00:00.000000000 Z
+date: 2021-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 3.2.0
 - !ruby/object:Gem::Dependency
-  name: activemodel
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -82,12 +82,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/workflows/main.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -100,12 +101,11 @@ files:
 - lib/generators/permisi/templates/migration.rb
 - lib/permisi.rb
 - lib/permisi/actable.rb
+- lib/permisi/backend.rb
 - lib/permisi/backend/active_record.rb
 - lib/permisi/backend/active_record/actor.rb
 - lib/permisi/backend/active_record/actor_role.rb
 - lib/permisi/backend/active_record/role.rb
-- lib/permisi/backend/base.rb
-- lib/permisi/backend/invalid_backend.rb
 - lib/permisi/backend/mongoid.rb
 - lib/permisi/config.rb
 - lib/permisi/permission_util.rb
@@ -133,7 +133,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: Simple and dynamic role-based access control for Rails

data/.github/workflows/main.yml

@@ -1,18 +0,0 @@
-name: Ruby
-
-on: [push,pull_request]
-
-jobs:
-  build:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby
-      uses: ruby/setup-ruby@v1
-      with:
-        ruby-version: 3.0.0
-    - name: Run the default task
-      run: |
-        gem install bundler -v 2.2.5
-        bundle install
-        bundle exec rake

data/lib/permisi/backend/base.rb

@@ -1,6 +0,0 @@
-module Permisi
-  module Backend
-    class Base
-    end
-  end
-end

data/lib/permisi/backend/invalid_backend.rb

@@ -1,9 +0,0 @@
-module Permisi
-  module Backend
-    class InvalidBackend < StandardError
-      def initialize(message = "Please specify a backend. For details, check https://github.com/ukazap/permisi#configuring-backend")
-        super
-      end
-    end
-  end
-end