contracts 0.15.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5f95ed9c9dca3e23e9feb707360335388730304e
-  data.tar.gz: 634613562833a5f69e2171163eb71e64314ae252
+  metadata.gz: d2050dfd5418498598d0f857e3fe285daa65908c
+  data.tar.gz: 9d5ae5ad04a508233be8ec25b2fb657f2a2b713e
 SHA512:
-  metadata.gz: 3e9393b9202596fbd5df5a53c1e4fd963ed9f5d881277f7705415fce911cba40c47ad0cf6ce993b1f94670fb8e5c7ab4ff9bcff9c20990826600969b686f7cce
-  data.tar.gz: 30bddf252a1e2da5a53223189bae378e834087ba3e1813c5acb8ad96bd62f75878d9bcf1afd4e861d87c63d1195af26ca1f9d89248b7089a54913090b52d1449
+  metadata.gz: 714992e52ce0d9bdc52c1a0d0ee0c89b0541559e924d2e63e902f73d253c09343f37e8bec1c082ba5bdae76cf146835f09e252f273a617fd5235108b3d2b9f49
+  data.tar.gz: 50518932f7576ddb8a092fa42267321b4502b87a45f96255d2673197075dbdaf9008b3096ce0753cfe57a39a0055c14326dfddeae81ef4ce4243157e55dadd08

data/CHANGELOG.markdown

