virtus2 2.0.1

data/spec/unit/virtus/module_spec.rb

@@ -0,0 +1,174 @@
+require 'spec_helper'
+
+describe Virtus, '.module' do
+  shared_examples_for 'a valid virtus object' do
+    it 'reads and writes attribute' do
+      instance.name = 'John'
+      expect(instance.name).to eql('John')
+    end
+  end
+
+  shared_examples_for 'an object extended with virtus module' do
+    context 'with default configuration' do
+      subject { Virtus.module }
+
+      it_behaves_like 'a valid virtus object' do
+        let(:instance) { model.new }
+      end
+
+      it 'sets defaults' do
+        expect(instance.name).to eql('Jane')
+      end
+    end
+
+    context 'with constructor turned off' do
+      subject { Virtus.module(:constructor => false) }
+
+      it_behaves_like 'a valid virtus object' do
+        let(:instance) { model.new }
+      end
+
+      it 'skips including constructor' do
+        expect { model.new({}) }.to raise_error(ArgumentError)
+      end
+    end
+
+    context 'with mass assignment is turned off' do
+      subject { Virtus.module(:mass_assignment => false) }
+
+      it_behaves_like 'a valid virtus object'
+
+      it 'skips including mass assignment' do
+        expect(instance).not_to respond_to(:attributes)
+        expect(instance).not_to respond_to(:attributes=)
+      end
+    end
+
+    context 'with coercion turned off' do
+      subject { Virtus.module(:coerce => false) }
+
+      it_behaves_like 'a valid virtus object'
+
+      it 'builds non-coercible attributes' do
+        expect(object.send(:attribute_set)[:name]).not_to be_coercible
+      end
+    end
+  end
+
+  let(:mod)      { Module.new }
+  let(:model)    { Class.new }
+  let(:instance) { model.new }
+
+  before do
+    mod.send(:include, subject)
+    mod.attribute :name, String, :default => 'Jane'
+    mod.attribute :something
+  end
+
+  context 'with a class' do
+    let(:object) { model }
+
+    before do
+      model.send(:include, mod)
+    end
+
+    it 'provides attributes for the model' do
+      expect(model.attribute_set[:name]).to be_kind_of(Virtus::Attribute)
+    end
+
+    it 'defaults to Object for attribute type' do
+      expect(model.attribute_set[:something].type).to be(Axiom::Types::Object)
+    end
+
+    it_behaves_like 'an object extended with virtus module'
+  end
+
+  context 'with a model instance' do
+    let(:object) { instance }
+
+    before do
+      instance.extend(mod)
+    end
+
+    it 'provides attributes for the instance' do
+      expect(instance.send(:attribute_set)[:name]).to be_kind_of(Virtus::Attribute)
+    end
+
+    it_behaves_like 'an object extended with virtus module'
+  end
+
+  context 'with another module' do
+    let(:other)  { Module.new }
+
+    let(:object) { instance }
+
+    before do
+      other.send(:include, mod)
+      model.send(:include, other)
+    end
+
+    it_behaves_like 'an object extended with virtus module'
+
+    it 'provides attributes for the model' do
+      expect(model.attribute_set[:name]).to be_kind_of(Virtus::Attribute)
+    end
+  end
+
+  context 'as a peer to another module within a class' do
+    subject { Virtus.module }
+    let(:other)  { Module.new }
+
+    before do
+      other.send(:include, Virtus.module)
+      other.attribute :last_name, String, :default => 'Doe'
+      other.attribute :something_else
+      model.send(:include, mod)
+      model.send(:include, other)
+    end
+
+    it 'provides attributes for the model from both modules' do
+      expect(model.attribute_set[:name]).to be_kind_of(Virtus::Attribute)
+      expect(model.attribute_set[:something]).to be_kind_of(Virtus::Attribute)
+      expect(model.attribute_set[:last_name]).to be_kind_of(Virtus::Attribute)
+      expect(model.attribute_set[:something_else]).to be_kind_of(Virtus::Attribute)
+    end
+
+    it 'includes the attributes from both modules' do
+      expect(model.new.attributes.keys).to eq(
+        [:name, :something, :last_name, :something_else]
+      )
+    end
+  end
+
+  context 'with multiple other modules mixed into it' do
+    subject { Virtus.module }
+    let(:other)  { Module.new }
+    let(:yet_another)  { Module.new }
+
+    before do
+      other.send(:include, Virtus.module)
+      other.attribute :last_name, String, :default => 'Doe'
+      other.attribute :something_else
+      yet_another.send(:include, Virtus.module)
+      yet_another.send(:include, mod)
+      yet_another.send(:include, other)
+      yet_another.attribute :middle_name, String, :default => 'Foobar'
+      model.send(:include, yet_another)
+    end
+
+    it 'provides attributes for the model from all modules' do
+      expect(model.attribute_set[:name]).to be_kind_of(Virtus::Attribute)
+      expect(model.attribute_set[:something]).to be_kind_of(Virtus::Attribute)
+      expect(model.attribute_set[:last_name]).to be_kind_of(Virtus::Attribute)
+      expect(model.attribute_set[:something_else]).to be_kind_of(Virtus::Attribute)
+      expect(model.attribute_set[:middle_name]).to be_kind_of(Virtus::Attribute)
+    end
+
+    it 'includes the attributes from all modules' do
+      expect(model.new.attributes.keys).to eq(
+        [:name, :something, :last_name, :something_else, :middle_name]
+      )
+    end
+  end
+
+end

data/spec/unit/virtus/set_default_attributes_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe Virtus, '#set_default_attributes!' do
+  subject { object.set_default_attributes! }
+
+  let(:model) {
+    Class.new {
+      include Virtus
+
+      attribute :name, String,  :default => 'foo', :lazy => true
+      attribute :age,  Integer, :default => 30
+    }
+  }
+
+  let(:object) { model.new }
+
+  before do
+    object.set_default_attributes!
+  end
+
+  it { is_expected.to be(object) }
+
+  describe '#name' do
+    subject { super().name }
+    it { is_expected.to eql('foo') }
+  end
+
+  describe '#age' do
+    subject { super().age }
+    it { is_expected.to be(30) }
+  end
+end

data/spec/unit/virtus/value_object_spec.rb

@@ -0,0 +1,138 @@
+require 'spec_helper'
+
+describe Virtus::ValueObject do
+  shared_examples_for 'a valid value object' do
+    subject { model.new(attributes) }
+
+    let(:attributes) { Hash[:id => 1, :name => 'Jane Doe'] }
+
+    describe '#id' do
+      subject { super().id }
+      it { is_expected.to be(1) }
+    end
+
+    describe '#name' do
+      subject { super().name }
+      it { is_expected.to eql('Jane Doe') }
+    end
+
+    it 'sets private writers' do
+      expect(subject.class.attribute_set[:id]).to_not be_public_writer
+      expect(subject.class.attribute_set[:name]).to_not be_public_writer
+    end
+
+    it 'disallows cloning' do
+      expect(subject.clone).to be(subject)
+    end
+
+    it 'defines #eql?' do
+      expect(subject).to eql(subject.class.new(attributes))
+    end
+
+    it 'defines #==' do
+      expect(subject == subject.class.new(attributes)).to be(true)
+    end
+
+    it 'defines #hash' do
+      expect(subject.hash).to eql(subject.class.new(attributes).hash)
+    end
+
+    it 'defines #inspect' do
+      expect(subject.inspect).to eql(
+        %(#<Model #{attributes.map { |k, v| "#{k}=#{v.inspect}" }.join(' ')}>)
+      )
+    end
+
+    it 'allows to construct new values using #with' do
+      new_instance = subject.with(:name => "John Doe")
+      expect(new_instance.id).to eql(subject.id)
+      expect(new_instance.name).to eql("John Doe")
+    end
+  end
+
+  shared_examples_for 'a valid value object with mass-assignment turned on' do
+    subject { model.new }
+
+    it 'disallows mass-assignment' do
+      expect(subject.private_methods).to include(:attributes=)
+    end
+  end
+
+  context 'using new values {} block' do
+    let(:model) {
+      model = Virtus.value_object(:coerce => false, :mass_assignment => mass_assignment)
+
+      Class.new {
+        include model
+
+        def self.name
+          'Model'
+        end
+
+        values do
+          attribute :id,   Integer
+          attribute :name, String
+        end
+      }
+    }
+
+    context 'without mass-assignment' do
+      let(:mass_assignment) { false }
+
+      it_behaves_like 'a valid value object'
+    end
+
+    context 'with mass-assignment' do
+      let(:mass_assignment) { true }
+
+      it_behaves_like 'a valid value object'
+      it_behaves_like 'a valid value object with mass-assignment turned on'
+
+      context 'with a model subclass' do
+        let(:subclass) {
+          Class.new(model) {
+            values do
+              attribute :email, String
+            end
+          }
+        }
+
+        it_behaves_like 'a valid value object' do
+          subject { subclass.new(attributes) }
+
+          let(:attributes) { Hash[:id => 1, :name => 'Jane Doe', :email => 'jane@doe.com'] }
+
+          describe '#email' do
+            subject { super().email }
+            it { is_expected.to eql('jane@doe.com') }
+          end
+
+          it 'sets private writers for additional values' do
+            expect(subclass.attribute_set[:email]).to_not be_public_writer
+          end
+
+          it 'defines valid #== for a subclass' do
+            expect(subject == subject.class.new(attributes.merge(:id => 2))).to be(false)
+          end
+        end
+      end
+    end
+  end
+
+  context 'using deprecated inclusion' do
+    let(:model) {
+      Class.new {
+        include Virtus::ValueObject
+
+        def self.name
+          'Model'
+        end
+
+        attribute :id,   Integer
+        attribute :name, String
+      }
+    }
+
+    it_behaves_like 'a valid value object'
+  end
+end

data/virtus2.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+
+require File.expand_path('../lib/virtus/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name        = "virtus2"
+  gem.version     = Virtus::VERSION.dup
+  gem.authors     = [ "Piotr Solnica", "Daniel Orner" ]
+  gem.email       = [ "dmorner@gmail.com" ]
+  gem.description = "Attributes on Steroids for Plain Old Ruby Objects"
+  gem.summary     = gem.description
+  gem.homepage    = "https://github.com/wishabi/virtus2"
+  gem.license     = 'MIT'
+
+  gem.require_paths    = [ "lib" ]
+  gem.files            = `git ls-files`.split("\n")
+  gem.test_files       = `git ls-files -- {spec}/*`.split("\n")
+  gem.extra_rdoc_files = %w[LICENSE README.md TODO.md]
+
+  gem.add_dependency('descendants_tracker', '~> 0.0', '>= 0.0.3')
+  gem.add_dependency('coercible', '~> 1.0')
+  gem.add_dependency('axiom-types', '~> 0.1')
+
+  gem.add_development_dependency 'rake'
+  gem.required_ruby_version = '>= 2.0'
+end

metadata

@@ -0,0 +1,225 @@
+--- !ruby/object:Gem::Specification
+name: virtus2
+version: !ruby/object:Gem::Version
+  version: 2.0.1
+platform: ruby
+authors:
+- Piotr Solnica
+- Daniel Orner
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-09-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: descendants_tracker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+- !ruby/object:Gem::Dependency
+  name: coercible
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: axiom-types
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !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: Attributes on Steroids for Plain Old Ruby Objects
+email:
+- dmorner@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+- README.md
+- TODO.md
+files:
+- ".gitignore"
+- ".rspec"
+- ".yardopts"
+- CONTRIBUTING.md
+- Changelog.md
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- TODO.md
+- lib/virtus.rb
+- lib/virtus/attribute.rb
+- lib/virtus/attribute/accessor.rb
+- lib/virtus/attribute/boolean.rb
+- lib/virtus/attribute/builder.rb
+- lib/virtus/attribute/coercer.rb
+- lib/virtus/attribute/coercible.rb
+- lib/virtus/attribute/collection.rb
+- lib/virtus/attribute/default_value.rb
+- lib/virtus/attribute/default_value/from_callable.rb
+- lib/virtus/attribute/default_value/from_clonable.rb
+- lib/virtus/attribute/default_value/from_symbol.rb
+- lib/virtus/attribute/embedded_value.rb
+- lib/virtus/attribute/enum.rb
+- lib/virtus/attribute/hash.rb
+- lib/virtus/attribute/lazy_default.rb
+- lib/virtus/attribute/nullify_blank.rb
+- lib/virtus/attribute/strict.rb
+- lib/virtus/attribute_set.rb
+- lib/virtus/builder.rb
+- lib/virtus/builder/hook_context.rb
+- lib/virtus/class_inclusions.rb
+- lib/virtus/class_methods.rb
+- lib/virtus/coercer.rb
+- lib/virtus/configuration.rb
+- lib/virtus/const_missing_extensions.rb
+- lib/virtus/extensions.rb
+- lib/virtus/instance_methods.rb
+- lib/virtus/model.rb
+- lib/virtus/module_extensions.rb
+- lib/virtus/support/equalizer.rb
+- lib/virtus/support/options.rb
+- lib/virtus/support/type_lookup.rb
+- lib/virtus/value_object.rb
+- lib/virtus/version.rb
+- spec/integration/attributes_attribute_spec.rb
+- spec/integration/building_module_spec.rb
+- spec/integration/collection_member_coercion_spec.rb
+- spec/integration/custom_attributes_spec.rb
+- spec/integration/custom_collection_attributes_spec.rb
+- spec/integration/default_values_spec.rb
+- spec/integration/defining_attributes_spec.rb
+- spec/integration/embedded_value_spec.rb
+- spec/integration/extending_objects_spec.rb
+- spec/integration/hash_attributes_coercion_spec.rb
+- spec/integration/inheritance_spec.rb
+- spec/integration/injectible_coercers_spec.rb
+- spec/integration/mass_assignment_with_accessors_spec.rb
+- spec/integration/overriding_virtus_spec.rb
+- spec/integration/required_attributes_spec.rb
+- spec/integration/struct_as_embedded_value_spec.rb
+- spec/integration/using_modules_spec.rb
+- spec/integration/value_object_with_custom_constructor_spec.rb
+- spec/integration/virtus/instance_level_attributes_spec.rb
+- spec/integration/virtus/value_object_spec.rb
+- spec/shared/constants_helpers.rb
+- spec/shared/freeze_method_behavior.rb
+- spec/shared/idempotent_method_behaviour.rb
+- spec/shared/options_class_method.rb
+- spec/spec_helper.rb
+- spec/unit/virtus/attribute/boolean/coerce_spec.rb
+- spec/unit/virtus/attribute/boolean/value_coerced_predicate_spec.rb
+- spec/unit/virtus/attribute/class_methods/build_spec.rb
+- spec/unit/virtus/attribute/class_methods/coerce_spec.rb
+- spec/unit/virtus/attribute/coerce_spec.rb
+- spec/unit/virtus/attribute/coercible_predicate_spec.rb
+- spec/unit/virtus/attribute/collection/class_methods/build_spec.rb
+- spec/unit/virtus/attribute/collection/coerce_spec.rb
+- spec/unit/virtus/attribute/collection/value_coerced_predicate_spec.rb
+- spec/unit/virtus/attribute/comparison_spec.rb
+- spec/unit/virtus/attribute/custom_collection_spec.rb
+- spec/unit/virtus/attribute/defined_spec.rb
+- spec/unit/virtus/attribute/embedded_value/class_methods/build_spec.rb
+- spec/unit/virtus/attribute/embedded_value/coerce_spec.rb
+- spec/unit/virtus/attribute/get_spec.rb
+- spec/unit/virtus/attribute/hash/class_methods/build_spec.rb
+- spec/unit/virtus/attribute/hash/coerce_spec.rb
+- spec/unit/virtus/attribute/lazy_predicate_spec.rb
+- spec/unit/virtus/attribute/rename_spec.rb
+- spec/unit/virtus/attribute/required_predicate_spec.rb
+- spec/unit/virtus/attribute/set_default_value_spec.rb
+- spec/unit/virtus/attribute/set_spec.rb
+- spec/unit/virtus/attribute/value_coerced_predicate_spec.rb
+- spec/unit/virtus/attribute_set/append_spec.rb
+- spec/unit/virtus/attribute_set/define_reader_method_spec.rb
+- spec/unit/virtus/attribute_set/define_writer_method_spec.rb
+- spec/unit/virtus/attribute_set/each_spec.rb
+- spec/unit/virtus/attribute_set/element_reference_spec.rb
+- spec/unit/virtus/attribute_set/element_set_spec.rb
+- spec/unit/virtus/attribute_set/merge_spec.rb
+- spec/unit/virtus/attribute_set/reset_spec.rb
+- spec/unit/virtus/attribute_spec.rb
+- spec/unit/virtus/attributes_reader_spec.rb
+- spec/unit/virtus/attributes_writer_spec.rb
+- spec/unit/virtus/class_methods/finalize_spec.rb
+- spec/unit/virtus/class_methods/new_spec.rb
+- spec/unit/virtus/config_spec.rb
+- spec/unit/virtus/element_reader_spec.rb
+- spec/unit/virtus/element_writer_spec.rb
+- spec/unit/virtus/freeze_spec.rb
+- spec/unit/virtus/model_spec.rb
+- spec/unit/virtus/module_spec.rb
+- spec/unit/virtus/set_default_attributes_spec.rb
+- spec/unit/virtus/value_object_spec.rb
+- virtus2.gemspec
+homepage: https://github.com/wishabi/virtus2
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.21
+signing_key:
+specification_version: 4
+summary: Attributes on Steroids for Plain Old Ruby Objects
+test_files: []