hash_cast 0.5.1 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68e050b609ffe18b09ada29f3606534113be56827b161bae6e917cbeadc82a57
-  data.tar.gz: 76b1ba697a03d6edcccb6f5196d3411d8af423ff5e0e0b1661b81db3e02846e6
+  metadata.gz: 0c7a40e91e7c2a8853eef8627131ddce5f3500bda9a3be64a9d363f65523f783
+  data.tar.gz: f75b041bd770043b6144bb5ec0cae0a3a52ce2103edea9e80a52b357112ab51e
 SHA512:
-  metadata.gz: e7fc1162f788fd180c0cd1a080bb2dbbcaaeb7b28fa1d59b3d490a0bd3f744a3457998d65fc1ce6d2e9819ce898416d6832c658d8bd5e3d47486980d6a4a1db3
-  data.tar.gz: 1d9d02707117f5619902867966c4e0a1f542e0e9aedd2b183557aaf25c6fc85704d488db2c52c22534a377779a68b1bc9d09b31420ad77af54576d701358f9fe
+  metadata.gz: 2503474b03a909d72daee0852aacac355da4d8837c99273336dffa403ce63d67aab3a2ea5259cb504ac096ccbd063155400ec4d47b12d72f5d1f2c5e74144536
+  data.tar.gz: 4d2f655abee9beaaf012dfa000518a35247612d76cb64ed0a96acd866bdcbec8cf57a25cdfc33630b68ad86500401af74fbe9e548002207e83953bb934358d9f

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+**Version 0.5.3**
+- Added optional support for array and string size validation
+
+**Version 0.5.2**
+- Rename AttributesCaster to HashCast::RecursiveCasterApplicator, to highlight that it's not a regular Caster
+
 **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.1)
+    hash_cast (0.5.3)
 
 GEM
   remote: https://rubygems.org/

data/lib/hash_cast/caster.rb

@@ -99,21 +99,26 @@ module HashCast::Caster
     # @param hash [Hash] hash for casting
     # @param options [Hash] options, input_keys: :string, output_key: :symbol
     def cast(hash, options = {})
-      check_attributes_defined!
-      check_hash_given!(hash)
-      check_options!(options)
-      set_default_options(options)
-
-      attributes_caster = HashCast::AttributesCaster.new(class_variable_get(:@@attributes), options)
-      attributes_caster.cast(hash)
+      cast_with_attributes(hash, get_attributes, options)
     end
 
     private
 
-    def check_attributes_defined!
+    def get_attributes
       unless class_variable_defined?(:@@attributes)
         raise HashCast::Errors::ArgumentError, "Attributes block should be defined"
       end
+
+      class_variable_get(:@@attributes)
+    end
+
+    def cast_with_attributes(hash, attributes, options = {})
+      check_hash_given!(hash)
+      check_options!(options)
+      set_default_options(options)
+
+      caster_applicator = HashCast::RecursiveCasterApplicator.new(attributes, options)
+      caster_applicator.cast(hash)
     end
 
     def check_options!(options)

data/lib/hash_cast/casters/array_caster.rb

@@ -1,14 +1,20 @@
 class HashCast::Casters::ArrayCaster
 
   def self.cast(value, attr_name, options = {})
-    if value.is_a?(Array)
-      if options[:each]
-        cast_array_items(value, attr_name, options)
-      else
-        value
+    unless value.is_a?(Array)
+      raise HashCast::Errors::CastingError, "should be an array"
+    end
+
+    if HashCast.config.array_size_validator_enabled
+      if value.size > HashCast.config.array_size_validator_limit
+        HashCast.config.array_size_validator_callback.call(value, attr_name, options)
       end
+    end
+
+    if options[:each]
+      cast_array_items(value, attr_name, options)
     else
-      raise HashCast::Errors::CastingError, "should be an array"
+      value
     end
   end
 

data/lib/hash_cast/casters/string_caster.rb

@@ -8,6 +8,12 @@ class HashCast::Casters::StringCaster
       raise HashCast::Errors::CastingError, 'contains invalid characters'
     end
 
+    if HashCast.config.string_size_validator_enabled
+      if value.size > HashCast.config.string_size_validator_limit
+        HashCast.config.string_size_validator_callback.call(value, attr_name, options)
+      end
+    end
+
     casted_value
   end
 

data/lib/hash_cast/config.rb

@@ -1,5 +1,14 @@
 class HashCast::Config
-  attr_accessor :input_keys, :output_keys, :validate_string_null_byte
+  attr_writer :input_keys, :output_keys, :validate_string_null_byte, 
+    :array_size_validator_enabled, 
+    :array_size_validator_limit, 
+    :array_size_validator_callback,
+    :string_size_validator_enabled, 
+    :string_size_validator_limit, 
+    :string_size_validator_callback
+
+  DEFAULT_ARRAY_SIZE_VALIDATOR_LIMIT = 1000_000
+  DEFAULT_STRING_SIZE_VALIDATOR_LIMIT = 1000_000
 
   def input_keys
     @input_keys || :symbol
@@ -14,4 +23,48 @@ class HashCast::Config
     
     @validate_string_null_byte
   end
+
+  def array_size_validator_enabled
+    return false if @array_size_validator_enabled.nil?
+    
+    @array_size_validator_enabled
+  end
+
+  def array_size_validator_limit
+    return DEFAULT_ARRAY_SIZE_VALIDATOR_LIMIT if @array_size_validator_limit.nil?
+    
+    @array_size_validator_limit
+  end
+
+  def array_size_validator_callback
+    if @array_size_validator_callback.nil?
+      return lambda{ |value, name, options|
+        raise HashCast::Errors::CastingError, "array is too large" 
+      }
+    end
+    
+    @array_size_validator_callback
+  end
+
+  def string_size_validator_enabled
+    return false if @string_size_validator_enabled.nil?
+    
+    @string_size_validator_enabled
+  end
+
+  def string_size_validator_limit
+    return DEFAULT_STRING_SIZE_VALIDATOR_LIMIT if @string_size_validator_limit.nil?
+    
+    @string_size_validator_limit
+  end
+
+  def string_size_validator_callback
+    if @string_size_validator_callback.nil?
+      return lambda{ |value, name, options|
+        raise HashCast::Errors::CastingError, "string is too large" 
+      }
+    end
+    
+    @string_size_validator_callback
+  end
 end

data/lib/hash_cast/{attributes_caster.rb → recursive_caster_applicator.rb}

@@ -1,4 +1,4 @@
-class HashCast::AttributesCaster
+class HashCast::RecursiveCasterApplicator
   attr_reader :attributes, :options
 
   def initialize(attributes, options)
@@ -19,7 +19,7 @@ class HashCast::AttributesCaster
           handle_attribute_error(e, attribute)
         end
       else
-        raise HashCast::Errors::MissingAttributeError.new("should be given", attribute.name)if attribute.required?
+        raise HashCast::Errors::MissingAttributeError.new("should be given", attribute.name) if attribute.required?
       end
     end
 

data/lib/hash_cast/version.rb

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

data/lib/hash_cast.rb

@@ -5,7 +5,7 @@ require 'hash_cast/casters'
 require 'hash_cast/concern.rb'
 require 'hash_cast/metadata/attribute'
 require 'hash_cast/attributes_parser'
-require 'hash_cast/attributes_caster'
+require 'hash_cast/recursive_caster_applicator'
 require 'hash_cast/caster'
 
 module HashCast
@@ -32,6 +32,16 @@ module HashCast
   def self.config
     @@config ||= HashCast::Config.new
   end
+
+  def self.create(&block)
+    Class.new do
+      include HashCast::Caster
+
+      attributes do
+        instance_exec(&block)
+      end
+    end
+  end
 end
 
 HashCast.add_caster(:array,    HashCast::Casters::ArrayCaster)

data/spec/hash_cast/caster_spec.rb

@@ -54,7 +54,7 @@ describe HashCast::Caster do
 
       casted_hash = ContactCaster.cast(input_hash)
 
-      casted_hash.should == {
+      expect(casted_hash).to eq({
         contact: {
           name: "John Smith",
           age: 22,
@@ -77,7 +77,7 @@ describe HashCast::Caster do
             },
           ]
         }
-      }
+      })
     end
 
     describe "Custom casters" do
@@ -119,14 +119,14 @@ describe HashCast::Caster do
           ]
         )
 
-        casted_hash.should == {
+        expect(casted_hash).to eq({
           name: "Might & Magic",
           settings: { account: "migthy_lord" },
           emails: [
             { address: "test1@example.com" },
             { address: "test2@example.com" }
           ]
-        }
+        })
       end
     end
 
@@ -221,69 +221,6 @@ describe HashCast::Caster do
       end.to_not raise_error
     end
 
-    it "raises error if skip_unexpected_attributes=false and unexpected attribute was given" do
-      input_hash = {
-        contact: {
-          wrong_attribute: 'foo',
-          name: "Jim",
-          weight: 65.5,
-          birthday: Date.today,
-          last_logged_in: DateTime.now,
-          last_visited_at: Time.now,
-          company: {
-            name: "MyCo",
-          },
-          emails: [ "test@example.com", "test2@example.com" ],
-          social_accounts: [
-            {
-              name: "john_smith",
-              type: :twitter,
-            },
-            {
-              name: "John",
-              type: :facebook,
-            },
-          ]
-        }
-      }
-
-      expect do
-        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 "doesn't raise unexpected attributes error by default" do
-      input_hash = {
-        contact: {
-          wrong_attribute: 'foo',
-          name: "Jim",
-          weight: 65.5,
-          birthday: Date.today,
-          last_logged_in: DateTime.now,
-          last_visited_at: Time.now,
-          company: {
-            name: "MyCo",
-          },
-          emails: [ "test@example.com", "test2@example.com" ],
-          social_accounts: [
-            {
-              name: "john_smith",
-              type: :twitter,
-            },
-            {
-              name: "John",
-              type: :facebook,
-            },
-          ]
-        }
-      }
-
-      expect do
-        ContactCaster.cast(input_hash)
-      end.not_to raise_error(HashCast::Errors::UnexpectedAttributeError)
-
-    end
-
     it "should convert accept hash with string keys and cast them to symbol keys" do
       input_hash = {
         'contact' => {
@@ -312,7 +249,7 @@ describe HashCast::Caster do
 
       casted_hash = ContactCaster.cast(input_hash, input_keys: :string, output_keys: :symbol)
 
-      casted_hash.should == {
+      expect(casted_hash).to eq({
         contact: {
           name: "John Smith",
           age: 22,
@@ -335,12 +272,106 @@ describe HashCast::Caster do
             },
           ]
         }
+      })
+    end
+  end
+
+  context "checking unexpected attributes" do
+    before(:all) do
+      class BillingDetailsCaster
+        include HashCast::Caster
+
+        attributes do
+          string   :name, optional: true
+
+          array :contacts, each: :hash, optional: true do
+            string :email
+          end
+
+          hash :address, optional: true do
+            string  :city
+            string  :country
+          end
+        end
+      end
+    end
+
+    it "doesn't raise unexpected attributes error by default" do
+      input_hash = {
+        wrong_attribute: 'foo',
+        name: "Jim",
+        address: {
+          city:     "New York",
+          country:  "USA",
+          street:   "Random street"
+        },
+        contacts: [
+          {
+            name: "john_smith",
+            email: "john@example.com",
+          }
+        ]
+      }
+
+      output_hash = BillingDetailsCaster.cast(input_hash)
+
+      expect(output_hash).to eq({
+        name: "Jim",
+        address: {
+          city:     "New York",
+          country:  "USA"
+        },
+        contacts: [
+          {
+            email: "john@example.com",
+          }
+        ]
+      })
+    end
+
+    it "raise error for unexpected root attribute if skip_unexpected_attributes=false" do
+      input_hash = {
+        wrong_attribute: 'foo',
+        name: "Jim"
+      }
+
+      expect do
+        BillingDetailsCaster.cast(input_hash, skip_unexpected_attributes: false)
+      end.to raise_error(HashCast::Errors::UnexpectedAttributeError, "wrong_attribute is not valid attribute name")
+    end
+
+    it "raise error for unexpected root attribute if skip_unexpected_attributes=false" do
+      input_hash = {
+        name: "Jim",
+        address: {
+          city:     "New York",
+          country:  "USA",
+          street:   "Random street"
+        }
+      }
+
+      expect do
+        BillingDetailsCaster.cast(input_hash, skip_unexpected_attributes: false)
+      end.to raise_error(HashCast::Errors::UnexpectedAttributeError, "address[street] is not valid attribute name")
+    end
+
+    it "raise error for unexpected root attribute if skip_unexpected_attributes=false" do
+      input_hash = {
+        name: "Jim",
+        contacts: [{
+          name: "john_smith",
+          email: "john@example.com",
+        }]
       }
+
+      expect do
+        BillingDetailsCaster.cast(input_hash, skip_unexpected_attributes: false)
+      end.to raise_error(HashCast::Errors::UnexpectedAttributeError, "contacts[name] is not valid attribute name")
     end
   end
 
   context "checking invalid parameters" do
-    it "should raise CaterNotFound exception if caster name is invalid" do
+    it "should raise CasterNotFound exception if caster name is invalid" do
       expect do
         class WrongCaster
           include HashCast::Caster

data/spec/hash_cast/casters/array_caster_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe HashCast::Casters::ArrayCaster do
+  subject { HashCast::Casters::ArrayCaster }
+
+  it "should cast an array" do
+    result = subject.cast([1,2,3], :ids)
+    expect(result).to eq([1,2,3])
+  end
+
+  it "should raise an error for non-array" do
+    expect {
+      subject.cast(1, :ids)
+    }.to raise_error(HashCast::Errors::CastingError, "should be an array")
+  end
+
+  context "array size validation" do
+    after{ 
+      HashCast.config.array_size_validator_enabled = nil
+      HashCast.config.array_size_validator_limit = nil
+    }
+
+    it "should not raise an error for large array by default" do
+      result = subject.cast([1] * 10_000, :ids)
+      expect(result).to eq([1] * 10_000)
+    end
+
+    it "should raise an error for large array when validation is enabled" do
+      HashCast.config.array_size_validator_enabled = true
+      HashCast.config.array_size_validator_limit = 1000
+
+      expect {
+        subject.cast([1] * 10_000, :ids)
+      }.to raise_error(HashCast::Errors::CastingError, "array is too large")
+    end
+
+    it "should allow overriding the callback" do
+      HashCast.config.array_size_validator_enabled = true
+      HashCast.config.array_size_validator_limit = 1000
+      HashCast.config.array_size_validator_callback = lambda { |value, name, options|
+        raise HashCast::Errors::UnexpectedAttributeError, 'test'
+      }
+
+      expect {
+        subject.cast([1] * 10_000, :ids)
+      }.to raise_error(HashCast::Errors::UnexpectedAttributeError, "test")
+    end
+  end
+end

data/spec/hash_cast/casters/string_caster_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe HashCast::Casters::StringCaster do
+  subject { HashCast::Casters::StringCaster }
+
+  it "should cast a string" do
+    result = subject.cast("foobar", :name)
+    expect(result).to eq("foobar")
+  end
+
+  context "string size validation" do
+    after{ 
+      HashCast.config.string_size_validator_enabled = nil
+      HashCast.config.string_size_validator_limit = nil
+    }
+
+    it "should not raise an error for large string by default" do
+      result = subject.cast("a" * 10_000, :name)
+      expect(result).to eq("a" * 10_000)
+    end
+
+    it "should raise an error for large string when validation is enabled" do
+      HashCast.config.string_size_validator_enabled = true
+      HashCast.config.string_size_validator_limit = 1000
+
+      expect {
+        subject.cast("a" * 10_000, :ids)
+      }.to raise_error(HashCast::Errors::CastingError, "string is too large")
+    end
+
+    it "should allow overriding the callback" do
+      HashCast.config.string_size_validator_enabled = true
+      HashCast.config.string_size_validator_limit = 1000
+      HashCast.config.string_size_validator_callback = lambda { |value, name, options|
+        raise HashCast::Errors::UnexpectedAttributeError, 'test'
+      }
+
+      expect {
+        subject.cast("a" * 10_000, :ids)
+      }.to raise_error(HashCast::Errors::UnexpectedAttributeError, "test")
+    end
+  end
+end

data/spec/hash_cast/hash_cast_spec.rb

@@ -4,11 +4,10 @@ describe HashCast do
 
   describe ".create" do
     it "should cast hash attributes" do
-      pending "NOT YET IMPLEMENTED"
       input_hash = {
         contact: {
           name: "John Smith",
-          age: "22",
+          age:  22,
           company: {
             name: "MyCo",
           }
@@ -30,8 +29,9 @@ describe HashCast do
       end
 
       casted_hash = caster.cast(input_hash)
-      casted_hash.object_id.should_not == hash.object_id
-      caster_hash.should == hash
+
+      expect(casted_hash.object_id).to_not eq(input_hash.object_id)
+      expect(casted_hash).to eq(input_hash)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hash_cast
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.3
 platform: ruby
 authors:
 - Albert Gazizov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-12 00:00:00.000000000 Z
+date: 2025-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -58,7 +58,6 @@ files:
 - Rakefile
 - hash_cast.gemspec
 - lib/hash_cast.rb
-- lib/hash_cast/attributes_caster.rb
 - lib/hash_cast/attributes_parser.rb
 - lib/hash_cast/caster.rb
 - lib/hash_cast/casters.rb
@@ -76,8 +75,11 @@ files:
 - lib/hash_cast/config.rb
 - lib/hash_cast/errors.rb
 - lib/hash_cast/metadata/attribute.rb
+- lib/hash_cast/recursive_caster_applicator.rb
 - lib/hash_cast/version.rb
 - spec/hash_cast/caster_spec.rb
+- spec/hash_cast/casters/array_caster_spec.rb
+- spec/hash_cast/casters/string_caster_spec.rb
 - spec/hash_cast/hash_cast_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/droidlabs/hash_cast
@@ -105,5 +107,7 @@ specification_version: 4
 summary: Declarative Hash Caster
 test_files:
 - spec/hash_cast/caster_spec.rb
+- spec/hash_cast/casters/array_caster_spec.rb
+- spec/hash_cast/casters/string_caster_spec.rb
 - spec/hash_cast/hash_cast_spec.rb
 - spec/spec_helper.rb