hash_cast 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 672fe60de0d65a961d15b86a8461c967815818aad2bae13bef645bba235a6808
-  data.tar.gz: 1831d51bdc595939bc3c61b66f72d42ce6c3d82af944c2a09b83710d1582eb5a
+  metadata.gz: 68e050b609ffe18b09ada29f3606534113be56827b161bae6e917cbeadc82a57
+  data.tar.gz: 76b1ba697a03d6edcccb6f5196d3411d8af423ff5e0e0b1661b81db3e02846e6
 SHA512:
-  metadata.gz: 054603f4b2ab7fcc8b0d47ded07535bd8f550a8950515bda53753ac52d45c61b72a81162133c26e0ab2188d0415101d6612c064f2f5fe7e45fd4c50026ba756a
-  data.tar.gz: 4c4709448714f4ff6e6deaaa5671a0c8e5de0bc54a85bb16a4647c7f2d2a9a45e69f2c01422c06c6a74f71759397d11e99a9e2357d21cf0aa0a576a3c30cdf64
+  metadata.gz: e7fc1162f788fd180c0cd1a080bb2dbbcaaeb7b28fa1d59b3d490a0bd3f744a3457998d65fc1ce6d2e9819ce898416d6832c658d8bd5e3d47486980d6a4a1db3
+  data.tar.gz: 1d9d02707117f5619902867966c4e0a1f542e0e9aedd2b183557aaf25c6fc85704d488db2c52c22534a377779a68b1bc9d09b31420ad77af54576d701358f9fe

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+**Version 0.5.1**
+- String caster should validate for null byte by default
+- skip_unexpected_attributes option is true by default

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    hash_cast (0.5.0)
+    hash_cast (0.5.1)
 
 GEM
   remote: https://rubygems.org/

data/lib/hash_cast/attributes_caster.rb

@@ -23,7 +23,7 @@ class HashCast::AttributesCaster
       end
     end
 
-    if !options[:skip_unexpected_attributes]
+    if options.has_key?(:skip_unexpected_attributes) && !options[:skip_unexpected_attributes]
       check_unexpected_attributes_not_given!(hash_keys, casted_hash.keys)
     end
 

data/lib/hash_cast/casters/string_caster.rb

@@ -1,6 +1,19 @@
 class HashCast::Casters::StringCaster
+  NULL_BYTE_CHARACTER = "\u0000".freeze
 
   def self.cast(value, attr_name, options = {})
+    casted_value = cast_string(value, attr_name, options)
+
+    if HashCast.config.validate_string_null_byte && casted_value.match?(NULL_BYTE_CHARACTER)
+      raise HashCast::Errors::CastingError, 'contains invalid characters'
+    end
+
+    casted_value
+  end
+
+  private
+
+  def self.cast_string(value, attr_name, options = {})
     if value.is_a?(String)
       value
     elsif value.is_a?(Symbol)

data/lib/hash_cast/config.rb

@@ -1,5 +1,5 @@
 class HashCast::Config
-  attr_accessor :input_keys, :output_keys
+  attr_accessor :input_keys, :output_keys, :validate_string_null_byte
 
   def input_keys
     @input_keys || :symbol
@@ -8,4 +8,10 @@ class HashCast::Config
   def output_keys
     @output_keys || :symbol
   end
+
+  def validate_string_null_byte
+    return true if @validate_string_null_byte.nil?
+    
+    @validate_string_null_byte
+  end
 end

data/lib/hash_cast/version.rb

@@ -1,3 +1,3 @@
 module HashCast
-  VERSION = "0.5.0"
+  VERSION = "0.5.1"
 end

data/spec/hash_cast/caster_spec.rb

@@ -221,7 +221,7 @@ describe HashCast::Caster do
       end.to_not raise_error
     end
 
-    it "should raise error if unexpected attribute was given" do
+    it "raises error if skip_unexpected_attributes=false and unexpected attribute was given" do
       input_hash = {
         contact: {
           wrong_attribute: 'foo',
@@ -248,11 +248,11 @@ describe HashCast::Caster do
       }
 
       expect do
-        ContactCaster.cast(input_hash)
+        ContactCaster.cast(input_hash, skip_unexpected_attributes: false)
       end.to raise_error(HashCast::Errors::UnexpectedAttributeError, "contact[wrong_attribute] is not valid attribute name")
     end
 
-    it "shouldn't unexpected attributes error if skip_unexpected_attributes flag is set to true" do
+    it "doesn't raise unexpected attributes error by default" do
       input_hash = {
         contact: {
           wrong_attribute: 'foo',
@@ -279,7 +279,7 @@ describe HashCast::Caster do
       }
 
       expect do
-        ContactCaster.cast(input_hash, skip_unexpected_attributes: true)
+        ContactCaster.cast(input_hash)
       end.not_to raise_error(HashCast::Errors::UnexpectedAttributeError)
 
     end
@@ -381,4 +381,29 @@ describe HashCast::Caster do
       end.to raise_error(HashCast::Errors::CastingError, "city should be a string")
     end
   end
+
+  context "string caster" do
+    before(:all) do
+      class HomeCaster
+        include HashCast::Caster
+
+        attributes do
+          string   :city
+        end
+      end
+    end
+
+    after{ HashCast.config.validate_string_null_byte = nil }
+
+    it "should allow null byte if validate_string_null_byte config is set to false" do
+      HashCast.config.validate_string_null_byte = false
+      HomeCaster.cast(city: "\u0000")
+    end
+
+    it "should not allow null byte if validate_string_null_byte config by default" do
+      expect do
+        HomeCaster.cast(city: "\u0000")
+      end.to raise_error(HashCast::Errors::CastingError, "city contains invalid characters")
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hash_cast
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Albert Gazizov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-28 00:00:00.000000000 Z
+date: 2024-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -50,6 +50,7 @@ files:
 - ".rspec"
 - ".ruby-gemset"
 - ".ruby-version"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt