durable_decorator 0.1.0 → 0.1.1

data/README.md

@@ -64,7 +64,7 @@ DurableDecorator::Base.determine_sha('ExampleClass#no_param_method')
 # => 'ba3114b2d46caa684b3f7ba38d6f74b2'
 
 ExampleClass.class_eval do
-  durably_decorate :string_method, mode: 'strict', sha: 'ba3114b2d46caa684b3f7ba38d6f74b2' do
+  durably_decorate :string_method, mode: 'strict', sha: 'WRONG-SHA-123456' do
     string_method_original + " and new"
   end
 end
@@ -117,6 +117,22 @@ instance.string_method_ba3114b2d46caa684b3f7ba38d6f74b2
 # => "original"
 ```
 
+### Asking for history
+
+You can inquire about the history of method [re]definitions like this:
+```ruby
+DurableDecorator::Base.definitions('ExampleClass#one_param_method')
+# => [{:name=>:one_param_method, :sha=>"935888f04d9e132be458591d5755cb8131fec457", :body=>"def one_param_method param\n  \"original: \#{param}\"\nend\n", :source=>["/home/denis/rails/durable_decorator/spec/example_class.rb", 6]}, {:name=>:one_param_method, :sha=>"3c39948e5e83c04fd4bf7a6ffab12c6828e0d959", :body=>"durably_decorate :one_param_method do |another_string|\n  \"\#{one_param_method_935888f04d9e132be458591d5755cb8131fec457('check')} and \#{another_string}\"\nend\n", :source=>["/home/denis/rails/durable_decorator/spec/durable_decorator_spec.rb", 45]}] 
+```
+
+With any luck you can even get the specific [re]definition printed!
+```ruby
+puts DurableDecorator::Base.definitions('ExampleClass#one_param_method')[0][:body]
+def one_param_method param
+  "original: #{param}"
+end
+```
+
 ### No more suprise monkey patching
 Once you decorate the method and seal it with its SHA, if some gem tries to come in and overwrite your work **BEFORE** decorate-time, DurableDecorator will warn you. Similarly, expect to see an exception bubble up if the definition of the original method has changed and requires a review and a re-hash. 
 

data/durable_decorator.gemspec

@@ -20,7 +20,6 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "method_source"
   spec.add_dependency "logging"
-  #spec.add_dependency "activesupport"
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"

data/lib/durable_decorator/base.rb

@@ -3,10 +3,10 @@ require 'digest/sha1'
 module DurableDecorator
   class Base
     class << self
-      REDEFINITIONS = {}
+      DEFINITIONS = {}
 
       def reset!
-        REDEFINITIONS.clear
+        DEFINITIONS.clear
       end
 
       def redefine clazz, method_name, meta, &block
@@ -45,8 +45,8 @@ module DurableDecorator
         end
       end
 
-      def redefinitions
-        REDEFINITIONS
+      def definitions
+        DEFINITIONS
       end
 
       def alias_definitions clazz, method_name, old_sha
@@ -67,11 +67,12 @@ module DurableDecorator
 
 
       def original_redefinition? clazz, method_name
-        !REDEFINITIONS[Util.full_method_name(clazz, method_name)]
+        defs = DEFINITIONS[Util.full_method_name(clazz, method_name)]
+        !defs || defs.empty?
       end
 
       def store_redefinition clazz, name, old_method, new_method
-        methods = REDEFINITIONS[Util.full_method_name(clazz, name)] ||= []
+        methods = (DEFINITIONS[Util.full_method_name(clazz, name)] ||= [])
        
         to_store = [new_method]
         to_store.unshift(old_method) if original_redefinition?(clazz, name)
@@ -86,7 +87,7 @@ module DurableDecorator
       def redefined? clazz, method_name, &block
         begin
           result =
-            overrides = REDEFINITIONS[clazz][method_name] and
+            overrides = DEFINITIONS[clazz][method_name] and
             overrides.select{|o| o == Util.method_hash(method_name)}.first and
             true
         rescue
@@ -95,7 +96,7 @@ module DurableDecorator
       end
 
       def determine_sha target
-        raise "Please provide a fully qualified method name: Module::Clazz#instance_method or ::clazz_method" unless target && target.match(/\.|#/)
+        raise "Please provide a fully qualified method name: Module::Clazz#instance_method or .clazz_method" unless target && target.match(/\.|#/)
 
         class_name, separator, method_name = target.match(/(.*)(\.|#)(.*)/)[1..3]
         clazz = Constantizer.constantize(class_name)

data/lib/durable_decorator/util.rb

@@ -24,10 +24,18 @@ module DurableDecorator
       def method_hash name, method
         {
           :name => name,
-          :sha => method_sha(method) 
+          :sha => method_sha(method),
+          :body => outdented_method_body(method),
+          :source => method.source_location
         }
       end
 
+      def outdented_method_body method
+        body = method.source
+        indent = body.match(/^\W+/).to_s
+        body.lines.map{|l| l.sub(indent, '')}.join
+      end
+
       def method_sha method
         Digest::SHA1.hexdigest(method.source.gsub(/\s+/, ' '))
       end

data/lib/durable_decorator/validator.rb

@@ -4,23 +4,31 @@ module DurableDecorator
       DECORATION_MODES = ['strict', 'soft']
 
       def validate_decoration_meta clazz, method_name, old_method, meta
-        return unless meta
+        expected_sha = Util.method_sha(old_method)
+        
+        unless meta
+          log_sha_suggestion clazz, method_name, expected_sha
+          return
+        end
 
         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 :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)
+      def log_sha_suggestion clazz, method_name, expected_sha
+        Util.logger.warn "#{clazz}##{method_name} definition's SHA is currently: #{expected_sha}. Consider sealing it against tampering."
+      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)
+      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

data/lib/durable_decorator/version.rb

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

data/spec/durable_decorator_spec.rb

@@ -74,6 +74,10 @@ describe DurableDecorator::Base do
           instance.one_param_method_9358('').should == "original: "
           instance.one_param_method_935888('').should == "original: "
         end
+
+        it 'maintains history of decorations' do
+          DurableDecorator::Base.definitions['ExampleClass#one_param_method'].size.should == 2
+        end
       end
 
       context 'for strict definitions' do
@@ -146,19 +150,27 @@ describe DurableDecorator::Base do
 
         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
+            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/)
+          end
+        end
+
+        context 'when lacking SHA' do
+          it 'prints the SHA suggestion' do
+            ExampleClass.class_eval do
+              durably_decorate :no_param_method do
+                no_param_method_original + " and a new string"
               end
-              @log_output.readline.should match(/invalid SHA/)
-            }.should_not raise_error
+            end
+            @log_output.readline.should match(/d54f9c7ea2038fac0ae2ff9af49c56f35761725d/)
           end
         end
 

data/spec/spec_helper.rb

@@ -11,5 +11,6 @@ RSpec.configure do |config|
     load 'sample_module.rb'
 
     DurableDecorator::Base.reset!
+    DurableDecorator::Util.stub(:logger).and_return(Logging.logger['SuperLogger'])
   end
 end

metadata

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