expects 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/.gitignore +17 -0
- data/Gemfile +4 -0
- data/LICENSE.txt +22 -0
- data/README.md +39 -0
- data/Rakefile +1 -0
- data/expects.gemspec +23 -0
- data/lib/expects.rb +13 -0
- data/lib/expects/error.rb +15 -0
- data/lib/expects/version.rb +3 -0
- data/spec/expects_error_spec.rb +37 -0
- data/spec/expects_spec.rb +39 -0
- data/spec/spec_helper.rb +1 -0
- metadata +88 -0
checksums.yaml
ADDED
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
---
|
|
2
|
+
SHA1:
|
|
3
|
+
metadata.gz: b70f9a3cc6b4a1f40da2d606c1b8b2ccc22c3f0c
|
|
4
|
+
data.tar.gz: 91118b1e631cdda1be9e8c7c0c98dc17f58dadc1
|
|
5
|
+
SHA512:
|
|
6
|
+
metadata.gz: c37b6a3a73079fdf23cc6cea703a9bc01241652e1be1cd81bcd4612c81a0a199b3a39e90dafffcf6f4bb2b1b79d6d9a0c11a71825642899b792da7c248198687
|
|
7
|
+
data.tar.gz: f3f3c461634ecc8f0752dcb47e149236e6570488b2fe22492225a0dbce6280c9c0412378872c376a67ff80fbf01f05c220fbc8e74fbc85adc5d60643f576edb5
|
data/.gitignore
ADDED
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
Copyright (c) 2013 Adam Laycock
|
|
2
|
+
|
|
3
|
+
MIT License
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
|
6
|
+
a copy of this software and associated documentation files (the
|
|
7
|
+
"Software"), to deal in the Software without restriction, including
|
|
8
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
|
9
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
|
10
|
+
permit persons to whom the Software is furnished to do so, subject to
|
|
11
|
+
the following conditions:
|
|
12
|
+
|
|
13
|
+
The above copyright notice and this permission notice shall be
|
|
14
|
+
included in all copies or substantial portions of the Software.
|
|
15
|
+
|
|
16
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
17
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
18
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|
19
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
|
20
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
|
21
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
|
22
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
ADDED
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
# Expects
|
|
2
|
+
|
|
3
|
+
A DSL for defining input expectations for methods
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
Add this line to your application's Gemfile:
|
|
8
|
+
|
|
9
|
+
gem 'expects'
|
|
10
|
+
|
|
11
|
+
And then execute:
|
|
12
|
+
|
|
13
|
+
$ bundle
|
|
14
|
+
|
|
15
|
+
Or install it yourself as:
|
|
16
|
+
|
|
17
|
+
$ gem install expects
|
|
18
|
+
|
|
19
|
+
## Usage
|
|
20
|
+
|
|
21
|
+
Include `Expects` in your class and then call it in your methods eg:
|
|
22
|
+
|
|
23
|
+
```ruby
|
|
24
|
+
class YourClass
|
|
25
|
+
include Expects
|
|
26
|
+
|
|
27
|
+
def initialize(name)
|
|
28
|
+
expects name, String
|
|
29
|
+
end
|
|
30
|
+
end
|
|
31
|
+
```
|
|
32
|
+
|
|
33
|
+
## Contributing
|
|
34
|
+
|
|
35
|
+
1. Fork it
|
|
36
|
+
2. Create your feature branch (`git checkout -b my-new-feature`)
|
|
37
|
+
3. Commit your changes (`git commit -am 'Add some feature'`)
|
|
38
|
+
4. Push to the branch (`git push origin my-new-feature`)
|
|
39
|
+
5. Create new Pull Request
|
data/Rakefile
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
require "bundler/gem_tasks"
|
data/expects.gemspec
ADDED
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# coding: utf-8
|
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
|
4
|
+
require 'expects/version'
|
|
5
|
+
|
|
6
|
+
Gem::Specification.new do |spec|
|
|
7
|
+
spec.name = "expects"
|
|
8
|
+
spec.version = Expects::VERSION
|
|
9
|
+
spec.authors = ["Adam Laycock"]
|
|
10
|
+
spec.email = ["adam@arcath.net"]
|
|
11
|
+
spec.description = %q{A DSL for method inpu expectations}
|
|
12
|
+
spec.summary = spec.description
|
|
13
|
+
spec.homepage = ""
|
|
14
|
+
spec.license = "MIT"
|
|
15
|
+
|
|
16
|
+
spec.files = `git ls-files`.split($/)
|
|
17
|
+
spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
|
|
18
|
+
spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
|
|
19
|
+
spec.require_paths = ["lib"]
|
|
20
|
+
|
|
21
|
+
spec.add_development_dependency "bundler", "~> 1.3"
|
|
22
|
+
spec.add_development_dependency "rspec"
|
|
23
|
+
end
|
data/lib/expects.rb
ADDED
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# Version Number
|
|
2
|
+
require 'expects/version'
|
|
3
|
+
# Error
|
|
4
|
+
require 'expects/error'
|
|
5
|
+
|
|
6
|
+
module Expects
|
|
7
|
+
def expects(subject, objects)
|
|
8
|
+
objects = [objects] unless objects.is_a? Array
|
|
9
|
+
raise UnexpectedInput.new(subject, objects) unless objects.include? subject.class
|
|
10
|
+
end
|
|
11
|
+
|
|
12
|
+
private :expects
|
|
13
|
+
end
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
class UnexpectedInput < StandardError
|
|
2
|
+
attr_reader :subject, :expected
|
|
3
|
+
|
|
4
|
+
def initialize(subject = nil, expected = nil)
|
|
5
|
+
@subject, @expected = subject, expected
|
|
6
|
+
end
|
|
7
|
+
|
|
8
|
+
def message
|
|
9
|
+
@message ||= build_message
|
|
10
|
+
end
|
|
11
|
+
|
|
12
|
+
def build_message
|
|
13
|
+
"Expected #{@subject.inspect} to be #{expected.join(", ")}"
|
|
14
|
+
end
|
|
15
|
+
end
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
require 'spec_helper'
|
|
2
|
+
|
|
3
|
+
describe UnexpectedInput do
|
|
4
|
+
let(:error) do
|
|
5
|
+
UnexpectedInput.new(1234, [String])
|
|
6
|
+
end
|
|
7
|
+
|
|
8
|
+
let(:test_class) do
|
|
9
|
+
Class.new do
|
|
10
|
+
include Expects
|
|
11
|
+
|
|
12
|
+
def initialize(message)
|
|
13
|
+
expects message, String
|
|
14
|
+
end
|
|
15
|
+
end
|
|
16
|
+
end
|
|
17
|
+
|
|
18
|
+
it "should take a few options" do
|
|
19
|
+
begin
|
|
20
|
+
raise error
|
|
21
|
+
rescue UnexpectedInput => e
|
|
22
|
+
e.message.should eq "Expected 1234 to be String"
|
|
23
|
+
e.subject.should eq 1234
|
|
24
|
+
e.expected.should eq [String]
|
|
25
|
+
end
|
|
26
|
+
end
|
|
27
|
+
|
|
28
|
+
it "should throw the error correctly" do
|
|
29
|
+
begin
|
|
30
|
+
test_class.new(1234)
|
|
31
|
+
rescue UnexpectedInput => e
|
|
32
|
+
e.message.should eq error.message
|
|
33
|
+
e.subject.should eq error.subject
|
|
34
|
+
e.expected.should eq error.expected
|
|
35
|
+
end
|
|
36
|
+
end
|
|
37
|
+
end
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
require 'spec_helper'
|
|
2
|
+
|
|
3
|
+
describe Expects do
|
|
4
|
+
let(:test_class) do
|
|
5
|
+
Class.new do
|
|
6
|
+
include Expects
|
|
7
|
+
|
|
8
|
+
def initialize(message)
|
|
9
|
+
expects message, String
|
|
10
|
+
end
|
|
11
|
+
|
|
12
|
+
def a_method
|
|
13
|
+
true
|
|
14
|
+
end
|
|
15
|
+
end
|
|
16
|
+
end
|
|
17
|
+
|
|
18
|
+
let(:array_class) do
|
|
19
|
+
Class.new(test_class) do
|
|
20
|
+
def initialize(message)
|
|
21
|
+
expects message, [String, Fixnum]
|
|
22
|
+
end
|
|
23
|
+
end
|
|
24
|
+
end
|
|
25
|
+
|
|
26
|
+
it "should include itself in any object" do
|
|
27
|
+
lambda { test_class.new("Foo") }.should_not raise_exception
|
|
28
|
+
end
|
|
29
|
+
|
|
30
|
+
it "should stop you providing anything but an String" do
|
|
31
|
+
lambda { test_class.new(1234) }.should raise_exception
|
|
32
|
+
end
|
|
33
|
+
|
|
34
|
+
it "should take an array" do
|
|
35
|
+
lambda { array_class.new(1234) }.should_not raise_exception
|
|
36
|
+
lambda { array_class.new(["foo"]) }.should raise_exception
|
|
37
|
+
array_class.new("This").a_method.should be_true
|
|
38
|
+
end
|
|
39
|
+
end
|
data/spec/spec_helper.rb
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
require 'expects'
|
metadata
ADDED
|
@@ -0,0 +1,88 @@
|
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
|
2
|
+
name: expects
|
|
3
|
+
version: !ruby/object:Gem::Version
|
|
4
|
+
version: 0.0.1
|
|
5
|
+
platform: ruby
|
|
6
|
+
authors:
|
|
7
|
+
- Adam Laycock
|
|
8
|
+
autorequire:
|
|
9
|
+
bindir: bin
|
|
10
|
+
cert_chain: []
|
|
11
|
+
date: 2013-07-17 00:00:00.000000000 Z
|
|
12
|
+
dependencies:
|
|
13
|
+
- !ruby/object:Gem::Dependency
|
|
14
|
+
name: bundler
|
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
|
16
|
+
requirements:
|
|
17
|
+
- - ~>
|
|
18
|
+
- !ruby/object:Gem::Version
|
|
19
|
+
version: '1.3'
|
|
20
|
+
type: :development
|
|
21
|
+
prerelease: false
|
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
23
|
+
requirements:
|
|
24
|
+
- - ~>
|
|
25
|
+
- !ruby/object:Gem::Version
|
|
26
|
+
version: '1.3'
|
|
27
|
+
- !ruby/object:Gem::Dependency
|
|
28
|
+
name: rspec
|
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
|
30
|
+
requirements:
|
|
31
|
+
- - '>='
|
|
32
|
+
- !ruby/object:Gem::Version
|
|
33
|
+
version: '0'
|
|
34
|
+
type: :development
|
|
35
|
+
prerelease: false
|
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
37
|
+
requirements:
|
|
38
|
+
- - '>='
|
|
39
|
+
- !ruby/object:Gem::Version
|
|
40
|
+
version: '0'
|
|
41
|
+
description: A DSL for method inpu expectations
|
|
42
|
+
email:
|
|
43
|
+
- adam@arcath.net
|
|
44
|
+
executables: []
|
|
45
|
+
extensions: []
|
|
46
|
+
extra_rdoc_files: []
|
|
47
|
+
files:
|
|
48
|
+
- .gitignore
|
|
49
|
+
- Gemfile
|
|
50
|
+
- LICENSE.txt
|
|
51
|
+
- README.md
|
|
52
|
+
- Rakefile
|
|
53
|
+
- expects.gemspec
|
|
54
|
+
- lib/expects.rb
|
|
55
|
+
- lib/expects/error.rb
|
|
56
|
+
- lib/expects/version.rb
|
|
57
|
+
- spec/expects_error_spec.rb
|
|
58
|
+
- spec/expects_spec.rb
|
|
59
|
+
- spec/spec_helper.rb
|
|
60
|
+
homepage: ''
|
|
61
|
+
licenses:
|
|
62
|
+
- MIT
|
|
63
|
+
metadata: {}
|
|
64
|
+
post_install_message:
|
|
65
|
+
rdoc_options: []
|
|
66
|
+
require_paths:
|
|
67
|
+
- lib
|
|
68
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
|
69
|
+
requirements:
|
|
70
|
+
- - '>='
|
|
71
|
+
- !ruby/object:Gem::Version
|
|
72
|
+
version: '0'
|
|
73
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
|
74
|
+
requirements:
|
|
75
|
+
- - '>='
|
|
76
|
+
- !ruby/object:Gem::Version
|
|
77
|
+
version: '0'
|
|
78
|
+
requirements: []
|
|
79
|
+
rubyforge_project:
|
|
80
|
+
rubygems_version: 2.0.0
|
|
81
|
+
signing_key:
|
|
82
|
+
specification_version: 4
|
|
83
|
+
summary: A DSL for method inpu expectations
|
|
84
|
+
test_files:
|
|
85
|
+
- spec/expects_error_spec.rb
|
|
86
|
+
- spec/expects_spec.rb
|
|
87
|
+
- spec/spec_helper.rb
|
|
88
|
+
has_rdoc:
|