schema_serializer 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4785bf7f03533889d217d20dfcc5df091139e9b4ee28951463840fabcff64e42
+  data.tar.gz: eb160896dc5eb11d2984819098ba26972b8f89e12e0850e43f095b99c5f9ea77
+SHA512:
+  metadata.gz: fecfa5fa50a51d4cc321b994ff37a3c5374b4697cf27828aabc6324d0947e3932f3abfeea1d29887420bb46ed25e79e54aaa6d7f14fbfa87e3bafa2174b75dc4
+  data.tar.gz: 320be8c96cb3bba902c22407fdf24547e53905511fa36ca7904cd9b3fc25dba4f8a4ac958a945658ba361cea92c18c96c8e11664db083b86dce99a5f19837140

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/Gemfile.lock

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.2

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in schema_serializer.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Ken Iiboshi
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,55 @@
+# SchemaSerializer
+
+SchemaSerializer is provide serialization from schema definition to JSON.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "schema_serializer"
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+## Usage
+
+```
+SchemaSerializer.definition = {
+  "User" => {
+    "required" => ["id", "name"],
+    "properties" => {
+      "id" => {
+        "type" => "integer",
+      },
+      "name" => {
+        "type" => "string",
+      },
+      "age" => {
+        "type" => "number",
+        "nullable" => true,
+      },
+    }
+  }
+}
+
+User.take.as_json
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/i2bskn/schema_serializer.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "schema_serializer"
+
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install --path .bundle

data/lib/schema_serializer.rb

@@ -0,0 +1,56 @@
+require "active_support"
+require "active_support/core_ext"
+
+require "schema_serializer/definition"
+require "schema_serializer/schema"
+require "schema_serializer/serializable"
+require "schema_serializer/errors"
+require "schema_serializer/version"
+require "schema_serializer/railtie" if defined?(Rails)
+
+class SchemaSerializer
+  attr_reader :object
+
+  class << self
+    def definition
+      @definition
+    end
+
+    def definition=(define)
+      define = SchemaSerializer::Definition.new(define) unless define.is_a?(SchemaSerializer::Definition)
+      @definition = define
+    end
+  end
+
+  def initialize(object)
+    @object = object
+  end
+
+  def as_json
+    schema.serialize(self)
+  end
+
+  def schema
+    self.class.definition.find(schema_name)
+  end
+
+  def schema_name
+    object.class.to_s
+  end
+
+  private
+
+    def method_missing(name, *args, &block)
+      super unless object.respond_to?(name)
+
+      define_singleton_method(name) do |*a, &b|
+        object.public_send(name)
+      end
+
+      send(name, *args, &block)
+    end
+
+    def respond_to_missing?(name, include_private = false)
+      object.respond_to?(name)
+    end
+end

data/lib/schema_serializer/definition.rb

@@ -0,0 +1,15 @@
+class SchemaSerializer
+  class Definition
+    attr_reader :schemas
+
+    def initialize(hash)
+      @schemas = hash.each_with_object({}) { |(name, hash), obj|
+        obj[name.to_s] = Schema.new(hash)
+      }
+    end
+
+    def find(name)
+      schemas[name] || (raise SchemaNotFound, name)
+    end
+  end
+end

data/lib/schema_serializer/definition/from_openapi3_parser.rb

@@ -0,0 +1,33 @@
+require "openapi3_parser"
+
+class SchemaSerializer::Definition
+  module FromOpenapi3Parser
+    class << self
+      def build(document)
+        SchemaSerializer::Definition.new(schemas_to_hash(document.components.schemas))
+      end
+
+      private
+
+        def schemas_to_hash(schemas)
+          schemas.each_with_object({}) { |(name, node), obj|
+            obj[name.to_s] = node_to_hash(node)
+          }
+        end
+
+        def node_to_hash(node)
+          obj = { "type" => node.type, "nullable" => node.nullable? }
+          case obj["type"]
+          when "array"
+            obj["items"] = node_to_hash(node.items)
+          when nil
+            obj["required"] = node.required.node_data
+            obj["properties"] = node.properties.each_with_object({}) { |(name, node), obj|
+              obj[name.to_s] = node_to_hash(node)
+            }
+          end
+          obj
+        end
+    end
+  end
+end

data/lib/schema_serializer/errors.rb

@@ -0,0 +1,3 @@
+class SchemaSerializer
+  class SchemaNotFound < StandardError; end
+end

data/lib/schema_serializer/railtie.rb

@@ -0,0 +1,9 @@
+class SchemaSerializer
+  class Railtie < ::Rails::Railtie
+    initializer "schema_serializer" do
+      ActiveSupport.on_load(:active_record) do
+        ::ActiveRecord::Base.send(:extend, SchemaSerializer::Serializable)
+      end
+    end
+  end
+end

data/lib/schema_serializer/schema.rb

@@ -0,0 +1,39 @@
+class SchemaSerializer
+  class Schema
+    attr_reader :type, :nullable, :items, :required, :properties
+
+    def initialize(hash = {})
+      @type     = hash["type"]
+      @nullable = !!hash["nullable"]
+
+      case type
+      when "array"
+        @items = self.class.new(hash.fetch("items"))
+      when "object", nil
+        @required = hash["required"] || []
+        @properties = hash.fetch("properties").each_with_object({}) { |(column, _hash), obj|
+          obj[column] = self.class.new(_hash)
+        }
+      end
+    end
+
+    def serialize(object)
+      return nil if nullable && object.nil?
+
+      case type
+      when "integer"
+        object.to_i
+      when "number"
+        object.to_f
+      when "string"
+        object.to_s
+      when "array"
+        object.map { |item| items.serialize(item) }
+      else
+        properties.each_with_object({}) { |(column, schema), obj|
+          obj[column] = schema.serialize(object.public_send(column))
+        }
+      end
+    end
+  end
+end

data/lib/schema_serializer/serializable.rb

@@ -0,0 +1,7 @@
+class SchemaSerializer
+  module Serializable
+    def serializer(klass = nil)
+      (klass || "#{self.class.to_s}Serializer".safe_constantize || SchemaSerializer).new(self)
+    end
+  end
+end

data/lib/schema_serializer/version.rb

@@ -0,0 +1,3 @@
+class SchemaSerializer
+  VERSION = "0.0.1".freeze
+end

data/schema_serializer.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "schema_serializer/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "schema_serializer"
+  spec.version       = SchemaSerializer::VERSION
+  spec.authors       = ["i2bskn"]
+  spec.email         = ["i2bskn@gmail.com"]
+
+  spec.summary       = %q{SchemaSerializer is provide serialization from schema definition to JSON.}
+  spec.description   = %q{SchemaSerializer is provide serialization from schema definition to JSON.}
+  spec.homepage      = "https://github.com/i2bskn/schema_serializer"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "openapi3_parser"
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification
+name: schema_serializer
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- i2bskn
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-07-24 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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+- !ruby/object:Gem::Dependency
+  name: openapi3_parser
+  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: SchemaSerializer is provide serialization from schema definition to JSON.
+email:
+- i2bskn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/schema_serializer.rb
+- lib/schema_serializer/definition.rb
+- lib/schema_serializer/definition/from_openapi3_parser.rb
+- lib/schema_serializer/errors.rb
+- lib/schema_serializer/railtie.rb
+- lib/schema_serializer/schema.rb
+- lib/schema_serializer/serializable.rb
+- lib/schema_serializer/version.rb
+- schema_serializer.gemspec
+homepage: https://github.com/i2bskn/schema_serializer
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: SchemaSerializer is provide serialization from schema definition to JSON.
+test_files: []