apipie-dsl 2.2.0 → 2.2.5

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 8712c1245add4425a89c69480c9a2e043a0c40a71199e64ce2dc4df6b3352973
4
- data.tar.gz: e37febc7bf4200644582443d6d39224ab172f666e849abcd219b60a4e28c2809
3
+ metadata.gz: 3abb36cc2c2a73c3d36df30adc52256d373862ef6e8d1d206502b35d2b6de2fc
4
+ data.tar.gz: b38860b723fe7a8e805e8dc9f29d36edad87a249a4bd1c2ac3b5776afed9f450
5
5
  SHA512:
6
- metadata.gz: 1b8b7af91cb70d835a8227038aef33b559bdd43f8bfcc42a92b83b990b2e212808016a119e5a0543a5f36a4a819b990f8a2127dfe8bc3f987882bea50e4984cf
7
- data.tar.gz: 6e7c84c789542c09838bb37650af701bcf24f8210f451e74bbf097541e05659cba3d76be5a29aa687b2176ab8e7c335335671ba7f76110a0ca697d93816384d8
6
+ metadata.gz: e83577ac774732338ed3ae5a9036aab988fd28fa95c173d331747f95e110c3a7393107728cdf92fdadde3e157b0731b01099a024deba10ea3625ee74a7271021
7
+ data.tar.gz: 8dd6360df8ce33373c4657646df2be53e1b3bae450cce471e476b70108e30ef4d7a081c5afa381849972390abe9db73f9998bd5ac159059c2cc699862e03c802
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
File without changes
@@ -76,9 +76,6 @@ module ApipieDsl
76
76
  end
77
77
  end
78
78
 
79
- def apipie_dsl_checksum
80
- end
81
-
82
79
  private
83
80
 
84
81
  helper_method :heading
@@ -0,0 +1,8 @@
1
+ <% if @languages && @languages.size > 1 %>
2
+ <li class='pull-right'>
3
+ &nbsp;[ <%= @languages.collect do |lang|
4
+ link = link_to(lang, "#{doc_url}.#{lang}.html")
5
+ lang == @language ? content_tag(:b, link) : link
6
+ end.join(' | ').html_safe %> ]
7
+ </li>
8
+ <% end %>
@@ -21,7 +21,7 @@
21
21
  <li class='active'>
22
22
  <%= @klass[:name] %>
23
23
  </li>
24
- <%= render(:partial => 'languages', :locals => {:doc_url => @klass[:doc_url]}) %>
24
+ <%= render(partial: 'languages', locals: { doc_url: @klass[:doc_url] }) %>
25
25
  </ul>
26
26
 
27
27
  <div class='page-header'>
@@ -15,7 +15,7 @@
15
15
  </ul>
16
16
  <ul class='breadcrumb'>
17
17
  <li class='active'><a href='<%= @doc[:doc_url] %><%= section_ext(@section) %><%= @doc[:link_extension] %>'><%= @doc[:name] %> <%= current_version(@doc[:classes]) %></a></li>
18
- <%= render(:partial => 'languages', :locals => {:doc_url => @doc[:doc_url]}) %>
18
+ <%= render(partial: 'languages', locals: { doc_url: @doc[:doc_url] + section_ext(@section) }) %>
19
19
  <% if @versions && @versions.size > 1 %>
20
20
  <li class='pull-right'>
21
21
  <%= @versions.collect { |v| link_to v, ApipieDSL.full_url(v+@doc[:link_extension]) }.join(' / ').html_safe %>
@@ -25,7 +25,7 @@
25
25
  <span class='divider'>/</span>
26
26
  </li>
27
27
  <li class='active'><%= @method[:name] %></li>
28
- <%= render(:partial => 'languages', :locals => {:doc_url => @method[:doc_url]}) %>
28
+ <%= render(partial: 'languages', locals: { doc_url: @method[:doc_url] }) %>
29
29
  </ul>
30
30
 
31
31
  <div class='page-header'>
@@ -3,18 +3,22 @@
3
3
  module ApipieDSL
4
4
  module Markup
5
5
  class RDoc
