parametron 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZWU4ODQyZTY0ZDczMTY5NzhmNWNhMWFhMTdiYjk5YmJmNGU4NThmOA==
+  data.tar.gz: !binary |-
+    ZTY4Mjg3NGFlYTZiZWZmYWEzMGM4NzljOGYyYmRjNmU4OTZiYzU0Yw==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NDhkNTg4NzRlOTc1ZTZlOWQ0ODc4MTc3ZTIwZjEyYzZhMGMxYTVlY2IzZGJi
+    MmYwOWIxZDhiMGE0YTJiOTgzNmQ2MjI0YTM0YTE1ZTYzZTAxYzgwMWZjN2Qz
+    ZDEwZDk0OTIzMzIwYjk1NjAzNzY5N2FmYWZmZWYzYTZlYmZmOTg=
+  data.tar.gz: !binary |-
+    NDkyMzJkMWNmNGJmMzlhNmRjMmQ5ODZiMTY0NTU4NDI3MTU1MDJkZjkzNzhi
+    N2UyNGY0MDBkMWRiMzJmMzViMWU4MDNiNjQyNDg3YzU2MTNmZTJjNjM2ZGI0
+    MzVlNjZjODI2MzlkOTJkNTdjY2M2NWRiZmQ3YTFiMzQ3NWQ3ZmE=

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in parametron.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Yury Batenko
+
+MIT License
+
+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,49 @@
+# Parametron
+
+This simple library implements DSL for validating method input parameters
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'parametron'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install parametron
+
+## Usage
+
+```ruby
+
+    class VictimStrict
+        include Parametron
+
+        params_for(:fetch, strict: true) do
+          required :city,   validator: /\w+/
+          required :year,   validator: /\d{4}/
+          optional :title,  validator: ->(str){ str != "Moscow" }
+          optional :number, validator: /\d+/, default: 42
+        end
+
+        def fetch params
+          # .. do something useful
+        end
+      end
+```
+
+See `spec/parametron_spec` how this library suppossed to work.
+All hackers do this and you should too!
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/lib/parametron/params_validator.rb

@@ -0,0 +1,87 @@
+class Parametron::ParamsValidator
+
+  attr_accessor :required_vals, :optional_vals
+
+  def initialize(opts)
+    @raise_on_excess = opts.fetch(:strict, false)
+    self.required_vals = []
+    self.optional_vals = []
+  end
+
+  def optional(name, opts={})
+    default   = opts.delete(:default)
+    validator = opts.delete(:validator)
+    raise Parametron::ErrorMethodParams.new("Not available param: #{opts.inspect}") unless opts.empty?
+    self.optional_vals << OptionalParameter.new(name.to_s, default, validator)
+  end
+
+  def required(name, opts={})
+    default   = opts.delete(:default)
+    validator = opts.delete(:validator)
+    raise Parametron::ErrorMethodParams.new("Not available param: #{opts.inspect}") unless opts.empty?
+    self.required_vals << RequiredParameter.new(name.to_s, default, validator)
+  end
+
+  def validate!(obj, params)
+    obj.validation_error_cause = []
+    normalized_param_keys = params.keys.map(&:to_s).sort
+    exceed_params = normalized_param_keys - valid_keys
+    if exceed_params.any?
+      exceed_params.each do |par|
+        obj.validation_error_cause << [par, params[par.to_sym]]
+      end
+      raise Parametron::ExcessParameter.new(exceed_params.to_s)  if @raise_on_excess
+    end
+
+    key_common = normalized_param_keys & required_keys
+    if key_common != required_keys
+      missing = required_keys - key_common
+      obj.validation_error_cause << missing
+      raise Parametron::RequiredParamError.new(missing)
+    end
+
+    params.each do |k, v|
+      key = k.to_s
+      next unless valid_keys.include?(key)
+      validators.find{|val| val.name == key}.tap do |curr_val|
+        unless curr_val.valid?(v)
+          obj.validation_error_cause << [key, v]
+          raise Parametron::MalformedParams.new(key)
+        end
+      end
+    end
+
+  end
+
+  private
+  def validators
+    self.required_vals + self.optional_vals
+  end
+
+  def valid_keys
+    validators.map{|x| x.name.to_s}.sort
+  end
+
+  def required_keys
+    self.required_vals.map{|x| x.name.to_s}
+  end
+
+  class GenericParameter < Struct.new(:name, :default, :validator)
+    def valid?(value)
+      case self.validator
+      when Regexp then value && !!self.validator.match(value.to_s)
+      when Proc then value && !!self.validator(value).call
+      else
+        true
+      end
+    end
+  end
+
+  class OptionalParameter < GenericParameter
+  end
+
+  class RequiredParameter < GenericParameter
+  end
+
+
+end

