wholable 0.0.0 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 42f00bcfb8063a21a4fb8f6427424078be9ce45365d2b41f5a6c053133b059d7
-  data.tar.gz: 267014e8011488d2b9e3db0fcdecebe6a70c0032e8f47ea60cb0d3b035174719
+  metadata.gz: bdd21036f1cae41b84f1db0c85aa8806770de6317ffff2e5928faa938871e9d5
+  data.tar.gz: 258dd2e251c8dd9d385d4331c20ab6395c8ccb93c5ee47cd079849df80bf2cd2
 SHA512:
-  metadata.gz: 94334fe408aa2e6ac16589688f1c3e3a4d746f738ef9ec4c75d2031e10898463ce63954e0c8f147167396a0a18da79d312a75a5a3ce52bc663a773be824841d9
-  data.tar.gz: b921837f4c80fb2651cf6a135c367c0fd2bbf18a5dfa47c0ad52838ad6f6482b90492e18d312093660f2f4ee693f56c49768647b50c8f7e0b5c93d0a9d99c9d7
+  metadata.gz: add335b9cdfc0ff14334b77aff7ee3295419fcf0fe4b78470925f6f395a85ded7cd47496213e9f36695e60833b4cf04692e9c030c02869d2fbff42352cabaa36
+  data.tar.gz: e2a9f041d020e166111905e76396887e9aae3f6f1f7475790a5dcb32678eb038c171a7e790ba1b196c0d9604463e6072e5975151980c3e67d61e930959a0a60f

data/README.adoc

@@ -3,23 +3,33 @@
 :figure-caption!:
 
 :data_link: link:https://alchemists.io/articles/ruby_data[Data]
+:pattern_matching_link: link:https://alchemists.io/articles/ruby_pattern_matching[pattern matching]
+:ruby_link: link:https://www.ruby-lang.org[Ruby]
+:data_link: link:https://alchemists.io/articles/ruby_data[Data]
+:structs_link: link:https://alchemists.io/articles/ruby_structs[Structs]
 
 = Wholable
 
-Wholable is a mixin that turns a class into a _whole value object_ by ensuring object equality is determined by the values that make up the object instead of by identity within memory.
+Wholable is a mixin that allows you to turn your object into a _whole value object_ by ensuring object equality is determined by the values of the object instead of by identity. Whole value objects -- or value objects in general -- have the following traits as also noted via link:https://en.wikipedia.org/wiki/Value_object[Wikipedia]:
+
+* Equality is determined by the values that make up an object and not by link:https://en.wikipedia.org/wiki/Identity_(object-oriented_programming)[identity] (i.e. memory address) which is the default behavior for all {ruby_link} objects except for {data_link} and {structs_link}.
+* Identity remains unique since two objects can have the same values but different identity. This means `BasicObject#equal?` is never overwritten -- which is strongly discouraged -- as per link:https://rubyapi.org/o/basicobject#method-i-3D-3D[BasicObject] documentation.
+* Value objects should be immutable (i.e. frozen) by default. This implementation enforces a strict adherence to immutability in order to ensure value objects remain equal and discourage mutation.
 
 toc::[]
 
 == Features
 
 * Ensures equality (i.e. `#==` and `#eql?`) is determined by attribute values and not object identity (i.e. `#equal?`).
+* Allows you to compare two objects of same or different types and see their differences.
+* Provides {pattern_matching_link}.
 * Automatically defines public attribute readers (i.e. `.attr_reader`) based on provided keys.
 * Ensures object inspection (i.e. `#inspect`) shows all registered attributes.
 * Ensures object is frozen upon initialization.
 
 == Requirements
 
-. link:https://www.ruby-lang.org[Ruby].
+. {ruby_link}.
 
 == Setup
 
@@ -72,45 +82,64 @@ jill = Person.new name: "Jill Smith", email: "jill@example.com"
 jill_two = Person.new name: "Jill Smith", email: "jill@example.com"
 jack = Person.new name: "Jack Smith", email: "jack@example.com"
 
-jill.frozen?          # true
-jill_two.frozen?      # true
-jack.frozen?          # true
+jill.name              # "Jill Smith"
+jill.email             # "jill@example.com"
+
+jill.frozen?           # true
+jill_two.frozen?       # true
+jack.frozen?           # true
+
+jill.inspect           # "#<Person @name=\"Jill Smith\", @email=\"jill@example.com\">"
+jill_two.inspect       # "#<Person @name=\"Jill Smith\", @email=\"jill@example.com\">"
+jack.inspect           # "#<Person @name=\"Jack Smith\", @email=\"jack@example.com\">"
+
+jill == jill           # true
+jill == jill_two       # true
+jill == jack           # false
+
+jill.diff(jill)        # {}
+jill.diff(jack)        # {
+                       #   name: ["Jill Smith", "Jack Smith"],
+                       #   email: ["jill@example.com", "jack@example.com"]
+                       # }
+jill.diff(Object.new)  # {:name=>["Jill Smith", nil], :email=>["jill@example.com", nil]}
 
-jill.inspect          # "#<Person @name=\"Jill Smith\", @email=\"jill@example.com\">"
-jill_two.inspect      # "#<Person @name=\"Jill Smith\", @email=\"jill@example.com\">"
-jack.inspect          # "#<Person @name=\"Jack Smith\", @email=\"jack@example.com\">"
+jill.eql? jill         # true
+jill.eql? jill_two     # true
+jill.eql? jack         # false
 
-jill.name             # "Jill Smith"
-jill.email            # "jill@example.com"
+jill.equal? jill       # true
+jill.equal? jill_two   # false
+jill.equal? jack       # false
 
-jill == jill          # true
-jill == jill_two      # true
-jill == jack          # false
+jill.hash              # 3650965837788801745
+jill_two.hash          # 3650965837788801745
+jack.hash              # 4460658980509842640
 
-jill.eql? jill        # true
-jill.eql? jill_two    # true
-jill.eql? jack        # false
+jill.to_a              # ["Jill Smith", "jill@example.com"]
+jack.to_a              # ["Jack Smith", "jack@example.com"]
 
-jill.equal? jill      # true
-jill.equal? jill_two  # false
-jill.equal? jack      # false
+jill.to_h              # {:name=>"Jill Smith", :email=>"jill@example.com"}
+jack.to_h              # {:name=>"Jack Smith", :email=>"jack@example.com"}
 
-jill.hash             # 3650965837788801745
-jill_two.hash         # 3650965837788801745
-jack.hash             # 4460658980509842640
+jill.with name: "Sue"  # #<Person @name="Sue", @email="jill@example.com">
+jill.with bad: "!"     # unknown keyword: :bad (ArgumentError)
 ----
 
-As you can see, object equality is determined by the object's values and not by the object's identity. When you include `Wholable` along with a list of keys, the following happens:
+As you can see, object equality is determined by the object's values and _not_ by the object's identity. When you include `Wholable` along with a list of keys, the following happens:
 
-. The corresponding _public_ `attr_reader` for each key will be created which saves you time and reduces double entry.
-. The object will be immediately frozen after initialization to ensure your instance is _immutable_ by default.
+. The corresponding _public_ `attr_reader` for each key is created which saves you time and reduces double entry when implementing your whole value object.
+. The `#to_a` and `#to_h` methods are added for convenience in order to play nice with {data_link} and {structs_link}.
+. The `#deconstruct` and `#deconstruct_keys` aliases are created for you so you can leverage {pattern_matching_link}.
+. Custom `#==`, `#eql?`, `#hash`, `#inspect`, `#to_a`, `#to_h`, and `#with` methods are added to provide whole value behavior.
+. The object is immediately frozen after initialization to ensure your instance is _immutable_ by default.
 
 == Caveats
 
-The whole value contract created for you when using this gem can be broken by doing the following:
+Whole values can be broken via the following:
 
-* *Duplication*: Sending the `#dub` message will cause your whole value object to be unfrozen. This might be desired in certain situations but make sure to refreeze when able.
-* *Post Attributes*: Adding additional attributes after what is defined when including `Wholable` will break your whole value object contract so ensure you let Wholable manage this for you.
+* *Duplication*: Sending the `#dup` message will cause your whole value object to be unfrozen. This might be desired in certain situations but make sure to refreeze when able.
+* *Post Attributes*: Adding additional attributes after what is defined when including `Wholable` will break your whole value object. To prevent this, let Wholable manage this for you (easiest). Otherwise (harder), you can manually override `#==`, `#eql?`, `#hash`, `#inspect`, `#to_a`, and `#to_h` behavior at which point you don't need Wholable anymore.
 * *Deep Freezing*: The automatic freezing of your instances is shallow and will not deeply freeze nested attributes. This behavior mimics the behavior of {data_link} objects.
 
 == Influences
@@ -118,8 +147,9 @@ The whole value contract created for you when using this gem can be broken by do
 This implementation is based upon these original designs:
 
 - link:https://github.com/dkubb/equalizer[Equalizer]: One of the first implementations that is over a decade old and no longer maintained.
-- link:https://github.com/dry-rb/dry-equalizer[Dry Equalizer]: Deprecated and no longer maintained but was based upon the above implementation. A version of this has moved into link:https://dry-rb.org/gems/dry-core[Dry Core] but doesn't appear to work properly or be well supported. Even the documentation is not fully linked on the main page.
-- link:https://github.com/piotrmurach/equatable/tree/master[Equatable]: A similar implementation to the above but is based off what you define via your `.attr_reader`. The project hasn't been maintained or updated in several years now.
+- link:https://github.com/dry-rb/dry-equalizer[Dry Equalizer]: Deprecated and no longer maintained but was based upon the above implementation and has now moved into Dry Core.
+- link:https://dry-rb.org/gems/dry-core[Dry Core]: Includes the link:https://dry-rb.org/gems/dry-core/equalizer[Dry::Core::Equalizer] module which is officially supported and actively maintained by the Dry RB team. A good alternative to this gem.
+- link:https://github.com/piotrmurach/equatable/tree/master[Equatable]: A similar implementation to the above but is based off what you define via your `.attr_reader`. The project hasn't been maintained or updated in several years.
 
 == Development
 

data/lib/wholable/comparable.rb

@@ -6,5 +6,14 @@ module Wholable
     def eql?(other) = instance_of?(other.class) && hash == other.hash
 
     def ==(other) = other.is_a?(self.class) && hash == other.hash
+
+    def diff other
+      if other.is_a? self.class
+        to_h.merge(other.to_h) { |_, one, two| [one, two].uniq }
+            .select { |_, diff| diff.size == 2 }
+      else
+        to_h.each.with_object({}) { |(key, value), diff| diff[key] = [value, nil] }
+      end
+    end
   end
 end

data/lib/wholable/equatable.rb

@@ -6,14 +6,13 @@ module Wholable
     def initialize *keys
       super()
       @keys = keys.uniq
-      define_hash
-      define_inspect
+      define_instance_methods
       freeze
     end
 
     def included descendant
       super
-      define_readers descendant
+      define_class_methods descendant
       descendant.include Comparable
       descendant.prepend Freezable
     end
@@ -22,12 +21,42 @@ module Wholable
 
     attr_reader :keys
 
+    def define_instance_methods
+      define_hash
+      define_inspect
+      define_with
+      define_to_a
+      define_to_h
+    end
+
+    def define_class_methods descendant
+      define_readers descendant
+      define_deconstruct descendant
+      define_deconstruct_keys descendant
+    end
+
     def define_readers descendant
       descendant.class_eval <<-READERS, __FILE__, __LINE__ + 1
         attr_reader #{keys.map(&:inspect).join ", "}
       READERS
     end
 
+    def define_deconstruct descendant
+      descendant.class_eval <<-READERS, __FILE__, __LINE__ + 1
+        alias deconstruct to_a
+      READERS
+    end
+
+    def define_deconstruct_keys descendant
+      descendant.class_eval <<-READERS, __FILE__, __LINE__ + 1
+        alias deconstruct_keys to_h
+      READERS
+    end
+
+    def define_with
+      define_method(:with) { |**attributes| self.class.new(**to_h.merge!(attributes)) }
+    end
+
     def define_hash
       local_keys = keys
 
@@ -38,7 +67,6 @@ module Wholable
       end
     end
 
-    # :reek:TooManyStatements
     def define_inspect
       local_keys = keys
 
@@ -46,10 +74,26 @@ module Wholable
         klass = self.class
         name = klass.name || klass.inspect
 
-        local_keys.map { |key| %(@#{key}=#{public_send(key).inspect}) }
+        local_keys.map { |key| "@#{key}=#{public_send(key).inspect}" }
                   .join(", ")
                   .then { |pairs| "#<#{name} #{pairs}>" }
       end
     end
+
+    def define_to_a
+      local_keys = keys
+
+      define_method :to_a do
+        local_keys.reduce([]) { |array, key| array.append public_send(key) }
+      end
+    end
+
+    def define_to_h
+      local_keys = keys
+
+      define_method :to_h do
+        local_keys.each.with_object({}) { |key, dictionary| dictionary[key] = public_send key }
+      end
+    end
   end
 end

data/lib/wholable/freezable.rb

@@ -4,7 +4,7 @@ module Wholable
   # Ensures an object is frozen after being initialized.
   module Freezable
     def initialize(...)
-      super(...)
+      super
       freeze
     end
   end

data/wholable.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name = "wholable"
-  spec.version = "0.0.0"
+  spec.version = "0.1.0"
   spec.authors = ["Brooke Kuhlmann"]
   spec.email = ["brooke@alchemists.io"]
   spec.homepage = "https://alchemists.io/projects/wholable"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wholable
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors:
 - Brooke Kuhlmann
@@ -35,7 +35,7 @@ cert_chain:
   3n5C8/6Zh9DYTkpcwPSuIfAga6wf4nXc9m6JAw8AuMLaiWN/r/2s4zJsUHYERJEu
   gZGm4JqtuSg8pYjPeIJxS960owq+SfuC+jxqmRA54BisFCv/0VOJi7tiJVY=
   -----END CERTIFICATE-----
-date: 2023-07-27 00:00:00.000000000 Z
+date: 2023-08-15 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -79,7 +79,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.17
+rubygems_version: 3.4.18
 signing_key:
 specification_version: 4
 summary: A whole value object mixin.