acts_as_sanitizable 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1e4032dfb42f0d9a4f5935a37e456ecfcd17bb9d
-  data.tar.gz: 20702d4096f6eaa01d99671873b3f5c6ecbe0c54
+  metadata.gz: 9b972376078e9eed1a1775f90b95273f497ad948
+  data.tar.gz: bbf4c81e36b1ec67715243c623e3865754b8102a
 SHA512:
-  metadata.gz: 2c7dfd888ca9ca4fb4cd8f3ffaacd9aa0bce869175e61da41b64630392863bad3d52bb232f671689416269bb69f9ddd090ec750461883892ffc9f88bac59aa43
-  data.tar.gz: 7e9b12707785bd8f0a565f50aaeeccd498790ed132f03a1697d4ca76474e03d4571cdcfbd7fa58927ae435c7d5a97b82f7c7223b7498e3d4c9019f84f088a0cf
+  metadata.gz: 56c954eabaa0adaf98ff9e1d71e9aea2278d197d8aa8ded34c9258cb4189571e0641c4efbda3f9e8e2c55f413752b157bc7a44a3492e5e8d74632127f2a2b548
+  data.tar.gz: 05c95047407bc919d93186703a9f9b540dec17c409e19d9426dc7bb074a1b663143f6b7b9eab04cb28d01b7d3315a0ff060a7a7bfdd563584db1773439a0f1a9

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.1.0
+script:
+  - bundle exec rspec spec

data/Gemfile

@@ -17,5 +17,4 @@ group :development do
   gem "simplecov", ">= 0"
   gem "activerecord", ">= 2.3.5"
   gem "activemodel", ">= 3.0.0"
-  gem "factory_girl"
 end

data/Gemfile.lock

@@ -35,8 +35,6 @@ GEM
     diff-lcs (1.2.5)
     docile (1.1.3)
     erubis (2.7.0)
-    factory_girl (4.4.0)
-      activesupport (>= 3.0.0)
     faraday (0.9.0)
       multipart-post (>= 1.2, < 3)
     git (1.2.6)
@@ -156,7 +154,6 @@ DEPENDENCIES
   activemodel (>= 3.0.0)
   activerecord (>= 2.3.5)
   bundler (~> 1.0)
-  factory_girl
   jeweler (~> 2.0.1)
   rails (>= 3.2.0, < 5)
   rdoc (~> 3.12)

data/README.md

@@ -1,4 +1,47 @@
-acts_as_sanitizable
-===================
+# acts_as_sanitizable [![Gem Version](https://badge.fury.io/rb/acts_as_sanitizable.svg)](http://badge.fury.io/rb/acts_as_sanitizable) [![Build Status](https://travis-ci.org/chilian/acts_as_sanitizable.svg?branch=master)](https://travis-ci.org/chilian/acts_as_sanitizable) [![Code Climate](https://codeclimate.com/github/chilian/acts_as_sanitizable.png)](https://codeclimate.com/github/chilian/acts_as_sanitizable)
 
-Sanitizable concern to sanitize attributes the way you like
+Sanitizable concern to sanitize activerecord model attributes the way you like. E.g. very useful if you want to convert empty strings from your form params into `nil`...  
+
+## Installation
+
+Add `acts_as_sanitizable` to your `Gemfile`:
+
+```ruby
+gem 'acts_as_sanitizable'
+```
+
+Download and install by running:
+
+```
+bundle install
+```
+
+Add the `sanitizes`-method to your model:
+
+```
+class User < ActiveRecord::Base   
+  sanitizes :content, with: :squish
+  sanitizes :content, :another_attribute, :nth_attribute, with: [:strip, :upcase]
+  sanitizes :content do |content|
+    content.squish.downcase
+  end
+  sanitizes :content, with: ->(content) { content.squish.downcase }
+end
+```
+
+
+## Contributing to acts_as_sanitizable
+
+Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+
+Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+
+Fork the project.
+
+Start a feature/bugfix branch.
+
+Commit and push until you are happy with your contribution.
+
+Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+
+Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.3.0

data/acts_as_sanitizable.gemspec

@@ -2,40 +2,42 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: acts_as_sanitizable 0.2.0 ruby lib
+# stub: acts_as_sanitizable 0.3.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "acts_as_sanitizable"
-  s.version = "0.2.0"
+  s.version = "0.3.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-15"
+  s.date = "2014-04-16"
   s.description = "Sanitizable concern to sanitize attributes the way you like"
   s.email = "christoph@chilian.de"
   s.extra_rdoc_files = [
     "LICENSE.txt",
-    "README.md",
-    "README.rdoc"
+    "README.md"
   ]
   s.files = [
     ".document",
+    ".travis.yml",
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",
     "README.md",
-    "README.rdoc",
     "Rakefile",
     "VERSION",
     "acts_as_sanitizable.gemspec",
     "lib/acts_as_sanitizable.rb",
+    "lib/sanitizable.rb",
+    "lib/sanitizable/attribute_sanitizer.rb",
+    "lib/sanitizable/macro.rb",
+    "lib/sanitizable/model.rb",
     "spec/db/database.yml",
     "spec/db/schema.rb",
-    "spec/factories/user.rb",
-    "spec/models/acts_as_sanitizable_spec.rb",
+    "spec/models/sanitizable_spec.rb",
     "spec/spec_helper.rb",
-    "spec/support/user.rb",
+    "spec/support/models.rb",
     "test/helper.rb",
     "test/test_acts_as_sanitizable.rb"
   ]
@@ -59,7 +61,6 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<simplecov>, [">= 0"])
       s.add_development_dependency(%q<activerecord>, [">= 2.3.5"])
       s.add_development_dependency(%q<activemodel>, [">= 3.0.0"])
-      s.add_development_dependency(%q<factory_girl>, [">= 0"])
     else
       s.add_dependency(%q<rails>, ["< 5", ">= 3.2.0"])
       s.add_dependency(%q<sqlite3>, [">= 0"])
@@ -72,7 +73,6 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<simplecov>, [">= 0"])
       s.add_dependency(%q<activerecord>, [">= 2.3.5"])
       s.add_dependency(%q<activemodel>, [">= 3.0.0"])
-      s.add_dependency(%q<factory_girl>, [">= 0"])
     end
   else
     s.add_dependency(%q<rails>, ["< 5", ">= 3.2.0"])
@@ -86,7 +86,6 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<simplecov>, [">= 0"])
     s.add_dependency(%q<activerecord>, [">= 2.3.5"])
     s.add_dependency(%q<activemodel>, [">= 3.0.0"])
-    s.add_dependency(%q<factory_girl>, [">= 0"])
   end
 end
 

data/lib/acts_as_sanitizable.rb

@@ -1,40 +0,0 @@
-require 'rubygems'
-require 'active_record'
-
-
-module ActsAsSanitizable
-  # use sanitizes concern to modify strings on specified fields
-  #
-  # -----
-  #
-  # === Example:
-  #   class User < ActiveRecord::Base   
-  #     sanitizes :content, with: :squish
-  #     sanitizes :content, :another_attribute, :nth_attribute, with: [:strip, :upcase]
-  #     sanitizes :content do |content|
-  #       content.squish.downcase
-  #     end
-  #     sanitizes :content, with: ->(content) { content.squish.downcase }
-  #   end
-  def sanitizes(*attribute_names, &block)
-    options = attribute_names.extract_options!.assert_valid_keys(:with, :on).reverse_merge(with: block_given? ? block : :strip)
- 
-    attribute_sanitizers = Array(options[:with]).map(&:to_proc)
-    
-    if attribute_sanitizers.any?
-      before_validation options.slice(:on) do
-        attribute_names.each do |attribute_name|
-          attribute_value = self.send(attribute_name)
-          unless attribute_value.nil?
-            sanitized_value = attribute_sanitizers.inject(attribute_value) do |prev_value, sanitizer_proc|
-              sanitizer_proc.call(prev_value)
-            end
-            self.send("#{attribute_name}=", sanitized_value) 
-          end
-        end
-      end
-    end
-  end
-end
-
-ActiveRecord::Base.extend(ActsAsSanitizable) if defined? ActiveRecord

