sig 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: ceb274fbcf05f2de021879342171b1e4a522b8b0
-  data.tar.gz: 9b88c7e2d0582a6d4a10dec22f32c1a953d9110a
+SHA256:
+  metadata.gz: 0275d2e23d0acbd4ee5ee320205b7f139d7827b5fac16d1897fd1cf3e52cadde
+  data.tar.gz: 33059bc6cb2c04122905353f7cef5582be23926c93d6b19df32aceb52aa7cabd
 SHA512:
-  metadata.gz: 2d8cfeb62529002f4eab8fd19fe0754963388101d2381b6861770996f70655fd30d1508923612d3a75c208061cf38906cdc9486367002e8103fd14d7b14f02be
-  data.tar.gz: 5d2aad0d692f818689acfa4e8fe4c51baec3d4fcb6348838fad6ff3fe56118d13dba8e4b830bd7da4f8755b4e4f985d00178af41fc7e86461a88c26ad00f85d6
+  metadata.gz: 59337fd40a457f2d887424b7915b62f3743b3316b2b621ac5ea7a6c17179ab74243c80fc36d4105a983ad737d7471dbc0ae00a9427d64045bf97f23591324489
+  data.tar.gz: 0d77e6f24e7b2c2c8483c93d726b572aab8128fe5a65581f99d65684bd064a1904c66f10e27061bb975c313b086f6aff515cbe62daa991dd137b3500d44cae92

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ## CHANGELOG
 
+### 1.0.2
+
+* Relax Ruby version requirement to allow Ruby 3.0
+
 ### 1.0.1
 
 * Improve keyword argument code, which also improves performance

data/Gemfile

@@ -2,9 +2,11 @@ source 'https://rubygems.org'
 
 gemspec
 
+gem 'rake'
+gem 'irb' unless RUBY_ENGINE == "jruby"
 gem 'minitest'
 gem 'minitest-line'
 gem 'minitest-reporters'
-gem 'benchmark-ips'
-gem 'rubype'
-gem 'contracts'
+# gem 'benchmark-ips'
+# gem 'rubype'
+# gem 'contracts'

data/README.md

@@ -1,4 +1,4 @@
-# `sig`: Optional Type Assertions for Ruby methods. [![[version]](https://badge.fury.io/rb/sig.svg)](http://badge.fury.io/rb/sig)  [![[travis]](https://travis-ci.org/janlelis/sig.png)](https://travis-ci.org/janlelis/sig)
+# `sig`: Optional Type Assertions for Ruby methods. [![[version]](https://badge.fury.io/rb/sig.svg)](http://badge.fury.io/rb/sig)  [![[ci]](https://github.com/janlelis/sig/workflows/Test/badge.svg)](https://github.com/janlelis/sig/actions?query=workflow%3ATest)
 
 This gem adds the `sig` method that allows you to add signatures to Ruby methods. When you call the method, it will verify that the method's arguments/result fit to the previously defined behavior:
 
@@ -55,7 +55,7 @@ Nevertheless, nothing is wrong with ensuring specific behaviour of method argume
 
 ### Is this better than rubype?
 
-The rubype gem achieves similar things like sig (and inspired the creation of sig). It offers a different syntax and differs in feature & implementation details, so in the end, it is a matter of taste, which gem you prefer. The performance impact is quite similar (sig version 1.0 vs rubype 0.2.5), run `rake benchmark` for details.
+The rubype gem achieves similar things like sig (and inspired the creation of sig). It offers a different syntax and differs in feature & implementation details, so in the end, it is a matter of taste, which gem you prefer.
 
 ## Setup
 
@@ -100,27 +100,91 @@ See source(https://github.com/janlelis/sig/blob/master/lib/sig.rb) or specs(http
 
 ## Benchmark (Take with a Grain of Salt)
 
+You can run `rake  benchmark` to run [it](https://github.com/janlelis/sig/blob/v1.0.1/Rakefile#L33-L148) on your machine.
+
+There is still a lot room for performance improvements. Feel free to suggest some faster implementation to do the type checks (even if it is crazy and not clean, as long it does not add too much "magic", a.k.a does not make debugging harder).
+
+Note: Starting with 0.3.0, rubype uses a C extension, which makes it much faster. The benchmark is still run with rubype 0.2.5, because 0.3.x currently does not work on jruby & rbx.
+
+### MRI
+
 ```
 ruby version: 2.2.2
+ruby engine: ruby
+ruby description: ruby 2.2.2p95 (2015-04-13 revision 50295) [x86_64-linux]
+sig version: 1.0.1
+rubype version: 0.2.5
+contracts version: 0.9
+Calculating -------------------------------------
+                pure   107.628k i/100ms
+                 sig    14.425k i/100ms
+              rubype    12.715k i/100ms
+           contracts     7.688k i/100ms
+-------------------------------------------------
+                pure      6.856M (± 0.9%) i/s -     34.333M
+                 sig    192.440k (± 1.5%) i/s -    966.475k
+              rubype    164.811k (± 0.8%) i/s -    826.475k
+           contracts     90.089k (± 0.7%) i/s -    453.592k
+
+Comparison:
+                pure:  6855615.3 i/s
+                 sig:   192439.7 i/s - 35.62x slower
+              rubype:   164810.5 i/s - 41.60x slower
+           contracts:    90088.6 i/s - 76.10x slower
+```
+
+### JRuby 9000
+
+```
+ruby version: 2.2.2
+ruby engine: jruby
+ruby description: jruby 9.0.0.0-SNAPSHOT (2.2.2) 2015-05-04 6055b79 Java HotSpot(TM) 64-Bit Server VM 24.80-b11 on 1.7.0_80-b15 +indy +jit [linux-amd64]
+sig version: 1.0.1
+rubype version: 0.2.5
+contracts version: 0.9
+Calculating -------------------------------------
+                pure    70.898k i/100ms
+                 sig     5.308k i/100ms
+              rubype     3.152k i/100ms
+           contracts   279.000  i/100ms
+-------------------------------------------------
+                pure      8.848M (±13.7%) i/s -     42.539M
+                 sig    178.169k (±10.3%) i/s -    881.128k
+              rubype    119.689k (±26.5%) i/s -    444.432k
+           contracts     56.780k (±16.8%) i/s -    265.887k
+
+Comparison:
+                pure:  8848039.4 i/s
+                 sig:   178168.8 i/s - 49.66x slower
+              rubype:   119689.0 i/s - 73.93x slower
+           contracts:    56780.4 i/s - 155.83x slower
+```
+
+### RBX 2.5.3
+
+```
+ruby version: 2.1.0
+ruby engine: rbx
+ruby description: rubinius 2.5.3.c25 (2.1.0 fbb3f1e4 2015-05-02 3.4 JI) [x86_64-linux-gnu]
 sig version: 1.0.1
 rubype version: 0.2.5
-contracts version: 0.8
+contracts version: 0.9
 Calculating -------------------------------------
-                pure    59.389k i/100ms
-                 sig     9.386k i/100ms
-              rubype     8.343k i/100ms
-           contracts     5.011k i/100ms
+                pure   114.964k i/100ms
+                 sig     9.654k i/100ms
+              rubype     3.775k i/100ms
+           contracts     3.964k 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
+                pure     23.585M (± 3.3%) i/s -    117.263M
+                 sig    134.304k (± 3.1%) i/s -    675.780k
+              rubype     56.042k (± 1.7%) i/s -    283.125k
+           contracts     69.820k (± 1.8%) i/s -    348.832k
 
 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
+                pure: 23585373.7 i/s
+                 sig:   134303.7 i/s - 175.61x slower
+           contracts:    69819.9 i/s - 337.80x slower
+              rubype:    56042.1 i/s - 420.85x slower
 ```
 
 ## Deactivate All Signature Checking

data/Rakefile

@@ -35,119 +35,9 @@ end
 
 desc "Compare with contracts and rubype"
 task :benchmark do
-  require "benchmark/ips"
-  require "rubype"
-  require "rubype/version"
-  require "contracts"
-  require "contracts/version"
-  require_relative "lib/sig"
-
-  # - - -
-
-  class PureSum
-    def sum(x, y)
-      x + y
-    end
-
-    def mul(x, y)
-      x * y
-    end
-  end
-  pure_instance = PureSum.new
-  puts "ruby version: #{RUBY_VERSION}"
-
-  # - - -
-
-  class SigSum
-    sig [Numeric, Numeric], Numeric,
-    def sum(x, y)
-      x + y
-    end
-
-    sig [:to_i, :to_i], Numeric,
-    def mul(x, y)
-      x * y
-    end
-  end
-  sig_instance = SigSum.new
-  puts "sig version: #{Sig::VERSION}"
-
-  # - - -
-
-  class RubypeSum
-    def sum(x, y)
-      x + y
-    end
-    typesig :sum, [Numeric, Numeric] => Numeric
-
-    def mul(x, y)
-      x * y
-    end
-    typesig :mul, [:to_i, :to_i] => Numeric
-  end
-  rubype_instance = RubypeSum.new
-  puts "rubype version: #{Rubype::VERSION}"
-
-  # - - -
-
-  class ContractsSum
-    include Contracts
-
-    Contract Num, Num => Num
-    def sum(x, y)
-      x + y
-    end
-
-    Contract RespondTo[:to_i], RespondTo[:to_i] => Num
-    def mul(x, y)
-      x * y
-    end
-  end
-  contracts_instance = ContractsSum.new
-  puts "contracts version: #{Contracts::VERSION}"
-
-  Benchmark.ips do |x|
-    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"){ |times|
-      i = 0
-      while i < times
-        sig_instance.sum(1, 2)
-        sig_instance.mul(1, 2)
-        i += 1
-      end
-    }
-
-    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"){ |times|
-      i = 0
-      while i < times
-        contracts_instance.sum(1, 2)
-        contracts_instance.mul(1, 2)
-        i += 1
-      end
-    }
-
-    x.compare!
-  end
+  ruby "benchmark/compare.rb"
 end
 