data/lib/parametron/version.rb

@@ -0,0 +1,3 @@
+module Parametron
+  VERSION = "0.0.1"
+end

data/lib/parametron.rb

@@ -0,0 +1,63 @@
+require "parametron/version"
+
+module Parametron
+
+  def self.included(base)
+    base.extend(ClassMethods)
+    base.send(:attr_accessor, :validation_error_cause)
+  end
+
+  module ClassMethods
+    attr_reader :params_validator
+    def params_for(method_name, opts={}, &block)
+      instance_eval do
+        @_method_name     = method_name.to_sym
+        @params_validator = Parametron::ParamsValidator.new(opts)
+        @params_validator.instance_eval(&block)
+      end
+    end
+
+    def method_added(name)
+      return if name != @_method_name or instance_variable_get(:"@_METHOD_#{name}_WRAPPED")
+      instance_variable_set(:"@_METHOD_#{name}_WRAPPED", true)
+      original = instance_method(name.to_sym)
+      remove_method(name.to_sym)
+      define_method(name) do |params|
+        new_params = _validate!(_set_defaults!(params))
+        original.bind(self).call(new_params)
+      end
+    end
+  end
+
+  private
+  def _set_defaults!(params)
+    new_par = params.dup
+    _validators_list.each do |v|
+      if new_par[v.name].nil? && new_par[v.name.to_sym].nil?
+        new_par[v.name.to_sym] = v.default if v.default
+      end
+    end
+    new_par
+  end
+
+  def _validate!(params)
+    _params_validator.validate!(self, params)
+    params
+  end
+
+  def _params_validator
+    self.class.params_validator
+  end
+
+  def _validators_list
+    _params_validator.required_vals + _params_validator.optional_vals
+  end
+
+  MalformedParams    = Class.new(ArgumentError)
+  RequiredParamError = Class.new(ArgumentError)
+  ErrorMethodParams  = Class.new(ArgumentError)
+  ExcessParameter    = Class.new(ArgumentError)
+
+end
+
+require 'parametron/params_validator'

data/parametron.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'parametron/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "parametron"
+  spec.version       = Parametron::VERSION
+  spec.authors       = ["Yury Batenko"]
+  spec.email         = ["jurbat@gmail.com"]
+  spec.description   = %q{DSL for method arguments validation}
+  spec.summary       = %q{DSL for method arguments validation}
+  spec.homepage      = "http://github.com/svenyurgensson/parametron"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version     = ">= 1.9"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+
+end

data/spec/parametron_spec.rb