data/lib/sanitizable/attribute_sanitizer.rb

@@ -0,0 +1,15 @@
+module Sanitizable
+  class AttributeSanitizer
+    attr_reader :name, :sanitizers, :context
+    
+    def initialize(name, options = {})
+      @name = name
+      @sanitizers = Array(options[:with]).map(&:to_proc)
+      @context = options[:on]
+    end
+
+    def inspect
+      "#<#{self.class.name} name: #{name.inspect}, sanitizers: #{sanitizers.inspect}, context: #{context.inspect}>"
+    end
+  end
+end

data/lib/sanitizable/macro.rb

@@ -0,0 +1,60 @@
+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
+    # 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.
+    #
+    # -----
+    #
+    # === Example:
+    #   class User < ActiveRecord::Base   
+    #     sanitizes :content, with: :squish
+    #     sanitizes :name, :content, :description, with: [:strip, :upcase]
+    #     sanitizes :content do |content|
+    #       content.squish.downcase
+    #     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 at least one attribute" if attribute_names.empty?
+
+      @sanitizable_attributes ||= []
+      @sanitizable_attributes += attribute_names.map do |attribute_name|
+        AttributeSanitizer.new(attribute_name.to_s, options.dup)
+      end
+      @sanitizable_attributes.uniq!
+    end
+
+    def acts_as_sanitizable(*attribute_names, &block)
+      sanitizes(*attribute_names, &block)
+    end
+
+    def skip_sanitization_on(*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|
+          attribute_names.include?(attribute.name) and context == attribute.context
+        end
+      end
+    end
+
+    def reset_sanitization
+      sanitizable_attributes.clear if self.include?(Model)
+    end
+  end
+end
+
+ActiveSupport.on_load(:active_record) do
+  ActiveRecord::Base.extend(Sanitizable::Macro)
+end

data/lib/sanitizable/model.rb

@@ -0,0 +1,39 @@
+module Sanitizable
+  module Model
+    extend ActiveSupport::Concern
+
+    included do
+      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
+    end
+
+    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)
+          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
+            self.send("#{attribute.name}=", sanitized_value) 
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sanitizable.rb

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'active_record'
+
+module Sanitizable
+end
+
+require 'sanitizable/attribute_sanitizer'
+require 'sanitizable/macro'
+require 'sanitizable/model'

data/spec/db/schema.rb

@@ -1,6 +1,6 @@
 ActiveRecord::Schema.define(version: 0) do
-
   create_table 'users', force: true do |t|    
+    t.string 'type'
     t.string 'first_name'
     t.string 'last_name'
     t.string 'username'

data/spec/models/sanitizable_spec.rb

@@ -0,0 +1,141 @@
+require 'spec_helper'
+
+describe Sanitizable do
+  before :each do
+    User.reset_sanitization
+  end
+
+  context 'macro' do
+    it 'must define an attribute' do
+      expect {
+        User.sanitizes with: :strip
+      }.to raise_error ArgumentError, 'User#sanitizes must define at least one attribute'
+    end
+
+    it 'can define multiple attributes' do
+      User.sanitizes :first_name, :last_name, :username, :email, with: :strip
+      expect(User.sanitizable_attribute_names).to match_array %w(first_name last_name username email)
+    end
+
+    context 'sanitizer' 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'
+      end
+      
+      it 'prefers block sanitizer over :with sanitizer' do
+        User.sanitizes :first_name, with: :upcase do |first_name|
+          first_name.downcase
+        end
+        user = User.create(first_name: 'Tobias')
+        expect(user.first_name).to eq 'tobias'
+      end
+
+      context 'using :with option' do
+        it 'can define a sanitizer' do
+          User.sanitizes :first_name, :last_name, with: :strip
+          user = User.create(first_name: '  Tobias ', last_name: '    Casper')
+          expect(user.first_name).to eq 'Tobias'
+          expect(user.last_name).to eq 'Casper'
+        end
+
+        it 'can define multiple sanitizers' do
+          User.sanitizes :email, with: [:strip, :downcase]
+          user = User.create(email: 'Tobias.Casper@GMail.com  ')
+          expect(user.email).to eq 'tobias.casper@gmail.com'
+        end
+
+        it 'can define a sanitizer from Proc' do
+          User.sanitizes :email, with: ->(email) { email.strip.downcase }
+          user = User.create(email: '  Tobias.Casper@GMail.com')
+          expect(user.email).to eq 'tobias.casper@gmail.com'
+        end
+
+        it 'can define sanitizers from mixed Symbols and Procs' do
+          sanitizers = []
+          sanitizers << lambda { |email| email.strip }
+          sanitizers << :downcase
+          User.sanitizes :email, with: sanitizers
+          user = User.create(email: '  Tobias.Casper@GMail.com')
+          expect(user.email).to eq 'tobias.casper@gmail.com'
+        end
+      end
+
+      context 'using a block' do
+        it 'can define a sanitizer' do
+          User.sanitizes :email do |email|
+            email.strip.downcase
+          end
+          user = User.create(email: '  Tobias.Casper@GMail.com   ')
+          expect(user.email).to eq 'tobias.casper@gmail.com'
+        end
+      end
+    end
+
+    context 'in inherited models' do
+      it 'can inherit a copy of the sanitizable attributes from the parent class' do
+        User.sanitizes :first_name, :last_name, with: [:strip, :upcase]
+        Admin = Class.new(User)
+        Admin.sanitizes :email, with: [:strip, :downcase]
+        expect(User.sanitizable_attribute_names).to match_array %w(first_name last_name)
+        expect(Admin.sanitizable_attribute_names).to match_array %w(first_name last_name email)
+      end
+    end
+
+    context 'contexts' do
+      before :each do
+        User.sanitizes :first_name, with: :downcase, on: :create
+        User.sanitizes :first_name, with: :upcase, on: :update
+      end
+
+      it 'recognizes a new object' do
+        new_user = User.new
+        new_user.first_name = 'Tobias'
+        new_user.save
+        expect(new_user.first_name).to eq 'tobias'
+      end
+
+      it 'recognizes a persisted object' do
+        persisted_user = User.create
+        persisted_user.first_name = 'Tobias'
+        persisted_user.save
+        expect(persisted_user.first_name).to eq 'TOBIAS'
+      end
+    end
+  end
+
+  context 'skip sanitation macro' do
+    it 'skips sanitation for attribute without context' do
+      User.sanitizes :first_name, with: :upcase
+      User.skip_sanitization_on :first_name
+
+      user = User.create(first_name: 'Tobias')
+      expect(user.first_name).to eq 'Tobias'
+    end
+
+    it 'skips sanitation for attribute in same context' do
+      User.sanitizes :first_name, with: :upcase, on: :create
+      User.skip_sanitization_on :first_name, on: :create
+
+      user = User.create(first_name: 'Tobias')
+      expect(user.first_name).to eq 'Tobias'
+    end
+
+    it 'does not skip sanitation for attribute in main context' do
+      User.sanitizes :first_name, with: :upcase, on: :create
+      User.skip_sanitization_on :first_name
+
+      user = User.create(first_name: 'Tobias')
+      expect(user.first_name).to eq 'TOBIAS'
+    end
+
+    it 'does not skip sanitation for attribute in another context' do
+      User.sanitizes :first_name, with: :upcase, on: :create
+      User.skip_sanitization_on :first_name, on: :update
+
+      user = User.create(first_name: 'Tobias')
+      expect(user.first_name).to eq 'TOBIAS'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -3,24 +3,19 @@ TEST_DIR = File.dirname(__FILE__)
 require 'rubygems'
 require 'bundler/setup'
 require 'yaml'
-require 'factory_girl'
 require 'rails/all'
 
-
-#Bundler.setup
+# Bundler.setup
 
 ActiveRecord::Base.configurations = YAML.load_file("#{TEST_DIR}/db/database.yml")
 ActiveRecord::Base.establish_connection(:sqlite3mem)
 ActiveRecord::Migration.verbose = false
 
