attribute_normalizer-extras 0.0.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 06c102320987edf49e01edf7ad800f760824e689
-  data.tar.gz: f2d9e5a093333c58fb1e28d4cd225ba7ebb752ac
+SHA256:
+  metadata.gz: c581c89805c67cd717dd67e74f96461667513783fe9c04d6500cd4845c5c9c65
+  data.tar.gz: 7c2a8604bb2dc440d3feb15d090c3c37f2fa455e0aea1743b5c064f067bdc3ed
 SHA512:
-  metadata.gz: a413ecb4057958a57dcefb9e561deff102d745b695b5903ce22d20327f92c637123969dda1e0ff8d6cb51b89d4d5b5cbc71e40c84691c3d95fb641ae470ff055
-  data.tar.gz: 565888fa99220bf84804cd9d3584220f7cfe00fdd70d95905c67b3846689204f9b8c88f9b4201a773b86e644e76213f780b61f304c644e9885a9ba7a8e0df879
+  metadata.gz: 3432b10ff2fc867edee4a4acf485743a684893c0942ee4fa7d600cbfd88494cc8d57deb1c277cb66922ec3905ffedf96100918c4fd06a8a754a6486f8bc1776c
+  data.tar.gz: ab1c3f3259115221928cd9a181b4a1e7ef1925b5bc494e424e97755fdd1b46335c751dc7f10f6827121650249beb06142e87cbaac18a1748cf913c5c15148c16

data/.github/workflows/main.yml

@@ -0,0 +1,14 @@
+name: Ruby
+on: [push,pull_request]
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: '2.7'
+        bundler-cache: true
+    - name: Run Tests
+      run: bundle exec rake

data/README.md

