permission_settings 1.0.2 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b7e8f088255b5705c519dd4df6b9ec6b4ef48b8f4262d858ecf1dab07637824
-  data.tar.gz: 1a8df3edb52e651d486c1c654d86478544071fe0cd5b6c52b0d551ad15997472
+  metadata.gz: 8e3d221f8775059aa809aa4d2f1209859688005a8019da2729b0d9c153ec2cb2
+  data.tar.gz: 5464c88c540fc443cbeb3da665c8d973688274920693f25c555b0bef646e8467
 SHA512:
-  metadata.gz: b65e864cd3ee5be7cb15960da4fd7ade1132b1b9bf059c7a4249db59b9e1bc27f9487abff6e49390842f2f0fdc5a7e2effb05fd1b3724307155214237b3ddfdf
-  data.tar.gz: 9c4aae8ff03cf38dd5ca6e097fa67b965ba4afe40019a4169188751967de8c5dc6a0f4423d7f921e00b97dc64a7ad50d1571498a360efeec2c280aeb5e2b83f7
+  metadata.gz: 82fd496bbd08ff3cd48657cc86cfccade0b187bf51a313265daae5304d1839c7b62b610d9dba676cbc4870ac005c4170d294a85b85ff4105e3bcaad72e0ecca9
+  data.tar.gz: b34b702372daf1b6c2b1cc9386c0e4ac7503833eb316ad8795523b73b6c92814b6047dfb8548a7476549c08f664b3623a62de61ed3085b9bc9ccfb8a86574ee3

data/.rubocop.yml

@@ -15,7 +15,7 @@ Style/StringLiteralsInInterpolation:
   EnforcedStyle: double_quotes
 
 Layout/LineLength:
-  Max: 120
+  Max: 150
 
 Style/Documentation:
   Enabled: false

data/CHANGELOG.md

@@ -1,4 +1,12 @@
-## [1.0.1] - 2024-02-19
+## [1.0.3] - 2024-02-19
+
+- Readme update
+- Better PermissionsDirNotFound error message and handling
+- Added `permissions` method to get permissions of the calling instance
+- Added test core coverage
+
+
+## [1.0.2] - 2024-02-19
 
 - Commented out `byebug` in the code
 

data/README.md

@@ -24,7 +24,7 @@ Generate and run the migration to create the settings table that is used to stor
 
 ```shell
 rails g rails_settings:migration
-rake db:migrate
+rails db:migrate
 ```
 
 ## Usage
@@ -36,7 +36,7 @@ You can configure the gem by calling `PermissionSettings.configure` method in an
 ```ruby 
 # config/initializers/permission_settings.rb
 
-PermissionSettings.configure do |_config|
+PermissionSettings.configure do |config|
   config.permissions_dir_path = 'config/permissions'
   config.role_access_method = :role
 end
@@ -98,7 +98,7 @@ end
 
 In order to check permissions of the resource instance you need to pass it as a named argument `resource` to the `#can?` method.
 
-Take into account that the resource model should have a `role` filed or method that returns a role name of the calling instance or you can configure the gem to use another method name by setting `role_access_method` configuration option.
+Take into account that the resource model should have a `role` field or method that returns a role name of the calling instance or you can configure the gem to use another method name by setting `role_access_method` configuration option.
 
 ### Checking permissions
 
@@ -111,8 +111,8 @@ user.can?(:read, :notifications, resource: person) # => true
 ```
 
 Method `can?` accepts 2 arguments:
-* `*permission_keys` - this keys will be used to find permissions in the settings. It can be a string or an array of strings. Required argument.
-* `*resource` - Named argument resource. Instance towards which the permissions will be checked. Required argument.
+* `*permission_keys` - this keys will be used to find permissions in the settings. It can be a string or an array of strings. `Required argument`.
+* `*resource` - Named argument resource. Instance towards which the permissions will be checked. `Required argument`.
 
 ### Accessing permissions
 
@@ -120,7 +120,7 @@ You can also access permissions of the resource or calling instance by calling `
 
 ```ruby
 person = Person.last # => #<Person id: 2, name: "Jane", role: "client">
-person.settings[PermissionSettings.configuration.scope_name].admin.notifications.read # => false
+person.permissions[:admin][:notifications][:read] # => false
 ```
 
 More about settings you can read in [Rails Settings](https://github.com/ledermann/rails-settings) gem documentation.
@@ -167,7 +167,8 @@ custom_permissions = {
 admin = User.first # => #<User id: 1, name: "John", role: "admin">
 person = Person.last # => #<User id: 2, name: "Jane", role: "client">
 
-person.settings(PermissionSettings.configuration.scope_name).update(custom_permissions)
+policy_scope = PermissionSettings.configuration.scope_name(User)
+person.settings(policy_scope).update(custom_permissions)
 
 admin.can?(:read, :notifications, resource: person) # => false
 

data/lib/permission_settings/configuration.rb

@@ -9,20 +9,13 @@ module PermissionSettings
     DEFAULT_PERMISSION_FILE_PATH = 'config/permissions'
     DEFAULT_ROLE_ACCESS_METHOD = :role
 
-    attr_accessor :role_access_method
-    attr_reader :permissions_dir_path
+    attr_accessor :role_access_method, :permissions_dir_path
 
     def initialize
       @permissions_dir_path = DEFAULT_PERMISSION_FILE_PATH
       @role_access_method = DEFAULT_ROLE_ACCESS_METHOD
     end
 
-    def permissions_dir_path=(path)
-      raise PermissionsDirNotFound, 'Permissions directory not found' unless Dir.exist?(path)
-
-      @permissions_dir_path = path
-    end
-
     def scope_name(klass)
       [klass.name.underscore, 'permissions'].join('_').to_sym
     end

data/lib/permission_settings/patcher.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 # require 'byebug'
+require 'active_record'
+require 'rails-settings'
 require_relative 'verify_instance'
 
 module PermissionSettings
@@ -17,12 +19,25 @@ module PermissionSettings
     end
 
     def call
+      check_permissions_dir
       setup_settings_interface
       setup_instance_verification
+      setup_permissions_method
     end
 
     private
 
+    def check_permissions_dir
+      path = PermissionSettings.configuration.permissions_dir_path
+      return if Dir.exist?(path)
+
+      raise PermissionSettings::Configuration::PermissionsDirNotFound, dir_missing_message(path)
+    end
+
+    def dir_missing_message(path)
+      "Permissions config directory not found. Please create a directory at #{path} and add permission files there."
+    end
+
     def setup_settings_interface
       klass.class_eval do
         has_settings do |s|
@@ -44,5 +59,18 @@ module PermissionSettings
         end
       end
     end
+
+    def setup_permissions_method
+      klass.class_eval do
+        define_method(:permissions) do
+          scope = PermissionSettings.configuration.scope_name(self.class)
+          settings(scope).then do |permissions|
+            return ActiveSupport::HashWithIndifferentAccess.new(permissions.value) if permissions.value.present?
+
+            ActiveSupport::HashWithIndifferentAccess.new(default_settings[scope])
+          end
+        end
+      end
+    end
   end
 end

data/lib/permission_settings/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PermissionSettings
-  VERSION = '1.0.2'
+  VERSION = '1.0.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: permission_settings
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.4
 platform: ruby
 authors:
 - Misha Push
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-02-19 00:00:00.000000000 Z
+date: 2024-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport