sober_swag 0.20.0 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 97cb4bbfd84f28f6f79368c3f78182835217868a1d3142c38107ab3b03552952
-  data.tar.gz: 1cd8446250a8ddadc16eb114a773b9d317c2182e2bcb8c692c59681331ef972b
+  metadata.gz: f9dce6daadaff9f7ddb1530ecf5fa69693454a29f04da849eec9bea8969166bc
+  data.tar.gz: a6cd16e93640b2d9c27fab081c3551d8498643044a6ebf9cab8100b51d8d916d
 SHA512:
-  metadata.gz: f6b055ea451db16f12a02ebe2bc6da459aefcf13605a54f4f0b0cff8aa694b73e2c4cb2c2f759a89c859a820a74a37391728998e0939a770cda2783c2190586e
-  data.tar.gz: 3a49c153297750447c2776b086da135b81c80a1b628780d9a7ab6f68f204ddeaa3b21e08ffd02f8a49e92f1a7ac5942b0e42d295307299e8623ebb6a765731dd
+  metadata.gz: fb2dcb7bee3b89e643b3e5d2d1e3d5b7034161ae563de59909120a3f4c817a8f14ab88d5d1968efb2b914b068cf0370d41f9094bbec7ae8ef96a87dfe3ad64fd
+  data.tar.gz: bfc9bfe3b4e93dca2a774e416496d430dfa63185acc82db780cc4f26d7eec1ff2a6db0f10103fd962243ab46b9799b8e6536dd94cc07758b5f52ea07af71df67

data/.github/workflows/benchmark.yml

@@ -0,0 +1,39 @@
+name: Ruby Benchmark
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  benchmark:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [ '2.6', '2.7', '3.0' ]
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+    - uses: actions/cache@v2
+      with:
+        path: vendor/bundle
+        key: ${{ runner.os }}-${{ matrix.ruby }}-gem-deps-${{ hashFiles('**/Gemfile.lock') }}
+        restore-keys: |
+          ${{ runner.os }}-${{ matrix.ruby }}-gem-deps-
+    - name: Install dependencies
+      run: |
+        bundle config path vendor/bundle
+        bundle install
+    - name: Run Benchmark
+      run: bundle exec ruby bench/benchmark.rb
+    - uses: actions/upload-artifact@v2
+      with:
+        name: benchmark-result
+        path: benchmark_results.yaml
+        if-no-files-found: error

data/.github/workflows/lint.yml

@@ -14,13 +14,11 @@ on:
     branches: [ master ]
 
 jobs:
-  test:
-
+  lint:
     runs-on: ubuntu-latest
     strategy:
       matrix:
         ruby: [ '2.6', '2.7', '3.0' ]
-
     steps:
     - uses: actions/checkout@v2
     - name: Set up Ruby

data/.gitignore

@@ -17,3 +17,4 @@ Gemfile.lock
 /vendor/
 
 .yardoc
+benchmark_results.yaml

data/CHANGELOG.md

@@ -1,9 +1,17 @@
 # Changelog
 
+## [v0.21.0] 2021-09-02
+
+- Added a new method of serializing views based on hash lookups, improving performance
+- Added a benchmarking suite
+- Added `except` parameter to the `merge` method, which allows a specified field to be excluded from the merge.
+- Add `type_key` to output objects, for easily serializing out type fields with a constant string.
+- Added `type_attribute` to `SoberSwag::InputObject` to add easy constant-value disambiguation.
+
 ## [v0.20.0] 2021-05-17
 
 - Added YARD documentation to almost every method
-- Added `except` parameter to the `merge` method, which allows a specified field to be excluded from the merge.
+
 
 ## [v0.19.0] 2021-03-10
 

data/Gemfile

@@ -12,3 +12,7 @@ gem 'redcarpet'
 gem 'yard-activesupport-concern'
 
 gem 'solargraph'
+
+gem 'benchmark-ips'
+
+gem 'rspec-its'

data/bench/benchmark.rb

@@ -0,0 +1,34 @@
+require 'bundler/setup'
+
+require 'sober_swag'
+
+require 'yaml'
+require 'benchmark/ips'
+
+##
+# Quick and dirty way to benchmark things.
+class Bench
+  class << self
+    def report(name, &block)
+      puts name
+
+      data[name] ||= Benchmark.ips(&block).data
+    end
+
+    def data
+      @data ||= {}
+    end
+
+    def write!(filename)
+      File.open(filename, 'w') do |f|
+        f << YAML.dump(data)
+      end
+    end
+  end
+end
+
+Dir['bench/benchmarks/**/*.rb'].sort.each do |file|
+  require_relative file.gsub(%r{^bench/}, '')
+end
+
+Bench.write!('benchmark_results.yaml')

data/bench/benchmarks/basic_field_serializer.rb

@@ -0,0 +1,21 @@
+##
+# Bench test for serializing multiple fields.
+class BasicFieldSerializer
+  Idea = Struct.new(:name, :grade, :cool)
+
+  Output = SoberSwag::OutputObject.define do
+    field :name, primitive(:String)
+    field :grade, primitive(:Integer)
+    field :cool, primitive(:Bool)
+  end
+
+  OutputSerializer = Output.serializer
+
+  MyIdea = Idea.new('Bob', 12, false)
+
+  Bench.report 'Basic Field Serializers' do |bm|
+    bm.report('Output Object') { Output.serialize(MyIdea) }
+    bm.report('Serializer of Output Object') { OutputSerializer.serialize(MyIdea) }
+    bm.compare!
+  end
+end

data/bench/benchmarks/view_selection.rb

@@ -0,0 +1,47 @@
+##
+# Benchmark for speed of selecting what view to use.
+class ViewSelection
+  Accomplishment = Struct.new(:name, :description)
+  Person = Struct.new(:first_name, :last_name, :accomplishments)
+
+  MyPerson = Person.new(
+    'Joeseph',
+    'Biden',
+    [
+      Accomplishment.new('Became President', 'Won a Presidential Election'),
+      Accomplishment.new('Oldest President', 'Oldest man to be elected president at time of election'),
+      Accomplishment.new('Became Senator', 'Got Elected to the Senate'),
+      Accomplishment.new('Youngest Senator', 'Youngest person elected Senator at time of election')
+    ]
+  )
+
+  AccomplishmentSerializer = SoberSwag::OutputObject.define do
+    field :name, primitive(:String)
+
+    view :detail do
+      field :description, primitive(:String)
+    end
+  end
+
+  PersonSerializer = SoberSwag::OutputObject.define do
+    field :first_name, primitive(:String)
+    field :last_name, primitive(:String)
+
+    # make a bunch of dummy views
+    1.upto(10).each { |n| view(:"view_#{n}") {} }
+
+    view :detail do
+      field :accomplishments, AccomplishmentSerializer.view(:detail)
+    end
+
+    1.upto(10).each { |n| view(:"view_after_#{n}") {} }
+  end
+
+  Bench.report 'View Selection' do |bm|
+    bm.report('With no view') { PersonSerializer.serialize(MyPerson) }
+
+    bm.report('With a view') { PersonSerializer.serialize(MyPerson, { view: :detail }) }
+
+    bm.compare!
+  end
+end

data/docs/serializers.md

@@ -105,7 +105,7 @@ This changes the type properly too.
 
 98% of the time, when we're writing web APIs, we want to transform our domain objects into JSON objects.
 We often want different ways to do this, too.
-Consider, for exmaple, and API for a college.
+Consider, for example, an API for a college.
 We might want to provide one detailed way to serialize a student, which includes their full name, grade, student ID, GPA, and so on.
 On another page, we might want to display a classroom with a list of students.
 However, on the classroom page, we don't want to serialize a full student: that's sending too much data.

data/example/Gemfile

@@ -8,7 +8,7 @@ gem 'actionpack', '>= 6.0.3.2'
 # Use sqlite3 as the database for Active Record
 gem 'sqlite3', '~> 1.4'
 # Use Puma as the app server
-gem 'puma', '~> 5.2'
+gem 'puma', '~> 5.3'
 # Build JSON APIs with ease. Read more: https://github.com/rails/jbuilder
 # gem 'jbuilder', '~> 2.7'
 # Use Active Model has_secure_password
@@ -34,7 +34,7 @@ group :development, :test do
 end
 
 group :development do
-  gem 'listen', '>= 3.0.5', '< 3.6'
+  gem 'listen', '>= 3.0.5', '< 3.7'
   # Spring speeds up development by keeping your application running in the background. Read more: https://github.com/rails/spring
   gem 'spring'
   gem 'spring-watcher-listen', '~> 2.0.0'

data/example/Gemfile.lock

@@ -64,7 +64,7 @@ GEM
       minitest (~> 5.1)
       tzinfo (~> 1.1)
       zeitwerk (~> 2.2, >= 2.2.2)
-    bootsnap (1.7.3)
+    bootsnap (1.7.5)
       msgpack (~> 1.0)
     builder (3.2.4)
     byebug (11.1.3)
@@ -103,13 +103,13 @@ GEM
       dry-types (>= 0.8.1)
       rails (>= 3)
     erubi (1.10.0)
