activerecord-normalizations 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bb7d93cba49064fa20b5453e5124c018f1ffdd6520bc0cbd4bf54fc97cbb35c7
+  data.tar.gz: a5c16649bbfcca2abc18a8acd39fcceb598291598fbb6b2945c84fa9ab944353
+SHA512:
+  metadata.gz: 01646026f5ea34cff910dd0b5fad30c8369f84f1b57704c6f3ac961a68d017bba20283dd68592f51734776c48a83c4dc0dc5802cb17d8cd39386f0b33daa0289
+  data.tar.gz: c53c5988aec6e6114fab25467ca91bdba2c8ee0945015010b64d31b1a20804b746789c6faafdd78c34e1eadf1b229fa64ca4cf546681b80b6b06ffa1449d2136

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+.byebug_history
+/Gemfile.lock

data/.travis.yml

@@ -0,0 +1,17 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+env:
+  - "RAILS_VERSION=5.2.0"
+  - "RAILS_VERSION=6.0.0"
+  - "RAILS_VERSION=6.1.0"
+rvm:
+  - 2.6.5
+  - 2.7.2
+  - 3.0.0
+before_install: gem update bundler
+jobs:
+  exclude:
+  - rvm: 3.0.0
+    env: "RAILS_VERSION=5.2.0"

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+# CHANGELOG
+
+## 1.0.0
+  * Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at cocchi.c@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,18 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in activerecord-normalizations.gemspec
+gemspec
+
+rails_version = ENV['RAILS_VERSION'] || 'default'
+
+version = case rails_version
+when 'master'
+  { github: 'rails/rails' }
+when "default"
+  '~> 6.1.3'
+else
+  "~> #{rails_version}"
+end
+
+gem 'activerecord', version
+gem 'activesupport', version

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Christopher Cocchi-Perrier
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 ccocchi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,96 @@
+# ActiveRecord::Normalizations
+
+`ActiveRecord::Normalizations` gives you the possibility to transform, or normalize, your attributes before they are saved in your database. It behaves mostly like validations, applying normalizations in methods like `save` or `update` but being totally skipped when methods touching directly the database like `update_columns`.
+
+## Compatibility
+
+### Ruby
+
+Currently supported Ruby versions: MRI 2.5, 2.6, 2.7, 3.0.
+JRuby hasn't been tested but since it's purely Ruby, it should work fine with it.
+
+### Rails
+
+Any version of ActiveRecord >= 4.2. It is tested against AR 5.2, 6.0, 6.1
+
+## Installation
+
+```ruby
+gem 'activerecord-normalizations'
+```
+
+## Usage
+
+`ActiveRecord::Normalizations` is included in `ActiveRecord::Base` by default so you can directly use the `normalize` method in your models:
+
+```ruby
+class User
+  normalizes :firstname, spaces: true, text_transform: :capitalize
+end
+```
+
+The first argument is the attribute you want to normalize, and each subsequent option are the normalizers that are going to me applied to it, each with their option (much like ActiveRecord'd validations).
+
+## Normalizers
+
+The gem comes with the following normalizers:
+
+### Spaces
+
+Available mode: `:leading, :trailing, :both (default)`
+
+This normalizer removes leading, trailing or both spaces from your attribute. It uses Ruby's `strip` methods family under the hood.
+
+### TextTransform
+
+Available mode: `:capitalize, :lowercase, :uppercase, :word_capitalize`
+
+This normalizer transforms your string attribute per the given mode:
+
+* `capitalize`, `lowercase` and `uppercase` are pretty straight-forward and use Ruby's equivalent methods
+* `word_capitalize` will capitalize every word of a string, a word being 1 or more alpha characters. Useful when dealing with foreign names like `Jean-Michel` or `O'Connor`.
+
+## Custom Normalizer
+
+You can also define your own normalizers. They should be classes following the naming format `<option_name>Normalizer`, initialized with an options hash and responding to the `call` method with a single argument, the attribute to normalize.
+
+For example, if you wanted to reverse your attribute you could do create the following class
+
+```ruby
+# app/normalizers/reverse_normalizer.rb
+class ReverseNormalizer
+  def initialize(*args)
+  end
+
+  def call(attr)
+    attr.reverse
+  end
+end
+```
+
+then use it in your model like any other normalizer
+
+```ruby
+# app/models/user.rb
+class User < ApplicationRecord
+  normalizes :name, reverse: true
+end
+```
+
+You can check the [normalizers](https://github.com/ccocchi/activerecord-normalizations/tree/main/lib/activerecord-normalizations/normalizers) folder to see how included normalizers are done.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ccocchi/activerecord-normalizations. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ActiveRecord::Normalizations project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ccocchi/activerecord-normalizations/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/activerecord-normalizations.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "activerecord-normalizations/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "activerecord-normalizations"
+  spec.version       = ActiveRecord::Normalizations::VERSION
+  spec.authors       = ["ccocchi"]
+  spec.email         = ["cocchi.c@gmail.com"]
+
+  spec.summary       = "Normalize your ActiveRecord models' attributes"
+  spec.homepage      = "https://github.com/ccocchi/activerecord-normalizations"
+  spec.license       = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activerecord", ">= 4.2", "< 7"
+  spec.add_dependency "activesupport", ">= 4.2", "< 7"
+
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "activerecord-nulldb-adapter", "~> 0.7.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "activerecord/normalizations"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/activerecord-normalizations.rb

@@ -0,0 +1,2 @@
+require "activerecord-normalizations/version"
+require "activerecord-normalizations/railtie" if defined?(Rails)

data/lib/activerecord-normalizations/normalizations.rb

@@ -0,0 +1,83 @@
+require 'active_support/concern'
+
+module ActiveRecord::Normalizations
+  extend ActiveSupport::Concern
+
+  included do
+    class_attribute :_normalizers, instance_writer: false, default: Hash.new { |h, k| h[k] = [] }
+  end
+
+  SHARED_OPTIONS  = [:on, :if, :unless].freeze
+  DEFAULT_OPTIONS = {}.freeze
+
+  module ClassMethods
+    #
+    #   normalize :firstname, spaces: true, text_transform: :capitalize
+    #
+    def normalizes(attr, **normalizations)
+      attr_str = attr.to_s
+
+      normalizations.each do |key, options|
+        next unless options
+
+        key = "#{key.to_s.camelize}Normalizer"
+
+        begin
+          klass = key.include?("::") ? key.constantize : const_get(key)
+        rescue NameError
+          raise ArgumentError, "Unknown validator: '#{key}'"
+        end
+
+        normalizer = klass.new(_parse_normalizer_options(options))
+        _normalizers[attr_str] << normalizer
+      end
+    end
+
+    private
+
+    def _parse_normalizer_options(opts)
+      case opts
+      when TrueClass
+        DEFAULT_OPTIONS
+      when Hash
+        opts
+      when String, Symbol
+        { with: opts }
+      else
+        raise
+      end
+    end
+  end
+
+  def save(**options)
+    _perform_normalizations(options) if options[:validate] == false
+    super
+  end
+
+  def save!(**options)
+    _perform_normalizations(options) if options[:validate] == false
+    super
+  end
+
+  def valid?(*args)
+    _perform_normalizations(DEFAULT_OPTIONS)
+    super
+  end
+
+  private
+
+  def _perform_normalizations(options)
+    return if options[:normalize] == false
+
+    _normalizers.each do |attr, norms|
+      value = self[attr]
+
+      if value.present? && will_save_change_to_attribute?(attr)
+        self[attr] = norms.reduce(value) { |res, n| n.call(res) }
+      end
+    end
+  end
+end
+
+require "activerecord-normalizations/normalizers/spaces_normalizer"
+require "activerecord-normalizations/normalizers/text_transform_normalizer"

data/lib/activerecord-normalizations/normalizers/spaces_normalizer.rb

@@ -0,0 +1,29 @@
+module ActiveRecord::Normalizations
+  class SpacesNormalizer
+    VALID_TYPES = [:leading, :trailing, :both]
+
+    def initialize(options)
+      type = options[:with] || :both
+      raise ArgumentError, "#{type} must be one of #{VALID_TYPES}" if !VALID_TYPES.include?(type)
+
+      @method = determine_method(type)
+    end
+
+    def call(attr)
+      attr.send(@method)
+    end
+
+    private
+
+    def determine_method(type)
+      case type
+      when :leading
+        :lstrip
+      when :trailing
+        :rstrip
+      else
+        :strip
+      end
+    end
+  end
+end

data/lib/activerecord-normalizations/normalizers/text_transform_normalizer.rb

@@ -0,0 +1,26 @@
+module ActiveRecord::Normalizations
+  class TextTransformNormalizer
+    VALID_TRANSFORMATIONS = [:capitalize, :word_capitalize, :uppercase, :lowercase]
+
+    def initialize(options)
+      @transformation = options[:with]
+
+      if !VALID_TRANSFORMATIONS.include?(@transformation)
+        raise ArgumentError, "#{@transformation} must be one of #{VALID_TRANSFORMATIONS}"
+      end
+    end
+
+    def call(attr)
+      case @transformation
+      when :uppercase
+        attr.upcase
+      when :lowercase
+        attr.downcase
+      when :word_capitalize
+        attr.gsub(/[[:alpha:]]+/, &:capitalize)
+      else
+        attr.capitalize
+      end
+    end
+  end
+end

data/lib/activerecord-normalizations/railtie.rb

@@ -0,0 +1,11 @@
+require 'activerecord-normalizations/normalizations'
+
+module ActiveRecord::Normalizations
+  class Railtie < Rails::Railtie
+    config.after_initialize do |app|
+      ActiveSupport.on_load :active_record do
+        include ActiveRecord::Normalizations
+      end
+    end
+  end
+end

data/lib/activerecord-normalizations/version.rb

@@ -0,0 +1,5 @@
+module ActiveRecord
+  module Normalizations
+    VERSION = "1.0.0"
+  end
+end

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: activerecord-normalizations
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- ccocchi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-06-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: activerecord-nulldb-adapter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.7.0
+description: 
+email:
+- cocchi.c@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- activerecord-normalizations.gemspec
+- bin/console
+- bin/setup
+- lib/activerecord-normalizations.rb
+- lib/activerecord-normalizations/normalizations.rb
+- lib/activerecord-normalizations/normalizers/spaces_normalizer.rb
+- lib/activerecord-normalizations/normalizers/text_transform_normalizer.rb
+- lib/activerecord-normalizations/railtie.rb
+- lib/activerecord-normalizations/version.rb
+homepage: https://github.com/ccocchi/activerecord-normalizations
+licenses:
+- MIT
+metadata: {}
+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: []
+rubygems_version: 3.2.15
+signing_key: 
+specification_version: 4
+summary: Normalize your ActiveRecord models' attributes
+test_files: []