controlist 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 641ff1fb7c170c5e3d33641eebb63e8d6ab42fcc
-  data.tar.gz: beb6c94f12192612b39df5b868ecc77a999eef68
+  metadata.gz: 865e5bff5b151ade402fd35e38acd252bdf5e901
+  data.tar.gz: 02524edfe03062a87bf1fec159ec6903ceaf715b
 SHA512:
-  metadata.gz: 65809c604627384c839c55d55eae91dab922cb6c95999d129bf196647073d0bb5e5c4dd009708f4f5620ce5465d8ca5d3d54c832a5a6a4d07dd004ce47f7704a
-  data.tar.gz: 86817ef4ae15ce9409f099c54a8cf0913c4a2ff6d063fa85c7e3e86535e7005969acad42eda4e8e67e21abfffecb7754757b6a85778ae050e75ef38401c9ec76
+  metadata.gz: 219e463aae3771abe5bb1f1ce92354c63aca4fad5b134f6617dfd12ef4cccb9978e8b4a337bcfd75677c9b4c065cc4d367cc70eb2e09187e2b9c69a4329c51c5
+  data.tar.gz: 02c56861870bf5ac7a06c91fae55830dc6d2984bd05bb7ea50779a5181e8859a6e84d8fa90897843063ca4a8db436b662ac253e8990c498bc3b7f0a4eeeca314

data/README.md

@@ -17,7 +17,7 @@ Controlist support Ruby 1.9 and 2.x, ActiveRecord 3.2 and 4.1+
 * Support association level permission
 * Filter attributes for READ permission
 * Check changed and previous value for persistence operation
-* CRUD permission support lambda, argument is "Relation" for READ or "Object" for persistence(ActiveRecord 4.1+)
+* CRUD permission support lambda, argument is "Relation" for READ or "Object" for persistence
 * Attribute value check support lambda and raw sql
 * Modify permissions on the fly
 * Skip permission check on demand
@@ -52,17 +52,19 @@ You can use your customized manager or configuration to initialize Controlist
 
 ```ruby
 require 'controlist'
-Controlist.initialize YourManager #, attribute_proxy: "_val", value_object_proxy: "_value_object", logger: Logger.new(STDOUT)
+Controlist.initialize YourManager #logger: Logger.new(STDOUT)
 
 ```
 
 ## Example
 
 ```ruby
+
+# For read
 Controlist.permission_manager.set_permission_package(OrderedPackage.new(
   Controlist::Permission.new(User, READ, true, [
     SimpleConstrain.new("name", "Tom"),
-    SimpleConstrain.new("name", ["Grade 1", "Grade 2"], relation: "clazz"),
+    AdvancedConstrain.new(property: "name", value: ["Grade 1", "Grade 2"], relation: "clazz"),
     AdvancedConstrain.new(property: "age", value: 5, operator: ">="),
     SimpleConstrain.new("age", "null"),
     SimpleConstrain.new("age", [1,2,3]),
@@ -70,14 +72,38 @@ Controlist.permission_manager.set_permission_package(OrderedPackage.new(
     AdvancedConstrain.new(clause: "age != 100"),
     AdvancedConstrain.new(proc_read: lambda{|relation| relation.order("id DESC").limit(3) })
   ])))
-relation = User.all
-relation.to_sql
-assert_equal [:clazz], relation.joins_values
-assert_equal ["(users.name = 'Tom') and (clazzs.name in ('Grade 1','Grade 2'))" +
-              " and (users.age >= 5) and (users.age is null) and (users.age in (1,2,3))" +
-              " and (users.clazz_id in (1,2)) and (age != 100)"], relation.where_values
-assert_equal 3, relation.limit_value
-assert_equal ["id DESC"], relation.order_values
+
+relation = User.unscoped
+sql = relation.to_sql
+assert_equal true, sql.include?("((users.name = 'Tom') and (clazzs.name in ('Grade 1','Grade 2')) and (users.age >= 5) and (users.age is null) and (users.age in (1,2,3)) and (users.clazz_id in (1,2,3)) and (age != 100)) ORDER BY id DESC LIMIT 3")
+
+# For persistence
+...
+Controlist::Permission.new(User, UPDATE, false, AdvancedConstrain.new(property: "name", value: "To", operator: "include?")),
+Controlist::Permission.new(User, UPDATE, false, AdvancedConstrain.new(proc_persistence: lambda{|object, operation| object.name == "Block"})),
+Controlist::Permission.new(User, [UPDATE, DELETE], false, AdvancedConstrain.new(property: "name", value: ["Grade 1", "Grade 3"], relation: "clazz")),
+...
+
+# For apply attribute
+...
+Controlist::Permission.new(User, READ).apply(:name)
+Controlist::Permission.new(User, UPDATE, true, SimpleConstrain.new("name", "Tom")).apply(name: "Test", clazz_id: [1, 2]),
+
+# For skip
+
+...
+Controlist.skip do
+  relation = User.unscoped
+  sql = relation.to_sql
+  assert_equal "SELECT \"users\".* FROM \"users\"", sql.strip
+end
+...
+
+# For modification on the fly
+package = Controlist.permission_manager.get_permission_package
+package.remove_permissions package.permissions.last
+package.add_permissions Controlist::Permission.new(User, READ)
+
 ```
 
 And more examples, please see [more examples](https://github.com/alo7/controlist/blob/master/test/feature_test.rb)

data/lib/controlist.rb

@@ -10,6 +10,21 @@ module Controlist
 
     attr_accessor :permission_manager, :attribute_proxy, :value_object_proxy, :logger
 
+    ##
+    # example:
+    #       Controlist.initialize Controlist::Managers::ThreadBasedManager
+    #           attribute_proxy: "_val",
+    #           value_object_proxy: "_value_object",
+    #           logger: Logger.new(STDOUT)
+    #
+    # attribute_proxy and value_object_proxy are to avoid ActiveModel::MissingAttributeError
+    # due to select(attributes) according to constrains, suppose attribute_proxy is :_val,
+    # value_object_proxy is :_value_object
+    #       user = User.find 1
+    #       user.id
+    #       user._val(:attr_might_not_be_accessed)
+    #       user._value_object.attr_might_not_be_accessed
+    #
     def initialize(permission_manager, config={})
       @permission_manager = permission_manager
       @attribute_proxy = config[:attribute_proxy] || "_val"
@@ -18,6 +33,15 @@ module Controlist
       Interceptor.hook
     end
 
+
+    ##
+    #  Skip Controlist interceptor
+    #
+    #      Controlist.skip do
+    #        relation = User.unscoped
+    #        sql = relation.to_sql
+    #        assert_equal "SELECT \"users\".* FROM \"users\"", sql.strip
+    #      end
     def skip
       @permission_manager.enable_skip
       result = yield
@@ -36,6 +60,11 @@ module Controlist
     def enable_logger
       @logger_enabled = true
     end
-  end
 
+    def has_permission(klass, operation)
+      permission_package = @permission_manager.get_permission_package
+      permission_package && permission_package.has_permission(klass, operation)
+    end
+
+  end
 end

data/lib/controlist/interceptor.rb

@@ -21,11 +21,6 @@ module Controlist
 
       private
 
-      # Avoid ActiveModel::MissingAttributeError due to select(attributes) according to constrains
-      #   #suppose attribute_proxy is :_val, value_object_proxy is :_value_object
-      #   user = User.find 1
-      #   user._val(:name)
-      #   user._value_object.name
       def hook_attribute
         ActiveRecord::Persistence.class_eval %Q{
           def #{Controlist.attribute_proxy}(attr)

data/lib/controlist/permissions/ordered_package.rb

@@ -40,6 +40,13 @@ module Controlist
         end
       end
 
+      def has_permission(klass, operation)
+        permission_list = instance_variable_get("@list_#{operation}")
+        if permission_list && (permissions = permission_list[klass])
+          permissions.any?(&:is_allowed)
+        end
+      end
+
       private
 
       def add(list, permission)

data/lib/controlist/version.rb

@@ -1,3 +1,3 @@
 module Controlist
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

data/test/feature_test.rb

@@ -209,4 +209,14 @@ class FeatureTest < ActiveSupport::TestCase
     end
   end
 
+  def test_has_permission_check
+    Controlist.permission_manager.set_permission_package(OrderedPackage.new(
+      Controlist::Permission.new(User, READ, true, "age != 100"),
+      Controlist::Permission.new(Clazz, CREATE, false)
+    ))
+    assert_equal true, Controlist.has_permission(User, READ)
+    assert_nil Controlist.has_permission(User, CREATE)
+    assert_equal false, Controlist.has_permission(Clazz, CREATE)
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: controlist
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Leon Li
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-16 00:00:00.000000000 Z
+date: 2015-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler