sig 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4715821434d81f8b6d4473888baf83db09dea536
-  data.tar.gz: f99a5268d57adfac1a8acce982998c7c317ab430
+  metadata.gz: ceb274fbcf05f2de021879342171b1e4a522b8b0
+  data.tar.gz: 9b88c7e2d0582a6d4a10dec22f32c1a953d9110a
 SHA512:
-  metadata.gz: ab71526170db48fed397b21f07a8905c7cdab0d2faaec363d2d58d2516a9253a3b7345cc2212d757db5cb51d44d7e9331a81a66886cdaa27f95b0e3a3b5f7f42
-  data.tar.gz: 91e5c513bb67eba3f0a17d1fb549091608fb003062f76e18b2607716c8a003dc876ab9f8ae4654f91e80a33fdaba9dde04db04b411762664e123d9795266f310
+  metadata.gz: 2d8cfeb62529002f4eab8fd19fe0754963388101d2381b6861770996f70655fd30d1508923612d3a75c208061cf38906cdc9486367002e8103fd14d7b14f02be
+  data.tar.gz: 5d2aad0d692f818689acfa4e8fe4c51baec3d4fcb6348838fad6ff3fe56118d13dba8e4b830bd7da4f8755b4e4f985d00178af41fc7e86461a88c26ad00f85d6

data/.travis.yml

@@ -7,6 +7,7 @@ rvm:
 - 2.2
 - 2.1
 - rbx-2
+- ruby-head
 - jruby-9000
 
 cache:
@@ -14,4 +15,5 @@ cache:
 
 matrix:
   allow_failures:
+    - rvm: ruby-head
     - rvm: jruby-9000

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## CHANGELOG
 
+### 1.0.1
+
+* Improve keyword argument code, which also improves performance
+
 ### 1.0.0
 
 * Inital release

data/README.md

@@ -20,6 +20,7 @@ class A
     a * b
   end
 end
+
 A.new.mul(4,"3")
 # Sig::ArgumentTypeError:
 # - Expected "3" to be a Numeric, but is a String
@@ -32,6 +33,7 @@ class B
     object.reverse
   end
 end
+
 B.rev 42
 # Sig::ArgumentTypeError:
 # - Expected 42 to respond to :reverse
