rswag-schema_components 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2df85fd39afcf4bda138ec5e178f8564aed86de64e87539e7a126dd03b411e98
+  data.tar.gz: 655a801d17c39ab96f109b105ab6522042d11967a13d3c48b03bc52c166aac90
+SHA512:
+  metadata.gz: 8eb05da6c3c02a99d550a4c00971071583bf6787e57e525afc1b8440e776ba8744d95301e3da229310837afa9e4975fb436b2a6964cca10d9bebff170686c3fc
+  data.tar.gz: 3e71dd10e8ef6732ee28645f2eb9c57967ca7182b687e46160b7ac835bdd66c7c5d0a2e0a87db53cb12587e3c0fb042324643734f3b62d17b14ca57778db2c2b

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright Marten Klitzke
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,142 @@
+# Rswag::SchemaComponents
+
+As an addition to the rswag gem, this gem allows you to define reusable components for your swagger schema. This allows you to define schema components as ruby classes once and reuse and inherit it in multiple places in your schema.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "rswag-schema_components"
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install rswag-schema_components
+```
+
+### Configuration
+
+To use a different components folder just add an initializer called "rswag_schema_components.rb" and paste in the following to add your custom global classes:
+
+```ruby
+# encoding: utf-8
+
+Rswag::SchemaComponents.setup do |config|
+  config.components_base_path = "api/components"
+end
+```
+
+## Usage
+
+### Define a component
+
+Create a new class in the `components_base_path` (defaults to `app/api_components`) and include the `Rswag::SchemaComponents::Component` module.
+
+A basic example of a component:
+
+```ruby
+class ExampleComponent
+  include Rswag::SchemaComponents::Component
+
+  schema({
+    type: :object,
+    properties: {
+      id: {type: :string, format: :uuid},
+      name: {type: :string},
+      description: {type: :string},
+      createdAt: {type: :string, format: "date-time"},
+      updatedAt: {type: :string, format: "date-time"}
+    },
+    additionalProperties: false,
+    required: %w[
+      id name createdAt updatedAt
+    ]
+  })
+end
+```
+
+### Use all Components in your rswag schema
+
+Inside your `swagger_helper.rb` file:
+
+```ruby
+...
+RSpec.configure do |config|
+  components_loader = Rswag::SchemaComponents::Loader.new
+
+  servers = [
+    {
+      url: "http://localhost:3000",
+      description: "Dev Server"
+    },
+  ]
+
+  config.openapi_specs = {
+    "schema.yaml" => {
+      openapi: "3.0.1",
+      info: {
+        title: "Example API",
+        version: "v1",
+      },
+      servers:,
+      components: {
+        schemas: components_loader.schemas,
+        ...
+      }.compact
+      ...
+    },
+  }
+end
+```
+
+Since the `Rswag::SchemaComponents::Loader` returns a simple Ruby hash you can just merge it into another schema. With this you are able to create a shared schema which includes all shared components.
+
+```ruby
+...
+RSpec.configure do |config|
+  public_components = Rswag::SchemaComponents::Loader.new("public")
+  admin_components = Rswag::SchemaComponents::Loader.new("admin")
+  shared_components = Rswag::SchemaComponents::Loader.new("shared")
+
+  config.openapi_specs = {
+    "public-schema.yaml" => {
+      openapi: "3.0.1",
+      info: {
+        title: "Example Public API",
+        version: "v1",
+      },
+      servers:,
+      components: {
+        schemas: shared_components.schemas.merge(public_components.schemas)
+        ...
+      }.compact
+      ...
+    },
+    "admin-schema.yaml" => {
+      openapi: "3.0.1",
+      info: {
+        title: "Example Admin API",
+        version: "v1",
+      },
+      servers:,
+      components: {
+        schemas: shared_components.schemas.merge(admin_components.schemas)
+        ...
+      }.compact
+      ...
+    }
+  }
+end
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,14 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "lib"
+  t.libs << "test"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = false
+end
+
+task default: :test

