named_validations 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 451f3d677b38d83d61f4444559b06eadc0bec731
+  data.tar.gz: 112a67da0e1f00526f2b85b199c107f36811f688
+SHA512:
+  metadata.gz: 60e77c7abced8e985d1b96f17b5181110cffd5562cb90c67da113fe6ffe07292ff55156831dc6a874b78efaf90bfac06459fda2fbaa01a292c883fb6972393af
+  data.tar.gz: 45e054fde95322cc25f7f92548309390b7d4b4cd3a008c0df053eb7f3814a63d55020392d361b7bf6e5252b1f7d052d24a15210751f7f534d7e636810cc9e560

data/.gitignore

@@ -0,0 +1,94 @@
+# Created by https://www.gitignore.io/api/ruby,osx,vim,sublimetext
+
+### Ruby ###
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+
+### OSX ###
+*.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+
+### Vim ###
+# swap
+[._]*.s[a-w][a-z]
+[._]s[a-w][a-z]
+# session
+Session.vim
+# temporary
+.netrwhist
+*~
+# auto-generated tag files
+tags

data/.reek

@@ -0,0 +1,4 @@
+---
+SubclassedFromCoreClass:
+  exclude:
+  - NamedValidations

data/.rubocop.yml

@@ -0,0 +1,12 @@
+AllCops:
+  Exclude:
+    - named_validations.gemspec
+  DisplayCopNames: true
+  TargetRubyVersion: 2.3
+
+Metrics/ClassLength:
+  Exclude:
+    - test/*_test.rb
+
+Style/SingleLineBlockParams:
+  Methods: []

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+ruby '~> 2.3.1'
+source 'https://rubygems.org'
+gemspec
+
+gem 'test-unit', '~> 3.2'
+gem 'rubocop'
+gem 'reek'
+gem 'simplecov'
+gem 'yard'
+gem 'pry'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 akira yamada
+
+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,168 @@
+# NamedValidations
+
+NamedValidations defines aliases for a set of validations for ActiveModel's `validates` method.
+
+Example:
+
+```ruby
+class CommonValidations < NamedValidations
+  define :required, :presence, true
+  define :short_text, :length, maximum: 100
+  define :long_text, :length, maximum: 5_000
+  define :formatted_text, :format,
+    with: /\A(?:[^:[:space:]]+:[^\n]*(\n\s+[^\n]*)*\n)*\z/,
+    allow_blank: true
+  define :formatted_long_text do |*_args|
+    long_text.formatted_long_text
+  end
+end
+
+class Article < ApplicationRecord
+  base = CommonValidations.new
+  validates :title, base.short_text.required
+  validates :content, base.long_text(minmum: 100)
+  validates :meta, base.formatted_long_text
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'named_validations'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install named_validations
+
+## Usage
+
+### Simple alias (define-by-value)
+
+```ruby
+define :required, :presence, true
+```
+
+First argument is a name for the defining alias.
+Second argument is a validation name,
+and third argument is parameters for it.
+
+The above code defines new alias `:required`
+which is equal to `{ presence: true }`.
+
+Validation name can be any of defined aliases including your aliases.
+NamedValidations has pre-defined aliases such as:
+
+* `:absence`
+* `:acceptance`
+* `:associated`
+* `:confirmation`
+* `:exclusion`
+* `:format`
+* `:inclusion`
+* `:length`
+* `:numericality`
+* `:presence`
+* `:size`
+* `:uniqueness`
+
+Parameters is usually Boolean or Hash.
+
+```ruby
+define :short_text, :length, minimum: 5, maximum: 78
+```
+
+It is equal to `{ length: { minimum: 5, maximum: 78 } }`.
+
+### Using alias
+
+NamedValidations instance can receive a defined alias.
+
+Simple alias and pre-defined aliases can take one or more arguments.
+The argument is merged into return value of the alias.
+
+```ruby
+class Sample < NamedValidations
+  define :required, :presence, true
+end
+
+base.required                   # represents: { presence: true }
+base.required(false)            # represents: { presence: false }
+base.required(on: :create, ...) # represents: { presence: { on: :create, ... } }
+
+base.required(false, { on: :create, foo: :bar }, { on: :update })
+# represents: { presence: { on: :update, foo: :bar } }
+```
+
+Alias returns new NamedValidations instance.
+
+```ruby
+base = Sample.new # => #<Sample:0x3fe051053ec8>
+base.required     # => #<Sample:0x3fe0510132ec>
+```
+
+So you can chain aliases.
+
+```ruby
+base.length(maximum: 78).format(with: /@/)
+# represents: { length: { maximum: 78}, format: { with: /@/ } }
+
+vals = base.length(maximum: 78).length(minimum: 5)
+# represents: { length: { maximum: 78, minimum: 5 } }
+
+vals.length(maximum: 1_000)
+# represents: { length: { maximum: 1_000, minimum: 5 } }
+```
+
+### Complex alias (define-by-block)
+
+You can define more complex alias by using block.
+
+```ruby
+define :long_format_text do |arg = true, *args|
+  length(maximum: 1_000)
+  .format({ with: /@/ }, *args)
+  .presence(arg)
+end
+
+define :clear do |*opts|
+  Sample.new
+end
+```
+
+The block should return a new NamedValidations instance.
+
+Defined aliases can take some arguments
+according to the block arguments.
+
+### Defaults options
+
+NamedValidations has special alias `:defaults`.
+It applies default options for validations.
+
+```ruby
+validates :title, length(...).format(...).defaults(if: -> { ... })
+# same as:
+#   validates :title, length: { ... }, format: { ... }, if: -> { ... }
+```
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/arika/named\_validations.
+
+
+## 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,19 @@
+# frozen_string_literal: true
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rubocop/rake_task'
+require 'reek/rake/task'
+require 'yard'
+require 'yard/rake/yardoc_task'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+RuboCop::RakeTask.new
+Reek::Rake::Task.new
+YARD::Rake::YardocTask.new
+
+task default: %i(test rubocop reek)

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'named_validations'
+
+# 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.
+
+require 'pry'
+Pry.start

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/named_validations.rb

@@ -0,0 +1,124 @@
+# frozen_string_literal: true
+require 'named_validations/version'
+
+# Naming to ActiveModel/ActiveRecord validations
+class NamedValidations < Hash
+  # Reserved names
+  RESERVED = %i(
+    extractable_options?
+    class inspect
+    merge deep_merge
+    deep_merge_internal
+  ).freeze
+  private_constant :RESERVED
+
+  class << self
+    # @overload define(name, validation, params)
+    #   Defines a new simple alias (define-by-value)
+    #   @param name [Symbol] new alias name
+    #   @param validation [Symbol] validation name or defined alias name
+    #   @param params [Object] parameters or arguments for validation
+    # @overload define(name, block)
+    #   Defines a new alias by block (define-by-block)
+    #   @param name [Symbol] new alias name
+    #   @param block [Proc] body of alias
+    def define(name, *spec, &block)
+      raise ArgumentError, "reserved name #{name}" if RESERVED.include?(name)
+      return define_by_block(name, block) if spec.empty?
+
+      validation, params, = spec
+      define_by_value(name, validation, params)
+    end
+
+    # Returns list of defined alias names
+    # @return [Array<Symbol>]
+    def aliases
+      @aliases ||= []
+    end
+
+    private
+
+    def inherited(sub_class)
+      # Merge defined alias names list
+      aliases.each { |name| sub_class.aliases << name }
+    end
+
+    def define_by_block(name, block)
+      define_method(name, block)
+      aliases << name
+      name
+    end
+
+    def define_by_value(name, validation, params)
+      raise ArgumentError,
+            "unknown alias #{name}" unless aliases.include?(validation)
+
+      block = -> (*opts) { public_send(validation, params, *opts) }
+      define_by_block(name, block)
+    end
+
+    # Defines aliases for ActiveModel/ActiveRecord validations
+    # @!macro attach define_for
+    #   Apply `$1` to `self` and return a new object
+    #   @!method $1(arg, *opts)
+    #   @return [NamedValidations]
+    def define_for(name)
+      define(name) { |arg, *opts| deep_merge(name, arg, *opts) }
+    end
+  end
+
+  define_for :absence
+  define_for :confirmation
+  define_for :format
+  define_for :inclusion
+  define_for :numericality
+  define_for :acceptance
+  define_for :exclusion
+  define_for :length
+  define_for :presence
+  define_for :uniqueness
+  define_for :associated
+  define_for :size
+
+  # Defines an alias for default options
+  define(:defaults) { |default_opts| merge(default_opts) }
+
+  # Returns true
+  #
+  # @note This method is needed for ActiveSupport `Hash#extract_options!`.
+  def extractable_options?
+    true
+  end
+
+  # Inspects self
+  def inspect
+    klass = self.class
+    class_name = klass.name ||
+                 Kernel.format('(Anonymous:0x%x)', klass.object_id)
+    Kernel.format('#<%s:0x%x>', class_name, object_id)
+  end
+
+  protected
+
+  # Returns a new object containing the given validations
+  # and the current validations.
+  def deep_merge(validation, params, *opts)
+    new_obj = deep_merge_internal(validation, params)
+    opts.inject(new_obj) { |obj, opt| obj.deep_merge(validation, opt) }
+  end
+
+  private
+
+  def deep_merge_internal(validation, params)
+    cur_params = self[validation]
+    if !params.is_a?(Hash) || !cur_params.is_a?(Hash)
+      new_params = params
+    else
+      new_params = params.inject(cur_params) do |hash, (key, value)|
+        hash.merge(key => value)
+      end
+    end
+
+    merge(validation => new_params)
+  end
+end

data/lib/named_validations/version.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+class NamedValidations < Hash
+  VERSION = '0.1.0'
+end

data/named_validations.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'named_validations/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'named_validations'
+  spec.version       = NamedValidations::VERSION
+  spec.authors       = ['akira yamada']
+  spec.email         = ['akira@arika.org']
+
+  spec.summary       = 'Naming to ActiveModel/ActiveRecord validations'
+  spec.description   = 'named_validations names to arguments of active_model\'s validates method.'
+  spec.homepage      = 'https://github.com/arika/named_validations'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 11.0'
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: named_validations
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- akira yamada
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-06-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.0'
+description: named_validations names to arguments of active_model's validates method.
+email:
+- akira@arika.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".reek"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/named_validations.rb
+- lib/named_validations/version.rb
+- named_validations.gemspec
+homepage: https://github.com/arika/named_validations
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Naming to ActiveModel/ActiveRecord validations
+test_files: []
+has_rdoc: