sinatra-my-params 0.0.5 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 747bacbce6ab90027f92e29c45475964414cda4f62ad362339f1fd515323fcf3
-  data.tar.gz: 2c0d6582d40e18230e5d97e29ddff20484d86163366bc23e7aa24e67c255d9a6
+  metadata.gz: 8391c458014310cc388fc93e899320baa879567e50ca8cb875e3a19e20ae5984
+  data.tar.gz: a928880e81d7f1cfb6d91d2da10347398f8eca11b85bf808eca3c12af8f7a675
 SHA512:
-  metadata.gz: b2b7b1e994250fce4fbabe3cf9571b62dc6432c7965d81897b54889a1be64198fb0dff9ba1ab83e91462985ee7644a5a3b00188b600b1d7fa4431d72e0ee99d6
-  data.tar.gz: e502b5deafbeb12839eb772b3be83720160ac8f1c99950fa527dcdef9da2e04df7aa55ffee1a32c6e037fa9931e3ec3f28e2e3470e545781e9855245b5db3d5d
+  metadata.gz: c18faa501799088dcf64962e616789b38a78176f4b0fdfc3b0c123e157b3f799ee7638243d6fb522ab55de945d296206d0c71e46436c4ff30444e5ee95ba8300
+  data.tar.gz: 257127aa4473a46ee13031cef5251f9b94cbb7195444130e0cb6011fc25376bab83a09e52a5c5b03c1e2e02e7a923d3fe942702c88370b65824b3ecf87fb3a11

data/lib/permit_params.rb

@@ -1,18 +1,25 @@
+# frozen_string_literal: true
+
 module PermitParams
   class InvalidParameterError < StandardError
     attr_accessor :param, :options
   end
 
-  def permitted_params(params, permitted = {}, strong_validation = false)
+  def permitted_params(params, permitted = {}, strong_validation = false, options = {})
     return params if permitted.empty?
-  
+
     coerced_params = Hash.new({})
 
     params.each do |key, value|
-      if permitted.keys.map(&:to_s).include?(key.to_s) && !value.nil?
-        coerced = coerce(value, permitted[key.to_sym], strong_validation)
-        coerced_params[key] = coerced if !coerced.nil?
-      end
+      next unless permitted?(permitted: permitted, key: key, value: value)
+
+      coerced = coerce(
+        param: value,
+        type: permitted[key.to_sym],
+        strong_validation: strong_validation,
+        options: options
+      )
+      coerced_params[key] = coerced unless coerced.nil?
     end
     coerced_params
   end
@@ -20,38 +27,76 @@ module PermitParams
   private
 
   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
 
-  def coerce(param, type, strong_validation = false, options = {})
     begin
       return nil if param.nil?
-      return param if (param.is_a?(type) rescue false)
-      return Integer(param, 10) if type == Integer
+      return param if begin
+        param.is_a?(type)
+      rescue StandardError
+        false
+      end
+      return coerce_integer(param, options) if type == Integer
       return Float(param) if type == Float
       return String(param) if type == String
       return Date.parse(param) if type == Date
       return Time.parse(param) if type == Time
       return DateTime.parse(param) if type == DateTime
-      return coerce_array(param) if type == Array
-      return coerce_hash(param) if type == Hash
+      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
-      return nil
+
+      nil
     rescue ArgumentError
       raise InvalidParameterError, "'#{param}' is not a valid #{type}" if strong_validation
     end
   end
 
-  def coerce_array(param)
-    Array(param.split(options[:delimiter] || ","))
+  def coerce_integer(param, options = {})
+    Integer(param, options[:integer_precision] || 10)
+  end
+
+  def coerce_array(param, options = {})
+    Array(param.split(options[:delimiter] || ',').map(&:strip))
   end
 
-  def coerce_hash(param)
-    Hash[param.split(options[:delimiter] || ",").map{|c| c.split(options[:separator] || ":")}]
+  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
+    Hash[key_value]
   end
 
   def coerce_boolean(param)
-    coerced = /^(false|f|no|n|0)$/i === param.to_s ? false : /^(true|t|yes|y|1)$/i === param.to_s ? true : nil
+    coerced = if /^(false|f|no|n|0)$/i === param.to_s
+                false
+              else
+                /^(true|t|yes|y|1)$/i === param.to_s ? true : nil
+              end
     raise ArgumentError if coerced.nil?
+
     coerced
   end
-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

@@ -1,87 +1,154 @@
-require "test/unit"
-require "permit_params"
-require "rspec"
-require "rack/test"
+# frozen_string_literal: true
+
+require 'test/unit'
+require 'permit_params'
+require 'rspec'
+require 'rack/test'
 
 include PermitParams
 
-describe "exceptions" do
-  it "should raise error when at least one param is invalid" do
-    input = { param_1: "a" }
-    expect{
+describe 'exceptions' do
+  it 'should raise error when at least one param is invalid' do
+    input = { param_1: 'a' }
+    expect  do
       permitted_params(input, { param_1: Integer }, true)
-    }.to raise_error(InvalidParameterError, "'a' is not a valid Integer") 
+    end.to raise_error(InvalidParameterError, "'a' is not a valid Integer")
+  end
+
+  it 'should allow all params when no restriction is given' do
+    input = { param_1: 'a string' }
+    expect(input).to eq permitted_params(input)
   end
 
