dry-doc 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: aee851ee5134074ba0f9278e9dca6df0cdeb4efb
+  data.tar.gz: 4a8e6e5a36521355828fd9b096dea9b320bb0c20
+SHA512:
+  metadata.gz: 9e9ce1e2dabd2da2c3dd8353ebf7aaa854c33a0450a9594cd623750ba4ab7379cc60532436d69d519f71055aab4e5d945c55bd2a20cd528176a77a80c8bf7fa2
+  data.tar.gz: ecda373413a557e0c343bd9a6dce2efe9b95a6cf7edbc7a0f49e4b5a47aaf8395898b0de68095696a969cbb5c158d12cdb2abf73594295b21bcbb59698666073

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.14.6

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 jamesdabbs@gmail.com. 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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dry-doc.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 James Dabbs
+
+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,41 @@
+# Dry::Doc
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/dry/doc`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dry-doc'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dry-doc
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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/jamesdabbs/dry-doc. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

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,10 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "dry/doc"
+
+# 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.
+
+require "pry"
+Pry.start

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-doc.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dry/doc/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dry-doc"
+  spec.version       = Dry::Doc::VERSION
+  spec.authors       = ["James Dabbs"]
+  spec.email         = ["jamesdabbs@gmail.com"]
+
+  spec.summary       = %q{Dry::Structs with swagger}
+  spec.homepage      = 'https://github.com/jamesdabbs/dry-doc'
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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"]
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'pry', '~> 0.11'
+  spec.add_development_dependency 'simplecov', '~> 0.16'
+
+  spec.add_runtime_dependency 'dry-struct', '~> 0.3'
+end

data/lib/dry/doc/namespace.rb

@@ -0,0 +1,35 @@
+module Dry::Doc
+  module Namespace
+    def definitions
+      @_definitions ||= []
+    end
+
+    def define name, &config
+      klass = Class.new ::Dry::Doc::Value do |c|
+        @ref = name
+        class_exec &config
+      end
+      klass.define_singleton_method(:name) { name }
+
+      const_set name, klass 
+      definitions.push klass
+      klass
+    end
+
+    def types
+      ::Dry::Doc::Value::Types
+    end
+
+    def as_open_api
+      definitions.freeze
+
+      defs = definitions.each_with_object({}) do |d, h|
+        h[d.name] = d.as_open_api
+      end
+
+      { 
+        definitions: defs
+      }
+    end
+  end
+end

data/lib/dry/doc/schema.rb

@@ -0,0 +1,116 @@
+class Dry::Doc::Schema
+  ::Dry::Doc::UnknownPrimitive = Class.new ::Dry::Doc::NotImplemented
+
+  Nullable = :"x-nullable"
+  T = ::Dry::Doc::Value::Types
+
+  class Field < ::Dry::Struct
+    attribute :type, Object
+    attribute :description, T::String.optional
+
+    def as_json
+      ast = type.respond_to?(:to_ast) ? type.to_ast : type
+      base = walk_ast(ast, {})
+      base[:description] = description if description
+      base
+    end
+
+    private
+
+    BOOL_AST = ::Dry::Doc::Value::Types::Bool.to_ast[1][0 .. -2]
+
+    def walk_ast ast, acc
+      kind, data = ast
+
+      # TODO: compare with 
+      # https://github.com/dry-rb/dry-types/blob/d6e50bf54c42dd54ffc0e813738978f58bbfbfa7/lib/dry/types/compiler.rb
+      # and see if we can clean this up and cover all the possibilities
+      case kind
+      when :array
+        type, _meta = data
+        acc[:type] = 'array'
+        acc[:items] = walk_ast type, {}
+        return acc
+
+      when :constrained
+        type, *constraints, _meta = data
+        # FIXME: note `is?` constraints
+        return walk_ast type, acc
+
+      when :constructor
+        definition, _cons, _meta = data
+        return walk_ast definition, acc
+
+      when :definition
+        primitive, _meta = data
+
+        if T.inline? primitive
+          return acc.merge primitive.as_open_api
+        elsif primitive.respond_to?(:ref) && primitive.ref
+          return acc.merge ref: primitive.ref
+        elsif primitive == Integer
+          return acc.merge type: :integer
+        elsif primitive == String
+          return acc.merge type: :string
+        elsif primitive == NilClass
+          return acc.merge type: nil
+        elsif primitive == DateTime
+          return acc.merge type: :string, format: :'date-time'
+        elsif primitive == Date
+          return acc.merge type: :string, format: :date
+        else
+          # TODO: allow plugins for handling custom types
+          # :nocov:
+          raise ::Dry::Doc::UnknownPrimitive, primitive
+          # :nocov:
+        end
+
+      when :sum
+        *nodes, _meta = data
+
+        if nodes == BOOL_AST
+          return acc.merge type: :boolean
+        end
+
+        types = nodes.map { |i| walk_ast i, {} }
+        nils, non_nils = types.partition { |t| t.key?(:type) && t[:type].nil? }
+        if nils.length == 1 && non_nils.length == 1
+          acc[:'x-nullable'] = true
+          acc = acc.merge non_nils.first
+        else
+          acc = acc.merge oneOf: non_nils
+        end
+        return acc
+
+      when :enum
+        inner, _meta = data
+        acc = walk_ast inner, acc
+        acc[:values] = self.type.values # FIXME: this needs to look at the AST
+        return acc
+      end
+
+      # :nocov:
+      raise ::Dry::Doc::NotImplemented, "AST kind: #{kind} | #{data}"
+      # :nocov:
+    end
+  end
+
+  attr_reader :klass
+
+  def initialize klass
+    @klass, @properties = klass, {}
+  end
+
+  def register name, type, description:
+    @properties[name] = Field.new \
+      type:        type,
+      description: description
+  end
+
+  def as_json
+    { 
+      type: :object,
+      properties: @properties.transform_values(&:as_json)
+    }
+  end
+end

data/lib/dry/doc/value.rb

@@ -0,0 +1,79 @@
+class Dry::Doc::Value < ::Dry::Struct
+  T = ::Dry::Types.module
+  Types = ::Dry::Doc::Value::T::Strict
+
+  module Types
+    Inlines = Set.new
+
+    def self.instance klass
+      ::Dry::Doc::Value::T::Constructor klass
+    end
+
+    def self.constant value
+      ::Dry::Doc::Value::T::Constant value
+    end
+
+    def self.sum left, right
+      left  = instance left unless left.respond_to? :to_ast
+      right = instance right unless right.respond_to? :to_ast
+      ::Dry::Types::Sum.new left, right
+    end
+
+    def self.[] type
+      ::Dry::Doc::Value::Types::Array.member type
+    end
+
+    def self.inline? klass
+      ::Dry::Doc::Value::Types::Inlines.include? klass
+    end
+  end
+
+  class << self
+    def doc
+      @_doc ||= ::Dry::Doc::Schema.new self
+    end
+
+    def types
+      ::Dry::Doc::Value::Types
+    end
+
+    def as_open_api
+      doc.as_json
+    end
+
+    def ref
+      "#/definitions/#{@ref}" if @ref
+    end
+
+    def attribute name, type=nil, opts={}, &nested
+      if nested
+        opts = type || {}
+        inline_class = build_type :"#{self.name}::#{name}", &nested
+        ::Dry::Doc::Value::Types::Inlines.add inline_class
+        type = types.instance inline_class
+        type = type.optional if opts[:optional]
+      end
+
+      doc.register name, type, 
+        description: opts.delete(:description)
+      super name, type
+    end
+
+    def inspect
+      "<#{name}>"
+    end
+
+    private
+
+    def build_type name, &config
+      Class.new ::Dry::Doc::Value do |klass|
+        class_exec &config
+        define_singleton_method(:name) { name }
+      end
+    end
+  end
+
+  def as_json *_
+    to_h
+  end
+end

data/lib/dry/doc/version.rb

@@ -0,0 +1,5 @@
+module Dry
+  module Doc
+    VERSION = '0.0.1'.freeze
+  end
+end

data/lib/dry/doc.rb

@@ -0,0 +1,14 @@
+require 'dry-struct'
+
+require 'dry/doc/version'
+
+module Dry
+  module Doc
+    NotImplemented = Class.new ::NotImplementedError
+  end
+end
+
+require 'dry/doc/value'
+require 'dry/doc/schema'
+require 'dry/doc/namespace'
+

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: dry-doc
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- James Dabbs
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: dry-struct
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+description: 
+email:
+- jamesdabbs@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dry-doc.gemspec
+- lib/dry/doc.rb
+- lib/dry/doc/namespace.rb
+- lib/dry/doc/schema.rb
+- lib/dry/doc/value.rb
+- lib/dry/doc/version.rb
+homepage: https://github.com/jamesdabbs/dry-doc
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Dry::Structs with swagger
+test_files: []