hash_cast 0.4.0

data/spec/hcast/caster_spec.rb

@@ -0,0 +1,384 @@
+require 'spec_helper'
+
+describe HCast::Caster do
+  describe "#cast" do
+
+    class ContactCaster
+      include HCast::Caster
+
+      attributes do
+        hash :contact do
+          string   :name
+          integer  :age, optional: true
+          float    :weight
+          date     :birthday
+          datetime :last_logged_in
+          time     :last_visited_at
+          hash :company do
+            string :name
+          end
+          array :emails, each: :string
+          array :social_accounts, each: :hash do
+            string :name
+            symbol :type
+          end
+        end
+      end
+    end
+
+    it "should cast hash attributes" do
+      input_hash = {
+        contact: {
+          name: "John Smith",
+          age: "22",
+          weight: "65.5",
+          birthday: "2014-02-02",
+          last_logged_in: "2014-02-02 10:10:00",
+          last_visited_at: "2014-02-02 10:10:00",
+          company: {
+            name: "MyCo",
+          },
+          emails: [ "test@example.com", "test2@example.com" ],
+          social_accounts: [
+            {
+              name: "john_smith",
+              type: 'twitter',
+            },
+            {
+              name: "John",
+              type: :facebook,
+            },
+          ]
+        }
+      }
+
+      casted_hash = ContactCaster.cast(input_hash)
+
+      casted_hash.should == {
+        contact: {
+          name: "John Smith",
+          age: 22,
+          weight: 65.5,
+          birthday: Date.parse("2014-02-02"),
+          last_logged_in: DateTime.parse("2014-02-02 10:10:00"),
+          last_visited_at: Time.parse("2014-02-02 10:10:00"),
+          company: {
+            name: "MyCo",
+          },
+          emails: [ "test@example.com", "test2@example.com" ],
+          social_accounts: [
+            {
+              name: "john_smith",
+              type: :twitter,
+            },
+            {
+              name: "John",
+              type: :facebook,
+            },
+          ]
+        }
+      }
+    end
+
+    describe "Custom casters" do
+      class SettingsCaster
+        include HCast::Caster
+
+        attributes do
+          string :account
+        end
+      end
+
+      class EmailCaster
+        include HCast::Caster
+
+        attributes do
+          string :address
+        end
+      end
+
+      class CompanyCaster
+        include HCast::Caster
+
+        attributes do
+          string :name
+          hash   :settings, caster: SettingsCaster
+          array  :emails,  caster: EmailCaster
+        end
+      end
+
+      it "should allow specify caster for nested hash attribute" do
+        casted_hash = CompanyCaster.cast(
+          name: 'Might & Magic',
+          settings: {
+            account: :'migthy_lord'
+          },
+          emails: [
+            { address: :'test1@example.com' },
+            { address: :'test2@example.com' },
+          ]
+        )
+
+        casted_hash.should == {
+          name: "Might & Magic",
+          settings: { account: "migthy_lord" },
+          emails: [
+            { address: "test1@example.com" },
+            { address: "test2@example.com" }
+          ]
+        }
+      end
+    end
+
+    it "should raise error if some attribute can't be casted" do
+      input_hash = {
+        contact: {
+          name: {},
+          age: 22,
+          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(HCast::Errors::CastingError, "contact[name] should be a string")
+    end
+
+    it "should raise error if some attribute wasn't given" do
+      input_hash = {
+        contact: {
+          age: 22,
+          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(HCast::Errors::MissingAttributeError, "contact[name] should be given")
+    end
+
+    it "should not raise error if attribute is optional" do
+      input_hash = {
+        contact: {
+          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_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(HCast::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(HCast::Errors::UnexpectedAttributeError)
+
+    end
+
+    it "should convert accept hash with string keys and cast them to symbol keys" do
+      input_hash = {
+        'contact' => {
+          'name' => "John Smith",
+          'age' => "22",
+          'weight' => "65.5",
+          'birthday' => "2014-02-02",
+          'last_logged_in' => "2014-02-02 10:10:00",
+          'last_visited_at' => "2014-02-02 10:10:00",
+          'company' => {
+            'name' => "MyCo",
+          },
+          'emails' => [ "test@example.com", "test2@example.com" ],
+          'social_accounts' => [
+            {
+             'name' => "john_smith",
+             'type' => 'twitter',
+            },
+            {
+             'name' => "John",
+             'type' => :facebook,
+            },
+          ]
+        }
+      }
+
+      casted_hash = ContactCaster.cast(input_hash, input_keys: :string, output_keys: :symbol)
+
+      casted_hash.should == {
+        contact: {
+          name: "John Smith",
+          age: 22,
+          weight: 65.5,
+          birthday: Date.parse("2014-02-02"),
+          last_logged_in: DateTime.parse("2014-02-02 10:10:00"),
+          last_visited_at: Time.parse("2014-02-02 10:10:00"),
+          company: {
+            name: "MyCo",
+          },
+          emails: [ "test@example.com", "test2@example.com" ],
+          social_accounts: [
+            {
+              name: "john_smith",
+              type: :twitter,
+            },
+            {
+              name: "John",
+              type: :facebook,
+            },
+          ]
+        }
+      }
+    end
+  end
+
+  context "checking invalid parameters" do
+    it "should raise CaterNotFound exception if caster name is invalid" do
+      expect do
+        class WrongCaster
+          include HCast::Caster
+
+          attributes do
+            integr   :name
+          end
+        end
+      end.to raise_error(HCast::Errors::CasterNotFoundError)
+    end
+  end
+
+  context "allow nil values" do
+    before(:all) do
+      class HomeCaster
+        include HCast::Caster
+
+        attributes do
+          string   :city
+          integer  :zip, allow_nil: true
+        end
+      end
+    end
+
+    it "should allow nil values if allow_nil is set to true" do
+      HomeCaster.cast(
+        city: 'Kazan',
+        zip: nil
+      )
+    end
+
+    it "should allow nil values unless allow_nil is set to true" do
+      expect do
+        HomeCaster.cast(
+          city: nil,
+          zip: nil
+        )
+      end.to raise_error(HCast::Errors::CastingError, "city should be a string")
+    end
+  end
+end

data/spec/hcast/hcast_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe HCast do
+
+  describe ".create" do
+    it "should cast hash attributes" do
+      pending "NOT YET IMPLEMENTED"
+      input_hash = {
+        contact: {
+          name: "John Smith",
+          age: "22",
+          company: {
+            name: "MyCo",
+          }
+        }
+      }
+
+      caster = HCast.create do
+        hash :contact do
+          string   :name
+          integer  :age
+          hash :company do
+            string :name
+          end
+        end
+
+        def registered?
+          true
+        end
+      end
+
+      casted_hash = caster.cast(input_hash)
+      casted_hash.object_id.should_not == hash.object_id
+      caster_hash.should == hash
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'hcast'
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: hash_cast
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- Albert Gazizov
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-10-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Declarative Hash Caster
+email:
+- deeper4k@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/rspec.yml"
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- hcast.gemspec
+- lib/hcast.rb
+- lib/hcast/attributes_caster.rb
+- lib/hcast/attributes_parser.rb
+- lib/hcast/caster.rb
+- lib/hcast/casters.rb
+- lib/hcast/casters/array_caster.rb
+- lib/hcast/casters/boolean_caster.rb
+- lib/hcast/casters/date_caster.rb
+- lib/hcast/casters/datetime_caster.rb
+- lib/hcast/casters/float_caster.rb
+- lib/hcast/casters/hash_caster.rb
+- lib/hcast/casters/integer_caster.rb
+- lib/hcast/casters/string_caster.rb
+- lib/hcast/casters/symbol_caster.rb
+- lib/hcast/casters/time_caster.rb
+- lib/hcast/concern.rb
+- lib/hcast/config.rb
+- lib/hcast/errors.rb
+- lib/hcast/metadata/attribute.rb
+- lib/hcast/version.rb
+- spec/hcast/caster_spec.rb
+- spec/hcast/hcast_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/droidlabs/hash_cast
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: Declarative Hash Caster
+test_files:
+- spec/hcast/caster_spec.rb
+- spec/hcast/hcast_spec.rb
+- spec/spec_helper.rb