dry-swagger 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0ea8396c1d7976844254a7e7564a74a0cdc0391c3bf42a4aa49fc479fd99e11e
+  data.tar.gz: 611a49427c0c0ece4bd4ec1e134afd8bcebc01f43b0803eecabdd9cf16df4d14
+SHA512:
+  metadata.gz: 7d1e8404d230897c6f4e88fffbd1870ee1fbf305b725d8d9067f5529c3f2bcdda71990b364372478d3ff9f780e6a997144c557f57f574768d705caea10255923
+  data.tar.gz: 0d7b5f769a536d9fd18b594cf097c5c9922b92f74bdf009ff2dd90ea099e90c5bc9d36aa684efcdd49a1176f299d6db2574a786a8a98213a5301a15bfdb223bf

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.idea/

data/.rakeTasks

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Settings><!--This file was automatically generated by Ruby plugin.
+You are allowed to: 
+1. Remove rake task
+2. Add existing rake tasks
+To add existing rake tasks automatically delete this file and reload the project.
+--><RakeGroup description="" fullCmd="" taksId="rake"><RakeTask description="Build dry-swagger-0.1.0.gem into the pkg directory" fullCmd="build" taksId="build" /><RakeTask description="Remove any temporary products" fullCmd="clean" taksId="clean" /><RakeTask description="Remove any generated files" fullCmd="clobber" taksId="clobber" /><RakeTask description="Build and install dry-swagger-0.1.0.gem into system gems" fullCmd="install" taksId="install" /><RakeGroup description="" fullCmd="" taksId="install"><RakeTask description="Build and install dry-swagger-0.1.0.gem into system gems without network access" fullCmd="install:local" taksId="local" /></RakeGroup><RakeTask description="Create tag v0.1.0 and build and push dry-swagger-0.1.0.gem to TODO: Set to 'http://mygemserver.com'" fullCmd="release[remote]" taksId="release[remote]" /><RakeTask description="Run RSpec code examples" fullCmd="spec" taksId="spec" /><RakeTask description="" fullCmd="default" taksId="default" /><RakeTask description="" fullCmd="release" taksId="release" /><RakeGroup description="" fullCmd="" taksId="release"><RakeTask description="" fullCmd="release:guard_clean" taksId="guard_clean" /><RakeTask description="" fullCmd="release:rubygem_push" taksId="rubygem_push" /><RakeTask description="" fullCmd="release:source_control_push" taksId="source_control_push" /></RakeGroup></RakeGroup></Settings>

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at jane.terziev@webfactory.mk. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in dry-swagger.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+gem "dry-validation"
+gem "dry-struct"

data/Gemfile.lock

