rspec-apib 0.3.4 → 0.4.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (6) hide show
  1. checksums.yaml +5 -5
  2. data/.envrc +1 -1
  3. data/README.md +3 -3
  4. data/lib/rspec/apib/version.rb +1 -1
  5. data/lib/rspec/apib/writer.rb +5 -1
  6. metadata +28 -28
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
- SHA1:
3
- metadata.gz: 3bb68f2609d1b57c9a6d95a38ef09f709614a0ba
4
- data.tar.gz: 00c1e7ddffd790f03b75992826e4c9e05759a5f4
2
+ SHA256:
3
+ metadata.gz: 5289265f76974beae58b1b06e3007f80ab8675e9fc90adfb0d990f92b73497a2
4
+ data.tar.gz: f5c304a0910a7b1e2ae167eae8d376669b8ca4e21015abadd6803d277de432b2
5
5
  SHA512:
6
- metadata.gz: ff77935c219c39b23b66ec637626a601edbc6dc9d7e4fd66dab1892dae04c3b8391e2854c4aadffc3dae24a845371a60b440b3127a8095383a5f26ccdbf77d4a
7
- data.tar.gz: 50657ef6855d20b93fd5b2cb22a94710379f1ae862a2ff3520c1711fb6502bfff10769d2a27ce09dd68c3bfe357f5706c217c4201f9ae426288d1355751fb19e
6
+ metadata.gz: c144150644f21b7e6eb41278eb97ffdc98294900b8fbf049e848832e49af0f95ce68eed76e1675d438f2fa858640ca93b516d8b7e885e7b755ddb76ac6709888
7
+ data.tar.gz: 182decedd6be6989b09519ba8aa75f0ffeae867b1abe24c52b5e8e7fb421fb9fe54a0b26348acfe09de285ff22f9cf01c859b9ac01b4135c050e48f795f4425d
data/.envrc CHANGED
@@ -1,4 +1,4 @@
1
- export COMPOSE_PROJECT_NAME=rspec-apib
1
+ export COMPOSE_PROJECT_NAME=rspecapib
2
2
 
3
3
  if [ "$(type -t direnv_load)" = 'function' ]; then
4
4
  PATH_add bin
data/README.md CHANGED
@@ -1,8 +1,8 @@
1
1
  # Rspec::Apib
2
2
 
3
- Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rspec/apib`. To experiment with that code, run `bin/console` for an interactive prompt.
4
-
5
- TODO: Delete this and the text above, and describe your gem
3
+ This is meant to be a drop-in solution for generating an API documentation from
4
+ existing RSpec request specs. The result is not always perfect, but hopefully
5
+ gives your developers and/or customers an idea of how your API works.
6
6
 
7
7
  ## Installation
8
8
 
data/lib/rspec/apib/version.rb CHANGED
@@ -1,5 +1,5 @@
1
1
  module RSpec
2
2
  module Apib
3
- VERSION = "0.3.4"
3
+ VERSION = "0.4.0"
4
4
  end
5
5
  end
data/lib/rspec/apib/writer.rb CHANGED
@@ -29,10 +29,14 @@ module RSpec
29
29
  RSpec::Apib.config.post_docs.map { |f| File.read(f) }.join("\n\n")
30
30
  end
31
31
 
32
+ def sorted_apib
33
+ @apib.to_a.sort { |a, b| a[0] <=> b[0] }
34
+ end
35
+
32
36
  def build
33
37
  apib = ""
34
38
 
35
- @apib.each do |group_name, group|
39
+ sorted_apib.each do |group_name, group|
36
40
  apib += "# Group #{group_name}\n\n"
37
41
  group.each do |action, data|
38
42
  apib += "## #{action}\n\n"
metadata CHANGED
@@ -1,111 +1,111 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: rspec-apib
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.3.4
4
+ version: 0.4.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Paul Spieker
8
8
  autorequire:
9
9
  bindir: exe
10
10
  cert_chain: []
11
- date: 2017-10-18 00:00:00.000000000 Z
11
+ date: 2018-11-05 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: bundler
15
15
  requirement: !ruby/object:Gem::Requirement
16
16
  requirements:
17
- - - ~>
17
+ - - "~>"
18
18
  - !ruby/object:Gem::Version
19
19
  version: '1.10'
20
20
  type: :development
21
21
  prerelease: false
22
22
  version_requirements: !ruby/object:Gem::Requirement
23
23
  requirements:
24
- - - ~>
24
+ - - "~>"
25
25
  - !ruby/object:Gem::Version
26
26
  version: '1.10'
27
27
  - !ruby/object:Gem::Dependency
28
28
  name: rake
29
29
  requirement: !ruby/object:Gem::Requirement
30
30
  requirements:
31
- - - ~>
31
+ - - "~>"
32
32
  - !ruby/object:Gem::Version
33
33
  version: '10.0'
34
34
  type: :development
35
35
  prerelease: false
36
36
  version_requirements: !ruby/object:Gem::Requirement
37
37
  requirements:
38
- - - ~>
38
+ - - "~>"
39
39
  - !ruby/object:Gem::Version
40
40
  version: '10.0'
41
41
  - !ruby/object:Gem::Dependency
42
42
  name: guard
43
43
  requirement: !ruby/object:Gem::Requirement
44
44
  requirements:
45
- - - ~>
45
+ - - "~>"
46
46
  - !ruby/object:Gem::Version
47
47
  version: 2.13.0
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
54
  version: 2.13.0
55
55
  - !ruby/object:Gem::Dependency
56
56
  name: guard-rspec
57
57
  requirement: !ruby/object:Gem::Requirement
58
58
  requirements:
59
- - - ~>
59
+ - - "~>"
60
60
  - !ruby/object:Gem::Version
61
61
  version: 4.6.4
62
62
  type: :development
63
63
  prerelease: false
64
64
  version_requirements: !ruby/object:Gem::Requirement
65
65
  requirements:
66
- - - ~>
66
+ - - "~>"
67
67
  - !ruby/object:Gem::Version
68
68
  version: 4.6.4
69
69
  - !ruby/object:Gem::Dependency
70
70
  name: pry
71
71
  requirement: !ruby/object:Gem::Requirement
72
72
  requirements:
73
- - - '>='
73
+ - - ">="
74
74
  - !ruby/object:Gem::Version
75
75
  version: '0'
76
76
  type: :development
77
77
  prerelease: false
78
78
  version_requirements: !ruby/object:Gem::Requirement
79
79
  requirements:
80
- - - '>='
80
+ - - ">="
81
81
  - !ruby/object:Gem::Version
82
82
  version: '0'
83
83
  - !ruby/object:Gem::Dependency
84
84
  name: rails
85
85
  requirement: !ruby/object:Gem::Requirement
86
86
  requirements:
87
- - - '>='
87
+ - - ">="
88
88
  - !ruby/object:Gem::Version
89
89
  version: '4.2'
90
90
  type: :runtime
91
91
  prerelease: false
92
92
  version_requirements: !ruby/object:Gem::Requirement
93
93
  requirements:
94
- - - '>='
94
+ - - ">="
95
95
  - !ruby/object:Gem::Version
96
96
  version: '4.2'
97
97
  - !ruby/object:Gem::Dependency
98
98
  name: rspec-rails
99
99
  requirement: !ruby/object:Gem::Requirement
100
100
  requirements:
101
- - - ~>
101
+ - - "~>"
102
102
  - !ruby/object:Gem::Version
103
103
  version: '3.4'
104
104
  type: :runtime
105
105
  prerelease: false
106
106
  version_requirements: !ruby/object:Gem::Requirement
107
107
  requirements:
108
- - - ~>
108
+ - - "~>"
109
109
  - !ruby/object:Gem::Version
110
110
  version: '3.4'
111
111
  description:
@@ -115,15 +115,15 @@ executables: []
115
115
  extensions: []
116
116
  extra_rdoc_files: []
117
117
  files:
118
- - .codeclimate.yml
119
- - .dockerignore
120
- - .envrc
121
- - .gitignore
122
- - .rspec
123
- - .rubocop.yml
124
- - .ruby-gemset
125
- - .ruby-version
126
- - .travis.yml
118
+ - ".codeclimate.yml"
119
+ - ".dockerignore"
120
+ - ".envrc"
121
+ - ".gitignore"
122
+ - ".rspec"
123
+ - ".rubocop.yml"
124
+ - ".ruby-gemset"
125
+ - ".ruby-version"
126
+ - ".travis.yml"
127
127
  - CODE_OF_CONDUCT.md
128
128
  - Dockerfile
129
129
  - Gemfile
@@ -150,17 +150,17 @@ require_paths:
150
150
  - lib
151
151
  required_ruby_version: !ruby/object:Gem::Requirement
152
152
  requirements:
153
- - - '>='
153
+ - - ">="
154
154
  - !ruby/object:Gem::Version
155
155
  version: '0'
156
156
  required_rubygems_version: !ruby/object:Gem::Requirement
157
157
  requirements:
158
- - - '>='
158
+ - - ">="
159
159
  - !ruby/object:Gem::Version
160
160
  version: '0'
161
161
  requirements: []
162
162
  rubyforge_project:
163
- rubygems_version: 2.0.14.1
163
+ rubygems_version: 2.7.7
164
164
  signing_key:
165
165
  specification_version: 4
166
166
  summary: Generates API Blueprint from request specs