sequel_proc_error_handling.rb 0.5.0

data/lib/sequel_proc_error_handling.rb

@@ -0,0 +1,163 @@
+module Sequel
+  module Plugins
+    # Proc Error Handling is a plugin to help handle validation errors
+    # by providing context specific error handling as proc objects.
+    #
+    # example:
+    #
+    #   filter_restricted = proc do |klass, values|
+    #     if $!.message =~ /doesn't exist or access is restricted to it/
+    #       values.delete_if { |k,v| klass.restricted_columns.include? k }
+    #       :retry
+    #     end
+    #   end
+    #       
+    #   Foo.new(:restricted_column => 'value') # raises error
+    #   Foo.new(:restricted_column => 'value', filter_restricted) # No Error
+    #
+    # This plugin is helpful when you don't want to be changing a model's
+    # error settings to acomodate unverified data in one area of the code,
+    # but still want the strict errors in a more secure area of the code.
+    module ProcErrorHandling
+      def self.apply(model)
+      end
+
+      def self.configure(model,&block)
+      end
+      
+      module InstanceMethods
+        def update(hash,*error_proc)
+          super(hash)
+        rescue
+          result = PEH.send(:process_error_proc,error_proc,self,hash)
+          retry if result == :retry
+          result
+        end
+
+        def update_all(hash, *error_proc)
+          super(hash)
+         rescue
+          result = PEH.send(:process_error_proc,error_proc,self,hash)
+          retry if result == :retry
+          result
+        end
+
+        def update_except(hash, *except)
+          error_procs = []
+          error_procs.unshift except.pop while except.last.is_a? Proc
+
+          # Only want to retry the update, don't want to clear error_procs
+          begin
+            super(hash,*except)
+          rescue
+            result = PEH.send(:process_error_proc,error_procs,self,hash)
+            retry if result == :retry
+            result
+          end
+        end
+
+        def update_only(hash, *only)
+          error_procs = []
+          error_procs.unshift only.pop while only.last.is_a? Proc
+
+          begin
+            super(hash,*only)
+          rescue
+            result = PEH.send(:process_error_proc,error_procs,self,hash)
+            retry if result == :retry
+            result
+          end
+        end
+
+        def initialize(values = {}, *args,&block)
+          orig = args.dup
+          error_procs = []
+          error_procs.unshift args.pop while args.last.is_a? Proc
+          from_db = args.pop || false # First value will be nil or boolean
+          raise ArgumentError, 
+            "Invalid Arguments passed to #new #{orig.inpsect}" unless args.empty?
+
+          begin
+            super(values,from_db,&block)
+          rescue
+            result = PEH.send(:process_error_proc,error_procs,self,values)
+            retry if result == :retry
+            # Special for new since we can't return anything else
+            if result.is_a? self.class
+              values  = result.values
+              from_db = true unless result.new?
+              retry
+            end
+            # Should not get here... means result was something other
+            # then :raise, :retry, nil, or an instance of self.class
+            raise "#new can not return any other object, there is" <<
+            " an error in your PEH proc"
+          end
+        end
+
+        def save(*columns)
+          error_procs = []
+          error_procs.unshift columns.pop while columns.last.is_a? Proc
+
+          begin
+            super(*columns)
+          rescue
+            result = PEH.send(:process_error_proc,error_procs,self,values)
+            retry if result == :retry
+            result
+          end
+        end
+
+      end
+
+      module ClassMethods
+        def create(values = {}, *error_proc, &block)
+          new(values,*error_proc, &block).save *error_proc
+        end
+
+        def on_error(&block)
+          @peh_error_block = block
+        end
+
+        def peh_error_occured(model)
+          if @peh_error_block
+            @peh_error_block.call(model)
+          elsif superclass.respond_to? :peh_error_occured
+            superclass.peh_error_occured(model)
+          end
+        end
+      end
+
+      module DatasetMethods
+      end
+
+      def self.process_error_proc(procs,obj,hash)
+        klass = obj.class
+        # if procs is nil then compact array and result will be nil
+        # if procs is single proc wrap in array so code runs normaly
+        # if procs is array execute each one till value returned
+        procs = [procs].compact unless procs.is_a? Array
+        result = procs.each do |ep|
+          val = ep.call(klass,hash) 
+          break val unless val.nil? 
+        end
+        # if result is the original array then error handling failed
+        result = (result == procs) ? nil : result
+
+        if result == :raise or result.nil?
+          klass.peh_error_occured(obj)
+          raise $!
+        end
+        if result != nil and result != :retry and result.class != obj.class
+          raise Sequel::Error, "An error handling proc must return either " <<
+          "nil, :raise, :retry, or an instance of the klass it is rescuing."
+        end
+        result
+      end
+
+      private_class_method :process_error_proc
+    end
+
+    PEH = ProcErrorHandling
+  end
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: sequel_proc_error_handling.rb
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 5
+  - 0
+  version: 0.5.0
+platform: ruby
+authors: 
+- daicoden
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-11 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: sequel
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 11
+        - 0
+        version: 3.11.0
+  type: :runtime
+  version_requirements: *id001
+description: "    Proc Error Handling allows you to specify a proc for\n    most of the database oriented operations.  If an error\n    occurs, the klass and values are passed to the proc.\n    The proc may attempt to fix the error and retry, or\n    pass the error on up the chain.\n"
+email: daicoden@copypastel.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/sequel_proc_error_handling.rb
+has_rdoc: true
+homepage: http://github.com/daicoden/sequel_proc_error_handling
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Proc based error recovery.
+test_files: []
+