rabarber 1.0.3 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f83c97e518621ea7749eab381d5e1e4f84785c8197036e923220fa0d29fcc43e
-  data.tar.gz: 9fe75afecf6c3066c0cbf779ffdf79a2e67716a8acdc0f15c72e85008528f5ab
+  metadata.gz: e54ea7ddbb816cbc279edf4cb5d8863086fb452528f1403da9c944e4d23b862a
+  data.tar.gz: a6cc1c88ced2c76561c368669e6413a476b7590fa105a9876a6dfcbd139c2b41
 SHA512:
-  metadata.gz: 407ed9c374cbe8dafd964aa939f342d47a307bd101e2932bf8ae12c526f48a75524df6eb6f6f35a6a3fb4a023f7db5e50a7c04b580f56fde06ccfcc09f431df8
-  data.tar.gz: 4cfcde7d7b6ed23faff8d0e6f8f036c641ecf6dfb18e1b075dbdfd6aaa5f8391dfdf13ea7e25b70b7881489fc3b292791f663c6c70b1a32a634e7caf681a2355
+  metadata.gz: ae10eca6248824b4dab6a7038b813933ee9ecaab1fd1cce67ef07ed95fdb0a77f5f70b3138574e9b42ea5d570da2a56186845978950b1fda03240e836cb07f8f
+  data.tar.gz: f8f4e00a8b76a8eb7a23e7ad7088ab38325e23ebd2ccab43b744def1d977b531f02866025c56f982578d3af8894582756bd980057159095a1bfe9eb3f6d261d5

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 1.0.5
+
+- Add co-author: [trafium](https://github.com/trafium)
+
+## 1.0.4
+
+- Allow to use strings as role names
+
 ## 1.0.3
 
 - Enhance clarity by improving error types and messages

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2023 enjaku4
+Copyright (c) 2023 enjaku4, trafium
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/lib/rabarber/configuration.rb

@@ -21,19 +21,21 @@ module Rabarber
     end
 
     def current_user_method=(method_name)
-      raise ConfigurationError, "current_user_method must be a symbol" unless method_name.is_a?(Symbol)
+      unless (method_name.is_a?(Symbol) || method_name.is_a?(String)) && method_name.present?
+        raise ConfigurationError, "Configuration 'current_user_method' must be a Symbol or a String"
+      end
 
       @current_user_method = method_name.to_sym
     end
 
     def must_have_roles=(value)
-      raise ConfigurationError, "must_have_roles must be a boolean" unless [true, false].include?(value)
+      raise ConfigurationError, "Configuration 'must_have_roles' must be a Boolean" unless [true, false].include?(value)
 
       @must_have_roles = value
     end
 
     def when_unauthorized=(callable)
-      raise ConfigurationError, "when_unauthorized must be a proc" unless callable.is_a?(Proc)
+      raise ConfigurationError, "Configuration 'when_unauthorized' must be a Proc" unless callable.is_a?(Proc)
 
       @when_unauthorized = callable
     end

data/lib/rabarber/models/concerns/has_roles.rb

@@ -19,36 +19,23 @@ module Rabarber
     end
 
     def has_role?(*role_names)
-      validate_role_names(role_names)
-
-      (roles & role_names).any?
+      (roles & RoleNames.pre_process(role_names)).any?
     end
 
     def assign_roles(*role_names, create_new: true)
-      validate_role_names(role_names)
+      roles_to_assign = RoleNames.pre_process(role_names)
 
-      create_new_roles(role_names) if create_new
+      create_new_roles(roles_to_assign) if create_new
 
-      rabarber_roles << Role.where(name: role_names) - rabarber_roles
+      rabarber_roles << Role.where(name: roles_to_assign) - rabarber_roles
     end
 
     def revoke_roles(*role_names)
-      validate_role_names(role_names)
-
-      self.rabarber_roles = rabarber_roles - Role.where(name: role_names)
+      self.rabarber_roles = rabarber_roles - Role.where(name: RoleNames.pre_process(role_names))
     end
 
     private
 
-    def validate_role_names(role_names)
-      return if role_names.all? { |role_name| role_name.is_a?(Symbol) && role_name.to_s.match?(Role::NAME_REGEX) }
-
-      raise(
-        InvalidArgumentError,
-        "Role names must be symbols and may only contain lowercase letters, numbers and underscores"
-      )
-    end
-
     def create_new_roles(role_names)
       new_roles = role_names - Role.names
       new_roles.each { |role_name| Role.create!(name: role_name) }

data/lib/rabarber/models/role.rb

@@ -4,9 +4,7 @@ module Rabarber
   class Role < ActiveRecord::Base
     self.table_name = "rabarber_roles"
 
-    NAME_REGEX = /\A[a-z0-9_]+\z/
-
-    validates :name, presence: true, uniqueness: true, format: { with: NAME_REGEX }
+    validates :name, presence: true, uniqueness: true, format: { with: RoleNames::REGEX }
 
     def self.names
       pluck(:name).map(&:to_sym)

data/lib/rabarber/role_names.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Rabarber
+  module RoleNames
+    module_function
+
+    REGEX = /\A[a-z0-9_]+\z/
+
+    def pre_process(role_names)
+      return role_names.map(&:to_sym) if role_names.all? do |role_name|
+        (role_name.is_a?(Symbol) || role_name.is_a?(String)) && role_name.to_s.match?(REGEX)
+      end
+
+      raise(
+        InvalidArgumentError,
+        "Role names must be Symbols or Strings and may only contain lowercase letters, numbers and underscores"
+      )
+    end
+  end
+end

data/lib/rabarber/rule.rb

@@ -5,9 +5,9 @@ module Rabarber
     attr_reader :action, :roles, :custom
 
     def initialize(action, roles, custom)
-      @action = validate_action(action)
-      @roles = validate_roles(roles)
-      @custom = validate_custom_rule(custom)
+      @action = pre_process_action(action)
+      @roles = RoleNames.pre_process(Array(roles))
+      @custom = pre_process_custom_rule(custom)
     end
 
     def verify_access(user_roles, custom_rule_receiver, action_name = nil)
@@ -38,29 +38,18 @@ module Rabarber
       end
     end
 
-    def validate_action(action)
-      return action if action.nil? || action.is_a?(Symbol)
+    def pre_process_action(action)
+      return action.to_sym if (action.is_a?(String) || action.is_a?(Symbol)) && action.present?
+      return action if action.nil?
 
-      raise InvalidArgumentError, "Action name must be a symbol"
+      raise InvalidArgumentError, "Action name must be a Symbol or a String"
     end
 
-    def validate_roles(roles)
-      roles_array = Array(roles)
+    def pre_process_custom_rule(custom)
+      return custom.to_sym if (custom.is_a?(String) || custom.is_a?(Symbol)) && action.present?
+      return custom if custom.nil? || custom.is_a?(Proc)
 
-      return roles_array if roles_array.empty? || roles_array.all? do |role|
-        role.is_a?(Symbol) && role.match?(Role::NAME_REGEX)
-      end
-
-      raise(
-        InvalidArgumentError,
-        "Role names must be symbols and may only contain lowercase letters, numbers and underscores"
-      )
-    end
-
-    def validate_custom_rule(custom)
-      return custom if custom.nil? || custom.is_a?(Symbol) || custom.is_a?(Proc)
-
-      raise InvalidArgumentError, "Custom rule must be a symbol or a proc"
+      raise InvalidArgumentError, "Custom rule must be a Symbol, a String, or a Proc"
     end
   end
 end

data/lib/rabarber/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Rabarber
-  VERSION = "1.0.3"
+  VERSION = "1.0.5"
 end

data/lib/rabarber.rb

@@ -6,13 +6,12 @@ require_relative "rabarber/configuration"
 require "active_record"
 require "active_support"
 
-require_relative "rabarber/controllers/concerns/authorization"
+require_relative "rabarber/role_names"
 
+require_relative "rabarber/controllers/concerns/authorization"
 require_relative "rabarber/helpers/helpers"
-
-require_relative "rabarber/models/role"
 require_relative "rabarber/models/concerns/has_roles"
-
+require_relative "rabarber/models/role"
 require_relative "rabarber/permissions"
 
 module Rabarber

data/rabarber.gemspec

@@ -5,7 +5,7 @@ require_relative "lib/rabarber/version"
 Gem::Specification.new do |spec|
   spec.name = "rabarber"
   spec.version = Rabarber::VERSION
-  spec.authors = ["enjaku4"]
+  spec.authors = ["enjaku4", "trafium"]
   spec.email = ["enjaku4@gmail.com"]
 
   spec.summary = "Simple authorization library for Ruby on Rails."

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: rabarber
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.5
 platform: ruby
 authors:
 - enjaku4
+- trafium
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-01 00:00:00.000000000 Z
+date: 2024-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -44,6 +45,7 @@ files:
 - lib/rabarber/models/concerns/has_roles.rb
 - lib/rabarber/models/role.rb
 - lib/rabarber/permissions.rb
+- lib/rabarber/role_names.rb
 - lib/rabarber/rule.rb
 - lib/rabarber/version.rb
 - rabarber.gemspec