RubyGems - oas_hanami - Versions diffs - 0.1.0 - Mend

oas_hanami 0.1.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 (23) hide show

checksums.yaml +7 -0
data/.release-please-config.json +64 -0
data/.release-please-manifest.json +3 -0
data/.rspec +4 -0
data/.rspec_status +11 -0
data/.rubocop.yml +15 -0
data/.rubocop_todo.yml +20 -0
data/.ruby-version +1 -0
data/.ruby.version +1 -0
data/CHANGELOG.md +8 -0
data/README.md +38 -0
data/Rakefile +11 -0
data/lib/oas_hanami/configuration.rb +63 -0
data/lib/oas_hanami/hanami_route_formatter.rb +9 -0
data/lib/oas_hanami/inspector.rb +11 -0
data/lib/oas_hanami/oas_route_builder.rb +90 -0
data/lib/oas_hanami/route_extractor.rb +46 -0
data/lib/oas_hanami/version.rb +5 -0
data/lib/oas_hanami/web/assets/rapidoc-min.js +3915 -0
data/lib/oas_hanami/web/view.rb +35 -0
data/lib/oas_hanami/web/views/index.html.erb +154 -0
data/lib/oas_hanami.rb +47 -0
metadata +82 -0

data/lib/oas_hanami/web/view.rb ADDED Viewed

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+module OasHanami
+  module Web
+    class View
+      def self.call(env)
+        new.call(env)
+      end
+      def call(env)
+        @request = Rack::Request.new(env)
+        oas = OasHanami.build.to_json
+        if @request.path.end_with?(".json")
+          [200, { "Content-Type" => "application/json" }, [oas]]
+        elsif @request.path.end_with?(".js")
+          [200, { "Content-Type" => "application/javascript" }, [render_js]]
+        else
+          [200, { "Content-Type" => "text/html" }, [render_view]]
+        end
+      end
+      def render_view
+        template_path = File.expand_path("views/index.html.erb", __dir__)
+        template = File.read(template_path)
+        ERB.new(template).result(binding)
+      end
+      def render_js
+        template_path = File.expand_path("assets/rapidoc-min.js", __dir__)
+        File.read(template_path)
+      end
+    end
+  end
+end

data/lib/oas_hanami/web/views/index.html.erb ADDED Viewed

