contracts-lite 0.14.0 → 0.15.0

data/spec/error_formatter_spec.rb

@@ -2,7 +2,6 @@ RSpec.describe "Contracts::ErrorFormatters" do
   before :all do
     @o = GenericExample.new
   end
-  C = Contracts::Builtin
 
   describe "self.class_for" do
     let(:keywordargs_contract) { C::KeywordArgs[:name => String, :age => Fixnum] }

data/spec/fixtures/fixtures.rb

@@ -161,20 +161,20 @@ class GenericExample
     block.call
   end
 
-  Contract C::Args[C::Num], C::Maybe[Proc] => C::Any
+  Contract C::SplatArgs[C::Num], C::Maybe[Proc] => C::Any
   def maybe_call(*vals, &block)
     block.call if block
     vals
   end
 
-  Contract C::Args[C::Num] => C::Num
+  Contract C::SplatArgs[C::Num] => C::Num
   def sum(*vals)
     vals.inject(0) do |acc, val|
       acc + val
     end
   end
 
-  Contract C::Args[C::Num], Proc => C::Num
+  Contract C::SplatArgs[C::Num], Proc => C::Num
   def with_partial_sums(*vals, &blk)
     sum = vals.inject(0) do |acc, val|
       blk[acc]
@@ -183,7 +183,7 @@ class GenericExample
     blk[sum]
   end
 
-  Contract C::Args[C::Num], C::Func[C::Num => C::Num] => C::Num
+  Contract C::SplatArgs[C::Num], C::Func[C::Num => C::Num] => C::Num
   def with_partial_sums_contracted(*vals, &blk)
     sum = vals.inject(0) do |acc, val|
       blk[acc]
@@ -193,7 +193,7 @@ class GenericExample
   end
 
   # Important to use different arg types or it falsely passes
-  Contract C::Num, C::Args[String] => C::ArrayOf[String]
+  Contract C::Num, C::SplatArgs[String] => C::ArrayOf[String]
   def arg_then_splat(n, *vals)
     vals.map { |v| v * n }
   end

data/spec/ruby_version_specific/contracts_spec_1.9.rb

@@ -1,5 +1,5 @@
 class GenericExample
-  Contract C::Args[String], C::Num => C::ArrayOf[String]
+  Contract C::SplatArgs[String], C::Num => C::ArrayOf[String]
   def splat_then_arg(*vals, n)
     vals.map { |v| v * n }
   end
@@ -21,4 +21,20 @@ RSpec.describe "Contracts:" do
       expect { @o.splat_then_arg("hello", "world", 3) }.to_not raise_error
     end
   end
+
+
+  context "Contracts::Args" do
+    it "should print deprecation warning when used" do
+      expect{
+        klass = Class.new do
+          include Contracts::Core
+
+          Contract C::Num, C::Args[String] => C::ArrayOf[String]
+          def arg_then_splat(n, *vals)
+            vals.map { |v| v * n }
+          end
+        end
+      }.to output(Regexp.new("DEPRECATION WARNING")).to_stdout
+    end
+  end
 end

data/spec/ruby_version_specific/contracts_spec_2.0.rb

@@ -1,5 +1,5 @@
 class GenericExample
-  Contract C::Args[String], { repeat: C::Maybe[C::Num] } => C::ArrayOf[String]
+  Contract C::SplatArgs[String], { repeat: C::Maybe[C::Num] } => C::ArrayOf[String]
   def splat_then_optional_named(*vals, repeat: 2)
     vals.map { |v| v * repeat }
   end

data/spec/ruby_version_specific/contracts_spec_2.1.rb

@@ -1,5 +1,5 @@
 class GenericExample
-  Contract String, C::Bool, C::Args[Symbol], Float, C::KeywordArgs[e: Range, f: C::Optional[C::Num], g: Symbol], Proc =>
+  Contract String, C::Bool, C::SplatArgs[Symbol], Float, C::KeywordArgs[e: Range, f: C::Optional[C::Num], g: Symbol], Proc =>
            [Proc, Hash, C::Maybe[C::Num], Range, Float, C::ArrayOf[Symbol], C::Bool, String]
   def complicated(a, b = true, *c, d, e:, f:2, **g, &h)
     h.call [h, g, f, e, d, c, b, a]

data/spec/spec_helper.rb

@@ -1,86 +1,35 @@
+if RUBY_VERSION.to_f > 2.0
+  require "byebug"
+end
+
+require 'simplecov'
+SimpleCov.start do
+  add_filter "/spec/"
+  add_filter "/.direnv/"
+end
+if ENV['CI']=='true'
+  require 'codecov'
+  SimpleCov.formatter = SimpleCov::Formatter::Codecov
+end
+
 require "contracts"
 require File.expand_path(File.join(__FILE__, "../support"))
 require File.expand_path(File.join(__FILE__, "../fixtures/fixtures"))
 