@@ -0,0 +1,208 @@
+require 'spec_helper'
+
+describe Parametron do
+
+  context 'Params' do
+    context '.params' do
+      it 'accepts params block' do
+        expect do
+          class Victim
+            include Parametron
+            params_for(:_) do; end
+          end
+        end.not_to raise_error
+      end
+    end
+
+    context '.optional' do
+      it 'accepts optional params' do
+        expect do
+          class Victim
+            include Parametron
+            params_for(:_) do
+              optional :city, default: ''
+            end
+          end
+        end.not_to raise_error
+      end
+
+      it 'accepts defaults and validator params' do
+        expect do
+          class Victim
+            include Parametron
+            params_for(:_) do
+              optional :city, default: '', validator: /\d+/
+            end
+          end
+        end.not_to raise_error
+      end
+
+      it 'store params validator' do
+        class Victim
+          include Parametron
+          params_for(:_) do
+            optional :city, default: '', validator: /\d+/
+          end
+        end
+        Victim.params_validator.should be_kind_of(Parametron::ParamsValidator)
+        Victim.params_validator.required_vals.should be_empty
+        Victim.params_validator.optional_vals.should have(1).items
+      end
+
+    end # context .optional
+
+
+    context '.required' do
+      it 'accepts required params' do
+        expect do
+          class Victim
+            include Parametron
+            params_for(:_) do
+              required :city, default: ''
+            end
+          end
+        end.not_to raise_error
+      end
+
+      it 'accepts defaults and validator params' do
+        expect do
+          class Victim
+            include Parametron
+            params_for(:_) do
+              required :city, default: '', validator: /\d+/
+            end
+          end
+        end.not_to raise_error
+      end
+
+      it 'store params validator' do
+        class Victim
+          include Parametron
+          params_for(:_) do
+            required :city, default: '', validator: /\d+/
+          end
+        end
+        Victim.params_validator.should be_kind_of(Parametron::ParamsValidator)
+        Victim.params_validator.optional_vals.should be_empty
+        Victim.params_validator.required_vals.should have(1).items
+      end
+
+    end # context .required
+
+
+    context '.validate' do
+      class VictimStrict
+        include Parametron
+        params_for(:fetch, strict: true) do
+          required :city,  validator: /\w+/
+          required :year,  validator: /\d+/, default: 2012
+          optional :title, validator: /\w+/
+          optional :other, default: 'staff'
+        end
+        def fetch params
+        end
+      end
+      class VictimRelaxed
+        include Parametron
+        params_for(:fetch) do
+          required :city,  validator: /\w+/
+          required :year,  validator: /\d+/, default: 2012
+          optional :title, validator: /\w+/
+          optional :other, default: 'staff'
+        end
+        def fetch params
+        end
+      end
+
+      subject{ VictimStrict.new }
+
+      it 'accepts valid params' do
+        expect do
+          subject.fetch({city: 'Moskow', year: '1917', title: 'Nothing', other: 'Not need'})
+        end.not_to raise_error
+      end
+
+      it 'raise error when required param absent' do
+        expect do
+          subject.fetch({year: 1917, title: 'Nothing', other: 'Not need'})
+        end.to raise_error(Parametron::RequiredParamError)
+        subject.validation_error_cause.should eql [["city"]]
+      end
+
+
+      context "when strict" do
+        subject{ VictimStrict.new }
+
+        it 'raise on unknown params' do
+          expect do
+            subject.fetch({city: 'Moskow', year: 1917, title: 'Nothing', other: 'Not need', invalid: 'Yes'})
+          end.to raise_error(Parametron::ExcessParameter)
+          subject.validation_error_cause.should eql [["invalid", "Yes"]]
+        end
+      end # context strict
+
+      context "when not strict" do
+        subject{ VictimRelaxed.new }
+
+        it 'not raise on unknown params' do
+          expect do
+            subject.fetch({city: 'Moskow', year: 1917, title: 'Nothing', other: 'Not need', invalid: 'Yes'})
+          end.not_to raise_error
+          subject.validation_error_cause.should eql [["invalid", "Yes"]]
+        end
+      end # context not strict
+
+    end # context .validate
+
+    context 'setting defaults for parameters' do
+      class VictimWithDef
+        include Parametron
+        params_for(:fetch, strict: true) do
+          required :city,  validator: /\w+/
+          required :year,  validator: /\d+/, default: '2012'
+          optional :title, validator: /\w+/
+          optional :other,                   default: 'staff'
+        end
+        attr_reader :city, :year, :title, :other
+
+        def fetch params
+          @city = params[:city]
+          @year = params[:year]
+          @title= params[:title]
+          @other= params[:other]
+        end
+      end
+
+      let(:par){{city: 'Krasn', title: 'No way'}}
+      let(:par_full){{city: 'Krasn', year: '2000', title: 'No way', other: 'KillAll'}}
+
+     it 'accepts params' do
+        expect do
+          @obj = VictimWithDef.new
+          @obj.fetch(par)
+        end.not_to raise_error
+      end
+
+      it 'set defaults' do
+        @obj = VictimWithDef.new
+        @obj.fetch(par)
+        @obj.city.should  eql par[:city]
+        @obj.title.should eql par[:title]
+        @obj.year.should  eql '2012'
+        @obj.other.should eql 'staff'
+      end
+
+      it 'given params have advantage over defaults' do
+        @obj = VictimWithDef.new
+        @obj.fetch(par_full)
+        @obj.city.should  eql par_full[:city]
+        @obj.title.should eql par_full[:title]
+        @obj.year.should  eql par_full[:year]
+        @obj.other.should eql par_full[:other]
+      end
+    end
+
+
+  end # context Params
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'parametron'

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: parametron
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Yury Batenko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  name: bundler
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  name: rake
+- !ruby/object:Gem::Dependency
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  name: rspec
+description: DSL for method arguments validation
+email:
+- jurbat@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/parametron.rb
+- lib/parametron/params_validator.rb
+- lib/parametron/version.rb
+- parametron.gemspec
+- spec/parametron_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/svenyurgensson/parametron
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: DSL for method arguments validation
+test_files:
+- spec/parametron_spec.rb
+- spec/spec_helper.rb