sober_swag 0.1.0 → 0.2.0

data/lib/sober_swag/types.rb

@@ -1,4 +1,7 @@
 module SoberSwag
+  ##
+  # Container for types.
+  # You can use constants like SoberSwag::Types::Integer and things as a result of this module existing.
   class Types
     include ::Dry::Types()
   end

data/lib/sober_swag/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SoberSwag
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/sober_swag.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/SonderMindOrg/sober_swag'
   spec.license       = 'MIT'
 
-  spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  spec.metadata['allowed_push_host'] = 'https://rubygems.org'
 
   spec.metadata['homepage_uri'] = spec.homepage
 
@@ -28,13 +28,15 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
+  spec.add_dependency 'activesupport'
   spec.add_dependency 'dry-struct', '~> 1.0'
   spec.add_dependency 'dry-types', '~> 1.2'
-  spec.add_dependency 'activesupport'
 
-  spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'simplecov'
   spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'pry'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'rubocop-rspec'
+  spec.add_development_dependency 'simplecov'
 end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: sober_swag
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Anthony Super
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-05-21 00:00:00.000000000 Z
+date: 2020-07-16 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: dry-struct
   requirement: !ruby/object:Gem::Requirement
@@ -39,19 +53,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.2'
 - !ruby/object:Gem::Dependency
-  name: activesupport
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
+        version: '2.0'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -67,61 +81,75 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rubocop-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Parse data, don't write docs
 email:
 - asuper@sondermind.com
@@ -129,6 +157,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/config/rubocop_linter_action.yml"
+- ".github/workflows/lint.yml"
 - ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
@@ -142,7 +172,9 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- docs/serializers.md
 - example/.gitignore
+- example/.rspec
 - example/.ruby-version
 - example/Gemfile
 - example/Gemfile.lock
@@ -151,10 +183,15 @@ files:
 - example/app/controllers/application_controller.rb
 - example/app/controllers/concerns/.keep
 - example/app/controllers/people_controller.rb
+- example/app/controllers/posts_controller.rb
 - example/app/jobs/application_job.rb
 - example/app/models/application_record.rb
 - example/app/models/concerns/.keep
 - example/app/models/person.rb
+- example/app/models/post.rb
+- example/app/output_objects/person_errors_output_object.rb
+- example/app/output_objects/person_output_object.rb
+- example/app/output_objects/post_output_object.rb
 - example/bin/bundle
 - example/bin/rails
 - example/bin/rake
@@ -181,27 +218,20 @@ files:
 - example/config/routes.rb
 - example/config/spring.rb
 - example/db/migrate/20200311152021_create_people.rb
+- example/db/migrate/20200603172347_create_posts.rb
 - example/db/schema.rb
 - example/db/seeds.rb
 - example/lib/tasks/.keep
 - example/log/.keep
-- example/person.json
 - example/public/robots.txt
-- example/test/controllers/.keep
-- example/test/fixtures/.keep
-- example/test/fixtures/files/.keep
-- example/test/fixtures/people.yml
-- example/test/integration/.keep
-- example/test/models/.keep
-- example/test/models/person_test.rb
-- example/test/test_helper.rb
+- example/spec/rails_helper.rb
+- example/spec/requests/people/create_spec.rb
+- example/spec/requests/people/get_spec.rb
+- example/spec/requests/people/index_spec.rb
+- example/spec/spec_helper.rb
 - example/tmp/.keep
 - example/vendor/.keep
 - lib/sober_swag.rb
-- lib/sober_swag/blueprint.rb
-- lib/sober_swag/blueprint/field.rb
-- lib/sober_swag/blueprint/field_syntax.rb
-- lib/sober_swag/blueprint/view.rb
 - lib/sober_swag/compiler.rb
 - lib/sober_swag/compiler/error.rb
 - lib/sober_swag/compiler/path.rb
@@ -212,6 +242,7 @@ files:
 - lib/sober_swag/controller/undefined_body_error.rb
 - lib/sober_swag/controller/undefined_path_error.rb
 - lib/sober_swag/controller/undefined_query_error.rb
+- lib/sober_swag/input_object.rb
 - lib/sober_swag/nodes.rb
 - lib/sober_swag/nodes/array.rb
 - lib/sober_swag/nodes/attribute.rb
@@ -224,20 +255,22 @@ files:
 - lib/sober_swag/nodes/one_of.rb
 - lib/sober_swag/nodes/primitive.rb
 - lib/sober_swag/nodes/sum.rb
+- lib/sober_swag/output_object.rb
+- lib/sober_swag/output_object/definition.rb
+- lib/sober_swag/output_object/field.rb
+- lib/sober_swag/output_object/field_syntax.rb
+- lib/sober_swag/output_object/view.rb
 - lib/sober_swag/parser.rb
-- lib/sober_swag/path.rb
-- lib/sober_swag/path/integer.rb
-- lib/sober_swag/path/lit.rb
-- lib/sober_swag/path/literal.rb
-- lib/sober_swag/path/param.rb
 - lib/sober_swag/serializer.rb
 - lib/sober_swag/serializer/array.rb
 - lib/sober_swag/serializer/base.rb
 - lib/sober_swag/serializer/conditional.rb
 - lib/sober_swag/serializer/field_list.rb
 - lib/sober_swag/serializer/mapped.rb
+- lib/sober_swag/serializer/meta.rb
 - lib/sober_swag/serializer/optional.rb
 - lib/sober_swag/serializer/primitive.rb
+- lib/sober_swag/server.rb
 - lib/sober_swag/types.rb
 - lib/sober_swag/version.rb
 - sober_swag.gemspec

data/example/person.json

@@ -1,4 +0,0 @@
-{
-  "first_name": "Tony",
-  "last_name": "Super"
-}

data/example/test/fixtures/people.yml

@@ -1,11 +0,0 @@
-# Read about fixtures at https://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
-
-one:
-  first_name: MyText
-  last_name: MyText
-  date_of_birth: 2020-03-11 09:20:21
-
-two:
-  first_name: MyText
-  last_name: MyText
-  date_of_birth: 2020-03-11 09:20:21

data/example/test/models/person_test.rb

@@ -1,7 +0,0 @@
-require 'test_helper'
-
-class PersonTest < ActiveSupport::TestCase
-  # test "the truth" do
-  #   assert true
-  # end
-end

data/example/test/test_helper.rb

@@ -1,13 +0,0 @@
-ENV['RAILS_ENV'] ||= 'test'
-require_relative '../config/environment'
-require 'rails/test_help'
-
-class ActiveSupport::TestCase
-  # Run tests in parallel with specified workers
-  parallelize(workers: :number_of_processors)
-
-  # Setup all fixtures in test/fixtures/*.yml for all tests in alphabetical order.
-  fixtures :all
-
-  # Add more helper methods to be used by all tests here...
-end

data/lib/sober_swag/blueprint.rb

@@ -1,113 +0,0 @@
-require 'sober_swag/serializer'
-
-module SoberSwag
-  ##
-  # Create a serializer that is heavily inspired by the "Blueprinter" library.
-  # This allows you to make "views" and such inside.
-  #
-  # Under the hood, this is actually all based on {SoberSwag::Serialzier::Base}.
-  class Blueprint
-    autoload(:Field, 'sober_swag/blueprint/field')
-    autoload(:FieldSyntax, 'sober_swag/blueprint/field_syntax')
-    autoload(:View, 'sober_swag/blueprint/view')
-
-    ##
-    # Use a Blueprint to define a new serializer.
-    # It will be based on {SoberSwag::Serializer::Base}.
-    #
-    # An example is illustrative:
-    #
-    #     PersonSerializer = SoberSwag::Blueprint.define do
-    #       field :id, primitive(:Integer)
-    #       field :name, primtive(:String).optional
-    #
-    #       view :complex do
-    #         field :age, primitive(:Integer)
-    #         field :title, primitive(:String)
-    #       end
-    #     end
-    #
-    # Note: This currently will generate a new *class* that does serialization.
-    # However, this is only a hack to get rid of the weird naming issue when
-    # generating swagger from dry structs: their section of the schema area
-    # is defined by their *Ruby Class Name*. In the future, if we get rid of this,
-    # we might be able to keep this on the value-level, in which case {#define}
-    # can simply return an *instance* of SoberSwag::Serializer that does
-    # the correct thing, with the name you give it. This works for now, though.
-    def self.define(&block)
-      self.new.tap { |o|
-        o.instance_eval(&block)
-      }.serializer_class
-    end
-
-    def initialize(base_fields = [])
-      @fields = base_fields.dup
-      @views = []
-    end
-
-    attr_reader :fields, :views
-
-    include FieldSyntax
-
-    def add_field!(field)
-      @fields << field
-    end
-
-    def view(name, &block)
-      @views << View.define(name, fields, &block)
-    end
-
-    ##
-    # Instead of generating a new value-level construct,
-    # this will generate a new *class*. This is so that you can
-    # name this blueprint, and have the views named as sub-classes.
-    # This is important as the type compiler uses class names
-    # for generating refs.
-    def serializer_class
-      @serializer_class ||= make_serializer_class!
-    end
-
-    private
-
-    def make_serializer_class!
-      # Klass we'll use
-      klass = Class.new(SoberSwag::Serializer::Base)
-      # The actual serialization logic is defined in a field list
-      base_serializer = SoberSwag::Serializer::FieldList.new(fields)
-      # WhateverBlueprint::Base is now used as the name for a ref
-      klass.const_set(:Base, base_serializer.type)
-      final_serializer = views.reduce(base_serializer) do |base, view|
-        view_serializer = view.serializer
-        # If we have a view :foo, its type is named
-        # WhateverBlueprint::Foo
-        klass.const_set(view.name.to_s.classify, view_serializer.type)
-        SoberSwag::Serializer::Conditional.new(
-          proc do |object, options|
-            if options[:view].to_s == view.name.to_s
-              [:left, object]
-            else
-              [:right, object]
-            end
-          end,
-          view_serializer,
-          base
-        )
-      end
-      klass.send(:define_method, :serialize) do |object, options = {}|
-        final_serializer.serialize(object, options)
-      end
-      klass.send(:define_method, :type) do
-        final_serializer.type
-      end
-      klass.send(:define_singleton_method, :type) do
-        final_serializer.type
-      end
-      klass.send(:define_singleton_method, :serializer) do
-        klass.new
-      end
-
-      klass
-    end
-
-  end
-end