-# This file was generated by the `rspec --init` command. Conventionally, all
-# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
-# The generated `.rspec` file contains `--require spec_helper` which will cause this
-# file to always be loaded, without a need to explicitly require it in any files.
-#
-# Given that it is always loaded, you are encouraged to keep this file as
-# light-weight as possible. Requiring heavyweight dependencies from this file
-# will add to the boot time of your test suite on EVERY test run, even for an
-# individual file that may not need all of that loaded. Instead, consider making
-# a separate helper file that requires the additional dependencies and performs
-# the additional setup, and require it from the spec files that actually need it.
-#
-# The `.rspec` file also contains a few flags that are not defaults but that
-# users commonly want.
-#
-# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|
   config.pattern = "*.rb"
 
-  # Only load tests who's syntax is valid in the current Ruby
+  # Only load tests with valid syntax in the current Ruby
   [1.9, 2.0, 2.1].each do |ver|
     config.pattern << ",ruby_version_specific/*#{ver}.rb" if ruby_version >= ver
   end
 
-  # rspec-expectations config goes here. You can use an alternate
-  # assertion/expectation library such as wrong or the stdlib/minitest
-  # assertions if you prefer.
   config.expect_with :rspec do |expectations|
-    # This option will default to `true` in RSpec 4. It makes the `description`
-    # and `failure_message` of custom matchers include text for helper methods
-    # defined using `chain`, e.g.:
-    # be_bigger_than(2).and_smaller_than(4).description
-    #   # => "be bigger than 2 and smaller than 4"
-    # ...rather than:
-    #   # => "be bigger than 2"
     expectations.include_chain_clauses_in_custom_matcher_descriptions = true
   end
 
-  # rspec-mocks config goes here. You can use an alternate test double
-  # library (such as bogus or mocha) by changing the `mock_with` option here.
-  config.mock_with :rspec do |mocks|
-    # Prevents you from mocking or stubbing a method that does not exist on
-    # a real object. This is generally recommended, and will default to
-    # `true` in RSpec 4.
-    mocks.verify_partial_doubles = true
-  end
-
-  # These two settings work together to allow you to limit a spec run
-  # to individual examples or groups you care about by tagging them with
-  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
-  # get run.
-  config.filter_run :focus
-  config.run_all_when_everything_filtered = true
-
-  # Limits the available syntax to the non-monkey patched syntax that is recommended.
-  # For more details, see:
-  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
-  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
-  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
-  config.disable_monkey_patching!
-
-  # This setting enables warnings. It's recommended, but in some cases may
-  # be too noisy due to issues in dependencies.
-  # config.warnings = true
-
-  # Many RSpec users commonly either run the entire suite or an individual
-  # file, and it's useful to allow more verbose output when running an
-  # individual spec file.
-  if config.files_to_run.one?
-    # Use the documentation formatter for detailed output,
-    # unless a formatter has already been configured
-    # (e.g. via a command-line flag).
-    config.default_formatter = "doc"
-  end
-
-  # Print the 10 slowest examples and example groups at the
-  # end of the spec run, to help surface which specs are running
-  # particularly slow.
-  config.profile_examples = 10
+  # # Print the 10 slowest examples and example groups
+  # config.profile_examples = 10
 
   # Run specs in random order to surface order dependencies. If you find an
   # order dependency and want to debug it, you can fix the order by providing

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: contracts-lite
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.15.0
 platform: ruby
 authors:
-- Aditya Bhargava
+- Aditya Bhargava, Ruslan Gatyatov, Roman Heinrich
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-22 00:00:00.000000000 Z
+date: 2017-01-09 00:00:00.000000000 Z
 dependencies: []
 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
@@ -18,6 +18,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
@@ -26,17 +27,25 @@ files:
 - Gemfile
 - LICENSE
 - README.md
-- TODO.markdown
+- Rakefile
 - TUTORIAL.md
 - benchmarks/bench.rb
 - benchmarks/hash.rb
 - benchmarks/invariants.rb
 - benchmarks/io.rb
 - benchmarks/wrap_test.rb
+- bin/console
+- bin/rubocop
 - contracts.gemspec
+- docs/_config.yml
+- docs/index.md
 - lib/contracts.rb
+- lib/contracts/args_validator.rb
 - lib/contracts/builtin_contracts.rb
-- lib/contracts/call_with.rb
+- lib/contracts/contract.rb
+- lib/contracts/contract/call_with.rb
+- lib/contracts/contract/failure_callback.rb
+- lib/contracts/contract/validators.rb
 - lib/contracts/core.rb
 - lib/contracts/decorators.rb
 - lib/contracts/engine.rb
@@ -50,9 +59,7 @@ files:
 - lib/contracts/method_handler.rb
 - lib/contracts/method_reference.rb
 - lib/contracts/support.rb
-- lib/contracts/validators.rb
 - lib/contracts/version.rb
-- script/rubocop
 - spec/builtin_contracts_spec.rb
 - spec/contracts_spec.rb
 - spec/error_formatter_spec.rb
@@ -87,7 +94,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Contracts for Ruby. (fork)

data/TODO.markdown

@@ -1,6 +0,0 @@
-- maybe make some screencasts
-
-- you can now do something like Haskell's quickcheck. Every contract has a method 'test_data' or something. You can use that data to automatically check methods with contracts to make sure they are correct.
-  - http://www.cse.chalmers.se/~rjmh/QuickCheck/manual.html
-  - for stuff like the Not contract, should I make a standard set of classes to check those functions with? Would that be useful at all?
-  - also write specs for this stuff

data/lib/contracts/call_with.rb

@@ -1,97 +0,0 @@
-module Contracts
-  module CallWith
-    def call_with(this, *args, &blk)
-      args << blk if blk
-
-      # Explicitly append blk=nil if nil != Proc contract violation anticipated
-      nil_block_appended = maybe_append_block!(args, blk)
-
-      # Explicitly append options={} if Hash contract is present
-      maybe_append_options!(args, blk)
-
-      # Loop forward validating the arguments up to the splat (if there is one)
-      (@args_contract_index || args.size).times do |i|
-        contract = args_contracts[i]
-        arg = args[i]
-        validator = @args_validators[i]
-
-        unless validator && validator[arg]
-          return unless Contract.failure_callback(:arg => arg,
-                                                  :contract => contract,
-                                                  :class => klass,
-                                                  :method => method,
-                                                  :contracts => self,
-                                                  :arg_pos => i+1,
-                                                  :total_args => args.size,
-                                                  :return_value => false)
-        end
-
-        if contract.is_a?(Contracts::Func)
-          args[i] = Contract.new(klass, arg, *contract.contracts)
-        end
-      end
-
-      # If there is a splat loop backwards to the lower index of the splat
-      # Once we hit the splat in this direction set its upper index
-      # Keep validating but use this upper index to get the splat validator.
-      if @args_contract_index
-        splat_upper_index = @args_contract_index
-        (args.size - @args_contract_index).times do |i|
-          arg = args[args.size - 1 - i]
-
-          if args_contracts[args_contracts.size - 1 - i].is_a?(Contracts::Args)
-            splat_upper_index = i
-          end
-
-          # Each arg after the spat is found must use the splat validator
-          j = i < splat_upper_index ? i : splat_upper_index
-          contract = args_contracts[args_contracts.size - 1 - j]
-          validator = @args_validators[args_contracts.size - 1 - j]
-
-          unless validator && validator[arg]
-            return unless Contract.failure_callback(:arg => arg,
-                                                    :contract => contract,
-                                                    :class => klass,
-                                                    :method => method,
-                                                    :contracts => self,
-                                                    :arg_pos => i-1,
-                                                    :total_args => args.size,
-                                                    :return_value => false)
-          end
-
-          if contract.is_a?(Contracts::Func)
-            args[args.size - 1 - i] = Contract.new(klass, arg, *contract.contracts)
-          end
-        end
-      end
-
-      # If we put the block into args for validating, restore the args
-      # OR if we added a fake nil at the end because a block wasn't passed in.
-      args.slice!(-1) if blk || nil_block_appended
-      result = if method.respond_to?(:call)
-                 # proc, block, lambda, etc
-                 method.call(*args, &blk)
-               else
-                 # original method name referrence
-                 method.send_to(this, *args, &blk)
-               end
-
-      unless @ret_validator[result]
-        Contract.failure_callback(:arg => result,
-                                  :contract => ret_contract,
-                                  :class => klass,
-                                  :method => method,
-                                  :contracts => self,
-                                  :return_value => true)
-      end
-
-      this.verify_invariants!(method) if this.respond_to?(:verify_invariants!)
-
-      if ret_contract.is_a?(Contracts::Func)
-        result = Contract.new(klass, result, *ret_contract.contracts)
-      end
-
-      result
-    end
-  end
-end