ivo 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3877d0d14eca70586641e288f3067cfb201764a8
-  data.tar.gz: ccc3b46313c22dbc1739dc17c862b24b4a79e44f
+SHA256:
+  metadata.gz: 6f7f83b9399c97a63549923922baf6d8d82898ba7826050fd8186cbe81f9b8b6
+  data.tar.gz: 42e2ec90299185b2e4a0769db49225d5fad0ab17e358ec512f24df60e14e8d92
 SHA512:
-  metadata.gz: 17037ae262928c28f4314a1ef9232acbe0ba6dad33fa7939ec613fa1c60941e3f1f6f2ac118a140cb21cff2572c6aa900320f19f86b8c99d9dbf72b726ec782b
-  data.tar.gz: 19088a2316bbd097bcabe3fb900d64f4960a4a21b9941f85b45c32069ac0158b4c6013e88b14512bd6b91d93f4de236a57ba50cb6c45842ed710537806e3d1a1
+  metadata.gz: e058a43abd113a379f565504059d594cbe6688d42edef8ecf6746ff9553b27a8e20cd09b431c25235a1899368f6aa42a6674127ba58c00c30aa8832d18b147e8
+  data.tar.gz: 4b1d014d31aabfa339f8b4d0a1659a6855af5b8242601c1a8c67f265b891b04cac7a05711e5ec592bfca3d70840d7c4e503d27b39db4038cc89e18b2b88c9d97

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Allen Madsen
+
+MIT License
+
+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

@@ -1,5 +1,7 @@
 # Ivo
 
+A library for creating immutable value objects.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -18,7 +20,87 @@ Or install it yourself as:
 
 ## Usage
 
-Coming soon.
+### Basics
+
+```ruby
+Car = Ivo.new(:make, :model)
+
+car = Car.new('Honda', 'Accord')
+
+car.make    # "Honda"
+car.model   # "Accord"
+car.frozen? # true
+```
+
+Objects can also be instantiated with keywords:
+
+```ruby
+car = Car.with(make: 'Honda', model: 'Accord')
+```
+
+`Ivo.new` also accepts a block for additional definitions:
+
+```ruby
+Car = Ivo.new(:make, :model) do
+  def to_s
+    "#{make} #{model}"
+  end
+end
+```
+
+For one-off value objects:
+
+```ruby
+car = Ivo.(make: 'Honda', model: 'Accord')
+
+car.make    # "Honda"
+car.model   # "Accord"
+car.frozen? # true
+```
+
+### Under the hood
+
+This:
+
+```ruby
+Car = Ivo.new(:make, :model) do
+  def to_s
+    "#{make} #{model}"
+  end
+end
+```
+
+is equivalent to:
+
+```ruby
+class Car
+  def self.with(make: nil, model: nil)
+    new(make, model)
+  end
+
+  def initialize(make = nil, model = nil)
+    @make = make
+    @model = model
+    freeze
+  end
+
+  attr_reader :make, :model
+
+  def to_s
+    "#{make} #{model}"
+  end
+
+  def ==(other)
+    self.class == other.class && make == other.make && model == other.model
+  end
+
+  alias_method :eql?, :==
+
+  def hash
+    make.hash ^ model.hash
+  end
+end
+```
 
 ## Development
 

data/benchmarks.rb

@@ -0,0 +1,73 @@
+#!/usr/bin/env ruby
+
+require 'bundler/inline'
+
+require 'benchmark'
+require 'ostruct'
+
+gemfile do
+  source 'https://rubygems.org'
+
+  gem 'ivo', '~> 0.4'
+  gem 'immutable-struct', '~> 2.4'
+  gem 'values', '~> 1.8'
+end
+
+StructClass = Struct.new(:x, :y)
+ImmutableStructClass = ImmutableStruct.new(:x, :y)
+ValueClass = Value.new(:x, :y)
+IvoClass = Ivo.new(:x, :y)
+
+n = 1_000_000
+
+Benchmark.bm(30) do |x|
+  x.report('StructClass.new') do
+    n.times do
+      StructClass.new(1, 2)
+    end
+  end
+
+  x.report('IvoClass.new') do
+    n.times do
+      IvoClass.new(1, 2)
+    end
+  end
+
+  x.report('IvoClass.with') do
+    n.times do
+      IvoClass.with(x: 1, y: 2)
+    end
+  end
+
+  x.report('ValueClass.new') do
+    n.times do
+      ValueClass.new(1, 2)
+    end
+  end
+
+  x.report('ValueClass.with') do
+    n.times do
+      ValueClass.with(x: 1, y: 2)
+    end
+  end
+
+  x.report('ImmutableStructClass.new') do
+    n.times do
+      ImmutableStructClass.new(x: 1, y: 2)
+    end
+  end
+end
+
+Benchmark.bm(30) do |x|
+  x.report('OpenStruct.new') do
+    n.times do
+      OpenStruct.new(x: 1, y: 2)
+    end
+  end
+
+  x.report('Ivo.call') do
+    n.times do
+      Ivo.call(x: 1, y: 2)
+    end
+  end
+end

data/ivo.gemspec

@@ -19,7 +19,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1"
+  spec.add_development_dependency "bundler", "~> 2"
   spec.add_development_dependency "rake", "~> 12"
   spec.add_development_dependency "rspec", "~> 3"
 end

data/lib/ivo.rb

@@ -1,71 +1,121 @@
+# frozen_string_literal: true
+
 require "ivo/version"
 require 'ivo/value'
 
 module Ivo
-  def self.new(*attrs, &block)
-    Class.new do
-      include Ivo.value *attrs
+  extend self
+
+  def new(*attrs, &block)
+    instance_ruby = build_instance_ruby(attrs)
+    class_ruby = build_class_ruby(attrs)
 
-      class_eval &block if block
+    Class.new do
+      instance_eval(instance_ruby)
+      class_eval(class_ruby)
+      class_eval(&block) if block
     end
   end
 
-  def self.value(*attrs)
-    # a: nil, b: nil
-    keyword_args = attrs.map { |attr| "#{attr}: nil" }.join ', '
+  def value(*attrs)
+    instance_ruby = build_instance_ruby(attrs)
+    class_ruby = build_class_ruby(attrs)
 
-    # a, b
-    args = attrs.map { |attr| "#{attr} = nil" }.join ', '
+    template = <<~RUBY
+      module ClassMethods
+        %{instance_ruby}
+      end
 
-    # @a = a
-    # @b = b
-    instance_variable_assignments = attrs.map { |attr| "@#{attr} = #{attr}" }.join "\n"
+      def self.included(klass)
+        klass.extend(ClassMethods)
+      end
+    RUBY
 
-    equality_check = begin
-      checks = ['self.class == other.class']
-      attrs.each { |attr| checks << "#{attr} == other.#{attr}" }
-      checks.join ' && '
-    end
+    ruby = template % {instance_ruby: instance_ruby}
 
-    hash = attrs.map { |attr| "#{attr}.hash" }.join ' ^ '
+    Module.new do
+      module_eval(ruby)
+      module_eval(class_ruby)
+    end
+  end
 
-    code = <<~RUBY
-      def self.included(base)
-        base.extend ClassMethods
-      end
+  def call(attrs = nil)
+    Value.new(attrs)
+  end
 
-      module ClassMethods
-        def with(#{keyword_args})
-          new #{attrs.join ', '}
-        end
-      end
+  private
 
-      def initialize(#{args})
-        #{instance_variable_assignments}
+  def build_class_ruby(attrs)
+    template = <<~RUBY
+      def initialize(%{args})
+        %{instance_variable_assignments}
         freeze
       end
 
+      %{attr_reader_declaration}
+
       def ==(other)
-        #{equality_check}
+        %{equality_check}
       end
 
-      def hash
-        #{hash}
-      end
+      alias_method :eql?, :==
+
+      %{hash_method}
     RUBY
 
-    Module.new do
-      module_eval code
+    # a, b
+    args = attrs.map { |attr| "#{attr} = nil" }.join(', ')
 
-      attr_reader *attrs
+    # @a = a
+    # @b = b
+    instance_variable_assignments = attrs.map { |attr| "@#{attr} = #{attr}" }.join("\n")
 
-      def eql?(other)
-        self == other
-      end
+    # attr_reader :a, :b
+    if attrs.any?
+      arg_symbols = attrs.map { |attr| ":#{attr}" }.join(', ')
+      attr_reader_declaration = "attr_reader #{arg_symbols}"
     end
+
+    # self.class == other.class && a == other.a && b == other.b
+    equality_check = begin
+      checks = ['self.class == other.class']
+      attrs.each { |attr| checks << "#{attr} == other.#{attr}" }
+      checks.join(' && ')
+    end
+
+    # def hash
+    #   a.hash ^ b.hash
+    # end
+    if attrs.any?
+      hash = attrs.map { |attr| "#{attr}.hash" }.join(' ^ ')
+      hash_method = <<~RUBY
+        def hash
+          #{hash}
+        end
+      RUBY
+    end
+
+    template % {
+      args: args,
+      instance_variable_assignments: instance_variable_assignments,
+      attr_reader_declaration: attr_reader_declaration,
+      equality_check: equality_check,
+      hash_method: hash_method,
+    }
   end
 
-  def self.call(attrs = nil)
-    Value.new attrs
+  def build_instance_ruby(attrs)
+    template = <<~RUBY
+      def with(%{keyword_args})
+        new(%{values})
+      end
+    RUBY
+
+    # a: nil, b: nil
+    keyword_args = attrs.map { |attr| "#{attr}: nil" }.join(', ')
+
+    values = attrs.join(', ')
+
+    template % {keyword_args: keyword_args, values: values}
   end
 end

data/lib/ivo/value.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Ivo
   class Value
     def initialize(data = nil)
@@ -25,7 +27,7 @@ module Ivo
     end
 
     def inspect
-      attributes = data.map { |key, value| "#{key}=#{value.inspect}" }.join ', '
+      attributes = data.map { |key, value| "#{key}=#{value.inspect}" }.join(', ')
       "#<#{self.class.name} #{attributes}>"
     end
 

data/lib/ivo/version.rb

@@ -1,3 +1,3 @@
 module Ivo
-  VERSION = "0.4.0"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ivo
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Austin Schneider
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-05-11 00:00:00.000000000 Z
+date: 2019-11-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1'
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -62,8 +62,10 @@ files:
 - ".gitignore"
 - ".rspec"
 - Gemfile
+- LICENSE.txt
 - README.md
 - Rakefile
+- benchmarks.rb
 - bin/console
 - bin/setup
 - ivo.gemspec
@@ -88,8 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Library for creating immutable value objects (IVO)