blueprinter_schema 0.4.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a5c36ae7940be0f29d7fa96352756ac959c03dfb61d968d4080d1368a7eb29c
-  data.tar.gz: cf498e454ca5349f419ac3e2db8d1efe9ee686ae09d34570be8523757e983e42
+  metadata.gz: b10fc12e29b6f54a7f5515b3d97809bd65e1fded8acd99a2d9395339cf7b1b2c
+  data.tar.gz: 4f0403c88c922e8c026d4ac0b7dd686c1e88f7f0f3fcde3174f184bfb9e375b9
 SHA512:
-  metadata.gz: d5eaf5134861ca54d30c5e1380ba7e0afa15db73c692bc84591903a04b2d3a2190628e8221fd58506c0c328cf2da149f4df7813faeec29b92d2333910487cc93
-  data.tar.gz: 6259270843fd90b83c08d797d1cd81799072e5b5d0c4e2295353c9b963e6e06b8729dde7f45e41121d4416a709f11e8a1aa7ed0d2a977180de98424b4d493d3b
+  metadata.gz: ac1dd30628176e9f5feb4f461bd4a4931050967945be9f81e1e6ceaa4387f52c1139d652a518acf4b2bce5e5309d9c95ccd8d5708215c672975b730e9be20e57
+  data.tar.gz: f77ef5d6d8c7d3c8a204f5b053b7a56183c3298f6b8b6a22606257e16febb0087ccb304ad60ed7acd26f3123693b40756503b178096870fd80d705d604f737e6

data/README.md

@@ -27,13 +27,15 @@ end
 class AddressSerializer < Blueprinter::Base
   identifier :id
 
-  fields :address
+  field :address
 end
 
 class UserSerializer < Blueprinter::Base
   identifier :id
 
-  fields :name, :email, :created_at
+  field :name, description: 'The name of the user'
+  fields :email, :created_at
+
   association :addresses, blueprint: AddressSerializer
 end
 ```
@@ -58,7 +60,8 @@ BlueprinterSchema.generate(UserSerializer, User)
       "type" => "string"
     },
     "name" => {
-      "type" => ["string", "null"]
+      "type" => ["string", "null"],
+      'description' => 'The name of the user'
     },
     "addresses" => {
       "type" => "array",
@@ -91,14 +94,28 @@ BlueprinterSchema.generate(
   model,
   {
     include_conditional_fields: true, # Whether or not to include conditional fields from the serializer
-    fallback_type: {} # Type when no DB column is found or type is unknown. E.g. { 'type' => 'object' }
+    fallback_type: {}, # Type when no DB column is found or type is unknown. E.g. { 'type' => 'object' }
+    view: :default # The Blueprint view to use
   }
 )
 ```
 
 ## 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.
+Devcontainer / Codespaces / Native
+
+```sh
+bin/setup
+```
+
+Docker
+
+```sh
+docker compose up -d
+docker compose exec ruby bin/setup
+```
+
+Then, run `bundle exec rspec` 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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 

data/Rakefile

@@ -1,12 +1,3 @@
 # frozen_string_literal: true
 
 require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec)
-
-require 'rubocop/rake_task'
-
-RuboCop::RakeTask.new
-
-task default: %i[spec rubocop]

data/lib/blueprinter_schema/generator.rb

@@ -2,7 +2,7 @@
 
 module BlueprinterSchema
   class Generator
-    def initialize(serializer, model, options = { include_conditional_fields: true, fallback_type: {} })
+    def initialize(serializer, model, options)
       @serializer = serializer
       @model = model
       @options = options
@@ -21,11 +21,11 @@ module BlueprinterSchema
     private
 
     def fields
-      @fields ||= @serializer.reflections[:default].fields
+      @fields ||= @serializer.reflections[@options[:view]].fields
     end
 
     def associations
-      @associations ||= @serializer.reflections[:default].associations
+      @associations ||= @serializer.reflections[@options[:view]].associations
     end
 
     def build_properties
@@ -45,7 +45,8 @@ module BlueprinterSchema
     end
 
     def skip_field?(field)
-      !@options[:include_conditional_fields] && (field.options[:if] || field.options[:unless])
+      !@options[:include_conditional_fields] &&
+        (field.options[:if] || field.options[:unless] || field.options[:exclude_if_nil])
     end
 
     def build_required_fields
@@ -55,7 +56,9 @@ module BlueprinterSchema
     def field_to_json_schema(field)
       column = @model.columns_hash[field.name.to_s]
 
-      ar_column_to_json_schema(column) || @options[:fallback_type]
+      type = ar_column_to_json_schema(column) || @options[:fallback_type]
+      type['description'] = field.options[:description] if field.options[:description]
+      type
     end
 
     # rubocop:disable Metrics/MethodLength

data/lib/blueprinter_schema/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BlueprinterSchema
-  VERSION = '0.4.2'
+  VERSION = '0.6.0'
 end

data/lib/blueprinter_schema.rb

@@ -4,7 +4,11 @@ require_relative 'blueprinter_schema/version'
 require_relative 'blueprinter_schema/generator'
 
 module BlueprinterSchema
-  def self.generate(serializer, model, options = { include_conditional_fields: true, fallback_type: {} })
+  def self.generate(
+    serializer,
+    model,
+    options = { include_conditional_fields: true, fallback_type: {}, view: :default }
+  )
     Generator.new(serializer, model, options).generate
   end
 end

metadata

@@ -1,14 +1,42 @@
 --- !ruby/object:Gem::Specification
 name: blueprinter_schema
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.6.0
 platform: ruby
 authors:
 - thisismydesign
 bindir: exe
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  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: blueprinter
+  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'
 email:
 - git.thisismydesign@gmail.com
 executables: []