rolistic 0.2.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 76c03ece2348ff3459a5a43e7d45adf0eeb2493f
-  data.tar.gz: 4509a6f3c5c0768d03b76b8be9fa753d70e90d35
+SHA256:
+  metadata.gz: 7356f50bf28651e088a35eac974c6c6d9a62472eaca0e1e766b17e4e449b9a1d
+  data.tar.gz: 591b0172a18126f9875da07938dc6fbb9576bd10fb6c6c7c221b7c3388dbb963
 SHA512:
-  metadata.gz: ea490af5effae8a0722378a75e25876164b96d1e15da6380babb0df8705e11bdffd39cb720e475dde06c2bd5533112ae068cb80c6bc5be6c7fd4cc0f5132cdd6
-  data.tar.gz: 95bf731807c0e34535fda73797e68fbcaf98f7e0650349e77446966fcb4560dadb5caa2158efcebd39a71a7de16fc60fe569f3a9d9f2e9ddbf3b9cc88b002697
+  metadata.gz: 57c3804494ee93ea246b43f4c1d34eab2b096eeeb093a6d0b1910b210fabf8d62835d394a9030b1582036b581cd820c1d6243a14668497ff85893e9b2ac69c56
+  data.tar.gz: e8efb268bb508d0568b25d4c5dc44673ba85caef2803e257489e16827bc665b56850fcee7c4981d076a6a4163bab452dfd7798d6d1b36fca9cbe8be81e03a146

data/README.md

@@ -2,7 +2,7 @@
 
 A simple DSL for role-based permissions.
 
-Inspired by tools like [`cancan`](https://github.com/ryanb/cancan) and [`pundit`](https://github.com/elabs/pundit) but intended to be even simpler.
+Inspired by tools like [`cancancan`](https://github.com/CanCanCommunity/cancancan) and [`pundit`](https://github.com/varvet/pundit) but intended to be even simpler.
 
 All permissions are identified by a single ability name. No need for objects or methods to manage policies for every type of domain object. Have a complex edge case? Just create a new ability for it specifically.
 
@@ -61,13 +61,19 @@ If you are using `ActiveRecord` your role class can easily be serialized to any
 
 ```ruby
 class User < ApplicationRecord
-  serialize :role, ForumRole
+  serialize :role, coder: ForumRole
   delegate :can?, to: :role
 end
 
 User.new(role: "registered").can?(:create_thread) # => true
 ```
 
+Rails 7.0 and earlier take the role class as a positional argument instead. Rails 7.1 deprecated this form and Rails 7.2 removed it.
+
+```ruby
+serialize :role, ForumRole
+```
+
 More usage examples can be found in `spec/rolistic_spec.rb`.
 
 ## Development

data/lib/rolistic/class_methods.rb

@@ -1,10 +1,12 @@
 module Rolistic
   module ClassMethods
+    NO_ABILITIES = Set.new.freeze
+
     def load(raw)
       case raw
       when self then raw
       when String, Symbol
-        new(raw) unless raw.blank?
+        raw.to_s.match?(/\A[[:space:]]*\z/) ? new : new(raw)
       else
         new
       end
@@ -29,38 +31,64 @@ module Rolistic
     end
 
     def abilities_for(name)
-      abilities_map.fetch(name) { [] }
+      find_role(name) || NO_ABILITIES
     end
 
     def abilities_for_trait(trait)
-      traits_map.fetch(trait) { abilities_for(name) }
+      find_trait(trait) || find_role(trait) ||
+        raise(DefinitionError, "no trait or role named #{trait.inspect} has been defined")
+    end
+
+    # roles and traits defined on a parent role class are visible to subclasses
+    def find_role(name)
+      abilities_map.fetch(name) { parent_role_class&.find_role(name) }
+    end
+
+    def find_trait(trait)
+      traits_map.fetch(trait) { parent_role_class&.find_trait(trait) }
+    end
+
+    def parent_role_class
+      superclass if superclass < Rolistic
     end
 
     def trait(trait, abilities)
-      traits_map[trait] = abilities
+      traits_map[trait] = Set.new(abilities).freeze
     end
     alias_method :add_trait, :trait
 
     def role(name, *traits_and_abilities, **options)
-      abilities = traits_and_abilities.reduce([]) do |m, t_or_a|
+      if traits_and_abilities.include?(:everything) && traits_and_abilities.size > 1
+        raise DefinitionError, "role #{name.inspect} has access to everything " \
+          "and cannot be combined with other traits or abilities"
+      end
+      abilities = traits_and_abilities.reduce(Set.new) do |m, t_or_a|
         case t_or_a
         when :everything then Everything
-        when Symbol then m + abilities_for_trait(t_or_a)
-        when Array then m + t_or_a
-        else t_or_a
+        when Symbol
+          trait_abilities = abilities_for_trait(t_or_a)
+          if trait_abilities == Everything
+            raise DefinitionError, "role #{name.inspect} cannot inherit from " \
+              "#{t_or_a.inspect}, which has access to everything; " \
+              "use :everything instead"
+          end
+          m | trait_abilities
+        when Array then m | t_or_a
+        else m
         end
       end
-      abilities_map[name] = abilities
+      abilities_map[name] = abilities == Everything ? Everything : abilities.freeze
       @default = name if options[:default]
     end
     alias_method :add_role, :role
 
     def default
-      @default if defined?(@default)
+      defined?(@default) ? @default : parent_role_class&.default
     end
 
     def available
-      abilities_map.keys
+      inherited = parent_role_class ? parent_role_class.available : []
+      inherited | abilities_map.keys
     end
   end
 end

data/lib/rolistic/errors.rb

@@ -0,0 +1,6 @@
+module Rolistic
+  class Error < StandardError; end
+
+  # Raised when the role/trait DSL is used incorrectly
+  class DefinitionError < Error; end
+end

data/lib/rolistic/version.rb

@@ -1,3 +1,3 @@
 module Rolistic
-  VERSION = "0.2.1"
+  VERSION = "1.0.0"
 end

data/lib/rolistic.rb

@@ -1,4 +1,5 @@
 require "rolistic/version"
+require "rolistic/errors"
 require "rolistic/class_methods"
 require "rolistic/everything"
 
@@ -20,6 +21,7 @@ module Rolistic
   end
 
   def can?(ability)
+    ability = ability.to_sym if ability.is_a?(String)
     abilities.member?(ability)
   end
 

metadata

@@ -1,57 +1,42 @@
 --- !ruby/object:Gem::Specification
 name: rolistic
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Carl Zulauf
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-27 00:00:00.000000000 Z
+date: 1980-01-01 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.14'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.14'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.13'
 description: Simple DSL to define roles and associated permissions.
 email:
 - carl@linkleaf.com
@@ -63,13 +48,16 @@ files:
 - README.md
 - lib/rolistic.rb
 - lib/rolistic/class_methods.rb
+- lib/rolistic/errors.rb
 - lib/rolistic/everything.rb
 - lib/rolistic/version.rb
 homepage: https://github.com/carlzulauf/rolistic
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  source_code_uri: https://github.com/carlzulauf/rolistic
+  bug_tracker_uri: https://github.com/carlzulauf/rolistic/issues
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -77,16 +65,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
-signing_key: 
+rubygems_version: 3.7.2
 specification_version: 4
 summary: Role based permissions
 test_files: []