normalizr 0.1.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 9f01b405bb0c605fb3d1ee13165c30708a209ac2
-  data.tar.gz: 585231449522b519400d785946f8d226fee9a1c2
+SHA256:
+  metadata.gz: 6df1b6a2804509540eacc96b2df9fd1a35ef129f64e88d672bdad2361dd92513
+  data.tar.gz: 46d9326603da3d5741c9174e7a579c1cc994463cdbafaeeabd13fd4bff6002d4
 SHA512:
-  metadata.gz: cfe8b07219b1869ce39d2e9795b98c0bf34af89547274e4e6e22c112ef47df6286be7c2098032584d9c40811280ecfc4ea139bbce4bc53a2a64415f0b8a6cebd
-  data.tar.gz: f7ca6b8dc3cc39ae349a753190eb809f734c00334bf22c5a676addd5f0485cc2c822f5801be8180f22d5e08272da66368c7a2bf446eef2da67ea09bfb4767205
+  metadata.gz: b01d5e605d9b743a6763d68f00a14e61f70314c7f666ddc628cb1930c49acabf5faf85c2f0cccb8f5652b706f9dc6a158723e027352c792ced274338e7f946cb
+  data.tar.gz: 2a2501d6aca9ea1b4afdfd5b1d976b1c16cae4e285bf2f6d8cd2b143a69619d680a7b48e2c3b958810e8f057316718c91b5493d13a2fee89b1958e6202efa5e5

data/.travis.yml

@@ -1,16 +1,18 @@
 language: ruby
 cache: bundler
 rvm:
-  - 2.0
-  - 2.1
-  - 2.2
+  - 2.5.7
+  - 2.6.5
+  - 2.7.0
 gemfile:
-  - gemfiles/activerecord-3.2.x.gemfile
-  - gemfiles/activerecord-4.0.x.gemfile
-  - gemfiles/activerecord-4.1.x.gemfile
-  - gemfiles/activerecord-4.2.x.gemfile
+  - gemfiles/activerecord-5.2.x.gemfile
+  - gemfiles/activerecord-6.0.x.gemfile
 addons:
   code_climate:
-    repo_token: 1cac54041089115a5bf218169b62c76c8b87a5896f5aa973f89637a8553c0376
+    repo_token:
+      secure: Dn+nXUOFHTRUhYqYM1NYSxYSyoDhFaB2EHvlhBJ/FK3QxCy4a0beSLhs+YnDl8kI1DOrZQMl7HDrh9AHlfYvu5fX4zADD5g7JkTA2mIx1Rk3yazAUuy1j1ftX/UaowzoUAR5t0qwYm344Nnqoh+O1FujvWbiGVuZvWa6vfjFbXA=
 matrix:
   fast_finish: true
+before_install:
+  - gem install bundler
+sudo: false

data/CHANGELOG.md

@@ -1,3 +1,27 @@
+### 0.5.0 / 2020-07-27
+
+* Add ability to use default and custom normalizers together (@subbbotin)
+
+### 0.4.0 / 2020-01-20
+
+* Support Ruby 2.7 (@badlamer)
+
+### 0.3.1 / 2018-03-22
+
+* Fix conditional normalization
+
+### 0.3.0 / 2018-03-21
+
+* Add a possibility to use if/unless cases for normalizer options (@TheTharin)
+
+### 0.2.0 / 2016-03-17
+
+* Introduce arrays normalization
+
+### 0.1.1 / 2015-11-12
+
+* New `parameterize` normalizer
+
 ### 0.1.0 / 2014-08-30
 
 * Add Mongoid integration

data/README.md

@@ -1,6 +1,9 @@
 ## Normalizr
 
-[![Travic CI](http://img.shields.io/travis/dimko/normalizr.svg)](https://travis-ci.org/dimko/normalizr) [![Code Climate](http://img.shields.io/codeclimate/github/dimko/normalizr.svg)](https://codeclimate.com/github/dimko/normalizr) [![Coverage](http://img.shields.io/codeclimate/coverage/github/dimko/normalizr.svg)](https://codeclimate.com/github/dimko/normalizr)
+[![Gem Version](https://badge.fury.io/rb/normalizr.svg)](https://badge.fury.io/rb/normalizr)
+[![Build Status](https://travis-ci.org/dmeremyanin/normalizr.svg?branch=master)](https://travis-ci.org/dmeremyanin/normalizr)
+[![Code Climate](https://codeclimate.com/github/dmeremyanin/normalizr/badges/gpa.svg)](https://codeclimate.com/github/dmeremyanin/normalizr)
+[![Test Coverage](https://codeclimate.com/github/dmeremyanin/normalizr/badges/coverage.svg)](https://codeclimate.com/github/dmeremyanin/normalizr/coverage)
 
 The [attribute_normalizer](https://github.com/mdeering/attribute_normalizer) replacement.
 
@@ -71,7 +74,7 @@ Normalizr.configure do
   add :indent do |value, amount = 2|
     if String === value
       value.indent(amount)
-    end
+    else
       value
     end
   end
@@ -85,19 +88,29 @@ class User < ActiveRecord::Base
   normalize :first_name, :last_name, :about # with default normalizers
   normalize :email, with: :downcase
 
+  # you can use default and custom normalizers together
+  normalize :middle_name, with: [:default, :titleize]
+
   # supports `normalize_attribute` and `normalize_attributes` as well
   normalize_attribute :skype
+
+  # array normalization is supported too
+  normalize :skills
 end
 
-user = User.new(first_name: '', last_name: '')
+user = User.new(first_name: '', last_name: '', middle_name: 'elizabeth ', skills: [nil, '', ' ruby'])
 user.email = "ADDRESS@example.com"
 
 user.first_name
 #=> nil
 user.last_name
 #=> nil
+user.middle_name
+#=> "Elizabeth"
 user.email
 #=> "address@example.com"
+user.skills
+#=> ["ruby"]
 ```
 
 ```ruby
@@ -122,6 +135,21 @@ sms.message
 #=> "It works"
 ```
 
+You can also use if/unless options (they accept a symbol (method name) or proc):
+
+```ruby
+class Book
+  include Normalizr::Concerns
+
+  attr_accessor :author, :description, :date
+
+  normalize :author, if: :author_should_be_normalized?
+  normalize :description, unless: :description_should_not_be_normalized?
+
+  normalize :author, if: -> { date.today? }
+end
+```
+
 Normalize values outside of class:
 
 ```ruby

data/gemfiles/{activerecord-3.2.x.gemfile → activerecord-5.2.x.gemfile}

@@ -1,7 +1,7 @@
 source 'https://rubygems.org'
 
-gem 'activerecord', '~> 3.2.0'
-gem 'mongoid',      '~> 3.0'
+gem 'activerecord', '~> 5.2.0'
+gem 'mongoid',      '~> 6.0'
 gem 'codeclimate-test-reporter', require: false
 
 gemspec path: '../'

data/gemfiles/{activerecord-4.0.x.gemfile → activerecord-6.0.x.gemfile}

@@ -1,7 +1,7 @@
 source 'https://rubygems.org'
 
-gem 'activerecord', '~> 4.0.0'
-gem 'mongoid',      '~> 4.0'
+gem 'activerecord', '~> 6.0.0'
+gem 'mongoid',      '~> 7.0'
 gem 'codeclimate-test-reporter', require: false
 
 gemspec path: '../'

data/lib/normalizr.rb

@@ -15,8 +15,12 @@ module Normalizr
     @configuration ||= Configuration.new
   end
 
-  def configure
-    configuration.instance_eval &Proc.new
+  def configure(&block)
+    unless block_given?
+      raise ArgumentError, '.configure must be called with a block'
+    end
+
+    configuration.instance_eval(&block)
   end
 
   def find(name)
@@ -27,13 +31,32 @@ module Normalizr
     end
   end
 
-  def normalize(value, *normalizers)
-    normalizers = configuration.default_normalizers if normalizers.empty?
-    normalizers.each do |name|
+  def process(obj, name, options)
+    if Array === obj
+      obj.map { |item| process(item, name, options) }.tap do |ary|
+        ary.compact! if name == :blank
+      end
+    else
+      find(name).call(obj, options)
+    end
+  end
+
+  def normalize(obj, *normalizers)
+    normalizers_with_default(normalizers).reduce(obj) do |memo, name|
       name, options = name.first if Hash === name
-      value = find(name).call(value, options)
+
+      process(memo, name, options)
     end
-    value
+  end
+
+  private
+
+  def normalizers_with_default(normalizers)
+    default_index = normalizers.index(:default)
+
+    normalizers[default_index.to_i] = configuration.default_normalizers if normalizers.empty? || default_index
+    normalizers.flatten!
+    normalizers
   end
 end
 

data/lib/normalizr/concern.rb

@@ -11,8 +11,16 @@ module Normalizr
         prepend Module.new {
           options.attributes.each do |method|
             define_method :"#{method}=" do |value|
-              value = Normalizr.normalize(value, *options.pre)
-              value = Normalizr.normalize(value, *options.post) if options.post.any?
+              condition_lambda = -> condition { Proc === condition ? instance_exec(&condition) : send(condition) }
+
+              positive = options.positive_condition.all?(&condition_lambda)
+              negative = options.negative_condition.none?(&condition_lambda)
+
+              if positive && negative
+                value = Normalizr.normalize(value, *options.before)
+                value = Normalizr.normalize(value, *options.after) if options.after.any?
+              end
+
               super(value)
             end
           end

data/lib/normalizr/configuration.rb

@@ -14,8 +14,12 @@ module Normalizr
       self.default_normalizers = normalizers
     end
 
-    def add(name)
-      normalizers[name] = Proc.new
+    def add(name, &block)
+      unless block_given?
+        raise ArgumentError, '#add must be called with a block'
+      end
+
+      normalizers[name] = block
     end
   end
 end

data/lib/normalizr/options_parser.rb

@@ -8,14 +8,22 @@ module Normalizr
       @block = block
     end
 
-    def pre
+    def before
       options_at(:with, :before) { block }
     end
 
-    def post
+    def after
       options_at(:after)
     end
 
+    def positive_condition
+      options_at(:if)
+    end
+
+    def negative_condition
+      options_at(:unless)
+    end
+
     private
 
     def options_at(*keys)

data/lib/normalizr/version.rb

@@ -1,3 +1,3 @@
 module Normalizr
-  VERSION = '0.1.1'
+  VERSION = '0.5.0'
 end

data/normalizr.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.email         = ['deemox@gmail.com']
   spec.description   = 'Writer methods parameters normalization'
   spec.summary       = 'Writer methods parameters normalization'
-  spec.homepage      = 'https://github.com/dimko/normalizr'
+  spec.homepage      = 'https://github.com/dmeremyanin/normalizr'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files`.split($/)
@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.0'
 
   spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'bundler',      '~> 1.5'
+  spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec',        '~> 3.0'
   spec.add_development_dependency 'rspec-its'

data/spec/lib/normalizr/configuration_spec.rb

@@ -5,17 +5,27 @@ describe Normalizr::Configuration do
   subject { configuration }
 
   describe '#default' do
-    before { configuration.default(:blank) }
-    its(:default_normalizers) { should == [:blank] }
+    it 'accpets default normalizers' do
+      subject.default(:blank)
+      expect(subject.default_normalizers).to eq([:blank])
+    end
   end
 
   describe '#normalizer_names' do
-    before { allow(configuration).to receive(:normalizers) {{ blank: proc {}}}}
-    its(:normalizer_names) { should == [:blank] }
+    it 'returns normalized names' do
+      allow(subject).to receive(:normalizers) {{ blank: proc {}}}
+      expect(subject.normalizer_names).to eq([:blank])
+    end
   end
 
   describe '#add' do
-    before { configuration.add(:blank) {}}
-    its(:normalizer_names) { should include(:blank) }
+    it 'requires block' do
+      expect { subject.add(:blank) }.to raise_error(ArgumentError)
+    end
+
+    it 'accepts block' do
+      subject.add(:blank) {}
+      expect(subject.normalizer_names).to include(:blank)
+    end
   end
 end

data/spec/lib/normalizr_spec.rb

@@ -17,7 +17,7 @@ describe Normalizr do
     context 'not existed normalizer' do
       let(:normalizer) { :not_existed }
 
-      it 'raise exception with normalizer in message' do
+      it 'raises the exception with normalizer in message' do
         expect { subject }.to raise_error(Normalizr::MissingNormalizer, /not_existed/)
       end
     end
@@ -31,25 +31,113 @@ describe Normalizr do
     end
   end
 
+  describe '#process' do
+    subject { described_class.process(obj, name, {}) }
+
+    context 'string' do
+      let(:obj) { ' test ' }
+
+      context 'blank normalizer' do
+        let(:name) { :strip }
+
+        it 'strips the value' do
+          should == 'test'
+        end
+      end
+    end
+
+    context 'array ' do
+      let(:obj) { [nil, ' '] }
+
+      context 'strip normalizer' do
+        let(:name) { :strip }
+
+        it 'strips all elements' do
+          expect(subject).to eq([nil, ''])
+        end
+      end
+
+      context 'custom normalizer' do
+        let(:name) { proc { |value| value.prepend('N:') if String === value }}
+
+        it 'processes all elements with the custom normalizer' do
+          expect(subject).to eq([nil, 'N: '])
+        end
+      end
+
+      context 'blank normalizer' do
+        let(:name) { :blank }
+
+        it 'returns empty array' do
+          expect(subject).to eq([])
+        end
+      end
+    end
+  end
+
   describe '#normalize' do
     before  { configuration.default_normalizers = [:strip, :blank] }
     subject { described_class.normalize(value, *normalizers) }
 
-    context 'normalizers is empty' do
+
+    context 'normalizers are empty' do
       let(:normalizers) { [] }
-      let(:value) { ' text ' }
 
-      it 'use default normalizers' do
-        expect(subject).to eq('text')
+      context 'string' do
+        let(:value) { ' text ' }
+
+        it 'uses the default normalizers' do
+          expect(subject).to eq('text')
+        end
+      end
+
+      context 'array' do
+        let(:value) { [nil, ' test '] }
+
+        it 'uses the default normalizers' do
+          expect(subject).to eq(['test'])
+        end
       end
     end
 
-    context 'normalizers is not empty' do
+    context 'normalizers are not empty' do
       let(:normalizers) { [:strip, { truncate: { length: 8, omission: '...' }}, proc { |v| v.first(6) }] }
+
+      context 'string' do
+        let(:value) { ' Lorem ipsum dolor sit amet' }
+
+        it 'strips, truncates and then slices the value' do
+          expect(subject).to eq('Lorem.')
+        end
+      end
+
+      context 'array' do
+        let(:value) { [' Lorem ipsum dolor sit amet', '    One more sentence'] }
+
+        it 'strips, truncates and then slices the value' do
+          expect(subject).to eq(['Lorem.', 'One m.'])
+        end
+      end
+    end
+
+    context 'normalizers are default and custom' do
+      let(:normalizers) { [:default, { truncate: { length: 8, omission: '...' }}, proc { |v| v.first(6) }] }
       let(:value) { ' Lorem ipsum dolor sit amet' }
 
-      it 'normalize value' do
-        expect(subject).to eq('Lorem.')
+      context 'string' do
+        let(:value) { ' Lorem ipsum dolor sit amet' }
+
+        it 'uses the default normalizers, then truncates and slices the value' do
+          expect(subject).to eq('Lorem.')
+        end
+      end
+
+      context 'array' do
+        let(:value) { [' Lorem ipsum dolor sit amet', '    One more sentence', ''] }
+
+        it 'strips, truncates and then slices the value' do
+          expect(subject).to eq(['Lorem.', 'One m.'])
+        end
       end
     end
   end

data/spec/models/book_spec.rb

@@ -1,12 +1,15 @@
 require 'spec_helper'
 
 describe Book do
-  it { should normalize_attribute(:author).from(' Michael Deering ').to('Michael Deering') }
-  it { should normalize_attribute(:us_price).from('$3.50').to(3.50) }
-  it { should normalize_attribute(:cnd_price).from('$3,450.98').to(3450.98) }
-  it { should normalize_attribute(:summary).from('    Here is my summary that is a little to long  ').to('Here is m...') }
+  it { should normalize(:author).from(' Michael Deering ').to('Michael Deering') }
+  it { should normalize(:us_price).from('$3.50').to(3.50) }
+  it { should normalize(:cnd_price).from('$3,450.98').to(3450.98) }
+  it { should normalize(:summary).from('    Here is my summary that is a little to long  ').to('Here is m...') }
+  it { should normalize(:title).from('pick up chicks with magic tricks').to('Pick Up Chicks With Magic Tricks') }
 
-  it { should normalize_attribute(:title).from('pick up chicks with magic tricks').to('Pick Up Chicks With Magic Tricks') }
+  it { should normalize(:tags).from(['', nil, ' ', ' test']).to(['test']) }
+  it { should normalize(:tags).from([[''], [nil, ' test ']]).to([[], ['test']]) } # nested arrays
+  it { should normalize(:tags).from([]).to([]) }
 
   context 'normalization should not interfere with other hooks and aliases on the attribute assignment' do
     before do
@@ -22,7 +25,7 @@ describe Book do
     before do
       @book = Book.create!(title: 'Original Title')
       @book2 = Book.find(@book.id)
-      @book2.update_attributes(title: 'New Title')
+      @book2.update(title: 'New Title')
     end
 
     it "should reflect the change when the record is reloaded" do

data/spec/models/user_spec.rb

@@ -4,4 +4,42 @@ describe User do
   context 'on default attribute with the default normalizer changed' do
     it { should normalize_attribute(:firstname).from(' here ').to('here') }
   end
+
+  context 'last name has to be normalized' do
+    before do
+      allow(subject).to receive(:should_normalize_lastname?).and_return(true)
+    end
+
+    it { is_expected.to normalize_attribute(:lastname).from(' here ').to('here') }
+  end
+
+  context 'last name cannot be normalized' do
+    before do
+      allow(subject).to receive(:should_normalize_lastname?).and_return(false)
+    end
+
+    it { is_expected.not_to normalize_attribute(:lastname).from(' here ').to('here') }
+  end
+
+  context 'maidenname has to be normalized' do
+    before do
+      allow(subject).to receive(:should_normalize_maidenname_positive?).and_return(true)
+      allow(subject).to receive(:should_normalize_maidenname_negative?).and_return(false)
+    end
+
+    it { is_expected.to normalize_attribute(:maidenname).from(' boba ').to('boba') }
+  end
+
+  context 'maidenname cannot to be normalized' do
+    before do
+      allow(subject).to receive(:should_normalize_maidenname_positive?).and_return(true)
+      allow(subject).to receive(:should_normalize_maidenname_negative?).and_return(true)
+    end
+
+    it { is_expected.not_to normalize_attribute(:maidenname).from(' boba ').to('boba') }
+  end
+
+  context 'favouritebook has to be normalized with proc' do
+    it { is_expected.to normalize_attribute(:favouritebook).from(' Евангелие от Матфея ').to('Евангелие от Матфея') }
+  end
 end

data/spec/spec_helper.rb

@@ -1,4 +1,4 @@
-require 'support/codeclimate'
+require 'simplecov'
 require 'pry'
 require 'rspec'
 require 'rspec/its'

data/spec/support/models/book.rb

@@ -5,4 +5,7 @@ class Book < ActiveRecord::Base
   normalize_attributes :title do |value|
     String === value ? value.titleize.strip : value
   end
+
+  serialize :tags, Array
+  normalize :tags
 end

data/spec/support/models/user.rb

@@ -1,3 +1,21 @@
 class User < Person
   normalize_attribute :firstname
+
+  normalize :lastname, if: :should_normalize_lastname?
+  normalize :maidenname, if: :should_normalize_maidenname_positive?, unless: :should_normalize_maidenname_negative?
+  normalize :favouritebook, if: -> { true }
+
+  private
+
+  def should_normalize_lastname?
+    true
+  end
+
+  def should_normalize_maidenname_positive?
+    true
+  end
+
+  def should_normalize_maidenname_negative?
+    false
+  end
 end

data/spec/support/schema.rb

@@ -22,6 +22,7 @@ ActiveRecord::Schema.define do
     t.decimal :us_price
     t.string  :summary
     t.string  :title
+    t.text    :tags
   end
 
   create_table :journals, force: true do |t|
@@ -37,5 +38,7 @@ ActiveRecord::Schema.define do
   create_table :users, force: true do |t|
     t.string :firstname
     t.string :lastname
+    t.string :maidenname
+    t.string :favouritebook
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: normalizr
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Dimko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-13 00:00:00.000000000 Z
+date: 2020-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -28,16 +28,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -151,10 +151,8 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- gemfiles/activerecord-3.2.x.gemfile
-- gemfiles/activerecord-4.0.x.gemfile
-- gemfiles/activerecord-4.1.x.gemfile
-- gemfiles/activerecord-4.2.x.gemfile
+- gemfiles/activerecord-5.2.x.gemfile
+- gemfiles/activerecord-6.0.x.gemfile
 - lib/normalizr.rb
 - lib/normalizr/concern.rb
 - lib/normalizr/configuration.rb
@@ -193,7 +191,7 @@ files:
 - spec/support/models/publisher.rb
 - spec/support/models/user.rb
 - spec/support/schema.rb
-homepage: https://github.com/dimko/normalizr
+homepage: https://github.com/dmeremyanin/normalizr
 licenses:
 - MIT
 metadata: {}
@@ -212,8 +210,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Writer methods parameters normalization

data/gemfiles/activerecord-4.1.x.gemfile

@@ -1,7 +0,0 @@
-source 'https://rubygems.org'
-
-gem 'activerecord', '~> 4.1.0'
-gem 'mongoid',      '~> 4.0'
-gem 'codeclimate-test-reporter', require: false
-
-gemspec path: '../'

data/gemfiles/activerecord-4.2.x.gemfile

@@ -1,7 +0,0 @@
-source 'https://rubygems.org'
-
-gem 'activerecord', '~> 4.2.0'
-gem 'mongoid',      '~> 4.0'
-gem 'codeclimate-test-reporter', require: false
-
-gemspec path: '../'