param_check 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d98a6fa8c72c459888f417ac75fe6a2f9ff5167a
-  data.tar.gz: 341fa70017a064a1b5046f21d2d7b1dd3697fd2a
+  metadata.gz: a9590fa4308abf4f64a13849ab47ad1dc8b68925
+  data.tar.gz: e857e2a0ac155531ca16253dc2d741b971e3f982
 SHA512:
-  metadata.gz: f9a92099a2944dbe2889ce787cbaacb1e65a46808967e738f8e03be5197e595ce3cb760d7ab3f79b7b2f29773be9b3b61a150903c57ef76e8c21f1186ea40671
-  data.tar.gz: f66096a368a3e10b300d1da425f988dbe9753fb498e6abf3cba26977b0646945540fec8305975fa7a35e1ccc39c9f1e75beb46991406cf7cb7a6f1c1b052a635
+  metadata.gz: de94c96397f07a7e6c331b421a0597c970b1e427dcd600c8b9748077da32f96ce41ffa7fbe5ed1ea4c3541320378d16fd7dfb8b2c9367fe8367449a1a1b1ba9a
+  data.tar.gz: 50a8a7ecf47a2afddcf592abb91083ef05bf4278bd14402157853450c9ca5eeef862c2607ed152dc3615661b78e357f8cbf13c35ab1f79167b2a964b32f9fa29

data/README.md

@@ -68,10 +68,15 @@ params[:foo] = {
 params[:foo] = 'bar'
 ```
 
-### Validating range
+### Validating numbers
+For number validation, you can use either the long hand keys `less_than` or the short hand `lt`
+
 ```ruby
 def index
-  param! :foo, min: 1, max: 3
+  param! :foo, lt: 2
+  param! :bar, lte: 3
+  param! :baz, mt: 4
+  param! :bazzy, mte: 5
 end
 ```
 
@@ -79,6 +84,8 @@ end
 ```ruby
 def index
   param! :foo, in: ['foo', 'bar']
+  param! :bar, in: 1..4
+  param! :baz, in: 'a'..'z'
 end
 ```
 
@@ -93,11 +100,21 @@ end
 ```
 
 ## Options
-| Option   | Type    | Default | Values                                         | Description                                |
-| -------- | ------- | ------- | ---------------------------------------------- | ------------------------------------------ |
-| required | Boolean | false   | true/false                                     | Is the parameter required?                 |
-| type     | Class   | nil     | Fixnum/Integer/String/ActionController::Params | Specifies the type the parameter should be |
-
+<<<<<<< HEAD
+| Option   | Type    | Default | Values                                               | Description                                         |
+| -------- | ------- | ------- | ---------------------------------------------------- | --------------------------------------------------- |
+| required | Boolean | false   | true/false                                           | Is the parameter required?                          |
+| type     | Class   | nil     | Fixnum/Integer/Float/String/ActionController::Params | Specifies the type the parameter should be          |
+| lt       | Integer | nil     | Integer/Float                                        | The parameter value should be less than             |
+| lte      | Integer | nil     | Integer/Float                                        | The parameter value should be less than or equal to |
+| mt       | Integer | nil     | Integer/Float                                        | The parameter value should be more than             |
+| mte      | Integer | nil     | Integer/Float                                        | The parameter value should be more than or equal to |
+| in       | Array   | nil     | Array                                                | An array of values the param should match           |
+
+## Production sites using this gem
+Submit a PR to add your site to the list
+
+[Givey](https://www.givey.com)
 
 ## Development
 

data/config/locales/en.yml

@@ -2,6 +2,8 @@ en:
   param_check:
     missing_required_parameter: "Missing required parameter: %{parameter}"
     invalid_parameter: "Parameter %{parameter} is invalid. Expected %{expected}, got %{got}"
-    invalid_minimum: "Parameter %{parameter} must be at least %{min}, got %{got}"
-    invalid_maximum: "Parameter %{parameter} must not be more than %{max}, got %{got}"
     invalid_inclusion: "Parameter %{parameter} is not in the list. Expected inclusion in %{expected}, got %{got}"
+    value_not_less_than: "Parameter %{parameter} should be less than %{expected}. Got %{got}"
+    value_not_less_than_equal_to: "Parameter %{parameter} should be less than or equal to %{expected}. Got %{got}"
+    value_not_more_than: "Parameter %{parameter} should be more than %{expected}. Got %{got}"
+    value_not_more_than_equal_to: "Parameter %{parameter} should be more than or equal to %{expected}. Got %{got}"

data/lib/param_check/version.rb

@@ -1,3 +1,3 @@
 module ParamCheck
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/param_check.rb

@@ -78,27 +78,46 @@ module ParamCheck
     end
   end
 
-  def validate_range name, value, min = nil, max = nil
-    if min.present?
-      if value.nil? || value.to_i < min.to_i
-        raise ParameterError, I18n.t(
-          'param_check.invalid_minimum',
-          parameter: name,
-          min: min,
-          got: value,
-        )
-      end
+  def validate_number name, value, options = {}
+    options[:lt] = options[:less_than] if options[:less_than].present?
+    options[:lte] = options[:less_than_equal_to] if options[:less_than_equal_to].present?
+    options[:mt] = options[:more_than] if options[:more_than].present?
+    options[:more_than_equal_to] = options[:more_than_equal_to] if options[:more_than_equal_to].present?
+
+    if options[:lt].present?
+      raise ParameterError, I18n.t(
+        'param_check.value_not_less_than',
+        parameter: name,
+        expected: options[:lt],
+        got: value,
+      ) if value >= options[:lt]
     end
 
-    if max.present?
-      if value.nil? || value.to_i > max.to_i
-        raise ParameterError, I18n.t(
-          'param_check.invalid_maximum',
-          parameter: name,
-          max: max,
-          got: value,
-        )
-      end
+    if options[:lte].present?
+      raise ParameterError, I18n.t(
+        'param_check.value_not_less_than_equal_to',
+        parameter: name,
+        expected: options[:lte],
+        got: value,
+      ) if value > options[:lte]
+    end
+
+    if options[:mt].present?
+      raise ParameterError, I18n.t(
+        'param_check.value_not_more_than',
+        parameter: name,
+        expected: options[:mt],
+        got: value,
+      ) if value <= options[:mt]
+    end
+
+    if options[:mte].present?
+      raise ParameterError, I18n.t(
+        'param_check.value_not_more_than_equal_to',
+        parameter: name,
+        expected: options[:mte],
+        got: value,
+      ) if value < options[:mte]
     end
   end
 

data/param_check.gemspec

@@ -11,7 +11,7 @@ Gem::Specification.new do |spec|
 
   spec.summary       = %q{Validate parameters for Rails API methods}
   spec.description   = %q{Validate parameters presence and type for Rails API methods}
-  spec.homepage      = "https://cjmarkham.co.uk"
+  spec.homepage      = "https://github.com/cjmarkham/param_check"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: param_check
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - cjmarkham
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-01-15 00:00:00.000000000 Z
+date: 2017-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -73,6 +73,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".DS_Store"
 - ".gitignore"
 - ".rspec"
 - CODE_OF_CONDUCT.md
@@ -88,7 +89,7 @@ files:
 - lib/param_check/engine.rb
 - lib/param_check/version.rb
 - param_check.gemspec
-homepage: https://cjmarkham.co.uk
+homepage: https://github.com/cjmarkham/param_check
 licenses:
 - MIT
 metadata: {}