activecleaner 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 158e7ce1e853b39bf241a0bfbe3d50b7e583b18e
-  data.tar.gz: 5d6da62887b63399be53d73c00e5dda6a77f008c
+SHA256:
+  metadata.gz: db7af709547b9681d4d402b9e4f7d58afd93285f18699653d205d91bf2de76c7
+  data.tar.gz: c0c308d472f8c4a47b9c0cacdb999fad674ff048fc3fe5fabd1bbd3fb381c9d3
 SHA512:
-  metadata.gz: 7ae1bd28121eb544095c27f801b6d20b15cef8e3b0f790ac6153728b178acd84b4d35ac182a27c34bce1559f41358e967f0a5dfd0a60d7e3810a715388bb2659
-  data.tar.gz: 3e04e8552411cd72504bb451fa76c822b48443bac2f299473efe3bf623ba3207ea0115e802be5812321bc6dbe781b6421fd03e32fe08a68ba7459c569d3245c4
+  metadata.gz: da651be9a0a08b68d4456fe0a225602474615a6ceeea90fb32a255e5e4b82de5645cccdad40919e175d8d508a782df2c6db265be0f2ac56fd024b08ad820d503
+  data.tar.gz: 676b0c47a6e16edea5f862fd3c89b8e35305e386a9bbedd2bdd34340fbc2788330e60ca575e547e566c218efb6aaf6f820ecb792d60a87572ba07f5349ccaaf2

data/lib/active_cleaner.rb

@@ -1,52 +1,69 @@
-# encoding: utf-8
-
-require 'active_support'
-#require 'active_support/rails'
-require 'active_model'
-
-require 'active_cleaner/helper_methods'
-
-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'
-
+# frozen_string_literal: true
+
+require "active_support"
+require "active_model"
+
+require "active_cleaner/helper_methods"
+
+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"
+
+# = ActiveCleaner
+#
+# See HelperMethods for the DSL.
+#
+# == Example
+#
+#   class Post
+#     include Mongoid::Document
+#     include ActiveCleaner
+#
+#     field :title
+#     field :subtitle
+#     clean :title, :subtitle, nilify: true
+#
+#     field :body
+#     clean :body, as: :text, nilify: true
+#   end
 module ActiveCleaner
+
   extend ActiveSupport::Concern
 
   included do
-
     include ActiveModel::Validations
 
     extend HelperMethods
     include HelperMethods
 
-    define_callbacks :cleaning, :scope => :name
+    define_callbacks :cleaning, scope: :name
 
     class_attribute :_cleaners
-    self._cleaners = Hash.new { |h,k| h[k] = [] }
+    self._cleaners = Hash.new { |h, k| h[k] = [] }
 
     set_callback :validate, :before, :run_cleaners!
+  end
 
-  end # included
-
-
-  module ClassMethods
+  module ClassMethods #:nodoc:
 
     def inherited(base) #:nodoc:
       dup = _cleaners.dup
-      base._cleaners = dup.each { |k, v| dup[k] = v.dup }
+      base._cleaners =
+        dup.each do |attr_name, cleaner|
+          dup[attr_name] = cleaner.dup
+        end
       super
     end
 
-  end # ClassMethods
-
+  end
 
+  # Do run the cleaners
   def run_cleaners!
-    self._cleaners.each do |attr_name, cleaners|
+    _cleaners.each do |_attr_name, cleaners|
       cleaners.each do |cleaner|
         cleaner.clean(self)
       end
@@ -55,9 +72,12 @@ module ActiveCleaner
     true
   end
 
+  # Method used by the cleaners to read the value of an attribute.
   def read_attribute_for_cleaning(attr_name)
     send(attr_name)
   end
+
+  # Method used by the cleaners to write the value of an attribute.
   def write_attribute_after_cleaning(attr_name, value)
     send(:"#{attr_name}=", value)
   end

data/lib/active_cleaner/base_cleaner.rb

@@ -1,26 +1,44 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module ActiveCleaner
+  # = The base cleaner.
+  #
+  # Every cleaner inherit from it.
+  #
+  #   class MyCleaner < ActiveCleaner::BaseCleaner
+  #
+  #     def clean_value(old_value, record = nil)
+  #       old_value.gsub("foo", "bar")
+  #     end
+  #
+  #   end
   class BaseCleaner
 
