acts_as_sanitizable 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 681b4753eb5471f8111f05ea9b1091754ce973fa
-  data.tar.gz: c4417a1084361ac08a02ebedec4a5e4e71cf8501
+  metadata.gz: 5e4317192c5b23b320ebbce26cf6e9ba1962a66e
+  data.tar.gz: 3b676779bf3852f8a05d9e178396497dd17fb779
 SHA512:
-  metadata.gz: 43eb287384242a29b688e61e55d2588046532b7641a3b44c8b7a3eeb6cc1b658693bc468175e0219b4c13217a8be3b75036fcd5cbe43a2a9aa5fcb6771978d01
-  data.tar.gz: a49fba0e61391f986b8d2812ad9e5625cbe46c64c12053cf542e14d10fcbdacf5fbf83d426ee3da61a4db99d52aa505373bc126160577a0f18f0843dfef644ca
+  metadata.gz: ce11693621154504f735c5ab69cd64fa03954e2bf003a5e9dbfbeb1efda2e55b9bfcccf30851afd3bf3814ce6082da86f7e4dda41f710566fac4576cabdf0289
+  data.tar.gz: 1f42baef78fa388c8f0925ede8bdeac70b005b2d71856a8318bc22bc16767ab031e45f5588e34574237c4598631a8182638b767738bd7e3bec0732e2db8b1b73

data/README.md

@@ -16,19 +16,64 @@ Download and install by running:
 bundle install
 ```
 
-Add the `sanitizes`-method to your model:
+## Usage
 
-```
+Add the `sanitizes` method to your model to perform sanitization on specific attributes. You can define what type of sanitization you want to do by specifing a `:with` option or a block.
+
+```ruby
 class User < ActiveRecord::Base   
-  sanitizes :content, with: :squish
-  sanitizes :content, :another_attribute, :nth_attribute, with: [:strip, :upcase]
-  sanitizes :content do |content|
-    content.squish.downcase
+  sanitizes :first_name, :last_name, with: :strip
+  sanitizes :email, with: [:strip, :downcase]
+  sanitizes :biography, with: ->(biography) { biography.squish }
+  sanitizes :username do |username|
+    # strip leading "@" characters as used in Twitter usernames
+    username.strip.downcase.sub(/\A@/, '')
   end
-  sanitizes :content, with: ->(content) { content.squish.downcase }
 end
 ```
 
+The `sanitizes` method is aliased as `acts_as_sanitizable`.
+
+Sanitization is performed `before_validation` so the sanitized content will only be visible after calling the `valid?` or `save` methods on your instance of the model.
+
+### Contexts
+
+You can define when sanitization should be performed via `:on`. If no `:on` parameter is specified acts_as_sanitizable will sanitize on both, create and update.
+
+```ruby
+class User < ActiveRecord::Base
+  sanitizes :first_name, with: :strip, on: :create
+  sanitizes :last_name, with: :strip, on: :update
+end
+```
+
+### Inheritance
+
+```ruby
+class User < ActiveRecord::Base   
+  sanitizes :first_name, :last_name, with: :strip
+  sanitizes :email, with: [:strip, :downcase], on: :create
+end
+```
+
+If you wish to not sanitize specific attributes on an inherited model you can call `skip_sanitization_on`. When you have been using a context in the sanitizer definition be sure to specify the same one when using `skip_sanitization_on`.
+
+```ruby
+class Admin < User
+  skip_sanitization_on :first_name
+  skip_sanitization_on :email, on: :create
+end
+```
+
+### Reflection
+
+You can return a list of all sanitized attributes by calling:
+
+```ruby
+User.sanitizable_attributes # => [#<Sanitizable::AttributeSanitizer name: :first_name, ...>, ...]
+
+User.sanitizable_attribute_names # => [:first_name, :last_name, ...]
+```
 
 ## Contributing to acts_as_sanitizable
 

data/VERSION

@@ -1 +1 @@
-0.3.1
+0.4.0

data/acts_as_sanitizable.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: acts_as_sanitizable 0.3.1 ruby lib
+# stub: acts_as_sanitizable 0.4.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "acts_as_sanitizable"
-  s.version = "0.3.1"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Christoph Chilian"]
-  s.date = "2014-04-16"
+  s.date = "2014-04-22"
   s.description = "Sanitizable concern to sanitize attributes the way you like"
   s.email = "christoph@chilian.de"
   s.extra_rdoc_files = [

data/lib/sanitizable/attribute_sanitizer.rb

@@ -1,15 +1,22 @@
 module Sanitizable
   class AttributeSanitizer
-    attr_reader :name, :sanitizers, :context
+    attr_reader :name, :sanitizers, :sanitizer_procs, :context
     
     def initialize(name, options = {})
       @name = name
-      @sanitizers = Array(options[:with]).map(&:to_proc)
+      @sanitizers = Array(options[:with])
+      @sanitizer_procs = @sanitizers.map(&:to_proc)
       @context = options[:on]
     end
 
     def inspect
       "#<#{self.class.name} name: #{name.inspect}, sanitizers: #{sanitizers.inspect}, context: #{context.inspect}>"
     end
+
+    def sanitize(value)
+      @sanitizer_procs.inject(value) do |prev_value, sanitizer_proc|
+        sanitizer_proc.call(prev_value)
+      end
+    end
   end
 end

data/lib/sanitizable/macro.rb

@@ -1,9 +1,7 @@
-require 'active_support/concern'
-
 module Sanitizable
   module Macro
     # Defines one or multiple columns that should be sanitized. The method used
-    # for sanitizing can be defined via the :option key and can either contain the name
+    # for sanitizing can be defined via the :with key and can either contain the name
     # of any method that is implemented on the particular class or a custom Proc.
     # Additionally, an Array of Symbols or Procs can be speficied. Alternatively a block
     # can be supplied as sanitizer.
@@ -12,43 +10,51 @@ module Sanitizable
     #
     # === Example:
     #   class User < ActiveRecord::Base   
-    #     sanitizes :content, with: :squish
-    #     sanitizes :name, :content, :description, with: [:strip, :upcase]
-    #     sanitizes :content do |content|
-    #       content.squish.downcase
+    #     sanitizes :first_name, :last_name, with: :strip
+    #     sanitizes :email, with: [:strip, :downcase]
+    #     sanitizes :biography, with: ->(biography) { biography.squish }
+    #     sanitizes :username do |username|
+    #       # strip leading "@" characters as used in Twitter usernames
+    #       username.strip.downcase.sub(/\A@/, '')
     #     end
-    #     sanitizes :content, with: ->(content) { content.squish.downcase }
     #   end
     def sanitizes(*attribute_names, &block)  
       include Model unless self.include?(Model)
 
       options = attribute_names.extract_options!.assert_valid_keys(:with, :on)
       options[:with] = block || options[:with]
-      raise ArgumentError, "#{self.name}#sanitizes must define a :with option or have block" unless options[:with]
+      raise ArgumentError, "#{self.name}#sanitizes must define a :with option or have a block" unless options[:with]
       raise ArgumentError, "#{self.name}#sanitizes must define at least one attribute" if attribute_names.empty?
 
-      @sanitizable_attributes ||= []
-      @sanitizable_attributes += attribute_names.map do |attribute_name|
+      self.sanitizable_attributes += attribute_names.map do |attribute_name|
         AttributeSanitizer.new(attribute_name.to_s, options.dup)
       end
-      @sanitizable_attributes.uniq!
+      self.sanitizable_attributes.uniq!
     end
 
     def acts_as_sanitizable(*attribute_names, &block)
       sanitizes(*attribute_names, &block)
     end
 
-    def skip_sanitization_on(*attribute_names)
+    def acts_as_sanitizable_on(*attribute_names, &block)
+      sanitizes(*attribute_names, &block)
+    end
+
+    def skip_sanitization_of(*attribute_names)
       if self.include?(Model)
         options = attribute_names.extract_options!.assert_valid_keys(:on)
         attribute_names = attribute_names.map(&:to_s)
         context = options[:on]
-        @sanitizable_attributes.delete_if do |attribute|
+        sanitizable_attributes.delete_if do |attribute|
           attribute_names.include?(attribute.name) and context == attribute.context
         end
       end
     end
 
+    def skip_sanitization_on(*attribute_names)
+      skip_sanitization_of(*attribute_names)
+    end
+
     def reset_sanitization
       sanitizable_attributes.clear if self.include?(Model)
     end
@@ -57,4 +63,4 @@ end
 
 ActiveSupport.on_load(:active_record) do
   ActiveRecord::Base.extend(Sanitizable::Macro)
-end
+end

data/lib/sanitizable/model.rb

@@ -1,20 +1,17 @@
+require 'active_support/concern'
+
 module Sanitizable
   module Model
     extend ActiveSupport::Concern
 
     included do
+      class_attribute :sanitizable_attributes
+      self.sanitizable_attributes = []
+
       before_validation :_sanitize_attributes
     end
 
     module ClassMethods
-      def inherited(base)
-        base.instance_variable_set(:@sanitizable_attributes, sanitizable_attributes.dup)
-      end
-
-      def sanitizable_attributes
-        @sanitizable_attributes ||= []
-      end
-
       def sanitizable_attribute_names
         sanitizable_attributes.collect(&:name).uniq.freeze
       end
@@ -22,18 +19,20 @@ module Sanitizable
 
     private
     def _sanitize_attributes
-      context = new_record? ? :create : :update
       self.class.sanitizable_attributes.each do |attribute|
-        if attribute.context.nil? or (!attribute.context.nil? and attribute.context == context)
+        if _sanitizable_in_context?(attribute.context)
           original_value = self.send(attribute.name)
           unless original_value.nil?
-            sanitized_value = attribute.sanitizers.inject(original_value) do |prev_value, sanitizer_proc|
-              sanitizer_proc.call(prev_value)
-            end
+            sanitized_value = attribute.sanitize(original_value)
             self.send("#{attribute.name}=", sanitized_value) 
           end
         end
       end
     end
+
+    def _sanitizable_in_context?(context)
+      actual_context = new_record? ? :create : :update
+      context.nil? or (!context.nil? and context == actual_context)
+    end
   end
 end

data/spec/models/sanitizable_spec.rb

@@ -21,7 +21,7 @@ describe Sanitizable do
       it 'must be defined through :with or a block' do
         expect {
           User.sanitizes :first_name
-        }.to raise_error ArgumentError, 'User#sanitizes must define a :with option or have block'
+        }.to raise_error ArgumentError, 'User#sanitizes must define a :with option or have a block'
       end
       
       it 'prefers block sanitizer over :with sanitizer' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_sanitizable
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Christoph Chilian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-16 00:00:00.000000000 Z
+date: 2014-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails