yard-contracts 0.1.0 → 0.1.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 +4 -4
- data/README.md +4 -0
- data/lib/yard-contracts/version.rb +1 -1
- data/yard-contracts.gemspec +1 -5
- metadata +3 -3
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA1:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 9bf8df24a7341f6f8f5fcc55fc3edc99724ea38a
|
|
4
|
+
data.tar.gz: cb3ec2d3b9d4f013784e0a69a0c31e0deb70b2a4
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 499b2df5a4dd04103d8c94e557eb9ad9d9234b0286960e8be3939a64522440d6d6481264725f8bdd6eb2efcdef445df54970f4d2d263f6481a4c37e26d35458e
|
|
7
|
+
data.tar.gz: b3b2f541a12c1c861afde7b4823512a802f66e68c5f4dd45485641f493c55bc8793aae21e57449b233def0664327975024593b2f8691e1f4c45e9c9ea376e823
|
data/README.md
CHANGED
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
# yard-contracts
|
|
2
2
|
|
|
3
3
|
[](https://travis-ci.org/sfcgeorge/yard-contracts)
|
|
4
|
+
[](http://badge.fury.io/rb/yard-contracts)
|
|
5
|
+
[](https://gitter.im/egonSchiele/contracts.ruby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
|
|
4
6
|
|
|
5
7
|
yard-contracts is a YARD plugin that works with the fantastic Contracts gem to automatically document types and descriptions of parameters in your method signatures, saving time, making your code concise and keeping your documentation consistent.
|
|
6
8
|
|
|
@@ -28,6 +30,8 @@ Or install it yourself as:
|
|
|
28
30
|
|
|
29
31
|
$ gem install yard-contracts
|
|
30
32
|
|
|
33
|
+
Compatible with MRI Ruby 2.0+ and JRuby 1.9mode (with additional kramdown gem).
|
|
34
|
+
|
|
31
35
|
## Examples
|
|
32
36
|
|
|
33
37
|
See these two equivalent(ish) examples and be blown away.
|
data/yard-contracts.gemspec
CHANGED
|
@@ -20,14 +20,10 @@ Gem::Specification.new do |spec|
|
|
|
20
20
|
spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
|
|
21
21
|
spec.require_paths = ["lib"]
|
|
22
22
|
|
|
23
|
-
#if spec.respond_to?(:metadata)
|
|
24
|
-
#spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com' to prevent pushes to rubygems.org, or delete to allow pushes to any server."
|
|
25
|
-
#end
|
|
26
|
-
|
|
27
23
|
spec.add_dependency "yard", "~> 0.8"
|
|
28
24
|
spec.add_dependency "contracts", "~> 0.7"
|
|
29
25
|
|
|
30
|
-
spec.add_development_dependency "bundler", "~> 1.
|
|
26
|
+
spec.add_development_dependency "bundler", "~> 1.6"
|
|
31
27
|
spec.add_development_dependency "rake", "~> 10.0"
|
|
32
28
|
spec.add_development_dependency "rspec", "~> 3.2"
|
|
33
29
|
spec.add_development_dependency "nokogiri", "~> 1.6"
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: yard-contracts
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.1.
|
|
4
|
+
version: 0.1.1
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Simon George
|
|
@@ -44,14 +44,14 @@ dependencies:
|
|
|
44
44
|
requirements:
|
|
45
45
|
- - "~>"
|
|
46
46
|
- !ruby/object:Gem::Version
|
|
47
|
-
version: '1.
|
|
47
|
+
version: '1.6'
|
|
48
48
|
type: :development
|
|
49
49
|
prerelease: false
|
|
50
50
|
version_requirements: !ruby/object:Gem::Requirement
|
|
51
51
|
requirements:
|
|
52
52
|
- - "~>"
|
|
53
53
|
- !ruby/object:Gem::Version
|
|
54
|
-
version: '1.
|
|
54
|
+
version: '1.6'
|
|
55
55
|
- !ruby/object:Gem::Dependency
|
|
56
56
|
name: rake
|
|
57
57
|
requirement: !ruby/object:Gem::Requirement
|