normalizy 1.6.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ce6511269094da3b936369b12195ad147ecbc4a67be1649eedf4a96a18aba63
-  data.tar.gz: bc8454295d05564e66a702d528132487297a0b969a62b56a182cc33e27156747
+  metadata.gz: 7fbc57100ff4a77fb63503844a16059b78537836f4df58f0f64127d2bcfe3270
+  data.tar.gz: f0ac58e5e468721dc2ab116a0550b542c495e073d9315b420f8bddb754b327c2
 SHA512:
-  metadata.gz: 197c6dc140be871e4758e67e8197ab55015760ec711c54f9923783bd516d79d084a8d13fe39fd6ff582cf634796b533938adfc7d437257d4f8a96ee02f926f5e
-  data.tar.gz: 36b8f76aa291b2bd977902777518e8c48ca4a6f7be5ab224d17e3de33c04cd1d02fdca9387dcf7ffeab83fc08ebc2f2e657a99fccaa169d6713cad67d236ea46
+  metadata.gz: f92bae33a40563537d7b6637118dbdf5b960b979a2941e6aa0859ad738a9dda2db74e1b444de3853ff61c2a4695866ad46efc96d3b34b3088bf16a6e6c87d124
+  data.tar.gz: cbf6c06467360321fa144d1800258d4af50215b1b661e9e2056ab1d0c17b712e137a4167d82bb9534030a9f35605faa4af2a140c09e6b2121f42e38d3b7a7560

data/CHANGELOG.md

@@ -1,3 +1,23 @@
+## v2.0.0
+
+### Break Changes
+
+- Drops support for Ruby < 3.3;
+
+### Fixes
+
+- `date` filter now returns `nil` explicitly on invalid date to avoid Rails 8 compatibility issue where `errors.add` returns the added `ActiveModel::Error` object instead of `nil`;
+
+## 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
@@ -9,13 +29,13 @@
 - Adds Code Quality;
 - Adds Test Coverage;
 - Migrates the build to Github Actions;
-- Removes Git dependency for build;
+- Removes Git dependency for the build;
 
 ## v1.5.0
 
 ### Features
 
-- Filter `date` now supports call object that respond to `beginning_of_day` or `end_of_day`;
+- Filter `date` now supports call object that responds to `beginning_of_day` or `end_of_day`;
 
 ## v1.4.0
 
@@ -39,19 +59,19 @@
 
 ### Fixes
 
-- When use `slug` filter the original values was not saved.
+- 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.
+- 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.
+- When `type` options were `cents` and had no decimal on the number, extra decimals were added.
 
 ## v1.0.0
 
@@ -73,7 +93,7 @@
 ### Updates
 
 - `number` filter no more make cast automatically.
-- `number` now accept `cast` options with method to be used on cast type;
+- `number` now accept `cast` options with a method to be used on cast type;
 
 ### Features
 

data/README.md

@@ -1,10 +1,10 @@
 # Normalizy
 
-[![CI](https://github.com/wbotelhos/normalizy/workflows/CI/badge.svg)](https://github.com/wbotelhos/normalizy/actions)
+[![Tests](https://github.com/wbotelhos/normalizy/workflows/Tests/badge.svg)](https://github.com/wbotelhos/normalizy/actions/workflows/tests.yml)
 [![Gem Version](https://badge.fury.io/rb/normalizy.svg)](https://badge.fury.io/rb/normalizy)
-[![Maintainability](https://api.codeclimate.com/v1/badges/f312587b4f126bb13e85/maintainability)](https://codeclimate.com/github/wbotelhos/normalizy/maintainability)
-[![Coverage](https://codecov.io/gh/wbotelhos/normalizy/branch/main/graph/badge.svg)](https://codecov.io/gh/wbotelhos/normalizy)
-[![Sponsor](https://img.shields.io/badge/sponsor-%3C3-green)](https://www.patreon.com/wbotelhos)
+[![Maintainability](https://qlty.sh/gh/wbotelhos/projects/normalizy/maintainability.svg)](https://qlty.sh/gh/wbotelhos/projects/normalizy)
+[![Coverage](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://github.com/sponsors/wbotelhos)
 
 Attribute normalizer for Rails.
 
@@ -406,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:

data/lib/normalizy/config.rb

@@ -20,7 +20,7 @@ module Normalizy
     end
 
     def initialize
-      @default_filters   = {}
+      @default_filters = {}
       @normalizy_aliases = {}
 
       @filters = {
@@ -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/extensions.rb

@@ -8,11 +8,11 @@ module Normalizy
       private
 
       def extract_filter(rule, rule_options, attribute, filters: Normalizy.config.filters)
-        options = rule_options.merge(attribute: attribute, object: self)
+        options = rule_options.merge(attribute:, object: self)
 
         return [filters[rule] || rule, options] unless rule.is_a?(Hash)
 
-        filter  = filters[rule.keys.first] || rule
+        filter = filters[rule.keys.first] || rule
         options = (rule.values.first || {}).merge(options)
 
         [filter, options]
@@ -58,7 +58,7 @@ module Normalizy
 
           unalias_for(rule_name).each do |unaliased_rule|
             filter, filter_options = extract_filter(unaliased_rule, rule_options, attribute)
-            result                 = extract_value(result, filter, filter_options, block)
+            result = extract_value(result, filter, filter_options, block)
           end
         end
 
@@ -75,36 +75,38 @@ module Normalizy
 
       def normalizy(*args, &block)
         options = args.extract_options!
-        rules   = options[:with]
+        rules = options[:with]
 
         self.normalizy_rules ||= {}
 
         args.each do |field|
           normalizy_rules[field] ||= []
-          normalizy_rules[field] << { block: block, options: options.except(:with), rules: rules }
+          normalizy_rules[field] << { block:, options: options.except(:with), 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
-              )
-
-              if rules.is_a?(Hash) && rules.dig(:slug, :to).present?
-                write_attribute rules.dig(:slug, :to), result
-
-                super value
-              else
-                super result
+        prepend(
+          Module.new do
+            args.each do |attribute|
+              define_method :"#{attribute}=" do |value|
+                result = normalizy!(
+                  attribute:,
+                  block:,
+                  options:   options.except(:with),
+                  rules:,
+                  value:
+                )
+
+                if rules.is_a?(Hash) && rules.dig(:slug, :to).present?
+                  write_attribute rules.dig(:slug, :to), result
+
+                  super(value)
+                else
+                  super(result)
+                end
               end
             end
           end
-        }
+        )
       end
     end
   end

data/lib/normalizy/filters/date.rb

@@ -14,11 +14,13 @@ module Normalizy
           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 = input.end_of_day if options[:adjust] == :end && input.respond_to?(:end_of_day)
 
           input
         rescue ArgumentError
-          options[:object].errors.add options[:attribute], error_message(input, options)
+          options[:object].errors.add(options[:attribute], error_message(input, options))
+
+          nil
         end
 
         private

data/lib/normalizy/filters/number.rb

@@ -8,7 +8,7 @@ module Normalizy
 
         value = input.gsub(/\D/, '')
 
-        return nil                        if value.blank?
+        return nil if value.blank?
         return value.send(options[:cast]) if options[:cast]
 
         value

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,10 +9,10 @@ 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}/), ''
+        input.gsub(/#{regex}/, '')
       end
     end
   end

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/rspec/matcher.rb

@@ -43,7 +43,7 @@ module Normalizy
 
           return false if options.blank?
 
-          options = default_rules if options.map { |option| option[:rules] }.compact.blank?
+          options = default_rules if options.filter_map { |option| option[:rules] }.blank?
 
           return false if options.blank?
 
@@ -98,6 +98,14 @@ module Normalizy
         @to.nil? ? :nil : %("#{@to}")
       end
 
+      def format_hash(hash)
+        pairs = hash.map do |k, v|
+          "#{k}: #{v.is_a?(Hash) ? format_hash(v) : v.inspect}"
+        end
+
+        "{#{pairs.join(', ')}}"
+      end
+
       def with_expected
         @with
       end
@@ -105,7 +113,7 @@ module Normalizy
       def with_value
         options = @subject.class.normalizy_rules[@attribute]
 
-        return :nil            if options.nil?
+        return :nil if options.nil?
         return %("#{options}") if options.blank?
 
         result = options.map do |option|
@@ -113,7 +121,7 @@ module Normalizy
 
           return :nil if rules.nil?
 
-          rules.presence || %("#{rules}")
+          rules.is_a?(Hash) ? format_hash(rules) : rules.presence || %("#{rules}")
         end
 
         result.join ', '

data/lib/normalizy/version.rb

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

data/lib/normalizy.rb

@@ -17,4 +17,4 @@ require 'normalizy/config'
 require 'normalizy/extensions'
 require 'normalizy/rspec/matcher'
 
-ActiveRecord::Base.include Normalizy::Extension
+ActiveSupport.on_load(:active_record) { include Normalizy::Extension }

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: normalizy
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Washington Botelho
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-19 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -24,104 +23,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.1'
-- !ruby/object:Gem::Dependency
-  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: pry-byebug
-  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: rspec-rails
-  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: rubocop-performance
-  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: rubocop-rails
-  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: rubocop-rspec
-  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: sqlite3
-  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'
 description: Attribute normalizer for Rails.
 email: wbotelhos@gmail.com
 executables: []
@@ -146,13 +47,14 @@ 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
 homepage: https://github.com/wbotelhos/normalizy
 licenses:
 - MIT
-metadata: {}
-post_install_message:
+metadata:
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -167,8 +69,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
-signing_key:
+rubygems_version: 4.0.12
 specification_version: 4
 summary: Attribute normalizer for Rails.
 test_files: []