value_struct 0.7.0 → 0.8.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b84f12dd920408c7536ca6548bcdc2c74ac3d3cf
+  data.tar.gz: fe3f7551490c4263c599e985df0ba799cc8a5027
+SHA512:
+  metadata.gz: e05f7c38fd1440a8bcad24e6be6755f0a05dcf1ef6a15ec5a7a4b252101d31abd7767c02ef8264cd24f0046e74e506a2a1d2d0217b2f8df3c748d76c816a47c0
+  data.tar.gz: a0be6061cc6ee344aedad39efac95381c3609dd6cd43466910e9263082cd7bc1fb454c13a3bb025d2a434cdaa03550e9a6ec7e78b3eb2361b788916540c1fd70

data/.editorconfig

@@ -0,0 +1,12 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.{md,rdoc,txt}]
+indent_size = 4
+

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+
+rvm:
+- ruby-head
+- 2.2.0
+- 2.1.5
+- 2.0.0
+- jruby-head

data/ChangeLog.md

@@ -1,3 +1,7 @@
+### 0.8.0
+* Drop support for Ruby 1
+* Remove #to_h mixin
+
 ### 0.7.0
 * Improve mixin system
 * More logical class/model/inheritance logic
@@ -7,6 +11,5 @@
 * Fix specs
 * Fix #dup
 
-### 0.5.0 / 2012-11-03
-
-* Initial puplic release:
+### 0.5.0
+* Initial puplic release

data/Gemfile

@@ -1,3 +1,3 @@
-source :rubygems
+source 'https://rubygems.org'
 
 gemspec

data/{LICENSE.txt → MIT-LICENSE.txt}

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Jan Lelis
+Copyright (c) 2012-2015 Jan Lelis
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,53 +1,93 @@
-# Value Struct
+# Value Struct [![[travis]](https://travis-ci.org/janlelis/value_struct.png)](https://travis-ci.org/janlelis/value_struct)
 
