sober_swag 0.17.0 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a0e2ee1acc571a7f6a90db87f4c15b6d7d820f24b75abd3f37cb369d431f271
-  data.tar.gz: 6384f275b7b1bd21ef35f4972b519be59a19d1a5e24a5c2138e203748a9702bb
+  metadata.gz: f9dce6daadaff9f7ddb1530ecf5fa69693454a29f04da849eec9bea8969166bc
+  data.tar.gz: a6cd16e93640b2d9c27fab081c3551d8498643044a6ebf9cab8100b51d8d916d
 SHA512:
-  metadata.gz: c1d8b82b62dc05656482b0e550bc5edb24cdf76dde9dc9bcd4729381c5439983df7e98704eb9a0d54964f70297c8097b8192a016736db5ffff3126849d5425e9
-  data.tar.gz: f55485cc2dd04c4dd414b7c2b5668be91d1c8ada7ad51cf20d04bad62925054d27f940caf83c6c83e1763928c3ea5295d9c592b7a83f85e133cdfbaca697652c
+  metadata.gz: fb2dcb7bee3b89e643b3e5d2d1e3d5b7034161ae563de59909120a3f4c817a8f14ab88d5d1968efb2b914b068cf0370d41f9094bbec7ae8ef96a87dfe3ad64fd
+  data.tar.gz: bfc9bfe3b4e93dca2a774e416496d430dfa63185acc82db780cc4f26d7eec1ff2a6db0f10103fd962243ab46b9799b8e6536dd94cc07758b5f52ea07af71df67

data/.github/dependabot.yml

@@ -0,0 +1,15 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "bundler"
+    directory: "/"
+    schedule:
+      interval: "daily"
+  - package-ecosystem: "bundler"
+    directory: "/example" 
+    schedule:
+      interval: "daily"

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' ]
-
+        ruby: [ '2.6', '2.7', '3.0' ]
     steps:
     - uses: actions/checkout@v2
     - name: Set up Ruby

data/.github/workflows/ruby.yml

@@ -19,7 +19,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        ruby: [ '2.6', '2.7' ]
+        ruby: [ '2.6', '2.7', '3.0' ]
     steps:
     - uses: actions/checkout@v2
     - name: Set up Ruby

data/.gitignore

@@ -15,3 +15,6 @@ Gemfile.lock
 *.gem
 
 /vendor/
+
+.yardoc
+benchmark_results.yaml

data/.rubocop.yml

@@ -2,6 +2,7 @@ require: rubocop-rspec
 
 AllCops:
   TargetRubyVersion: 2.6.0
+  NewCops: enable
   Exclude:
     - 'bin/bundle'
     - 'example/bin/bundle'
@@ -22,6 +23,9 @@ Metrics/BlockLength:
     - 'sober_swag.gemspec'
     - 'example/spec/**/*.rb'
 
+Lint/MissingSuper:
+  Enabled: false
+
 RSpec/ImplicitBlockExpectation:
   Enabled: false
 
@@ -123,4 +127,4 @@ Style/FrozenStringLiteralComment:
   Enabled: false
 
 Style/BlockDelimiters:
-  EnforcedStyle: braces_for_chaining
+  EnforcedStyle: braces_for_chaining

data/.yardopts

@@ -0,0 +1,7 @@
+--markup-provider=redcarpet
+--markup=markdown
+--plugin activesupport-concern
+--plugin solargraph
+--private
+--protected
+--files docs/serializers.md

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 # 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
+
+
+## [v0.19.0] 2021-03-10
+
+- Use [redoc](https://github.com/Redocly/redoc) for generated documentation UI
+
+## [v0.18.0] 2021-03-02
+
+- Add generic hash type for primitive types
+
 ## [v0.17.0]: 2020-11-30
 
 - Allow tagging endpoints via the new `tags` method.

data/Gemfile

@@ -4,3 +4,15 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in sober_swag.gemspec
 gemspec
+
+gem 'yard'
+
+gem 'redcarpet'
+
+gem 'yard-activesupport-concern'
+
+gem 'solargraph'
+
+gem 'benchmark-ips'
+
+gem 'rspec-its'

data/README.md

@@ -11,7 +11,7 @@ An introductory presentation is available [here](https://www.icloud.com/keynote/
 
 Further documentation on using the gem is available in the `docs/` directory:
 
-- [Serializers](docs/serializers.md)
+- {file:docs/serializers.md Serializers}
 
 ## Types for a fully-automated API
 

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.
@@ -241,6 +241,9 @@ end
 Using `#merge` lets you add in all the fields from one output object into another.
 You can even use `merge` from within a view.
 
+Exclude any unneeded fields from the merge by passing a hash:
+`merge GenericBioOutput, { except: [:position] }`
+
 Note that `merge` does *not* copy anything but fields.
 Identifiers and views will not be copied over.
 

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', '~> 4.3'
+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.2'
+  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

@@ -1,7 +1,7 @@
 PATH
   remote: ..
   specs:
-    sober_swag (0.16.0)
+    sober_swag (0.19.0)
       activesupport
       dry-struct (~> 1.0)
       dry-types (~> 1.2)
@@ -64,12 +64,12 @@ GEM
       minitest (~> 5.1)
       tzinfo (~> 1.1)
       zeitwerk (~> 2.2, >= 2.2.2)
-    bootsnap (1.4.6)
+    bootsnap (1.7.5)
       msgpack (~> 1.0)
     builder (3.2.4)
     byebug (11.1.3)
     coderay (1.1.3)
-    concurrent-ruby (1.1.6)
+    concurrent-ruby (1.1.8)
     crass (1.0.6)
     diff-lcs (1.4.4)
     dry-configurable (0.11.6)
@@ -102,18 +102,17 @@ GEM
     dry-types-rails (0.3.4)
       dry-types (>= 0.8.1)
       rails (>= 3)
-    erubi (1.9.0)
-    ffi (1.13.1)
+    erubi (1.10.0)
+    ffi (1.15.3)
     globalid (0.4.2)
       activesupport (>= 4.2.0)
-    i18n (1.8.3)
+    i18n (1.8.9)
       concurrent-ruby (~> 1.0)
     ice_nine (0.11.2)
-    listen (3.1.5)
-      rb-fsevent (~> 0.9, >= 0.9.4)
-      rb-inotify (~> 0.9, >= 0.9.7)
-      ruby_dep (~> 1.2)
-    loofah (2.6.0)
+    listen (3.6.0)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    loofah (2.9.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
@@ -121,19 +120,23 @@ GEM
     marcel (0.3.3)
       mimemagic (~> 0.3.2)
     method_source (1.0.0)
-    mimemagic (0.3.5)
+    mimemagic (0.3.10)
+      nokogiri (~> 1)
+      rake
     mini_mime (1.0.2)
-    mini_portile2 (2.4.0)
-    minitest (5.14.1)
-    msgpack (1.3.3)
-    nio4r (2.5.2)
-    nokogiri (1.10.10)
-      mini_portile2 (~> 2.4.0)
-    pry (0.13.1)
+    mini_portile2 (2.5.1)
+    minitest (5.14.4)
+    msgpack (1.4.2)
+    nio4r (2.5.7)
+    nokogiri (1.11.5)
+      mini_portile2 (~> 2.5.0)
+      racc (~> 1.4)
+    pry (0.14.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    puma (4.3.5)
+    puma (5.3.2)
       nio4r (~> 2.0)
+    racc (1.5.2)
     rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
@@ -163,29 +166,28 @@ GEM
       method_source
       rake (>= 0.8.7)
       thor (>= 0.20.3, < 2.0)
-    rake (13.0.1)
-    rb-fsevent (0.10.4)
+    rake (13.0.3)
+    rb-fsevent (0.11.0)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
-    rspec-core (3.9.2)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.2)
+    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.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-rails (4.0.1)
-      actionpack (>= 4.2)
-      activesupport (>= 4.2)
-      railties (>= 4.2)
-      rspec-core (~> 3.9)
-      rspec-expectations (~> 3.9)
-      rspec-mocks (~> 3.9)
-      rspec-support (~> 3.9)
-    rspec-support (3.9.3)
-    ruby_dep (1.5.0)
-    spring (2.1.0)
+      rspec-support (~> 3.10.0)
+    rspec-rails (5.0.1)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
+      railties (>= 5.2)
+      rspec-core (~> 3.10)
+      rspec-expectations (~> 3.10)
+      rspec-mocks (~> 3.10)
+      rspec-support (~> 3.10)
+    rspec-support (3.10.2)
+    spring (2.1.1)
     spring-watcher-listen (2.0.1)
       listen (>= 2.7, < 4.0)
       spring (>= 1.2, < 3.0)
@@ -197,14 +199,14 @@ GEM
       activesupport (>= 4.0)
       sprockets (>= 3.0.0)
     sqlite3 (1.4.2)
-    thor (1.0.1)
+    thor (1.1.0)
     thread_safe (0.3.6)
-    tzinfo (1.2.7)
+    tzinfo (1.2.9)
       thread_safe (~> 0.1)
     websocket-driver (0.7.3)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.5)
-    zeitwerk (2.4.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
@@ -214,9 +216,9 @@ DEPENDENCIES
   bootsnap (>= 1.4.2)
   byebug
   dry-types-rails
-  listen (>= 3.0.5, < 3.2)
+  listen (>= 3.0.5, < 3.7)
   pry
-  puma (~> 4.3)
+  puma (~> 5.3)
   rails (~> 6.0.2, >= 6.0.2.2)
   rspec-rails
   sober_swag!