validate_args 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8fecd8695811758e2dbd45d7814e361df8cb1d4e
+  data.tar.gz: 46ec88c290e91eae7d644a385a47ed95da384371
+SHA512:
+  metadata.gz: 1bbfd63e9bd84ee890e52ca6d89b5b37fa73d83e9cb1262a6d79b62fe9196bac1fa3574b3cf724d2c4110a472aa04ec5404814440fb11c2b17c4e0bccf67e8fd
+  data.tar.gz: 8ac4353e80ce1bff1aff1621ce4e19a864a35f66995c235446383d2028bdb3a945eb9b619e15e67c900edd7bc606ffee488c866ea60ec3abe4be8ad6d76c5a36

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gem 'byebug'
+gem 'benchmark-ips'
+gem 'rubype'
+# Specify your gem's dependencies in validate_args.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Nobuhiro Nikushi
+
+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,136 @@
+# ValidateArgs
+
+ValidateArgs allows you to specify validations for method arguments, using `validate_args` to supply validation rules of a hash or array. Validations you declared would be called automatically before method calls.
+
+The syntax of validation rules is the same as shyouhei's [data-validator](https://github.com/shyouhei/data-validator) because ValidateArgs dispatches rules and validations to data-validator internally.
+
+## Example
+
+### Basic usages
+
+```ruby
+require 'validate_args'
+
+class MyClass
+
+  extend ValidateArgs
+
+  validate_args :do_something, 'foo' => Numeric
+  def do_something(params)
+    return params
+  end
+
+end
+
+# pass validation
+MyClass.new.do_something('foo' => 42) 
+# => {"foo"=>42}
+
+# pass
+MyClass.new.do_something('foo' => 0, 'baz' => 42, 'qux' => 100) 
+# => {"foo"=>0, "baz"=>42, "qux"=>100}
+
+# validation failure
+MyClass.new.do_something('foo' => 'string') 
+# => ValidateArgs::ArgumentTypeError: for MyClass#do_something's 1st argument is invalid => foo:type mismatch
+
+# validation failure
+MyClass.new.do_something('bar' => 1) 
+# => ValidateArgs::ArgumentTypeError: for MyClass#do_something's 1st argument is invalid => ["foo"] missing
+```
+
+### Complex cases
+
+```ruby
+require 'validate_args'
+
+class MyClass
+
+  extend ValidateArgs
+
+  validate_args :do_something, {
+    'foo' => { isa: Numeric, default: 99 },
+    'bar' => { isa: Numeric, default: lambda {|validator, rule, args| args['foo'] + 1 } },
+    'baz' => { isa: String, optional: true }
+  }
+  def do_something(params)
+    return params
+  end
+end
+
+# pass
+MyClass.new.do_something('foo' => 1, 'bar' => 2)
+# => {"foo"=>1, "bar"=>2}
+
+
+# pass (`bar` is calculated)
+MyClass.new.do_something('foo' => 5)
+# => {"foo"=>5, "bar"=>6}
+```
+
+### non hash arguments
+
+```ruby
+require 'validate_args'
+
+class MyClass
+
+  extend ValidateArgs
+
+  validate_args :sum, [Numeric, Numeric]
+  def sum(x, y)
+    x + y
+  end
+
+end
+
+# pass 
+MyClass.new.sum(1, 2)   
+# => 3
+
+# validation failure
+MyClass.new.sum(1, 'a')
+# => ValidateArgs::ArgumentTypeError: for MyClass#sum's 2nd argument is invalid => type mismatch
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'validate_args'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install validate_args
+
+## Similar gems
+
+* [data-validator](https://github.com/shyouhei/data-validator)
+  * ValidateArgs just wraps it to provide `validate_args` class method as DSL.
+* [Rubype](https://github.com/gogotanaka/Rubype)
+  * Rubype is super cool gem!
+  * Rubype does not validate values of given hashes because it focuses on checking classes of given args.
+  * Rubype is faster than ValidateArgs
+  * Rubype can check return value, but ValidateArgs does not for now. (patches are welcome though!)
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/[USERNAME]/validate_args.
+
+
+## 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,161 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+#  Benchmark
+#-----------------------------------------------
+desc "Compare with pure ruby and rubype"
+task :benchmark do
+  require "benchmark/ips"
+  require "validate_args"
+  require "validate_args/version"
+  require 'rubype'
+  require 'rubype/version'
+
+  puts "ruby version: #{RUBY_VERSION}"
+  class PureClass
+    def sum(x, y)
+      x + y
+    end
+  end
+  pure_instance = PureClass.new
+
+  puts "validate_args version: #{ValidateArgs::VERSION}"
+  class ValidateArgsClass
+    extend ValidateArgs
+    validate_args :sum, [Numeric, Numeric]
+    def sum(x, y)
+      x + y
+    end
+  end
+  validate_args_instance = ValidateArgsClass.new
+
+  puts "rubype version: #{Rubype::VERSION}"
+  class RubypeClass
+    def sum(x, y)
+      x + y
+    end
+    typesig :sum, [Numeric, Numeric] => Numeric
+  end
+  rubype_instance = RubypeClass.new
+
+
+  Benchmark.ips do |x|
+    x.report('Pure Ruby') { pure_instance.sum(4, 2) }
+    x.report('ValidateArgs') { validate_args_instance.sum(4, 2) }
+    x.report('Rubype') { rubype_instance.sum(4, 2) }
+
+    x.compare!
+  end
+end
+task bm: :benchmark
+
+#  Benchmark2 hash validation
+#-----------------------------------------------
+desc "Compare with pure ruby and rubype for hash validation"
+task :benchmark2 do
+  require "benchmark/ips"
+  require "validate_args"
+  require "validate_args/version"
+  require 'rubype'
+  require 'rubype/version'
+
+  puts "ruby version: #{RUBY_VERSION}"
+  class PureClass
+    def do_something(params = {})
+      params
+    end
+  end
+  pure_instance = PureClass.new
+
+  puts "validate_args version: #{ValidateArgs::VERSION}"
+  class ValidateArgsClass
+    extend ValidateArgs
+    validate_args :do_something, 'uri' => String
+    def do_something(params = {})
+      params
+    end
+  end
+  validate_args_instance = ValidateArgsClass.new
+
+  puts "rubype version: #{Rubype::VERSION}"
+  class RubypeClass
+    def do_something(params = {})
+      params
+    end
+    typesig :do_something, [Hash] => Hash
+  end
+  rubype_instance = RubypeClass.new
+
+  Benchmark.ips do |x|
+    x.report('Pure Ruby') { pure_instance.do_something('uri' => 'example.com') }
+    x.report('ValidateArgs') { validate_args_instance.do_something('uri' => 'example.com') }
+    x.report('Rubype') { rubype_instance.do_something('uri' => 'example.com') }
+
+    x.compare!
+  end
+end
+task bm2: :benchmark2
+
+#  Benchmark3 pure data-validator vs validate_args
+#-----------------------------------------------
+desc "Compare with pure data-validator and validate_args"
+task :benchmark3 do
+  require "benchmark/ips"
+  require "validate_args"
+  require "validate_args/version"
+  require 'data/validator'
+  require 'data/validator/version'
+
+  puts "data validator version: #{Data::Validator::VERSION}"
+  class DataValidatorClass
+    @@validator = Data::Validator.new('uri' => String)
+    def do_something(params = {})
+      @@validator.validate params
+    end
+  end
+  data_validator_instance = DataValidatorClass.new
+
+  puts "validate_args version: #{ValidateArgs::VERSION}"
+  class ValidateArgsClass
+    extend ValidateArgs
+    validate_args :do_something, 'uri' => String
+    def do_something(params = {})
+      params
+    end
+  end
+  validate_args_instance = ValidateArgsClass.new
+
+  Benchmark.ips do |x|
+    x.report('DataValidator') { data_validator_instance.do_something('uri' => 'example.com') }
+    x.report('ValidateArgs') { validate_args_instance.do_something('uri' => 'example.com') }
+
+    x.compare!
+  end
+end
+task bm3: :benchmark3
+
+desc "Memory growth test"
+task :mem_benchmark do
+  require "validate_args"
+  require "validate_args/version"
+  N = (ENV['N'] || 100_000).to_i
+
+  puts "validate_args version: #{ValidateArgs::VERSION}"
+  class Foo
+    extend ValidateArgs
+    validate_args :do_something, [Numeric, 'uri' => String]
+    def do_something(i, params)
+    end
+  end
+  N.times do |i|
+    Foo.new.do_something(1, 'uri' => 'example.com')
+    if (i%10_000) == 0
+      GC.start
+      p `ps -o rss= -p #{Process.pid}`.to_i
+    end
+  end
+end

