hash_cast 0.5.0 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 672fe60de0d65a961d15b86a8461c967815818aad2bae13bef645bba235a6808
-  data.tar.gz: 1831d51bdc595939bc3c61b66f72d42ce6c3d82af944c2a09b83710d1582eb5a
+  metadata.gz: 899228916d29fc1b30a38151b850f6734ea57cb7390561b6a3aaecd0e3e1a7e6
+  data.tar.gz: b055bcb17b4863fea30a1f5b3a6e739514aaff9ca853fcefb3ee702bed3ece5d
 SHA512:
-  metadata.gz: 054603f4b2ab7fcc8b0d47ded07535bd8f550a8950515bda53753ac52d45c61b72a81162133c26e0ab2188d0415101d6612c064f2f5fe7e45fd4c50026ba756a
-  data.tar.gz: 4c4709448714f4ff6e6deaaa5671a0c8e5de0bc54a85bb16a4647c7f2d2a9a45e69f2c01422c06c6a74f71759397d11e99a9e2357d21cf0aa0a576a3c30cdf64
+  metadata.gz: 1ebd62549257464c42f8d9550b5a3a592e9b84fc430619821818497d74bc1c95946effc1c21188a619834f6420b3c78fef2aac6f9859289da0ec7719188e9726
+  data.tar.gz: 0134f1c7695a0c205e0b9f57fa6ed995fc568e55e1e999b37d80973ac102c0450d2bde94eaf20c7c72f74f534d9da6d9432a017224d1bac4eb4b05e8b04e9f2c

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+**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.0)
+    hash_cast (0.5.2)
 
 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/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/{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,11 +19,11 @@ 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
 
-    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/version.rb

@@ -1,3 +1,3 @@
 module HashCast
-  VERSION = "0.5.0"
+  VERSION = "0.5.2"
 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 "should raise error if 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)
-      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
-      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: true)
-      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
@@ -381,4 +412,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

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.0
+  version: 0.5.2
 platform: ruby
 authors:
 - Albert Gazizov
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-28 00:00:00.000000000 Z
+date: 2024-11-13 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
@@ -57,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
@@ -75,6 +75,7 @@ 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/hash_cast_spec.rb