schema_serializer 0.2.0 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e77ad90c0adef33c9d54051f2747a00ceb8668e46a54cf2350c5a52cc8a90ad
-  data.tar.gz: a99ef7650ff88cfae0879fa3d322c0f043fe78f87aa99c00a167bbb00d515d50
+  metadata.gz: 16979d066b051ff98b81083b073753d4f755f7d395c10d100de19d3258fd00fe
+  data.tar.gz: 58bc8904ee191d367bce4cb81c60acf5028276e090c34bed16150a96ba42f398
 SHA512:
-  metadata.gz: 7380eb8d5f8c53bd335fdecc91df45009f6317a633d0c8ca32df63503756852515f82a2581c2f5f7a1867ff1c4f3870bf86291e2924c1beb28df555e6e1e49e5
-  data.tar.gz: ed7aca31fe5173463fefe842b91fcacc469355de7a02db17cdf2b4470bce7199cc7eb7d4779c5978904e2dd83f7824a842d906b3f0569c2fa253c5713065c8b0
+  metadata.gz: 7b9cea96ae7da52913b33a7ebe16b249be137861e31d5ea2f84509b40f14b0ceafac7d5fe42f760ba2d3389e11a901bb53c87c6b1f121ee5ed453fa0ca4daa3f
+  data.tar.gz: 3e404e9176704a2220e83dd607672053d4bc7ee6ba1e0f8314150e8e3942f2890ba0735bc7b938ceea921e0a7bfdf7babf74e2657e58ebad1a7ea6e2a3766bdb

data/.github/workflows/ci.yml

@@ -0,0 +1,28 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: CI
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7.2
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rake spec
+    - name: Run rubocop
+      run: bundle exec rake rubocop

data/.gitignore

@@ -8,4 +8,5 @@
 /tmp/
 /Gemfile.lock
 
+# rspec failure tracking
 .rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -1,18 +1,21 @@
 AllCops:
+  NewCops: enable
   TargetRubyVersion: 2.6
   Exclude:
     - "node_modules/**/*"
     - "vendor/**/*"
 
-Layout/IndentFirstArrayElement:
-  EnforcedStyle: consistent
-
-Layout/IndentFirstHashElement:
-  EnforcedStyle: consistent
-
+# Private methods indent.
 Layout/IndentationConsistency:
   EnforcedStyle: indented_internal_methods
 
+# Warning: 120 characters
+# Error:   160 characters
+# Make the library more restrictive.
+Layout/LineLength:
+  Max: 120
+
+# Multi-line indentation with receiver.
 Layout/MultilineMethodCallIndentation:
   EnforcedStyle: indented_relative_to_receiver
 
@@ -20,6 +23,11 @@ Lint/AmbiguousBlockAssociation:
   Exclude:
     - "spec/**/*_spec.rb"
 
+# May define constants within the block in spec.
+Lint/ConstantDefinitionInBlock:
+  Exclude:
+    - "spec/**/*_spec.rb"
+
 Lint/InheritException:
   EnforcedStyle: standard_error
 
@@ -38,18 +46,12 @@ Metrics/BlockLength:
     - "Gemfile"
     - "*.gemspec"
 
-CyclomaticComplexity:
+Metrics/CyclomaticComplexity:
   Max: 10
 
-Metrics/LineLength:
-  Max: 120
-
 Metrics/MethodLength:
   Max: 20
 
-Naming/UncommunicativeMethodParamName:
-  Enabled: false
-
 Security/YAMLLoad:
   Enabled: false
 
@@ -65,9 +67,6 @@ Style/AsciiComments:
 Style/BlockDelimiters:
   Enabled: false
 
-Style/BracesAroundHashParameters:
-  Enabled: false
-
 Style/ClassAndModuleChildren:
   Enabled: false
 
@@ -96,6 +95,7 @@ Style/EmptyMethod:
 Style/FormatString:
   EnforcedStyle: percent
 
+# Do not use frozen_string_literal comment.
 Style/FrozenStringLiteralComment:
   Enabled: false
 
@@ -110,6 +110,7 @@ Style/MixinUsage:
   Exclude:
     - "bin/setup"
 
+# Use _ when 7 digits or more.
 Style/NumericLiterals:
   MinDigits: 7
   Strict: true
@@ -123,38 +124,42 @@ Style/OrAssignment:
 Style/PercentLiteralDelimiters:
   Enabled: false
 
+# `has_xxx?` is more readable.
 Style/PreferredHashMethods:
   EnforcedStyle: verbose
 
+# Do not use unnecessary returns. (Allow to return multiple values.)
 Style/RedundantReturn:
   AllowMultipleReturnValues: true
 
-Style/RedundantSelf:
-  Enabled: false
-
+# Do not specify error class when rescuing StandardError.
 Style/RescueStandardError:
   EnforcedStyle: implicit
 
+# String literals use double quotes.
 Style/StringLiterals:
   EnforcedStyle: double_quotes
 
+# String literal inside the string interpolation use double quotes too.
 Style/StringLiteralsInInterpolation:
   EnforcedStyle: double_quotes
 
+# Percent(`%i(a b)`) and brackets(`[:a, :b]`) are acceptable.
 Style/SymbolArray:
   Enabled: false
 
-Style/TernaryParentheses:
-  EnforcedStyle: require_parentheses_when_complex
-
+# Put a trailing comma in argument list.
 Style/TrailingCommaInArguments:
   EnforcedStyleForMultiline: comma
 
+# Put a trailing comma in Array literal.
 Style/TrailingCommaInArrayLiteral:
   EnforcedStyleForMultiline: comma
 
+# Put a trailing comma in Hash literal.
 Style/TrailingCommaInHashLiteral:
   EnforcedStyleForMultiline: comma
 
+# Percent(`%w(a b)`) and brackets(`["a", "b"]`) are acceptable.
 Style/WordArray:
   Enabled: false

data/.ruby-version

@@ -1 +1 @@
-2.6.4
+2.7.2

data/README.md

@@ -1,7 +1,7 @@
 # SchemaSerializer
 
 [![Gem Version](https://badge.fury.io/rb/schema_serializer.svg)](https://badge.fury.io/rb/schema_serializer)
-[![Build Status](https://travis-ci.org/i2bskn/schema_serializer.svg?branch=master)](https://travis-ci.org/i2bskn/schema_serializer)
+[![CI](https://github.com/i2bskn/schema_serializer/workflows/CI/badge.svg?branch=master)](https://github.com/i2bskn/schema_serializer/actions?query=workflow%3ACI)
 
 SchemaSerializer is provide serialization from schema definition to JSON.
 

data/Rakefile

@@ -1,6 +1,8 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
+require "rubocop/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new
 
-task default: :spec
+task :default => %i(spec rubocop)

data/bin/profile

@@ -5,7 +5,7 @@ require "schema_serializer"
 
 User = Struct.new(:id, :name, :age, :gender, :email, :created_at)
 User.include SchemaSerializer::Serializable
-users = Array.new(10000) { |i|
+users = Array.new(1_000_000) { |i|
   User.new(i.to_s, "abcdefg", rand(80).to_s, rand(2).to_s, "user#{i}@example.com", Time.now)
 }
 SchemaSerializer.definition = {

data/lib/generators/schema_serializer/install/install_generator.rb

@@ -8,6 +8,10 @@ module SchemaSerializer::Generators
 
     def create_example_schema
       copy_file "schema.yml", "doc/schema.yml"
+      copy_file "components/index.yml", "doc/components/index.yml"
+      copy_file "components/schemas/index.yml", "doc/components/schemas/index.yml"
+      copy_file "components/schemas/User.yml", "doc/components/schemas/User.yml"
+      copy_file "components/schemas/Users.yml", "doc/components/schemas/Users.yml"
     end
   end
 end

data/lib/generators/schema_serializer/install/templates/components/index.yml

@@ -0,0 +1,2 @@
+schemas:
+  $ref: ./schemas/index.yml

data/lib/generators/schema_serializer/install/templates/components/schemas/User.yml

@@ -0,0 +1,12 @@
+type: object
+required:
+  - id
+  - name
+properties:
+  id:
+    type: integer
+  name:
+    type: string
+  age:
+    nullable: true
+    type: integer

data/lib/generators/schema_serializer/install/templates/components/schemas/Users.yml

@@ -0,0 +1,3 @@
+type: array
+items:
+  $ref: "#/components/schemas/User"

data/lib/generators/schema_serializer/install/templates/components/schemas/index.yml

@@ -0,0 +1,4 @@
+User:
+  $ref: ./User.yml
+Users:
+  $ref: ./Users.yml

data/lib/generators/schema_serializer/install/templates/schema.yml

@@ -1,11 +1,3 @@
-Pet:
-  required:
-    - id
-    - name
-  properties:
-    id:
-      type: integer
-    name:
-      type: string
-    tag:
-      type: string
+openapi: "3.0.0"
+components:
+  $ref: ./components/index.yml

data/lib/generators/schema_serializer/install/templates/schema_serializer.rb

@@ -1 +1,4 @@
+# Throw exception with unexpected null value.
+SchemaSerializer.config.raise_on_null = true
+
 SchemaSerializer.load_definition(Rails.root.join("doc/schema.yml"))

data/lib/schema_serializer.rb

@@ -2,15 +2,17 @@ require "active_support"
 require "active_support/core_ext"
 require "yaml_ext"
 
+require "schema_serializer/configuration"
 require "schema_serializer/definition"
 require "schema_serializer/schema"
+require "schema_serializer/constantizer"
 require "schema_serializer/serializable"
 require "schema_serializer/errors"
 require "schema_serializer/version"
 require "schema_serializer/railtie" if defined?(Rails)
 
 class SchemaSerializer
-  attr_reader :object
+  attr_reader :object, :options
 
   class << self
     attr_reader :definition
@@ -21,16 +23,28 @@ class SchemaSerializer
         doc = doc.fetch("components").fetch("schemas")
       end
 
+      @document_path = path
       self.definition = doc
     end
 
+    def reload!
+      raise ReloadError, "Load config using .load_definition" if @document_path.nil?
+
+      load_definition(@document_path)
+    end
+
     def definition=(define)
       @definition = define.is_a?(SchemaSerializer::Definition) ? define : SchemaSerializer::Definition.new(define)
     end
+
+    def config
+      @config ||= Configuration.new
+    end
   end
 
-  def initialize(object, _options = {})
+  def initialize(object, options = {})
     @object = object
+    @options = options
   end
 
   def as_json(_options = nil)
@@ -56,6 +70,7 @@ class SchemaSerializer
     end
 
     def respond_to_missing?(name, _include_private = false)
+      super
       object.respond_to?(name)
     end
 end

data/lib/schema_serializer/configuration.rb

@@ -0,0 +1,23 @@
+class SchemaSerializer
+  class Configuration
+    VALID_OPTIONS = [
+      :raise_on_null,
+    ].freeze
+
+    attr_accessor(*VALID_OPTIONS)
+
+    def initialize(options = {})
+      reset
+      merge(options)
+    end
+
+    def merge(options)
+      options.each_key { |key| send("#{key}=", options[key]) }
+      self
+    end
+
+    def reset
+      @raise_on_null = true
+    end
+  end
+end

data/lib/schema_serializer/constantizer.rb

@@ -0,0 +1,34 @@
+class SchemaSerializer
+  class Constantizer
+    class << self
+      def find(name)
+        return cached_serializers.fetch(name) if cached_serializers.has_key?(name)
+        return nil                            if non_existent_serializers.include?(name)
+
+        klass = name.safe_constantize
+        if klass.present?
+          cached_serializers[name] = klass
+          return klass
+        end
+
+        non_existent_serializers << name
+        nil
+      end
+
+      def refresh!
+        @non_existent_serializers = []
+        @serializers = {}
+      end
+
+      private
+
+        def non_existent_serializers
+          @non_existent_serializers ||= []
+        end
+
+        def cached_serializers
+          @cached_serializers ||= {}
+        end
+    end
+  end
+end

data/lib/schema_serializer/definition.rb

@@ -4,7 +4,7 @@ class SchemaSerializer
 
     def initialize(hash)
       @schemas = hash.each_with_object({}) { |(name, schema), obj|
-        obj[name.to_s] = Schema.new(schema)
+        obj[name.to_s] = Schema.new(name, schema)
       }
     end
 

data/lib/schema_serializer/errors.rb

@@ -2,4 +2,6 @@ class SchemaSerializer
   class BaseError          < StandardError; end
   class SchemaNotFound     < BaseError; end
   class RequiredNotDefined < BaseError; end
+  class NullValue          < BaseError; end
+  class ReloadError        < BaseError; end
 end

data/lib/schema_serializer/railtie.rb

@@ -2,7 +2,8 @@ class SchemaSerializer
   class Railtie < ::Rails::Railtie
     initializer "schema_serializer" do
       ActiveSupport.on_load(:active_record) do
-        ::ActiveRecord::Base.send(:include, SchemaSerializer::Serializable)
+        ::ActiveRecord::Base.include SchemaSerializer::Serializable
+        ::ActiveRecord::Relation.include SchemaSerializer::Serializable
       end
     end
   end

data/lib/schema_serializer/schema.rb

@@ -1,24 +1,28 @@
 class SchemaSerializer
   class Schema
-    attr_reader :type, :nullable, :items, :required, :properties
+    attr_reader :key, :type, :nullable, :items, :required, :properties
 
-    def initialize(hash = {})
+    def initialize(key, hash = {})
+      @key      = key
       @type     = hash["type"]
       @nullable = !hash["nullable"].nil?
 
       case type
       when "array"
-        @items = self.class.new(hash.fetch("items"))
+        @items = self.class.new(@key, hash.fetch("items"))
       when "object", nil
         @required = hash["required"] || []
         @properties = hash.fetch("properties").each_with_object({}) { |(column, property), obj|
-          obj[column] = self.class.new(property)
+          obj[column] = self.class.new(column, property)
         }
       end
     end
 
     def serialize(object)
-      return nil if nullable && object.nil?
+      if object.nil?
+        return nil if nullable
+        raise NullValue, "#{key} is not allowed to be null" if SchemaSerializer.config.raise_on_null
+      end
 
       case type
       when "integer"
@@ -30,8 +34,19 @@ class SchemaSerializer
       when "boolean"
         !!object
       when "array"
-        object.map { |item| items.serialize(item) }
+        serialize_array(object)
       else
+        serialize_object(object)
+      end
+    end
+
+    private
+
+      def serialize_array(object)
+        object.map { |item| items.serialize(item) }
+      end
+
+      def serialize_object(object)
         not_enough_columns = required - properties.keys
         raise RequiredNotDefined, not_enough_columns.join(", ") unless not_enough_columns.empty?
 
@@ -39,9 +54,6 @@ class SchemaSerializer
           obj[column] = schema.serialize(get_value(object, column))
         }
       end
-    end
-
-    private
 
       def get_value(object, column)
         return object[column] || object[column.to_sym] if object.is_a?(Hash)

data/lib/schema_serializer/serializable.rb

@@ -1,7 +1,21 @@
 class SchemaSerializer
   module Serializable
-    def serializer(klass = nil)
-      (klass || "#{self.class.name}Serializer".safe_constantize || SchemaSerializer).new(self)
+    def serializer(*args)
+      options = args.last.is_a?(Hash) ? args.pop : {}
+      klass = args.first || options[:class]
+      (klass || serializer_class || SchemaSerializer).new(self, options)
     end
+
+    private
+
+      def serializer_class
+        SchemaSerializer::Constantizer.find("#{serializer_base_class_name}Serializer")
+      end
+
+      def serializer_base_class_name
+        return self.class.name unless defined?(ActiveRecord)
+
+        self.class < ActiveRecord::Relation ? model.name.pluralize : self.class.name
+      end
   end
 end

data/lib/schema_serializer/version.rb

@@ -1,3 +1,3 @@
 class SchemaSerializer
-  VERSION = "0.2.0".freeze
+  VERSION = "0.2.6".freeze
 end

data/schema_serializer.gemspec

@@ -20,14 +20,16 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
+  spec.required_ruby_version = ">= 2.6"
+
   spec.add_dependency "activesupport", ">= 5.2.0", "< 6.1"
   spec.add_dependency "yaml_ext", "0.1.2"
 
   spec.add_development_dependency "activerecord", ">= 5.2.0", "< 6.1"
-  spec.add_development_dependency "bundler", "~> 2.0.2"
-  spec.add_development_dependency "pry", "~> 0.12.2"
+  spec.add_development_dependency "bundler", "~> 2.1.4"
+  spec.add_development_dependency "pry", "~> 0.13.1"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec", "~> 3.8.0"
-  spec.add_development_dependency "rubocop", "~> 0.74.0"
-  spec.add_development_dependency "sqlite3", "~> 1.4.0"
+  spec.add_development_dependency "rspec", "~> 3.10.0"
+  spec.add_development_dependency "rubocop", "~> 1.2.0"
+  spec.add_development_dependency "sqlite3", "~> 1.4.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: schema_serializer
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.6
 platform: ruby
 authors:
 - i2bskn
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-02 00:00:00.000000000 Z
+date: 2020-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -70,28 +70,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.2
+        version: 2.1.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.2
+        version: 2.1.4
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.2
+        version: 0.13.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.12.2
+        version: 0.13.1
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -112,42 +112,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.8.0
+        version: 3.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.8.0
+        version: 3.10.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.74.0
+        version: 1.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.74.0
+        version: 1.2.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: 1.4.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.4.0
+        version: 1.4.2
 description: SchemaSerializer is provide serialization from schema definition to JSON.
 email:
 - i2bskn@gmail.com
@@ -155,10 +155,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
+- ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
-- ".travis.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -168,12 +169,18 @@ files:
 - bin/setup
 - lib/generators/schema_serializer/install/USAGE
 - lib/generators/schema_serializer/install/install_generator.rb
+- lib/generators/schema_serializer/install/templates/components/index.yml
+- lib/generators/schema_serializer/install/templates/components/schemas/User.yml
+- lib/generators/schema_serializer/install/templates/components/schemas/Users.yml
+- lib/generators/schema_serializer/install/templates/components/schemas/index.yml
 - lib/generators/schema_serializer/install/templates/schema.yml
 - lib/generators/schema_serializer/install/templates/schema_serializer.rb
 - lib/generators/schema_serializer/serializer/USAGE
 - lib/generators/schema_serializer/serializer/serializer_generator.rb
 - lib/generators/schema_serializer/serializer/templates/serializer.rb.erb
 - lib/schema_serializer.rb
+- lib/schema_serializer/configuration.rb
+- lib/schema_serializer/constantizer.rb
 - lib/schema_serializer/definition.rb
 - lib/schema_serializer/errors.rb
 - lib/schema_serializer/railtie.rb
@@ -193,14 +200,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
 summary: SchemaSerializer is provide serialization from schema definition to JSON.

data/.travis.yml

@@ -1,10 +0,0 @@
----
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.6.4
-before_install: gem install bundler -v 2.0.2
-script:
-  - bundle exec rake spec
-  - bundle exec rubocop