sinatra-my-params 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a1f7f7726f5d92878f2f65847f2d853d3ab3033b3dfaf4e84784d0bb56bd9b3
-  data.tar.gz: 4ebf4d253a1286535ff93503433695867faf4ab4c3b3fd08076e807ba40535f9
+  metadata.gz: 8391c458014310cc388fc93e899320baa879567e50ca8cb875e3a19e20ae5984
+  data.tar.gz: a928880e81d7f1cfb6d91d2da10347398f8eca11b85bf808eca3c12af8f7a675
 SHA512:
-  metadata.gz: b87393662b298d9acf0c127427ed77894c2c378fc05f4f737c0412c60180eae68f99ba55c7e6bafdfd42afc8428971482c19cac9bb3c0524ca289f741488364c
-  data.tar.gz: d9a899475bb3e5d6af6cd2c5d539b645a5770e9d4de99cf37797899058bd0ad18c2bec8799905aab8dd3c46cbacf8915d3ad97679684dfce15e56583d9d5c554
+  metadata.gz: c18faa501799088dcf64962e616789b38a78176f4b0fdfc3b0c123e157b3f799ee7638243d6fb522ab55de945d296206d0c71e46436c4ff30444e5ee95ba8300
+  data.tar.gz: 257127aa4473a46ee13031cef5251f9b94cbb7195444130e0cb6011fc25376bab83a09e52a5c5b03c1e2e02e7a923d3fe942702c88370b65824b3ecf87fb3a11

data/lib/permit_params.rb

@@ -11,7 +11,7 @@ module PermitParams
     coerced_params = Hash.new({})
 
     params.each do |key, value|
-      next unless permitted.keys.map(&:to_s).include?(key.to_s) && !value.nil?
+      next unless permitted?(permitted: permitted, key: key, value: value)
 
       coerced = coerce(
         param: value,
@@ -28,6 +28,11 @@ module PermitParams
 
   Boolean = :boolean
   Any = :any
+  Shape = :shape
+
+  def permitted?(permitted:, key:, value:)
+    permitted.keys.map(&:to_s).include?(key.to_s) && !value.nil?
+  end
 
   def coerce(param:, type:, strong_validation: false, options: {})
     return param if type == Any
@@ -46,6 +51,7 @@ module PermitParams
       return Time.parse(param) if type == Time
       return DateTime.parse(param) if type == DateTime
       return coerce_array(param, options) if type == Array
+      return coerce_shape(param, options) if type == Shape
       return coerce_hash(param, options) if type == Hash
       return coerce_boolean(param) if [TrueClass, FalseClass, Boolean].include? type
 
@@ -64,6 +70,8 @@ module PermitParams
   end
 
   def coerce_hash(param, options = {})
+    return param if param.is_a?(Hash)
+
     key_value = param.split(options[:delimiter] || ',').map(&:strip).map do |c|
       c.split(options[:separator] || ':').map(&:strip)
     end
@@ -80,4 +88,15 @@ module PermitParams
 
     coerced
   end
+
+  def coerce_shape(param, options = {})
+    hash = coerce_hash(param)
+    has_shape?(hash, options[:shape]) ? hash : nil
+  end
+
+  def has_shape?(hash, shape)
+    hash.all? do |k, v|
+      v.is_a?(Hash) ? has_shape?(v, shape[k]) : shape[k] === v
+    end
+  end
 end

data/spec/permit_params_spec.rb

@@ -8,10 +8,6 @@ require 'rack/test'
 include PermitParams
 
 describe 'exceptions' do
-  before do
-    class TestClass; end
-  end
-
   it 'should raise error when at least one param is invalid' do
     input = { param_1: 'a' }
     expect  do
@@ -107,6 +103,36 @@ describe 'exceptions' do
     expect(input).to eq permitted_params(input, { param_1: Hash })
   end
 
+  it 'should return a hash when a pemitted is shape' do
+    input = { param_1: { a: 1, b: 2 } }
+    expect(input).to eq permitted_params(
+      input,
+      { param_1: Shape },
+      false,
+      { shape: { a: Integer, b: Integer } }
+    )
+  end
+
+  it 'should return a hash when a pemitted is shape(deep)' do
+    input = { param_1: { a: { b: 2 } } }
+    expect(input).to eq permitted_params(
+      input,
+      { param_1: Shape },
+      false,
+      { shape: { a: { b: Integer } } }
+    )
+  end
+
+  it 'should return a empty when a pemitted is shape not defined' do
+    input = { param_1: { a: 1, b: 2 } }
+    expect({}).to eq permitted_params(
+      input,
+      { param_1: Shape },
+      false,
+      { shape: { a: Integer } }
+    )
+  end
+
   it 'should return a hash when a pemitted is hash' do
     input = { param_1: { a: { b: 1 } } }
     expect(input).to eq permitted_params(input, { param_1: Hash })
@@ -133,18 +159,29 @@ describe 'exceptions' do
   end
 
   it 'returns the paramter without casting if Any' do
+    class TestClass
+      attr_accessor :some_attribute
+
+      def initialize(some_attribute: nil)
+        @some_attribute = some_attribute
+      end
+    end
+
     input = { param_1: '1' }
     output = { param_1: '1' }
     expect(output).to eq permitted_params(input, { param_1: Any })
 
-    test_class = TestClass.new
-    input = { param_1: test_class }
-    output = { param_1: test_class }
-    expect(output).to eq permitted_params(input, { param_1: Any })
-
-    test_class = TestClass.new
-    input = { param_1: test_class, param_2: 2 }
-    output = { param_1: test_class }
-    expect(output).to eq permitted_params(input, { param_1: Any })
+    input = {
+      param_1: TestClass.new(some_attribute: 'a string')
+    }
+    output = permitted_params(input, { param_1: Any })
+    expect(input[:param_1].some_attribute).to eq output[:param_1].some_attribute
+
+    input = {
+      param_1: TestClass.new(some_attribute: 1),
+      param_2: 2
+    }
+    output = permitted_params(input, { param_1: Any })
+    expect(input[:param_1].some_attribute).to eq output[:param_1].some_attribute
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sinatra-my-params
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Marco Aviles
@@ -10,7 +10,7 @@ bindir: bin
 cert_chain: []
 date: 2021-09-19 00:00:00.000000000 Z
 dependencies: []
-description: A simple sinatra params sanitizer
+description: A simple params sanitizer(originally created for sinatra)
 email: gdmarav374@gmail.com
 executables: []
 extensions: []