simon_says 0.2.0 → 0.3.0.alpha.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6c3b6bd7983eb136f044c2653430143493637871
-  data.tar.gz: a66d00fe12a96f48e8865a61aaf61f145feb5007
+  metadata.gz: c6bf629f417e1bd66bf820ee52c333aacfe0e25a
+  data.tar.gz: 340919dff4421094ec54d4b75e0446b54f522a10
 SHA512:
-  metadata.gz: 284e3a2a74a36d1ae52aa78849a347f38071b4c5838dc43b60cdba794fd9bed021054941b44b44d28744511a3af57eb6764108ae087b7bf1d17e96b03f1f1e8a
-  data.tar.gz: dea0bc94572281d6b505ef4a3eb2ed0fb502e916483e122cf19f34444dfaf12947e374065495f2b2edd3c8a0e370b45a5454a1075c56daec896f642a02ae451e
+  metadata.gz: c2f679703c9bd5fb566ee181498131d069c6ad5e3de83957cb2e8a8a3777a6c194589a399a58e4272906c1e8e89f309101ad23103f1b5e515e7d747edc0c9055
+  data.tar.gz: 1aae317daf655c2dcbcf425ef2eeeff492212003a4256501f72c5278239aeb8f57b861051a407d8f35af5467e8f2f10466695e9a5eeaec887c3d050c02129ef4

data/README.md

@@ -12,7 +12,7 @@ Rails that works great with devise!
 
 ### Installation
 
-SimonSays can be installed via your Gemfile or using Ruby gems directly.
+SimonSays can be installed via your Gemfile.
 
 ```ruby
 gem 'simon_says'
@@ -22,21 +22,23 @@ gem 'simon_says'
 
 SimonSays consists of two parts:
 
-1. A [Roleable](#roleable) concern which provides a way to define access roles
-   on User models or on join through models.
-2. An [Authorizer](#authorizer) concern which provides a declarative API
-   to controllers for finding and authorizing model resources.
+1. A [Roleable](#roleable) module mixin which provides a way to define
+   roles on User models or on join through models.
+2. An [Authorizer](#authorizer) module mixin which provides a
+   declarative API to controllers for finding and authorizing resources.
 
 #### Roleable
 
 First, we need to define some roles on a model. Roles are stored as an
 integer and [bitmasking](https://en.wikipedia.org/wiki/Mask_(computing))
-is used to determine the roles assigned for that model. SimonSays
+is used to determine the roles assigned for given record. SimonSays
 provides a generator for creating a new migration for this required
 attribute:
 
 ```bash
+rails g model User # if and only if this model does not yet exist
 rails g active_record:simon_says User
+rails db:migrate
 ```
 
 Now we can define some roles in our User model. For example:
@@ -51,14 +53,16 @@ end
 # > User.new.roles
 # => []
 
-# > u = User.new(roles: %i[add edit])
-#
+# > u = User.create(roles: %i[add edit])
+# => #<User ...>
 # > u.roles
 # => [:add, :edit]
 # > u.has_add?
 # => true
 # > u.has_delete?
 # => false
+# > u.update roles: %i[delete add edit]
+# > u.save # save record with roles_mask of 7
 ```
 
 The attribute name can be customized by using the `:as` option as seen
@@ -103,11 +107,20 @@ end
 # => [:download, :edit, :delete]
 ```
 
-It is useful to note the dynamically generated `has_` methods as shown
-in the User model as well the `ROLES` constant which is used in the
-Permission example. Take a look at the `Roleable`
+`Roleable` also creates two scopes that can be used to find records that
+have a given set roles. Using the default attribute name, the two scopes
+generated would be `with_roles` and `with_all_roles`. Both methods
+accept one or more role symbols as its arguments. The first scope,
+`with_roles`, will find any record with one or more the supplied roles.
+The second scope, `with_all_roles` will only find record that have all
+of the supplied roles.
+
+It is useful to note the various dynamically generated methods as well
+the `ROLES` constant, which is used in the Permission example. Take a
+look at the `Roleable`
 [source code](https://github.com/SimplyBuilt/SimonSays/blob/master/lib/simon_says/roleable.rb)
-to see how features are dynamically generated with `has_roles`.
+to see how methods and scopes are dynamically generated with
+`has_roles`.
 
 #### Authorizer
 

data/lib/simon_says/roleable.rb

@@ -71,11 +71,11 @@ module SimonSays
             args.compact!
             args.map!(&:to_sym)
 
-            self[:#{name}_mask] = (args & #{const}).map { |i| 2 ** #{const}.index(i) }.sum
+            self.#{name}_mask = (args & #{const}).map { |i| 2 ** #{const}.index(i) }.sum
           end
 
           def #{name}
-            #{const}.reject { |i| ((#{name}_mask || 0) & 2 ** #{const}.index(i)).zero? }
+            #{const}.reject { |i| ((#{name}_mask || 0) & 2 ** #{const}.index(i)).zero? }.tap(&:freeze)
           end
 
           def has_#{name}?(*args)
@@ -93,12 +93,40 @@ module SimonSays
           RUBY_EVAL
         end
 
-        # Declare a scope for finding records with a given role set
-        # TODO support an array roles (must match ALL)
-        scope "with_#{name}", ->(role) {
-          where("(#{name}_mask & ?) > 0", 2**roles.index(role.to_sym))
-        }
+        # Try to declare ActiveRecord scopes or Sequel subsets for finding
+        # records with a given set of roles
+
+        scope_method = respond_to?(:scope) ? :scope : respond_to?(:subset) ? :subset : nil
+
+        if scope_method
+          send scope_method, "with_#{name}", ->(*args) {
+            clause = "#{name}_mask & ?"
+            values = Roleable.roles2ints(roles, *args)
+
+            query = where(clause, values.shift)
+            query = query.or(where(clause, values.shift)) until values.empty?
+            query
+          }
+
+          send scope_method, "with_all_#{name}", ->(*args) {
+            clause = "#{name}_mask & ?"
+            values = Roleable.roles2ints(roles, *args)
+
+            query = where(clause, values.shift)
+            query = query.where(clause, values.shift) until values.empty?
+            query
+          }
+        end
       end
     end
+
+    def self.roles2ints(defined_roles, *args)
+      values = args.map do |arg|
+        index = defined_roles.index(arg)
+        index ? 2 ** index : nil
+      end
+
+      values.tap(&:flatten!)
+    end
   end
 end

data/lib/simon_says/version.rb

@@ -1,3 +1,3 @@
 module SimonSays
-  VERSION = '0.2.0'
+  VERSION = '0.3.0.alpha.1'
 end

data/test/simon_says/roleable_test.rb

@@ -132,15 +132,34 @@ class RoleableTest < ActiveSupport::TestCase
   test "named scope with_roles" do
     assert_equal [2, 1], [
       Membership.with_roles(:download).count,
-      Membership.with_roles(:delete).count
+      Membership.with_roles(:edit, :delete).count,
     ]
   end
 
   test "named scope with_access" do
-    assert_equal [2, 2, 2], [
-      Admin.with_access(:marketing).count,
+    assert_equal [2, 3, 4], [
       Admin.with_access(:content).count,
-      Admin.with_access(:support).count
+      Admin.with_access(:content, :marketing).count,
+      Admin.with_access(:content, :marketing, :support).count
+    ]
+  end
+
+  test "named scope with_all_roles" do
+    memberships(:mb1).update roles: %i[download fork edit]
+    memberships(:mb2).update roles: %i[download fork]
+
+    assert_equal [2, 0], [
+      Membership.with_all_roles(:download, :fork).count,
+      Membership.with_all_roles(:download, :fork, :edit, :delete).count
+    ]
+  end
+
+  test "named scope with_all_access" do
+    Admin.create(access: %i[content marketing])
+
+    assert_equal [2, 1], [
+      Admin.with_all_access(:content, :marketing).count,
+      Admin.with_all_access(:content, :marketing, :support).count
     ]
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simon_says
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0.alpha.1
 platform: ruby
 authors:
 - Michael Coyne
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-07 00:00:00.000000000 Z
+date: 2018-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -231,9 +231,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.6.13