-    attr_reader :attr_name, :options
+    # Attribute name
+    attr_reader :attr_name
+
+    # Options given to the cleaner.
+    attr_reader :options
 
     # Accepts options that will be made available through the +options+ reader.
     def initialize(attr_name, options = {})
       @attr_name = attr_name
       @options = {
-        :nilify => false,
+        nilify: false,
       }.merge(options).freeze
     end
 
+    # The kind of the cleaner.
     def self.kind
-      @kind ||= name.split('::').last.underscore.sub(/_cleaner$/, '').to_sym
+      @kind ||= name.split("::").last.underscore.sub(/_cleaner$/, "").to_sym
     end
 
+    # The kind of the cleaner.
     def kind
       self.class.kind
     end
 
+    # Cleans the record by extracting the value of the field, cleaning it, and setting it back.
     def clean(record)
       value = record.read_attribute_for_cleaning(attr_name)
 
@@ -31,15 +49,23 @@ module ActiveCleaner
       record.write_attribute_after_cleaning(attr_name, new_value) unless new_value == value
     end
 
-    def clean_value(value, record=nil)
+    # Cleans the value.
+    #
+    # It is expected that the returned value is the cleaned value.
+    #
+    # The method needs to be implemented in the subclasses.
+    def clean_value(_old_value, _record = nil)
       raise NotImplementedError, "Subclasses must implement a clean(value, record=nil) method."
     end
 
-    # feel free to subclass for your custom cleaner
-    def nilify_value?(value, record=nil)
+    # Tests whether or not the value should be nilified.
+    #
+    # This can be changed in the subclasses.
+    def nilify_value?(value, _record = nil)
       value == ""
     end
 
+    # Test whether or not two cleaners are equal.
     def ==(other)
       kind == other.kind && attr_name == other.attr_name && options == other.options
     end

data/lib/active_cleaner/helper_methods.rb

@@ -1,8 +1,27 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module ActiveCleaner
+  # Defines the DSL methods available in your model.
   module HelperMethods
 
+    # Registers a cleaner to a bunch of fields by its name.
+    #
+    # === Options
+    #
+    # [:as]
+    #   the kind of the cleaner. Default to +:string+
+    #
+    # Extra options are passed to the cleaner.
+    #
+    # === Example
+    #
+    #   class MyModel
+    #     include ActiveCleaner
+    #
+    #     clean :name, nilify: false
+    #     clean :firstname, :lastname, nilify: false
+    #     clean :resume, as: :markdown
+    #   end
     def clean(*attr_names)
       options = attr_names.extract_options!.symbolize_keys
       attr_names.flatten!
@@ -16,8 +35,15 @@ module ActiveCleaner
       end
     end
 
+    # Registers a cleaner by an instance of it.
+    #
+    #   class MyModel
+    #     include ActiveCleaner
+    #
+    #     clean_with ActiveCleaner::StringCleaner.new(:name, nilify: false)
+    #   end
     def clean_with(cleaner)
-      self._cleaners[cleaner.attr_name] << cleaner
+      _cleaners[cleaner.attr_name] << cleaner
     end
 
   end

data/lib/active_cleaner/markdown_cleaner.rb

@@ -1,9 +1,37 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module ActiveCleaner
+  # = MarkdownCleaner
+  #
+  # Cleans a string by squishing all the extra space characters, but preserves new lines
+  # (with a max of 2 successive new lines) and spaces in the beginning of lines (the indentation).
+  #
+  # Useful for Markdown.
+  #
+  # It turns <tt>"   My todo \n * todo 1 \n * todo 2   \t  "</tt> into <tt>"My todo\n * todo 1\n * todo 2"</tt>.
+  #
+  # == Options
+  #
+  # [:nilify]
+  #   Whether or not set the field to +nil+ when the field was or is cleaned to <tt>""</tt>.
+  #   Default to +false+.
+  #
+  # == Example
+  #
+  #   class Article
+  #     include ActiveCleaner
+  #
+  #     clean :body, as: :markdown
+  #   end
+  #
+  #   article = Article.new(body: "   My todo \n * todo 1 \n * todo 2   \t  ")
+  #   article.save
+  #   article.body
+  #   # => "My todo\n * todo 1\n * todo 2"
   class MarkdownCleaner < BaseCleaner
 
-    def clean_value(old_value, record=nil)
+    # Cleans the value.
+    def clean_value(old_value, _record = nil)
       case old_value
       when String
         value = old_value.dup
@@ -15,7 +43,7 @@ module ActiveCleaner
 
         # protect stuff to keep with a markup
         value.gsub!(/\n/, "__NEW_LINE__")
