normalizy 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 76436253c67c497cba120a39bd71667b34cad65f
-  data.tar.gz: c5bb1d390b33e655ea7e5e9c865cf4bf8d903fc6
+  metadata.gz: d91babea23ed3c9c18a9aa9629da1139d1f12c55
+  data.tar.gz: 7ab05fe0149743bf72ea4c50b8095e029a11158d
 SHA512:
-  metadata.gz: 488852bd2f5c2ce038533f7dcd984b537b5e27cd185cccafa560553cf7f50a13d8a7bac0e15670c6647fff376957b91a53463b966713f887ed5e566f68d32415
-  data.tar.gz: 7205c44545020100f4663e2ca7e9d9af224dfda0e3bb6645acee7defb8798c76bec57582678a25670a5f4c07d2f6d07fed151d089e81f72e154ca6fd20afb806
+  metadata.gz: cb83724af9af4b195de644457cf7928ea71b218a77ed15d2ae5f822fffa5065531f8cb5a6d65b28a38048d1d238a43bd89894639634729c2dbff19d01f9c93a7
+  data.tar.gz: 5852ecb8103d2fa5849a61919216c297a493d500d7f41d00059c20abb62996c8c398788ccf1ce637af299b0878775846a970e346471a4c04adcf6b215ed104c4

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## v1.0.0
+
+- Changes:
+  - `raw` options was dropped since `prepend` already works before type cast;
+  - Multiple lines of `normalizy` will be evaluated from the bottom to top.
+
+- Features:
+  - `alias` configuration now accepts options;
+
+- Fixes:
+  - Multiple filters were not running together.
+
 ## v0.2.0
 
 - Changes:

data/README.md

@@ -2,6 +2,7 @@
 
 [![Build Status](https://travis-ci.org/wbotelhos/normalizy.svg)](https://travis-ci.org/wbotelhos/normalizy)
 [![Gem Version](https://badge.fury.io/rb/normalizy.svg)](https://badge.fury.io/rb/normalizy)
+[![Gratipay](https://img.shields.io/gratipay/user/wbotelhos.svg)](https://gratipay.com/normalizy)
 
 Attribute normalizer for ActiveRecord.
 
@@ -112,8 +113,6 @@ Tue, 23 Oct 1984 00:00:00 EDT -04:00
 # Tue, 23 Oct 1984 11:59:59 EDT -04:00
 ```
 
-By default, `number` works with value before [Type Cast](#type-cast).
-
 ### Money
 
 Transform a value to money format.
@@ -219,8 +218,6 @@ normalizy :amount, with: money: { cast: :to_f, type: :cents }
 # 4200.0
 ```
 
-By default, `money` works with value before [Type Cast](#type-cast).
-
 ### Number
 
 ```ruby
@@ -239,8 +236,6 @@ normalizy :age, with: number: { cast: :to_i }
 # 32
 ```
 
-By default, `number` works with value before [Type Cast](#type-cast).
-
 ### Percent
 
 Transform a value to percent format.
@@ -346,8 +341,6 @@ normalizy :amount, with: percent: { cast: :to_f, type: :integer }
 # 4200.0
 ```
 
-By default, `percent` works with value before [Type Cast](#type-cast).
-
 ### Strip
 
 Options:
@@ -392,25 +385,32 @@ normalizy :name, with: %i[squish titleize]
 
 ## Multiple Attributes
 
-You can normalize more than one attribute at once too, with one or muiltiple filters:
+You can normalize more than one attribute at once too, with one or multiple filters:
 
 ```ruby
 normalizy :email, :username, with: :downcase
 ```
 
-Of course you can declare muiltiples attribute and multiple filters, either.
-It is possible to make sequential normalizy calls:
+Of course you can declare multiple attribute and multiple filters, either.
+It is possible to make sequential normalizy calls, but *take care*!
+Since we use `prepend` module the last line will run first then others:
 
 ```ruby
-normalizy :email, :username, with: :squish
-normalizy :email           , with: :downcase
+normalizy :username, with: :downcase
+normalizy :username, with: :titleize
+
+'BoteLho'
+# 'bote lho'
 ```
 
-In this case, each line will be evaluated from the top to the bottom.
+As you can see, `titleize` runs first then `downcase`.
+Each line will be evaluated from the *bottom* to the *top*.
+If it is hard to you accept, use [Muiltiple Filters](#multiple-filters)
 
 ## Default Filters
 
-You can configure some default filters to be runned. Edit initializer at `config/initializers/normalizy.rb`:
+You can configure some default filters to be runned.
+Edit initializer at `config/initializers/normalizy.rb`:
 
 ```ruby
 Normalizy.configure do |config|
@@ -418,7 +418,7 @@ Normalizy.configure do |config|
 end
 ```
 
-Now, all normalization will include squish, even when no rule is declared.
+Now, all normalization will include `squish`, even when no rule is declared.
 
 ```ruby
 normalizy :name
@@ -580,37 +580,6 @@ Normalizy.configure do |config|
 end
 ```
 
-## Type Cast
-
-An input field with `= 42` value when sent to model with a field as `integer` type,
-will be converted to `0`, since the type does not match. But you want to use the value before Rails cast the type.
-
-To receive the value before type cast, just pass a `raw` options as `true`:
-
-```ruby
-normalizy :amount, with: :number, raw: true
-
-'= 42'
-# 42
-```
-
-To avoid repeat the `raw: true` when you have multiple uses, you can register a filter:
-
-```ruby
-Normalizy.configure do |config|
-  config.add :raw_number, ->(input) { input.gsub(/\D/, '') }, raw: true
-end
-```
-
-And use it in short version:
-
-```ruby
-normalizy :amount, with: :raw_number
-
-'= 42'
-# 42
-```
-
 ## Alias
 
 Sometimes you want to give a better name to your filter, just to keep the things semantic.
@@ -623,13 +592,6 @@ end
 ```
 
 Now, `age` will delegate to `number` filter.
-Since we already know the need of `raw` options, we can declare it here:
-
-```ruby
-Normalizy.configure do |config|
-  config.alias :age, :number, raw: true
-end
-```
 
 And now, the aliased filter will work fine:
 
@@ -648,6 +610,14 @@ Normalizy.configure do |config|
 end
 ```
 
+Alias accepts options parameters too:
+
+```ruby
+Normalizy.configure do |config|
+  config.alias :left_trim, trim: { side: :left }
+end
+```
+
 ## RSpec
 
 If you use [RSpec](http://rspec.info), we did built-in matchers for you.
@@ -685,4 +655,4 @@ it { is_expected.to normalizy(:email).with(trim: { side: :left }) }
 
 ## Love it!
 
-Via [PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=X8HEP2878NDEG&item_name=normalizy) or [Gratipay](https://gratipay.com/~wbotelhos). Thanks! (:
+Via [PayPal](https://www.paypal.com/cgi-bin/webscr?cmd=_donations&business=X8HEP2878NDEG&item_name=normalizy) or [Gratipay](https://gratipay.com/normalizy). Thanks! (:

data/lib/normalizy/config.rb

@@ -5,19 +5,16 @@ require 'normalizy/filters'
 module Normalizy
   class Config
     attr_accessor :default_filters
-    attr_reader :filters, :normalizy_aliases, :normalizy_raws
+    attr_reader :filters, :normalizy_aliases
 
-    def add(name, value, raw: false)
+    def add(name, value)
       @filters[name] = value
 
-      @normalizy_raws << name if raw
-
       self
     end
 
-    def alias(name, to, raw: false)
+    def alias(name, to)
       @normalizy_aliases[name] = to
-      @normalizy_raws << name if raw
 
       self
     end
@@ -25,7 +22,6 @@ module Normalizy
     def initialize
       @default_filters   = {}
       @normalizy_aliases = {}
-      @normalizy_raws    = %i[date money number percent]
 
       @filters = {
         date:    Normalizy::Filters::Date,

data/lib/normalizy/extensions.rb

@@ -5,27 +5,25 @@ module Normalizy
     extend ActiveSupport::Concern
 
     included do
-      before_validation :apply_normalizy, if: -> {
-        self.class.respond_to? :normalizy
-      }
-
       private
 
-      def apply_normalizy
-        (self.class.normalizy_rules || {}).each do |attribute, rules|
-          rules.each { |rule| normalizy! rule.merge(attribute: attribute) }
-        end
+      def extract_filter(rule, rule_options, attribute, filters: Normalizy.config.filters)
+        options = rule_options.merge(attribute: attribute, object: self)
+
+        return [filters[rule] || rule, options] unless rule.is_a?(Hash)
+
+        filter  = filters[rule.keys.first] || rule
+        options = (rule.values.first || {}).merge(options)
+
+        [filter, options]
       end
 
-      def extract_filter(rule, filters: Normalizy.config.filters)
+      def extract_rule(rule)
         if rule.is_a?(Hash)
-          result  = filters[rule.keys.first] || rule.keys.first
-          options = rule.values.first
+          [rule.keys.first, rule.values.first]
         else
-          result = filters[rule]
+          [rule, {}]
         end
-
-        [result || rule, options || {}]
       end
 
       def extract_value(value, filter, options, block)
@@ -36,7 +34,11 @@ module Normalizy
             filter.call value, &block
           end
         elsif respond_to?(filter)
-          send filter, value, options, &block
+          if method(filter).arity == -2
+            send filter, value, options, &block
+          else
+            send filter, value, &block
+          end
         elsif value.respond_to?(filter)
           value.send filter, &block
         else
@@ -44,49 +46,27 @@ module Normalizy
         end
       end
 
-      def normalizy!(attribute:, rules:, options:, block:)
+      def normalizy!(attribute:, block:, options:, rules:, value:)
+        rules ||= Normalizy.config.default_filters
+
         return if rules.blank? && block.blank?
 
-        aliases = Normalizy.config.normalizy_aliases
-        value   = nil
+        result = value
 
         [rules].flatten.compact.each do |rule|
-          result_rules = [aliases.key?(rule) ? aliases[rule] : rule]
-
-          result_rules.flatten.compact.each do |result_rule|
-            filter, filter_options = extract_filter(result_rule)
-
-            if filter.respond_to?(:name)
-              rule_name = filter.name.tableize.split('/').last.singularize.to_sym
-            end
+          rule_name, rule_options = extract_rule(rule)
 
-            original     = original_value(attribute, rule_name, options)
-            full_options = filter_options.merge(attribute: attribute, object: self)
-            value        = extract_value(original, filter, full_options, block)
+          unalias_for(rule_name).each do |rule|
+            filter, filter_options = extract_filter(rule, rule_options, attribute)
+            result                 = extract_value(result, filter, filter_options, block)
           end
         end
 
-        write attribute, value
-      end
-
-      def original_value(attribute, rule, options)
-        if raw? attribute, rule, options
-          send "#{attribute}_before_type_cast"
-        else
-          send attribute
-        end
+        result
       end
 
-      def raw?(attribute, rule, options)
-        return false unless respond_to?("#{attribute}_before_type_cast")
-
-        options[:raw] || Normalizy.config.normalizy_raws.include?(rule)
-      end
-
-      def write(attribute, value)
-        write_attribute attribute, value
-      rescue ActiveModel::MissingAttributeError
-        send "#{attribute}=", value
+      def unalias_for(rule, aliases: Normalizy.config.normalizy_aliases)
+        [aliases.key?(rule) ? aliases[rule] : rule].flatten.compact
       end
     end
 
@@ -95,7 +75,7 @@ module Normalizy
 
       def normalizy(*args, &block)
         options = args.extract_options!
-        rules   = options[:with] || Normalizy.config.default_filters
+        rules   = options[:with]
 
         self.normalizy_rules ||= {}
 
@@ -103,6 +83,22 @@ module Normalizy
           normalizy_rules[field] ||= []
           normalizy_rules[field] << { block: block, options: options.except(:with), rules: rules }
         end
+
+        prepend Module.new {
+          args.each do |attribute|
+            define_method :"#{attribute}=" do |value|
+              result = normalizy!(
+                attribute: attribute,
+                block:     block,
+                options:   options.except(:with),
+                rules:     rules,
+                value:     value
+              )
+
+              super result
+            end
+          end
+        }
       end
     end
   end

data/lib/normalizy/rspec/matcher.rb

@@ -43,6 +43,12 @@ module Normalizy
 
           return false if options.blank?
 
+          if options.map { |option| option[:rules] }.compact.blank?
+            options = default_rules
+          end
+
+          return false if options.blank?
+
           options.each do |option|
             rules = option[:rules]
 
@@ -52,9 +58,9 @@ module Normalizy
 
           false
         else
-          @subject.send "#{@attribute}=", @from
+          @subject.send :"#{@attribute}=", @from
 
-          @subject.send(@attribute) == @to
+          @subject[@attribute] == @to
         end
       end
 
@@ -80,6 +86,12 @@ module Normalizy
         value.is_a?(String) ? %("#{value}") : value
       end
 
+      def default_rules
+        [Normalizy.config.default_filters].flatten.compact.map do |rule|
+          { rules: rule }
+        end
+      end
+
       def from_value
         @from.nil? ? :nil : %("#{@from}")
       end

data/lib/normalizy/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Normalizy
-  VERSION = '0.2.0'
+  VERSION = '1.0.0'.freeze
 end

data/lib/normalizy.rb

@@ -17,4 +17,4 @@ require 'normalizy/config'
 require 'normalizy/extensions'
 require 'normalizy/rspec/matcher'
 
-ActiveRecord::Base.send :include, Normalizy::Extension
+ActiveRecord::Base.include Normalizy::Extension

data/spec/normalizy/config/alias_spec.rb

@@ -3,55 +3,27 @@
 require 'rails_helper'
 
 RSpec.describe Normalizy::Config, '#alias' do
-  context 'with no raw type' do
-    let!(:object) { User.new name: 'Washington Botelho' }
-
-    before do
-      object.class.normalizy_rules = {}
-
-      Normalizy.configure do |config|
-        config.alias :email, :downcase
-      end
+  it 'accepts alias' do
+    Normalizy.configure do |config|
+      config.alias :email, :downcase
     end
 
-    it 'alias one filter to others' do
-      object.class.normalizy :name, with: :email
-
-      object.save
-
-      expect(object.name).to eq 'washington botelho'
-    end
+    expect(Alias.create(email: 'Botelho').email).to eq 'botelho'
   end
 
-  context 'with raw type' do
-    before { User.normalizy_rules = {} }
-
-    context 'configured on setup' do
-      before do
-        Normalizy.configure do |config|
-          config.alias :age, :number, raw: true
-        end
-      end
-
-      it 'alias one filter to others' do
-        User.normalizy :age, with: :age
-
-        expect(User.create(age: '= 42').age).to eq 42
-      end
+  it 'accepts alias with options' do
+    Normalizy.configure do |config|
+      config.alias :with_arg, strip: { side: :left }
     end
 
-    context 'configured on normalizy' do
-      before do
-        Normalizy.configure do |config|
-          config.alias :age, :number
-        end
-      end
-
-      it 'alias one filter to others' do
-        User.normalizy :age, with: :age, raw: true
+    expect(Alias.create(with_arg_field: '  trim').with_arg_field).to eq 'trim'
+  end
 
-        expect(User.create(age: '= 42').age).to eq 42
-      end
+  it 'accepts late options' do
+    Normalizy.configure do |config|
+      config.alias :with_inline_arg, :strip
     end
+
+    expect(Alias.create(with_inline_arg_field: '  trim').with_inline_arg_field).to eq 'trim'
   end
 end

data/spec/normalizy/extensions/filters/date_spec.rb

@@ -2,33 +2,23 @@
 
 require 'rails_helper'
 
-RSpec.describe User, 'filters:date' do
-  before do
-    described_class.normalizy_rules = {}
-  end
-
+RSpec.describe ModelDate, 'filters:date' do
   specify do
-    described_class.normalizy :birthday, with: :date
-
     expected = Time.new(1984, 10, 23, 0, 0, 0, 0)
 
-    expect(described_class.create(birthday: '1984-10-23').birthday).to eq expected
+    expect(described_class.create(date: '1984-10-23').date).to eq expected
   end
 
   specify do
-    described_class.normalizy :birthday, with: { date: { format: '%y/%m/%d' } }
-
     expected = Time.new(1984, 10, 23, 0, 0, 0, 0)
 
-    expect(described_class.create(birthday: '84/10/23').birthday).to eq expected
+    expect(described_class.create(date_format: '84/10/23').date_format).to eq expected
   end
 
   specify do
-    described_class.normalizy :birthday, with: { date: { time_zone: 'Brasilia' } }
-
     hours    = offset_in_hours('America/Sao_Paulo')
     expected = Time.new(1984, 10, 23, 0, 0, 0, 0) + (hours.hours * -1)
 
-    expect(described_class.create(birthday: '1984-10-23').birthday).to eq expected
+    expect(described_class.create(date_time_zone: '1984-10-23').date_time_zone).to eq expected
   end
 end

data/spec/normalizy/extensions/filters/money_spec.rb

@@ -2,39 +2,29 @@
 
 require 'rails_helper'
 
-RSpec.describe User, 'filters:money' do
-  before do
-    described_class.normalizy_rules = {}
+RSpec.describe ModelMoney, 'filters:money' do
+  specify do
+    expect(described_class.create(text: '$ 42.00').text).to eq '42.00'
+    expect(described_class.create(text: '$ 42.10').text).to eq '42.10'
   end
 
   specify do
-    described_class.normalizy :amount_text, with: :money
-
-    expect(described_class.create(amount_text: '$ 42.00').amount_text).to eq '42.00'
-    expect(described_class.create(amount_text: '$ 42.10').amount_text).to eq '42.10'
+    expect(described_class.create(cents_type: '$ 42.33').cents_type).to eq '4233'
   end
 
   specify do
-    described_class.normalizy :amount_cents, with: { money: { type: :cents } }
-
-    expect(described_class.create(amount_cents: '$ 42.33').amount_cents).to be 4233
+    expect(described_class.create(cast_to_i: '$ 42.00').cast_to_i).to be 42
   end
 
   specify do
-    described_class.normalizy :amount_cents, with: { money: { cast: :to_i } }
-
-    expect(described_class.create(amount_cents: '$ 42.00').amount_cents).to be 42
+    expect(described_class.create(cast_to_d: '$ 1.23').cast_to_d).to eq 1.23
   end
 
   specify do
-    described_class.normalizy :amount, with: { money: { cast: :to_d } }
-
-    expect(described_class.create(amount: '$ 1.23').amount).to eq 1.23.to_d
+    expect(described_class.create(cents_type_and_cast_to_f: '$ 42.00').cents_type_and_cast_to_f).to eq 4200.0
   end
 
   specify do
-    described_class.normalizy :amount, with: { money: { cast: :to_f, type: :cents } }
-
-    expect(described_class.create(amount: '$ 42.00').amount).to eq 4200.0.to_f
+    expect(described_class.create(cents_type_and_cast_to_i: '$ 42.00').cents_type_and_cast_to_i).to eq 4200
   end
 end

data/spec/normalizy/extensions/filters/number_spec.rb

@@ -2,12 +2,8 @@
 
 require 'rails_helper'
 
-RSpec.describe User, 'filters:number' do
-  before { described_class.normalizy_rules = {} }
-
+RSpec.describe ModelNumber, 'filters:number' do
   specify do
-    described_class.normalizy :name, with: :number
-
-    expect(described_class.create(name: 'Washington 32').name).to eq '32'
+    expect(described_class.create(number: 'Botelho 32').number).to eq '32'
   end
 end

data/spec/normalizy/extensions/filters/percent_spec.rb

@@ -2,39 +2,29 @@
 
 require 'rails_helper'
 
-RSpec.describe User, 'filters:percent' do
-  before do
-    described_class.normalizy_rules = {}
+RSpec.describe ModelPercent, 'filters:percent' do
+  specify do
+    expect(described_class.create(text: '42.00 %').text).to eq '42.00'
+    expect(described_class.create(text: '42.10 %').text).to eq '42.10'
   end
 
   specify do
-    described_class.normalizy :amount_text, with: :percent
-
-    expect(described_class.create(amount_text: '42.00 %').amount_text).to eq '42.00'
-    expect(described_class.create(amount_text: '42.10 %').amount_text).to eq '42.10'
+    expect(described_class.create(cents_type: '42.33 %').cents_type).to eq '4233'
   end
 
   specify do
-    described_class.normalizy :amount_cents, with: { percent: { type: :cents } }
-
-    expect(described_class.create(amount_cents: '42.33 %').amount_cents).to be 4233
+    expect(described_class.create(cast_to_i: '42.00 %').cast_to_i).to be 42
   end
 
   specify do
-    described_class.normalizy :amount_cents, with: { percent: { cast: :to_i } }
-
-    expect(described_class.create(amount_cents: '42.00 %').amount_cents).to be 42
+    expect(described_class.create(cast_to_d: '1.23 %').cast_to_d).to eq 1.23
   end
 
   specify do
-    described_class.normalizy :amount, with: { percent: { cast: :to_d } }
-
-    expect(described_class.create(amount: '1.23 %').amount).to eq 1.23.to_d
+    expect(described_class.create(cents_type_and_cast_to_f: '42.00 %').cents_type_and_cast_to_f).to eq 4200.0
   end
 
   specify do
-    described_class.normalizy :amount, with: { percent: { cast: :to_f, type: :cents } }
-
-    expect(described_class.create(amount: '42.00 %').amount).to eq 4200.0.to_f
+    expect(described_class.create(cents_type_and_cast_to_i: '42.00 %').cents_type_and_cast_to_i).to eq 4200
   end
 end

data/spec/normalizy/extensions/filters/strip_spec.rb

@@ -2,20 +2,20 @@
 
 require 'rails_helper'
 
-RSpec.describe User, 'filters:strip' do
-  before do
-    described_class.normalizy_rules = {}
+RSpec.describe ModelStrip, 'filters:strip' do
+  specify do
+    expect(described_class.create(strip: '  Botelho  ').strip).to eq 'Botelho'
   end
 
   specify do
-    described_class.normalizy :name, with: :strip
-
-    expect(described_class.create(name: '  Washington  ').name).to eq 'Washington'
+    expect(described_class.create(strip_side_left: '  Botelho  ').strip_side_left).to eq 'Botelho  '
   end
 
   specify do
-    described_class.normalizy :name, with: { strip: { side: :left } }
+    expect(described_class.create(strip_side_right: '  Botelho  ').strip_side_right).to eq '  Botelho'
+  end
 
-    expect(described_class.create(name: '  Washington  ').name).to eq 'Washington  '
+  specify do
+    expect(described_class.create(strip_side_both: '  Botelho  ').strip_side_both).to eq 'Botelho'
   end
 end