-    ffi (1.15.0)
+    ffi (1.15.3)
     globalid (0.4.2)
       activesupport (>= 4.2.0)
     i18n (1.8.9)
       concurrent-ruby (~> 1.0)
     ice_nine (0.11.2)
-    listen (3.5.0)
+    listen (3.6.0)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
     loofah (2.9.0)
@@ -124,17 +124,17 @@ GEM
       nokogiri (~> 1)
       rake
     mini_mime (1.0.2)
-    mini_portile2 (2.5.0)
+    mini_portile2 (2.5.1)
     minitest (5.14.4)
     msgpack (1.4.2)
     nio4r (2.5.7)
-    nokogiri (1.11.2)
+    nokogiri (1.11.5)
       mini_portile2 (~> 2.5.0)
       racc (~> 1.4)
-    pry (0.14.0)
+    pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    puma (5.2.2)
+    puma (5.3.2)
       nio4r (~> 2.0)
     racc (1.5.2)
     rack (2.2.3)
@@ -167,7 +167,7 @@ GEM
       rake (>= 0.8.7)
       thor (>= 0.20.3, < 2.0)
     rake (13.0.3)
-    rb-fsevent (0.10.4)
+    rb-fsevent (0.11.0)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
     rspec-core (3.10.1)
@@ -216,9 +216,9 @@ DEPENDENCIES
   bootsnap (>= 1.4.2)
   byebug
   dry-types-rails
-  listen (>= 3.0.5, < 3.6)
+  listen (>= 3.0.5, < 3.7)
   pry
-  puma (~> 5.2)
+  puma (~> 5.3)
   rails (~> 6.0.2, >= 6.0.2.2)
   rspec-rails
   sober_swag!

data/lib/sober_swag/input_object.rb

@@ -46,6 +46,40 @@ module SoberSwag
         super(key, parent, &block)
       end
 
+      ##
+      # Add on an attribute which only ever parses from a constant value.
+      # By default, this attribute will be called `type`, but you can override it with the kwarg.
+      # This is useful in situations where you want to emulate a sum type.
+      # For example, if you want to make an API endpoint that can either accept or reject proposals
+      #
+      # ```ruby
+      #
+      # ApiInputType = SoberSwag.input_object {
+      #   identifier 'AcceptProposal'
+      #   type_attribute 'accept'
+      #   attribute(:message, primitive(:String))
+      # } | SoberSwag.input_object {
+      #   identifier 'RejectProposal'
+      #   type_attribute 'reject'
+      #   attribute(:message, primitive(:String))
+      # }
+      # ```
+      #
+      # Under the hood, this basically looks like:
+      #
+      # ```ruby
+      # type_attribute 'archive'
+      # # is equivalent to
+      #
+      # attribute(:type, SoberSwag::Types::String.enum('archive'))
+      # ```
+      #
+      # @param value [String,Symbol] the value to parse
+      # @param attribute_key [Symbol] what key to use
+      def type_attribute(value, attribute_key: :type)
+        attribute(attribute_key, SoberSwag::Types::String.enum(value.to_s))
+      end
+
       ##
       # @overload attribute(key, parent = SoberSwag::InputObject, &block)
       #   Defines an optional attribute by defining a sub-object inline.

data/lib/sober_swag/output_object/definition.rb

@@ -19,6 +19,32 @@ module SoberSwag
 
       include FieldSyntax
 
+      ##
+      # Adds a "type key", which is basically a field that will be
+      # serialized out to a constant value.
+      #
+      # This is useful if you have multiple types you may want to serialize out, and want consumers of your API to distinguish between them.
+      #
+      # By default this will have the key "type" but you can set it with the keyword arg.
+      # ```ruby
+      #   type_key('MyObject')
+      #   # is equivalent to
+      #   field :type, SoberSwag::Serializer::Primitive.new(SoberSwag::Types::String.enum('MyObject')) do |_, _|
+      #   'MyObject'
+      #   end
+      # ```
+      # @param str [String, Symbol] the value to serialize (will be converted to a string)
+      # @param
+      def type_key(str, field_name: :type)
+        str = str.to_s
+        field(
+          field_name,
+          SoberSwag::Serializer::Primitive.new(
+            SoberSwag::Types::String.enum(str)
+          )
+        ) { |_, _| str }
+      end
+
       ##
       # Adds a new field to the fields array
       # @param field [SoberSwag::OutputObject::Field]

data/lib/sober_swag/output_object.rb

@@ -37,6 +37,7 @@ module SoberSwag
     # the correct thing, with the name you give it. This works for now, though.
     #
     # @return [Class] the serializer generated.
+    # @yieldself [SoberSwag::OutputObject::Definition]
     def self.define(&block)
       d = Definition.new.tap do |o|
         o.instance_eval(&block)
@@ -99,23 +100,12 @@ module SoberSwag
     # and {SoberSwag::Serializer::FieldList} to do the actual serialization.
     #
     # @todo: optimize view selection to use binary instead of linear search
-    def serializer # rubocop:disable Metrics/MethodLength
+    def serializer
       @serializer ||=
         begin
-          views.reduce(base_serializer) do |base, view|
-            view_serializer = view.serializer
-            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
+          view_choices = views.map { |view| [view.name.to_s, view.serializer] }.to_h
+          view_choices['base'] = base_serializer
+          SoberSwag::Serializer::Hash.new(view_choices, base, proc { |_, options| options[:view]&.to_s })
         end
     end
 

data/lib/sober_swag/serializer/field_list.rb

@@ -27,9 +27,11 @@ module SoberSwag
       # @param options [Hash] arbitrary options
       # @return [Hash] serialized object.
       def serialize(object, options = {})
-        field_list.map { |field|
-          [field.name, field.serializer.serialize(object, options)]
-        }.to_h
+        {}.tap do |hash|
+          field_list.each do |field|
+            hash[field.name] = field.serializer.serialize(object, options)
+          end
+        end
       end
 
       ##

data/lib/sober_swag/serializer/hash.rb

@@ -0,0 +1,53 @@
+require 'set'
+
+module SoberSwag
+  module Serializer
+    ##
+    # Serialize via hash lookup.
+    # This is used to speed up serialization of views, but it may be useful elsewhere.
+    #
+    class Hash < Base
+      ##
+      # @param choices [Hash<Object => SoberSwag::Serializer::Base>] hash of serializers
+      #   that we might use.
+      # @param default [SoberSwag::Serializer::Base] default to use if key not found.
+      # @param key_proc [Proc<Object, Hash>] extract the key we are interested in from the proc.
+      #   Will be called with the object to serialize and the options hash.
+      def initialize(choices, default, key_proc)
+        @choices = choices
+        @default = default
+        @key_proc = key_proc
+      end
+
+      attr_reader :choices, :default, :key_proc
+
+      def serialize(object, options = {})
+        key = key_proc.call(object, options)
+
+        choices.fetch(key) { default }.serialize(object, options)
+      end
+
+      ##
+      # @return [Set<SoberSwag::Serializer::Base>]
+      def possible_serializers
+        @possible_serializers ||= (choices.values + [default]).to_set
+      end
+
+      def lazy_type?
+        possible_serializers.any?(&:lazy_type?)
+      end
+
+      def finalize_lazy_type!
+        possible_serializers.each(&:finalize_lazy_type!)
+      end
+
+      def lazy_type
+        @lazy_type ||= possible_serializers.map(&:lazy_type).reduce(:|)
+      end
+
+      def type
+        @type ||= possible_serializers.map(&:type).reduce(:|)
+      end
+    end
+  end
+end

data/lib/sober_swag/serializer.rb

@@ -10,6 +10,7 @@ module SoberSwag
     autoload(:Mapped, 'sober_swag/serializer/mapped')
     autoload(:Optional, 'sober_swag/serializer/optional')
     autoload(:FieldList, 'sober_swag/serializer/field_list')
+    autoload(:Hash, 'sober_swag/serializer/hash')
     autoload(:Meta, 'sober_swag/serializer/meta')
 
     class << self

data/lib/sober_swag/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sober_swag
 version: !ruby/object:Gem::Version
-  version: 0.20.0
+  version: 0.21.0
 platform: ruby
 authors:
 - Anthony Super
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-05-17 00:00:00.000000000 Z
+date: 2021-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -173,6 +173,7 @@ extra_rdoc_files: []
 files:
 - ".github/config/rubocop_linter_action.yml"
 - ".github/dependabot.yml"
+- ".github/workflows/benchmark.yml"
 - ".github/workflows/lint.yml"
 - ".github/workflows/ruby.yml"
 - ".gitignore"
@@ -186,6 +187,9 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bench/benchmark.rb
+- bench/benchmarks/basic_field_serializer.rb
+- bench/benchmarks/view_selection.rb
 - bin/console
 - bin/rspec
 - bin/setup
@@ -284,6 +288,7 @@ files:
 - lib/sober_swag/serializer/base.rb
 - lib/sober_swag/serializer/conditional.rb
 - lib/sober_swag/serializer/field_list.rb
+- lib/sober_swag/serializer/hash.rb
 - lib/sober_swag/serializer/mapped.rb
 - lib/sober_swag/serializer/meta.rb
 - lib/sober_swag/serializer/optional.rb