access_schema 0.2.3 → 0.3

data/README.md

@@ -184,6 +184,8 @@ anywhere in app. Alternatively it can be assempled with ServiceLocator.
     schema :plans, AccessSchema.build_file('config/plans.rb')
     schema :acl, AccessSchema.build_file('config/acl.rb')
 
+    logger Rails.logger
+
   end
 
 ```

data/lib/access_schema/builders/config_builder.rb

@@ -20,6 +20,11 @@ module AccessSchema
       @config.add_schema(name, schema)
     end
 
+    def logger(logger)
+      puts logger.inspect
+      @config.logger = logger
+    end
+
     private
 
     def schema_from_options(options)

data/lib/access_schema/config.rb

@@ -13,5 +13,13 @@ module AccessSchema
       @schemas[name]
     end
 
+    def logger=(logger)
+      @logger = ProxyLogger.new(logger)
+    end
+
+    def logger
+      @logger ||= StubLogger.new
+    end
+
   end
 end

data/lib/access_schema/loggers/proxy_logger.rb

@@ -0,0 +1,22 @@
+module AccessSchema
+
+  class ProxyLogger
+
+    def initialize(logger)
+      @logger = logger
+    end
+
+    %w{debug info warn error fatal}.each do |level|
+      define_method(level) do |message = nil, &block|
+        if block
+          proxy_block = proc { "AccessSchema: #{block.call}" }
+          @logger.send(level, &proxy_block)
+        else
+          @logger.send(level, "AccessSchema: #{message}")
+        end
+      end
+    end
+
+  end
+
+end

data/lib/access_schema/loggers/stub_logger.rb

@@ -0,0 +1,18 @@
+module AccessSchema
+  class StubLogger
+
+    def info
+    end
+
+    def debug
+    end
+
+    def warn
+    end
+
+    def error
+    end
+
+  end
+end
+

data/lib/access_schema/loggers/test_logger.rb

@@ -0,0 +1,17 @@
+module AccessSchema
+
+  class TestLogger
+
+    attr_reader :output
+    attr_accessor :log_only_level
+
+    %w{debug info warn error fatal}.each do |level|
+      define_method(level) do |message = nil, &block|
+        return if log_only_level && level != log_only_level
+        @output = [@output, message || block.call].compact.join("\n")
+      end
+    end
+
+  end
+
+end

data/lib/access_schema/schema.rb

@@ -55,6 +55,18 @@ module AccessSchema
     end
 
     def check!(namespace_name, element_name, roles, options)
+
+      format_log_payload = lambda {
+        [
+          "namespace = '#{namespace_name}'",
+          "privilege = '#{element_name}'",
+          "roles = '#{roles.inspect}'",
+          "options = '#{options.inspect}'"
+        ].join(', ')
+      }
+
+      logger.debug{ "check: #{format_log_payload.call}" }
+
       allowed = for_element(namespace_name, element_name) do |element|
         element.allow?(roles) do |expectation|
           check_assert(expectation, options)
@@ -62,6 +74,7 @@ module AccessSchema
       end
 
       unless allowed
+        logger.info{ "check FAILED: #{format_log_payload.call}" }
         raise NotAlowedError.new
       else
         true
@@ -87,5 +100,10 @@ module AccessSchema
       @namespaces[namespace].elements
     end
 
+    private
+
+    def logger
+      AccessSchema.config.logger
+    end
   end
 end

data/lib/access_schema/version.rb

@@ -1,3 +1,3 @@
 module AccessSchema
-  VERSION = "0.2.3"
+  VERSION = "0.3"
 end

data/lib/access_schema.rb

@@ -8,6 +8,9 @@ require 'access_schema/namespace'
 require 'access_schema/element'
 require 'access_schema/expectation'
 
+require 'access_schema/loggers/proxy_logger'
+require 'access_schema/loggers/stub_logger'
+
 require 'access_schema/builders/config_builder'
 
 require 'access_schema/builders/basic_builder'
@@ -33,6 +36,10 @@ module AccessSchema
     @config = ConfigBuilder.build(&block)
   end
 
+  def self.config
+    @config ||= Config.new
+  end
+
   def self.schema(name)
     @config.schema(name)
   end

data/spec/access_schema/config_builder_spec.rb

@@ -12,4 +12,17 @@ describe AccessSchema::ConfigBuilder do
     config.schema(:acl).plans.should_not be_nil
   end
 
+  it "can specify logger" do
+
+    test_logger = AccessSchema::TestLogger.new
+    config = AccessSchema::ConfigBuilder.build do
+      logger test_logger
+    end
+
+    config.logger.debug("hello!")
+
+    test_logger.output.should == "AccessSchema: hello!"
+
+  end
+
 end

data/spec/access_schema/loggers/proxy_logger_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe AccessSchema::ProxyLogger do
+
+  describe ".debug" do
+
+    before do
+      @logger = AccessSchema::TestLogger.new
+      @proxy = AccessSchema::ProxyLogger.new(@logger)
+    end
+
+    it "adds 'AccessSchema: ' prefix to passed message" do
+      @proxy.debug("message test")
+      @logger.output.should == "AccessSchema: message test"
+    end
+
+    it "adds the same prefix to message generated by passed block" do
+      @proxy.debug{ "block test" }
+      @logger.output.should == "AccessSchema: block test"
+    end
+
+  end
+
+end
+

data/spec/access_schema/schema_spec.rb

@@ -2,6 +2,10 @@ require 'spec_helper'
 
 describe AccessSchema::Schema, "errors rising" do
 
+  before do
+    @schema = AccessSchema::SchemaBuilder.build_file('spec/schema_example.rb')
+  end
+
   describe "#add_plan" do
 
     it "raises error if duplicate"
@@ -35,5 +39,26 @@ describe AccessSchema::Schema, "errors rising" do
 
   end
 
+  describe "logging" do
+
+    before do
+      @logger = AccessSchema::TestLogger.new
+      AccessSchema.config.logger = @logger
+    end
+
+    it "logs check arguments with debug level" do
+      @logger.log_only_level = "debug"
+      @schema.allow? "Review", :mark_featured, :flower
+      @logger.output.should == "AccessSchema: check: namespace = 'Review', privilege = 'mark_featured', roles = '[:flower]', options = '{}'"
+    end
+
+    it "logs check fail with info level" do
+      @logger.log_only_level = "info"
+      @schema.allow? "Review", :mark_featured, :none
+      @logger.output.should == "AccessSchema: check FAILED: namespace = 'Review', privilege = 'mark_featured', roles = '[:none]', options = '{}'"
+    end
+  end
+
+
 end
 

data/spec/spec_helper.rb

@@ -1,6 +1,8 @@
 require 'rspec'
 require 'access_schema'
 
+require 'access_schema/loggers/test_logger'
+
 Dir[File.expand_path('../support/**/*', __FILE__)].each { |f| require f }
 
 RSpec.configure do |config|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: access_schema
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: '0.3'
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-15 00:00:00.000000000 Z
+date: 2012-03-19 00:00:00.000000000 Z
 dependencies: []
 description: AccessSchema is a tool for ACL or tariff plans schema definition and
   checks
@@ -40,11 +40,15 @@ files:
 - lib/access_schema/element.rb
 - lib/access_schema/exceptions.rb
 - lib/access_schema/expectation.rb
+- lib/access_schema/loggers/proxy_logger.rb
+- lib/access_schema/loggers/stub_logger.rb
+- lib/access_schema/loggers/test_logger.rb
 - lib/access_schema/namespace.rb
 - lib/access_schema/proxy.rb
 - lib/access_schema/schema.rb
 - lib/access_schema/version.rb
 - spec/access_schema/config_builder_spec.rb
+- spec/access_schema/loggers/proxy_logger_spec.rb
 - spec/access_schema/proxy_spec.rb
 - spec/access_schema/schema_builder_spec.rb
 - spec/access_schema/schema_spec.rb
@@ -63,12 +67,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -30797054816985066
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -30797054816985066
 requirements: []
 rubyforge_project: access_schema
 rubygems_version: 1.8.16
@@ -77,6 +87,7 @@ specification_version: 3
 summary: AccessSchema is an ACL tool
 test_files:
 - spec/access_schema/config_builder_spec.rb
+- spec/access_schema/loggers/proxy_logger_spec.rb
 - spec/access_schema/proxy_spec.rb
 - spec/access_schema/schema_builder_spec.rb
 - spec/access_schema/schema_spec.rb