require 'spec_helper' describe Hashie::Trash do class TrashTest < Hashie::Trash property :first_name, from: :firstName end let(:trash) { TrashTest.new } describe 'translating properties' do it 'adds the property to the list' do expect(TrashTest.properties).to include(:first_name) end it 'creates a method for reading the property' do expect(trash).to respond_to(:first_name) end it 'creates a method for writing the property' do expect(trash).to respond_to(:first_name=) end it 'creates a method for writing the translated property' do expect(trash).to respond_to(:firstName=) end it 'does not create a method for reading the translated property' do expect(trash).not_to respond_to(:firstName) end it 'maintains translations hash mapping from the original to the translated name' do expect(TrashTest.translations[:firstName]).to eq(:first_name) end it 'maintains inverse translations hash mapping from the translated to the original name' do expect(TrashTest.inverse_translations[:first_name]).to eq :firstName end it '#permitted_input_keys contain the :from key of properties with translations' do expect(TrashTest.permitted_input_keys).to include :firstName end end describe 'standard properties' do class TrashTestPermitted < Hashie::Trash property :id end it '#permitted_input_keys contain names of properties without translations' do expect(TrashTestPermitted.permitted_input_keys).to include :id end end describe 'writing to properties' do it 'does not write to a non-existent property using []=' do expect { trash['abc'] = 123 }.to raise_error(NoMethodError) end it 'writes to an existing property using []=' do expect { trash[:first_name] = 'Bob' }.not_to raise_error expect(trash.first_name).to eq('Bob') expect { trash['first_name'] = 'John' }.to raise_error(NoMethodError) end it 'writes to a translated property using []=' do expect { trash[:firstName] = 'Bob' }.not_to raise_error expect { trash['firstName'] = 'Bob' }.to raise_error(NoMethodError) end it 'reads/writes to an existing property using a method call' do trash.first_name = 'Franklin' expect(trash.first_name).to eq 'Franklin' end it 'writes to an translated property using a method call' do trash.firstName = 'Franklin' expect(trash.first_name).to eq 'Franklin' end it 'writes to a translated property using #replace' do trash.replace(firstName: 'Franklin') expect(trash.first_name).to eq 'Franklin' end it 'writes to a non-translated property using #replace' do trash.replace(first_name: 'Franklin') expect(trash.first_name).to eq 'Franklin' end end describe ' initializing with a Hash' do it 'does not initialize non-existent properties' do expect { TrashTest.new(bork: 'abc') }.to raise_error(NoMethodError) end it 'sets the desired properties' do expect(TrashTest.new(first_name: 'Michael').first_name).to eq 'Michael' end context 'with both the translated property and the property' do it 'sets the desired properties' do expect(TrashTest.new(first_name: 'Michael', firstName: 'Maeve').first_name).to eq 'Michael' end end it 'sets the translated properties' do expect(TrashTest.new(firstName: 'Michael').first_name).to eq 'Michael' end end describe 'translating properties using a proc' do class TrashLambdaTest < Hashie::Trash property :first_name, from: :firstName, with: ->(value) { value.reverse } end let(:lambda_trash) { TrashLambdaTest.new } it 'translates the value given on initialization with the given lambda' do expect(TrashLambdaTest.new(firstName: 'Michael').first_name).to eq 'Michael'.reverse end it 'does not translate the value if given with the right property' do expect(TrashTest.new(first_name: 'Michael').first_name).to eq 'Michael' end it 'translates the value given as property with the given lambda' do lambda_trash.firstName = 'Michael' expect(lambda_trash.first_name).to eq 'Michael'.reverse end it 'does not translate the value given as right property' do lambda_trash.first_name = 'Michael' expect(lambda_trash.first_name).to eq 'Michael' end end describe 'translating multiple properties using a proc' do class SomeDataModel < Hashie::Trash property :value_a, from: :config, with: ->(config) { config.a } property :value_b, from: :config, with: ->(config) { config.b } end ConfigDataModel = Struct.new(:a, :b) subject { SomeDataModel.new(config: ConfigDataModel.new('value in a', 'value in b')) } it 'translates the first key' do expect(subject.value_a).to eq 'value in a' end it 'translates the second key' do expect(subject.value_b).to eq 'value in b' end it 'maintains translations hash mapping from the original to the translated name' do expect(SomeDataModel.translations).to eq(config: %i[value_a value_b]) end end describe 'uses with or transform_with interchangeably' do class TrashLambdaTestTransformWith < Hashie::Trash property :first_name, from: :firstName, transform_with: ->(value) { value.reverse } end let(:lambda_trash) { TrashLambdaTestTransformWith.new } it 'translates the value given as property with the given lambda' do lambda_trash.firstName = 'Michael' expect(lambda_trash.first_name).to eq 'Michael'.reverse end it 'does not translate the value given as right property' do lambda_trash.first_name = 'Michael' expect(lambda_trash.first_name).to eq 'Michael' end end describe 'translating properties without from option using a proc' do class TrashLambdaTestWithProperties < Hashie::Trash property :first_name, transform_with: ->(value) { value.reverse } end let(:lambda_trash) { TrashLambdaTestWithProperties.new } it 'translates the value given as property with the given lambda' do lambda_trash.first_name = 'Michael' expect(lambda_trash.first_name).to eq 'Michael'.reverse end it 'transforms the value when given in constructor' do expect( TrashLambdaTestWithProperties.new(first_name: 'Michael').first_name ).to eq 'Michael'.reverse end context 'when :from option is given' do class TrashLambdaTest3 < Hashie::Trash property :first_name, from: :firstName, transform_with: ->(value) { value.reverse } end it 'does not override the :from option in the constructor' do expect(TrashLambdaTest3.new(first_name: 'Michael').first_name).to eq 'Michael' end it 'does not override the :from option when given as property' do t = TrashLambdaTest3.new t.first_name = 'Michael' expect(t.first_name).to eq 'Michael' end end end describe 'inheritable transforms' do class TransformA < Hashie::Trash property :some_value, transform_with: ->(v) { v.to_i } end class TransformB < TransformA property :some_other_value, transform_with: ->(v) { v.to_i } end class TransformC < TransformB property :some_value, transform_with: ->(v) { -v.to_i } end it 'inherit properties transforms' do expect(TransformB.new(some_value: '123', some_other_value: '456').some_value).to eq(123) end it 'replaces property transform' do expect(TransformC.new(some_value: '123', some_other_value: '456').some_value).to eq(-123) end end describe 'inheritable translations' do class TranslationA < Hashie::Trash property :some_value, from: 'someValue', with: ->(v) { v.to_i } end class TranslationB < TranslationA property :some_other_value, from: 'someOtherValue' end it 'inherit properties translations' do expect(TranslationB.new('someValue' => '123').some_value).to eq(123) end end it 'raises an error when :from have the same value as property' do expect do class WrongTrash < Hashie::Trash property :first_name, from: :first_name end end.to raise_error(ArgumentError) end context 'when subclassing' do class Person < Hashie::Trash property :first_name, from: :firstName end class Hobbit < Person; end subject { Hobbit.new(firstName: 'Frodo') } it 'keeps translation definitions in subclasses' do expect(subject.first_name).to eq('Frodo') end end context 'when copying properties from other properties' do it 'retains the original and also sets the copy' do simple = Class.new(Hashie::Trash) do property :id property :copy_of_id, from: :id end subject = simple.new(id: 1) expect(subject.id).to eq(1) expect(subject.copy_of_id).to eq(1) end it 'grabs the default for the original if it is not set' do with_default = Class.new(Hashie::Trash) do property :id, default: 0 property :copy_of_id, from: :id end subject = with_default.new expect(subject.id).to eq(0) expect(subject.copy_of_id).to eq(0) end it 'can be a required value' do with_required = Class.new(Hashie::Trash) do property :id property :copy_of_id, from: :id, required: true, message: 'must be set' end expect { with_required.new }.to raise_error( ArgumentError, "The property 'copy_of_id' must be set" ) end it 'does not set properties that do not exist' do from_non_property = Class.new(Hashie::Trash) do property :copy_of_value, from: :value end subject = from_non_property.new(value: 0) expect(subject).not_to respond_to(:value) expect { subject[:value] }.to raise_error( NoMethodError, "The property 'value' is not defined for ." ) expect(subject.to_h[:value]).to eq(nil) expect(subject.copy_of_value).to eq(0) end it 'is not order-dependent in definition' do simple = Class.new(Hashie::Trash) do property :copy_of_id, from: :id property :id end subject = simple.new(id: 1) expect(subject.id).to eq(1) expect(subject.copy_of_id).to eq(1) end end end