entitlements 0.1.8 → 0.2.0

data/lib/contracts-ruby2/benchmarks/bench.rb

@@ -0,0 +1,67 @@
+require "./lib/contracts"
+require "benchmark"
+require "rubygems"
+require "method_profiler"
+require "ruby-prof"
+
+include Contracts
+
+def add a, b
+  a + b
+end
+
+Contract Num, Num => Num
+def contracts_add a, b
+  a + b
+end
+
+def explicit_add a, b
+  fail unless a.is_a?(Numeric)
+  fail unless b.is_a?(Numeric)
+  c = a + b
+  fail unless c.is_a?(Numeric)
+  c
+end
+
+def benchmark
+  Benchmark.bm 30 do |x|
+    x.report "testing add" do
+      1_000_000.times do |_|
+        add(rand(1000), rand(1000))
+      end
+    end
+    x.report "testing contracts add" do
+      1_000_000.times do |_|
+        contracts_add(rand(1000), rand(1000))
+      end
+    end
+  end
+end
+
+def profile
+  profilers = []
+  profilers << MethodProfiler.observe(Contract)
+  profilers << MethodProfiler.observe(Object)
+  profilers << MethodProfiler.observe(Contracts::MethodDecorators)
+  profilers << MethodProfiler.observe(Contracts::Decorator)
+  profilers << MethodProfiler.observe(Contracts::Support)
+  profilers << MethodProfiler.observe(UnboundMethod)
+  10_000.times do |_|
+    contracts_add(rand(1000), rand(1000))
+  end
+  profilers.each { |p| puts p.report }
+end
+
+def ruby_prof
+  RubyProf.start
+  100_000.times do |_|
+    contracts_add(rand(1000), rand(1000))
+  end
+  result = RubyProf.stop
+  printer = RubyProf::FlatPrinter.new(result)
+  printer.print(STDOUT)
+end
+
+benchmark
+profile
+ruby_prof if ENV["FULL_BENCH"] # takes some time

data/lib/contracts-ruby2/benchmarks/hash.rb

@@ -0,0 +1,69 @@
+require "./lib/contracts"
+require "benchmark"
+require "rubygems"
+require "method_profiler"
+require "ruby-prof"
+
+include Contracts
+
+def add opts
+  opts[:a] + opts[:b]
+end
+
+Contract ({ :a => Num, :b => Num}) => Num
+def contracts_add opts
+  opts[:a] + opts[:b]
+end
+
+def explicit_add opts
+  a = opts[:a]
+  b = opts[:b]
+  fail unless a.is_a?(Numeric)
+  fail unless b.is_a?(Numeric)
+  c = a + b
+  fail unless c.is_a?(Numeric)
+  c
+end
+
+def benchmark
+  Benchmark.bm 30 do |x|
+    x.report "testing add" do
+      1_000_000.times do |_|
+        add(:a => rand(1000), :b => rand(1000))
+      end
+    end
+    x.report "testing contracts add" do
+      1_000_000.times do |_|
+        contracts_add(:a => rand(1000), :b => rand(1000))
+      end
+    end
+  end
+end
+
+def profile
+  profilers = []
+  profilers << MethodProfiler.observe(Contract)
+  profilers << MethodProfiler.observe(Object)
+  profilers << MethodProfiler.observe(Contracts::MethodDecorators)
+  profilers << MethodProfiler.observe(Contracts::Decorator)
+  profilers << MethodProfiler.observe(Contracts::Support)
+  profilers << MethodProfiler.observe(UnboundMethod)
+  10_000.times do |_|
+    contracts_add(:a => rand(1000), :b => rand(1000))
+  end
+  profilers.each { |p| puts p.report }
+end
+
+def ruby_prof
+  RubyProf.start
+  100_000.times do |_|
+    contracts_add(:a => rand(1000), :b => rand(1000))
+  end
+  result = RubyProf.stop
+  printer = RubyProf::FlatPrinter.new(result)
+  printer.print(STDOUT)
+end
+
+benchmark
+profile
+ruby_prof if ENV["FULL_BENCH"] # takes some time

data/lib/contracts-ruby2/benchmarks/invariants.rb

