dry-doc 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aee851ee5134074ba0f9278e9dca6df0cdeb4efb
-  data.tar.gz: 4a8e6e5a36521355828fd9b096dea9b320bb0c20
+  metadata.gz: 65f2898bcc0d29121f1ef94ae8a947be45b0e184
+  data.tar.gz: fc3fb4d684aa8b2112187ef42a9566688b4efd65
 SHA512:
-  metadata.gz: 9e9ce1e2dabd2da2c3dd8353ebf7aaa854c33a0450a9594cd623750ba4ab7379cc60532436d69d519f71055aab4e5d945c55bd2a20cd528176a77a80c8bf7fa2
-  data.tar.gz: ecda373413a557e0c343bd9a6dce2efe9b95a6cf7edbc7a0f49e4b5a47aaf8395898b0de68095696a969cbb5c158d12cdb2abf73594295b21bcbb59698666073
+  metadata.gz: cffa125c73f7ee00ea837b2abf781bc3d96ba3c175d0a2285ac2515db473fc39869e0b7bf56e81bd3d95f881240cc63a1a6acd85b250f58cd7524980dc538df4
+  data.tar.gz: 1e5e30e6ae417759bd6f508fdcb00100a86028375dcb160c2a7441f606aaa6de530d35d59476eeedb408ccf9dbab3fe1f7c8649ef2420e397d918d1680a9bd83

data/Gemfile

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

data/README.md

@@ -1,8 +1,78 @@
 # 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.
+```
+module MyApi
+  extend Dry::Doc::Namespace
+
+  define :User do
+    # dry-struct definitions
+    attribute :name, types::String
+    attribute :age, types::Int.optional
+  end
+
+  define :Post do
+    attribute :author, types.instance(User)
+    attribute :title, types::String
+    attribute :body, types::String
+    attribute :created_at, types::DateTime
+  end
+end
+```
+
+Get serializable objects that check their input
+
+```
+u = MyApi::User.new(name: 'James', age: nil)
+u.as_json
+# => { name: "James", age: nil}
+
+v = MyApi::User.new(name: 0, age: '')
+# => Dry::Struct::Error: [MyApi::User.new] :name is missing in Hash input
+
+p = MyApi::Post.new(author: u, title: '...', body: '...', created_at: DateTime.now).as_json
+# => { author: { name: "James", age: null }, title: "...", body: "...", created_at: "..." }
+
+```
+
+and provide an open api definition (with e.g. `JSON.pretty_generate MyApi.as_open_api`)
+
+```
+{
+  "definitions": {
+    "User": {
+      "type": "object",
+      "properties": {
+        "name": {
+          "type": "string"
+        },
+        "age": {
+          "nullable": true,
+          "type": "integer"
+        }
+      }
+    },
+    "Post": {
+      "type": "object",
+      "properties": {
+        "author": {
+          "ref": "#/definitions/User"
+        },
+        "title": {
+          "type": "string"
+        },
+        "body": {
+          "type": "string"
+        },
+        "created_at": {
+          "type": "string",
+          "format": "date-time"
+        }
+      }
+    }
+  }
+}
+```
 
-TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
@@ -22,7 +92,7 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+See the specs for further examples. This currently implements just enough to get by, but the eventual hope is to be fully compatible with the OpenAPI spec.
 
 ## Development
 

data/lib/dry/doc.rb

@@ -5,10 +5,41 @@ require 'dry/doc/version'
 module Dry
   module Doc
     NotImplemented = Class.new ::NotImplementedError
+
+    T = ::Dry::Types.module
+    Types = ::Dry::Doc::T::Strict
+
+    module Types
+      def self.instance klass
+        ::Dry::Doc::T::Constructor klass
+      end
+
+      def self.constant value
+        ::Dry::Doc::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::Types::Array.member type
+      end
+    end
+
+    Inlines = Set.new
+    def self.inline klass
+      Inlines.add klass
+    end
+    def self.inline? klass
+      Inlines.include? klass
+    end
   end
 end
 
-require 'dry/doc/value'
+require 'dry/doc/object'
 require 'dry/doc/schema'
 require 'dry/doc/namespace'
 

data/lib/dry/doc/namespace.rb

@@ -1,23 +1,55 @@
 module Dry::Doc
+  class Type
+    attr_accessor :ref
+
+    def initialize inner
+      @inner = inner
+    end
+
+    def call *args
+      @inner.call *args
+    end
+
+    def as_open_api
+      # TODO: this smells
+      ::Dry::Doc::Schema::Field.new(
+        type: @inner,
+        description: nil
+      ).as_json
+    end
+
+    def name
+      ref
+    end
+
+    def to_ast *args
+      @inner.to_ast *args
+    end
+
+    def inspect
+      "<#{name}>"
+    end
+  end
+
   module Namespace
     def definitions
       @_definitions ||= []
     end
 
     def define name, &config
-      klass = Class.new ::Dry::Doc::Value do |c|
-        @ref = name
+      klass = Class.new ::Dry::Doc::Object do |c|
         class_exec &config
       end
-      klass.define_singleton_method(:name) { name }
+      register name, klass 
+    end
 
-      const_set name, klass 
-      definitions.push klass
-      klass
+    def type name, inner
+      klass = ::Dry::Doc::Type.new inner
+      register name, klass
     end
 
     def types
-      ::Dry::Doc::Value::Types
+      ::Dry::Doc::Types
     end
 
     def as_open_api
@@ -28,8 +60,19 @@ module Dry::Doc
       end
 
       { 
-        definitions: defs
+        schemas: defs
       }
     end
+
+    private
+
+    def register name, klass
+      klass.ref = name
+      klass.freeze
+
+      const_set name, klass
+      definitions.push klass
+      klass
+    end
   end
 end

data/lib/dry/doc/object.rb

@@ -0,0 +1,52 @@
+class Dry::Doc::Object < ::Dry::Struct
+  class << self
+    attr_accessor :ref
+
+    def doc
+      @_doc ||= ::Dry::Doc::Schema.new self
+    end
+
+    def types
+      ::Dry::Doc::Types
+    end
+
+    def as_open_api
+      doc.as_json
+    end
+
+    def name
+      ref
+    end
+
+    def attribute name, type=nil, opts={}, &nested
+      if nested
+        opts = type || {}
+        inline_class = build_type :"#{self.name}::#{name}", &nested
+        ::Dry::Doc.inline 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::Object do |klass|
+        class_exec &config
+        define_singleton_method(:name) { name }
+      end
+    end
+  end
+
+  def as_json *_
+    to_h
+  end
+end

data/lib/dry/doc/schema.rb

@@ -1,11 +1,10 @@
 class Dry::Doc::Schema
   ::Dry::Doc::UnknownPrimitive = Class.new ::Dry::Doc::NotImplemented
 
-  Nullable = :"x-nullable"
-  T = ::Dry::Doc::Value::Types
+  T = ::Dry::Doc::Types
 
   class Field < ::Dry::Struct
-    attribute :type, Object
+    attribute :type, ::Object
     attribute :description, T::String.optional
 
     def as_json
@@ -17,7 +16,43 @@ class Dry::Doc::Schema
 
     private
 
-    BOOL_AST = ::Dry::Doc::Value::Types::Bool.to_ast[1][0 .. -2]
+    BOOL_AST = ::Dry::Doc::Types::Bool.to_ast[1][0 .. -2]
+
+    def apply_constraint acc, con
+      if con.first == :and
+        con[1].reduce(acc) { |a, c| apply_constraint a, c}
+      elsif con.first == :predicate
+        apply_predicate acc, con[1]
+      else
+        # TODO: ignore?
+        acc
+      end
+    end
+
+    def restrict_enum acc, list
+      if acc[:enum]
+        acc[:enum] = acc[:enum] & list
+      else
+        acc[:enum] = list
+      end
+      acc
+    end
+
+    def apply_predicate acc, pred
+      case pred.first
+      when :type?
+        # These are (presumably) handled by `definition`
+        acc
+      when :included_in?
+        list = pred[1][0][1] # TODO: is this always true?
+        restrict_enum acc, list
+      when :is?
+        list = [pred[1][0][1]] # TODO: is this always true?
+        restrict_enum acc, list
+      else
+        acc
+      end
+    end
 
     def walk_ast ast, acc
       kind, data = ast
@@ -34,7 +69,9 @@ class Dry::Doc::Schema
 
       when :constrained
         type, *constraints, _meta = data
-        # FIXME: note `is?` constraints
+        acc = constraints.reduce(acc) do |a, con|
+          apply_constraint a, con
+        end
         return walk_ast type, acc
 
       when :constructor
@@ -44,10 +81,10 @@ class Dry::Doc::Schema
       when :definition
         primitive, _meta = data
 
-        if T.inline? primitive
+        if ::Dry::Doc.inline? primitive
           return acc.merge primitive.as_open_api
         elsif primitive.respond_to?(:ref) && primitive.ref
-          return acc.merge ref: primitive.ref
+          return acc.merge '$ref': "#/components/schemas/#{primitive.ref}"
         elsif primitive == Integer
           return acc.merge type: :integer
         elsif primitive == String
@@ -75,7 +112,7 @@ class Dry::Doc::Schema
         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[:nullable] = true
           acc = acc.merge non_nils.first
         else
           acc = acc.merge oneOf: non_nils
@@ -85,7 +122,6 @@ class Dry::Doc::Schema
       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
 

data/lib/dry/doc/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dry-doc
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - James Dabbs
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-10 00:00:00.000000000 Z
+date: 2018-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -114,8 +114,8 @@ files:
 - dry-doc.gemspec
 - lib/dry/doc.rb
 - lib/dry/doc/namespace.rb
+- lib/dry/doc/object.rb
 - lib/dry/doc/schema.rb
-- lib/dry/doc/value.rb
 - lib/dry/doc/version.rb
 homepage: https://github.com/jamesdabbs/dry-doc
 licenses:

data/lib/dry/doc/value.rb

@@ -1,79 +0,0 @@
-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