sequel_sanitize 0.0.1

data/CHANGELOG

@@ -0,0 +1,2 @@
+== 0.0.1, 2011-01-12
+* First iteration of the sequel_sanitize

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Kevin Tom - http://github.com/kevintom
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,37 @@
+= sequel_sanitize
+
+== Install
+
+Add gemcutter.org source if you don't have it:
+  gem source http://gemcutter.org
+
+Install:
+  [sudo] gem install sequel_sanitize
+
+== Usage
+
+This plug-in provide functionality to allow Sequel::Model to have fields sanitized
+with a defined or default method.
+
+To use plug-in you add plug-in to your model:
+
+  class MyModel < Sequel::Model
+    plugin :sanitize, :fields => [:first_name, :last_name], :sanitizer => :name_sanitizer
+    plugin :sanitize, :fields => [:email], :downcase => true
+  end
+
+You can use following options:
+*fields*:: an array of the fields that the sanitizer method should be applied to
+*sanitizer*:: Proc or Symbol to call to sanitize the value of the field.
+*downcase*:: Set to true to downcase the value returned from the sanitizer
+
+Options *sanitizer* and *downcase* are optional.
+
+<b>Options are inherited when you use inheritance for your models</b>. However
+you can only set options via plugin method.
+
+If you don't provide a :sanitizer, the default sanitizer method will strip whitespace
+
+== Copyright
+
+Copyright (c) 2011 Kevin Tom. See LICENSE for details.

data/lib/sequel_sanitize/version.rb

@@ -0,0 +1,7 @@
+module Sequel
+  module Plugins
+    module Sanitize
+      VERSION = '0.0.1'.freeze
+    end
+  end
+end

data/lib/sequel_sanitize.rb

@@ -0,0 +1,74 @@
+module Sequel
+  module Plugins
+    # The Sanitize plugin basically does a 'before_filter' on 
+    # specified fields, if no sanitizer is specified the default 
+    # one is used
+    #
+    module Sanitize
+      # Plugin configuration
+      def self.configure(model, opts={})
+        model.sanitize_options = opts
+        model.sanitize_options.freeze
+        model.class_eval do
+          sanitize_options[:fields].each do |f|
+            define_method("#{f}=") do |value|
+              sanitizer = self.class.sanitize_options[:field_sanitize][f]
+              do_downcase = self.class.sanitize_options[:field_downcase][f]
+              sanitized = sanitizer.call(value) if sanitizer.respond_to?(:call)
+              sanitized ||= self.send(sanitizer, value) if sanitizer
+              sanitized = sanitized.downcase if do_downcase
+              super(sanitized)
+            end
+          end
+        end
+      end
+
+      module ClassMethods
+        attr_reader :sanitize_options
+        # Propagate settings to the child classes
+        # @param [Class] Child class
+        def inherited(klass)
+          super
+          klass.sanitize_options = self.sanitize_options.dup
+        end
+
+        def sanitize_options=(options)
+          fields = options[:fields]
+          if fields.nil? || !fields.is_a?(Array) || fields.empty?
+            raise ArgumentError, ":fields must be a non-empty array" 
+          end
+          options[:fields] = fields.uniq.compact
+          sanitizer = options[:sanitizer]
+          if sanitizer && !sanitizer.is_a?(Symbol) && !sanitizer.respond_to?(:call)
+            raise ArgumentError, "If you provide :sanitizer it must be Symbol or callable." 
+          end
+          sanitizer_to_be_called = sanitizer.nil? ? :sanitize_field : sanitizer
+          do_downcase = options[:downcase].class == TrueClass
+          field_sanitize_map = {}
+          field_downcase_map = {}
+          options[:fields].each do |f|
+            field_sanitize_map[f.to_sym] = sanitizer_to_be_called
+            field_downcase_map[f.to_sym] = do_downcase
+          end
+          @sanitize_options ||= {}
+          @sanitize_options[:fields] ||= []
+          @sanitize_options[:field_sanitize] ||= {}
+          @sanitize_options[:field_downcase] ||= {}
+          @sanitize_options[:fields].concat(options[:fields])
+          @sanitize_options[:fields].uniq!
+          @sanitize_options[:fields].compact!
+          @sanitize_options[:field_sanitize].merge!(field_sanitize_map)
+          @sanitize_options[:field_downcase].merge!(field_downcase_map)
+        end
+      end
+
+      module InstanceMethods
+        private
+        def sanitize_field(value)
+          sanitized_value = value.strip if value.respond_to?(:strip)
+          sanitized_value
+        end
+      end # InstanceMethods
+    end # Sanitize
+  end # Plugins
+end # Sequel

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+name: sequel_sanitize
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Kevin Tom
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-12 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: sequel
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        - 0
+        version: 3.0.0
+  type: :runtime
+  version_requirements: *id001
+description: Sequel plugin which lets you set a sanitization method on specific fields
+email: kevin@kevintom.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- LICENSE
+- CHANGELOG
+files: 
+- Rakefile
+- lib/sequel_sanitize/version.rb
+- lib/sequel_sanitize.rb
+- README.rdoc
+- LICENSE
+- CHANGELOG
+has_rdoc: true
+homepage: http://github.com/kevintom/sequel_sanitize
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Sequel plugin which lets you set a sanitization method on specific fields
+test_files: []
+