-
 # # #
 # Specs
 

data/benchmark/compare.rb

@@ -0,0 +1,145 @@
+require "benchmark/ips"
+
+require "rubype"
+require "rubype/version"
+require "typecheck"
+require "contracts"
+require "contracts/version"
+require_relative "../lib/sig"
+
+# - - -
+
+puts "ruby version: #{RUBY_VERSION}"
+puts "ruby engine: #{RUBY_ENGINE}"
+puts "ruby description: #{RUBY_DESCRIPTION}"
+puts "sig version: #{Sig::VERSION}"
+puts "rubype version: #{Rubype::VERSION}"
+puts "typecheck version: #{Typecheck::VERSION}"
+puts "contracts version: #{Contracts::VERSION}"
+
+# - - -
+
+class PureSum
+  def sum(x, y)
+    x + y
+  end
+
+  def mul(x, y)
+    x * y
+  end
+end
+pure_instance = PureSum.new
+
+# - - -
+
+class SigSum
+  sig [Numeric, Numeric], Numeric,
+  def sum(x, y)
+    x + y
+  end
+
+  sig [:to_i, :to_i], Numeric,
+  def mul(x, y)
+    x * y
+  end
+end
+sig_instance = SigSum.new
+
+# - - -
+
+class RubypeSum
+  def sum(x, y)
+    x + y
+  end
+  typesig :sum, [Numeric, Numeric] => Numeric
+
+  def mul(x, y)
+    x * y
+  end
+  typesig :mul, [:to_i, :to_i] => Numeric
+end
+rubype_instance = RubypeSum.new
+
+# - - -
+
+class TypecheckSum
+  extend Typecheck
+
+  typecheck 'Numeric, Numeric -> Numeric',
+  def sum(x, y)
+    x + y
+  end
+
+  typecheck '#to_i, #to_i -> Numeric',
+  def mul(x, y)
+    x * y
+  end
+end
+typecheck_instance = TypecheckSum.new
+
+# - - -
+
+class ContractsSum
+  include Contracts
+
+  Contract Num, Num => Num
+  def sum(x, y)
+    x + y
+  end
+
+  Contract RespondTo[:to_i], RespondTo[:to_i] => Num
+  def mul(x, y)
+    x * y
+  end
+end
+contracts_instance = ContractsSum.new
+
+Benchmark.ips do |x|
+  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"){ |times|
+    i = 0
+    while i < times
+      sig_instance.sum(1, 2)
+      sig_instance.mul(1, 2)
+      i += 1
+    end
+  }
+
+  x.report("rubype"){ |times|
+    i = 0
+    while i < times
+      rubype_instance.sum(1, 2)
+      rubype_instance.mul(1, 2)
+      i += 1
+    end
+  }
+
+  x.report("typecheck"){ |times|
+    i = 0
+    while i < times
+      typecheck_instance.sum(1, 2)
+      typecheck_instance.mul(1, 2)
+      i += 1
+    end
+  }
+
+  x.report("contracts"){ |times|
+    i = 0
+    while i < times
+      contracts_instance.sum(1, 2)
+      contracts_instance.mul(1, 2)
+      i += 1
+    end
+  }
+
+  x.compare!
+end
+

data/lib/sig.rb

@@ -9,6 +9,8 @@ module Sig
   end
 
   def self.define(object, expected_arguments, expected_result = nil, method_name)
+    no_argument_checks = expected_arguments.nil?
+
     expected_arguments = Array(expected_arguments)
     if expected_arguments.last.is_a?(Hash)
       expected_keyword_arguments = expected_arguments.delete_at(-1)
@@ -20,14 +22,15 @@ module Sig
     signature_checker = get_or_create_signature_checker(object)
     signature_checker.send :define_method, method_name do |*arguments, **keyword_arguments|
       if keyword_arguments.empty?
-        ::Sig.check_arguments(expected_arguments, arguments)
+        ::Sig.check_arguments(expected_arguments, arguments) unless no_argument_checks
         result = super(*arguments)
       else
         ::Sig.check_arguments_with_keywords(expected_arguments, arguments,
-                                            expected_keyword_arguments, keyword_arguments)
+                                            expected_keyword_arguments,
+                                            keyword_arguments) unless no_argument_checks
         result = super(*arguments, **keyword_arguments)
       end
-      ::Sig.check_result(expected_result, result)
+      ::Sig.check_result(expected_result, result) unless expected_result.nil?
 
       result
     end

data/lib/sig/version.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 module Sig
-  VERSION = "1.0.1".freeze
+  VERSION = "1.0.2"
 end
 

data/sig.gemspec

@@ -17,5 +17,5 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ["lib"]
 
-  gem.required_ruby_version = "~> 2.1"
+  gem.required_ruby_version = ">= 2.1", "< 4.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sig
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Jan Lelis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-15 00:00:00.000000000 Z
+date: 2020-12-30 00:00:00.000000000 Z
 dependencies: []
 description: Optional Type Assertions for Ruby methods.
 email: mail@janlelis.de
@@ -16,23 +16,19 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".CHANGELOG.md.swp"
-- ".Rakefile.swp"
 - ".gitignore"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - MIT-LICENSE.txt
 - README.md
 - Rakefile
+- benchmark/compare.rb
 - lib/sig.rb
-- lib/sig/.kernel.rb.swp
 - lib/sig/kernel.rb
 - lib/sig/none.rb
 - lib/sig/version.rb
 - sig.gemspec
-- spec/.sig_spec.rb.swp
 - spec/sig_spec.rb
 homepage: https://github.com/janlelis/sig
 licenses:
@@ -44,20 +40,21 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - "~>"
+  - - ">="
     - !ruby/object:Gem::Version
       version: '2.1'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '4.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Optional Type Assertions for Ruby.
 test_files:
-- spec/.sig_spec.rb.swp
 - spec/sig_spec.rb

data/.travis.yml

@@ -1,19 +0,0 @@
-sudo: false
-language: ruby
-
-script: bundle exec ruby spec/sig_spec.rb
-
-rvm:
-- 2.2
-- 2.1
-- rbx-2
-- ruby-head
-- jruby-9000
-
-cache:
-- bundler
-
-matrix:
-  allow_failures:
-    - rvm: ruby-head
-    - rvm: jruby-9000