-        value.gsub!(/(?<=__NEW_LINE__)\s+/) {|match| match.gsub(/\s/, "__SPACE__")}
+        value.gsub!(/(?<=__NEW_LINE__)\s+/) { |match| match.gsub(/\s/, "__SPACE__") }
 
         value.gsub!(/\s+/, " ")
         value.gsub!(/(__SPACE__|\s)*__NEW_LINE__\s*/, "__NEW_LINE__")

data/lib/active_cleaner/string_cleaner.rb

@@ -1,9 +1,34 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module ActiveCleaner
+  # = StringCleaner
+  #
+  # Cleans a string by squishing all the extra space characters.
+  #
+  # It turns <tt>"   A  \n  \t title   \t  "</tt> into <tt>"A title"</tt>.
+  #
+  # == Options
+  #
+  # [:nilify]
+  #   Whether or not set the field to +nil+ when the field was or is cleaned to <tt>""</tt>.
+  #   Default to +false+.
+  #
+  # == Example
+  #
+  #   class Article
+  #     include ActiveCleaner
+  #
+  #     clean :title, as: :string
+  #   end
+  #
+  #   article = Article.new(title: "   My  \n  \t Title   \t  ")
+  #   article.save
+  #   article.title
+  #   # => "My Title"
   class StringCleaner < BaseCleaner
 
-    def clean_value(old_value, record=nil)
+    # Cleans the value.
+    def clean_value(old_value, _record = nil)
       case old_value
       when String
         value = old_value.dup

data/lib/active_cleaner/text_cleaner.rb

@@ -1,9 +1,37 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module ActiveCleaner
+  # = TextCleaner
+  #
+  # Cleans a string by squishing all the extra space characters, but preserves new lines
+  # (with a max of 2 successive new lines).
+  #
+  # Useful when the field is rendered with the +simple_format+ Rails helper.
+  #
+  # It turns <tt>"   My first line \n My second line   \t  "</tt> into <tt>"My first line\nMy second line"</tt>.
+  #
+  # == Options
+  #
+  # [:nilify]
+  #   Whether or not set the field to +nil+ when the field was or is cleaned to <tt>""</tt>.
+  #   Default to +false+.
+  #
+  # == Example
+  #
+  #   class Article
+  #     include ActiveCleaner
+  #
+  #     clean :body, as: :text
+  #   end
+  #
+  #   article = Article.new(body: "   My first paragraph \n   \n  \t \n My second paragraph,  \n longer.  \t  ")
+  #   article.save
+  #   article.body
+  #   # => "My first paragraph\n\nMy second paragraph,\nlonger."
   class TextCleaner < BaseCleaner
 
-    def clean_value(old_value, record=nil)
+    # Cleans the value.
+    def clean_value(old_value, _record = nil)
       case old_value
       when String
         value = old_value.dup

data/lib/active_cleaner/utf8mb3_cleaner.rb

@@ -1,12 +1,41 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module ActiveCleaner
+  # = Utf8mb3Cleaner
+  #
+  # Cleans a string by removes all 4-bytes encoded chars in UTF8 strings that mess with
+  # the +utf8mb3+ (also simply known as +utf8+) encoding in MySQL.
+  #
+  # Useful for user input that may contain iOS6 emojis for example (as they are only compatible
+  # with +utf8mb4+ and cause string truncation, at best).
+  #
+  # It turns <tt>"String with emoticon 😀"</tt> into <tt>"String with emoticon"</tt>.
+  #
+  # == Options
+  #
+  # [:nilify]
+  #   Whether or not set the field to +nil+ when the field was or is cleaned to <tt>""</tt>.
+  #   Default to +false+.
+  #
+  # == Example
+  #
+  #   class Comment
+  #     include ActiveCleaner
+  #
+  #     clean :body, as: :utf8mb3
+  #   end
+  #
+  #   comment = Comment.new(body: "Nice! 😀")
+  #   comment.save
+  #   comment.body
+  #   # => "Nice!"
   class Utf8mb3Cleaner < BaseCleaner
 
-    def clean_value(old_value, record=nil)
+    # Cleans the value.
+    def clean_value(old_value, _record = nil)
       case old_value
       when String
-        old_value.each_char.select { |char| char.bytesize < 4 }.join('')
+        old_value.each_char.select { |char| char.bytesize < 4 }.join
       else
         old_value
       end

data/lib/active_cleaner/version.rb

@@ -1,8 +1,11 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 module ActiveCleaner
+  # Contains the version of the gem.
   module Version
 