@@ -1,3 +1,9 @@
+## v0.16.0
+
+- **Support for Ruby 1.8 has been discontinued** - [Corey Farwell](https://github.com/frewsxcv) [#256](https://github.com/egonSchiele/contracts.ruby/pull/256)
+- Enhancement: Add a `Contracts::Attrs` module containing attribute w/ contracts utilities - [Corey Farwell](https://github.com/frewsxcv) [#255](https://github.com/egonSchiele/contracts.ruby/pull/255)
+- Bugfix: Fix StrictHash contract for extra keys - [Maciej Malecki](https://github.com/smt116) [#254](https://github.com/egonSchiele/contracts.ruby/pull/254)
+
 ## v0.15.0
 - Bugfix: Func contract's return value isn't enforced with blocks - [Piotr Szmielew](https://github.com/esse) [#251](https://github.com/egonSchiele/contracts.ruby/pull/251)
 - Bugfx: Fix contracts used in AR-models - [Gert Goet](https://github.com/eval) [#237](https://github.com/egonSchiele/contracts.ruby/pull/237)

data/README.md

@@ -81,7 +81,7 @@ Using contracts.ruby results in very little slowdown. Check out [this blog post]
 
 **Q.** What Rubies can I use this with?
 
-**A.** It's been tested with `1.8.7`, `1.9.2`, `1.9.3`, `2.0.0`, `2.1`, `2.2`, and `jruby` (both 1.8 and 1.9 modes).
+**A.** It's been tested with `1.9.2`, `1.9.3`, `2.0.0`, `2.1`, `2.2`, and `jruby` (1.9 mode).
 
 If you're using the library, please [let me know](https://github.com/egonSchiele) what project you're using it on :)
 
@@ -97,7 +97,7 @@ Michael Tomer
 
 ## Credits
 
-Inspired by [contracts.coffee](http://disnetdev.com/contracts.coffee/).
+Inspired by [contracts.coffee](http://disnet.github.io/contracts.coffee/).
 
 Copyright 2012-2015 [Aditya Bhargava](http://adit.io).
 Major improvements by [Alexey Fedorov](https://github.com/waterlink).

data/Rakefile

@@ -7,5 +7,9 @@ else
   task :default => [:spec]
 end
 
+task :add_tag do
+  `git tag -a v#{Contracts::VERSION} -m 'v#{Contracts::VERSION}'`
+end
+
 require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new(:spec)

data/TUTORIAL.md

@@ -606,6 +606,32 @@ Possible validator overrides:
 
 Default validators can be found here: [lib/contracts/validators.rb](https://github.com/egonSchiele/contracts.ruby/blob/master/lib/contracts/validators.rb).
 
+## Contracts with attributes
+
+You can include the `Contracts::Attrs` module in your class/module to get access to attribute utilities:
+
+- `attr_reader_with_contract <symbol>..., <contract>`
+  - Wraps `attr_reader`, validates contract upon 'getting'
+- `attr_writer_with_contract <symbol>..., <contract>`
+  - Wraps `attr_writer`, validates contract upon 'setting'
+- `attr_accessor_with_contract <symbol>..., <contract>`
+  - Wraps `attr_accessor`, validates contract upon 'getting' or 'setting'
+
+### Example
+
+```ruby
+class Person
+  include Contracts::Core
+  include Contracts::Attrs
+
+  attr_accessor_with_contract :name, String
+end
+
+person = Person.new
+person.name = 'Jane'
+person.name = 1.4 # This results in a contract error!
+```
+
 ## Disabling contracts
 
 If you want to disable contracts, set the `NO_CONTRACTS` environment variable. This will disable contracts and you won't have a performance hit. Pattern matching will still work if you disable contracts in this way! With NO_CONTRACTS only pattern-matching contracts are defined.

data/lib/contracts.rb

@@ -1,3 +1,4 @@
+require "contracts/attrs"
 require "contracts/builtin_contracts"
 require "contracts/decorators"
 require "contracts/errors"

data/lib/contracts/attrs.rb

@@ -0,0 +1,20 @@
+module Contracts
+  module Attrs
+    def attr_reader_with_contract(*names, contract)
+      Contract Contracts::None => contract
+      attr_reader(*names)
+    end
+
+    def attr_writer_with_contract(*names, contract)
+      Contract contract => contract
+      attr_writer(*names)
+    end
+
+    def attr_accessor_with_contract(*names, contract)
+      attr_reader_with_contract(*names, contract)
+      attr_writer_with_contract(*names, contract)
+    end
+  end
+
+  include Attrs
+end

data/lib/contracts/builtin_contracts.rb

@@ -405,9 +405,10 @@ module Contracts
 
       def valid?(arg)
         return false unless arg.is_a?(Hash)
+        return false unless arg.keys.sort.eql?(contract_hash.keys.sort)
 
-        contract_hash.all? do |key, _v|
-          contract_hash.key?(key) && Contract.valid?(arg[key], contract_hash[key])
+        contract_hash.all? do |key, contract|
+          contract_hash.key?(key) && Contract.valid?(arg[key], contract)
         end
       end
     end

data/lib/contracts/support.rb

@@ -4,14 +4,10 @@ module Contracts
       def method_position(method)
         return method.method_position if method.is_a?(MethodReference)
 
-        if RUBY_VERSION =~ /^1\.8/
-          if method.respond_to?(:__file__)
-            method.__file__ + ":" + method.__line__.to_s
-          else
-            method.inspect
-          end
+        file, line = method.source_location
+        if file.nil? || line.nil?
+          ""
         else
-          file, line = method.source_location
           file + ":" + line.to_s
         end
       end
@@ -34,8 +30,7 @@ module Contracts
       end
 
       def eigenclass_hierarchy_supported?
-        return false if RUBY_PLATFORM == "java" && RUBY_VERSION.to_f < 2.0
-        RUBY_VERSION.to_f > 1.8
+        RUBY_PLATFORM != "java" || RUBY_VERSION.to_f >= 2.0
       end
 
       def eigenclass_of(target)

data/lib/contracts/version.rb

@@ -1,3 +1,3 @@
 module Contracts
-  VERSION = "0.15.0"
+  VERSION = "0.16.0"
 end

data/spec/attrs_spec.rb

@@ -0,0 +1,75 @@
+RSpec.describe "Contracts:" do
+  describe "Attrs:" do
+    class Person
+      include Contracts::Core
+      include Contracts::Attrs
+      include Contracts::Builtin
+
+      def initialize(name)
+        @name_r = name
+        @name_w = name
+        @name_rw = name
+      end
+
+      attr_reader_with_contract :name_r, String
+      attr_writer_with_contract :name_w, String
+      attr_accessor_with_contract :name_rw, String
+    end
+
+    context "attr_reader_with_contract" do
+      it "getting valid type" do
+        expect(Person.new("bob").name_r)
+          .to(eq("bob"))
+      end
+
+      it "getting invalid type" do
+        expect { Person.new(1.3).name_r }
+          .to(raise_error(ReturnContractError))
+      end
+
+      it "setting" do
+        expect { Person.new("bob").name_r = "alice" }
+          .to(raise_error(NoMethodError))
+      end
+    end
+
+    context "attr_writer_with_contract" do
+      it "getting" do
+        expect { Person.new("bob").name_w }
+          .to(raise_error(NoMethodError))
+      end
+
+      it "setting valid type" do
+        expect(Person.new("bob").name_w = "alice")
+          .to(eq("alice"))
+      end
+
+      it "setting invalid type" do
+        expect { Person.new("bob").name_w = 1.2 }
+          .to(raise_error(ParamContractError))
+      end
+    end
+
+    context "attr_accessor_with_contract" do
+      it "getting valid type" do
+        expect(Person.new("bob").name_rw)
+          .to(eq("bob"))
+      end
+
+      it "getting invalid type" do
+        expect { Person.new(1.2).name_rw }
+          .to(raise_error(ReturnContractError))
+      end
+
+      it "setting valid type" do
+        expect(Person.new("bob").name_rw = "alice")
+          .to(eq("alice"))
+      end
+
+      it "setting invalid type" do
+        expect { Person.new("bob").name_rw = 1.2 }
+          .to(raise_error(ParamContractError))
+      end
+    end
+  end
+end

data/spec/builtin_contracts_spec.rb

@@ -448,7 +448,7 @@ RSpec.describe "Contracts:" do
 
     context "when given an input with extra keys" do
       it "raises an error" do
-        fails { @o.strict_person(:name => "calvin", :age => "10", :soft => true) }
+        fails { @o.strict_person(:name => "calvin", :age => 10, :soft => true) }
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: contracts
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.16.0
 platform: ruby
 authors:
 - Aditya Bhargava
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-02-24 00:00:00.000000000 Z
+date: 2017-04-24 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
@@ -68,6 +68,7 @@ files:
 - features/builtin_contracts/xor.feature
 - features/support/env.rb
 - lib/contracts.rb
+- lib/contracts/attrs.rb
 - lib/contracts/builtin_contracts.rb
 - lib/contracts/call_with.rb
 - lib/contracts/core.rb
@@ -88,6 +89,7 @@ files:
 - script/docs-release
 - script/docs-staging
 - script/rubocop.rb
+- spec/attrs_spec.rb
 - spec/builtin_contracts_spec.rb
 - spec/contracts_spec.rb
 - spec/fixtures/fixtures.rb