6
- def initialize
7
- require 'rdoc'
8
- require 'rdoc/markup/to_html'
9
- @rdoc ||= if Gem::Version.new(::RDoc::VERSION) < Gem::Version.new('4.0.0')
10
- ::RDoc::Markup::ToHtml.new
11
- else
12
- ::RDoc::Markup::ToHtml.new(::RDoc::Options.new)
13
- end
6
+ def to_html(text)
7
+ rdoc.convert(text)
14
8
  end
15
9
 
16
- def to_html(text)
17
- @rdoc.convert(text)
10
+ private
11
+
12
+ def rdoc
13
+ @rdoc ||= begin
14
+ require 'rdoc'
15
+ require 'rdoc/markup/to_html'
16
+ if Gem::Version.new(::RDoc::VERSION) < Gem::Version.new('4.0.0')
17
+ ::RDoc::Markup::ToHtml.new()
18
+ else
19
+ ::RDoc::Markup::ToHtml.new(::RDoc::Options.new)
20
+ end
21
+ end
18
22
  end
19
23
  end
20
24
 
@@ -3,7 +3,6 @@ module ApipieDSL
3
3
  module MapperExtensions
4
4
  def apipie_dsl(options = {})
5
5
  namespace 'apipie_dsl', path: ApipieDSL.configuration.doc_base_url do
6
- get 'apipie_dsl_checksum', to: 'apipie_dsls#apipie_dsl_checksum', format: 'json'
7
6
  constraints(version: /[^\/]+/, section: /[^\/]+/, class: /[^\/]+/,
8
7
  method: /[^\/]+/) do
9
8
  get(options.reverse_merge("(:version)/(:section)/(:class)/(:method)" => 'apipie_dsls#index', as: :apipie_dsl))
@@ -23,7 +23,7 @@ namespace :apipie_dsl do
23
23
  ApipieDSL.configuration.sections.each do |section|
24
24
  ApipieDSL.url_prefix = "../../#{subdir}"
25
25
  doc = ApipieDSL.docs(version, nil, nil, lang, section)
26
- doc[:docs][:link_extension] = "#{lang_ext(lang)}.html"
26
+ doc[:docs][:link_extension] = "#{ApipieDSL::TasksUtils.lang_ext(lang)}.html"
27
27
  ApipieDSL::TasksUtils.generate_index_page(file_base_version, doc, include_json, true, lang, section)
28
28
  ApipieDSL.url_prefix = "../../../#{subdir}"
29
29
  section_out = "#{file_base_version}/#{section}"
@@ -33,7 +33,7 @@ namespace :apipie_dsl do
33
33
  end
34
34
  ApipieDSL.url_prefix = "../../#{subdir}"
35
35
  doc = ApipieDSL.docs(version, nil, nil, lang)
36
- doc[:docs][:link_extension] = "#{lang_ext(lang)}.html"
36
+ doc[:docs][:link_extension] = "#{ApipieDSL::TasksUtils.lang_ext(lang)}.html"
37
37
  ApipieDSL::TasksUtils.generate_help_page(file_base_version, doc, true, lang)
38
38
  end
39
39
  end
@@ -60,7 +60,7 @@ namespace :apipie_dsl do
60
60
  ApipieDSL.configuration.sections.each do |section|
61
61
  ApipieDSL.url_prefix = "../../#{subdir}"
62
62
  doc = ApipieDSL.docs(version, nil, nil, lang, section)
63
- doc[:docs][:link_extension] = "#{lang_ext(lang)}.html"
63
+ doc[:docs][:link_extension] = "#{ApipieDSL::TasksUtils.lang_ext(lang)}.html"
64
64
  ApipieDSL::TasksUtils.generate_index_page(file_base_version, doc, include_json, true, lang, section)
65
65
  ApipieDSL.url_prefix = "../../../#{subdir}"
66
66
  section_out = "#{file_base_version}/#{section}"
@@ -70,7 +70,7 @@ namespace :apipie_dsl do
70
70
  end
71
71
  ApipieDSL.url_prefix = "../../#{subdir}"
72
72
  doc = ApipieDSL.docs(version, nil, nil, lang)
