activecleaner 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 54ad3d4c2a454cfb2e8237abb6399bab45d5448c
-  data.tar.gz: 3bf151d63ce0286fa4819a2ce1a25e61a62a3047
+  metadata.gz: f568e263b920da28be6897d33c390ba37d100d02
+  data.tar.gz: 6649a5b52ece6e7181a8c3d8bc635c3e671dd5d7
 SHA512:
-  metadata.gz: 46a2b65f759e7d9501de3795637707e9a5de27375185526e7fc55c6bb9cd270f880b498e0e6817f3ac414d68449407734f5976b9107bbb8727b28585f01c13d8
-  data.tar.gz: 7a7d84b9e7ff1e68733b13e1b4c995f85f07f001a2a77de562c2ef501ae76aae9cdc222c0fc6eeafb2337645c9a76602f353feab9b2955ea4ab319b2ff81cb6e
+  metadata.gz: 09c356b188281b08dd78d2c9d99622234c0be6d2be3f795a9dce25c7e27c527f3e5880cf60f4f125bad8f648e319658aeab9d810c47cf7e7b97f1467122e3cc0
+  data.tar.gz: 26fcaef9a2105e5df417ec0a8c1440d56b1792acfac489bbd2606fdc1464333dcbb83296cf6f4084abcc61398920cd0cb10244f7a308d4ddfcd1b5187810bc5a

data/README.md

@@ -1,6 +1,8 @@
 # ActiveCleaner
 
-[![Gem Version](https://badge.fury.io/rb/activecleaner.svg)](http://badge.fury.io/rb/activecleaner) [![Build Status](https://travis-ci.org/maximeg/activecleaner.svg?branch=master)](https://travis-ci.org/maximeg/activecleaner)
+[![Gem Version](https://badge.fury.io/rb/activecleaner.svg)](https://rubygems.org/gems/activecleaner)
+[![Build Status](https://travis-ci.org/maximeg/activecleaner.svg?branch=master)](https://travis-ci.org/maximeg/activecleaner)
+[![Dependency Status](https://gemnasium.com/maximeg/activecleaner.svg)](https://gemnasium.com/maximeg/activecleaner)
 
 `ActiveCleaner` is a set of helpers that helps you in cleaning user-typed content in your ActiveModel depending models (ActiveRecord, Mongoid...)
 
@@ -26,6 +28,7 @@ end
  * `:string` (StringCleaner, the default one) : cleans all the space characters. It turns `"   A  \n  \t title   \t  "` into `"A title"`.
  * `:text` (TextCleaner) : like `:string`, but preserves new lines (with a max of 2 successive new lines). useful when the field is rendered with the `simple_format` Rails helper.
  * `:markdown` (MarkdownCleaner) : like `:text`, but preserves spaces in the beginning of lines (the indentation). useful for... markdown!
+ * `:utf8mb3` (Utf8mb3Cleaner) : removes all 4-bytes encoded chars in UTF8 strings that mess with the `utf8` encoding in MySQL (iOS6 emojis for example).
 
 
 

data/lib/active_cleaner.rb

@@ -10,6 +10,7 @@ require 'active_cleaner/base_cleaner'
 require 'active_cleaner/string_cleaner'
 require 'active_cleaner/text_cleaner'
 require 'active_cleaner/markdown_cleaner'
+require 'active_cleaner/utf8mb3_cleaner'
 
 require 'active_cleaner/version'
 

data/lib/active_cleaner/utf8mb3_cleaner.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+
+module ActiveCleaner
+  class Utf8mb3Cleaner < BaseCleaner
+
+    def clean_value(old_value, record=nil)
+      unless old_value.nil?
+        old_value.each_char.select { |char| char.bytesize < 4 }.join('')
+      end
+    end
+
+  end
+end

data/lib/active_cleaner/version.rb

@@ -2,7 +2,7 @@
 module ActiveCleaner
   module Version
 
-    STRING = '0.2.0'
+    STRING = '0.3.0'
 
   end
 end

data/spec/cases/inherit_spec.rb

@@ -17,9 +17,10 @@ class Ad
 end
 
 class CarAd < Ad
-  attr_accessor :body
+  attr_accessor :body, :user_generated_content
 
   clean :body, as: :text
+  clean :user_generated_content, as: :utf8mb3
 end
 
 #
@@ -49,8 +50,8 @@ describe "Case: an ad and his inherited car ad" do
 
     subject { CarAd._cleaners }
 
-    it "has 3 cleaners" do
-      expect(subject.length).to eq(3)
+    it "has 4 cleaners" do
+      expect(subject.length).to eq(4)
     end
 
     it "includes a StringCleaner for #title" do
@@ -65,6 +66,10 @@ describe "Case: an ad and his inherited car ad" do
       expect(subject[:body].first).to eq(ActiveCleaner::TextCleaner.new(:body))
     end
 
+    it "includes a Utf8mb3Cleaner for #user_generated_content" do
+      expect(subject[:user_generated_content].first).to eq(ActiveCleaner::Utf8mb3Cleaner.new(:user_generated_content))
+    end
+
   end # describe
 
   context "considering a car ad" do
@@ -119,6 +124,22 @@ describe "Case: an ad and his inherited car ad" do
 
     end # describe
 
+    describe "#user_generated_content, marked as to clean as utf8mb3" do
+
+      it "is untouched when legit" do
+        subject.user_generated_content = "A good user generated content!"
+        subject.valid?
+        expect(subject.user_generated_content).to eq("A good user generated content!")
+      end
+
+      it "is cleaned as an utf8mb3" do
+        subject.user_generated_content = "A good 😀 user generated content!"
+        subject.valid?
+        expect(subject.user_generated_content).to eq("A good  user generated content!")
+      end
+
+    end # describe
+
   end # context
 
 end # describe

data/spec/cases/nilify_spec.rb

@@ -9,11 +9,12 @@ require "spec_helper"
 class OptimizedPost
   include ActiveCleaner
 
-  attr_accessor :title, :name, :body
+  attr_accessor :title, :name, :body, :user_generated_content
 
   clean :title, nilify: true
   clean :name, as: :string, nilify: true
   clean :body, as: :text, nilify: true
+  clean :user_generated_content, as: :utf8mb3, nilify: true
 end
 
 
@@ -26,8 +27,8 @@ describe "Case: a simple post with nulify" do
 
     subject { OptimizedPost._cleaners }
 
-    it "has 3 cleaners" do
-      expect(subject.length).to eq(3)
+    it "has 4 cleaners" do
+      expect(subject.length).to eq(4)
     end
 
     it "includes a StringCleaner for #title" do
@@ -42,6 +43,10 @@ describe "Case: a simple post with nulify" do
       expect(subject[:body].first).to eq(ActiveCleaner::TextCleaner.new(:body, nilify: true))
     end
 
+    it "includes a Utf8mb3Cleaner for #user_generated_content" do
+      expect(subject[:user_generated_content].first).to eq(ActiveCleaner::Utf8mb3Cleaner.new(:user_generated_content, nilify: true))
+    end
+
   end # describe
 
   context "considering a post" do
@@ -96,6 +101,22 @@ describe "Case: a simple post with nulify" do
 
     end # describe
 
+    describe "#user_generated_content, marked as to clean as utf8mb3" do
+
+      it "is untouched when legit" do
+        subject.user_generated_content = "A good user generated content!"
+        subject.valid?
+        expect(subject.user_generated_content).to eq("A good user generated content!")
+      end
+
+      it "is nulified" do
+        subject.user_generated_content = "😀"
+        subject.valid?
+        expect(subject.user_generated_content).to be_nil
+      end
+
+    end # describe
+
   end # context
 
 end # describe

data/spec/cases/simple_spec.rb

@@ -9,11 +9,12 @@ require "spec_helper"
 class Post
   include ActiveCleaner
 
-  attr_accessor :title, :name, :body
+  attr_accessor :title, :name, :body, :user_generated_content
 
   clean :title
   clean :name, as: :string
   clean :body, as: :text
+  clean :user_generated_content, as: :utf8mb3
 end
 
 
@@ -26,8 +27,8 @@ describe "Case: a simple post" do
 
     subject { Post._cleaners }
 
-    it "has 3 cleaners" do
-      expect(subject.length).to eq(3)
+    it "has 4 cleaners" do
+      expect(subject.length).to eq(4)
     end
 
     it "includes a StringCleaner for #title" do
@@ -42,6 +43,10 @@ describe "Case: a simple post" do
       expect(subject[:body].first).to eq(ActiveCleaner::TextCleaner.new(:body))
     end
 
+    it "includes a Utf8mb3Cleaner for #user_generated_content" do
+      expect(subject[:user_generated_content].first).to eq(ActiveCleaner::Utf8mb3Cleaner.new(:user_generated_content))
+    end
+
   end # describe
 
   context "considering a post" do
@@ -96,6 +101,22 @@ describe "Case: a simple post" do
 
     end # describe
 
+    describe "#user_generated_content, marked as to clean as utf8mb3" do
+
+      it "is untouched when legit" do
+        subject.user_generated_content = "A good user generated content!"
+        subject.valid?
+        expect(subject.user_generated_content).to eq("A good user generated content!")
+      end
+
+      it "is cleaned as an utf8mb3" do
+        subject.user_generated_content = "A good 😀 user generated content!"
+        subject.valid?
+        expect(subject.user_generated_content).to eq("A good  user generated content!")
+      end
+
+    end # describe
+
   end # context
 
 end # describe

data/spec/lib/active_cleaner/utf8mb4_cleaner_spec.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe ActiveCleaner::Utf8mb3Cleaner do
+
+  let(:cleaner) { ActiveCleaner::Utf8mb3Cleaner.new(:title) }
+
+  describe "#clean_value" do
+
+    it "doesn't touch legit value" do
+      expect(cleaner.clean_value("A good title!")).to eq("A good title!")
+    end
+
+    it "cleans emoticons" do
+      emoticons = "😀😁😂😃😄😅😆😇😈😉😊😋😌😍😎😏😐😑😒😓😔😕😖😗😘😙😚😛😜😝😞😟😠😡😢😣😤😥😦😧😨😩😪😫😬😭😮😯😰😱😲😳😴😵😶😷😸😹😺😻😼😽😾😿🙀🙁🙂🙅🙆🙇🙈🙉🙊🙋🙌🙍🙎🙏"
+      expect(cleaner.clean_value("A good #{emoticons} title!")).to eq("A good  title!")
+    end
+
+    it "kepts accentued chars" do
+      expect(cleaner.clean_value("L'Inouï Goûter À Manger.")).to eq("L'Inouï Goûter À Manger.")
+    end
+
+    it "kepts japanese chars" do
+      expect(cleaner.clean_value("ginkō is written as 銀行")).to eq("ginkō is written as 銀行")
+    end
+
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activecleaner
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Maxime Garcia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-19 00:00:00.000000000 Z
+date: 2014-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -86,6 +86,7 @@ files:
 - lib/active_cleaner/markdown_cleaner.rb
 - lib/active_cleaner/string_cleaner.rb
 - lib/active_cleaner/text_cleaner.rb
+- lib/active_cleaner/utf8mb3_cleaner.rb
 - lib/active_cleaner/version.rb
 - lib/activecleaner.rb
 - spec/cases/inherit_spec.rb
@@ -94,6 +95,7 @@ files:
 - spec/lib/active_cleaner/markdown_cleaner_spec.rb
 - spec/lib/active_cleaner/string_cleaner_spec.rb
 - spec/lib/active_cleaner/text_cleaner_spec.rb
+- spec/lib/active_cleaner/utf8mb4_cleaner_spec.rb
 - spec/lib/active_cleaner_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/maximeg/activecleaner
@@ -116,16 +118,17 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.1
+rubygems_version: 2.4.2
 signing_key: 
 specification_version: 4
 summary: Clean the fields in your models
 test_files:
-- spec/lib/active_cleaner/string_cleaner_spec.rb
+- spec/cases/simple_spec.rb
+- spec/cases/inherit_spec.rb
+- spec/cases/nilify_spec.rb
 - spec/lib/active_cleaner/text_cleaner_spec.rb
+- spec/lib/active_cleaner/utf8mb4_cleaner_spec.rb
+- spec/lib/active_cleaner/string_cleaner_spec.rb
 - spec/lib/active_cleaner/markdown_cleaner_spec.rb
 - spec/lib/active_cleaner_spec.rb
 - spec/spec_helper.rb
-- spec/cases/inherit_spec.rb
-- spec/cases/simple_spec.rb
-- spec/cases/nilify_spec.rb