hash_initialized_struct 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cc7ed250f43a1ae28eae74e01ceebf6d8af96784
-  data.tar.gz: ea0e9580302506002ff65c74085428b7893706b8
+  metadata.gz: 0a019905cb0578ccd137f19e03bc4506c4394d70
+  data.tar.gz: d995895f24be535e41f72b7c55d8f074b05dbf66
 SHA512:
-  metadata.gz: 925de0d5261c4c00838b63800280cc9a89189ce108363dc8de75f717a39a602d8333708857ac4b9540b12c2250fd80849c9c4be08730d40a4f47bc0d3662b9f3
-  data.tar.gz: e28821abc99474aca7408ca85f5b3060370d5cbac0ed3d513585487a4d5bfb99d561925f3305cdf74dc1b4d87e56d5005807804aab2d63a9f8f918e7e487c8da
+  metadata.gz: eaa60f77a463b145fe836d23b06b1953ef64959a99b78e14c603280de7e655b482c5abcca48e2ceb921cd2ed8cae716fbadcc3417c4744426e80fd3b86d1bea8
+  data.tar.gz: 9c3990737ae43394e9ea0f2d3ea8c7fe186b3165c3718edc3568f894d3cae8a5517cdc000cf4a230610b34c97cf5bfeadf308d11232ed5c274cd4ba271271a4b

data/lib/hash_initialized_struct/version.rb

@@ -1,3 +1,3 @@
 class HashInitializedStruct
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

data/lib/hash_initialized_struct.rb

@@ -35,16 +35,10 @@ class HashInitializedStruct
 
       def initialize(attrs)
         provided = attrs.keys
-        needed   = self.class::STRUCT_ATTRS
-        (provided - needed).tap do |unknown|
-          raise ArgumentError, "Unrecognised keys: #{unknown.map(&:inspect).join(', ')}" unless unknown.empty?
-        end
-        (needed - provided).tap do |missing|
-          raise ArgumentError, "Missing keys: #{missing.map(&:inspect).join(', ')}" unless missing.empty?
-        end
-        attrs.each do |attr,value|
-          instance_variable_set("@#{attr}", value)
-        end
+        needed   = needed_keys
+        self.raise_on_unrecognised_keys(provided, needed)
+        self.raise_on_missing_keys(provided, needed)
+        set_attributes(attrs)
       end
 
       def to_h
@@ -52,6 +46,30 @@ class HashInitializedStruct
         Hash[ self.class::STRUCT_ATTRS.map {|key| [key, self.public_send(key)]} ]
       end
       alias :to_hash :to_h
+
+      protected
+
+        def needed_keys
+          self.class::STRUCT_ATTRS
+        end
+
+        def raise_on_unrecognised_keys(provided, needed)
+          (provided - needed).tap do |unknown|
+            raise ArgumentError, "Unrecognised keys: #{unknown.map(&:inspect).join(', ')}" unless unknown.empty?
+          end
+        end
+
+        def raise_on_missing_keys(provided, needed)
+          (needed - provided).tap do |missing|
+            raise ArgumentError, "Missing keys: #{missing.map(&:inspect).join(', ')}" unless missing.empty?
+          end
+        end
+
+        def set_attributes(attrs)
+          attrs.each do |attr,value|
+            instance_variable_set("@#{attr}", value)
+          end
+        end
     end
   end
 end

data/spec/hash_initialized_struct_spec.rb

@@ -46,23 +46,38 @@ describe "HashInitializedStruct" do
     expect(point.to_h).to eq Hash(point) # to_h == to_hash
   end
 
-  it "allows for overriding the constructor to add additional checks" do
-    # Could do this with an anonymous class and define_method, but we're trying to emulate
-    # how it might actually be used.
-    class My3DPoint < HashInitializedStruct.new(:x, :y, :z)
-      def initialize(attrs)
-        super
-        [x, y, z].each do |attr|
-          raise ArgumentError, "#{attr} must be a number" unless attr.kind_of?(Numeric)
+  describe "overriding the constructor" do
+    it "allows additional checks" do
+      # Could do this with an anonymous class and define_method, but we're trying to emulate
+      # how it might actually be used.
+      class My3DPoint < HashInitializedStruct.new(:x, :y, :z)
+        def initialize(attrs)
+          super
+          [x, y, z].each do |attr|
+            raise ArgumentError, "#{attr} must be a number" unless attr.kind_of?(Numeric)
+          end
         end
       end
+
+      good = My3DPoint.new(x: 1, y: 2, z: 9)
+      expect(good.x).to eq 1
+
+      expect {
+        My3DPoint.new(x: "1", y: nil, z: 9)
+      }.to raise_error(ArgumentError)
     end
 
-    good = My3DPoint.new(x: 1, y: 2, z: 9)
-    expect(good.x).to eq 1
+    it "allows partial checks" do
+      class MyOptionally4DPoint < HashInitializedStruct.new(:x, :y, :z, :t)
+        def initialize(attrs)
+          provided = attrs.keys
+          raise_on_unrecognised_keys(provided, needed_keys)
+          set_attributes
+        end
+      end
 
-    expect {
-      My3DPoint.new(x: "1", y: nil, z: 9)
-    }.to raise_error(ArgumentError)
+      good = My3DPoint.new(x: 1, y: 2, z: 9) # Missing :t
+      expect(good.x).to eq 1
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hash_initialized_struct
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Rob Howard