-    STRING = '0.3.1'
+    # The version as string.
+    STRING = "0.3.2".freeze
 
   end
 end

data/lib/activecleaner.rb

@@ -1,3 +1,3 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
-require 'active_cleaner'
+require "active_cleaner"

data/spec/cases/inherit_spec.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 require "spec_helper"
 
 #
@@ -8,28 +9,30 @@ require "spec_helper"
 # in a common STI scenario.
 #
 class Ad
+
   include ActiveCleaner
 
   attr_accessor :title, :name
 
   clean :title
   clean :name, as: :string
+
 end
 
 class CarAd < Ad
+
   attr_accessor :body, :user_generated_content
 
   clean :body, as: :text
   clean :user_generated_content, as: :utf8mb3
+
 end
 
 #
 # The specs
 #
 describe "Case: an ad and his inherited car ad" do
-
   describe Ad, "._cleaners" do
-
     subject { Ad._cleaners }
 
     it "has 2 cleaners" do
@@ -43,11 +46,9 @@ describe "Case: an ad and his inherited car ad" do
     it "includes a StringCleaner for #name" do
       expect(subject[:name].first).to eq(ActiveCleaner::StringCleaner.new(:name))
     end
-
-  end # describe
+  end
 
   describe CarAd, "._cleaners" do
-
     subject { CarAd._cleaners }
 
     it "has 4 cleaners" do
@@ -67,17 +68,15 @@ describe "Case: an ad and his inherited car ad" do
     end
 
     it "includes a Utf8mb3Cleaner for #user_generated_content" do
-      expect(subject[:user_generated_content].first).to eq(ActiveCleaner::Utf8mb3Cleaner.new(:user_generated_content))
+      expect(subject[:user_generated_content].first)
+        .to eq(ActiveCleaner::Utf8mb3Cleaner.new(:user_generated_content))
     end
-
-  end # describe
+  end
 
   context "considering a car ad" do
-
     let(:subject) { CarAd.new }
 
     describe "#title, marked as to clean with no type" do
-
       it "is untouched when legit" do
         subject.title = "A good title!"
         subject.valid?
@@ -89,11 +88,9 @@ describe "Case: an ad and his inherited car ad" do
         subject.valid?
         expect(subject.title).to eq("A good title!")
       end
-
-    end # describe
+    end
 
     describe "#name, marked as to clean as a string" do
-
       it "is untouched when legit" do
         subject.name = "John Doe"
         subject.valid?
@@ -105,11 +102,9 @@ describe "Case: an ad and his inherited car ad" do
         subject.valid?
         expect(subject.name).to eq("John Doe")
       end
-
-    end # describe
+    end
 
     describe "#body, marked as to clean as a text" do
-
       it "is untouched when legit" do
         subject.body = "Lorem ipsum\ndolor sit amet.\n\nLorem."
         subject.valid?
@@ -121,11 +116,9 @@ describe "Case: an ad and his inherited car ad" do
         subject.valid?
         expect(subject.body).to eq("Lorem ipsum\ndolor sit amet.\n\nLorem.")
       end
-
-    end # describe
+    end
 
     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?
@@ -137,9 +130,6 @@ describe "Case: an ad and his inherited car ad" do
         subject.valid?
         expect(subject.user_generated_content).to eq("A good  user generated content!")
       end
-
-    end # describe
-
-  end # context
-
-end # describe
+    end
+  end
+end

data/spec/cases/nilify_spec.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 require "spec_helper"
 
 #
@@ -7,6 +8,7 @@ require "spec_helper"
 # This is to demonstrate when we want to clean some simple fields and nulify them
 #
 class OptimizedPost
+
   include ActiveCleaner
 
   attr_accessor :title, :name, :body, :user_generated_content
@@ -15,16 +17,14 @@ class OptimizedPost
   clean :name, as: :string, nilify: true
   clean :body, as: :text, nilify: true
   clean :user_generated_content, as: :utf8mb3, nilify: true
-end
 
+end
 
 #
 # The specs
 #
 describe "Case: a simple post with nulify" do
-
   describe OptimizedPost, "._cleaners" do
-
     subject { OptimizedPost._cleaners }
 
     it "has 4 cleaners" do
@@ -44,17 +44,15 @@ describe "Case: a simple post with nulify" do
     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))
+      expect(subject[:user_generated_content].first)
+        .to eq(ActiveCleaner::Utf8mb3Cleaner.new(:user_generated_content, nilify: true))
     end
-
-  end # describe
+  end
 
   context "considering a post" do
-
     let(:subject) { OptimizedPost.new }
 
     describe "#title, marked as to clean with no type" do
-
       it "is untouched when legit" do
         subject.title = "A good title!"
         subject.valid?
@@ -66,11 +64,9 @@ describe "Case: a simple post with nulify" do
         subject.valid?
         expect(subject.title).to be_nil
       end
-
-    end # describe
+    end
 
     describe "#name, marked as to clean as a string" do
-
       it "is untouched when legit" do
         subject.name = "John Doe"
         subject.valid?
@@ -82,11 +78,9 @@ describe "Case: a simple post with nulify" do
         subject.valid?
         expect(subject.title).to be_nil
       end
-
-    end # describe
+    end
 
     describe "#body, marked as to clean as a text" do
-
       it "is untouched when legit" do
         subject.body = "Lorem ipsum\ndolor sit amet.\n\nLorem."
         subject.valid?
@@ -98,11 +92,9 @@ describe "Case: a simple post with nulify" do
         subject.valid?
         expect(subject.title).to be_nil
       end
-
-    end # describe
+    end
 
     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?
@@ -114,9 +106,6 @@ describe "Case: a simple post with nulify" do
         subject.valid?
         expect(subject.user_generated_content).to be_nil
       end
-
-    end # describe
-
-  end # context
-
-end # describe
+    end
+  end
+end

data/spec/cases/simple_spec.rb

@@ -1,4 +1,5 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
 require "spec_helper"
 
 #
@@ -7,6 +8,7 @@ require "spec_helper"
 # This is to demonstrate when we want to clean some simple fields
 #
 class Post
+
   include ActiveCleaner
 
   attr_accessor :title, :name, :body, :user_generated_content
@@ -15,16 +17,14 @@ class Post
   clean :name, as: :string
   clean :body, as: :text
   clean :user_generated_content, as: :utf8mb3
-end
 
+end
 
 #
 # The specs
 #
 describe "Case: a simple post" do
-
   describe Post, "._cleaners" do
-
     subject { Post._cleaners }
 
     it "has 4 cleaners" do
@@ -44,17 +44,15 @@ describe "Case: a simple post" do
     end
 
     it "includes a Utf8mb3Cleaner for #user_generated_content" do
-      expect(subject[:user_generated_content].first).to eq(ActiveCleaner::Utf8mb3Cleaner.new(:user_generated_content))
+      expect(subject[:user_generated_content].first)
+        .to eq(ActiveCleaner::Utf8mb3Cleaner.new(:user_generated_content))
     end
-
-  end # describe
+  end
 
   context "considering a post" do
-
     let(:subject) { Post.new }
 
     describe "#title, marked as to clean with no type" do
-
       it "is untouched when legit" do
         subject.title = "A good title!"
         subject.valid?
@@ -66,11 +64,9 @@ describe "Case: a simple post" do
         subject.valid?
         expect(subject.title).to eq("A good title!")
       end
-
-    end # describe
+    end
 
     describe "#name, marked as to clean as a string" do
-
       it "is untouched when legit" do
         subject.name = "John Doe"
         subject.valid?
@@ -82,11 +78,9 @@ describe "Case: a simple post" do
         subject.valid?
         expect(subject.name).to eq("John Doe")
       end
-
-    end # describe
+    end
 
     describe "#body, marked as to clean as a text" do
-
       it "is untouched when legit" do
         subject.body = "Lorem ipsum\ndolor sit amet.\n\nLorem."
         subject.valid?
@@ -98,11 +92,9 @@ describe "Case: a simple post" do
         subject.valid?
         expect(subject.body).to eq("Lorem ipsum\ndolor sit amet.\n\nLorem.")
       end
-
-    end # describe
+    end
 
     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?
@@ -114,9 +106,6 @@ describe "Case: a simple post" do
         subject.valid?
         expect(subject.user_generated_content).to eq("A good  user generated content!")
       end
-
-    end # describe
-
-  end # context
-
-end # describe
+    end
+  end
+end

data/spec/lib/active_cleaner/markdown_cleaner_spec.rb

@@ -1,12 +1,11 @@
-# encoding: utf-8
-require 'spec_helper'
+# frozen_string_literal: true
 
-describe ActiveCleaner::MarkdownCleaner do
+require "spec_helper"
 
+describe ActiveCleaner::MarkdownCleaner do
   let(:cleaner) { ActiveCleaner::MarkdownCleaner.new(:body) }
 
   describe "#clean_value" do
