method_struct 0.1.5 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e0b38691d962c63d8ebb037565c81361f44f3b2b
-  data.tar.gz: f3bcf9cf908e6ead363a94ef5fb954ce88f3dbd1
+  metadata.gz: 759afa62052f554daf31d700adf7f69bc3f15655
+  data.tar.gz: 334a8eaf98c5aa21302f61e35f836c8ced75c0a3
 SHA512:
-  metadata.gz: 6cfec0c5eb4782d6455bf98273b1225c69810197f097f4a37d1e58690f9b5e7844fee9de430c4fc9837cc9ee2cf275a04553b983dfe7247b7749678b6f10288c
-  data.tar.gz: fb802dde5e883e65fe7ccb69a9b589b1ab9efaeaa05643f395ae9a41195e3511e119536a94da2630453cdefeec8feef9506d07e5d44b32a81350bba7566329d6
+  metadata.gz: 07461e8742e57cf53bea6e84c2a0d1433fe6336858cc094e70186abac378193446936b0a37ea9fa28d0e5150a15d4c574e187b4e86bb7ec9fbf61cf55430b587
+  data.tar.gz: 38807e3209841db570081cb5e930a100996ee4f72735938801c3f772953184e4c27e23185539a006f162ed88b59b1dcc04a2e20ffff25b67997b71551e0316c3

data/CHANGELOG

@@ -1,3 +1,11 @@
+0.2.0
++ Allow user functions to overwrite the generated attr readers
++ Require_all option that checks if all arguments have been provided on
+  initialization
++ Require_presence option that checks if all arguments are non-nil on
+  initialization
++ Configurable defaults for the options
+
 0.1.5
 + Support blocks
 

data/README.md

@@ -79,7 +79,16 @@ class UsersController
 end
 ```
 
-One hopes the benefits will be more obvious for more complex methods
+You can use `:require_all => true` if you want to verify that all arguments
+have been specified or `:require_presence => true` to verify that all arguments
+are non-nil. Global defaults for these options can be changed like so:
+
+```ruby
+MethodStruct::Defaults.set(
+  :require_presence => true,
+  :method_name => :do_it
+)
+```
 
 ## Contributing
 

data/lib/method_struct/argument_verifier.rb

@@ -0,0 +1,42 @@
+module MethodStruct
+  class ArgumentVerifier
+    def initialize(fields, values, require_all, require_presence)
+      @fields, @values = fields, values
+      @require_all, @require_presence = require_all, require_presence
+    end
+
+    def verify
+      if fields.size > 1 && values.size == 1 && values.first.is_a?(Hash)
+        verify_hash
+      else
+        verify_normal
+      end
+    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
+
+      if require_all && !(expected - provided).empty?
+        raise ArgumentError.new("wrong arguments provided")
+      end
+
+      if require_presence && !expected.all? { |arg| values.first[arg] || values.first[arg.to_s] }
+        raise ArgumentError.new("nil arguments provided")
+      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
+
+      if require_presence && fields.count != values.compact.count
+        raise ArgumentError.new("nil arguments provided")
+      end
+    end
+  end
+end

data/lib/method_struct/defaults.rb

@@ -0,0 +1,31 @@
+require "singleton"
+
+module MethodStruct
+  class Defaults
+    include Singleton
+
+    def self.set(options)
+      instance.set(options)
+    end
+
+    def self.get
+      instance.get
+    end
+
+    def initialize
+      @defaults = {
+        :method_name => :call,
+        :require_all => false,
+        :require_presence => false,
+      }
+    end
+
+    def set(options)
+      @defaults = @defaults.merge(options)
+    end
+
+    def get
+      @defaults
+    end
+  end
+end

data/lib/method_struct/version.rb

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

data/lib/method_struct.rb

@@ -1,14 +1,20 @@
 require "method_struct/version"
+require "method_struct/defaults"
+require "method_struct/argument_verifier"
 
 module MethodStruct
   def self.new(*fields, &block)
     if fields.last.is_a?(Hash)
-      method_name = fields.last[:method_name]
+      options = fields.last
       fields = fields.take(fields.size - 1)
     else
-      method_name = :call
+      options = {}
     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])
+
     Class.new do
       singleton_class = (class << self; self; end)
 
@@ -27,6 +33,8 @@ module MethodStruct
       end
 
       define_method(:initialize) do |*values|
+        ArgumentVerifier.new(fields, values, require_all, require_presence).verify
+
         if fields.size > 1 && values.size == 1 && values.first.is_a?(Hash)
           fields.each do |field|
             instance_variable_set("@#{field}", values.first[field])
@@ -49,12 +57,12 @@ module MethodStruct
         fields.map { |field| send(field).hash }.inject(&:^)
       end
 
-      class_eval(&block) if block_given?
-
-      protected
       fields.each do |field|
         attr_reader(field)
+        protected field
       end
+
+      class_eval(&block) if block_given?
     end
   end
 end

data/spec/method_struct_spec.rb

@@ -16,6 +16,16 @@ describe MethodStruct do
       end
     end
 
+    WithDefault = MethodStruct.new(:x, :y) do
+      def call
+        [x, y]
+      end
+
+      def x
+        @x ||= 'default'
+      end
+    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)
@@ -71,6 +81,38 @@ describe MethodStruct do
       end
     end
 
+    context "when :require_all => true" 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)
+      end
+
+      it "does not allow creation without all hash arguments" do
+        expect { klass.new(:y => nil) }.to raise_error(ArgumentError)
+      end
+
+      it "allows creation with all nil arguments" do
+        expect { klass.new(nil, nil) }.not_to raise_error
+      end
+    end
+
+    context "when :require_presence => true" 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)
+      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)
+      end
+
+      it "allows creation with all arguments provided" do
+        expect { klass.new(1, 2) }.not_to raise_error
+      end
+    end
+
     it "allows for additional methods defined with a block" do
       klass = MethodStruct.new(:x) do
         def something
@@ -135,5 +177,10 @@ describe MethodStruct do
         poker.call(argument1)
       end
     end
+
+    it 'allows overriding default attr_readers' do
+      WithDefault.call(:x => argument1, :y => argument2).should eq([argument1, argument2])
+      WithDefault.call(:y => argument2).should eq(['default', argument2])
+    end
   end
 end

metadata

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