grape-apidoc 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '00539705ff2d9e78efbb1f426ebfd137b8341b899f30ab6b4f043de5491ab200'
+  data.tar.gz: 3c581b505833b9a5a0a22243512e1e4a2eb8e97ec6eb612eb18f7f1b6b42c0cb
+SHA512:
+  metadata.gz: d01f82031b6b9eeafda3138012aea74b81ffe7b679161905e1c6d9acca59d608783d6e3da1cd4ff116ef04f8c58ac1ac106bc97eb28b2bbe8fa392d725fff6a1
+  data.tar.gz: 31a64d4676dbd91be7783b1a9dd435c96ba95523e7980a36d38d8e7d7e827153c9890b6c520e15707d714f2b7101225a6b1bfadf8efcddfa505be5254937d36a

data/.github/workflows/test.yml

@@ -0,0 +1,21 @@
+name: Test
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ["2.7", "3.0", "3.1", "3.2"]
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+      - run: bundle exec rake

data/.gitignore

@@ -0,0 +1 @@
+.ruby-version

data/.rubocop.yml

@@ -0,0 +1,10 @@
+inherit_gem:
+  rubocop-bsm:
+    - default.yml
+inherit_mode:
+  merge:
+    - Exclude
+
+Naming/FileName:
+  Exclude:
+    - lib/grape-apidoc.rb

data/Gemfile

@@ -0,0 +1,7 @@
+source 'http://rubygems.org'
+gemspec
+gem 'grape-entity'
+gem 'mustermann', '>= 3'
+gem 'rake'
+gem 'rspec'
+gem 'rubocop-bsm'

data/Gemfile.lock

@@ -0,0 +1,122 @@
+PATH
+  remote: .
+  specs:
+    grape-apidoc (0.0.2)
+      grape
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    activesupport (7.0.4.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    builder (3.2.4)
+    concurrent-ruby (1.2.0)
+    diff-lcs (1.5.0)
+    dry-core (1.0.0)
+      concurrent-ruby (~> 1.0)
+      zeitwerk (~> 2.6)
+    dry-inflector (1.0.0)
+    dry-logic (1.5.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 1.0, < 2)
+      zeitwerk (~> 2.6)
+    dry-types (1.7.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 1.0, < 2)
+      dry-inflector (~> 1.0, < 2)
+      dry-logic (>= 1.4, < 2)
+      zeitwerk (~> 2.6)
+    grape (1.7.0)
+      activesupport
+      builder
+      dry-types (>= 1.1)
+      mustermann-grape (~> 1.0.0)
+      rack (>= 1.3.0)
+      rack-accept
+    grape-entity (0.10.2)
+      activesupport (>= 3.0.0)
+      multi_json (>= 1.3.2)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    json (2.6.3)
+    minitest (5.17.0)
+    multi_json (1.15.0)
+    mustermann (3.0.0)
+      ruby2_keywords (~> 0.0.1)
+    mustermann-grape (1.0.2)
+      mustermann (>= 1.0.0)
+    parallel (1.22.1)
+    parser (3.2.0.0)
+      ast (~> 2.4.1)
+    rack (3.0.4.1)
+    rack-accept (0.4.5)
+      rack (>= 0.4)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.2)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.44.1)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.24.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.24.1)
+      parser (>= 3.1.1.0)
+    rubocop-bsm (0.6.1)
+      rubocop (~> 1.0)
+      rubocop-performance
+      rubocop-rake
+      rubocop-rspec
+    rubocop-capybara (2.17.0)
+      rubocop (~> 1.41)
+    rubocop-performance (1.15.2)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.18.1)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.4.2)
+    zeitwerk (2.6.6)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  bundler
+  grape-apidoc!
+  grape-entity
+  mustermann (>= 3)
+  rake
+  rspec
+  rubocop-bsm
+
+BUNDLED WITH
+   2.3.16

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2021 Black Square Media Ltd
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,27 @@
+# grape-apidoc [![Test](https://github.com/bsm/grape-apidoc/actions/workflows/test.yml/badge.svg)](https://github.com/bsm/grape-apidoc/actions/workflows/test.yml)
+
+[Rake](https://github.com/ruby/rake) task to generate [Markdown](https://en.wikipedia.org/wiki/Markdown) documentation for [Grape](https://github.com/ruby-grape/grape)/[Grape::Entity](https://github.com/ruby-grape/grape-entity)-based APIs
+
+## Getting started
+
+```ruby
+# Gemfile
+group :development do # most common use env is env=development
+  gem 'grape-apidoc'
+end
+```
+
+```ruby
+# Rakefile
+begin
+  require 'grape/apidoc'
+  Grape::Apidoc::RakeTask.new(:apidoc, root_api_class: Grape::App) # point it to the top-level API class
+rescue LoadError
+  nil # so it does not fail in non-development environment
+end
+```
+
+## Examples
+
+- API: [spec/scenario/example.rb](spec/scenario/example.rb)
+- Resulting doc: [spec/fixtures/example.md](spec/fixtures/example.md)

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/setup'
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new(:rubocop)
+
+task default: %i[rubocop spec]

data/grape-apidoc.gemspec

@@ -0,0 +1,19 @@
+Gem::Specification.new do |s|
+  s.name        = 'grape-apidoc'
+  s.version     = '0.0.2'
+  s.authors     = ['Black Square Media Ltd.']
+  s.email       = ['info@blacksquaremedia.com']
+  s.summary     = 'Markdown documentation for Grape APIs'
+  s.description = 'github.com/ruby/rake task to generate Markdown documentation for github.com/ruby-grape/grape + github.com/ruby-grape/grape-entity based APIs'
+  s.homepage    = 'https://github.com/bsm/grape-apidoc'
+  s.license     = 'Apache-2.0'
+
+  s.files         = `git ls-files -z`.split("\x0").reject {|f| f.start_with?('spec/') }
+  s.require_paths = ['lib']
+  s.required_ruby_version = '>= 2.7'
+
+  s.add_dependency 'grape'
+
+  s.add_development_dependency 'bundler'
+  s.metadata['rubygems_mfa_required'] = 'true'
+end

data/lib/grape/apidoc/rake_task.rb

@@ -0,0 +1,11 @@
+class Grape::Apidoc::RakeTask < Rake::TaskLib
+  def initialize(name = :apidoc, root_api_class: nil, output: $stdout)
+    super()
+
+    desc 'Generate markdown documentation for API'
+    task(name => :environment) do
+      doc = Grape::Apidoc.new(root_api_class, output: output)
+      doc.write!
+    end
+  end
+end

data/lib/grape/apidoc/table_format.rb

@@ -0,0 +1,26 @@
+# column cell widths
+class Grape::Apidoc::TableFormat < Array
+  def format(*values)
+    str = '|'
+
+    each_with_index do |width, index|
+      str << ' '
+      str << (values[index] || '').ljust(width)
+      str << ' |'
+    end
+
+    str
+  end
+
+  def separator
+    str = '|'
+
+    each_with_index do |width, _index|
+      str << ' '
+      str << ('-' * width)
+      str << ' |'
+    end
+
+    str
+  end
+end

data/lib/grape/apidoc.rb

@@ -0,0 +1,188 @@
+module Grape
+  class Apidoc
+    autoload :RakeTask, 'grape/apidoc/rake_task'
+    autoload :TableFormat, 'grape/apidoc/table_format'
+
+    ENTITY_FIELDS_TABLE = TableFormat.new([20, 10, 30, 10]).freeze # Field, Type, Description, Values
+    ROUTE_FIELDS_TABLE = TableFormat.new([20, 10, 40]).freeze # Field, Type, Description
+
+    def initialize(root_api_class = nil, output: $stdout)
+      @api = root_api_class || detect_root_api_class
+      @out = output
+    end
+
+    def write!
+      write_entities! if defined?(Grape::Entity)
+      write_routes!
+    end
+
+    private
+
+    def detect_root_api_class
+      # performance shortcut for https://github.com/bsm/grape-app/
+      return Grape::App if defined?(Grape::App)
+
+      # root api is the one with largest route count:
+      Grape::API.descendants.max do |a, b|
+        a.try(:routes)&.count <=> b.try(:routes)&.count
+      end
+    end
+
+    # Returns all the entities used in app.
+    def entities
+      @entities ||= begin
+        acc = {}
+        @api.routes.filter_map(&:entity).each do |entity|
+          collect_entities(acc, entity)
+        end
+        acc.keys.sort_by(&:name)
+      end
+    end
+
+    # Recursively collects entities.
+    # @param acc Hash entity_class => true lookup/accumulator
+    # @param entity Grape::Entity root/seed entity
+    def collect_entities(acc, entity)
+      return if acc[entity]
+
+      acc[entity] = true
+
+      entity.root_exposures.each do |exp|
+        via = exp.try(:using_class_name)
+        collect_entities(acc, via) if via
+      end
+    end
+
+    def write_entities!
+      @out.puts '# Entities'
+      @out.puts
+
+      entities.each do |entity|
+        write_entity_header!(entity)
+        @out.puts
+
+        write_entity_fields!(entity)
+        @out.puts
+      end
+    end
+
+    def write_entity_header!(entity)
+      @out.puts "## #{entity_name(entity)}"
+    end
+
+    def write_entity_fields!(entity)
+      unless entity.root_exposures.present?
+        @out.puts '*No fields exposed.*'
+        return
+      end
+
+      @out.puts ENTITY_FIELDS_TABLE.format('Field', 'Type', 'Description', 'Values')
+      @out.puts ENTITY_FIELDS_TABLE.separator
+
+      entity.root_exposures.each do |exposure|
+        name = exposure.key
+        doc = entity.documentation[name] || {}
+        type, desc, vals = doc.values_at(:type, :desc, :values)
+
+        # fall back to `using:...`
+        unless type
+          via = exposure.try(:using_class_name)
+          if via
+            via_name = entity_name(via)
+            type = "[#{via_name}](##{identifier(via_name)})"
+          end
+        end
+
+        type = "[#{type}]" if doc[:is_array]
+        @out.puts ENTITY_FIELDS_TABLE.format(name.to_s, type.to_s, desc.to_s, vals&.join(', '))
+      end
+    end
+
+    def write_routes!
+      @out.puts '# Routes'
+      @out.puts
+
+      @api.routes.each do |route|
+        write_route_header!(route)
+        @out.puts
+
+        # list items:
+        write_route_retval!(route)
+        write_route_security!(route)
+        @out.puts
+
+        write_route_params!(route)
+        @out.puts
+      end
+    end
+
+    def write_route_header!(route)
+      method = route.request_method
+      path = route.path
+                  .sub(':version', route.version.to_s)
+                  .sub('(.:format)', '')
+      @out.puts "## #{method} #{path}"
+
+      return unless route.description.present?
+
+      @out.puts
+      @out.puts route.description
+    end
+
+    def write_route_security!(route)
+      security = route.settings.dig(:description, :security)
+      return unless security.present?
+
+      security_desc = security.map {|k, v| "#{k}=#{v.inspect}" }.join(' ')
+
+      @out.puts "- **Security**: `#{security_desc}`"
+    end
+
+    def write_route_retval!(route)
+      entity = route.try(&:entity)
+      return unless entity
+
+      array_prefix = 'List of ' if route.settings.dig(:description, :is_array)
+
+      name = entity_name(entity)
+      @out.puts "- **Returns**: #{array_prefix}[#{name}](##{identifier(name)})"
+    end
+
+    def write_route_params!(route)
+      return unless route.params.present?
+
+      @out.puts '**Parameters**:'
+      @out.puts
+
+      @out.puts ROUTE_FIELDS_TABLE.format('Parameter', 'Type', 'Description')
+      @out.puts ROUTE_FIELDS_TABLE.separator
+
+      route.params.each do |name, doc|
+        # route.params includes path params as well, like `id => ''`
+        # (not a hash, like normal params):
+        doc = {} unless doc.is_a?(Hash)
+
+        # Problem: it's pretty much impossible to match Entity to model to dig column types.
+        # Problem: it's not guaranteed that Entity exposures match params.
+        # Need to either enforce some requirements for organizing API or give up.
+        type = doc[:type] || ''
+        desc = doc.except(:type).map {|k, v| "#{k}: #{v}" }.join(', ')
+        @out.puts ROUTE_FIELDS_TABLE.format(name.to_s, type, desc)
+      end
+    end
+
+    def identifier(str)
+      # FIXME: this is github-specific. At some point, maybe extract smth like testable Grape::Apidoc::Flavor::Github or so.
+
+      # "Foo::Bar is a foo_bar, -   definitely" -> "foobar-is-a-foo_bar-----definitely"
+      str.downcase.gsub(/[^0-9a-z_-]+/, '').gsub('\s', '-')
+    end
+
+    def entity_name(entity)
+      entity.name
+            .split('::')
+            .filter_map {|s| s.delete_suffix('Entity').presence } # Foo::Entity, FooEntity -> just Foo
+            .join(':')
+    end
+  end
+end

data/lib/grape-apidoc.rb

@@ -0,0 +1 @@
+require 'grape/apidoc'

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: grape-apidoc
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Black Square Media Ltd.
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-02-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: grape
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: github.com/ruby/rake task to generate Markdown documentation for github.com/ruby-grape/grape
+  + github.com/ruby-grape/grape-entity based APIs
+email:
+- info@blacksquaremedia.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/test.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- grape-apidoc.gemspec
+- lib/grape-apidoc.rb
+- lib/grape/apidoc.rb
+- lib/grape/apidoc/rake_task.rb
+- lib/grape/apidoc/table_format.rb
+homepage: https://github.com/bsm/grape-apidoc
+licenses:
+- Apache-2.0
+metadata:
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.1
+signing_key: 
+specification_version: 4
+summary: Markdown documentation for Grape APIs
+test_files: []