-A value struct is a subclass of normal [Ruby struct](http://blog.grayproductions.net/articles/all_about_struct) that behaves almost the same. However, it has a major difference:
+A value struct is a subclass of the normal [Ruby struct](http://blog.grayproductions.net/articles/all_about_struct) that behaves almost the same. However, it has a major difference:
 
 __Value structs are immutable, i.e. they don't have setters (although, not recursively*)__
 
 Additionally, this gem provides the following optional mixins to make life easier when using immutable structs:
 
-* __:dup_with_changes__ #dup takes a optional hash for setting new values in the duplicate
-* __:to_h__ #to_h for converting into a valuestruct into a hash (if Ruby version below < 2.0)
-
+* __:dup_with_changes__ Extends `#dup` to take a optional hash for setting new values in the duplicate
 * __:strict_arguments__ Value structs need to be initialized with the exact amount of arguments
 * __:freeze__ Automatically freezes new instances
-* __:no_clone__ #clone does not clone, but return the same object
-
-By default, only :dup_with_changes and :to_h get included.
+* __:no_clone__ Alters `#clone` to return the same object
 
-## Why?
+By default, only __:dup_with_changes__ will be included.
 
-Sometimes you want to eliminate state. See [this blog article] for more information.
+Without mixins, ValueStructs are almost as fast as normal structs. Some mixins add noticable overhead, e.g. strict_arguments
 
-## Performance
+## Why?
 
-Without mixins, ValueStructs are as fast as normal structs. Some (optional) mixins add noticable overhead, e.g. strict_arguments
+See [this blog article](http://ruby.janlelis.de/65-value_struct-read-only-structs-in-ruby) for more information.
 
-## Example
+## Example 1
 
     require 'value_struct'
 
-    Point = ValueStruct.new(:x, :y) do # methods defined in the block will be available in your new value struct class
-      # ...
-    end
+    SimplePoint = ValueStruct.new(:x, :y)
+
 
-Please refer to the [documentation of Ruby's struct] for more details on usage.
+Please refer to the [documentation of Ruby's struct](http://ruby-doc.org/core-2.2.0/Struct.html) for more details on general struct usage.
 
 ## How to use structs with mixins
 
     Point = ValueStruct.new_with_mixins :x, :y, [
-      ValueStruct::ToH,
-      ValueStruct::Freeze,
-      ValueStruct::DupWithChanges,
-      ValueStruct::StrictArguments,
+      :freeze,
+      :dup_with_changes,
+      :strict_arguments,
     ]
 
     p = Point.new(1,2)
-    p.to_h       #=> { :x => 1, :y => 2 }
     p.frozen?    #=> true
     p.dup(x: 0)  #=> #<ValueStruct Point x=0, y=2>
     Point.new(1) # ArgumentError
 
+Alternatively, you can put custom modules in the mixin array.
+
+## Example 2
+
+    require 'value_struct'
+
+    Point = ValueStruct.new_with_mixins(
+      :x,
+      :y,
+       [:dup_with_changes, :freeze, :no_clone],
+    ) do
+
+      def initialize(x,y)
+        raise ArgumentError, 'points must be initilized with two numerics' unless x.is_a?(Numeric) && y.is_a?(Numeric)
+        super(x,y)
+      end
+
+      def abs
+        ( x**2 + y**2 ) ** 0.5
+      end
+
+      def +(o)
+        dup(x: x + o.x, y: y + o.y)
+      end
+
+      def -(o)
+        dup(x: x - o.x, y: y - o.y)
+      end
+
+      def +@
+        self
+      end
+
+      def -@
+        dup(x: -x, y: -o.y)
+      end
+
+      def to_c
+        Complex(x,y)
+      end
+
+      def to_s
+        "(#{x},#{y})"
+      end
+      alias inspect to_s
+    end
+
 ## *
 
 Because of the nature of Ruby, most things are not really immutable. So if you have an attribute `:by` and initialize it with an array, you cannot change the value struct anymore, but still the array:
@@ -69,4 +109,6 @@ Because of the nature of Ruby, most things are not really immutable. So if you h
 * Theo Hultberg: [ImmutableStruct](https://github.com/iconara/immutable_struct)
 * Ruby Rogues
 
-## J-_-L
+## J-_-L
+
+Copyright © 2012-2015 Jan Lelis, janlelis.com, released under the MIT license.

data/Rakefile

@@ -1,7 +1,5 @@
 # encoding: utf-8
 
-require 'rubygems'
-
 begin
   require 'bundler'
 rescue LoadError => e
@@ -20,15 +18,28 @@ end
 
 require 'rake'
 
+# - - -
+
 require 'rubygems/tasks'
 Gem::Tasks.new
 
+# - - -
+
 require 'rspec/core/rake_task'
 RSpec::Core::RakeTask.new
 
 task :test    => :spec
 task :default => :spec
 
+# - - -
+
 require 'yard'
-YARD::Rake::YardocTask.new  
+YARD::Rake::YardocTask.new
 task :doc => :yard
+
+# - - -
+
+desc 'compare ValueStruct with similar implementations'
+task :benchmark do
+  ruby 'spec/benchmark.rb'
+end

data/gemspec.yml

@@ -5,14 +5,14 @@ authors: Jan Lelis
 email: mail@janlelis.de
 homepage: https://github.com/janlelis/value_struct
 
+required_ruby_version: ~> 2.0
+
 development_dependencies:
   bundler: ~> 1.0
   rake: ~> 0.8
   rspec: ~> 2.4
   rubygems-tasks: ~> 0.2
   yard: ~> 0.8
-  kramdown: ~> 0.14 
-  debugger: ~> 1.2.1
-  values: ~> 1.2.1
-  immutable_struct: ~> 1.0.2
-  hamster: ~> 0.4.3
+  kramdown: ~> 0.14
+  values: ~> 1.5.0
+  immutable_struct: ~> 1.1.1

data/lib/value_struct.rb

@@ -1,7 +1,6 @@
 require_relative 'value_struct/version'
 
 require_relative 'value_struct/immutable'
-require_relative 'value_struct/to_h'
 require_relative 'value_struct/dup_with_changes'
 require_relative 'value_struct/strict_arguments'
 require_relative 'value_struct/no_clone'
@@ -29,7 +28,6 @@ class ValueStruct < Struct
 
     def new(*args, &block)
       mixins = [ValueStruct::DupWithChanges]
-      mixins.unshift(ValueStruct::ToH) if RUBY_VERSION < "2.0"
       new_with_mixins(*args, mixins, &block)
     end
   end
@@ -37,4 +35,4 @@ class ValueStruct < Struct
   def inspect
     super.to_s.sub('struct', 'ValueStruct')
   end
-end
+end

data/lib/value_struct/version.rb

@@ -1,3 +1,3 @@
 class ValueStruct < Struct
-  VERSION = '0.7.0'
+  VERSION = '0.8.0'
 end

data/spec/benchmark.rb

@@ -3,7 +3,7 @@ require 'benchmark'
 require 'immutable_struct'
 require 'values'
 
-COUNT = 200_000
+COUNT = 1_000_000
 
 def benchmark_for(struct_class)
   puts "%20s: %s" % [

data/spec/value_struct_spec.rb

@@ -13,7 +13,9 @@ describe ValueStruct do
     describe '.new' do
       it 'calls .new_with_mixins and adds default mixins' do
         subject.should_receive(:new_with_mixins).with(
-          :x, :y,  [ValueStruct::ToH, ValueStruct::DupWithChanges]
+          :x, :y,[
+            ValueStruct::DupWithChanges,
+          ].compact
         )
         subject.new(:x, :y)
       end
@@ -21,12 +23,6 @@ describe ValueStruct do
       it 'adds the ValueStruct::DupWithChanges mixin' do
         subject.new(:x, :y).new(1,2).should be_a ValueStruct::DupWithChanges
       end
-
-      it 'adds ValueStruct::ToH if ruby version is below 2.0' do
-        if RUBY_VERSION < "2.0"
-          subject.new(:x, :y).new(1,2).should be_a ValueStruct::ToH
-        end
-      end
     end
 
     describe '.new_with_mixins' do
@@ -52,7 +48,6 @@ describe ValueStruct do
       it 'includes all mixins that are given in the last paramater array' do
         mixins = [
           ValueStruct::DupWithChanges,
-          ValueStruct::ToH,
           ValueStruct::StrictArguments,
           ValueStruct::Freeze,
         ]

metadata

@@ -1,192 +1,145 @@
 --- !ruby/object:Gem::Specification
 name: value_struct
 version: !ruby/object:Gem::Version
-  version: 0.7.0
-  prerelease: 
+  version: 0.8.0
 platform: ruby
 authors:
 - Jan Lelis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-04 00:00:00.000000000 Z
+date: 2015-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.4'
 - !ruby/object:Gem::Dependency
   name: rubygems-tasks
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
 - !ruby/object:Gem::Dependency
   name: kramdown
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.14'
-- !ruby/object:Gem::Dependency
-  name: debugger
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.2.1
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.2.1
 - !ruby/object:Gem::Dependency
   name: values
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: 1.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.2.1
+        version: 1.5.0
 - !ruby/object:Gem::Dependency
   name: immutable_struct
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.2
+        version: 1.1.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.2
-- !ruby/object:Gem::Dependency
-  name: hamster
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.4.3
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.4.3
+        version: 1.1.1
 description: ''
 email: mail@janlelis.de
 executables: []
 extensions: []
 extra_rdoc_files:
 - ChangeLog.md
-- LICENSE.txt
+- MIT-LICENSE.txt
 - README.md
 files:
-- .document
-- .gitignore
-- .rspec
-- .yardopts
+- ".document"
+- ".editorconfig"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- ".yardopts"
 - ChangeLog.md
 - Gemfile
-- LICENSE.txt
+- MIT-LICENSE.txt
 - README.md
 - Rakefile
 - gemspec.yml
@@ -196,7 +149,6 @@ files:
 - lib/value_struct/immutable.rb
 - lib/value_struct/no_clone.rb
 - lib/value_struct/strict_arguments.rb
-- lib/value_struct/to_h.rb
 - lib/value_struct/version.rb
 - spec/benchmark.rb
 - spec/dup_with_changes_spec.rb
@@ -204,32 +156,30 @@ files:
 - spec/no_clone_spec.rb
 - spec/spec_helper.rb
 - spec/strict_arguments_spec.rb
-- spec/to_h_spec.rb
 - spec/value_struct_spec.rb
 - value_struct.gemspec
 homepage: https://github.com/janlelis/value_struct
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 2.4.5
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Struct-like value objects
 test_files: []

data/lib/value_struct/to_h.rb

@@ -1,5 +0,0 @@
-module ValueStruct::ToH
-  def to_h
-    Hash[members.zip(values)]
-  end
-end

data/spec/to_h_spec.rb

@@ -1,11 +0,0 @@
-require 'spec_helper'
-
-describe ValueStruct::ToH do
-  subject do
-    ValueStruct.new_with_mixins(:x, :y, [ValueStruct::ToH]).new(1,2)
-  end
-
-  its(:to_h) do
-    { x: 1, y: 2 }
-  end
-end