param_check 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 229dac1713acddecb143dbe935c1ed71b64e81a2
-  data.tar.gz: cb1df9cbe44a477b03e54ee31ebb1893911fa7d7
+  metadata.gz: d98a6fa8c72c459888f417ac75fe6a2f9ff5167a
+  data.tar.gz: 341fa70017a064a1b5046f21d2d7b1dd3697fd2a
 SHA512:
-  metadata.gz: f77219d9cceb435d165ec969900d6f95d9ffc9d079031b8ab400f2d25b9841377aac23a0793fae2504ba9a920c756d144b40b83d940c4f7d7d6ad02db26db275
-  data.tar.gz: 2fcd88053f1fa18b55e4d0901409b7c16b0a4c0e3347ae1024a33703fb8e8272f197dd2af3e8f072501d5c43adbbade2ee0f1ae735068751c7607148922d381c
+  metadata.gz: f9a92099a2944dbe2889ce787cbaacb1e65a46808967e738f8e03be5197e595ce3cb760d7ab3f79b7b2f29773be9b3b61a150903c57ef76e8c21f1186ea40671
+  data.tar.gz: f66096a368a3e10b300d1da425f988dbe9753fb498e6abf3cba26977b0646945540fec8305975fa7a35e1ccc39c9f1e75beb46991406cf7cb7a6f1c1b052a635

data/README.md

@@ -68,6 +68,20 @@ params[:foo] = {
 params[:foo] = 'bar'
 ```
 
+### Validating range
+```ruby
+def index
+  param! :foo, min: 1, max: 3
+end
+```
+
+### Validating inclusion
+```ruby
+def index
+  param! :foo, in: ['foo', 'bar']
+end
+```
+
 By default, ParamCheck throws a `ParameterError` exception. You can rescue from this exception in order to
 respond with JSON for example:
 

data/config/locales/en.yml

@@ -1,4 +1,7 @@
 en:
   param_check:
     missing_required_parameter: "Missing required parameter: %{parameter}"
-    invalid_parameter: "Parameter %{parameter} is invalid. Expected %{expected} got %{got}"
+    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}"

data/lib/param_check/version.rb

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

data/lib/param_check.rb

@@ -28,16 +28,26 @@ module ParamCheck
     yield controller, index
   end
 
-  def validate! name, param, options
+  def validate! name, value, options
     if options[:required]
-      validate_presence name, param
+      validate_presence name, value
     end
 
-    validate_type name, param, options[:type]
+    if options[:type].present?
+      validate_type name, value, options[:type]
+    end
+
+    if options[:min].present? || options[:max].present?
+      validate_range name, value, options[:min], options[:max]
+    end
+
+    if options[:in].present?
+      validate_inclusion name, value, options[:in]
+    end
   end
 
-  def validate_presence name, param
-    if param.nil?
+  def validate_presence name, value
+    if value.nil?
       raise ParameterError, I18n.t(
         'param_check.missing_required_parameter',
         parameter: name,
@@ -45,25 +55,60 @@ module ParamCheck
     end
   end
 
-  def validate_type name, param, type
-    return if param.nil?
+  def validate_type name, value, type
+    return if value.nil?
 
     if type.in?([Integer, Fixnum])
-      is_numeric = Float(param) rescue nil
+      is_numeric = Float(value) rescue nil
       if ! is_numeric
         raise ParameterError, I18n.t(
           'param_check.invalid_parameter',
           parameter: name,
           expected: type,
-          got: param.class.name
+          got: value.class.name
         )
       end
-    elsif ! param.is_a? type
+    elsif ! value.is_a? type
       raise ParameterError, I18n.t(
         'param_check.invalid_parameter',
         parameter: name,
         expected: type,
-        got: param.class.name
+        got: value.class.name
+      )
+    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
+    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
+    end
+  end
+
+  def validate_inclusion name, value, inclusion = []
+    if ! value.in?(inclusion)
+      raise ParameterError, I18n.t(
+        'param_check.invalid_inclusion',
+        parameter: name,
+        expected: inclusion,
+        got: value,
       )
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: param_check
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - cjmarkham