nullify_empty 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: '0459d74924231eed6419005c311ce8f2b196a7dd'
+  data.tar.gz: 0fc1c50cfe4d7489fe7be439521c53325905d747
+SHA512:
+  metadata.gz: 49fec594d8545501ddfb798b36d5b899340f27ee20766421676aa00ea9b0134047917b34a338ddb33d687657aab909e043a7cd87e92875d3f7772bd09b1b2747
+  data.tar.gz: 140cb8a4966a48a33b25af469a2f51c8b48cb5230cf12714b4fe4327a6fb1e149641f0e688d1002650d00961efcb1e4d181e349f71fd3ec083c6a90d0f696dc2

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.4

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in nullify_empty.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Anton Chumakov
+
+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,58 @@
+# NullifyEmpty
+
+This gem allows to store string or text attributes as NULL in DB if they have empty values.
+It is very useful when you need to avoid `""` values coming from blank form inputs or anywhere else to be stored in DB.
+
+Having empty values in DB is not allowed when there is unique constraint on the column or uniqueness validation on the field, while presence of the values is not required. Unique constraint ignores nulls in most DBMS.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nullify_empty'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install nullify_empty
+
+## Usage
+
+Use `nullify_empty` method in the model to specify attributes that must not have empty values stored as empty strings in DB:
+
+``` ruby
+class User < ApplicationRecord
+  nullify_empty :email, :phone
+end
+```
+
+
+``` ruby
+params = {email: "", phone: "", ...}
+user = User.create(params) # => #<User id: 1, email: nil, phone: nil, ... > 
+
+user.email = ""
+user.email # => nil
+
+user.update(email: "")
+user.email # => nil
+
+user.update_column :email, ""
+user.email # => nil
+
+```
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/nullify_empty. 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](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "nullify_empty"
+
+# 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/nullify_empty/active_record_extension.rb

@@ -0,0 +1,14 @@
+module NullifyEmpty
+  module ActiveRecordExtension
+    def nullify_empty(*attr_names)
+      attr_names.each do |attr_name|
+        original_type_klass = attribute_types[attr_name.to_s].class
+
+        new_type_klass = 
+          NULLIFY_EMPTY_TYPES.find { |_, klass| klass.superclass == original_type_klass }.first
+
+        attribute attr_name, new_type_klass
+      end
+    end
+  end
+end

data/lib/nullify_empty/types.rb

@@ -0,0 +1,16 @@
+module NullifyEmpty
+  class NullifyEmptyStringType < ActiveRecord::Type::String; end
+  class NullifyEmptyTextType < ActiveRecord::Type::Text; end
+
+  NULLIFY_EMPTY_TYPES = {nullify_empty_string: NullifyEmptyStringType, 
+                         nullify_empty_text: NullifyEmptyTextType}
+  
+  NULLIFY_EMPTY_TYPES.values.each do |klass|
+    klass.class_eval do
+      def cast(value)
+        value = nil if value.respond_to?(:empty?) && value.empty?
+        super value
+      end    
+    end
+  end  
+end

data/lib/nullify_empty/version.rb

@@ -0,0 +1,3 @@
+module NullifyEmpty
+  VERSION = "0.1.0"
+end

data/lib/nullify_empty.rb

@@ -0,0 +1,11 @@
+require "nullify_empty/version"
+
+require "active_record"
+require "nullify_empty/types"
+require "nullify_empty/active_record_extension"
+
+NullifyEmpty::NULLIFY_EMPTY_TYPES.each do |symbol, klass|
+  ActiveRecord::Type.register(symbol, klass)
+end
+
+ActiveRecord::Base.extend NullifyEmpty::ActiveRecordExtension

data/nullify_empty.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "nullify_empty/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "nullify_empty"
+  spec.version       = NullifyEmpty::VERSION
+  spec.authors       = ["Anton Chumakov"]
+  spec.email         = ["anton@chumakoff.com"]
+
+  spec.summary       = "Store empty values as NULL in DB."
+  spec.description   = "This gem allows to ensure there are no empty strings in DB, but nulls."
+  spec.homepage      = "https://github.com/chumakoff/nullify_empty"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = spec.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  spec.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activerecord", ">= 4.0"
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: nullify_empty
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Anton Chumakov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-08-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: This gem allows to ensure there are no empty strings in DB, but nulls.
+email:
+- anton@chumakoff.com
+executables:
+- console
+- setup
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/nullify_empty.rb
+- lib/nullify_empty/active_record_extension.rb
+- lib/nullify_empty/types.rb
+- lib/nullify_empty/version.rb
+- nullify_empty.gemspec
+homepage: https://github.com/chumakoff/nullify_empty
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Store empty values as NULL in DB.
+test_files: []