hexx-entities 0.0.1 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0cfb1586f444fcffc282f8875fc0f158e93e190e
-  data.tar.gz: b7ed4909ae9aeb7cd0e91969d418e852dd80f063
+  metadata.gz: 5c93ee8a3d4271e91a696427b35b8a6ba05da2a0
+  data.tar.gz: 6f69ca96cbb85cbafbf36a9b8946552f3cdc69b2
 SHA512:
-  metadata.gz: f4b9a371d643448b7a762f2797a1666ad10401d2f006de90250000fe869b03d28475c86b26d67bed7785a959e6ae65cf04cad84e090e785c42d1b434a7cfaeda
-  data.tar.gz: d4b415a67d586bd3fa957db482344a04b6713ac5e20d918c77864ff64c4b10445d68595be294fc3d1f18dfe02c628e6c2ba8aaf49eb5ffe7d56fb05d677ed4e5
+  metadata.gz: 10b1cdf1f6695351854f948df670eb34104ae9e6bce235619847d559d4a15454ad58085039fbd565d428f0ce6b0633e53252c718f9bc6d425ae19fa122d9cb3b
+  data.tar.gz: 417fe608dfa733f29eb8a198698cc5e2b730c07fb0af8a91bffa757a285d85d5ed7f259073a724cff8f0f9276d27254018af1c5cfd48e3985d247bba2940a6ee

data/README.md

@@ -52,12 +52,18 @@ class Item < Hexx::Entities::Base
 end # class Item
 
 item = Item.new foo: 1
+
+item.frozen?
+# => true
 item.attributes
 # => { uuids: ["31a840f4-71e2-4de1-3a6f-04d2103aa2e8"], foo: "1", bar: nil }
 item.validate!
 # <Attestor::InvalidError> because bar is nil
 ```
 
+To model parts of aggregate entities, that have no identity by themselves,
+use `Hexx::Entitites::Part`. The part is just the entity without `uuids`.
+
 Installation
 ------------
 

data/lib/hexx-entities.rb

@@ -10,6 +10,7 @@ require "securerandom"  # for uuids
 module Hexx
 
   require_relative "hexx/entities" # for namespace
+  require_relative "hexx/entities/part"
   require_relative "hexx/entities/uuid"
   require_relative "hexx/entities/uuids"
   require_relative "hexx/entities/base"

data/lib/hexx/entities/base.rb

@@ -2,7 +2,7 @@
 
 module Hexx::Entities
 
-  # Class Base provides a common interface for entities
+  # Class Base provides a common interface for entities, that have identity
   #
   # @example
   #   require "hexx-entities"
@@ -20,10 +20,7 @@ module Hexx::Entities
   # @author Andrew Kozin <Andrew.Kozin@gmail.com>
   #
   # @api public
-  class Base
-    include Attestor::Validations
-    include Comparable
-    include Eigindir
+  class Base < Part
 
     # @!scope class
     # @!method new(attributes)
@@ -36,7 +33,7 @@ module Hexx::Entities
     # @private
     def initialize(uuids: nil, **attributes)
       @uuids = UUIDs.build Array(uuids)
-      self.attributes = attributes
+      super attributes
     end
 
     # @!attribute [rw] uuids
@@ -58,19 +55,6 @@ module Hexx::Entities
       (other.uuids & uuids).any?
     end
 
-    # Recursively serializes the entity to the hash
-    #
-    # Returns the hash of entity attributes, where every attribute
-    # that responds to `serialize` is serialized in its turn.
-    #
-    # @return [Hash]
-    def serialize
-      values = attributes.values.map do |item|
-        item.respond_to?(:serialize) ? item.serialize : item
-      end
-      attributes.keys.zip(values).to_h
-    end
-
   end # class Base
 
 end # module Hexx::Entities

data/lib/hexx/entities/part.rb

@@ -0,0 +1,57 @@
+# encoding: utf-8
+
+module Hexx::Entities
+
+  # Class Part provides a common interface for parts of aggregate entities
+  #
+  # @example
+  #   require "hexx-entities"
+  #
+  #   class Item < Hexx::Entities::Part
+  #
+  #     # Defines attributes with their coercers
+  #     attribute :foo, coerce: ->(value) { value.to_s }
+  #
+  #     # Defines validation for the entity
+  #     validate { invalid :blank_foo unless foo }
+  #
+  #   end # class Item
+  #
+  # @author Andrew Kozin <Andrew.Kozin@gmail.com>
+  #
+  # @api public
+  class Part
+    include Attestor::Validations
+    include Comparable
+    include Eigindir
+
+    # @!scope class
+    # @!method new(attributes)
+    # Creates the immutable object
+    #
+    # @param [Hash] attributes
+    #
+    # @return [Hexx::Entities::Part]
+
+    # @private
+    def initialize(**attributes)
+      self.attributes = attributes
+      freeze
+    end
+
+    # Recursively serializes the part to the hash
+    #
+    # Returns the hash of attributes, where every attribute
+    # that responds to `serialize` is serialized in its turn.
+    #
+    # @return [Hash]
+    def serialize
+      values = attributes.values.map do |item|
+        item.respond_to?(:serialize) ? item.serialize : item
+      end
+      attributes.keys.zip(values).to_h
+    end
+
+  end # class Part
+
+end # module Hexx::Entities

data/lib/hexx/entities/version.rb

@@ -6,7 +6,7 @@ module Hexx
 
     # The semantic version of the module.
     # @see http://semver.org/ Semantic versioning 2.0
-    VERSION = "0.0.1".freeze
+    VERSION = "0.1.1".freeze
 
   end # module Entities
 

data/spec/tests/base_spec.rb

@@ -11,22 +11,8 @@ describe Hexx::Entities::Base do
 
   describe ".new" do
 
-    it "creates validatable object" do
-      expect(subject).to be_kind_of Attestor::Validations
-    end
-
-    it "creates attributable object" do
-      expect(subject).to be_kind_of Eigindir
-    end
-
-    it "creates comparable object" do
-      expect(subject).to be_kind_of Comparable
-    end
-
-    it "initializes attributes from hash" do
-      klass.attribute :foo
-      subject = klass.new foo: :bar
-      expect(subject.foo).to eq :bar
+    it "creates a part" do
+      expect(subject).to be_kind_of Hexx::Entities::Part
     end
 
   end # describe .new

data/spec/tests/part_spec.rb

@@ -0,0 +1,55 @@
+# encoding: utf-8
+
+require "attestor/rspec"
+
+describe Hexx::Entities::Part do
+  include Attestor::RSpec # helpers and matchers for validations
+
+  let(:klass) { Class.new(described_class) }
+
+  subject(:entity) { klass.new }
+
+  describe ".new" do
+
+    it "creates validatable object" do
+      expect(subject).to be_kind_of Attestor::Validations
+    end
+
+    it "creates attributable object" do
+      expect(subject).to be_kind_of Eigindir
+    end
+
+    it "creates comparable object" do
+      expect(subject).to be_kind_of Comparable
+    end
+
+    it "initializes attributes from hash" do
+      klass.attribute :foo
+      subject = klass.new foo: :bar
+      expect(subject.foo).to eq :bar
+    end
+
+    it "creates immutable object" do
+      expect(subject).to be_frozen
+    end
+
+  end # describe .new
+
+  describe "#serialize" do
+
+    before { klass.attribute :foo }
+    before { klass.attribute :bar }
+
+    let(:bar)   { double }
+    let(:baz)   { double serialize: { baz: :baz } }
+    let(:uuids) { [SecureRandom.uuid] }
+
+    subject(:entity) { klass.new(foo: bar, bar: baz) }
+
+    it "returns a nested hash" do
+      expect(entity.serialize).to eq(foo: bar, bar: { baz: :baz })
+    end
+
+  end # describe #to_hash
+
+end # describe Hexx::Entities::Part

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hexx-entities
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.1
 platform: ruby
 authors:
 - Andrew Kozin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-29 00:00:00.000000000 Z
+date: 2015-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: attestor
@@ -87,11 +87,13 @@ files:
 - lib/hexx-entities.rb
 - lib/hexx/entities.rb
 - lib/hexx/entities/base.rb
+- lib/hexx/entities/part.rb
 - lib/hexx/entities/uuid.rb
 - lib/hexx/entities/uuids.rb
 - lib/hexx/entities/version.rb
 - spec/spec_helper.rb
 - spec/tests/base_spec.rb
+- spec/tests/part_spec.rb
 - spec/tests/uuid_spec.rb
 - spec/tests/uuids_spec.rb
 homepage: https://github.com/nepalez/hexx-entities
@@ -120,6 +122,7 @@ specification_version: 4
 summary: Base class for domain entities
 test_files:
 - spec/spec_helper.rb
+- spec/tests/part_spec.rb
 - spec/tests/uuid_spec.rb
 - spec/tests/uuids_spec.rb
 - spec/tests/base_spec.rb