immutable_struct 1.1.1 → 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 93086edd21bcd5072e8cdb370c3bfed0f2d20531
+  data.tar.gz: e07772aa0a327755e5970a29ff04d26cbca1299c
+SHA512:
+  metadata.gz: d5506fccce9550424ce24e893dc135db396dd89756e506fd0ed6ebf6ae7f5a79cff19362754d0d78ce4eb63e58e26c7e3a520fe2b52d6fa6b9e361d3003768e2
+  data.tar.gz: 2872be0b42a810eeecdeb7ba9d5e8a5185ba312539d9548a81a01fe40c87ef4b3abf3b1ed337e8b13b5f7040e87de4cf69717122e5baf50ad48c886c000fe8c6

data/README.mdown

@@ -16,5 +16,12 @@ In addition to the above, `ImmutableStruct` enhances the constructor to accept a
     ship = Spaceship.new(:max_speed => '∞', :name => 'The TARDIS')
     
     puts ship.max_speed # => ∞
+
+You can create a strict version of the struct, which will raise an error if you initialize it with a Hash that does not contain all the fields
+of the struct
+
+    StrictSpaceship = Spaceship.strict
+
+    strict_ship = StrictSpaceship.new(:name => 'Enterprise') # raises ArgumentError
     
-I'm surprised every time I look at the RDoc for `Struct` that it doesn't do this.
+I'm surprised every time I look at the RDoc for `Struct` that it doesn't do this.

data/lib/immutable_struct.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 
 class ImmutableStruct
-  VERSION = '1.1.1'
+  VERSION = '1.2.0'
   
   def self.new(*attrs, &block)
     struct = Struct.new(*attrs, &block)
@@ -10,7 +10,7 @@ class ImmutableStruct
     extend_dup!(struct)
     struct
   end
-  
+
 private
 
   def self.make_immutable!(struct)
@@ -18,6 +18,12 @@ private
     struct.members.each do |member|
       struct.send(:undef_method, "#{member}=".to_sym)
     end
+    struct.instance_variable_set('@strict_mode', false)
+    struct.define_singleton_method(:strict) do
+      cl = self.clone
+      cl.instance_variable_set('@strict_mode', true)
+      cl
+    end
   end
   
   def self.optionalize_constructor!(struct)
@@ -26,6 +32,14 @@ private
 
       def initialize(*attrs)
         if members.size > 1 && attrs && attrs.size == 1 && attrs.first.instance_of?(Hash)
+          strict = self.class.instance_variable_get('@strict_mode')
+          if strict
+            attr_keys = attrs.first.keys.map(&:to_sym)
+            diff = members - attr_keys
+            unless diff.empty?
+              raise ArgumentError, "Fields #{diff.join(',')} not provided"
+            end
+          end
           struct_initialize(*members.map { |m| attrs.first[m.to_sym] })
         else
           struct_initialize(*attrs)
@@ -38,6 +52,17 @@ private
           h
         end
       end
+
+      def encode_with(coder)
+        members.each do |m|
+          coder[m.to_s] = self[m]
+        end
+      end
+
+      def init_with(coder)
+        struct_initialize(*members.map { |m| coder.map[m.to_s] })
+      end
+
     end
   end
   

metadata

@@ -1,8 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: immutable_struct
 version: !ruby/object:Gem::Version
-  version: 1.1.1
-  prerelease: 
+  version: 1.2.0
 platform: ruby
 authors:
 - Theo Hultberg
@@ -10,38 +9,34 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-20 00:00:00.000000000 Z
+date: 2016-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: A version of Ruby's Struct class that creates classes whose instances
@@ -54,35 +49,31 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/immutable_struct.rb
 - LICENSE
 - README.mdown
+- lib/immutable_struct.rb
 homepage: http://github.com/iconara/immutable_struct
 licenses: []
+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'
-      segments:
-      - 0
-      hash: 186220760556065832
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.3.6
 requirements: []
 rubyforge_project: immutable_struct
-rubygems_version: 1.8.23
+rubygems_version: 2.4.8
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A version of Ruby's Struct class that creates classes whose instances are
   immutable
 test_files: []