value_semantics 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 17f5d6eaef0f928cf467ac69b5dc9d4f0dfcc09a6991ad460e44f394c5b94d87
+  data.tar.gz: c85d1e46558e4599e52df186a5b45f47193cf88246c4267c76b46f5f959f9f55
+SHA512:
+  metadata.gz: 3cd1bfb5150cbb4fef561da3d433dde03d4a4432253f697c94790ac6e30832a1901bc5989f8a48e062f55a9a80f5c9b19cdf99b20b16ac3704e872ebd4851057
+  data.tar.gz: bd16975818cb48f84cf07472a4723ffe6b04a74036d52f6a7e3c3fe8a5d04b4ef6270a6ea7d2a25ff137b56d3a3905392706ea91825134b7c7630a1c985fc53b

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+- 2.4.1
+script: bundle exec rspec
+deploy:
+  provider: rubygems
+  on:
+    tags: true
+  api_key:
+    secure: nL74QuUczEpA0qbhSBN2zjGdviWgKB3wR6vFvwervv1MZNWmwOQUYe99Oq9kPeyc8/x2MR/H6PQm5qbrk/WAfRede01WxlZ/EBUW+9CYGrxcBsGONx9IULO8A0I8/yN/YJHW2vjo3dfR66EwVsXTVWq8U63PRRcwJIyTqnIiUm2sxauMQoPRBbXG+pD9v/EJSn3ugpdtxp0lVYDn8LDKk5Ho4/wbpY4ML11XUJa9mz9CyR/GsAzdy5FTXaDMOwuWOVEx9cab7m4qPOBhmlJY4TrmooFpxTxRwChcvByjq1IboEd2M3RT5on7Q/xDTlHSOuT0OS8mnS2AocGT4a1gC+W/xOlghgEcN+xs2V5mfucR6+iUYlCy32uz1w3ey7T2X5xN4ubut09r1xLi7eu1NisAoAc+GOJ4TIxQNqkeRhY4X/fs8j7SMfOEMDr6pPxSLKZxgSvExt+IbdcZD/uQ7rTBQkadYCbc9MX5dHazBievmar3ZsFffbIf+n13FVDXsaPgRt7DlFM5dqGrEwVwt1jFRhdFuDCjkj4QWOLn7E1uY3XqgrqGvgUBlF8Znwc6qicW8zxV4SIWhqIzCOH6L9WIZGLHNq0remoCd9sq9Ter9av3jL+6UmZRRAr+JceeZfZmsYIXKomECzleM9FXMx7FXlpjJKOlf3JnrfeCTwI=

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in the gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Tom Dalling
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,207 @@
+# ValueSemantics
+
+Create value classes quickly, with all the [conventions of a good value object](https://github.com/zverok/good-value-object).
+
+Generates modules that provide value semantics for a given set of attributes.
+Provides the behaviour of an immutable struct-like value class,
+with light-weight validation and coercion.
+
+These are intended for internal use, as opposed to validating user input like ActiveRecord.
+Invalid or missing attributes cause an exception intended for developers,
+not an error message intended for the user.
+
+## Basic Usage
+
+```ruby
+require 'value_semantics'
+
+class Person
+  include ValueSemantics.for_attributes {
+    name
+    age default: 31
+  }
+end
+
+tom = Person.new(name: 'Tom')
+
+
+#
+# Read-only attributes
+#
+tom.name  #=> "Tom"
+tom.age  #=> 31
+
+
+#
+# Convert to Hash
+#
+tom.to_h  #=> { :name => "Tom", :age => 31 }
+
+
+#
+# Non-destructive updates
+#
+old_tom = tom.with(age: 99)
+
+old_tom  #=> #<Person name="Tom" age=99>
+tom      #=> #<Person name="Tom" age=31> (unchanged)
+
+
+#
+# Equality
+#
+other_tom = Person.new(name: 'Tom', age: 31)
+
+tom == other_tom  #=> true
+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.
+
+
+## Validation (Types)
+
+Validators are objects that implement the `===` method,
+which means you can use `Class` objects (like `String`) and also `Regexp` objects:
+
+```ruby
+class Person
+  include ValueSemantics.for_attributes {
+    name String
+    birthday /\d\d\d\d-\d\d-\d\d/
+  }
+end
+
+Person.new(name: 'Tom', ...)  # works
+Person.new(name: 5, ...)
+#=> ArgumentError:
+#=>     Value for attribute 'name' is not valid: 5
+
+Person.new(birthday: "1970-01-01", ...)  # works
+Person.new(birthday: "hello", ...)
+#=> ArgumentError:
+#=>     Value for attribute 'birthday' is not valid: "hello"
+```
+
+A custom validator might look something like this:
+
+```ruby
+module Odd
+  def self.===(value)
+    value.odd?
+  end
+end
+
+class Person
+  include ValueSemantics.for_attributes {
+    age Odd
+  }
+end
+
+Person.new(age: 9)  # works
+Person.new(age: 8)
+#=> ArgumentError:
+#=>     Value for attribute 'age' is not valid: 8
+```
+
+Default attribute values also pass through validation.
+
+
+## Coercion
+
+Coercion blocks can convert invalid values into valid ones, where possible.
+
+```ruby
+class Server
+  include ValueSemantics.for_attributes {
+    address IPAddr do |value|
+      if value.is_a?(String)
+        IPAddr.new(value)
+      else
+        value
+      end
+    end
+  }
+end
+
+Server.new(address: '127.0.0.1')  # works
+Server.new(address: IPAddr.new('127.0.0.1'))  # works
+Server.new(address: 42)
+#=> ArgumentError:
+#=>     Value for attribute 'address' is not valid: 42
+```
+
+If coercion is not possible, the value is to returned unchanged, allowing the validator to fail.
+Another option is to raise an error within the coercion block.
+
+Coercion happens before validation.
+Default attribute values also pass through coercion.
+
+The coercion block runs in the context of the value object,
+so you can call methods from the value object.
+For example:
+
+```
+class Server
+  include ValueSemantics.for_attributes {
+    address IPAddr do |value|
+      coerce_address(value)
+    end
+  }
+
+  def coerce_address(value)
+    if value.is_a?(String)
+      IPAddr.new(value)
+    else
+      value
+    end
+  end
+end
+```
+
+## All Together
+
+```ruby
+class Coordinate
+  include ValueSemantics.for_attributes {
+    latitude Float, default: 0 { |value| value.to_f }
+    longitude Float, default: 0 { |value| value.to_f }
+  }
+end
+
+Coordinate.new(longitude: "123")
+#=> #<Coordinate latitude=0.0 longitude=123.0>
+```
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'value_semantics'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install value_semantics
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at:
+https://github.com/tomdalling/value_semantics
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT
+License](http://opensource.org/licenses/MIT).
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "value_semantics"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/value_semantics.rb

@@ -0,0 +1,164 @@
+module ValueSemantics
+  def self.for_attributes(&block)
+    attributes = DSL.run(&block)
+    generate_module(attributes)
+  end
+
+  def self.generate_module(attributes)
+    Module.new.tap do |m|
+      # include all the instance methods
+      m.include(Semantics)
+
+      # define the attr readers
+      attributes.each do |attr|
+        m.module_eval("def #{attr.name}; #{attr.instance_variable}; end")
+      end
+
+      # define BaseClass.attributes class method
+      m.const_set(:ATTRIBUTES__, attributes)
+      m.define_singleton_method(:included) do |base|
+        base.const_set(:ValueSemantics_Generated, m)
+        class << base
+          def attributes
+            self::ATTRIBUTES__
+          end
+        end
+      end
+    end
+  end
+
+  module Semantics
+    def initialize(given_attrs = {})
+      remaining_attrs = given_attrs.dup
+
+      self.class.attributes.each do |attr|
+        key, value = attr.determine_from!(remaining_attrs, self)
+        instance_variable_set(attr.instance_variable, value)
+        remaining_attrs.delete(key)
+      end
+
+      unless remaining_attrs.empty?
+        unrecognised = remaining_attrs.keys.map(&:inspect).join(', ')
+        raise ArgumentError, "Unrecognised attributes: #{unrecognised}"
+      end
+    end
+
+    def with(new_attrs)
+      self.class.new(to_h.merge(new_attrs))
+    end
+
+    def to_h
+      self.class.attributes
+        .map { |attr| [attr.name, public_send(attr.name)] }
+        .to_h
+    end
+
+    def ==(other)
+      (other.is_a?(self.class) || is_a?(other.class)) && other.to_h == to_h
+    end
+
+    def eql?(other)
+      other.class.equal?(self.class) && other.to_h.eql?(to_h)
+    end
+
+    def hash
+      @__hash ||= (to_h.hash ^ self.class.hash)
+    end
+
+    def inspect
+      attrs = to_h
+        .map { |key, value| "#{key}=#{value.inspect}" }
+        .join(" ")
+
+      "#<#{self.class} #{attrs}>"
+    end
+  end
+
+  class Attribute
+    attr_reader :name, :has_default, :default_value, :coercer
+
+    def initialize(name:, has_default:, default_value:, validator:, coercer:)
+      @name = name.to_sym
+      @has_default = has_default
+      @default_value = default_value
+      @validator = validator
+      @coercer = coercer
+      freeze
+    end
+
+    def determine_from!(attr_hash, value_object)
+      raw_value = attr_hash.fetch(name) do
+        if has_default
+          default_value
+        else
+          raise ArgumentError, "Value missing for attribute '#{name}'"
+        end
+      end
+
+      coerced_value = value_object.instance_exec(raw_value, &coercer)
+
+      if validate?(coerced_value)
+        [name, coerced_value]
+      else
+        raise ArgumentError, "Value for attribute '#{name}' is not valid: #{coerced_value.inspect}"
+      end
+    end
+
+    def default_value
+      if has_default
+        @default_value
+      else
+        fail "Attribute does not have a default value"
+      end
+    end
+
+    def validate?(value)
+      !!(@validator === value)
+    end
+
+    def instance_variable
+      '@' + name.to_s.chomp('!').chomp('?')
+    end
+  end
+
+  class DSL
+    NOT_SPECIFIED = Object.new
+
+    def self.run(&block)
+      dsl = new
+      dsl.instance_eval(&block)
+      dsl.__attributes
+    end
+
+    attr_reader :__attributes
+
+    def initialize
+      @__attributes = []
+    end
+
+    def method_missing(attr_name, validator=AnythingValidator,
+      default: NOT_SPECIFIED, &coercion_block)
+
+      __attributes << Attribute.new(
+        name: attr_name,
+        has_default: default != NOT_SPECIFIED,
+        default_value: default,
+        validator: validator,
+        coercer: coercion_block || IdentityCoercer,
+      )
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      true
+    end
+  end
+
+  module AnythingValidator
+    def self.===(value)
+      true
+    end
+  end
+
+  IdentityCoercer = ->(value) { value }
+
+end

data/lib/value_semantics/version.rb

@@ -0,0 +1,3 @@
+module ValueSemantics
+  VERSION = "0.1.1"
+end

data/value_semantics.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "value_semantics/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "value_semantics"
+  spec.version       = ValueSemantics::VERSION
+  spec.authors       = ["Tom Dalling"]
+  spec.email         = [["tom", "@", "tomdalling.com"].join]
+
+  spec.summary       = %q{Create value classes quickly, with all the proper conventions.}
+  spec.description   = %q{
+    Create value classes quickly, with all the proper conventions.
+
+    Generates modules that provide value semantics for a given set of attributes.
+    Provides the behaviour of an immutable struct-like value class,
+    with light-weight validation and coercion.
+  }
+  spec.homepage      = "https://github.com/tomdalling/value_semantics"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rspec", "~> 3.7.0"
+  #spec.add_development_dependency "mutant-rspec"
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "gem-release"
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: value_semantics
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Tom Dalling
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-08-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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'
+- !ruby/object:Gem::Dependency
+  name: gem-release
+  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: "\n    Create value classes quickly, with all the proper conventions.\n\n
+  \   Generates modules that provide value semantics for a given set of attributes.\n
+  \   Provides the behaviour of an immutable struct-like value class,\n    with light-weight
+  validation and coercion.\n  "
+email:
+- tom@tomdalling.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- bin/console
+- bin/setup
+- lib/value_semantics.rb
+- lib/value_semantics/version.rb
+- value_semantics.gemspec
+homepage: https://github.com/tomdalling/value_semantics
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: Create value classes quickly, with all the proper conventions.
+test_files: []