valued 0.1.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32117338fc8ee6ce822e3e057ea7c8604982976b634a6807f4d6775f76a194c1
-  data.tar.gz: 9b55bea9f75eb48836be435fd8e1a7afec2ec75b4ed5d1acb5dd33b04f3c0496
+  metadata.gz: c09b1d932113939667c5e36981e3256b25483679ebc222131d377985152a70a9
+  data.tar.gz: 823e69bdf5587363b1cae66ce2bd68ed8f38aedcdca3bddac5e59b953c27414f
 SHA512:
-  metadata.gz: b7ba659cce34b7115079682145a1b67799f167fa0592c7ad46be1768e309536738a1abacf476ff3d13ee6b50613a4be4ddfc4c780fe509d0ea5398abc2b58ce7
-  data.tar.gz: ab42f48189a070eb8b82336bc72d1b784218f47bd945759646f6d0ee36449c14799380bda760e6ade3a9f4b35b68636cb1ff5f0e81f1f2f0fc3828adcc77ee41
+  metadata.gz: 7c050eb350406595297da5f44fddd9f8b87e7675ad72596eaf89b8de9075e4da48f873da3750d01f7bd47f986c56efe5dd295900a17f94c1d81aee22459d482f
+  data.tar.gz: bd235452be8f966895982d83b31650bd468af5922e27d97680f04f95e8557cfd87f5c82ca982dc36880b0f2b2b767d9c56fb573ec6e42ed6396c16f433e183e1

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+# Changelog
+
+## 0.3.0
+
+- added a `update` method to all `Valued` and `Valued::Mutable` objects that
+  allows creating a duplicate of an object with changed attributes

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    valued (0.1.2)
+    valued (0.4.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -82,6 +82,39 @@ p quantity
 => #<Quantity amount=2 unit="m">
 ```
 
+You can create a duplicate of your object with updated attributes by using `update`.
+
+```ruby
+quantity = Quantity.new(unit: 'm', amount: 2)
+p quantity
+=> #<Quantity amount=2 unit="m">
+updated_quantity = quantity.update(unit: 'yard')
+p updated_quantity
+=> #<Quantity amount=2 unit="yard">
+```
+
+If you really need a mutable object, just use `Valued::Mutable` instead of `Valued`.
+
+```ruby
+require 'valued'
+
+class Quantity
+  include Valued::Mutable
+
+  attributes :unit, :amount
+end
+```
+
+By doing that, you also get a setter for every attribute.
+
+```ruby
+quantity = Quantity.new
+quantity.amount = 2
+quantity.unit = 'm'
+p quantity
+=> #<Quantity amount=2 unit="m">
+```
+
 ## License
 
 The gem is available as open source under the terms of the

data/lib/valued.rb

@@ -1,10 +1,16 @@
+require 'valued/mutable'
 require 'valued/version'
 
 module Valued
   module ClassMethods
+    def self.define_method(attr, klass)
+      klass.class_eval { attr_reader attr }
+    end
+
     def attributes(*attributes)
-      attributes.each { |attr| attr_reader attr }
+      attributes.each { |attr| Valued::ClassMethods.define_method(attr, self) }
       define_method('_attributes') { attributes }
+      private :_attributes
     end
   end
 
@@ -34,6 +40,14 @@ module Valued
     end
   end
 
+  def update(new_attributes)
+    self.class.new(
+      _attributes.each_with_object({}) do |attribute, result|
+        result[attribute] = new_attributes[attribute] || self.send(attribute)
+      end
+    )
+  end
+
   def ==(other)
     _attributes.all? do |attribute|
       other.respond_to?(attribute) && send(attribute) == other.send(attribute)

data/lib/valued/mutable.rb

@@ -0,0 +1,80 @@
+module Valued
+  module Mutable
+    module ClassMethods
+      def self.define_method(attr, klass)
+        klass.class_eval { attr_accessor attr }
+      end
+
+      def attributes(*attributes)
+        attributes.each do |attr|
+          Valued::Mutable::ClassMethods.define_method(attr, self)
+        end
+        define_method('_attributes') { attributes }
+        private :_attributes
+      end
+    end
+
+    def self.define(*attrs, &block)
+      klass =
+        Class.new do
+          include Valued::Mutable
+
+          attributes(*attrs)
+        end
+      klass.class_eval(&block) if block_given?
+      klass
+    end
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    def initialize(attributes = {})
+      _attributes.each do |attribute|
+        if attributes.key?(attribute)
+          instance_variable_set("@#{attribute}", attributes.fetch(attribute))
+        end
+      end
+    end
+
+    def update(new_attributes)
+      self.class.new(
+        _attributes.each_with_object({}) do |attribute, result|
+          result[attribute] = new_attributes[attribute] || self.send(attribute)
+        end
+      )
+    end
+
+    def ==(other)
+      _attributes.all? do |attribute|
+        other.respond_to?(attribute) && send(attribute) == other.send(attribute)
+      end
+    end
+
+    def eql?(other)
+      self.class == other.class && self == other
+    end
+
+    def hash
+      (_attributes.map { |attribute| send(attribute) } + [self.class]).hash
+    end
+
+    def to_h
+      _attributes.each_with_object({}) do |attribute, hash|
+        hash[attribute] = send(attribute)
+      end
+    end
+
+    def to_s
+      inspect
+    end
+
+    def inspect
+      inspected_attributes =
+        _attributes.map do |attribute|
+          "#{attribute}=#{send(attribute).inspect}"
+        end.join(' ')
+      "#<#{self.class} #{inspected_attributes}>"
+    end
+  end
+end

data/lib/valued/version.rb

@@ -1,3 +1,3 @@
 module Valued
-  VERSION = '0.1.2'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: valued
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Mario Mainz
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-03-27 00:00:00.000000000 Z
+date: 2020-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,7 +80,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.38'
-description: 
+description:
 email:
 - mainz.mario@googlemail.com
 executables: []
@@ -91,12 +91,14 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/valued.rb
+- lib/valued/mutable.rb
 - lib/valued/version.rb
 - valued.gemspec
 homepage: https://github.com/mmainz/valued
@@ -105,7 +107,7 @@ licenses:
 metadata:
   homepage_uri: https://github.com/mmainz/valued
   source_code_uri: https://github.com/mmainz/valued
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -121,7 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.1.2
-signing_key: 
+signing_key:
 specification_version: 4
 summary: A Ruby gem that makes it easy to create value objects.
 test_files: []