rolistic 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 46c090f1f28f35a7ba10b34d95ff3d0aa5740a52
-  data.tar.gz: 23f8a625cb8ffdb60603c61cf1d8bcb3bc66cb56
+  metadata.gz: f91550f1333bb0466e4a35bf3567cc51c4ef53c7
+  data.tar.gz: 27263d1e23f74b953ddbb807d6d98dd01f39c1c9
 SHA512:
-  metadata.gz: d8498998f018830c711df49fccbf96e20014395718866beed6930277eb71e48e58b8f388fb3052f33e8a76bfc4228a04fa864db1638cb36711c2f252b212b9dd
-  data.tar.gz: 249cf7c8084e412853ffdea56d56e0594fc3ff78e39cb37cd6e209788dd2fe4756cfd7ba627179829361cd7d4e6ac9812ee1f5accadbb5ec9e7d40a728b3ed57
+  metadata.gz: d6b2a485bf18ed8ee2b5a31072d7df69a7099b14b1986a462d8f8dd2fe97b8106471ef4022b435f6fdd6def7ab22e256d0391da5f77aeab48c7f600be9d9ea98
+  data.tar.gz: 4e7e13bc52bd18ea3bce59ad1de109b31141d3ad26a84b0accf170044e76ef16d655b3fcc20acbf260ef4f5171f1e0dbd4046d68bec1e9662231cd099fc2144c

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Carl Zulauf
+
+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,86 @@
+# Rolistic
+
+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.
+
+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.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rolistic'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rolistic
+
+## Usage
+
+Create a class to house your roles and their permissions.
+
+```ruby
+class ForumRole
+  include Rolistic
+  # traits allow you to categorize abilities shared by multiple roles
+  trait :moderation, %i(delete_thread edit_thread)
+
+  role :anonymous, %i(vote_in_polls reply_to_thread), default: true
+
+  # roles can inherit abilities from existing roles, plus add their own
+  role :registered, :anonymous, %i(edit_own_thread create_thread)
+
+  role :moderator, :registered, :moderation
+  role :silent_moderator, :moderation
+
+  # special `everything` trait has access to all abilities, even unnamed ones
+  role :developer, :everything
+end
+```
+
+Instances of your role class tell you what they can do.
+
+```ruby
+ForumRole.new(:registered).can?(:vote_in_polls) # => true
+ForumRole.new("moderator").can?(:edit_thread)   # => true
+ForumRole.new(:anonymous).can?(:create_thread)  # => false
+ForumRole.new(:developer).can?(:introduce_bugs) # => true
+
+# Use the default role
+ForumRole.new.can?(:reply_to_thread) # => true
+```
+
+If you are using `ActiveRecord` your role class can easily be serialized to any string column.
+
+```ruby
+class User < ApplicationRecord
+  serialize :role, ForumRole
+  delegate :can?, to: :role
+end
+
+User.new(role: "registered").can?(:create_thread) # => true
+```
+
+More usage examples can be found in `spec/rolistic_spec.rb`.
+
+## 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 tags, 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/carlzulauf/rolistic. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/rolistic.rb

@@ -0,0 +1,33 @@
+require "rolistic/version"
+require "rolistic/class_methods"
+require "rolistic/everything"
+
+module Rolistic
+  def self.included(klass)
+    klass.class_exec do
+      attr_reader :name, :abilities
+      extend ClassMethods
+    end
+  end
+
+  def initialize(name = self.class.default)
+    @name = name.to_sym if name
+    @abilities = self.class.abilities_for(@name)
+  end
+
+  def to_s
+    name.to_s
+  end
+
+  def can?(ability)
+    abilities.member?(ability)
+  end
+
+  def default?
+    name == self.class.default
+  end
+
+  def inspect
+    "#<#{self.class} :#{to_s}>"
+  end
+end

data/lib/rolistic/class_methods.rb

@@ -0,0 +1,65 @@
+module Rolistic
+  module ClassMethods
+    def load(raw)
+      case raw
+      when self then raw
+      when String, Symbol
+        new(raw) unless raw.blank?
+      else
+        new
+      end
+    end
+
+    def dump(role)
+      case role
+      when String, Symbol then role.to_s
+      when self
+        role.to_s unless role.default?
+      end
+    end
+
+    def abilities_map
+      return @abilities_map if defined?(@abilities_map)
+      @abilities_map = {}
+    end
+
+    def traits_map
+      return @traits_map if defined?(@traits_map)
+      @traits_map = {everything: Everything}
+    end
+
+    def abilities_for(name)
+      abilities_map.fetch(name) { [] }
+    end
+
+    def abilities_for_trait(trait)
+      traits_map.fetch(trait) { abilities_for(name) }
+    end
+
+    def trait(trait, abilities)
+      traits_map[trait] = abilities
+    end
+    alias_method :add_trait, :trait
+
+    def role(name, *traits_and_abilities, **options)
+      abilities = traits_and_abilities.reduce([]) do |m, t_or_a|
+        case t_or_a
+        when Symbol then m + abilities_for_trait(t_or_a)
+        when Array then m + t_or_a
+        else t_or_a
+        end
+      end
+      abilities_map[name] = abilities
+      @default = name if options[:default]
+    end
+    alias_method :add_role, :role
+
+    def default
+      @default if defined?(@default)
+    end
+
+    def available
+      abilities_map.keys
+    end
+  end
+end

data/lib/rolistic/everything.rb

@@ -0,0 +1,7 @@
+module Rolistic
+  module Everything
+    def self.member?(*)
+      true
+    end
+  end
+end

data/lib/rolistic/version.rb

@@ -0,0 +1,3 @@
+module Rolistic
+  VERSION = "0.2.0"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rolistic
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Carl Zulauf
@@ -58,7 +58,13 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/rolistic.rb
+- lib/rolistic/class_methods.rb
+- lib/rolistic/everything.rb
+- lib/rolistic/version.rb
 homepage: https://github.com/carlzulauf/rolistic
 licenses:
 - MIT