rspec-dry-types 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cae481ae202a06c1d6e129a5f62ca6a5ed66aa6f74822b785296118da40374a9
-  data.tar.gz: 4d57d5c70686016b96b67e424fd5734af34ba9ced7a365baf1247b415f417a16
+  metadata.gz: 86fca0bb16df69d550af305359f8232afab4ec61b653a17bad89a39cd4fcae0d
+  data.tar.gz: 5d0833b3da286695adc15326f8158f2d05d7ca905dd3ee478c1d24fc56fac0b5
 SHA512:
-  metadata.gz: c11eb9ae4fd5859428e67ab1e970e8457bf31fd249192245a55016e91f01ee0d32ca07eb48e0effdba5f695cf8f0c67dcb5c14f5b821883c0092123c84e11f5c
-  data.tar.gz: 45fc113c76239eb402ef1fbf3b557404623f3ea77aa5033f88d2b1f149d09a30f2f66cb97d6e7cf24dbf82f9a99a7c1a9b6bd1a9f6421639ef131a6b983841ae
+  metadata.gz: 72e1925c5e6bb7d242eea4a9751e3a0c0bbaeb14074d15fdcaf51c3171d1219c4db85c0df1126b698fac490997d9bee709733b53b64dc727cc2b529023f46514
+  data.tar.gz: 9ec4072143621ca047d8c67c5c918fb53e9f6a598b1381fcb10e73a9aaae58d3563a23fc7397652d1a3fea75ffa6dd52553b13ef1ad10ed5caac2dcc3638639f

data/README.md

@@ -1,78 +1,97 @@
 [![CircleCI](https://circleci.com/gh/patrickclery/rspec-dry-types.svg?style=svg)](https://circleci.com/gh/patrickclery/rspec-dry-types)
 
-# Dry::Types for RSpec
-
-`rspec-dry-types` makes type-checking in Test-Driven Development easier by replacing RSpec's default type checkers with ones that check values using the [dry-types gem](http://dry-rb.org/gems/dry-types/). 
- 
- This:
- 
- ```ruby
-expect(subject).to be_a(String)
-```
+> Speed up test-driven development with looser or stronger type-checking in your RSpec tests
 
-Becomes this:
+[rspec-dry-types](https://github.com/patrickclery/rspec-dry-types) connects RSpec to [dry-types](https://dry-rb.org/gems/dry-types/1.2/built-in-types/) so you have access to extra type-checking helpers.
 
-```ruby
-expect(subject).to be_a(Dry::Types['strict.string'])
-```
- 
-## Usage:
+## Usage
+
+The best way to describe it, is to look at the actual RSpec tests used for this gem:
 
 ```ruby
+require 'rspec'
+require 'rspec/matchers/be_of_type'
+
 RSpec.describe "check types using be_of_type" do
   include RSpec::Matchers::DryTypes
 
-  it 'can use a symbol to expect a dry-type' do
+  it 'can expect a dry-type (by symbol)' do
     expect('a string').to be_of_type(:string)
     expect(123).to be_of_type(:integer)
     expect(0.123).to be_of_type(:float)
-    expect("123").to be_of_type(:integer, strict: false)
-    expect(nil).to be_of_type(:string, strict: false)
     expect(nil).to be_of_type(:nil)
+    expect({}).to be_of_type(:hash)
+    expect([]).to be_of_type(:array)
+    expect(true).to be_of_type(:bool)
+    expect(false).to be_of_type(:bool)
+    expect(Date.new(2001, 2, 3)).to be_of_type(:date)
+    expect(Time.new(2001, 2, 3, 4, 5, 6)).to be_of_type(:time)
+    expect(DateTime.new(2001, 2, 3, 4, 5, 6)).to be_of_type(:date_time)
+    expect(:abc).to be_of_type(:symbol)
+  end
+
+  it 'can expect any type' do
+    # Any type
+    expect('a string').to be_of_type(:any)
+    expect(123).to be_of_type(:any)
+    expect(0.123).to be_of_type(:any)
+    expect(nil).to be_of_type(:any)
+    expect({}).to be_of_type(:any)
+    expect([]).to be_of_type(:any)
+    expect(true).to be_of_type(:any)
+    expect(false).to be_of_type(:any)
+    expect(Date.new(2001, 2, 3)).to be_of_type(:any)
+    expect(Time.new(2001, 2, 3, 4, 5, 6)).to be_of_type(:any)
+    expect(DateTime.new(2001, 2, 3, 4, 5, 6)).to be_of_type(:any)
+    expect(:abc).to be_of_type(:any)
+    expect(0.1).to be_of_type(:any)
+  end
+
+  it 'can expect a value to be coercible into a type' do
+    # actual.to_s
+    expect(nil).to be_of_type(:string, strict: false)
+    expect(123).to be_of_type(:string, strict: false) # 123.to_s == "123"
+    expect(123).to be_of_type("coercible.string")
+
+    # actual.to_i
+    expect("123").to be_of_type(:integer, strict: false)
+    expect(0.123).not_to be_of_type(:integer)
+    expect(0.123).to be_of_type(:integer, strict: false)
   end
 
   # Strings must reference the dry-types docs
-  it 'can use string to expect a dry-type' do
-    expect('a string').to be_of_type('string')
+  it 'can expect a dry-type (by string)' do
+    expect('a string').to be_of_type('strict.string')
+    expect("123").to be_of_type('coercible.integer')
     expect('a string').to be_of_type('strict.string')
-    expect(123).to be_of_type('integer')
     expect(123).to be_of_type('strict.integer')
-    expect(0.123).to be_of_type('float')
-    expect(0.123).to be_of_type('coercible.integer')
+    expect(0.123).to be_of_type('strict.float')
+    expect(nil).to be_of_type('strict.nil')
+    expect({}).to be_of_type('strict.hash')
+    expect([]).to be_of_type('strict.array')
+    expect(true).to be_of_type('strict.bool')
+    expect(false).to be_of_type('strict.bool')
+    expect(Date.new(2001, 2, 3)).to be_of_type('strict.date')
+    expect(Time.new(2001, 2, 3, 4, 5, 6)).to be_of_type('strict.time')
+    expect(DateTime.new(2001, 2, 3, 4, 5, 6)).to be_of_type('strict.date_time')
+    expect(:abc).to be_of_type('strict.symbol')
+
+    # with an optional flag
+    expect(123).to be_of_type('integer', strict: true)
     expect("123").to be_of_type('integer', strict: false)
-    expect(nil).to be_of_type('string', strict: false)
-    expect(nil).to be_of_type('nil')
-  end
-
-  # Strings must reference the dry-types docs
-  it 'is backwards compat with be_a' do
-    expect('a string').to be_a(String)
-    expect('a string').to be_a_kind_of('strict.string')
-    expect(123).to be_an(Integer)
-    expect(123).to be_an('integer')
   end
 
-  it 'can use a class to check if its a type' do
-    # Check inheritance
+  # Note: there is no 'object' type for `dry-types`
+  it 'can expect class inheritance of a type' do
+    # String/Integer inherit from Object
     expect(String).to be_of_type(Object)
-    expect('a string').to be_of_type(Object)
-
-    # Check coercion
-    expect(123).to be_of_type(String, strict: false)
-    expect(0.123).not_to be_of_type(Integer)
-    expect(0.123).to be_of_type(Integer, strict: false)
-
-    expect(123).to be_of_type(Object)
     expect(123).to be_of_type(Object)
+    expect('a string').to be_of_type(Object)
   end
 
 end
 ```
 
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rspec-dry-types. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
-
-## Code of Conduct
+> For a full list of types, checkout the [dry-types documentation](https://dry-rb.org/gems/dry-types/1.2/built-in-types/)
 
-Everyone interacting in the Rspec::Dry::Types project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/rspec-dry-types/blob/master/CODE_OF_CONDUCT.md).
+If this project helps you, 

data/lib/rspec/dry/types/version.rb

@@ -1,7 +1,7 @@
 module Rspec
   module Dry
     module Types
-      VERSION = "0.1.2"
+      VERSION = "0.1.3"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rspec-dry-types
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - patrickclery
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-11 00:00:00.000000000 Z
+date: 2019-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler