Module: Joshua::Doc

Extended by:
Doc
Included in:
Doc
Defined in:
lib/doc/doc.rb

Constant Summary collapse

ICONS = 
{
  github:  {
    url:   'https://github.com/dux/joshua',
    image: '<path d="M11.999 1.271C5.925 1.271 1 6.196 1 12.273c0 4.859 3.152 8.982 7.523 10.437.55.1.751-.239.751-.53l-.015-1.872c-3.06.666-3.706-1.474-3.706-1.474-.5-1.271-1.221-1.609-1.221-1.609-.999-.683.075-.668.075-.668 1.105.077 1.685 1.133 1.685 1.133.981 1.681 2.575 1.196 3.202.914.1-.711.384-1.196.698-1.471-2.442-.277-5.011-1.221-5.011-5.436 0-1.201.429-2.183 1.133-2.952-.114-.278-.491-1.397.108-2.911 0 0 .923-.296 3.025 1.127A10.56 10.56 0 0 1 12 6.591c.935.004 1.876.127 2.754.37 2.1-1.423 3.022-1.127 3.022-1.127.6 1.514.223 2.633.11 2.911.705.769 1.131 1.751 1.131 2.952 0 4.225-2.573 5.155-5.023 5.427.395.34.747 1.011.747 2.038 0 1.471-.014 2.657-.014 3.018 0 .293.199.636.756.528C19.851 21.251 23 17.13 23 12.273c0-6.077-4.926-11.002-11.001-11.002z"></path>',
  },
  twitter: {
    url:   nil,
    image: '<path d="M22.208 3.871c-.757.252-1.824.496-2.834.748-.757-.883-1.892-1.388-3.154-1.388-2.902 0-4.92 2.649-4.289 5.425-3.659-.126-6.939-1.892-9.083-4.542-1.135 1.892-.505 4.542 1.388 5.803-.757 0-1.388-.126-2.019-.505 0 2.145 1.388 4.037 3.532 4.416-.631.252-1.388.252-2.019.126.505 1.766 2.145 3.028 4.037 3.028-1.892 1.388-4.289 2.019-6.56 1.766 1.892 1.262 4.163 2.019 6.686 2.019 8.2 0 12.742-6.813 12.49-12.994.753-1.089 1.49-2.201 1.824-3.902z"></path>',
  },
  email: {
    url:   nil,
    image: '<path d="M22.22 9.787c0-5.13-4.062-8.307-8.983-8.307-6.666 0-11.457 4.948-11.457 11.431 0 6.042 4.609 9.609 9.999 9.609 1.64 0 3.749-.391 5.234-1.12l.364-2.031c-1.484.729-3.645 1.224-5.442 1.224-4.661 0-7.968-2.968-7.968-7.682 0-5.025 3.619-9.478 9.14-9.478 3.854 0 7.004 2.318 7.004 6.354 0 1.562-.39 3.671-1.588 4.843-.521.521-1.068.885-1.849.885-.599 0-1.015-.312-1.015-1.015 0-.235.052-.495.104-.729l1.614-6.458h-1.745l-.65 1.094c-.521-.938-1.615-1.381-2.63-1.381-3.386 0-5.208 3.151-5.208 6.25 0 1.198.416 2.291 1.197 3.047.599.598 1.485 1.041 2.5 1.041 1.328 0 2.422-.443 3.307-1.458.209.729 1.042 1.458 2.292 1.458 1.64 0 2.578-.625 3.541-1.562 1.536-1.484 2.239-3.828 2.239-6.015zm-7.916 1.276c0 1.77-.755 4.426-2.916 4.426-1.458 0-2.057-1.067-2.057-2.395 0-1.094.365-2.474 1.172-3.385.442-.495 1.015-.886 1.718-.886 1.406 0 2.083.886 2.083 2.24z"></path>',
  },
  error: {
    url: 'https://github.com/dux/joshua/issues',
    image: '<path d="M3,4v12c0,1.103,0.897,2,2,2h3.5l3.5,4l3.5-4H19c1.103,0,2-0.897,2-2V4c0-1.103-0.897-2-2-2H5C3.897,2,3,2.897,3,4z M11,5 h2v6h-2V5z M11,13h2v2h-2V13z" />'
  }
}

Instance Method Summary collapse

Instance Method Details

#icon(data, size: 24, color: nil, style: nil) ⇒ Object

render single icon



111
112
113
 
# File 'lib/doc/doc.rb', line 111

