converters_before_validation 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 63341ad4fd640864f114a55de5f24fe4cf07f101f6f22c35186f4645c5f2576f
+  data.tar.gz: fd7f1da7981b581c8a7d7f291ec30e065dc49b04549429a27f94de727f2c9dea
+SHA512:
+  metadata.gz: 193c8a070e0b0ad3d0d30abc3260911b1269ae8f5d67d0fe181fb55396a5dcbc5ff3eee61d1727d889f2dfc3ac64ca6822540bfff38850e821bc10647bea778f
+  data.tar.gz: a02b046458b30bdf00339b99d8bbdeff4e93a6f997749822f3c6c3922be10f14da38e815c2d509f3272ce9dc021115280fbc13712069055bd8f52a940a5a7655

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 Kanaikin Slava
+
+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,116 @@
+# ConvertersBeforeValidation
+
+string_converter_before_validation adds before_validation callback, which apply necessary function to attributes.
+
+There are some derivatives: 
+
+* squish_before_validation_for
+* downcase_before_validation_for
+* upcase_before_validation_for
+
+## Usage
+
+Let we have model Article with some fields: author_name, contact_email, title, camel_tag.
+
+```ruby
+  # app/models/article.rb
+  class Article < ApplicationRecord
+
+    validates :contact_email, format: { with: /\A[^@\s]+@[^@\s]+\z/, message: "Not email format" }
+
+  end
+```
+
+Let's take fields' values from some not accurate input:
+
+```
+>> article = Article.new(author_name: '   Boss   ', contact_email: ' Boss@ExAmple.Org', title: ' hello ', camel_tag: 'hello_world')
+
+>> article.valid?
+=> false
+
+>> article.author_name
+=> '   Boss   '
+
+>> article.contact_email
+=> ' Boss@ExAmple.Org'
+
+>> article.title
+=> ' hello '
+
+>> article.camel_tag
+=> 'hello_world'
+
+```
+
+So, we can want to format values before save it to our base:  
+  contact_email = contact_email.squish.downcase  
+  author_name = author_name.squish  
+  title = title.squish.upcase  
+  camel_tag = camel_tag.camelcase
+
+This gem's functions are usefull for it. They add before_validation callbacks to model and do this job for us.
+
+```ruby
+  # app/models/article.rb
+  class Article < ApplicationRecord
+
+    downcase_before_validation_for :contact_email
+
+    squish_before_validation_for :author_name, :contact_email, :title
+
+    upcase_before_validation_for :title
+
+    # and another string function
+    string_converter_before_validation :camelcase, :camel_tag
+
+    validates :contact_email, format: { with: /\A[^@\s]+@[^@\s]+\z/, message: "Not email format" }
+
+  end
+```
+
+```
+>> article = Article.new(author_name: '   Boss   ', contact_email: ' Boss@ExAmple.Org', title: ' hello ', camel_tag: 'hello_world')
+
+>> article.valid?
+=> true
+
+>> article.author_name
+=> 'Boss'
+
+>> article.contact_email
+=> 'boss@example.org'
+
+>> article.title
+=> 'HELLO'
+
+>> article.camel_tag
+=> 'HelloWorld'
+
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+  gem 'converters_before_validation'
+```
+
+And then execute:
+
+```bash
+  bundle
+```
+
+Or install it yourself as:
+
+```bash
+  gem install converters_before_validation
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,27 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ConvertersBeforeValidation'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/converters_before_validation.rb

@@ -0,0 +1,48 @@
+module ConvertersBeforeValidation
+  ActiveSupport.on_load(:active_record) do
+    # Adds private callback before_validation, which apply necessary function
+    # to attributes.
+    #
+    # Usage:
+    #  string_converter_before_validation :camelcase, :field1, :field2, :field3
+    #
+    # Parameters:
+    # formatter_function::
+    #  Name of String functions: downcase, squish, upcase, camelcase, ...
+    #  (Example: 'camelcase', :camelcase, "camelcase")
+    #
+    # attributes_list::
+    #  List of attributes, which values will be converted with formatter_function.
+    def self.string_converter_before_validation(formatter_function, *attributes_list)
+      callback_name = "callback_converters_before_validation_string_#{formatter_function}"
+
+      before_validation callback_name.to_sym
+
+      class_eval(%(
+      def #{callback_name}
+      #{attributes_list.map { |aa| "    self.#{aa.to_s.squish} = #{aa.to_s.squish}.to_s.#{formatter_function};" }.join("\n")}
+      end
+      ))
+
+      private callback_name.to_s
+    end
+
+    # Usage:
+    #  downcase_before_validation_for :email, :login
+    def self.downcase_before_validation_for(*attributes_list)
+      string_converter_before_validation :downcase, *attributes_list
+    end
+
+    # Usage:
+    #  squish_before_validation_for :name, :surname, :email, :login
+    def self.squish_before_validation_for(*attributes_list)
+      string_converter_before_validation :squish, *attributes_list
+    end
+
+    # Usage:
+    #  upcase_before_validation_for :title
+    def self.upcase_before_validation_for(*attributes_list)
+      string_converter_before_validation :upcase, *attributes_list
+    end
+  end
+end

data/lib/converters_before_validation/version.rb

@@ -0,0 +1,3 @@
+module ConvertersBeforeValidation
+  VERSION = '0.1.1'
+end

data/lib/tasks/converters_before_validation_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :converters_before_validation do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: converters_before_validation
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Kanaikin Slava
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-07-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.0.rc1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.0.rc1
+- !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: 'Adds before_validation callback, which apply necessary function to attributes.
+  There are some derivatives: squish_before_validation_for, downcase_before_validation_for,
+  upcase_before_validation_for.'
+email:
+- sportix@gotar.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/converters_before_validation.rb
+- lib/converters_before_validation/version.rb
+- lib/tasks/converters_before_validation_tasks.rake
+homepage: https://github.com/slavik117/converters_before_validation
+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.0.1
+signing_key: 
+specification_version: 4
+summary: Formatters for ActiveRecord attributes by before_validation callback
+test_files: []