docurium 0.3.2 → 0.4.0

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.
Files changed (17) hide show
  1. checksums.yaml +7 -0
  2. data/.travis.yml +13 -0
  3. data/Gemfile +6 -0
  4. data/Rakefile +6 -0
  5. data/docurium.gemspec +5 -3
  6. data/lib/docurium.rb +186 -137
  7. data/lib/docurium/docparser.rb +292 -0
  8. data/lib/docurium/version.rb +1 -1
  9. data/lib/libdetect.rb +23 -0
  10. data/site/css/style.css +4 -0
  11. data/site/index.html +56 -10
  12. data/site/js/docurium.js +28 -5
  13. data/site/shared/css/documentation.css +1 -0
  14. data/test/fixtures/git2/errors.h +2 -0
  15. data/test/parser_test.rb +333 -46
  16. data/test/repo_test.rb +14 -6
  17. metadata +59 -44
data/test/repo_test.rb CHANGED
@@ -30,8 +30,7 @@ END
30
30
 
31
31
  @path = File.dirname(__FILE__) + '/fixtures/git2/api.docurium'
32
32
  @doc = Docurium.new(@path, @repo)
33
- @doc.parse_headers(index)
34
- @data = @doc.data
33
+ @data = @doc.parse_headers(index, 'HEAD')
35
34
  end
36
35
 
37
36
  def teardown
@@ -45,6 +44,7 @@ END
45
44
  end
46
45
 
47
46
  def test_can_extract_enum_from_define
47
+ skip("this isn't something we do")
48
48
  assert_equal 41, @data[:globals].size
49
49
  idxentry = @data[:types].find { |a| a[0] == 'GIT_IDXENTRY' }
50
50
  assert idxentry
@@ -56,6 +56,7 @@ END
56
56
  end
57
57
 
58
58
  def test_can_extract_structs_and_enums
59
+ skip("we don't auto-create enums, so the number is wrong")
59
60
  assert_equal 25, @data[:types].size
60
61
  end
61
62
 
@@ -69,7 +70,7 @@ END
69
70
  func = @data[:functions]['git_blob_rawcontent']
70
71
  assert_equal "<p>Get a read-only buffer with the raw content of a blob.</p>\n", func[:description]
71
72
  assert_equal 'const void *', func[:return][:type]
72
- assert_equal 'the pointer; NULL if the blob has no contents', func[:return][:comment]
73
+ assert_equal ' the pointer; NULL if the blob has no contents', func[:return][:comment]
73
74
  assert_equal 84, func[:line]
74
75
  assert_equal 84, func[:lineto]
75
76
  assert_equal 'blob.h', func[:file]
@@ -82,7 +83,7 @@ END
82
83
  def test_can_parse_defined_functions
83
84
  func = @data[:functions]['git_tree_lookup']
84
85
  assert_equal 'int', func[:return][:type]
85
- assert_equal '0 on success; error code otherwise', func[:return][:comment]
86
+ assert_equal ' 0 on success; error code otherwise', func[:return][:comment]
86
87
  assert_equal 50, func[:line]
87
88
  assert_equal 'tree.h', func[:file]
88
89
  assert_equal 'id', func[:args][2][:name]
@@ -93,7 +94,7 @@ END
93
94
  def test_can_parse_function_cast_args
94
95
  func = @data[:functions]['git_reference_listcb']
95
96
  assert_equal 'int', func[:return][:type]
96
- assert_equal '0 on success; error code otherwise', func[:return][:comment]
97
+ assert_equal ' 0 on success; error code otherwise', func[:return][:comment]
97
98
  assert_equal 321, func[:line]
98
99
  assert_equal 'refs.h', func[:file]
99
100
  assert_equal 'repo', func[:args][0][:name]
@@ -108,7 +109,7 @@ END
108
109
 
109
110
  def test_can_get_the_full_description_from_multi_liners
110
111
  func = @data[:functions]['git_commit_create_o']
111
- desc = "<p>Create a new commit in the repository using <code>git_object</code>\ninstances as parameters.</p>\n"
112
+ desc = "<p>Create a new commit in the repository using <code>git_object</code>\n instances as parameters.</p>\n"
112
113
  assert_equal desc, func[:description]
113
114
  end
114
115
 
@@ -119,4 +120,11 @@ END
119
120
  assert_equal 6, funcs.size