73
- doc[:docs][:link_extension] = "#{lang_ext(lang)}.html"
73
+ doc[:docs][:link_extension] = "#{ApipieDSL::TasksUtils.lang_ext(lang)}.html"
74
74
  ApipieDSL::TasksUtils.generate_help_page(file_base_version, doc, true, lang)
75
75
  end
76
76
  end
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module ApipieDSL
4
- VERSION = '2.2.0'
4
+ VERSION = '2.2.5'
5
5
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: apipie-dsl
3
3
  version: !ruby/object:Gem::Version
4
- version: 2.2.0
4
+ version: 2.2.5
5
5
  platform: ruby
6
6
  authors:
7
7
  - Oleh Fedorenko
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2020-04-03 00:00:00.000000000 Z
11
+ date: 2020-05-26 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: bundler
@@ -129,7 +129,8 @@ executables: []
129
129
  extensions: []
130
130
  extra_rdoc_files: []
131
131
  files:
132
- - LICENSE
132
+ - APACHE-LICENSE-2.0
133
+ - MIT-LICENSE
133
134
  - README.md
134
135
  - app/controllers/apipie_dsl/apipie_dsls_controller.rb
135
136
  - app/helpers/apipie_dsl_helper.rb
@@ -142,16 +143,16 @@ files:
142
143
  - app/public/apipie_dsl/stylesheets/bundled/bootstrap-responsive.min.css
143
144
  - app/public/apipie_dsl/stylesheets/bundled/bootstrap.min.css
144
145
  - app/public/apipie_dsl/stylesheets/bundled/prettify.css
145
- - app/views/apipie_dsl/apipie_dsls/_index_class_meth.erb
146
- - app/views/apipie_dsl/apipie_dsls/_index_class_prop.erb
147
- - app/views/apipie_dsl/apipie_dsls/_languages.erb
148
- - app/views/apipie_dsl/apipie_dsls/_metadata.erb
149
- - app/views/apipie_dsl/apipie_dsls/_method.erb
150
- - app/views/apipie_dsl/apipie_dsls/_method_detail.erb
146
+ - app/views/apipie_dsl/apipie_dsls/_index_class_meth.html.erb
147
+ - app/views/apipie_dsl/apipie_dsls/_index_class_prop.html.erb
148
+ - app/views/apipie_dsl/apipie_dsls/_languages.html.erb
149
+ - app/views/apipie_dsl/apipie_dsls/_metadata.html.erb
150
+ - app/views/apipie_dsl/apipie_dsls/_method.html.erb
151
+ - app/views/apipie_dsl/apipie_dsls/_method_detail.html.erb
151
152
  - app/views/apipie_dsl/apipie_dsls/_params.html.erb
152
153
  - app/views/apipie_dsl/apipie_dsls/_params_plain.html.erb
153
- - app/views/apipie_dsl/apipie_dsls/_property.erb
154
- - app/views/apipie_dsl/apipie_dsls/_property_detail.erb
154
+ - app/views/apipie_dsl/apipie_dsls/_property.html.erb
155
+ - app/views/apipie_dsl/apipie_dsls/_property_detail.html.erb
155
156
  - app/views/apipie_dsl/apipie_dsls/_raises.html.erb
156
157
  - app/views/apipie_dsl/apipie_dsls/_returns.html.erb
157
158
  - app/views/apipie_dsl/apipie_dsls/apipie_dsl_404.html.erb
@@ -212,7 +213,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
212
213
  - !ruby/object:Gem::Version
213
214
  version: '0'
214
215
  requirements: []
215
- rubygems_version: 3.0.3
216
+ rubygems_version: 3.1.2
216
217
  signing_key:
217
218
  specification_version: 4
218
219
  summary: Ruby DSL documentation tool
@@ -1,6 +0,0 @@
1
- <% if @languages && @languages.size > 1 %>
2
- <li class='pull-right'>
3
- &nbsp;[ <%= @languages.collect { |lang| link = link_to(lang, "#{doc_url}.#{lang}.html");
4
- lang == @language ? content_tag(:b, link) : link }.join(' | ').html_safe %> ]
5
- </li>
6
- <% end %>