casbin-ruby 1.0.10 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 88e68e3c8f15c55fbeba3bf37683124c9d2fb17a8d2dd408f3ed7d36a430fe95
-  data.tar.gz: 124e945552b694c89ef488a71d286d6171118281041c2823db896efb56ec0d83
+  metadata.gz: 0a6fa41ab5193602d852ba7652d0d92775f1a26243471d154188aca17a5a3a67
+  data.tar.gz: 19174a79a646b395960fd842bec794f8a202d283396c802d872ce7e88914763a
 SHA512:
-  metadata.gz: 10b12e4a479b2c3d4f7b70f33750d604292f15aaae6441968559a7d7ae195e4a5b291a3ce69fe553e7c976020218fa1b2dd2dcb86c58a9483868c30eef38842c
-  data.tar.gz: 225eaf757fbaab699f3a4c832020b9ca527e2b53e2f03c843631dadf81a1f199c0135447cc9a41bc96f509712011feca18970c02949fa037543e1a1c77aa08c1
+  metadata.gz: 9c40a77ea91e4addeba67652af4fe0bd1af3151f67e2bdfc3625f4c90e295a643d3f2d221446957ebd3a1f4321e3a1869a822a31102c5a6cdf78da3dd572e35d
+  data.tar.gz: 29c3ff1985b8e1480ce596763ce621790cf19f6676649efc6d6e4ac8bb06c476f3d8618db2e72a89a40e1f277da36a5eba5ba598040a4dd3ada102b91fe9c390

data/README.md

@@ -151,7 +151,20 @@ https://casbin.org/docs/en/tutorials
 1. New a Casbin enforcer with a model file and a policy file:
 
 ```ruby
-# TODO: correct `require`
+require 'casbin-ruby'
+Casbin::Config.setup do |config|
+  config.model = "path/to/model.conf" # default: nil
+  config.adapter = "path/to/policy.csv" # default: nil
+  config.watcher = Casbin::SomeWatcher # default: nil
+  config.logger = Logger.new($stdout) # default: Logger.new($stdout, level: :error)
+end
+
+enforcer = Casbin::Enforcer.new
+```
+
+OR
+
+```ruby
 require 'casbin-ruby'
 enforcer = Casbin::Enforcer.new("path/to/model.conf", "path/to/policy.csv")
 ```

data/lib/casbin-ruby/config.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+module Casbin
+  module Config
+    class << self
+      attr_writer :logger
+      attr_accessor :adapter, :model, :watcher
+
+      def setup
+        yield self
+      end
+
+      def logger
+        @logger ||= ::Logger.new($stdout, level: :error)
+      end
+    end
+  end
+end

data/lib/casbin-ruby/core_enforcer.rb

@@ -9,46 +9,50 @@ require 'casbin-ruby/rbac/default_role_manager/role_manager'
 require 'casbin-ruby/util'
 require 'casbin-ruby/util/builtin_operators'
 require 'casbin-ruby/util/evaluator'
-
-require 'logger'
+require 'casbin-ruby/logger'
+require 'casbin-ruby/config'
 
 module Casbin
   # CoreEnforcer defines the core functionality of an enforcer.
   # get_attr/set_attr methods is ported from Python as attr/attr=
   class CoreEnforcer
-    def initialize(model = nil, adapter = nil, logger: Logger.new($stdout))
+    def initialize(model = nil, adapter = nil, watcher = nil)
+      model ||= Config.model
+      adapter ||= Config.adapter
+      @watcher = watcher || Config.watcher
+
       if model.is_a? String
         if adapter.is_a? String
-          init_with_file(model, adapter, logger: logger)
+          init_with_file(model, adapter)
         else
-          init_with_adapter(model, adapter, logger: logger)
+          init_with_adapter(model, adapter)
         end
       elsif adapter.is_a? String
         raise 'Invalid parameters for enforcer.'
       else
-        init_with_model_and_adapter(model, adapter, logger: logger)
+        init_with_model_and_adapter(model, adapter)
       end
     end
 
-    attr_accessor :adapter, :auto_build_role_links, :auto_save, :effector, :enabled, :watcher, :rm_map
-    attr_reader :model
+    attr_accessor :auto_build_role_links, :auto_save, :effector, :enabled, :rm_map
+    attr_reader :adapter, :model, :watcher
 
     # initializes an enforcer with a model file and a policy file.
-    def init_with_file(model_path, policy_path, logger: Logger.new($stdout))
+    def init_with_file(model_path, policy_path)
       a = Persist::Adapters::FileAdapter.new(policy_path)
-      init_with_adapter(model_path, a, logger: logger)
+      init_with_adapter(model_path, a)
     end
 
     # initializes an enforcer with a database adapter.