data/bin/console

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

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

@@ -0,0 +1,19 @@
+module ValidateArgs
+  require "validate_args/version"
+  require "validate_args/error_printer"
+  require "validate_args/validators"
+
+  class ArgumentTypeError < StandardError; end
+
+  private
+
+  def __proxy__
+    @__proxy__ ||= Module.new.tap {|proxy| prepend proxy }
+  end
+
+  # Define DSL
+  def validate_args(meth, rules)
+    Validators.register_validator(self, meth, rules, __proxy__)
+    self
+  end
+end

data/lib/validate_args/error_printer.rb

@@ -0,0 +1,18 @@
+require 'validate_args/utils'
+
+module ValidateArgs
+  class ErrorPrinter
+    def initialize(owner, meth, errors)
+      @owner = owner
+      @meth = meth
+      @errors = errors
+    end
+
+    def to_s
+      @errors.zip(0..@errors.size).reject{|message, i| message.nil? }.map do |message, i|
+        "for #{@owner.class}##{@meth}'s #{Utils.ordinalize(i+1)} argument is invalid => #{message}"
+      end.join("\n")
+    end
+
+  end
+end

data/lib/validate_args/utils.rb

@@ -0,0 +1,19 @@
+# Borrowed from ActiveSupport::Inflector
+module ValidateArgs
+  module Utils
+    class << self
+      def ordinalize(number)
+        if (11..13).include?(number % 100)
+          "#{number}th"
+        else
+          case number % 10
+            when 1 then "#{number}st"
+            when 2 then "#{number}nd"
+            when 3 then "#{number}rd"
+            else        "#{number}th"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/validate_args/validators.rb

@@ -0,0 +1,42 @@
+require 'data/validator'
+require 'validate_args'
+
+module ValidateArgs
+  module Validators
+    @@validators = Hash.new({})
+
+    class << self
+
+      def register_validator(owner, meth, rules, __proxy__)
+        rules = [rules] unless rules.is_a? Array
+        @@validators[owner][meth] = rules.map {|rule| Data::Validator.new(rule) }
+        __proxy__.module_eval do
+          define_method(meth) do |*args|
+            ::ValidateArgs::Validators.validate!(self, meth, args)
+            super(*args)
+          end
+        end
+      end
+      
+      def get_validator(owner, meth)
+        @@validators[owner][meth]
+      end
+
+      def validate!(owner, meth, args)
+        rules = get_validator(owner, meth)
+        errors = []
+        rules.zip(args).each_with_index do |(rule, arg), i|
+          if rule and arg
+            begin
+              rule.validate(arg)
+            rescue ::Data::Validator::Error => e
+              errors[i] = e.message
+            end
+          end
+        end
+        raise ArgumentTypeError, ErrorPrinter.new(owner, meth, errors).to_s if !errors.empty?
+        true
+      end
+    end
+  end
+end

data/lib/validate_args/version.rb

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

data/validate_args.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'validate_args/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "validate_args"
+  spec.version       = ValidateArgs::VERSION
+  spec.authors       = ["Nobuhiro Nikushi"]
+  spec.email         = ["deneb.ge@gmail.com"]
+
+  spec.summary       = %q{Validation system for method arguments}
+  spec.description   = %q{It allows you to specify validations for method arguments, using `validate_args` to supply validation rules of a hash or array.}
+  spec.homepage      = "https://github.com/niku4i/validate_args"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  #if spec.respond_to?(:metadata)
+  #  spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  #else
+  #  raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  #end
+
+  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_dependency "data-validator"
+  spec.add_development_dependency "bundler", "~> 1.11"
+  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: validate_args
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nobuhiro Nikushi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: data-validator
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: It allows you to specify validations for method arguments, using `validate_args`
+  to supply validation rules of a hash or array.
+email:
+- deneb.ge@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/validate_args.rb
+- lib/validate_args/error_printer.rb
+- lib/validate_args/utils.rb
+- lib/validate_args/validators.rb
+- lib/validate_args/version.rb
+- validate_args.gemspec
+homepage: https://github.com/niku4i/validate_args
+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: Validation system for method arguments
+test_files: []