durable_decorator 0.0.9 → 0.1.0

data/README.md

@@ -33,7 +33,7 @@ class ExampleClass
   end
 end
 
-class ExampleClass
+ExampleClass.class_eval do
   durably_decorate :string_method do
     string_method_original + " and new"
   end
@@ -62,13 +62,9 @@ Armed with this knowledge, we can enforce a strict mode:
 ```ruby
 DurableDecorator::Base.determine_sha('ExampleClass#no_param_method')
 # => 'ba3114b2d46caa684b3f7ba38d6f74b2'
-ExampleClass.class_eval do
-  meta = {
-    mode: 'strict',
-    sha: 'WE-IGNORE-THE-ABOVE'
-  }
 
-  durably_decorate :string_method, meta do
+ExampleClass.class_eval do
+  durably_decorate :string_method, mode: 'strict', sha: 'ba3114b2d46caa684b3f7ba38d6f74b2' do
     string_method_original + " and new"
   end
 end
@@ -76,6 +72,26 @@ end
 DurableDecorator::TamperedDefinitionError: Method SHA mismatch, the definition has been tampered with
 ```
 
+DurableDecorator may also decorate methods with params like so:
+
+```ruby
+class ExampleClass
+  def string_method(text)
+    "original #{text}"
+  end
+end
+
+ExampleClass.class_eval do
+  durably_decorate :string_method, mode: 'strict', sha: 'ba3114b2d46caa684b3f7ba38d6f74b2' do |text|
+    string_method_original(text) + " and new"
+  end
+end
+
+instance = ExampleClass.new
+instance.string_method('test')
+# => "original test and new"
+```
+
 DurableDecorator also maintains explicit versions of each method overriden by creating aliases with appended SHAs of the form ```some_method_1234abcd``` so you can always target explicit method versions without relying on ```some_method_original```.
 
 DurableDecorator maintains 3 versions of aliases to previous method versions, 2 of which are short-SHA versions, akin to Github:

data/lib/durable_decorator/util.rb

@@ -35,8 +35,27 @@ module DurableDecorator
       def logger
         return @logger if @logger
 
-        @logger = Logging.logger(STDOUT)
+        Logging.color_scheme( 'bright',
+          :levels => {
+            :info  => :green,
+            :warn  => :yellow,
+            :error => :red,
+            :fatal => [:white, :on_red]
+          }
+        )
+
+        Logging.appenders.stdout(
+          'stdout',
+          :layout => Logging.layouts.pattern(
+            :pattern => '%-5l %c: %m\n',
+            :color_scheme => 'bright'
+          )
+        )
+
+        @logger = Logging.logger['DurableDecorator']
         @logger.level = :warn
+
+        Logging.logger.root.appenders = Logging.appenders.stdout
         @logger
       end
     end

data/lib/durable_decorator/validator.rb

@@ -1,15 +1,28 @@
 module DurableDecorator
   class Validator
     class << self
-      DECORATION_MODES = ['strict']
+      DECORATION_MODES = ['strict', 'soft']
 
       def validate_decoration_meta clazz, method_name, old_method, meta
         return unless meta
 
         chill_meta = Util.symbolized_hash(meta)
+        provided_mode = chill_meta[:mode]
+        provided_sha = chill_meta[:sha]
+        expected_sha = Util.method_sha(old_method)
 
-        raise InvalidDecorationError, "The hash provided to the decorator is invalid" unless DECORATION_MODES.include? chill_meta[:mode] and chill_meta[:sha] and !chill_meta[:sha].empty?
-        raise TamperedDefinitionError, "Method SHA mismatch, the definition has been tampered with" unless Util.method_sha(old_method) == chill_meta[:sha]
+        raise InvalidDecorationError, "The :mode provided is invalid. Possible modes are: #{DECORATION_MODES.join(", ")}" unless DECORATION_MODES.include? provided_mode
+        raise InvalidDecorationError, "The SHA provided appears to be empty" unless provided_sha and !provided_sha.empty?
+        send("handle_#{chill_meta[:mode]}_fault", clazz, method_name, expected_sha, provided_sha) unless expected_sha == provided_sha
+      end
+
+      def handle_strict_fault(clazz, method_name, expected_sha, provided_sha)
+        raise TamperedDefinitionError, "Method SHA mismatch, the definition has been tampered with. #{expected_sha} is expected but #{provided_sha} was provided."
+      end
+
+      def handle_soft_fault(clazz, method_name, expected_sha, provided_sha)
+        Util.logger.fatal "#{clazz}##{method_name} decoration uses an invalid SHA. The original method definition could have been tampered with!"
+        Util.logger.fatal "Expected SHA was #{expected_sha} but the provided SHA is #{provided_sha}"
       end
 
       def validate_method_arity clazz, method_name, old_method, &block

data/lib/durable_decorator/version.rb

@@ -1,3 +1,3 @@
 module DurableDecorator
-  VERSION = "0.0.9"
+  VERSION = "0.1.0"
 end

data/spec/durable_decorator_spec.rb

@@ -125,6 +125,58 @@ describe DurableDecorator::Base do
           end
         end
       end
+
+      context 'for soft definitions' do
+        context 'with the correct SHA' do
+          it 'guarantees access to #method_original' do
+            ExampleClass.class_eval do
+              meta = {
+                :mode => 'soft',
+                :sha => 'd54f9c7ea2038fac0ae2ff9af49c56f35761725d'
+              }
+              durably_decorate :no_param_method, meta do
+                no_param_method_original + " and a new string"
+              end
+            end
+
+            instance = ExampleClass.new
+            instance.no_param_method.should == "original and a new string"
+          end
+        end
+
+        context 'with the wrong SHA' do
+          it 'logs a warning but does not raise an error' do
+            DurableDecorator::Util.stub(:logger).and_return(Logging.logger['SuperLogger'])
+            lambda{
+              ExampleClass.class_eval do
+                meta = {
+                  :mode => 'soft',
+                  :sha => '1234wrong'
+                }
+                durably_decorate :no_param_method, meta do
+                  no_param_method_original + " and a new string"
+                end
+              end
+              @log_output.readline.should match(/invalid SHA/)
+            }.should_not raise_error
+          end
+        end
+
+        context 'for an invalid config' do
+          it 'raises an error' do
+            lambda{
+              ExampleClass.class_eval do
+                meta = {
+                  :mode => 'soft'
+                }
+                durably_decorate :no_param_method, meta do
+                  no_param_method_original + " and a new string"
+                end
+              end
+            }.should raise_error(DurableDecorator::InvalidDecorationError)
+          end
+        end
+      end
     end
 
     context 'for methods not yet defined' do

data/spec/spec_helper.rb

@@ -1,7 +1,11 @@
 require 'rspec'
 require 'durable_decorator'
+require 'rspec/logging_helper'
 
 RSpec.configure do |config|
+  include RSpec::LoggingHelper
+  config.capture_log_messages
+
   config.before(:each) do
     load 'example_class.rb'
     load 'sample_module.rb'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: durable_decorator
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-12 00:00:00.000000000 Z
+date: 2013-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: method_source