-  it "should return a string when a pemitted is string" do
-    input = { param_1: "a string" }
+  it 'should remove a string when a pemitted is integer' do
+    input = { param_1: 'a string' }
+    output = {}
+    expect(output).to eq permitted_params(input, { param_1: Integer })
+  end
+
+  it 'should return an integer when a pemitted is integer' do
+    input = { param_1: 1 }
+    expect(input).to eq permitted_params(input, { param_1: Integer })
+  end
+
+  it 'should return an integer when a pemitted can be cast into integer' do
+    input = { param_1: '1' }
+    output = { param_1: 1 }
+    expect(output).to eq permitted_params(input, { param_1: Integer })
+  end
+
+  it 'should return a string when a pemitted is string' do
+    input = { param_1: 'a string' }
     expect(input).to eq permitted_params(input, { param_1: String })
   end
 
-  it "should return a float when a pemitted is float" do
+  it 'should return a float when a pemitted is float' do
     input = { param_1: 10.0 }
     expect(input).to eq permitted_params(input, { param_1: Float })
   end
 
-  it "should return a date when a pemitted is date" do
+  it 'should return a date when a pemitted is date' do
     input = { param_1: Date.new }
     expect(input).to eq permitted_params(input, { param_1: Date })
   end
 
-  it "should return a time when a pemitted is time" do
+  it 'should return a time when a pemitted is time' do
     input = { param_1: Time.new }
     expect(input).to eq permitted_params(input, { param_1: Time })
   end
 
-  it "should return an integer when a pemitted is integer" do
-    input = { param_1: 1 }
-    expect(input).to eq permitted_params(input, { param_1: Integer })
-  end
-
-  it "should return an integer when a pemitted can be cast into integer" do
-    input = { param_1: "1" }
-    output = { param_1: 1 }
-    expect(output).to eq permitted_params(input, { param_1: Integer })
-  end
-
-  it "should return a false(boolean) when a pemitted is boolean" do
-    input = { param_1: "false" }
+  it 'should return a false(boolean) when a pemitted is boolean' do
+    input = { param_1: 'false' }
     output = { param_1: false }
     expect(output).to eq permitted_params(input, { param_1: Boolean })
   end
 
-  it "should return a true(boolean) when a pemitted is boolean" do
-    input = { param_1: "true" }
+  it 'should return a true(boolean) when a pemitted is boolean' do
+    input = { param_1: 'true' }
     output = { param_1: true }
     expect(output).to eq permitted_params(input, { param_1: Boolean })
   end
 
-  it "should return an array when a pemitted is array" do
-    input = { param_1: [1,2] }
+  it 'should return an array when a pemitted is array' do
+    input = { param_1: [1, 2] }
     expect(input).to eq permitted_params(input, { param_1: Array })
   end
 
-  it "should return a hash when a pemitted is hash" do
+  it 'should return an array when a pemitted is array' do
+    input = { param_1: '1, 2' }
+    output = { param_1: %w[1 2] }
+    expect(output).to eq permitted_params(input, { param_1: Array })
+  end
+
+  it 'should return an array when a pemitted is array' do
+    input = { param_1: '1; 2' }
+    output = { param_1: %w[1 2] }
+    expect(output).to eq permitted_params(input, { param_1: Array }, false, { delimiter: ';' })
+  end
+
+  it 'should return a hash when a pemitted is hash' do
+    input = { param_1: 'a: 1, b: 2' }
+    output = { param_1: { 'a' => '1', 'b' => '2' } }
+    expect(output).to eq permitted_params(input, { param_1: Hash })
+  end
+
+  it 'should return a hash when a pemitted is hash' do
+    input = { param_1: 'a: 1; b: 2' }
+    output = { param_1: { 'a' => '1', 'b' => '2' } }
+    expect(output).to eq permitted_params(input, { param_1: Hash }, false, { delimiter: ';' })
+  end
+
+  it 'should return a hash when a pemitted is hash' do
     input = { param_1: { a: 1 } }
     expect(input).to eq permitted_params(input, { param_1: Hash })
   end
 
-  it "should return a hash when a pemitted is hash" do
-    input = { param_1: { :a => 1 } }
+  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 })
   end
 
-  it "should return a hash when a pemitted is hash" do
+  it 'should return a hash when a pemitted is hash' do
     input = { param_1: { "a": 1 } }
     expect(input).to eq permitted_params(input, { param_1: Hash })
   end
 
-  it "should return a several types for several inputs" do
-    input = { number: 1, string: "string", bol: "true", array: [1,2], hsh: {a: 3}  }
-    output = { number: 1, string: "string", bol: true, array: [1,2], hsh: {a: 3}  }
+  it 'should return a several types for several inputs' do
+    input = { number: 1, string: 'string', bol: 'true', array: [1, 2], hsh: { a: 3 } }
+    output = { number: 1, string: 'string', bol: true, array: [1, 2], hsh: { a: 3 } }
     expect(output).to eq permitted_params(
-      input, 
-      { 
+      input,
+      {
         number: Integer,
         string: String,
         bol: Boolean,
@@ -91,15 +158,30 @@ describe "exceptions" do
     )
   end
 
-  it "should remove a string when a pemitted is integer" do
-    input = { param_1: "a string" }
-    output = {}
-    expect(output).to eq permitted_params(input, { param_1: Integer })
-  end
+  it 'returns the paramter without casting if Any' do
+    class TestClass
+      attr_accessor :some_attribute
 
-  it "should allow all params when no restriction is given" do
-    input = { param_1: "a string" }
-    expect(input).to eq permitted_params(input)
+      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 })
+
+    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.5
+  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: []