120
121
  end
121
122
 
123
+ def test_can_store_mutliple_enum_doc_sections
124
+ skip("this isn't something we do")
125
+ idxentry = @data[:types].find { |a| a[0] == 'GIT_IDXENTRY' }
126
+ assert idxentry, "GIT_IDXENTRY did not get automatically created"
127
+ assert_equal 2, idxentry[1][:sections].size
128
+ end
129
+
122
130
  end
metadata CHANGED
@@ -1,8 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: docurium
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.3.2
5
- prerelease:
4
+ version: 0.4.0
6
5
  platform: ruby
7
6
  authors:
8
7
  - Carlos Martín Nieto
@@ -10,120 +9,134 @@ authors:
10
9
  autorequire:
11
10
  bindir: bin
12
11
  cert_chain: []
13
- date: 2014-02-22 00:00:00.000000000 Z
12
+ date: 2014-09-13 00:00:00.000000000 Z
14
13
  dependencies:
15
14
  - !ruby/object:Gem::Dependency
16
15
  name: version_sorter
17
16
  requirement: !ruby/object:Gem::Requirement
18
- none: false
19
17
  requirements:
20
- - - ~>
18
+ - - "~>"
21
19
  - !ruby/object:Gem::Version
22
- version: 1.1.0
20
+ version: '1.1'
23
21
  type: :runtime
24
22
  prerelease: false
25
23
  version_requirements: !ruby/object:Gem::Requirement
26
- none: false
27
24
  requirements:
28
- - - ~>
25
+ - - "~>"
29
26
  - !ruby/object:Gem::Version
30
- version: 1.1.0
27
+ version: '1.1'
31
28
  - !ruby/object:Gem::Dependency
32
29
  name: mustache
33
30
  requirement: !ruby/object:Gem::Requirement
34
- none: false
35
31
  requirements:
36
- - - ! '>='
32
+ - - "~>"
37
33
  - !ruby/object:Gem::Version
38
- version: 0.99.4
34
+ version: '0.99'
39
35
  type: :runtime
40
36
  prerelease: false
41
37
  version_requirements: !ruby/object:Gem::Requirement
42
- none: false
43
38
  requirements:
44
- - - ! '>='
39
+ - - "~>"
45
40
  - !ruby/object:Gem::Version
46
- version: 0.99.4
41
+ version: '0.99'
47
42
  - !ruby/object:Gem::Dependency
48
43
  name: rocco
49
44
  requirement: !ruby/object:Gem::Requirement
50
- none: false
51
45
  requirements:
52
- - - ~>
46
+ - - "~>"
53
47
  - !ruby/object:Gem::Version
54
48
  version: '0.8'
55
49
  type: :runtime
56
50
  prerelease: false
57
51
  version_requirements: !ruby/object:Gem::Requirement
58
- none: false
59
52
  requirements:
60
- - - ~>
53
+ - - "~>"
61
54
  - !ruby/object:Gem::Version
62
55
  version: '0.8'
63
56
  - !ruby/object:Gem::Dependency
64
57
  name: gli
65
58
  requirement: !ruby/object:Gem::Requirement
66
- none: false
67
59
  requirements:
68
- - - ~>
60
+ - - "~>"
69
61
  - !ruby/object:Gem::Version
70
62
  version: '2.5'
71
63
  type: :runtime
72
64
  prerelease: false
73
65
  version_requirements: !ruby/object:Gem::Requirement
74
- none: false
75
66
  requirements:
76
- - - ~>
67
+ - - "~>"
77
68
  - !ruby/object:Gem::Version
78
69
  version: '2.5'
79
70
  - !ruby/object:Gem::Dependency
80
71
  name: rugged
81
72
  requirement: !ruby/object:Gem::Requirement
82
- none: false
83
73
  requirements:
84
- - - ~>
74
+ - - "~>"
85
75
  - !ruby/object:Gem::Version
86
- version: '0.19'
76
+ version: '0.21'
87
77
  type: :runtime
88
78
  prerelease: false
89
79
  version_requirements: !ruby/object:Gem::Requirement
90
- none: false
91
80
  requirements:
92
- - - ~>
81
+ - - "~>"
93
82
  - !ruby/object:Gem::Version
94
- version: '0.19'
83
+ version: '0.21'
95
84
  - !ruby/object:Gem::Dependency