def icon data, size: 24, color: nil, style: nil
  %[<svg style="width: #{size}px; height: #{size}px; #{style}" viewBox="0 0 24 24" fill="currentColor">#{data}</svg>]
end

#index ⇒ Object

render doc for all documented classes



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/doc/doc.rb', line 141

def index
  tag.div do |n|
    for @klass in Joshua.documented
      @opts = @klass.opts
      icon = @opts.dig(:opts, :icon)

      n._sticky(style: 'background: #f7f7f7; padding-bottom: 5px; padding-top: 30px; margin-top: 2px;') do |n|
        n.push name_link @klass, 40
        n.push self.icon icon, style: 'position: absolute; margin-left: -40px; margin-top: 1px; fill: #777; background: #f7f7f7;' if icon
        n.h4 { @klass.to_s.sub(/Api$/, '') }
      end

      if desc = @opts.dig(:opts, :desc)
        n.p { desc }
      end

      if detail = @opts.dig(:opts, :detail)
        n.p { detail }
      end

      n.push render_type :member
      n.push render_type :collection

      n.br
      n.hr
      n.br
    end
  end
end

#left_nav ⇒ Object

left side navigation



126
127
128
129
130
131
132
133
134
135
136
137
138
 
# File 'lib/doc/doc.rb', line 126

def left_nav
  tag.div do |n|
    Joshua.documented.each do |name|
      n.a({ class:'btn btn-outline-info btn-sm', style: '-font-size: 14px; margin-bottom: 10px;', href: '#%s' % name}) do |n|
        icon = name.opts.dig(:opts, :icon)
        n.push self.icon icon, size: 20 if icon
        n.push name.to_s.sub(/Api$/, '')
      end

      n.br
    end
  end
end

#list_errors ⇒ Object 



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/doc/doc.rb', line 230

def list_errors
  tag.div do |n|
    n.push name_link :api_errors
    n.push icon ICONS[:error][:image], style: 'position: absolute; margin-left: -40px; margin-top: 1px; fill: #777;'
    n.h4 { 'Named errors' }

    n._box do |n|
      if RESCUE_FROM.keys.length == 0
        n.p 'No named errors defiend via'
        n.code "rescue from :name, 'Error description'"
      end

      n._row({ style: 'margin-bottom: 30px;' }) do |n|
        for key, desc in RESCUE_FROM
          next if key == :all
          next unless key.is_a?(Symbol) && desc.is_a?(String)

          n._col_4 { "<code>#{key}</code>" }
          n._col_8 { desc }
        end
      end
    end
  end
end

#misc_file(name) ⇒ Object 



28
29
30
 
# File 'lib/doc/doc.rb', line 28

def misc_file name
  File.read [__dir__, '../misc/%s' % name].join('/')
end

#modal_dialog ⇒ Object 



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/doc/doc.rb', line 255

def modal_dialog
  %[
    <script>#{misc_file('doc.js')}</script>
    <div id="modal" class="modal" tabindex="-1" role="dialog">
      <div style="position: absolute; top: 0; left: 0; width: 100%; height: 100%; background: rgba(99,99,99,0.3)"></div>
      <div class="modal-dialog modal-lg" role="document">
        <div class="modal-content">
          <div class="modal-header">
            <h5 class="modal-title"></h5>
            <button type="button" class="close" data-dismiss="modal" aria-label="Close" onclick="Modal.close()">
              <span aria-hidden="true">&times;</span>
            </button>
          </div>
          <div class="modal-body">
          </div>
        </div>
      </div>
    </div>
  ]
end

#name_link(name, top = nil) ⇒ Object

anchor link



106
107
108
 
# File 'lib/doc/doc.rb', line 106

def name_link name, top=nil
  %[<a name="#{name}" class="anchor" style="top: #{top || -95}px;"></a>]
end

#render(mount_on: nil, request: nil, bearer: nil) ⇒ Object

render full page



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/doc/doc.rb', line 33

def render mount_on: nil, request: nil, bearer: nil
  mount_on ||= request.url.split('?').first+'/'
  mount_on.sub! %r{//$}, '/'

  tag.html do |n|
    n.head  do |n|
      n.title 'Joshua Tester'
      n.link({ href: "https://fonts.googleapis.com/css?family=Inter:300,400,500,600,700,800,900&display=swap",  rel:"stylesheet" })
      n.link({ rel:"stylesheet", href:"https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/4.5.0/css/bootstrap.min.css" })
      n.script({ src: 'https://cdnjs.cloudflare.com/ajax/libs/zepto/1.2.0/zepto.min.js' })
      n.script %[window.api_opts = { mount_on: '#{mount_on}', bearer: '#{bearer}' }]
    end
    n.body do |n|
      n.style { misc_file('doc.css') }
      n.header({ style: 'border-bottom: 1px solid rgb(228, 228, 228);'}) do |n|
        n._container do |n|
          n.push top_icons
          n.push %[<button id="bearer_button" onclick="AuthButton.set()" class="btn btn-sm btn-outline-primary" style="float: right; margin-top: 15px; margin-right: 20px;">-</button>]
          n.h1({ class: :nav}) { %[<a href="#top">Joshua &nbsp; <gray>Docs</gray></a>] }
        end
      end

      n.img src:"https://i.imgur.com/HWoUz5k.png", style: 'width: 40px; z-index: 1; position: absolute; top: 10px; left: 50%;', onclick: "window.open('https://github.com/dux/joshua')"

      n.push modal_dialog

      n._container do |n|
        n._row do |n|
          n._col_3 do |n|
            n._sticky(style: 'padding-top: 30px;') do |n|
              n.a({ class: :dark, href: '#top' }) { '<p><b>API OBJECTS</b></p>' }
              n.push left_nav

              n.br
              n.br

              n.p '<b>TOOLS</b>'
              n.div do |n|
                n.push %[<p><a class="badge badge-light" href="#api_errors">Named errors</a></p>]
                n.push %[<p><a class="badge badge-light" href="#{mount_on}_/postman" target="capi_postman">Postman/Insomnija import URL</a></p>]
                n.push %[<p><a class="badge badge-light" href="#{mount_on}_/raw" target="capi_raw">Raw doc data</a></p>]
              end

              n.br

              n.p '<b>API LIBRARIES</b>'
              n.div do |n|
                n.push %[<a class="badge badge-light" href="https://github.com/dux/joshua/blob/master/lib/client/ruby/client" target="capi_ruby">Ruby</a>]
                n.push %[<a class="badge badge-light" href="https://github.com/dux/joshua/blob/master/lib/misc/api_example.coffee" target="capi_js">Javascript</a>]
                n.push %[<a class="badge badge-light" href="#">Python</a>]
                n.push %[<a class="badge badge-light" href="#">C#</a>]
              end

              n.br

              n.p '<b>RESOURCES</b>'
              n.div do |n|
                n.push %[<a class="badge badge-light" href="http://vmrcre.org/web/scribe/home/-/blogs/why-rest-sucks" target="capi_why">Why we only prefer POST?</a>]
              end
            end
          end

          n._col_9 do |n|
            n.push index
            n.push list_errors
          end
        end
      end
    end
  end
end

#render_method(name:, m_name:, opts:) ⇒ Object

render api method



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/doc/doc.rb', line 188

def render_method name:, m_name:, opts:
  tag._box do |n|
    # n.push %[<button onclick="" class="btn btn-info btn-sm request">request</button>]
    anchor = [@klass, m_name].join('-')

    n.push name_link anchor
    n.h5 do |n|
      n.push "<a href='##{anchor}'>#{m_name}</a>"
      n.push ' <gray>&nbsp; &mdash; &nbsp; %s</gray>' % opts[:desc] if opts[:desc]
    end

    n.p({style: 'margin: 20px 0 25px 0;'}) do |n|
      path = @klass.api_path
      path += '/:id' if name == :member
      path += "/#{m_name}"
      n.push %[<button href="#{path}" class="btn btn-outline-info btn-sm" onclick="ModalForm.render(api_opts.mount_on+this.innerHTML, #{(opts[:params] || {}).to_json.gsub('"', '&quot;')})">#{path}</button>]
    end

    if opts[:detail]
      n.h6 'Details'
      n.pre opts[:detail]
    end

    if mopts = opts[:params]
      n.h6 'Params'
      n.ul do |n|
        for name, opt in mopts
          n.li do |n|
            n.push '<bold>%s</bold>: ' % name
            n.push opt[:type]

            data = []
            data.push 'required' if opt[:required]
            data.push 'default: %s' % opt[:default].to_s unless opt[:default].nil?
            n.push ' &mdash; (%s)' % data.join(', ') if data.length > 0
          end
        end
      end
    end
  end
end

#render_type(name) ⇒ Object

render members or collection



172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/doc/doc.rb', line 172

def render_type name
  base = @opts[name] || return

  tag.div do |n|
    n.br
    n.h5 '<gray>%s methods</gray>' % name

    for m_name, member in base
      n.div do |n|
        n.push render_method name: name, m_name: m_name, opts: member
      end
    end
  end
end

#tag ⇒ Object 



24
25
26
 
# File 'lib/doc/doc.rb', line 24

def tag
  HtmlTagBuilder
end

#top_icons ⇒ Object

top side navigation icons



116
117
118
119
120
121
122
123
 
# File 'lib/doc/doc.rb', line 116

def top_icons
  tag.div({ style: 'float: right; margin-top: 18px;' }) do |n|
    for icon in ICONS.values
      next unless icon[:url]
      n.push %[<a target="_new" href="#{icon[:url]}">#{icon icon[:image]}</a>]
    end
  end
end