@@ -0,0 +1,76 @@
+PATH
+  remote: .
+  specs:
+    dry-swagger (0.3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    concurrent-ruby (1.1.9)
+    diff-lcs (1.4.4)
+    dry-configurable (0.12.1)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.5, >= 0.5.0)
+    dry-container (0.8.0)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.1, >= 0.1.3)
+    dry-core (0.7.1)
+      concurrent-ruby (~> 1.0)
+    dry-equalizer (0.3.0)
+    dry-inflector (0.2.1)
+    dry-initializer (3.0.4)
+    dry-logic (1.2.0)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.5, >= 0.5)
+    dry-schema (1.7.0)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.8, >= 0.8.3)
+      dry-core (~> 0.5, >= 0.5)
+      dry-initializer (~> 3.0)
+      dry-logic (~> 1.0)
+      dry-types (~> 1.5)
+    dry-struct (1.4.0)
+      dry-core (~> 0.5, >= 0.5)
+      dry-types (~> 1.5)
+      ice_nine (~> 0.11)
+    dry-types (1.5.1)
+      concurrent-ruby (~> 1.0)
+      dry-container (~> 0.3)
+      dry-core (~> 0.5, >= 0.5)
+      dry-inflector (~> 0.1, >= 0.1.2)
+      dry-logic (~> 1.0, >= 1.0.2)
+    dry-validation (1.6.0)
+      concurrent-ruby (~> 1.0)
+      dry-container (~> 0.7, >= 0.7.1)
+      dry-core (~> 0.4)
+      dry-equalizer (~> 0.2)
+      dry-initializer (~> 3.0)
+      dry-schema (~> 1.5, >= 1.5.2)
+    ice_nine (0.11.2)
+    rake (12.3.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  dry-struct
+  dry-swagger!
+  dry-validation
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 wf-janeterziev
+
+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,294 @@
+# Dry::Swagger
+
+Generate a valid and up to date swagger documentation out of your dry-structs and dry-validations
+
+The gem is still work in progress and is not yet fully tested.
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dry-swagger'
+```
+
+And then execute:
+
+    bundle install
+
+Or install it yourself as:
+
+    gem install dry-swagger
+
+## Usage
+## Dry::Validation::Contract
+    class Contract < Dry::Validation::Contract
+        json do
+            required(:required_field).value(:str?)
+            required(:required_nullable_field).maybe(:str?)
+            required(:required_filled_field).filled(:str?)
+            
+            optional(:optional_field).value(:str?)
+            optional(:optional_nullable_field).maybe(:str?)
+            optional(:optional_filled_field).filled(:str?)
+        end
+    end
+    
+    Dry::Swagger::ContractParser.new.call(Contract)
+    => {
+         "type": "object",
+         "properties": {
+           "required_field": {
+             "type": "string",
+             "nullable": false
+           },
+           "required_nullable_field": {
+             "type": "string",
+             "nullable": true
+           },
+           "required_filled_field": {
+             "type": "string",
+             "nullable": false
+           },
+           "optional_field": {
+             "type": "string",
+             "nullable": false
+           },
+           "optional_nullable_field": {
+             "type": "string",
+             "nullable": true
+           },
+           "optional_filled_field": {
+             "type": "string",
+             "nullable": false
+           }
+         },
+         "required": [
+           "required_field",
+           "required_nullable_field",
+           "required_filled_field"
+         ]
+       }
+#### With nested fields - hash or array
+    class Contract < Dry::Validation::Contract
+      json do
+        required(:array_field).array(:int?)
+        required(:array_of_hash).array(:hash) do
+          required(:field).value(:str?)
+        end
+        required(:hash_field).hash do
+          required(:field).value(:str?)
+        end
+      end
+    end
+    
+    Dry::Swagger::ContractParser.new.call(Contract)
+    => {
+         "type": "object",
+         "properties": {
+           "array_field": {
+             "type": "array",
+             "items": {
+               "type": "integer"
+             }
+           },
+           "array_of_hash": {
+             "type": "array",
+             "items": {
+               "type": "object",
+               "properties": {
+                 "field": {
+                   "type": "string",
+                   "x-nullable": false
+                 }
+               },
+               "required": [
+                 "field"
+               ]
+             }
+           },
+           "hash_field": {
+             "type": "object",
+             "properties": {
+               "field": {
+                 "type": "string",
+                 "x-nullable": false
+               }
+             },
+             "required": [
+               "field"
+             ]
+           }
+         },
+         "required": [
+           "array_field",
+           "array_of_hash",
+           "hash_field"
+         ]
+       }
+
+### With Dry::Struct
+    class DTO < Dry::Struct
+      attribute  :required_string, Types::String
+      attribute  :required_nullable_string, Types::String.optional
+      attribute  :required_string_with_enum, Types::String.enum('enum1')
+      attribute? :optional_string, Types::String
+      attribute? :optional_nullable_string, Types::String.optional
+    end
+    
+    Dry::Swagger::StructParser.new.call(DTO)
+    => {
+         "type": "object",
+         "properties": {
+           "required_string": {
+             "type": "string",
+             "x-nullable": false
+           },
+           "required_nullable_string": {
+             "type": "string",
+             "x-nullable": true
+           },
+           "required_string_with_enum": {
+             "type": "string",
+             "enum": [
+               "enum1"
+             ],
+             "x-nullable": false
+           },
+           "optional_string": {
+             "type": "string",
+             "x-nullable": false
+           },
+           "optional_nullable_string": {
+             "type": "string",
+             "x-nullable": true
+           }
+         },
+         "required": [
+           "required_string",
+           "required_nullable_string",
+           "required_string_with_enum"
+         ]
+       }
+#### With nested fields
+    {
+      "type": "object",
+      "properties": {
+        "array_of_integer": {
+          "type": "array",
+          "items": {
+            "type": "integer"
+          },
+          "x-nullable": false
+        },
+        "array_of_objects": {
+          "type": "array",
+          "items": {
+            "type": "object",
+            "properties": {
+              "required_string": {
+                "type": "string",
+                "x-nullable": false
+              },
+              "required_nullable_string": {
+                "type": "string",
+                "x-nullable": true
+              },
+              "required_string_with_enum": {
+                "type": "string",
+                "enum": [
+                  "enum1"
+                ],
+                "x-nullable": false
+              },
+              "optional_string": {
+                "type": "string",
+                "x-nullable": false
+              },
+              "optional_nullable_string": {
+                "type": "string",
+                "x-nullable": true
+              }
+            },
+            "required": [
+              "required_string",
+              "required_nullable_string",
+              "required_string_with_enum"
+            ]
+          },
+          "x-nullable": false
+        },
+        "dto": {
+          "type": "object",
+          "properties": {
+            "required_string": {
+              "type": "string",
+              "x-nullable": false
+            },
+            "required_nullable_string": {
+              "type": "string",
+              "x-nullable": true
+            },
+            "required_string_with_enum": {
+              "type": "string",
+              "enum": [
+                "enum1"
+              ],
+              "x-nullable": false
+            },
+            "optional_string": {
+              "type": "string",
+              "x-nullable": false
+            },
+            "optional_nullable_string": {
+              "type": "string",
+              "x-nullable": true
+            }
+          },
+          "required": [
+            "required_string",
+            "required_nullable_string",
+            "required_string_with_enum"
+          ],
+          "x-nullable": false
+        }
+      },
+      "required": [
+        "array_of_integer",
+        "array_of_objects",
+        "dto"
+      ]
+    }
+## Custom Configuration For Your Project
+You can override default configurations by creating a file in config/initializers/dry-swagger.rb and changing the following values.
+
+    Dry::Swagger.configuration do |config|
+      config.struct_enable_required_validation = true / false       
+      config.struct_enable_nullable_validation = true / false
+      config.struct_enable_enums = true / false
+      config.struct_enable_descriptions = true / false
+      
+      config.contract_enable_required_validation = true / false
+      config.contract_enable_nullable_validation = true / false
+      config.contract_enable_enums = true / false
+      config.contract_enable_descriptions = true / false
+      config.nullable_type = :"x-nullable" / :nullable
+    end
+By default, all these settings are true, and nullable_type is :"x-nullable".
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Jane-Terziev/dry-swagger. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/dry-swagger/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Dry::Swagger project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/dry-swagger/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "dry/swagger"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/dry-swagger.gemspec

@@ -0,0 +1,29 @@
+require_relative 'lib/dry/swagger/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dry-swagger"
+  spec.version       = Dry::Swagger::VERSION
+  spec.authors       = ["Jane-Terziev"]
+  spec.email         = ["janeterziev@gmail.com"]
+
+  spec.summary       = %q{Generate dry-validation and dry-struct into valid swagger documentation}
+  spec.description   = %q{A parser which converts dry-validation or dry-struct into valid swagger documentation}
+  spec.homepage      = "https://github.com/Jane-Terziev/dry-swagger"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/Jane-Terziev/dry-swagger"
+  spec.metadata["changelog_uri"] = "https://github.com/Jane-Terziev/dry-swagger"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

data/lib/dry/swagger.rb

@@ -0,0 +1,24 @@
+require "dry/swagger/version"
+require "dry/swagger/contract_parser"
+require "dry/swagger/struct_parser"
+require 'helpers/configuration'
+
+module Dry
+  module Swagger
+    class Error < StandardError; end
+
+    extend Configuration
+
+    define_setting :struct_enable_required_validation, true
+    define_setting :struct_enable_nullable_validation, true
+    define_setting :struct_enable_enums, true
+    define_setting :struct_enable_descriptions, true
+
+    define_setting :contract_enable_required_validation, true
+    define_setting :contract_enable_nullable_validation, true
+    define_setting :contract_enable_enums, true
+    define_setting :contract_enable_descriptions, true
+
+    define_setting :nullable_type, :"x-nullable"
+  end
+end

data/lib/dry/swagger/contract_parser.rb

@@ -0,0 +1,173 @@
+module Dry
+  module Swagger
+    class ContractParser
+      PREDICATE_TO_TYPE = {
+          array?: 'array',
+          bool?: 'boolean',
+          date?: 'date',
+          date_time?: 'datetime',
+          decimal?: 'float',
+          float?: 'float',
+          hash?: 'hash',
+          int?: 'integer',
+          nil?: 'nil',
+          str?: 'string',
+          time?: 'time'
+      }.freeze
+
+      SWAGGER_FIELD_TYPE_DEFINITIONS = {
+          "string" => { type: :string },
+          "integer" => { type: :integer },
+          "boolean" => { type: :boolean },
+          "float" => { type: :float },
+          "datetime" => { type: :string, format: :datetime },
+          "date" => { type: :string, format: :date },
+          "time" => { type: :string, format: :time },
+      }.freeze
+
+      # @api private
+      attr_reader :keys
+
+      # @api private
+      def initialize
+        @keys = {}
+      end
+
+      # @api private
+      def to_h
+        { keys: keys }
+      end
+
+      # @api private
+      def call(contract, &block)
+        @keys = {}
+        visit(contract.schema.to_ast)
+        instance_eval(&block) if block_given?
+        to_swagger
+      end
+
+      # @api private
+      def visit(node, opts = {})
+        meth, rest = node
+        public_send(:"visit_#{meth}", rest, opts)
+      end
+
+      # @api private
+      def visit_set(node, opts = {})
+        target = (key = opts[:key]) ? self.class.new : self
+
+        node.map { |child| target.visit(child, opts) }
+
+        return unless key
+
+        target_info = opts[:member] ? target.to_h : target.to_h
+        type = keys[key][:array] ? 'array' : 'hash'
+
+        keys.update(key => { **keys[key], type: type, **target_info })
+      end
+
+      # @api private
+      def visit_and(node, opts = {})
+        left, right = node
+
+        visit(left, opts)
+        visit(right, opts)
+      end
+
+      def visit_not(_node, opts = {})
+        key = opts[:key]
+        keys[key][::Dry::Swagger.nullable_type] = true if ::Dry::Swagger.contract_enable_nullable_validation
+      end
+
+      # @api private
+      def visit_implication(node, opts = {})
+        node.each do |el|
+          opts = opts.merge(required: false) if ::Dry::Swagger.contract_enable_required_validation
+          visit(el, opts)
+        end
+      end
+
+      # @api private
+      def visit_each(node, opts = {})
+        visit(node, opts.merge(member: true))
+      end
+
+      # @api private
+      def visit_key(node, opts = {})
+        name, rest = node
+        opts = opts.merge(key: name)
+        opts = opts.merge(required: true) if ::Dry::Swagger.contract_enable_required_validation
+        visit(rest, opts)
+      end
+
+      # @api private
+      def visit_predicate(node, opts = {})
+        name, rest = node
+
+        key = opts[:key]
+
+        if name.equal?(:key?)
+          keys[rest[0][1]] = { required: opts.fetch(:required, true) } if ::Dry::Swagger.contract_enable_required_validation
+        elsif name.equal?(:array?)
+          keys[key][:array] = true
+        elsif name.equal?(:included_in?)
+          keys[key][:enum] = rest[0][1]
+        elsif PREDICATE_TO_TYPE[name]
+          keys[key][:type] = PREDICATE_TO_TYPE[name]
+        else
+          description = predicate_description(name.to_s, rest[0][1].to_s)
+          if keys[key][:description].to_s.empty?
+            keys[key][:description] = description unless description.to_s.empty?
+          else
+            keys[key][:description] += ", #{description}" unless description.to_s.empty?
+          end
+        end
+      end
+
+      def predicate_description(name, validation)
+        case name
+        when 'eql?' then "Must be equal to #{validation}"
+        when 'max_size?' then "Maximum size: #{validation}"
+        when 'min_size?' then "Minimum size: #{validation}"
+        when 'gteq?' then "Greater or equal #{validation}"
+        when 'gt?' then "Greater than #{validation}"
+        when 'lt?' then "Lower than #{validation}"
+        when 'lteq?' then "Lower than or equal to #{validation}"
+        else
+          ''
+        end
+      end
+
+      def to_swagger
+        generate_documentation(keys)
+      end
+
+      private
+
+      def generate_documentation(fields)
+        documentation = { properties: {}, required: [] }
+        fields.each do |field_name, attributes_hash|
+          documentation[:properties][field_name] = generate_field_properties(attributes_hash)
+          documentation[:required] << field_name if ::Dry::Swagger.contract_enable_required_validation && attributes_hash[:required]
+        end
+        { :type => :object, :properties => documentation[:properties], :required => documentation[:required] }
+      end
+
+      def generate_field_properties(attributes_hash)
+        if attributes_hash[:type] == 'array'
+          { type: :array, items: generate_documentation(attributes_hash[:keys]) }
+        elsif attributes_hash[:array] && attributes_hash[:type] != 'array'
+          { type: :array, items: SWAGGER_FIELD_TYPE_DEFINITIONS.fetch(attributes_hash[:type]) }
+        elsif attributes_hash[:type] == 'hash'
+          generate_documentation(attributes_hash[:keys])
+        else
+          field = SWAGGER_FIELD_TYPE_DEFINITIONS.fetch(attributes_hash[:type])
+          field = field.merge(::Dry::Swagger.nullable_type => attributes_hash[::Dry::Swagger.nullable_type] | false) if ::Dry::Swagger.contract_enable_nullable_validation
+          field = field.merge(enum: attributes_hash[:enum]) if attributes_hash[:enum] if ::Dry::Swagger.contract_enable_enums
+          field = field.merge(description: attributes_hash[:description]) if attributes_hash[:description] if ::Dry::Swagger.contract_enable_descriptions
+          field
+        end
+      end
+    end
+  end
+end

data/lib/dry/swagger/struct_parser.rb

@@ -0,0 +1,82 @@
+module Dry
+  module Swagger
+    class StructParser
+      SWAGGER_FIELD_TYPE_DEFINITIONS = {
+          "String" => { type: :string },
+          "Integer" => { type: :integer },
+          "TrueClass | FalseClass" => { type: :boolean },
+          "BigDecimal" => { type: :decimal },
+          "Float" => { type: :float },
+          "DateTime" => { type: :string, format: :datetime },
+          "Date" => { type: :string, format: :date },
+          "Time" => { type: :string, format: :time }
+      }
+
+      def call(dto)
+        documentation = generate_fields_documentation(dto.schema)
+        { :type => :object, :properties => documentation[:properties], :required => documentation[:required]}
+      end
+
+      def generate_fields_documentation(dto_schema)
+        documentation = { properties: {}, required: [] }
+        dto_schema.name_key_map.each do |name, schema_key_object|
+          documentation[:properties][name] = schema_key_object.type.optional? ?
+                                                 generate_field_properties(schema_key_object.type.right, true) :
+                                                 generate_field_properties(schema_key_object.type, false)
+
+          documentation[:required] << name if ::Dry::Swagger.struct_enable_required_validation && schema_key_object.required?
+        end
+        documentation
+      end
+
+      def generate_field_properties(type, nullable)
+        field_type = type.name
+        if SWAGGER_FIELD_TYPE_DEFINITIONS[field_type] # IS PRIMITIVE FIELD?
+          definition = SWAGGER_FIELD_TYPE_DEFINITIONS[field_type]
+          definition = definition
+          if is_enum?(type.class.name) && ::Dry::Swagger.struct_enable_enums
+            enums = type.values
+            enums += [nil] if nullable
+            definition = definition.merge(enum: enums)
+          end
+        elsif is_array?(field_type)
+          definition = { type: :array }
+          if is_primitive?(type.type.member.name)
+            definition = definition
+            definition = definition.merge(items: SWAGGER_FIELD_TYPE_DEFINITIONS[type.type.member.name])
+          else
+            schema = is_array_with_dynamic_schema?(type.type.member) ? type.type.member.left : type.type.member
+            definition = definition.merge(items: call(schema))
+          end
+        else
+          schema = is_dynamic_schema?(type) ? type.left : type
+          definition = call(schema)
+        end
+
+        ::Dry::Swagger.struct_enable_nullable_validation ? definition.merge(::Dry::Swagger.nullable_type => nullable) : definition
+      end
+
+      private
+
+      def is_enum?(class_name)
+        class_name == 'Dry::Types::Enum'
+      end
+
+      def is_array?(type_name)
+        type_name == 'Array'
+      end
+
+      def is_primitive?(type_name)
+        !SWAGGER_FIELD_TYPE_DEFINITIONS[type_name].nil?
+      end
+
+      def is_array_with_dynamic_schema?(member)
+        member.respond_to?(:right)
+      end
+
+      def is_dynamic_schema?(type)
+        !type.respond_to?(:schema)
+      end
+    end
+  end
+end

data/lib/dry/swagger/types.rb

@@ -0,0 +1,7 @@
+module Dry
+  module Swagger
+    module Types
+      include Dry.Types()
+    end
+  end
+end

data/lib/dry/swagger/version.rb

@@ -0,0 +1,5 @@
+module Dry
+  module Swagger
+    VERSION = "0.3.0"
+  end
+end

data/lib/helpers/configuration.rb

@@ -0,0 +1,27 @@
+module Configuration
+
+  def configuration
+    yield self
+  end
+
+  def define_setting(name, default = nil)
+    class_variable_set("@@#{name}", default)
+
+    define_class_method "#{name}=" do |value|
+      class_variable_set("@@#{name}", value)
+    end
+
+    define_class_method name do
+      class_variable_get("@@#{name}")
+    end
+  end
+
+  private
+
+  def define_class_method(name, &block)
+    (class << self; self; end).instance_eval do
+      define_method name, &block
+    end
+  end
+
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: dry-swagger
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Jane-Terziev
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-07-31 00:00:00.000000000 Z
+dependencies: []
+description: A parser which converts dry-validation or dry-struct into valid swagger
+  documentation
+email:
+- janeterziev@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rakeTasks"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dry-swagger.gemspec
+- lib/dry/swagger.rb
+- lib/dry/swagger/contract_parser.rb
+- lib/dry/swagger/struct_parser.rb
+- lib/dry/swagger/types.rb
+- lib/dry/swagger/version.rb
+- lib/helpers/configuration.rb
+homepage: https://github.com/Jane-Terziev/dry-swagger
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/Jane-Terziev/dry-swagger
+  source_code_uri: https://github.com/Jane-Terziev/dry-swagger
+  changelog_uri: https://github.com/Jane-Terziev/dry-swagger
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Generate dry-validation and dry-struct into valid swagger documentation
+test_files: []