method_struct 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 759afa62052f554daf31d700adf7f69bc3f15655
-  data.tar.gz: 334a8eaf98c5aa21302f61e35f836c8ced75c0a3
+  metadata.gz: faab59cbf9a78b593cae7f255ae43932fa51d829
+  data.tar.gz: bb14949700c7b102b51fafbef4f85c403b0cc8a9
 SHA512:
-  metadata.gz: 07461e8742e57cf53bea6e84c2a0d1433fe6336858cc094e70186abac378193446936b0a37ea9fa28d0e5150a15d4c574e187b4e86bb7ec9fbf61cf55430b587
-  data.tar.gz: 38807e3209841db570081cb5e930a100996ee4f72735938801c3f772953184e4c27e23185539a006f162ed88b59b1dcc04a2e20ffff25b67997b71551e0316c3
+  metadata.gz: fdf24cfa6f0b92286a1414328853ef3f54c2b991d788a306a0fb3b048ae1052d90e3cef2067eee77cebd97448879ee33137ffb0e4360ec44ed3b43bf1c02713d
+  data.tar.gz: 4d14e2c96eca0876d166a0e1e16caab4d607c2ef8bd256c3a9feec30facac3d2d9d07f8114aab2ddc545875fce44c316af0597b018d724cd85d7b4dd8e0f3458

data/CHANGELOG

@@ -1,3 +1,6 @@
+0.2.1
+~ Fixes in how argument verification deals with hashes
+
 0.2.0
 + Allow user functions to overwrite the generated attr readers
 + Require_all option that checks if all arguments have been provided on

data/lib/method_struct.rb

@@ -1,6 +1,7 @@
 require "method_struct/version"
 require "method_struct/defaults"
 require "method_struct/argument_verifier"
+require "method_struct/argument_parser"
 
 module MethodStruct
   def self.new(*fields, &block)
@@ -11,6 +12,11 @@ module MethodStruct
       options = {}
     end
 
+    unless fields.all?{ |f| f.is_a?(Symbol) }
+      invalid_fields = fields.select{ |f| !f.is_a?(Symbol) }
+      raise ArgumentError, "only symbol fields allowed: #{invalid_fields.inspect}"
+    end
+
     method_name = options.fetch(:method_name, Defaults.get[:method_name])
     require_all = options.fetch(:require_all, Defaults.get[:require_all])
     require_presence = options.fetch(:require_presence, Defaults.get[:require_presence])
@@ -33,16 +39,15 @@ module MethodStruct
       end
 
       define_method(:initialize) do |*values|
-        ArgumentVerifier.new(fields, values, require_all, require_presence).verify
+        arguments = ArgumentParser.new(
+          :fields => fields,
+          :raw_arguments => values,
+          :require_all => require_all,
+          :require_presence => require_presence
+        ).call
 
-        if fields.size > 1 && values.size == 1 && values.first.is_a?(Hash)
-          fields.each do |field|
-            instance_variable_set("@#{field}", values.first[field])
-          end
-        else
-          fields.zip(values).each do |field, value|
-            instance_variable_set("@#{field}", value)
-          end
+        arguments.each do |field, value|
+          instance_variable_set("@#{field}", value)
         end
       end
 

data/lib/method_struct/argument_parser.rb

@@ -0,0 +1,41 @@
+module MethodStruct
+  class ArgumentParser
+    def initialize(options)
+      @options = options
+    end
+
+    def call
+      parsed_arguments.tap do |args|
+        ArgumentVerifier.new(options.merge(:arguments => args)).call
+      end
+    end
+
+    private
+    attr_reader :options
+
+    def fields
+      options.fetch(:fields)
+    end
+
+    def raw_arguments
+      options.fetch(:raw_arguments)
+    end
+
+    def parsed_arguments
+      {}.tap do |h|
+        fields.each do |field|
+          h[field] = raw_arguments_hash[field] if raw_arguments_hash.key?(field)
+        end
+      end
+    end
+
+    def raw_arguments_hash
+      @raw_arguments_hash ||= if fields.size > 1 && raw_arguments.size == 1 && raw_arguments.first.is_a?(Hash)
+        raw_arguments.first
+      else
+        zipped_fields = fields.take(raw_arguments.count)
+        Hash[*zipped_fields.zip(raw_arguments).flatten(1)]
+      end
+    end
+  end
+end

data/lib/method_struct/argument_verifier.rb

@@ -1,42 +1,37 @@
 module MethodStruct
   class ArgumentVerifier
-    def initialize(fields, values, require_all, require_presence)
-      @fields, @values = fields, values
-      @require_all, @require_presence = require_all, require_presence
+    def initialize(options)
+      @options = options
     end
 
-    def verify
-      if fields.size > 1 && values.size == 1 && values.first.is_a?(Hash)
-        verify_hash
-      else
-        verify_normal
-      end
+    def call
+      verify_require_all
+      verify_require_presence
     end
 
     private
-    attr_reader :fields, :values, :require_all, :require_presence
-
-    def verify_hash
-      expected = fields.map(&:to_s).sort
-      provided = values.first.keys.map(&:to_s).sort
+    attr_reader :options
 
-      if require_all && !(expected - provided).empty?
-        raise ArgumentError.new("wrong arguments provided")
+    def verify_require_all
+      if options.fetch(:require_all)
+        missing_arguments = fields - arguments.keys
+        raise ArgumentError.new("missing arguments: #{missing_arguments.sort.inspect}") unless missing_arguments.empty?
       end
+    end
 
-      if require_presence && !expected.all? { |arg| values.first[arg] || values.first[arg.to_s] }
-        raise ArgumentError.new("nil arguments provided")
+    def verify_require_presence
+      if options.fetch(:require_presence)
+        nil_arguments = arguments.map{ |k, v| k if v.nil? }.compact
+        raise ArgumentError.new("nil arguments: #{nil_arguments.sort.inspect}") unless nil_arguments.empty?
       end
     end
 
-    def verify_normal
-      if require_all && fields.count != values.count
-        raise ArgumentError.new("wrong number of arguments (#{values.count} for #{fields.count})")
-      end
+    def fields
+      options.fetch(:fields)
+    end
 
-      if require_presence && fields.count != values.compact.count
-        raise ArgumentError.new("nil arguments provided")
-      end
+    def arguments
+      options.fetch(:arguments)
     end
   end
 end

data/lib/method_struct/version.rb

@@ -1,3 +1,3 @@
 module MethodStruct
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

data/spec/method_struct_spec.rb

@@ -26,6 +26,11 @@ describe MethodStruct do
       end
     end
 
+    it 'does not allow definition with strings' do
+      expect{ MethodStruct.new('x', 'y') }.to raise_error(
+        ArgumentError, 'only symbol fields allowed: ["x", "y"]')
+    end
+
     it "creates a class method which calls the declared instance method with the given context" do
       verifier.should_receive(:poke).with(argument1, argument2)
       create_poker(verifier).call(argument1, argument2)
@@ -85,11 +90,15 @@ describe MethodStruct do
       let(:klass) { MethodStruct.new(:x, :y, :require_all => true) }
 
       it "does not allow creation without all arguments" do
-        expect { klass.new(nil) }.to raise_error(ArgumentError)
+        expect { klass.new(nil) }.to raise_error(ArgumentError, 'missing arguments: [:y]')
       end
 
       it "does not allow creation without all hash arguments" do
-        expect { klass.new(:y => nil) }.to raise_error(ArgumentError)
+        expect { klass.new(:y => nil) }.to raise_error(ArgumentError, 'missing arguments: [:x]')
+      end
+
+      it "allows creation with all nil hash arguments" do
+        expect { klass.new(:x => nil, :y => nil) }.not_to raise_error
       end
 
       it "allows creation with all nil arguments" do
@@ -101,11 +110,23 @@ describe MethodStruct do
       let(:klass) { MethodStruct.new(:x, :y, :require_presence => true) }
 
       it "does not allow creation without all arguments being non-nil" do
-        expect { klass.new(1, nil) }.to raise_error(ArgumentError)
+        expect { klass.new(1, nil) }.to raise_error(ArgumentError, 'nil arguments: [:y]')
       end
 
       it "does not allow creation without all hash arguments being non-nil" do
-        expect { klass.new(:x => 1, :y => nil) }.to raise_error(ArgumentError)
+        expect { klass.new(:x => 1, :y => nil) }.to raise_error(ArgumentError, 'nil arguments: [:y]')
+      end
+
+      it "allows creation with boolean hash arguments provided" do
+        expect { klass.new(:x => false, :y => false) }.not_to raise_error
+      end
+
+      it "allows creation with boolean hash arguments provided" do
+        expect { klass.new(false, false) }.not_to raise_error
+      end
+
+      it "allows creation with all hash symbol arguments provided" do
+        expect { klass.new(:x => 1, :y => 2) }.not_to raise_error
       end
 
       it "allows creation with all arguments provided" do
@@ -142,7 +163,7 @@ describe MethodStruct do
         expect(struct.new(argument1, argument2) == struct.new(argument2, argument1)).to be_false
       end
 
-      it "is uneql for unequal arguments" do
+      it "is unequal for unequal arguments" do
         expect(struct.new(argument1, argument2).eql?(struct.new(argument2, argument1))).to be_false
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: method_struct
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Paweł Obrok
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-21 00:00:00.000000000 Z
+date: 2014-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -67,6 +67,7 @@ files:
 - README.md
 - Rakefile
 - lib/method_struct.rb
+- lib/method_struct/argument_parser.rb
 - lib/method_struct/argument_verifier.rb
 - lib/method_struct/defaults.rb
 - lib/method_struct/version.rb