validate_params 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 94d70008f263cf4fd0a16e5bdbc3a545694246fa
+  data.tar.gz: 22d7be0bbdfe6fa51115801a50c454fc914393c5
+SHA512:
+  metadata.gz: b62c9e214661c8f08ebacc5e42e66c503144e86eda408ec2bafdb7b35f578a1faca5833bdc46fddc6207ed2dc8270a56a8aec4295eb8db201f5b30a3fe3896a8
+  data.tar.gz: 770cff204a9634d12fd1d5abeeb653ee7e83595f0bdca266520ed32bedcef4d04b749ae589ed03b3fdacf69663c40446fe58605e1ffdf3177dda05a1c3eeede6

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 
+
+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/Rakefile

@@ -0,0 +1,34 @@
+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    = 'ValidateParams'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/tasks/validates_params_tasks.rake

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

data/lib/validate_params.rb

@@ -0,0 +1,7 @@
+require 'validate_params/core'
+
+module ValidateParams
+  def validate_params!(*args)
+    ValidateParams::Core.validate! params, args
+  end
+end

data/lib/validate_params/core.rb

@@ -0,0 +1,116 @@
+class InvalidParamsException < Exception; end
+
+class ValidateParams::Core
+  OPTIONS = %i(type default size cast in range regex custom).freeze
+  CAST_TYPES = %i(Integer Array Float).freeze
+
+  class << self
+    def validate!(params, args)
+      new(params, args)
+    end
+  end
+
+  def initialize(params, args)
+    @params = params
+    @args   = args
+
+    proceed
+  end
+
+  private
+
+  def proceed
+    @args.each do |arg|
+      case arg
+      when Symbol
+        validate_presence(arg)
+      when Hash
+        arg.each do |h|
+          validate_hash(h)
+        end
+      end
+    end
+  end
+
+  def validate_presence(key)
+    _raise("#{key} is not present") unless @params[key].present?
+  end
+
+  def validate_hash(hash)
+    key, value = hash
+
+    case value
+    when Class
+      validate_class(key, value)
+    when Hash
+      validate_presence(key) unless value.keys.include? :default
+
+      value.each do |opt_key, opt_value|
+        validate_option(key, opt_key, opt_value)
+      end
+    end
+  end
+
+  def validate_class(key, klass)
+    unless @params[key].is_a? klass
+      _raise("#{key} is not a #{klass}")
+    end
+  end
+
+  def validate_option(param, opt_key, opt_value)
+    unless OPTIONS.include? opt_key
+      raise TypeError.new("Option #{opt_key} is not valid")
+    end
+
+    case opt_key
+    when :type
+      validate_class(param, opt_value)
+    when :default
+      @params[param] = opt_value
+    when :cast
+      cast(param, opt_value)
+    when :size
+      unless @params[param].size == opt_value
+        _raise("#{param} size is not equal to #{opt_value}")
+      end
+    when :range
+      unless opt_value.include? @params[param].to_i
+        _raise("#{param} is not included in #{opt_value}")
+      end
+    when :in
+      unless opt_value.include? @params[param]
+        _raise("#{param} is not included in #{opt_value}")
+      end
+    when :regex
+      unless opt_value =~ @params[param]
+        _raise("#{param} does not match with #{opt_value}")
+      end
+    when :custom
+      unless opt_value.call @params[param]
+        _raise("#{param} does not match with #{opt_value}")
+      end
+    end
+  end
+
+  def cast(param, type)
+    unless CAST_TYPES.include? type
+      raise TypeError.new("Cast type #{type} is not valid")
+    end
+
+    @types ||= {
+      Integer: 0,
+      Array: [],
+      Float: 0.0
+    }.freeze
+
+    @params[param] = begin
+                       self.send(type, @params[param])
+                     rescue
+                       @types[type]
+                     end
+  end
+
+  def _raise(msg)
+    raise InvalidParamsException.new msg
+  end
+end

data/lib/validate_params/version.rb

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

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks

data/test/dummy/app/assets/javascripts/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/test/dummy/app/controllers/api/v1/examples_controller.rb

@@ -0,0 +1,59 @@
+class Api::V1::ExamplesController < ApplicationController
+  include ValidateParams
+
+  def create
+    params[:type] ||= 1
+    self.send("_#{params[:type]}")
+    render json: { example: params[:example] }
+  end
+
+  private
+
+  def _presence
+    validate_params! :example
+  end
+
+  def _presence_2
+    validate_params! :example, :example2
+  end
+
+  def _type
+    validate_params! example: Array
+  end
+
+  def _type_2
+    validate_params! example: { type: Array }
+  end
+
+  def _types
+    validate_params! example: Array, example2: String
+  end
+
+  def _type_and_size
+    validate_params! example: { type: Array, size: 2 }
+  end
+
+  def _range
+    validate_params! example: { range: 0..10 }
+  end
+
+  def _regex
+    validate_params! example: { regex: /myregex/ }
+  end
+
+  def _proc
+    validate_params! example: { custom: Proc.new { |value| value == 'a' } }
+  end
+
+  def _default
+    validate_params! example: { default: 'abc' }
+  end
+
+  def _in
+    validate_params! example: { in: %w(test1 test2) }
+  end
+
+  def _cast
+    validate_params! example: { cast: :Integer }
+  end
+end

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,9 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+
+  rescue_from InvalidParamsException do |exception|
+    render json: { error: exception.to_s }, status: 400
+  end
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track' => true %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track' => true %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application', __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/test/dummy/bin/setup

@@ -0,0 +1,29 @@
+#!/usr/bin/env ruby
+require 'pathname'
+
+# path to your application root.
+APP_ROOT = Pathname.new File.expand_path('../../',  __FILE__)
+
+Dir.chdir APP_ROOT do
+  # This script is a starting point to setup your application.
+  # Add necessary setup steps to this file:
+
+  puts "== Installing dependencies =="
+  system "gem install bundler --conservative"
+  system "bundle check || bundle install"
+
+  # puts "\n== Copying sample files =="
+  # unless File.exist?("config/database.yml")
+  #   system "cp config/database.yml.sample config/database.yml"
+  # end
+
+  puts "\n== Preparing database =="
+  system "bin/rake db:setup"
+
+  puts "\n== Removing old logs and tempfiles =="
+  system "rm -f log/*"
+  system "rm -rf tmp/cache"
+
+  puts "\n== Restarting application server =="
+  system "touch tmp/restart.txt"
+end

data/test/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment', __FILE__)
+run Rails.application

data/test/dummy/config/application.rb

@@ -0,0 +1,23 @@
+require File.expand_path('../boot', __FILE__)
+
+require 'action_controller/railtie'
+require 'rails/test_unit/railtie'
+
+Bundler.require(*Rails.groups)
+require "validate_params"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+  end
+end