RubyGems - rails-api-docs - Versions diffs - 0.1.1 - Mend

rails-api-docs 0.1.1

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 (28) hide show

checksums.yaml +7 -0
data/CHANGELOG.md +156 -0
data/LICENSE.txt +21 -0
data/README.md +552 -0
data/app/controllers/rails_api_docs/docs_controller.rb +20 -0
data/config/routes.rb +5 -0
data/lib/generators/rails-api-docs/init/init_generator.rb +167 -0
data/lib/generators/rails-api-docs/update/update_generator.rb +28 -0
data/lib/rails-api-docs/config/appender.rb +98 -0
data/lib/rails-api-docs/config/builder.rb +175 -0
data/lib/rails-api-docs/config/loader.rb +30 -0
data/lib/rails-api-docs/configuration.rb +64 -0
data/lib/rails-api-docs/doc/curl_renderer.rb +120 -0
data/lib/rails-api-docs/doc/file_builder.rb +36 -0
data/lib/rails-api-docs/doc/renderer.rb +228 -0
data/lib/rails-api-docs/doc/responder.rb +55 -0
data/lib/rails-api-docs/engine.rb +27 -0
data/lib/rails-api-docs/inspectors/body_inferrer.rb +88 -0
data/lib/rails-api-docs/inspectors/controller_inspector.rb +78 -0
data/lib/rails-api-docs/inspectors/json_route_detector.rb +189 -0
data/lib/rails-api-docs/inspectors/route_inspector.rb +126 -0
data/lib/rails-api-docs/inspectors/schema_inspector.rb +36 -0
data/lib/rails-api-docs/sample_value.rb +28 -0
data/lib/rails-api-docs/tasks/rails-api-docs.rake +25 -0
data/lib/rails-api-docs/templates/api_docs.html.erb +695 -0
data/lib/rails-api-docs/version.rb +5 -0
data/lib/rails-api-docs.rb +21 -0
metadata +159 -0

data/lib/rails-api-docs/version.rb ADDED Viewed

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+module RailsApiDocs
+  VERSION = "0.1.1"
+end

data/lib/rails-api-docs.rb ADDED Viewed

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+require_relative "rails-api-docs/version"
+require_relative "rails-api-docs/configuration"
+require_relative "rails-api-docs/sample_value"
+require_relative "rails-api-docs/inspectors/route_inspector"
+require_relative "rails-api-docs/inspectors/controller_inspector"
+require_relative "rails-api-docs/inspectors/schema_inspector"
+require_relative "rails-api-docs/inspectors/body_inferrer"
+require_relative "rails-api-docs/inspectors/json_route_detector"
+require_relative "rails-api-docs/config/builder"
+require_relative "rails-api-docs/config/loader"
+require_relative "rails-api-docs/config/appender"
+require_relative "rails-api-docs/doc/curl_renderer"
+require_relative "rails-api-docs/doc/renderer"
+require_relative "rails-api-docs/doc/responder"
+require_relative "rails-api-docs/doc/file_builder"
+require_relative "rails-api-docs/engine" if defined?(Rails::Engine)
+module RailsApiDocs
+end

metadata ADDED Viewed

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: rails-api-docs
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Jackson Pires
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+- !ruby/object:Gem::Dependency
+  name: prism
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.24'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.24'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.1'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Inspects your Rails routes, controllers and schema to produce config/rails-api-docs.yml,
+  then renders a Scalar-style three-column HTML page at public/api-docs.html. Includes
+  a live preview mount at /rails/api-docs in development.
+email:
+- jackson@linkana.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- app/controllers/rails_api_docs/docs_controller.rb
+- config/routes.rb
+- lib/generators/rails-api-docs/init/init_generator.rb
+- lib/generators/rails-api-docs/update/update_generator.rb
+- lib/rails-api-docs.rb
+- lib/rails-api-docs/config/appender.rb
+- lib/rails-api-docs/config/builder.rb
+- lib/rails-api-docs/config/loader.rb
+- lib/rails-api-docs/configuration.rb
+- lib/rails-api-docs/doc/curl_renderer.rb
+- lib/rails-api-docs/doc/file_builder.rb
+- lib/rails-api-docs/doc/renderer.rb
+- lib/rails-api-docs/doc/responder.rb
+- lib/rails-api-docs/engine.rb
+- lib/rails-api-docs/inspectors/body_inferrer.rb
+- lib/rails-api-docs/inspectors/controller_inspector.rb
+- lib/rails-api-docs/inspectors/json_route_detector.rb
+- lib/rails-api-docs/inspectors/route_inspector.rb
+- lib/rails-api-docs/inspectors/schema_inspector.rb
+- lib/rails-api-docs/sample_value.rb
+- lib/rails-api-docs/tasks/rails-api-docs.rake
+- lib/rails-api-docs/templates/api_docs.html.erb
+- lib/rails-api-docs/version.rb
+homepage: https://github.com/jacksonpires/rails-api-docs
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/jacksonpires/rails-api-docs
+  source_code_uri: https://github.com/jacksonpires/rails-api-docs/tree/main
+  changelog_uri: https://github.com/jacksonpires/rails-api-docs/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/jacksonpires/rails-api-docs/issues
+  documentation_uri: https://github.com/jacksonpires/rails-api-docs#readme
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.6
+specification_version: 4
+summary: Generate beautiful, self-contained HTML API documentation from your Rails
+  routes.
+test_files: []