96
85
  name: redcarpet
97
86
  requirement: !ruby/object:Gem::Requirement
98
- none: false
99
87
  requirements:
100
- - - ~>
88
+ - - "~>"
101
89
  - !ruby/object:Gem::Version
102
90
  version: '3.0'
103
91
  type: :runtime
104
92
  prerelease: false
105
93
  version_requirements: !ruby/object:Gem::Requirement
106
- none: false
107
94
  requirements:
108
- - - ~>
95
+ - - "~>"
109
96
  - !ruby/object:Gem::Version
110
97
  version: '3.0'
98
+ - !ruby/object:Gem::Dependency
99
+ name: ffi-clang
100
+ requirement: !ruby/object:Gem::Requirement
101
+ requirements:
102
+ - - "~>"
103
+ - !ruby/object:Gem::Version
104
+ version: '0.2'
105
+ type: :runtime
106
+ prerelease: false
107
+ version_requirements: !ruby/object:Gem::Requirement
108
+ requirements:
109
+ - - "~>"
110
+ - !ruby/object:Gem::Version
111
+ version: '0.2'
111
112
  - !ruby/object:Gem::Dependency
112
113
  name: bundler
113
114
  requirement: !ruby/object:Gem::Requirement
114
- none: false
115
115
  requirements:
116
- - - ~>
116
+ - - "~>"
117
117
  - !ruby/object:Gem::Version
118
118
  version: '1.0'
119
119
  type: :development
120
120
  prerelease: false
121
121
  version_requirements: !ruby/object:Gem::Requirement
122
- none: false
123
122
  requirements:
124
- - - ~>
123
+ - - "~>"
125
124
  - !ruby/object:Gem::Version
126
125
  version: '1.0'
126
+ - !ruby/object:Gem::Dependency
127
+ name: rake
128
+ requirement: !ruby/object:Gem::Requirement
129
+ requirements:
130
+ - - "~>"
131
+ - !ruby/object:Gem::Version
132
+ version: '10.1'
133
+ type: :development
134
+ prerelease: false
135
+ version_requirements: !ruby/object:Gem::Requirement
136
+ requirements:
137
+ - - "~>"
138
+ - !ruby/object:Gem::Version
139
+ version: '10.1'
127
140
  description: A simpler, prettier Doxygen replacement.
128
141
  email:
129
142
  - cmn@dwim.me
@@ -133,7 +146,8 @@ executables:
133
146
  extensions: []
134
147
  extra_rdoc_files: []
135
148
  files:
136
- - .gitignore
149
+ - ".gitignore"
150
+ - ".travis.yml"
137
151
  - Gemfile
138
152
  - LICENCE
139
153
  - README.md
@@ -144,9 +158,11 @@ files:
144
158
  - lib/docurium.rb
145
159
  - lib/docurium/cli.rb
146
160
  - lib/docurium/cparser.rb
161
+ - lib/docurium/docparser.rb
147
162
  - lib/docurium/layout.mustache
148
163
  - lib/docurium/layout.rb
149
164
  - lib/docurium/version.rb
165
+ - lib/libdetect.rb
150
166
  - site/css/style.css
151
167
  - site/images/search_icon.png
152
168
  - site/index.html
@@ -192,26 +208,25 @@ files:
192
208
  homepage: https://github.com/libgit2/docurium
193
209
  licenses:
194
210
  - MIT
211
+ metadata: {}
195
212
  post_install_message:
196
213
  rdoc_options: []
197
214
  require_paths:
198
215
  - lib
199
216
  required_ruby_version: !ruby/object:Gem::Requirement
200
- none: false
201
217
  requirements:
202
- - - ! '>='
218
+ - - ">="
203
219
  - !ruby/object:Gem::Version
204
220
  version: '0'
205
221
  required_rubygems_version: !ruby/object:Gem::Requirement
206
- none: false
207
222
  requirements:
208
- - - ! '>='
223
+ - - ">="
209
224
  - !ruby/object:Gem::Version
210
225
  version: '0'
211
226
  requirements: []
212
227
  rubyforge_project:
213
- rubygems_version: 1.8.23
228
+ rubygems_version: 2.2.2
214
229
  signing_key:
215
- specification_version: 3
230
+ specification_version: 4
216
231
  summary: A simpler, prettier Doxygen replacement.
217
232
  test_files: []