sinclair 1.14.2 → 1.16.0

data/spec/lib/sinclair/caster/class_methods_spec.rb

@@ -0,0 +1,208 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Sinclair::Caster::ClassMethods do
+  subject(:caster) { Class.new(superclass) }
+
+  let(:superclass) do
+    Class.new(Sinclair::Caster) do
+      cast_with(:string, :to_s)
+      cast_with(:integer, :to_i)
+      cast_with(:float, :to_f)
+      cast_with(String, :to_s)
+    end
+  end
+
+  describe '.cast_with' do
+    let(:value)       { instance_double('value', to_p: final_value) }
+    let(:final_value) { Random.rand(100) }
+
+    context 'when a proc is given' do
+      it do
+        expect { caster.cast_with(:problem, &:to_p) }
+          .not_to raise_error
+      end
+
+      context 'when casting is called' do
+        before { caster.cast_with(:problem, &:to_p) }
+
+        it 'returns the cast value' do
+          expect(caster.cast(value, :problem)).to eq(final_value)
+        end
+      end
+    end
+
+    context 'when a proc with two arguments is given' do
+      it do
+        expect { caster.cast_with(:problem) { |v, **_opts| v.to_p } }
+          .not_to raise_error
+      end
+
+      context 'when casting is called' do
+        before { caster.cast_with(:problem) { |v, sum:| v.to_p + sum } }
+
+        it 'returns the cast value' do
+          expect(caster.cast(value, :problem, sum: 2))
+            .to eq(final_value + 2)
+        end
+      end
+    end
+
+    context 'when a symbol is given' do
+      let(:instance) { Sinclair::Caster.new(&:to_p) }
+
+      it do
+        expect { caster.cast_with(:problem, instance) }
+          .not_to raise_error
+      end
+
+      context 'when casting is called' do
+        before { caster.cast_with(:problem, instance) }
+
+        it 'returns the cast value' do
+          expect(caster.cast(value, :problem)).to eq(final_value)
+        end
+      end
+    end
+
+    context 'when a caster is given is given' do
+      it do
+        expect { caster.cast_with(:problem, :to_p) }
+          .not_to raise_error
+      end
+
+      context 'when casting is called' do
+        before { caster.cast_with(:problem, :to_p) }
+
+        it 'returns the cast value' do
+          expect(caster.cast(value, :problem)).to eq(final_value)
+        end
+      end
+    end
+
+    context 'when key is a class' do
+      it do
+        expect { caster.cast_with(Integer, :to_i) }
+          .not_to raise_error
+      end
+
+      context 'when casting is called' do
+        before { caster.cast_with(Integer, :to_i) }
+
+        it 'returns the cast value' do
+          expect(caster.cast('10', Integer)).to eq(10)
+        end
+      end
+    end
+
+    context 'when key is a module' do
+      it do
+        expect { caster.cast_with(JSON) { |value| JSON.parse(value) } }
+          .not_to raise_error
+      end
+
+      context 'when casting is called' do
+        before { caster.cast_with(JSON) { |value| JSON.parse(value) } }
+
+        it 'returns the cast value' do
+          expect(caster.cast('{"key":"value"}', JSON))
+            .to eq({ 'key' => 'value' })
+        end
+      end
+    end
+
+    context 'when key is a superclass' do
+      it do
+        expect { caster.cast_with(Numeric, :to_i) }
+          .not_to raise_error
+      end
+
+      context 'when casting is called with the child class' do
+        before { caster.cast_with(Numeric, :to_i) }
+
+        it 'returns the cast value' do
+          expect(caster.cast('10', Integer)).to eq(10)
+        end
+      end
+    end
+  end
+
+  describe '.caster_for' do
+    context 'when nil key is given' do
+      let(:value) { values.sample }
+      let(:values) do
+        [Random.rand, 'some string', { key: 10 }, Object.new, Class.new, [2, 3]]
+      end
+
+      it { expect(caster.caster_for(nil)).to be_a(Sinclair::Caster) }
+
+      it 'returns the default caster' do
+        expect(caster.caster_for(nil).cast(value)).to eq(value)
+      end
+    end
+
+    context 'when the key has been defined with a symbol key' do
+      before { caster.cast_with(:problem, :to_p) }
+
+      it do
+        expect(caster.caster_for(:problem))
+          .to be_a(Sinclair::Caster)
+      end
+    end
+
+    context 'when the key has not been defined' do
+      it do
+        expect(caster.caster_for(:problem))
+          .to be_a(Sinclair::Caster)
+      end
+    end
+  end
+
+  describe '.cast' do
+    let(:value) { values.sample }
+    let(:values) do
+      [Random.rand, 'some string', { key: 10 }, Object.new, Class.new, [2, 3]]
+    end
+
+    context 'when klass is nil' do
+      it 'returns the value' do
+        expect(caster.cast(value, nil))
+          .to eq(value)
+      end
+    end
+
+    context 'when class is :string' do
+      it 'returns the value as string' do
+        expect(caster.cast(value, :string))
+          .to eq(value.to_s)
+      end
+    end
+
+    context 'when class is :integer' do
+      let(:value) { '10.5' }
+
+      it 'returns the value as integer' do
+        expect(caster.cast(value, :integer))
+          .to eq(10)
+      end
+    end
+
+    context 'when class is :float' do
+      let(:value) { '10.5' }
+
+      it 'returns the value as float' do
+        expect(caster.cast(value, :float))
+          .to eq(10.5)
+      end
+    end
+  end
+
+  describe '.master_caster!' do
+    it 'ignores superclass registered casters' do
+      expect { caster.master_caster! }
+        .to change { caster.cast('10', :integer) }
+        .from(10).to('10')
+    end
+  end
+end

data/spec/lib/sinclair/caster_spec.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Sinclair::Caster do
+  subject(:caster) { caster_class.new(&method_name) }
+
+  let(:caster_class) { Class.new(described_class) }
+
+  describe '.cast' do
+    context 'when no options are given and the block accepts none' do
+      let(:method_name) { :to_s }
+
+      it 'uses the block to transform the value' do
+        expect(caster.cast(10)).to eq('10')
+      end
+    end
+
+    context 'when options are given and the block accepts none' do
+      let(:method_name) { :to_i }
+
+      it 'uses the block to transform the value' do
+        expect(caster.cast('10', extra: true)).to eq(10)
+      end
+    end
+
+    context 'when no options are given and the block accepts options' do
+      subject(:caster) do
+        caster_class.new do |value, sum: 5|
+          (value.to_i + sum).to_s
+        end
+      end
+
+      it 'uses the block to transform the value' do
+        expect(caster.cast('10')).to eq('15')
+      end
+    end
+
+    context 'when options are given and the block accepts options' do
+      subject(:caster) do
+        caster_class.new do |value, sum:|
+          (value.to_i + sum).to_s
+        end
+      end
+
+      it 'uses the options in the block' do
+        expect(caster.cast('10', sum: 5)).to eq('15')
+      end
+    end
+
+    context 'when no options are given and the block requires options' do
+      subject(:caster) do
+        caster_class.new do |value, sum:|
+          (value.to_i + sum).to_s
+        end
+      end
+
+      it do
+        expect { caster.cast('10') }.to raise_error(ArgumentError)
+      end
+    end
+
+    context 'when extra options are given and the block accepts options' do
+      subject(:caster) do
+        caster_class.new do |value, sum:|
+          (value.to_i + sum).to_s
+        end
+      end
+
+      it 'ignores extra options' do
+        expect(caster.cast('10', sum: 5, extra: true)).to eq('15')
+      end
+    end
+  end
+end

data/spec/support/models/enum_caster.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: false
+
+class EnumCaster < Sinclair::Caster
+  cast_with(:hash, :to_h)
+  cast_with(:array, :to_a)
+end

data/spec/support/models/enum_converter.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: false
+
+module EnumConverter
+  class << self
+    def to_hash(value)
+      return value if value.is_a?(Hash)
+
+      hash_caster.cast(value)
+    end
+
+    def to_array(value)
+      return value if value.is_a?(Array)
+
+      array_caster.cast(value)
+    end
+
+    private
+
+    def hash_caster
+      @hash_caster ||= EnumCaster.caster_for(:hash)
+    end
+
+    def array_caster
+      @array_caster ||= EnumCaster.caster_for(:array)
+    end
+  end
+end

data/spec/support/models/hash_model.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class HashModel
+  def initialize(hash)
+    hash.each do |attribute, value|
+      method_name = "#{attribute}="
+
+      send(method_name, value) if respond_to?(method_name)
+    end
+  end
+end

data/spec/support/models/hash_person.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+class HashPerson < HashModel
+  attr_accessor :name, :age
+
+  def ==(other)
+    return unless other.class == self.class
+
+    other.name == name && other.age == age
+  end
+end

data/spec/support/models/math_caster.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+class MathCaster < Sinclair::Caster
+  cast_with(:float, :to_f)
+
+  cast_with(:log) do |value, base: 10|
+    value = MathCaster.cast(value, :float)
+
+    Math.log(value, base)
+  end
+
+  cast_with(:exp) do |value, base: 10|
+    value = MathCaster.cast(value, :float)
+
+    base**value
+  end
+end

data/spec/support/models/ruby_string_caster.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+class RubyStringCaster < Sinclair::Caster
+  master_caster!
+
+  cast_with(NilClass) { 'nil' }
+  cast_with(Symbol) { |value| ":#{value}" }
+  cast_with(String, :to_json)
+  cast_with(Object, :to_s)
+
+  def self.to_ruby_string(value)
+    cast(value, value.class)
+  end
+end

data/spec/support/models/string_parser.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: false
+
+class StringParser < Sinclair::Caster
+  master_caster!
+
+  cast_with(JSON) { |value| JSON.parse(value) }
+  cast_with(Integer, :to_i)
+  cast_with(Float, :to_f)
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sinclair
 version: !ruby/object:Gem::Version
-  version: 1.14.2
+  version: 1.16.0
 platform: ruby
 authors:
 - DarthJee
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-04-27 00:00:00.000000000 Z
+date: 2023-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -273,6 +273,8 @@ files:
 - config/yardstick.yml
 - docker-compose.yml
 - lib/sinclair.rb
+- lib/sinclair/caster.rb
+- lib/sinclair/caster/class_methods.rb
 - lib/sinclair/class_methods.rb
 - lib/sinclair/comparable.rb
 - lib/sinclair/comparable/class_methods.rb
@@ -339,6 +341,10 @@ files:
 - spec/integration/yard/my_builder_spec.rb
 - spec/integration/yard/sinclair/add_class_method_spec.rb
 - spec/integration/yard/sinclair/add_method_spec.rb
+- spec/integration/yard/sinclair/caster/cast_spec.rb
+- spec/integration/yard/sinclair/caster/cast_with_spec.rb
+- spec/integration/yard/sinclair/caster/caster_for_spec.rb
+- spec/integration/yard/sinclair/caster/class_methods_spec.rb
 - spec/integration/yard/sinclair/class_methods/build_spec.rb
 - spec/integration/yard/sinclair/comparable_spec.rb
 - spec/integration/yard/sinclair/config_builder_spec.rb
@@ -361,6 +367,8 @@ files:
 - spec/integration/yard/sinclair/options_parser_spec.rb
 - spec/integration/yard/sinclair/options_spec.rb
 - spec/integration/yard/sinclair_spec.rb
+- spec/lib/sinclair/caster/class_methods_spec.rb
+- spec/lib/sinclair/caster_spec.rb
 - spec/lib/sinclair/class_methods_spec.rb
 - spec/lib/sinclair/comparable_spec.rb
 - spec/lib/sinclair/config/methods_builder_spec.rb
@@ -420,7 +428,11 @@ files:
 - spec/support/models/dummy_config.rb
 - spec/support/models/dummy_configurable.rb
 - spec/support/models/dummy_options_parser.rb
+- spec/support/models/enum_caster.rb
+- spec/support/models/enum_converter.rb
 - spec/support/models/env_settings.rb
+- spec/support/models/hash_model.rb
+- spec/support/models/hash_person.rb
 - spec/support/models/host_config.rb
 - spec/support/models/http_json_model.rb
 - spec/support/models/http_person.rb
@@ -429,6 +441,7 @@ files:
 - spec/support/models/job.rb
 - spec/support/models/login_config.rb
 - spec/support/models/login_configurable.rb
+- spec/support/models/math_caster.rb
 - spec/support/models/my_app_client.rb
 - spec/support/models/my_builder.rb
 - spec/support/models/my_class.rb
@@ -441,9 +454,11 @@ files:
 - spec/support/models/person.rb
 - spec/support/models/purchase.rb
 - spec/support/models/random_generator.rb
+- spec/support/models/ruby_string_caster.rb
 - spec/support/models/server.rb
 - spec/support/models/server_config.rb
 - spec/support/models/service_client.rb
+- spec/support/models/string_parser.rb
 - spec/support/models/tv.rb
 - spec/support/models/validator_builder.rb
 - spec/support/sample_model.rb