@@ -0,0 +1,91 @@
+require "./lib/contracts"
+require "benchmark"
+require "rubygems"
+require "method_profiler"
+require "ruby-prof"
+
+class Obj
+  include Contracts
+
+  attr_accessor :value
+  def initialize value
+    @value = value
+  end
+
+  Contract Num, Num => Num
+  def contracts_add a, b
+    a + b
+  end
+end
+
+class ObjWithInvariants
+  include Contracts
+  include Contracts::Invariants
+
+  invariant(:value_not_nil) { value != nil }
+  invariant(:value_not_string) { !value.is_a?(String) }
+
+  attr_accessor :value
+  def initialize value
+    @value = value
+  end
+
+  Contract Num, Num => Num
+  def contracts_add a, b
+    a + b
+  end
+end
+
+def benchmark
+  obj = Obj.new(3)
+  obj_with_invariants = ObjWithInvariants.new(3)
+
+  Benchmark.bm 30 do |x|
+    x.report "testing contracts add" do
+      1_000_000.times do |_|
+        obj.contracts_add(rand(1000), rand(1000))
+      end
+    end
+    x.report "testing contracts add with invariants" do
+      1_000_000.times do |_|
+        obj_with_invariants.contracts_add(rand(1000), rand(1000))
+      end
+    end
+  end
+end
+
+def profile
+  obj_with_invariants = ObjWithInvariants.new(3)
+
+  profilers = []
+  profilers << MethodProfiler.observe(Contract)
+  profilers << MethodProfiler.observe(Object)
+  profilers << MethodProfiler.observe(Contracts::Support)
+  profilers << MethodProfiler.observe(Contracts::Invariants)
+  profilers << MethodProfiler.observe(Contracts::Invariants::InvariantExtension)
+  profilers << MethodProfiler.observe(UnboundMethod)
+
+  10_000.times do |_|
+    obj_with_invariants.contracts_add(rand(1000), rand(1000))
+  end
+
+  profilers.each { |p| puts p.report }
+end
+
+def ruby_prof
+  RubyProf.start
+
+  obj_with_invariants = ObjWithInvariants.new(3)
+
+  100_000.times do |_|
+    obj_with_invariants.contracts_add(rand(1000), rand(1000))
+  end
+
+  result = RubyProf.stop
+  printer = RubyProf::FlatPrinter.new(result)
+  printer.print(STDOUT)
+end
+
+benchmark
+profile
+ruby_prof if ENV["FULL_BENCH"] # takes some time

data/lib/contracts-ruby2/benchmarks/io.rb

@@ -0,0 +1,62 @@
+require "./lib/contracts"
+require "benchmark"
+require "rubygems"
+require "method_profiler"
+require "ruby-prof"
+require "open-uri"
+
+include Contracts
+
+def download url
+  open("http://www.#{url}/").read
+end
+
+Contract String => String
+def contracts_download url
+  open("http://www.#{url}").read
+end
+
+@urls = %w{google.com bing.com}
+
+def benchmark
+  Benchmark.bm 30 do |x|
+    x.report "testing download" do
+      100.times do |_|
+        download(@urls.sample)
+      end
+    end
+    x.report "testing contracts download" do
+      100.times do |_|
+        contracts_download(@urls.sample)
+      end
+    end
+  end
+end
+
+def profile
+  profilers = []
+  profilers << MethodProfiler.observe(Contract)
+  profilers << MethodProfiler.observe(Object)
+  profilers << MethodProfiler.observe(Contracts::MethodDecorators)
+  profilers << MethodProfiler.observe(Contracts::Decorator)
+  profilers << MethodProfiler.observe(Contracts::Support)
+  profilers << MethodProfiler.observe(UnboundMethod)
+  10.times do |_|
+    contracts_download(@urls.sample)
+  end
+  profilers.each { |p| puts p.report }
+end
+
+def ruby_prof
+  RubyProf.start
+  10.times do |_|
+    contracts_download(@urls.sample)
+  end
+  result = RubyProf.stop
+  printer = RubyProf::FlatPrinter.new(result)
+  printer.print(STDOUT)
+end
+
+benchmark
+profile
+ruby_prof if ENV["FULL_BENCH"] # takes some time

data/lib/contracts-ruby2/benchmarks/wrap_test.rb

@@ -0,0 +1,57 @@
+require "benchmark"
+
+module Wrapper
+  def self.extended(klass)
+    klass.class_eval do
+      @@methods = {}
+      def self.methods
+        @@methods
+      end
+      def self.set_method k, v
+        @@methods[k] = v
+      end
+    end
+  end
+
+  def method_added name
+    return if methods.include?(name)
+    puts "#{name} added"
+    set_method(name, instance_method(name))
+    class_eval %{
+      def #{name}(*args)
+        self.class.methods[#{name.inspect}].bind(self).call(*args)
+      end
+    }, __FILE__, __LINE__ + 1
+  end
+end
+
+class NotWrapped
+  def add a, b
+    a + b
+  end
+end
+
+class Wrapped
+  extend ::Wrapper
+  def add a, b
+    a + b
+  end
+end
+
+w = Wrapped.new
+nw = NotWrapped.new
+# p w.add(1, 4)
+# exit
+# 30 is the width of the output column
+Benchmark.bm 30 do |x|
+  x.report "wrapped" do
+    100_000.times do |_|
+      w.add(rand(1000), rand(1000))
+    end
+  end
+  x.report "not wrapped" do
+    100_000.times do |_|
+      nw.add(rand(1000), rand(1000))
+    end
+  end
+end

data/lib/contracts-ruby2/contracts.gemspec

@@ -0,0 +1,17 @@
+require File.expand_path(File.join(__FILE__, "../lib/contracts/version"))
+
+Gem::Specification.new do |s|
+  s.name        = "contracts"
+  s.version     = Contracts::VERSION
+  s.summary     = "Contracts for Ruby."
+  s.description = "This library provides contracts for Ruby. Contracts let you clearly express how your code behaves, and free you from writing tons of boilerplate, defensive code."
+  s.author      = "Aditya Bhargava"
+  s.email       = "bluemangroupie@gmail.com"
+  s.files       = `git ls-files`.split("\n")
+  s.homepage    = "https://github.com/egonSchiele/contracts.ruby"
+  s.license     = "BSD-2-Clause"
+  s.post_install_message = "
+    0.16.x will be the supporting Ruby 2.x and be feature frozen (only fixes will be released)
+    For Ruby 3.x use 0.17.x or later (might not be released yet)
+  "
+end

data/lib/contracts-ruby2/cucumber.yml

@@ -0,0 +1 @@
+default: --require features

data/lib/contracts-ruby2/dependabot.yml

@@ -0,0 +1,20 @@
+version: 2
+updates:
+  - package-ecosystem: bundler
+    directory: "/"
+    schedule:
+      interval: monthly
+      time: "06:00"
+      timezone: Asia/Hong_Kong
+    open-pull-requests-limit: 10
+    labels:
+      - "dependencies"
+  - package-ecosystem: github-actions
+    directory: "/"
+    schedule:
+      interval: monthly
+      time: "06:00"
+      timezone: Asia/Hong_Kong
+    open-pull-requests-limit: 10
+    labels:
+      - "dependencies"

data/lib/contracts-ruby2/features/README.md

@@ -0,0 +1,17 @@
+contracts.ruby brings code contracts to the Ruby language.
+
+Example:
+
+```ruby
+class Example
+  include Contracts::Core
+  C = Contracts
+
+  Contract C::Num, C::Num => C::Num
+  def add(a, b)
+    a + b
+  end
+end
+```
+
+This documentation is [open source](https://github.com/egonSchiele/contracts.ruby/tree/master/features). If you find it incomplete or confusing, please [submit an issue](https://github.com/egonSchiele/contracts.ruby/issues), or, better yet, [a pull request](https://github.com/egonSchiele/contracts.ruby).

data/lib/contracts-ruby2/features/basics/functype.feature

@@ -0,0 +1,71 @@
+Feature: Fetching contracted function type
+
+  You can use `functype(name)` method for that:
+
+  ```ruby
+  functype(:add) # => "add :: Num, Num => Num"
+  ```
+
+  Background:
+    Given a file named "example.rb" with:
+    """ruby
+    require "contracts"
+    C = Contracts
+
+    class Example
+      include Contracts::Core
+
+      Contract C::Num, C::Num => C::Num
+      def add(a, b)
+        a + b
+      end
+
+      Contract String => String
+      def self.greeting(name)
+        "Hello, #{name}"
+      end
+
+      class << self
+        Contract C::Num => C::Num
+        def increment(number)
+          number + 1
+        end
+      end
+    end
+    """
+
+  Scenario: functype on instance method
+    Given a file named "instance_method_functype.rb" with:
+    """ruby
+    require "./example"
+    puts Example.new.functype(:add)
+    """
+    When I run `ruby instance_method_functype.rb`
+    Then the output should contain:
+    """
+    add :: Num, Num => Num
+    """
+
+  Scenario: functype on class method
+    Given a file named "class_method_functype.rb" with:
+    """ruby
+    require "./example"
+    puts Example.functype(:greeting)
+    """
+    When I run `ruby class_method_functype.rb`
+    Then the output should contain:
+    """
+    greeting :: String => String
+    """
+
+  Scenario: functype on singleton method
+    Given a file named "singleton_method_functype.rb" with:
+    """ruby
+    require "./example"
+    puts Example.functype(:increment)
+    """
+    When I run `ruby singleton_method_functype.rb`
+    Then the output should contain:
+    """
+    increment :: Num => Num
+    """