-    def init_with_adapter(model_path, adapter = nil, logger: Logger.new($stdout))
+    def init_with_adapter(model_path, adapter = nil)
       m = new_model(model_path)
-      init_with_model_and_adapter(m, adapter, logger: logger)
+      init_with_model_and_adapter(m, adapter)
 
       self.model_path = model_path
     end
 
     # initializes an enforcer with a model and a database adapter.
-    def init_with_model_and_adapter(m, adapter = nil, logger: Logger.new($stdout))
+    def init_with_model_and_adapter(m, adapter = nil)
       if !m.is_a?(Model::Model) || (!adapter.nil? && !adapter.is_a?(Persist::Adapter))
         raise StandardError, 'Invalid parameters for enforcer.'
       end
@@ -59,15 +63,15 @@ module Casbin
       model.print_model
       self.fm = Model::FunctionMap.load_function_map
 
-      init(logger: logger)
+      init
 
       # Do not initialize the full policy when using a filtered adapter
       load_policy if adapter && !filtered?
     end
 
     # creates a model.
-    def self.new_model(path = '', text = '', logger: Logger.new($stdout))
-      m = Model::Model.new logger: logger
+    def self.new_model(path = '', text = '')
+      m = Model::Model.new
       if path.length.positive?
         m.load_model(path)
       else
@@ -291,13 +295,13 @@ module Casbin
     protected
 
     attr_accessor :model_path, :fm, :auto_motify_watcher
-    attr_reader :logger
 
     private
 
     attr_accessor :matcher_map
+    attr_writer :adapter
 
-    def init(logger: Logger.new($stdout))
+    def init
       self.rm_map = {}
       self.effector = Effect::DefaultEffector.get_effector(model.model['e']['e'].value)
 
@@ -305,8 +309,6 @@ module Casbin
       self.auto_save = true
       self.auto_build_role_links = true
 
-      @logger = logger
-
       init_rm_map
     end
 
@@ -338,10 +340,10 @@ module Casbin
       req_str = "Request: #{rvals.map(&:to_s).join ', '} ---> #{result}"
 
       if result
-        logger.info(req_str)
+        Logger.info(req_str)
       else
         # leaving this in error for now, if it's very noise this can be changed to info or debug
-        logger.error(req_str)
+        Logger.error(req_str)
       end
     end
 
@@ -349,7 +351,7 @@ module Casbin
       return unless model.model.keys.include?('g')
 
       model.model['g'].each_key do |ptype|
-        rm_map[ptype] = Rbac::DefaultRoleManager::RoleManager.new(10, logger: logger)
+        rm_map[ptype] = Rbac::DefaultRoleManager::RoleManager.new(10)
       end
     end
   end

data/lib/casbin-ruby/logger.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require 'casbin-ruby/config'
+
+module Casbin
+  module Logger
+    module_function
+
+    def info(value)
+      Config.logger.info(value)
+    end
+
+    def error(value)
+      Config.logger.error(value)
+    end
+  end
+end

data/lib/casbin-ruby/model/assertion.rb

@@ -1,19 +1,17 @@
 # frozen_string_literal: true
 
-require 'logger'
+require 'casbin-ruby/logger'
 
 module Casbin
   module Model
     class Assertion
       attr_accessor :key, :value, :tokens, :policy, :rm
-      attr_reader :logger
 
       def initialize(hash = {})
         @key = hash[:key].to_s
         @value = hash[:value].to_s
         @tokens = [*hash[:tokens]]
         @policy = [*hash[:policy]]
-        @logger = hash[:logger] || Logger.new($stdout)
       end
 
       def build_role_links(rm)
@@ -24,7 +22,7 @@ module Casbin
           raise 'grouping policy elements do not meet role definition' if rule.size < count
 
           rm.add_link(*rule)
-          logger.info("Role links for: #{key}")
+          Logger.info("Role links for: #{key}")
           rm.print_roles
         end
       end

data/lib/casbin-ruby/model/model.rb

@@ -4,6 +4,7 @@ require 'casbin-ruby/model/policy'
 require 'casbin-ruby/model/assertion'
 require 'casbin-ruby/config/config'
 require 'casbin-ruby/util'
+require 'casbin-ruby/logger'
 
 module Casbin
   module Model
@@ -29,7 +30,7 @@ module Casbin
       def add_def(sec, key, value)
         return false if value == ''
 
-        ast = Assertion.new(key: key, value: value, logger: logger)
+        ast = Assertion.new(key: key, value: value)
         %w[r p].include?(sec) ? ast_tokens_set(ast, key) : model_sec_set(ast)
 
         model[sec] ||= {}
@@ -37,11 +38,11 @@ module Casbin
       end
 
       def print_model
-        logger.info 'Model:'
+        Logger.info 'Model:'
 
         model.each do |k, v|
           v.each do |i, j|
-            logger.info "#{k}.#{i}: #{j.value}"
+            Logger.info "#{k}.#{i}: #{j.value}"
           end
         end
       end

data/lib/casbin-ruby/model/policy.rb

@@ -1,15 +1,14 @@
 # frozen_string_literal: true
 
-require 'logger'
+require 'casbin-ruby/logger'
 
 module Casbin
   module Model
     class Policy
-      attr_reader :model, :logger
+      attr_reader :model
 
-      def initialize(logger: Logger.new($stdout))
+      def initialize
         @model = {}
-        @logger = logger
       end
 
       # initializes the roles in RBAC.
@@ -24,13 +23,13 @@ module Casbin
 
       # Log using info
       def print_policy
-        logger.info 'Policy:'
+        Logger.info 'Policy:'
 
         %w[p g].each do |sec|
           next unless model.key? sec
 
           model[sec].each do |key, ast|
-            logger.info "#{key} : #{ast.value} : #{ast.policy}"
+            Logger.info "#{key} : #{ast.value} : #{ast.policy}"
           end
         end
       end

data/lib/casbin-ruby/rbac/default_role_manager/role_manager.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'logger'
 require 'casbin-ruby/rbac/role_manager'
 require 'casbin-ruby/rbac/default_role_manager/role'
+require 'casbin-ruby/logger'
 
 module Casbin
   module Rbac
@@ -10,11 +10,9 @@ module Casbin
       # provides a default implementation for the RoleManager interface
       class RoleManager < Rbac::RoleManager
         attr_accessor :all_roles, :max_hierarchy_level, :matching_func, :has_domain_pattern, :domain_matching_func
-        attr_reader :logger
 
-        def initialize(max_hierarchy_level, logger: Logger.new($stdout))
+        def initialize(max_hierarchy_level)
           super()
-          @logger = logger
           @all_roles = {}
           @max_hierarchy_level = max_hierarchy_level
         end
@@ -120,7 +118,7 @@ module Casbin
 
         def print_roles
           line = all_roles.map { |_key, role| role.to_string }.compact
-          logger.info(line.join(', '))
+          Logger.info(line.join(', '))
         end
 
         private

data/lib/casbin-ruby/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Casbin
-  VERSION = '1.0.10'
+  VERSION = '1.1.0'
 end

data/lib/casbin-ruby.rb

@@ -4,6 +4,7 @@ module Casbin
   require 'casbin-ruby/version'
   require 'casbin-ruby/enforcer'
   require 'casbin-ruby/synced_enforcer'
+  require 'casbin-ruby/config'
 
   module Persist
     require 'casbin-ruby/persist/adapter'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: casbin-ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.10
+  version: 1.1.0
 platform: ruby
 authors:
 - Igor Kutyavin
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-09-01 00:00:00.000000000 Z
+date: 2021-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: keisan
@@ -78,6 +78,7 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/casbin-ruby.rb
+- lib/casbin-ruby/config.rb
 - lib/casbin-ruby/config/config.rb
 - lib/casbin-ruby/core_enforcer.rb
 - lib/casbin-ruby/effect/allow_and_deny_effector.rb
@@ -88,6 +89,7 @@ files:
 - lib/casbin-ruby/effect/priority_effector.rb
 - lib/casbin-ruby/enforcer.rb
 - lib/casbin-ruby/internal_enforcer.rb
+- lib/casbin-ruby/logger.rb
 - lib/casbin-ruby/management_enforcer.rb
 - lib/casbin-ruby/model/assertion.rb
 - lib/casbin-ruby/model/function_map.rb
@@ -141,11 +143,11 @@ specification_version: 4
 summary: Casbin in Ruby
 test_files:
 - spec/support/model_helper.rb
-- spec/casbin/rbac/default_role_manager/role_spec.rb
-- spec/casbin/rbac/default_role_manager/role_manager_spec.rb
+- spec/casbin/config/config_spec.rb
 - spec/casbin/enforcer_spec.rb
-- spec/casbin/util/builtin_operators_spec.rb
+- spec/casbin/model/function_map_spec.rb
 - spec/casbin/util_spec.rb
 - spec/casbin/core_enforcer_spec.rb
-- spec/casbin/config/config_spec.rb
-- spec/casbin/model/function_map_spec.rb
+- spec/casbin/util/builtin_operators_spec.rb
+- spec/casbin/rbac/default_role_manager/role_manager_spec.rb
+- spec/casbin/rbac/default_role_manager/role_spec.rb