@@ -1,3 +1,5 @@
+[![Build Status](https://github.com/amaabca/attribute_normalizer-extras/actions/workflows/main.yml/badge.svg)](https://github.com/amaabca/attribute_normalizer-extras/actions/workflows/main.yml)
+
 # AttributeNormalizer::Extras
 
 Extra normalizers for the [attribute_normalizer](https://rubygems.org/gems/attribute_normalizer) gem

data/attribute_normalizer-extras.gemspec

@@ -6,8 +6,24 @@ require 'attribute_normalizer/extras/version'
 Gem::Specification.new do |spec|
   spec.name          = "attribute_normalizer-extras"
   spec.version       = AttributeNormalizer::Extras::VERSION
-  spec.authors       = ["Darko Dosenovic", "Michael van den Beuken", "Ruben Estevez", "Jordan Babe", "Mathieu Gilbert", "Ryan Jones", "Jonathan Weyermann"]
-  spec.email         = ["darko.dosenovic@ama.ab.ca", "michael.vandenbeuken@ama.ab.ca", "ruben.estevez@ama.ab.ca", "jordan.babe@ama.ab.ca", "mathieu.gilbert@ama.ab.ca", "ryan.jones@ama.ab.ca", "jonathan.weyermann@ama.ab.ca"]
+  spec.authors       = [
+    "Darko Dosenovic",
+    "Michael van den Beuken",
+    "Ruben Estevez",
+    "Jordan Babe",
+    "Mathieu Gilbert",
+    "Zoie Carnegie",
+    "Jesse Doyle"
+  ]
+  spec.email         = [
+    "darko.dosenovic@ama.ab.ca",
+    "michael.vandenbeuken@ama.ab.ca",
+    "ruben.estevez@ama.ab.ca",
+    "jordan.babe@ama.ab.ca",
+    "mathieu.gilbert@ama.ab.ca",
+    "zoie.carnegie@ama.ab.ca",
+    "jesse.doyle@ama.ab.ca"
+  ]
   spec.summary       = %q{attribute_normalizer gem extras}
   spec.description   = %q{Specific normalizers that we commonly use in our apps}
   spec.homepage      = ""
@@ -18,13 +34,12 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "pry", "~> 0.10"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "pry"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "rspec-instafail"
   spec.add_development_dependency "simplecov"
 
   spec.add_runtime_dependency "attribute_normalizer", "~> 1.0"
 end
-

data/lib/attribute_normalizer/extras/version.rb

@@ -1,5 +1,5 @@
 module AttributeNormalizer
   module Extras
-    VERSION = "0.0.1"
+    VERSION = "0.2.0"
   end
 end

data/lib/attribute_normalizer/extras.rb

@@ -3,11 +3,17 @@ require "attribute_normalizer/extras/version"
 require "attribute_normalizer/normalizers/gsub_normalizer"
 require "attribute_normalizer/normalizers/spaceless_normalizer"
 require "attribute_normalizer/normalizers/postal_code_normalizer"
+require "attribute_normalizer/normalizers/float_normalizer"
+require "attribute_normalizer/normalizers/downcase_normalizer"
+require "attribute_normalizer/normalizers/upcase_normalizer"
 
 extras = {
- gsub:  AttributeNormalizer::Normalizers::GsubNormalizer,
- postal_code: AttributeNormalizer::Normalizers::PostalCodeNormalizer,
- spaceless: AttributeNormalizer::Normalizers::SpacelessNormalizer
+  gsub:  AttributeNormalizer::Normalizers::GsubNormalizer,
+  postal_code: AttributeNormalizer::Normalizers::PostalCodeNormalizer,
+  spaceless: AttributeNormalizer::Normalizers::SpacelessNormalizer,
+  float: AttributeNormalizer::Normalizers::FloatNormalizer,
+  downcase: AttributeNormalizer::Normalizers::DowncaseNormalizer,
+  upcase: AttributeNormalizer::Normalizers::UpcaseNormalizer
 }
 
 AttributeNormalizer.configuration.normalizers.merge! extras

data/lib/attribute_normalizer/normalizers/downcase_normalizer.rb

@@ -0,0 +1,9 @@
+module AttributeNormalizer
+  module Normalizers
+    module DowncaseNormalizer
+      def self.normalize(value, options = {})
+        options.fetch(:allow_nil, true) ? value&.downcase : value.to_s.downcase
+      end
+    end
+  end
+end

data/lib/attribute_normalizer/normalizers/float_normalizer.rb

@@ -0,0 +1,69 @@
+module AttributeNormalizer
+  module Normalizers
+    # Accept an input value of various types and coerce it into a float.
+    #
+    # Valid types for coersion are: String, Numeric, and NilClass.
+    #
+    # = Options
+    # allow_blank::
+    #   Will not attempt to coerce nil or '' to a float if this evaluates to a
+    #   truthy value. DEFAULT: false
+    #
+    # = Notes
+    #   This normalizer does not handle negative values, or perform any rounding
+    #
+    # = Usage
+    # AttributeNormalizer::Normalizers::FloatNormalizer.normalize('$1,500.00')
+    module FloatNormalizer
+      DEFAULTS = {
+        blank: false
+      }.freeze
+
+      class << self
+        def normalize(value, opts = {})
+          case value
+          when String
+            handle_string(value, opts)
+          when Numeric
+            value.to_f
+          when NilClass
+            handle_nil(opts)
+          else
+            invalid_type!(value)
+          end
+        end
+
+        private
+
+        def handle_string(value, opts = {})
+          if opts.fetch(:allow_blank, DEFAULTS[:blank]) && blank?(value)
+            value
+          else
+            # Strip all characters except digits or '.'.
+            # Be warned that this will coerce '' or nil to 0.00.
+            # Use allow_blank: true if you don't want this behaviour.
+            value.gsub(/[^\d.]/, '').to_f
+          end
+        end
+
+        def handle_nil(opts = {})
+          if opts.fetch(:allow_blank, DEFAULTS[:blank])
+            nil
+          else
+            nil.to_f
+          end
+        end
+
+        def invalid_type!(value)
+          raise ArgumentError, "must pass a Numeric or a String, got: #{value.class}"
+        end
+
+        # This gem doesn't have a dependency on ActiveSupport - I'd rather not add
+        # the dependency just for String#blank?.
+        def blank?(value)
+          value.nil? || value.empty?
+        end
+      end
+    end
+  end
+end

data/lib/attribute_normalizer/normalizers/postal_code_normalizer.rb

@@ -2,7 +2,9 @@ module AttributeNormalizer
   module Normalizers
     module PostalCodeNormalizer
       def self.normalize(value, options)
-        GsubNormalizer.normalize value, pattern: /\W+|_/, replacement: ''
+        if value
+          GsubNormalizer.normalize value.upcase, pattern: /\W+|_/, replacement: ''
+        end
       end
     end
   end

data/lib/attribute_normalizer/normalizers/upcase_normalizer.rb

@@ -0,0 +1,9 @@
+module AttributeNormalizer
+  module Normalizers
+    module UpcaseNormalizer
+      def self.normalize(value, options = {})
+        options.fetch(:allow_nil, true) ? value&.upcase : value.to_s.upcase
+      end
+    end
+  end
+end

data/spec/models/downcase_normalizer_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe AttributeNormalizer::Normalizers::DowncaseNormalizer do
+
+  describe '.normalizer' do
+    it 'downcase a string' do
+      normalized_text = subject.normalize "I AM big STRING"
+      expect(normalized_text).to eq "i am big string"
+    end
+  end
+end

data/spec/models/float_normalizer_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+
+describe AttributeNormalizer::Normalizers::FloatNormalizer do
+  describe '#normalize' do
+    let(:normalized) { described_class.normalize(value, opts) }
+
+    context 'with an Integer' do
+      let(:value) { 2 }
+      let(:opts) { Hash.new }
+
+      it 'returns a float' do
+        expect(normalized).to eq(2.0) # be careful: 2 == 2.to_f
+        expect(normalized).to be_a(Float)
+      end
+    end
+
+    context 'with nil' do
+      let(:value) { nil }
+
+      context 'with allow_blank: false' do
+        let(:opts) { { allow_blank: false } }
+
+        it 'returns nil.to_f (0.00)' do
+          expect(normalized).to eq(nil.to_f)
+        end
+      end
+
+      context 'with allow_blank: true' do
+        let(:opts) { { allow_blank: true } }
+
+        it 'returns nil' do
+          expect(normalized).to be nil
+        end
+      end
+    end
+
+    context 'with a String' do
+      let(:value) { '$1,500.01' }
+      let(:opts) { Hash.new }
+
+      it 'strips out invalid characters' do
+        expect(normalized).to eq(1500.01)
+      end
+    end
+
+    context 'with an empty String' do
+      let(:value) { '' }
+
+      context 'with allow_blank: false' do
+        let(:opts) { { allow_blank: false } }
+
+        it 'returns "".to_f (0.00)' do
+          expect(normalized).to eq(''.to_f)
+        end
+      end
+
+      context 'with allow_blank: true' do
+        let(:opts) { { allow_blank: true } }
+
+        it 'returns the empty string' do
+          expect(normalized).to eq('')
+        end
+      end
+    end
+
+    context 'with an invalid type' do
+      let(:value) { Array.new }
+      let(:opts) { Hash.new }
+
+      it 'raises ArgumentError' do
+        expect{ normalized }.to raise_error(ArgumentError)
+      end
+    end
+  end
+end

data/spec/models/postal_code_normalizer_spec.rb

@@ -14,6 +14,15 @@ describe AttributeNormalizer::Normalizers::PostalCodeNormalizer do
     it 'removes whitespace' do
       expect(subject.normalize " T1T 1T1 ", {}).to eq "T1T1T1"
     end
+
+    it 'upcases lowercase text' do
+      expect(subject.normalize "t6h1v2", {}).to eq "T6H1V2"
+    end
+
+    it 'returns nil if value is nil' do
+      expect(subject.normalize nil, {}).to be_nil
+    end
+
   end
 
 end

data/spec/models/uppercase_normalizer_spec.rb

@@ -0,0 +1,11 @@
+require 'spec_helper'
+
+describe AttributeNormalizer::Normalizers::UpcaseNormalizer do
+
+  describe '.normalizer' do
+    it 'upcase a string' do
+      normalized_text = subject.normalize "i AM big StrINg"
+      expect(normalized_text).to eq "I AM BIG STRING"
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: attribute_normalizer-extras
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Darko Dosenovic
@@ -9,109 +9,109 @@ authors:
 - Ruben Estevez
 - Jordan Babe
 - Mathieu Gilbert
-- Ryan Jones
-- Jonathan Weyermann
-autorequire: 
+- Zoie Carnegie
+- Jesse Doyle
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-07-30 00:00:00.000000000 Z
+date: 2021-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: 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: rspec-instafail
   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: simplecov
   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: attribute_normalizer
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
 description: Specific normalizers that we commonly use in our apps
@@ -121,14 +121,14 @@ email:
 - ruben.estevez@ama.ab.ca
 - jordan.babe@ama.ab.ca
 - mathieu.gilbert@ama.ab.ca
-- ryan.jones@ama.ab.ca
-- jonathan.weyermann@ama.ab.ca
+- zoie.carnegie@ama.ab.ca
+- jesse.doyle@ama.ab.ca
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".github/workflows/main.yml"
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -136,39 +136,47 @@ files:
 - attribute_normalizer-extras.gemspec
 - lib/attribute_normalizer/extras.rb
 - lib/attribute_normalizer/extras/version.rb
+- lib/attribute_normalizer/normalizers/downcase_normalizer.rb
+- lib/attribute_normalizer/normalizers/float_normalizer.rb
 - lib/attribute_normalizer/normalizers/gsub_normalizer.rb
 - lib/attribute_normalizer/normalizers/postal_code_normalizer.rb
 - lib/attribute_normalizer/normalizers/spaceless_normalizer.rb
+- lib/attribute_normalizer/normalizers/upcase_normalizer.rb
+- spec/models/downcase_normalizer_spec.rb
+- spec/models/float_normalizer_spec.rb
 - spec/models/gsub_normalizer_spec.rb
 - spec/models/postal_code_normalizer_spec.rb
 - spec/models/spaceless_normalizer_spec.rb
+- spec/models/uppercase_normalizer_spec.rb
 - spec/spec_helper.rb
 homepage: ''
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.0.0
-signing_key: 
+rubygems_version: 3.2.33
+signing_key:
 specification_version: 4
 summary: attribute_normalizer gem extras
 test_files:
+- spec/models/downcase_normalizer_spec.rb
+- spec/models/float_normalizer_spec.rb
 - spec/models/gsub_normalizer_spec.rb
 - spec/models/postal_code_normalizer_spec.rb
 - spec/models/spaceless_normalizer_spec.rb
+- spec/models/uppercase_normalizer_spec.rb
 - spec/spec_helper.rb

data/.travis.yml

@@ -1,3 +0,0 @@
-language: ruby
-rvm:
-  - 2.0.0