-
     it "doesn't touch non string value" do
       expect(cleaner.clean_value(nil)).to eq(nil)
       expect(cleaner.clean_value(true)).to eq(true)
@@ -14,8 +13,15 @@ describe ActiveCleaner::MarkdownCleaner do
       expect(cleaner.clean_value(10)).to eq(10)
     end
 
+    it "doesn't modify input string" do
+      input = "Lorem    ipsum"
+      expect {
+        cleaner.clean_value(input)
+      }.not_to change { input }
+    end
+
     it "doesn't touch legit value" do
-      body = ""
+      body = String.new
       body << "= Title =\n"
       body << "\n"
       body << "A first paragraph.\n"
@@ -48,25 +54,37 @@ describe ActiveCleaner::MarkdownCleaner do
     end
 
     it "cleans repeted spaces" do
-      expect(cleaner.clean_value("Lorem   ipsum   \ndolor   sit   amet.")).to eq("Lorem ipsum\ndolor sit amet.")
-      expect(cleaner.clean_value("Lorem \t ipsum \t \ndolor \t sit \t amet.")).to eq("Lorem ipsum\ndolor sit amet.")
+      expect(cleaner.clean_value("Lorem   ipsum   \ndolor   sit   amet."))
+        .to eq("Lorem ipsum\ndolor sit amet.")
+      expect(cleaner.clean_value("Lorem \t ipsum \t \ndolor \t sit \t amet."))
+        .to eq("Lorem ipsum\ndolor sit amet.")
+    end
+
+    it "cleans \\r" do
+      expect(cleaner.clean_value("Lorem ipsum\rdolor sit amet."))
+        .to eq("Lorem ipsum\ndolor sit amet.")
+      expect(cleaner.clean_value("Lorem ipsum\r\ndolor sit amet."))
+        .to eq("Lorem ipsum\ndolor sit amet.")
     end
 
     context "considering the spaces in the beggining of lines" do
       it "preserves them" do
-        expect(cleaner.clean_value("Lorem ipsum\n   dolor sit amet.")).to eq("Lorem ipsum\n   dolor sit amet.")
+        expect(cleaner.clean_value("Lorem ipsum\n   dolor sit amet."))
+          .to eq("Lorem ipsum\n   dolor sit amet.")
       end
       it "clears line full of spaces" do
-        expect(cleaner.clean_value("Lorem ipsum   \n   \n   dolor sit amet.")).to eq("Lorem ipsum\n\n   dolor sit amet.")
+        expect(cleaner.clean_value("Lorem ipsum   \n   \n   dolor sit amet."))
+          .to eq("Lorem ipsum\n\n   dolor sit amet.")
       end
     end
 
     it "keeps two max succeeding new line" do
-      expect(cleaner.clean_value("Lorem ipsum\n\n\ndolor sit amet.")).to eq("Lorem ipsum\n\ndolor sit amet.")
-      expect(cleaner.clean_value("Lorem ipsum\n\n\n\ndolor sit amet.")).to eq("Lorem ipsum\n\ndolor sit amet.")
-      expect(cleaner.clean_value("Lorem ipsum\n  \n  \n  \ndolor sit amet.")).to eq("Lorem ipsum\n\ndolor sit amet.")
+      expect(cleaner.clean_value("Lorem ipsum\n\n\ndolor sit amet."))
+        .to eq("Lorem ipsum\n\ndolor sit amet.")
+      expect(cleaner.clean_value("Lorem ipsum\n\n\n\ndolor sit amet."))
+        .to eq("Lorem ipsum\n\ndolor sit amet.")
+      expect(cleaner.clean_value("Lorem ipsum\n  \n  \n  \ndolor sit amet."))
+        .to eq("Lorem ipsum\n\ndolor sit amet.")
     end
-
   end
-
 end

data/spec/lib/active_cleaner/string_cleaner_spec.rb

@@ -1,12 +1,11 @@
-# encoding: utf-8
-require 'spec_helper'
+# frozen_string_literal: true
 
-describe ActiveCleaner::StringCleaner do
+require "spec_helper"
 
+describe ActiveCleaner::StringCleaner do
   let(:cleaner) { ActiveCleaner::StringCleaner.new(:title) }
 
   describe "#clean_value" do
-
     it "doesn't touch non string value" do
       expect(cleaner.clean_value(nil)).to eq(nil)
       expect(cleaner.clean_value(true)).to eq(true)
@@ -14,6 +13,13 @@ describe ActiveCleaner::StringCleaner do
       expect(cleaner.clean_value(10)).to eq(10)
     end
 
+    it "doesn't modify input string" do
+      input = "Lorem    ipsum"
+      expect {
+        cleaner.clean_value(input)
+      }.not_to change { input }
+    end
+
     it "doesn't touch legit value" do
       expect(cleaner.clean_value("A good title!")).to eq("A good title!")
     end
@@ -33,9 +39,11 @@ describe ActiveCleaner::StringCleaner do
     it "cleans leading and trailing spaces" do
       expect(cleaner.clean_value("  A good title!  ")).to eq("A good title!")
     end
+
     it "cleans leading and trailing tabs" do
       expect(cleaner.clean_value("\tA good title!\t")).to eq("A good title!")
     end
+
     it "cleans leading and trailing lines" do
       expect(cleaner.clean_value("\nA good title!\n")).to eq("A good title!")
     end
@@ -44,7 +52,5 @@ describe ActiveCleaner::StringCleaner do
       expect(cleaner.clean_value("A    good    title!")).to eq("A good title!")
       expect(cleaner.clean_value("A  \n good  \t title!")).to eq("A good title!")
     end
-
   end
-
 end

data/spec/lib/active_cleaner/text_cleaner_spec.rb

@@ -1,12 +1,11 @@
-# encoding: utf-8
-require 'spec_helper'
+# frozen_string_literal: true
 
-describe ActiveCleaner::TextCleaner do
+require "spec_helper"
 
+describe ActiveCleaner::TextCleaner do
   let(:cleaner) { ActiveCleaner::TextCleaner.new(:text) }
 
   describe "#clean_value" do
-
     it "doesn't touch non string value" do
       expect(cleaner.clean_value(nil)).to eq(nil)
       expect(cleaner.clean_value(true)).to eq(true)
@@ -14,6 +13,13 @@ describe ActiveCleaner::TextCleaner do
       expect(cleaner.clean_value(10)).to eq(10)
     end
 
+    it "doesn't modify input string" do
+      input = "Lorem    ipsum"
+      expect {
+        cleaner.clean_value(input)
+      }.not_to change { input }
+    end
+
     it "doesn't touch legit value" do
       [
         "Lorem ipsum dolor sit amet.",
@@ -37,25 +43,39 @@ describe ActiveCleaner::TextCleaner do
     end
 
     it "cleans leading and trailing spaces" do
-      expect(cleaner.clean_value(" Lorem ipsum\ndolor sit amet. ")).to eq("Lorem ipsum\ndolor sit amet.")
+      expect(cleaner.clean_value(" Lorem ipsum\ndolor sit amet. "))
+        .to eq("Lorem ipsum\ndolor sit amet.")
     end
+
     it "cleans leading and trailing tabs" do
-      expect(cleaner.clean_value("\tLorem ipsum\ndolor sit amet.\t")).to eq("Lorem ipsum\ndolor sit amet.")
+      expect(cleaner.clean_value("\tLorem ipsum\ndolor sit amet.\t"))
+        .to eq("Lorem ipsum\ndolor sit amet.")
     end
+
     it "cleans leading and trailing lines" do
-      expect(cleaner.clean_value("\nLorem ipsum\ndolor sit amet.\n")).to eq("Lorem ipsum\ndolor sit amet.")
+      expect(cleaner.clean_value("\nLorem ipsum\ndolor sit amet.\n"))
+        .to eq("Lorem ipsum\ndolor sit amet.")
     end
 
     it "cleans repeted spaces" do
-      expect(cleaner.clean_value("Lorem   ipsum   \n   dolor   sit   amet.")).to eq("Lorem ipsum\ndolor sit amet.")
-      expect(cleaner.clean_value("Lorem \t ipsum \t \n   dolor \t sit \t amet.")).to eq("Lorem ipsum\ndolor sit amet.")
+      expect(cleaner.clean_value("Lorem   ipsum   \n   dolor   sit   amet."))
+        .to eq("Lorem ipsum\ndolor sit amet.")
+      expect(cleaner.clean_value("Lorem \t ipsum \t \n   dolor \t sit \t amet."))
+        .to eq("Lorem ipsum\ndolor sit amet.")
     end
 
-    it "keeps two max succeeding new line" do
-      expect(cleaner.clean_value("Lorem ipsum\n\n\ndolor sit amet.")).to eq("Lorem ipsum\n\ndolor sit amet.")
-      expect(cleaner.clean_value("Lorem ipsum\n\n\n\ndolor sit amet.")).to eq("Lorem ipsum\n\ndolor sit amet.")
+    it "cleans \\r" do
+      expect(cleaner.clean_value("Lorem ipsum\rdolor sit amet."))
+        .to eq("Lorem ipsum\ndolor sit amet.")
+      expect(cleaner.clean_value("Lorem ipsum\r\ndolor sit amet."))
+        .to eq("Lorem ipsum\ndolor sit amet.")
     end
 
+    it "keeps two max succeeding new line" do
+      expect(cleaner.clean_value("Lorem ipsum\n\n\ndolor sit amet."))
+        .to eq("Lorem ipsum\n\ndolor sit amet.")
+      expect(cleaner.clean_value("Lorem ipsum\n\n\n\ndolor sit amet."))
+        .to eq("Lorem ipsum\n\ndolor sit amet.")
+    end
   end
-
 end

data/spec/lib/active_cleaner/utf8mb4_cleaner_spec.rb

@@ -1,12 +1,11 @@
-# encoding: utf-8
-require 'spec_helper'
+# frozen_string_literal: true
 
-describe ActiveCleaner::Utf8mb3Cleaner do
+require "spec_helper"
 
+describe ActiveCleaner::Utf8mb3Cleaner do
   let(:cleaner) { ActiveCleaner::Utf8mb3Cleaner.new(:title) }
 
   describe "#clean_value" do
-
     it "doesn't touch non string value" do
       expect(cleaner.clean_value(nil)).to eq(nil)
       expect(cleaner.clean_value(true)).to eq(true)
@@ -14,6 +13,13 @@ describe ActiveCleaner::Utf8mb3Cleaner do
       expect(cleaner.clean_value(10)).to eq(10)
     end
 
+    it "doesn't modify input string" do
+      input = "Lorem 😁 ipsum"
+      expect {
+        cleaner.clean_value(input)
+      }.not_to change { input }
+    end
+
     it "doesn't touch legit value" do
       expect(cleaner.clean_value("A good title!")).to eq("A good title!")
     end
@@ -30,7 +36,5 @@ describe ActiveCleaner::Utf8mb3Cleaner do
     it "kepts japanese chars" do
       expect(cleaner.clean_value("ginkō is written as 銀行")).to eq("ginkō is written as 銀行")
     end
-
   end
-
 end

data/spec/lib/active_cleaner_spec.rb

@@ -1,4 +1,3 @@
-# encoding: utf-8
-
-require 'spec_helper'
+# frozen_string_literal: true
 
+require "spec_helper"

data/spec/spec_helper.rb

@@ -1,9 +1,8 @@
-# encoding: utf-8
-require 'rubygems'
-require 'rspec'
-require 'active_cleaner'
+# frozen_string_literal: true
 
+require "rubygems"
+require "rspec"
+require "active_cleaner"
 
-RSpec.configure do |config|
-
+RSpec.configure do |_config|
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: activecleaner
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Maxime Garcia
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-22 00:00:00.000000000 Z
+date: 2017-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -16,64 +16,72 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '4.2'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
-    - - ">="
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
       - !ruby/object:Gem::Version
-        version: 3.0.0
-description: |2
-      ActiveCleaner is a set of helpers that helps you in cleaning user-typed content in your ActiveModel depending models (ActiveRecord, Mongoid...)
+        version: 0.52.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.52.0
+description: "    ActiveCleaner is a set of helpers that helps you in cleaning user-typed
+  content in your ActiveModel depending models (ActiveRecord, Mongoid...)\n"
 email:
-- maxime.garcia@free.fr
+- maxime.garcia@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -110,25 +118,25 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '1.9'
+      version: 2.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.6
+      version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.1
+rubygems_version: 2.7.4
 signing_key: 
 specification_version: 4
 summary: Clean the fields in your models
 test_files:
-- spec/lib/active_cleaner/utf8mb4_cleaner_spec.rb
-- spec/lib/active_cleaner/string_cleaner_spec.rb
-- spec/lib/active_cleaner/text_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
+- spec/cases/inherit_spec.rb
+- spec/lib/active_cleaner_spec.rb
+- spec/lib/active_cleaner/string_cleaner_spec.rb
+- spec/lib/active_cleaner/markdown_cleaner_spec.rb
+- spec/lib/active_cleaner/text_cleaner_spec.rb
+- spec/lib/active_cleaner/utf8mb4_cleaner_spec.rb