@@ -0,0 +1,154 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title><%= OasHanami.config.info.title %></title>
+    <meta charset="utf-8">
+    <!-- Important: rapi-doc uses utf8 characters -->
+    <script type="module" src="<%= @request.env['SCRIPT_NAME'] %>/rapidoc-min.js"></script>
+    <script>
+      function applyTheme() {
+        const theme = "<%= OasHanami.config.rapidoc_theme %>";
+        const docEl = document.querySelector('rapi-doc');
+        // Reset all theme-related attributes
+        docEl.removeAttribute('theme');
+        docEl.removeAttribute('bg-color');
+        docEl.removeAttribute('text-color');
+        docEl.removeAttribute('nav-bg-color');
+        docEl.removeAttribute('nav-text-color');
+        docEl.removeAttribute('nav-hover-bg-color');
+        docEl.removeAttribute('nav-hover-text-color');
+        docEl.removeAttribute('nav-accent-color');
+        docEl.removeAttribute('primary-color');
+        console.log(theme === 'dark')
+        if (theme === 'dark'){
+          docEl.setAttribute('theme','dark');
+          docEl.setAttribute('bg-color','#333');
+          docEl.setAttribute('text-color','#BBB');
+        } else if (theme === 'light'){
+          docEl.setAttribute('theme','light');
+          docEl.setAttribute('bg-color','#FFF');
+          docEl.setAttribute('text-color','#444');
+        } else if (theme === 'night') {
+          docEl.setAttribute('theme','dark');
+          docEl.setAttribute('bg-color','#14191f');
+          docEl.setAttribute('text-color','#aec2e0');
+        } else if (theme === 'mud') {
+          docEl.setAttribute('theme','dark');
+          docEl.setAttribute('bg-color','#403635');
+          docEl.setAttribute('text-color','#c3b8b7');
+        } else if (theme === 'cofee') {
+          docEl.setAttribute('theme','dark');
+          docEl.setAttribute('bg-color','#36312C');
+          docEl.setAttribute('text-color','#ceb8a0');
+        } else if (theme === 'forest') {
+          docEl.setAttribute('theme','dark');
+          docEl.setAttribute('bg-color','#384244');
+          docEl.setAttribute('text-color','#BDD6DB');
+        } else if (theme === 'olive') {
+          docEl.setAttribute('theme','dark');
+          docEl.setAttribute('bg-color','#2a2f31');
+          docEl.setAttribute('text-color','#acc7c8');
+        } else if (theme === 'outerspace') {
+          docEl.setAttribute('theme','dark');
+          docEl.setAttribute('bg-color','#2D3133');
+          docEl.setAttribute('text-color','#CAD9E3');
+        } else if (theme === 'ebony') {
+          docEl.setAttribute('theme','dark');
+          docEl.setAttribute('bg-color','#2B303B');
+          docEl.setAttribute('text-color','#dee3ec');
+        } else if (theme === 'snow') {
+          docEl.setAttribute('theme','light');
+          docEl.setAttribute('bg-color','#FAFAFA');
+          docEl.setAttribute('text-color','#555');
+        } else if (theme === 'green') {
+          docEl.setAttribute('theme','light');
+          docEl.setAttribute('bg-color','#f9fdf7');
+          docEl.setAttribute('text-color','#375F1B');
+        } else if (theme === 'blue') {
+          docEl.setAttribute('theme','light');
+          docEl.setAttribute('bg-color','#ecf1f7');
+          docEl.setAttribute('text-color','#133863');
+        } else if (theme === 'beige') {
+          docEl.setAttribute('show-header','true');
+          docEl.setAttribute('theme','light');
+          docEl.setAttribute('bg-color','#fdf8ed');
+          docEl.setAttribute('text-color','#342809');
+        } else if (theme === 'graynav') {
+          docEl.setAttribute('show-header','false');
+          docEl.setAttribute('theme','light');
+          docEl.setAttribute('nav-bg-color','#3e4b54');
+          docEl.setAttribute('nav-accent-color','#fd6964');
+          docEl.setAttribute('primary-color','#ea526f');
+        }  else if (theme === 'purplenav') {
+          docEl.setAttribute('show-header','false');
+          docEl.setAttribute('theme','light');
+          docEl.setAttribute('nav-accent-color','#ffd8e7');
+          docEl.setAttribute('nav-bg-color','#666699');
+          docEl.setAttribute('primary-color','#ea526f');
+          docEl.setAttribute('bg-color','#fff9fb');
+        } else if (theme === 'lightgraynav') {
+          docEl.setAttribute('show-header','false');
+          docEl.setAttribute('theme','light');
+          docEl.setAttribute('nav-bg-color','#fafafa');
+          docEl.setAttribute('nav-hover-text-color','#9b0700');
+          docEl.setAttribute('nav-hover-bg-color','#ffebea');
+          docEl.setAttribute('primary-color','#F63C41');
+          docEl.setAttribute('bg-color','#ffffff');
+        } else if (theme === 'darkbluenav') {
+          docEl.setAttribute('show-header','false');
+          docEl.setAttribute('theme','light');
+          docEl.setAttribute('bg-color','#f9f9fa');
+          docEl.setAttribute('nav-bg-color','#3f4d67');
+          docEl.setAttribute('nav-text-color','#a9b7d0');
+          docEl.setAttribute('nav-hover-bg-color','#333f54');
+          docEl.setAttribute('nav-hover-text-color','#fff');
+          docEl.setAttribute('nav-accent-color','#f87070');
+          docEl.setAttribute('primary-color','#5c7096');
+        } else if (theme === 'rails') {
+          docEl.setAttribute('theme','light');
+          docEl.setAttribute('bg-color','#FFFFFF');
+          docEl.setAttribute('nav-bg-color','#101828');
+          docEl.setAttribute('nav-text-color','#fff');
+          docEl.setAttribute('nav-hover-bg-color','#261B23');
+          docEl.setAttribute('nav-hover-text-color','#fff');
+          docEl.setAttribute('nav-accent-color','#D30001');
+          docEl.setAttribute('primary-color','#D30001');
+        } else if (theme === 'hanami') {
+          docEl.setAttribute('theme','light');
+          docEl.setAttribute('bg-color','#FFFFFF');
+          docEl.setAttribute('nav-bg-color','#685D9F');
+          docEl.setAttribute('nav-text-color','#fff');
+          docEl.setAttribute('nav-hover-bg-color','#8e80d1');
+          docEl.setAttribute('nav-hover-text-color','#fff');
+          docEl.setAttribute('nav-accent-color','#FCE4EC');
+          docEl.setAttribute('primary-color','#685D9F');
+        }
+      }
+      document.addEventListener('DOMContentLoaded', applyTheme);
+    </script>
+  </head>
+  <body>
+    <rapi-doc
+      spec-url="<%= @request.env['SCRIPT_NAME'] %>/.json"
+      show-header="false"
+      font-size="largest"
+      show-method-in-nav-bar="as-colored-text"
+      nav-item-spacing="relaxed"
+      allow-spec-file-download="true"
+      schema-style="table"
+      sort-tags="true"
+    >
+    </rapi-doc>
+    <style>
+      rapi-doc::part(btn btn-outline) {
+        width: 220px;
+        min-width: 170px;
+      }
+    </style>
+  </body>
+</html>

data/lib/oas_hanami.rb ADDED Viewed

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+require "rack"
+require "oas_core"
+require "debug"
+OasCore.configure_yard!
+module OasHanami
+  autoload :VERSION, "oas_hanami/version"
+  autoload :Configuration, "oas_hanami/configuration"
+  autoload :RouteExtractor, "oas_hanami/route_extractor"
+  autoload :OasRouteBuilder, "oas_hanami/oas_route_builder"
+  autoload :HanamiRouteFormatter, "oas_hanami/hanami_route_formatter"
+  autoload :Inspector, "oas_hanami/inspector"
+  module Web
+    autoload :View, "oas_hanami/web/view"
+  end
+  class << self
+    def build
+      clear_cache
+      OasCore.config = config
+      host_routes = RouteExtractor.host_routes
+      oas = OasCore::Builders::SpecificationBuilder.new.with_oas_routes(host_routes).build
+      oas.to_spec
+    end
+    def configure
+      yield config
+    end
+    def config
+      @config ||= Configuration.new
+    end
+    def clear_cache
+      return if Hanami.env?(:production)
+      MethodSource.clear_cache
+      RouteExtractor.clear_cache
+    end
+  end
+end

metadata ADDED Viewed

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: oas_hanami
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- achacon
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: oas_core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.5.3
+description: OasHanami simplifies API documentation by automatically generating OpenAPI
+  Specification (OAS 3.1) documents from your Hanami application routes. It eliminates
+  the need for manual documentation, ensuring accuracy and consistency.
+email:
+- andres.ch@protonmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".release-please-config.json"
+- ".release-please-manifest.json"
+- ".rspec"
+- ".rspec_status"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".ruby-version"
+- ".ruby.version"
+- CHANGELOG.md
+- README.md
+- Rakefile
+- lib/oas_hanami.rb
+- lib/oas_hanami/configuration.rb
+- lib/oas_hanami/hanami_route_formatter.rb
+- lib/oas_hanami/inspector.rb
+- lib/oas_hanami/oas_route_builder.rb
+- lib/oas_hanami/route_extractor.rb
+- lib/oas_hanami/version.rb
+- lib/oas_hanami/web/assets/rapidoc-min.js
+- lib/oas_hanami/web/view.rb
+- lib/oas_hanami/web/views/index.html.erb
+homepage: https://github.com/a-chacon/oas_hanami
+licenses:
+- GPL-3.0-only
+metadata:
+  homepage_uri: https://github.com/a-chacon/oas_hanami
+  source_code_uri: https://github.com/a-chacon/oas_hanami
+  changelog_uri: https://github.com/a-chacon/oas_hanami/blob/main/CHANGELOG.md
+  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: 3.6.7
+specification_version: 4
+summary: Generates OpenAPI Specification (OAS) documents by analyzing and extracting
+  routes from Hanami applications.
+test_files: []