value_semantics 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 235fbd4782ce1bc943f12688408c20a5b6893e7b57882c63b725953115de74d3
-  data.tar.gz: 6adbdbcc36d8093fd323fb2d734557025df4b0dc9983e6ba343690a229dfed40
+  metadata.gz: 17ee24bc8ffd744493e9957a4cb7ee0071f0c33aa8560b3ed36689575b9c0ab1
+  data.tar.gz: 05da8d260966f9257578f0ebf3891ba447b51032709bb75b39bdacba3e081961
 SHA512:
-  metadata.gz: 179eed3a45a75b8f6546c99fd4fdcd2cb987885a4b00f36caa359a3e7b19854dd0401d3b6f3c4cd5b108256492be94d068dfa1765eb6a6844b9ccd610212cffe
-  data.tar.gz: c9eefd7b84e63507513c2d3b88469730c346899a2a7ae109bc1159f2ed764d71102a7dbbd9e7ae0ea9d2caad1ee82c1c6b740c69eb508caa50571687d0f51c75
+  metadata.gz: 4a4da5150969146f5fd8cb06a17f8e43b1c897cd40f228cdddd7b2a8367fdbbceeacc66843668bf74a48575d72f752d3f24fd101c2ac7e946335688a1eec95a3
+  data.tar.gz: c0e71a37be6df7bcafa4833f7b7cea4304468818a4391e020770c6f85e16edaf68a56c84c572f3bd26399aa85b2dc149abb48660d82750a656d746d87da5a16a

data/README.md

@@ -16,8 +16,42 @@ Invalid or missing attributes cause an exception intended for developers,
 not an error message intended for the user.
 
 
-Basic Usage
------------
+Defining and Creating Value Objects
+-----------------------------------
+
+```ruby
+class Person
+  include ValueSemantics.for_attributes {
+    name String, default: "Anon Emous"
+    birthday Either(Date, nil), coerce: true
+  }
+
+  def self.coerce_birthday(value)
+    if value.is_a?(String)
+      Date.parse(value)
+    else
+      value
+    end
+  end
+end
+
+Person.new(name: "Tom", birthday: "2020-12-25")
+#=> #<Person name="Tom" birthday=#<Date: 2020-12-25 ((2459209j,0s,0n),+0s,2299161j)>>
+
+Person.new(birthday: Date.today)
+#=> #<Person name="Anon Emous" birthday=#<Date: 2018-09-04 ((2458366j,0s,0n),+0s,2299161j)>>
+
+Person.new(birthday: nil)
+#=> #<Person name="Anon Emous" birthday=nil>
+```
+
+The curly bracket syntax used with `ValueSemantics.for_attributes` is, unfortunately,
+mandatory due to Ruby's precedence rules.
+The `do`/`end` syntax will not work unless you surround the whole thing with parenthesis.
+
+
+Using Value Objects
+-------------------
 
 ```ruby
 require 'value_semantics'
@@ -64,9 +98,31 @@ tom.eql?(other_tom)  #=> true
 tom.hash == other_tom.hash  #=> true
 ```
 
-The curly bracket syntax used with `ValueSemantics.for_attributes` is, unfortunately,
-mandatory due to Ruby's precedence rules.
-The `do`/`end` syntax will not work unless you surround the whole thing with parenthesis.
+
+Defaults
+--------
+
+Defaults can be specified in one of two ways:
+the `:default` option, or the `default_generator` option.
+
+```ruby
+class Cat
+  include ValueSemantics.for_attributes {
+    paws Integer, default: 4
+    born_at Time, default_generator: ->{ Time.now }
+  }
+end
+
+Cat.new
+#=> #<Cat paws=4 born_at=2018-12-21 18:42:01 +1100>
+```
+
+The `default` option is a single value.
+
+The `default_generator` option is a callable object, which returns a default value.
+In the example above, `default_generator` is a lambda that returns the current time.
+
+Only one of these options can be used per attribute.
 
 
 Validation (Types)
@@ -83,7 +139,7 @@ Anything that you can use in a `case`/`when` expression will work.
 class Person
   include ValueSemantics.for_attributes {
     name String
-    birthday /\d\d\d\d-\d\d-\d\d/
+    birthday /\d{4}-\d{2}-\d{2}/
   }
 end
 