data/lib/rswag/schema_components/component.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Rswag
+  module SchemaComponents
+    module Component
+      extend ActiveSupport::Concern
+
+      included do
+        class << self
+          attr_accessor :schema_value
+
+          def schema(schema_definition)
+            self.schema_value = if superclass.respond_to?(:schema_value)
+              parent_schema_definition = superclass.schema_value.deep_dup
+              parent_schema_definition.deeper_merge(schema_definition)
+            else
+              schema_definition
+            end
+          end
+        end
+
+        def to_schema
+          self.class.schema_value
+        end
+      end
+    end
+  end
+end

data/lib/rswag/schema_components/loader.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module Rswag
+  module SchemaComponents
+    class Loader
+      attr_accessor :identifier, :type
+
+      VALID_TYPES = %w[
+        schemas parameters securitySchemes requestBodies responses headers examples links callbacks
+      ].freeze
+
+      def initialize(identifier = nil)
+        @identifier = identifier
+      end
+
+      VALID_TYPES.each do |type|
+        define_method(type) do
+          @type = type
+
+          load_components
+        end
+      end
+
+      private def load_components
+        components = {}
+
+        load_classes.each do |klass|
+          component_name = extract_component_name(klass)
+
+          definition = klass.new.to_schema
+
+          if components[component_name].present?
+            raise "Duplicate component name \"#{component_name}\" found in \"#{definitions_path}\""
+          end
+
+          components[component_name] = definition.merge(title: component_name)
+        end
+
+        components
+      end
+
+      private def load_classes
+        Dir.glob(base_path.join("#{definitions_path}/**/*")).filter_map do |file_path|
+          next if File.directory?(file_path)
+
+          file_path.gsub(base_path.to_s, "") # remove base_path
+            .gsub(".rb", "") # remove extension
+            .camelize.constantize
+        end
+      end
+
+      private def extract_component_name(klass)
+        klass_name = extract_class_name(klass)
+
+        klass_name_parts = klass_name.split("::").reject(&:blank?)
+
+        klass_name_parts.join
+      end
+
+      private def extract_class_name(klass)
+        klass.name.split("::").last
+      end
+
+      private def definitions_path
+        [
+          identifier,
+          type
+        ].compact.join("/")
+      end
+
+      private def base_path
+        @base_path ||= Rails.root.join(Rswag::SchemaComponents.components_base_path)
+      end
+    end
+  end
+end

data/lib/rswag/schema_components/railtie.rb

@@ -0,0 +1,6 @@
+module Rswag
+  module SchemaComponents
+    class Railtie < ::Rails::Railtie
+    end
+  end
+end

data/lib/rswag/schema_components/version.rb

@@ -0,0 +1,5 @@
+module Rswag
+  module SchemaComponents
+    VERSION = "0.1.0"
+  end
+end

data/lib/rswag/schema_components.rb

@@ -0,0 +1,15 @@
+require "rswag/schema_components/version"
+require "rswag/schema_components/railtie"
+require "rswag/schema_components/loader"
+require "rswag/schema_components/component"
+
+module Rswag
+  module SchemaComponents
+    mattr_accessor :components_base_path
+    @@components_base_path = "app/api_components"
+
+    def self.setup
+      yield self
+    end
+  end
+end

data/lib/tasks/rswag/schema_components_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :rswag_schema_components do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: rswag-schema_components
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Marten Klitzke
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-06-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 8.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 8.0.0
+description: Schema Components for the rswag gem to define reusable schema components.
+email:
+- marten@fobizz.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/rswag/schema_components.rb
+- lib/rswag/schema_components/component.rb
+- lib/rswag/schema_components/loader.rb
+- lib/rswag/schema_components/railtie.rb
+- lib/rswag/schema_components/version.rb
+- lib/tasks/rswag/schema_components_tasks.rake
+homepage: https://github.com/101skills-gmbh/rswag-schema-components
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/101skills-gmbh/rswag-schema-components
+  changelog_uri: https://github.com/101skills-gmbh/rswag-schema-components/blob/main/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.13
+signing_key:
+specification_version: 4
+summary: Schema Components for Rswag.
+test_files: []