-require 'acts_as_sanitizable'
-require 'support/user' # user model for testing
-Dir["#{TEST_DIR}/factories/*.rb"].each { |file| require file }
+require 'sanitizable'
+require 'support/models'
 require 'rspec/rails'
 
 RSpec.configure do |config|
-  config.include FactoryGirl::Syntax::Methods
-
   config.before :suite do
     I18n.enforce_available_locales = true
     load "#{TEST_DIR}/db/schema.rb"

data/spec/support/models.rb

@@ -0,0 +1,2 @@
+class User < ActiveRecord::Base
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_sanitizable
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Christoph Chilian
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-15 00:00:00.000000000 Z
+date: 2014-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -170,20 +170,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.0.0
-- !ruby/object:Gem::Dependency
-  name: factory_girl
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: Sanitizable concern to sanitize attributes the way you like
 email: christoph@chilian.de
 executables: []
@@ -191,24 +177,26 @@ extensions: []
 extra_rdoc_files:
 - LICENSE.txt
 - README.md
-- README.rdoc
 files:
 - ".document"
+- ".travis.yml"
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
 - README.md
-- README.rdoc
 - Rakefile
 - VERSION
 - acts_as_sanitizable.gemspec
 - lib/acts_as_sanitizable.rb
+- lib/sanitizable.rb
+- lib/sanitizable/attribute_sanitizer.rb
+- lib/sanitizable/macro.rb
+- lib/sanitizable/model.rb
 - spec/db/database.yml
 - spec/db/schema.rb
-- spec/factories/user.rb
-- spec/models/acts_as_sanitizable_spec.rb
+- spec/models/sanitizable_spec.rb
 - spec/spec_helper.rb
-- spec/support/user.rb
+- spec/support/models.rb
 - test/helper.rb
 - test/test_acts_as_sanitizable.rb
 homepage: http://github.com/chilian/acts_as_sanitizable

data/README.rdoc

@@ -1,19 +0,0 @@
-= acts_as_sanitizable
-
-Description goes here.
-
-== Contributing to acts_as_sanitizable
- 
-* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
-* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
-* Fork the project.
-* Start a feature/bugfix branch.
-* Commit and push until you are happy with your contribution.
-* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
-* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-
-== Copyright
-
-Copyright (c) 2014 Christoph Chilian. See LICENSE.txt for
-further details.
-

data/spec/factories/user.rb

@@ -1,6 +0,0 @@
-FactoryGirl.define do
-  factory :user do
-    first_name "Christoph"
-    last_name "Chilian"
-  end
-end

data/spec/models/acts_as_sanitizable_spec.rb

@@ -1,27 +0,0 @@
-require 'spec_helper'
-
-
-describe ActsAsSanitizable do
-
-
-  it "first_name ' Christoph ' returns 'Christoph' after strip" do
-    user = create(:user, first_name: " Christoph ")   
-    expect(user.first_name).to eq("Christoph")
-  end
-
-  it "last_name 'Chilian' returns 'CHILIAN' after upcase" do
-    user = create(:user, last_name: "Chilian")   
-    expect(user.last_name).to eq("CHILIAN")
-  end
-
-  it "email 'chriStoph@Chilian.de  ' returns 'christoph@chilian.de' after squish and downcase" do
-    user = create(:user, email: "chriStoph@Chilian.de  ")   
-    expect(user.email).to eq("christoph@chilian.de")
-  end
-
-  it "username should be downcased gsub'ed" do
-    user = create(:user, username: '@YamYam')
-    expect(user.username).to eq 'yamyam'
-  end
-
-end

data/spec/support/user.rb

@@ -1,11 +0,0 @@
-class User < ActiveRecord::Base
-
-  sanitizes :username, with: [:downcase, ->(content) { content.gsub(/\A@/, '') }]
-  sanitizes :first_name, with: :strip
-  sanitizes :last_name, with: :upcase
-
-  sanitizes :email do |content|
-    content.squish.downcase
-  end
-
-end