@@ -243,34 +299,6 @@ For example, the default value could be a string,
 which would then be coerced into an `IPAddr` object.
 
 
-## All Together
-
-```ruby
-class Person
-  include ValueSemantics.for_attributes {
-    name String, default: "Anon Emous"
-    birthday Either(Date, nil), coerce: true
-  }
-
-  def self.coerce_birthday(value)
-    if value.is_a?(String)
-      Date.parse(value)
-    else
-      value
-    end
-  end
-end
-
-Person.new(name: "Tom", birthday: "2020-12-25")
-#=> #<Person name="Tom" birthday=#<Date: 2020-12-25 ((2459209j,0s,0n),+0s,2299161j)>>
-
-Person.new(birthday: Date.today)
-#=> #<Person name="Anon Emous" birthday=#<Date: 2018-09-04 ((2458366j,0s,0n),+0s,2299161j)>>
-
-Person.new(birthday: nil)
-#=> #<Person name="Anon Emous" birthday=nil>
-```
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -288,10 +316,6 @@ Or install it yourself as:
     $ gem install value_semantics
 
 
-## TODO
-
- - Allow defaults to be generated by calling a method (e.g. to get the current time)
-
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at:

data/lib/value_semantics.rb

@@ -1,4 +1,6 @@
 module ValueSemantics
+  NOT_SPECIFIED = Object.new.freeze
+
   def self.for_attributes(&block)
     attributes = DSL.run(&block)
     generate_module(attributes.freeze)
@@ -75,13 +77,13 @@ module ValueSemantics
   end
 
   class Attribute
-    NOT_SPECIFIED = Object.new.freeze
+    NO_DEFAULT_GENERATOR = ->{ raise "Attribute does not have a default value" }
 
-    attr_reader :name, :validator, :coercer
+    attr_reader :name, :validator, :coercer, :default_generator
 
-    def initialize(name:, default_value:, validator:, coercer:)
+    def initialize(name:, default_generator:, validator:, coercer:)
       @name = name.to_sym
-      @default_value = default_value
+      @default_generator = default_generator
       @validator = validator
       @coercer = coercer
       freeze
@@ -89,10 +91,10 @@ module ValueSemantics
 
     def determine_from!(attr_hash, klass)
       raw_value = attr_hash.fetch(name) do
-        if default_specified?
-          default_value
-        else
+        if default_generator.equal?(NO_DEFAULT_GENERATOR)
           raise ArgumentError, "Value missing for attribute '#{name}'"
+        else
+          default_generator.call
         end
       end
 
@@ -115,18 +117,6 @@ module ValueSemantics
       end
     end
 
-    def default_specified?
-      !@default_value.equal?(NOT_SPECIFIED)
-    end
-
-    def default_value
-      if default_specified?
-        @default_value
-      else
-        fail "Attribute does not have a default value"
-      end
-    end
-
     def validate?(value)
       validator === value
     end
@@ -169,11 +159,28 @@ module ValueSemantics
       ArrayOf.new(element_validator)
     end
 
-    def def_attr(attr_name, validator=Anything, default: Attribute::NOT_SPECIFIED, coerce: nil)
+    def def_attr(attr_name,
+                 validator=Anything,
+                 default: NOT_SPECIFIED,
+                 default_generator: nil,
+                 coerce: nil
+                 )
+      generator = begin
+        if default_generator && !default.equal?(NOT_SPECIFIED)
+          raise ArgumentError, "Attribute '#{attr_name}' can not have both a default, and a default_generator"
+        elsif default_generator
+          default_generator
+        elsif !default.equal?(NOT_SPECIFIED)
+          ->{ default }
+        else
+          Attribute::NO_DEFAULT_GENERATOR
+        end
+      end
+
       __attributes << Attribute.new(
         name: attr_name,
         validator: validator,
-        default_value: default,
+        default_generator: generator,
         coercer: coerce
       )
     end

data/lib/value_semantics/version.rb

@@ -1,3 +1,3 @@
 module ValueSemantics
-  VERSION = "2.0.1"
+  VERSION = "2.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: value_semantics
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Tom Dalling
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-10-15 00:00:00.000000000 Z
+date: 2018-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -121,8 +121,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.0
 signing_key: 
 specification_version: 4
 summary: Create value classes quickly, with all the proper conventions.