normalizy 1.4.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f14ab0cae60c11869af9ac8bf6fbb51f95d94200f32f72d024dc7374f82e4ed
-  data.tar.gz: bb91ac9f34acdeeb0e98d8891bd0dc1d8ddade115af057ad5292ee5925455f46
+  metadata.gz: ee7f65965cec5c289729431b01fcf23be051784ec7b18bf9b71ae00c698d9d93
+  data.tar.gz: ad9ce5473030dec2eae92783feecf6895e8e5e841bee48b5af46f4b6579dcc12
 SHA512:
-  metadata.gz: dc45e12d2315ef96780d736fcc8554bd78c74f25db2addd6868658c4268196ba64de7c65925798dd8eedc0d31b012a69d542c7725032cb657d4f024900d6adf9
-  data.tar.gz: e1f89c0c87861c86291d38ef4be32cff60a110ebed57e2b893fbb3a0c29b66e4ba256d5b486d2194b9af26de7442859720d59d690b5930c46aec058206d6437a
+  metadata.gz: c2c043c42e3627fb56b02defc6a0081311da5b72dfb1da0ecda255abca81a734b4a47c4c25054f24d5c4dec75059862fa250482e54d84f79a6905ecde4e5a7cc
+  data.tar.gz: eec956c476590a3a521f33ed58e657add31f52d391cb29362856d9dce14968f8d55df4f38b7d030071283da2d236ee1ec87654c5b6598a181ea45c227ef32216

data/CHANGELOG.md

@@ -1,54 +1,95 @@
+## v1.7.0
+
+### Features
+
+- Adds `truncate` filter; [#3](https://github.com/wbotelhos/normalizy/pull/3) by [rafaeldev](https://github.com/rafaeldev)
+
+### Updates
+
+- Adds RuboCop task on the CI;
+
+## v1.6.0
+
+### Fixes
+
+- Fix Money Filter to use the correct default Rails path for Currency and Percentage;
+
+### Updates
+
+- Adds Code Quality;
+- Adds Test Coverage;
+- Migrates the build to Github Actions;
+- Removes Git dependency for the build;
+
+## v1.5.0
+
+### Features
+
+- Filter `date` now supports call object that responds to `beginning_of_day` or `end_of_day`;
+
 ## v1.4.0
 
+### Features
+
 - Adds `date` support for `Date` class.
 
 ## v1.3.0
 
-- Changes:
- - Support Rails 6.
+### Updates
+
+- Support Rails 6.
 
 ## v1.2.0
 
-- Features:
-  - `money` filter now allows negative numbers.
+### Features
+
+- `money` filter now allows negative numbers.
 
 ## v1.1.1
 
-- Fixes:
-  - When use `slug` filter the original values was not saved.
+### Fixes
+
+- When using `slug` filter the original values were not saved.
 
 ## v1.1.0
 
-- Features:
-  - Added `slug` filter with option to apply the value on other field.
+### Features
+
+- Added `slug` filter with the option to apply the value on other fields.
 
 ## v1.0.1
 
-- Fixes:
-  - When `type` options was `cents` and had no decimal on number, extra decimal were added.
+### Fixes
+
+- When `type` options were `cents` and had no decimal on the number, extra decimals were added.
 
 ## 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.
+### Updates
+
+- `raw` options was dropped since `prepend` already works before type cast;
+- Multiple lines of `normalizy` will be evaluated from the bottom to top.
+
+### Features
 
-- Features:
-  - `alias` configuration now accepts options;
+- `alias` configuration now accepts options;
 
-- Fixes:
-  - Multiple filters were not running together.
+### Fixes
+
+- Multiple filters were not running together.
 
 ## v0.2.0
 
-- Changes:
-  - `number` filter no more make cast automatically.
-  - `number` now accept `cast` options with method to be used on cast type;
+### Updates
+
+- `number` filter no more make cast automatically.
+- `number` now accept `cast` options with a method to be used on cast type;
+
+### Features
 
-- Features:
-  - add `date` filter with `format`, `time_zone` and I18n error message support;
-  - add `money` filter with `cast`, `type` and I18n support;
-  - add `percent` filter with `cast`, `type` and I18n support.
+- add `date` filter with `format`, `time_zone` and I18n error message support;
+- add `money` filter with `cast`, `type` and I18n support;
+- add `percent` filter with `cast`, `type` and I18n support.
 
 ## v0.1.0
 

data/README.md

@@ -1,10 +1,12 @@
 # Normalizy
 
-[![Build Status](https://travis-ci.org/wbotelhos/normalizy.svg)](https://travis-ci.org/wbotelhos/normalizy)
+[![CI](https://github.com/wbotelhos/normalizy/workflows/CI/badge.svg)](https://github.com/wbotelhos/normalizy/actions)
 [![Gem Version](https://badge.fury.io/rb/normalizy.svg)](https://badge.fury.io/rb/normalizy)
-[![Patreon](https://img.shields.io/badge/donate-%3C3-brightgreen.svg)](https://www.patreon.com/wbotelhos)
+[![Maintainability](https://api.codeclimate.com/v1/badges/3896d0a11bee012c818c/maintainability)](https://codeclimate.com/github/wbotelhos/normalizy/maintainability)
+[![codecov](https://codecov.io/gh/wbotelhos/normalizy/branch/master/graph/badge.svg?token=0XTRFDFHDq)](https://codecov.io/gh/wbotelhos/normalizy)
+[![Sponsor](https://img.shields.io/badge/sponsor-%3C3-green)](https://www.patreon.com/wbotelhos)
 
-Attribute normalizer for ActiveRecord.
+Attribute normalizer for Rails.
 
 ## Description
 
@@ -140,9 +142,10 @@ If you do not want pass it as options, Normalizy will fetch your I18n config:
 
 ```yaml
 en:
-  currency:
-    format:
-      separator: '.'
+  number:
+    currency:
+      format:
+        separator: '.'
 ```
 
 And if it does not exists, `.` will be used as default.
@@ -190,9 +193,10 @@ If you do not want pass it as options, Normalizy will fetch your I18n config:
 
 ```yaml
 en:
-  currency:
-    format:
-      separator: 2
+  number:
+    currency:
+      format:
+        precision: 2
 ```
 
 And if it does not exists, `2` will be used as default.
@@ -265,9 +269,10 @@ If you do not want pass it as options, Normalizy will fetch your I18n config:
 
 ```yaml
 en:
-  percentage:
-    format:
-      separator: '.'
+  number:
+    percentage:
+      format:
+        separator: '.'
 ```
 
 And if it does not exists, `.` will be used as default.
@@ -315,9 +320,10 @@ If you do not want pass it as options, Normalizy will fetch your I18n config:
 
 ```yaml
 en:
-  percentage:
-    format:
-      separator: 2
+  number:
+    percentage:
+      format:
+        separator: 2
 ```
 
 And if it does not exists, `2` will be used as default.
@@ -400,6 +406,17 @@ normalizy :name, with: { strip: { side: :both } }
 
 As you can see, the rules can be passed as Symbol/String or as Hash if it has options.
 
+### Truncate
+
+Remove excedent string part from a gived limit.
+
+```ruby
+normalizy :description, with: { truncate: { limit: 10 } }
+
+'Once upon a time in a world far far away'
+# 'Once upon '
+```
+
 ## Multiple Filters
 
 You can normalize with a couple of filters at once:
@@ -449,7 +466,7 @@ Now, all normalization will include `squish`, even when no rule is declared.
 
 ```ruby
 normalizy :name
-'  Washington  Botelho  '
+"  Washington  \n  Botelho  "
 # 'Washington Botelho'
 ```
 

data/lib/normalizy/config.rb

@@ -29,7 +29,8 @@ module Normalizy
         number:  Normalizy::Filters::Number,
         percent: Normalizy::Filters::Percent,
         slug:    Normalizy::Filters::Slug,
-        strip:   Normalizy::Filters::Strip
+        strip:   Normalizy::Filters::Strip,
+        truncate: Normalizy::Filters::Truncate,
       }
     end
   end

data/lib/normalizy/filters/date.rb

@@ -13,10 +13,8 @@ module Normalizy
             end
           end
 
-          if [::Date, DateTime, Time].include?(input.class)
-            input = input.beginning_of_day if options[:adjust] == :begin
-            input = input.end_of_day       if options[:adjust] == :end
-          end
+          input = input.beginning_of_day if options[:adjust] == :begin && input.respond_to?(:beginning_of_day)
+          input = input.end_of_day       if options[:adjust] == :end   && input.respond_to?(:end_of_day)
 
           input
         rescue ArgumentError

data/lib/normalizy/filters/money.rb

@@ -29,7 +29,7 @@ module Normalizy
         end
 
         def precision(options)
-          options.fetch :precision, I18n.t('currency.format.precision', default: 2)
+          options.fetch(:precision, I18n.t('number.currency.format.precision', default: 2))
         end
 
         def precisioned(value, options)
@@ -37,7 +37,7 @@ module Normalizy
         end
 
         def separator(options)
-          options.fetch :separator, I18n.t('currency.format.separator', default: '.')
+          options.fetch(:separator, I18n.t('number.currency.format.separator', default: '.'))
         end
       end
     end

data/lib/normalizy/filters/percent.rb

@@ -29,7 +29,7 @@ module Normalizy
         end
 
         def precision(options)
-          options.fetch :precision, I18n.t('percentage.format.precision', default: 2)
+          options.fetch(:precision, I18n.t('number.percentage.format.precision', default: 2))
         end
 
         def precisioned(value, options)
@@ -37,7 +37,7 @@ module Normalizy
         end
 
         def separator(options)
-          options.fetch :separator, I18n.t('percentage.format.separator', default: '.')
+          options.fetch(:separator, I18n.t('number.percentage.format.separator', default: '.'))
         end
       end
     end

data/lib/normalizy/filters/slug.rb

@@ -4,7 +4,7 @@ module Normalizy
   module Filters
     module Slug
       class << self
-        def call(input, options = {})
+        def call(input, _options = {})
           return input unless input.is_a?(String)
 
           input.parameterize

data/lib/normalizy/filters/strip.rb

@@ -9,7 +9,7 @@ module Normalizy
         regex = {
           both:  '\A\s*|\s*\z',
           left:  '\A\s*',
-          right: '\s*\z'
+          right: '\s*\z',
         }[options[:side] || :both]
 
         input.gsub Regexp.new(/#{regex}/), ''

data/lib/normalizy/filters/truncate.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Normalizy
+  module Filters
+    module Truncate
+      module_function
+
+      def call(input, options = {})
+        return input unless options[:limit].is_a?(Integer)
+        return input unless input.is_a?(String)
+
+        input[0, options[:limit]]
+      end
+    end
+  end
+end

data/lib/normalizy/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Normalizy
-  VERSION = '1.4.0'
+  VERSION = '1.7.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: normalizy
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Washington Botelho
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-03-30 00:00:00.000000000 Z
+date: 2022-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -25,7 +25,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4.1'
 - !ruby/object:Gem::Dependency
-  name: pry-byebug
+  name: codecov
+  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'
+- !ruby/object:Gem::Dependency
+  name: debug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -108,11 +122,14 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Attribute normalizer for ActiveRecord.
+description: Attribute normalizer for Rails.
 email: wbotelhos@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- CHANGELOG.md
+- LICENSE
+- README.md
 files:
 - CHANGELOG.md
 - LICENSE
@@ -129,55 +146,15 @@ files:
 - lib/normalizy/filters/percent.rb
 - lib/normalizy/filters/slug.rb
 - lib/normalizy/filters/strip.rb
+- lib/normalizy/filters/truncate.rb
 - lib/normalizy/rspec/matcher.rb
 - lib/normalizy/version.rb
-- spec/normalizy/config/add_spec.rb
-- spec/normalizy/config/alias_spec.rb
-- spec/normalizy/config/default_filters_spec.rb
-- spec/normalizy/config/initialize_spec.rb
-- spec/normalizy/config/normalizy_aliases_spec.rb
-- spec/normalizy/extensions/filters/date_spec.rb
-- spec/normalizy/extensions/filters/money_spec.rb
-- spec/normalizy/extensions/filters/number_spec.rb
-- spec/normalizy/extensions/filters/percent_spec.rb
-- spec/normalizy/extensions/filters/slug_spec.rb
-- spec/normalizy/extensions/filters/strip_spec.rb
-- spec/normalizy/extensions/model_spec.rb
-- spec/normalizy/extensions/normalizy_rules_spec.rb
-- spec/normalizy/filters/date_spec.rb
-- spec/normalizy/filters/money_spec.rb
-- spec/normalizy/filters/number_spec.rb
-- spec/normalizy/filters/percent_spec.rb
-- spec/normalizy/filters/slug_spec.rb
-- spec/normalizy/filters/strip_spec.rb
-- spec/normalizy/normalizy/configure_spec.rb
-- spec/normalizy/rspec/matcher/description_spec.rb
-- spec/normalizy/rspec/matcher/failure_message_spec.rb
-- spec/normalizy/rspec/matcher/failure_message_when_negated_spec.rb
-- spec/normalizy/rspec/matcher/from_spec.rb
-- spec/normalizy/rspec/matcher/matches_spec.rb
-- spec/normalizy/rspec/matcher/to_spec.rb
-- spec/rails_helper.rb
-- spec/support/common.rb
-- spec/support/db/schema.rb
-- spec/support/filters/blacklist.rb
-- spec/support/filters/block.rb
-- spec/support/filters/info.rb
-- spec/support/models/alias.rb
-- spec/support/models/match.rb
-- spec/support/models/model.rb
-- spec/support/models/model_date.rb
-- spec/support/models/model_money.rb
-- spec/support/models/model_number.rb
-- spec/support/models/model_percent.rb
-- spec/support/models/model_slug.rb
-- spec/support/models/model_strip.rb
-- spec/support/models/rule.rb
 homepage: https://github.com/wbotelhos/normalizy
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -192,50 +169,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.1.6
+signing_key:
 specification_version: 4
-summary: Attribute normalizer for ActiveRecord.
-test_files:
-- spec/normalizy/filters/date_spec.rb
-- spec/normalizy/filters/number_spec.rb
-- spec/normalizy/filters/money_spec.rb
-- spec/normalizy/filters/percent_spec.rb
-- spec/normalizy/filters/slug_spec.rb
-- spec/normalizy/filters/strip_spec.rb
-- spec/normalizy/config/initialize_spec.rb
-- spec/normalizy/config/normalizy_aliases_spec.rb
-- spec/normalizy/config/alias_spec.rb
-- spec/normalizy/config/add_spec.rb
-- spec/normalizy/config/default_filters_spec.rb
-- spec/normalizy/extensions/filters/date_spec.rb
-- spec/normalizy/extensions/filters/number_spec.rb
-- spec/normalizy/extensions/filters/money_spec.rb
-- spec/normalizy/extensions/filters/percent_spec.rb
-- spec/normalizy/extensions/filters/slug_spec.rb
-- spec/normalizy/extensions/filters/strip_spec.rb
-- spec/normalizy/extensions/normalizy_rules_spec.rb
-- spec/normalizy/extensions/model_spec.rb
-- spec/normalizy/normalizy/configure_spec.rb
-- spec/normalizy/rspec/matcher/matches_spec.rb
-- spec/normalizy/rspec/matcher/failure_message_spec.rb
-- spec/normalizy/rspec/matcher/failure_message_when_negated_spec.rb
-- spec/normalizy/rspec/matcher/to_spec.rb
-- spec/normalizy/rspec/matcher/from_spec.rb
-- spec/normalizy/rspec/matcher/description_spec.rb
-- spec/support/filters/block.rb
-- spec/support/filters/blacklist.rb
-- spec/support/filters/info.rb
-- spec/support/models/model_money.rb
-- spec/support/models/match.rb
-- spec/support/models/model_date.rb
-- spec/support/models/model.rb
-- spec/support/models/model_slug.rb
-- spec/support/models/rule.rb
-- spec/support/models/model_percent.rb
-- spec/support/models/model_number.rb
-- spec/support/models/model_strip.rb
-- spec/support/models/alias.rb
-- spec/support/common.rb
-- spec/support/db/schema.rb
-- spec/rails_helper.rb
+summary: Attribute normalizer for Rails.
+test_files: []

data/spec/normalizy/config/add_spec.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-require 'rails_helper'
-
-RSpec.describe Normalizy::Config, '#add' do
-  it 'adds filters to the built-in filters' do
-    Normalizy.configure do |config|
-      config.add :blacklist, :blacklist_filter
-    end
-
-    expect(Normalizy.config.filters).to eq(
-      blacklist: :blacklist_filter,
-      date:      Normalizy::Filters::Date,
-      money:     Normalizy::Filters::Money,
-      number:    Normalizy::Filters::Number,
-      percent:   Normalizy::Filters::Percent,
-      slug:      Normalizy::Filters::Slug,
-      strip:     Normalizy::Filters::Strip
-    )
-  end
-end

data/spec/normalizy/config/alias_spec.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-require 'rails_helper'
-
-RSpec.describe Normalizy::Config, '#alias' do
-  it 'accepts alias' do
-    Normalizy.configure do |config|
-      config.alias :email, :downcase
-    end
-
-    expect(Alias.create(email: 'Botelho').email).to eq 'botelho'
-  end
-
-  it 'accepts alias with options' do
-    Normalizy.configure do |config|
-      config.alias :with_arg, strip: { side: :left }
-    end
-
-    expect(Alias.create(with_arg_field: '  trim').with_arg_field).to eq 'trim'
-  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/config/default_filters_spec.rb

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-require 'rails_helper'
-
-RSpec.describe Normalizy::Config, 'default_filters' do
-  context 'when get' do
-    it 'returns the default filters' do
-      expect(subject.default_filters).to eq({})
-    end
-  end
-
-  context 'when set' do
-    before { subject.default_filters = :blank }
-
-    it 'keeps the original' do
-      expect(subject.default_filters).to eq :blank
-    end
-  end
-end

data/spec/normalizy/config/initialize_spec.rb

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-require 'rails_helper'
-
-RSpec.describe Normalizy::Config, 'filters' do
-  it 'loads some filters' do
-    expect(subject.filters).to eq(
-      date:    Normalizy::Filters::Date,
-      money:   Normalizy::Filters::Money,
-      number:  Normalizy::Filters::Number,
-      percent: Normalizy::Filters::Percent,
-      slug:    Normalizy::Filters::Slug,
-      strip:   Normalizy::Filters::Strip
-    )
-  end
-end

data/spec/normalizy/config/normalizy_aliases_spec.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-require 'rails_helper'
-
-RSpec.describe Normalizy::Config, 'normalizy_aliases' do
-  it 'has the right defaults' do
-    expect(subject.normalizy_aliases).to eq({})
-  end
-end

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

@@ -1,23 +0,0 @@
-# frozen_string_literal: true
-
-require 'rails_helper'
-
-RSpec.describe ModelDate, 'filters:date' do
-  it { expect(described_class.create(date: '1984-10-23').date).to eq(Time.new(1984, 10, 23, 0, 0, 0, 0)) }
-  it { expect(described_class.create(date_format: '84/10/23').date_format).to eq(Time.new(1984, 10, 23, 0, 0, 0, 0)) }
-
-  it do
-    hours    = ActiveSupport::TimeZone['Brasilia'].utc_offset / 3600.0
-    expected = Time.new(1984, 10, 23, 0, 0, 0, 0) + (hours.hours * -1)
-
-    expect(described_class.create(date_time_zone: '1984-10-23').date_time_zone).to eq expected
-  end
-
-  it 'normalizys end date' do
-    expect(described_class.new(date_time_end: Date.new(1984)).date_time_end).to eq(Time.new(1984).end_of_day)
-  end
-
-  it 'normalizys begin date' do
-    expect(described_class.new(date_time_begin: Date.new(1984, 10, 23)).date_time_begin).to eq(Time.new(1984, 10, 23))
-  end
-end

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

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-require 'rails_helper'
-
-RSpec.describe ModelMoney, 'filters:money' do
-  it 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'
-
-    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
-
-  it do
-    expect(described_class.create(cents_type: '$ 42.33').cents_type).to  eq '4233'
-    expect(described_class.create(cents_type: '$ -42.33').cents_type).to eq '-4233'
-  end
-
-  it do
-    expect(described_class.create(cast_to_i: '$ 42.00').cast_to_i).to  be 42
-    expect(described_class.create(cast_to_i: '$ -42.00').cast_to_i).to be -42
-  end
-
-  it do
-    expect(described_class.create(cast_to_d: '$ 1.23').cast_to_d).to  eq 1.23
-    expect(described_class.create(cast_to_d: '$ -1.23').cast_to_d).to eq -1.23
-  end
-
-  it do
-    expect(described_class.create(cents_type_and_cast_to_f: '$ 42.00').cents_type_and_cast_to_f).to  eq 4200.0
-    expect(described_class.create(cents_type_and_cast_to_f: '$ -42.00').cents_type_and_cast_to_f).to eq -4200.0
-  end
-
-  it do
-    expect(described_class.create(cents_type_and_cast_to_i: '$ 42.00').cents_type_and_cast_to_i).to  eq 4200
-    expect(described_class.create(cents_type_and_cast_to_i: '$ -42.00').cents_type_and_cast_to_i).to eq -4200
-  end
-end