@@ -96,13 +98,38 @@ sig [Numeric, nil,  Numeric],      # first and third argument must be numeric, d
 
 See source(https://github.com/janlelis/sig/blob/master/lib/sig.rb) or specs(https://github.com/janlelis/sig/blob/master/spec/sig_spec.rb) for more features.
 
-## Deactivate all signature checking
+## Benchmark (Take with a Grain of Salt)
+
+```
+ruby version: 2.2.2
+sig version: 1.0.1
+rubype version: 0.2.5
+contracts version: 0.8
+Calculating -------------------------------------
+                pure    59.389k i/100ms
+                 sig     9.386k i/100ms
+              rubype     8.343k i/100ms
+           contracts     5.011k i/100ms
+-------------------------------------------------
+                pure      4.660M (± 0.6%) i/s -     23.340M
+                 sig    136.535k (± 0.7%) i/s -    685.178k
+              rubype    112.444k (± 0.4%) i/s -    567.324k
+           contracts     60.699k (± 0.4%) i/s -    305.671k
+
+Comparison:
+                pure:  4660112.0 i/s
+                 sig:   136535.0 i/s - 34.13x slower
+              rubype:   112443.6 i/s - 41.44x slower
+           contracts:    60698.9 i/s - 76.77x slower
+```
+
+## Deactivate All Signature Checking
 
 ```ruby
 require 'sig/none' # instead of require 'sig'
 ```
 
-## Alternatives for type checking and more
+## Alternatives for Type Checking and More
 
 - https://github.com/gogotanaka/Rubype
 - https://github.com/egonSchiele/contracts.ruby

data/Rakefile

@@ -29,6 +29,7 @@ task :irb do
   sh "irb -I ./lib -r #{gemspec.name.gsub '-','/'}"
 end
 
+
 # # #
 # Benchmark: Take with a grain of salt
 
@@ -63,7 +64,7 @@ task :benchmark do
       x + y
     end
 
-    sig [Numeric, Numeric], Numeric,
+    sig [:to_i, :to_i], Numeric,
     def mul(x, y)
       x * y
     end
@@ -82,7 +83,7 @@ task :benchmark do
     def mul(x, y)
       x * y
     end
-    typesig :mul, [Numeric, Numeric] => Numeric
+    typesig :mul, [:to_i, :to_i] => Numeric
   end
   rubype_instance = RubypeSum.new
   puts "rubype version: #{Rubype::VERSION}"
@@ -97,7 +98,7 @@ task :benchmark do
       x + y
     end
 
-    Contract Num, Num => Num
+    Contract RespondTo[:to_i], RespondTo[:to_i] => Num
     def mul(x, y)
       x * y
     end
@@ -106,32 +107,50 @@ task :benchmark do
   puts "contracts version: #{Contracts::VERSION}"
 
   Benchmark.ips do |x|
-    x.report("pure"){
-      pure_instance.sum(1, 2)
-      pure_instance.mul(1, 2)
+    x.report("pure"){ |times|
+      i = 0
+      while i < times
+        pure_instance.sum(1, 2)
+        pure_instance.mul(1, 2)
+        i += 1
+      end
     }
 
-    x.report("sig"){
-      sig_instance.sum(1, 2)
-      sig_instance.mul(1, 2)
+    x.report("sig"){ |times|
+      i = 0
+      while i < times
+        sig_instance.sum(1, 2)
+        sig_instance.mul(1, 2)
+        i += 1
+      end
     }
 
-    x.report("rubype"){
-      rubype_instance.sum(1, 2)
-      rubype_instance.mul(1, 2)
+    x.report("rubype"){ |times|
+      i = 0
+      while i < times
+        rubype_instance.sum(1, 2)
+        rubype_instance.mul(1, 2)
+        i += 1
+      end
     }
 
-    x.report("contracts"){
-      contracts_instance.sum(1, 2)
-      contracts_instance.mul(1, 2)
+    x.report("contracts"){ |times|
+      i = 0
+      while i < times
+        contracts_instance.sum(1, 2)
+        contracts_instance.mul(1, 2)
+        i += 1
+      end
     }
-    x.warmup = 10
+
     x.compare!
   end
 end
 
+
 # # #
 # Specs
+
 desc "Run specs"
 task :spec do
   ruby "spec/sig_spec.rb"

data/lib/sig.rb

@@ -9,13 +9,22 @@ module Sig
   end
 
   def self.define(object, expected_arguments, expected_result = nil, method_name)
+    expected_arguments = Array(expected_arguments)
+    if expected_arguments.last.is_a?(Hash)
+      expected_keyword_arguments = expected_arguments.delete_at(-1)
+    else
+      expected_keyword_arguments = nil
+    end
+
     method_visibility = get_method_visibility_or_raise(object, method_name)
     signature_checker = get_or_create_signature_checker(object)
     signature_checker.send :define_method, method_name do |*arguments, **keyword_arguments|
-      ::Sig.check_arguments(expected_arguments, arguments, keyword_arguments)
       if keyword_arguments.empty?
+        ::Sig.check_arguments(expected_arguments, arguments)
         result = super(*arguments)
       else
+        ::Sig.check_arguments_with_keywords(expected_arguments, arguments,
+                                            expected_keyword_arguments, keyword_arguments)
         result = super(*arguments, **keyword_arguments)
       end
       ::Sig.check_result(expected_result, result)
@@ -50,29 +59,38 @@ module Sig
     checker
   end
 
-  def self.check_arguments(expected_arguments, arguments, keyword_arguments)
+  def self.check_arguments(expected_arguments, arguments)
     errors = ""
 
-    normalized_expected_arguments = Array(expected_arguments).dup
-    if  normalized_expected_arguments.last.is_a?(Hash)
-      expected_keyword_arguments = normalized_expected_arguments.delete_at(-1)
-    elsif keyword_arguments
-      expected_keyword_arguments = {}
-      arguments += [keyword_arguments] unless keyword_arguments.empty?
+    arguments.each_with_index{ |argument, index|
+      if error = valid_or_formatted_error(expected_arguments[index], argument)
+        errors << error
+      end
+    }
+
+    unless errors.empty?
+      raise ArgumentTypeError, errors
     end
+  end
+
+  def self.check_arguments_with_keywords(expected_arguments, arguments,
+                                         expected_keyword_arguments, keyword_arguments)
+    errors = ""
 
     arguments.each_with_index{ |argument, index|
-      if error = valid_or_formatted_error(normalized_expected_arguments[index], argument)
+      if error = valid_or_formatted_error(expected_arguments[index], argument)
         errors << error
       end
     }
 
-    unless expected_keyword_arguments.empty?
-      keyword_arguments.each{ |key, argument|
-        if error = valid_or_formatted_error(expected_keyword_arguments[key], argument)
+    if expected_keyword_arguments
+      keyword_arguments.each{ |key, keyword_argument|
+        if error = valid_or_formatted_error(expected_keyword_arguments[key], keyword_argument)
           errors << error
         end
       }
+    elsif error = valid_or_formatted_error(expected_arguments[arguments.size], keyword_arguments)
+      errors << error
     end
 
     unless errors.empty?

data/lib/sig/version.rb

@@ -1,4 +1,4 @@
 module Sig
-  VERSION = "1.0.0".freeze
+  VERSION = "1.0.1".freeze
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sig
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Jan Lelis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-14 00:00:00.000000000 Z
+date: 2015-04-15 00:00:00.000000000 Z
 dependencies: []
 description: Optional Type Assertions for Ruby methods.
 email: mail@janlelis.de
@@ -16,9 +16,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".CHANGELOG.md.swp"
+- ".Rakefile.swp"
 - ".gitignore"
 - ".travis.yml"
-- B.rev
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
@@ -60,4 +61,3 @@ summary: Optional Type Assertions for Ruby.
 test_files:
 - spec/.sig_spec.rb.swp
 - spec/sig_spec.rb
-has_rdoc: