json-schema-serializer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: aa99cc9446a97fd7d69624a5618fa53c4cba390ef4b008073ee3aaa65e7a18f7
+  data.tar.gz: bd775b351f47f8292ff70df162586d0822d814b9f3230ff7b7b7fe8caf9584c7
+SHA512:
+  metadata.gz: e050ecaccb1a4de337b76a8c310c77b572c996e5689da63ea2008c899ace3d9cc1bc800e455349912d767f48d76d00fa09e2b4405ce49dc93707798a5d5ae350
+  data.tar.gz: 825b13e2e6c0bc51fbc0b41e18ec9785c44168cd098819e07afdb79c7a41a2ab6775e237f377c736d6406b9e4a3b7c41420e10768af87983d1f543322645721c

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/Gemfile.lock
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,4 @@
+--format documentation
+--color
+--require rspec-power_assert
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 1.17.2

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# CHANGELOG
+
+## 0.1.0
+
+- released

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 json-schema-serializer.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2019 Narazaka
+
+This software is provided 'as-is', without any express or implied
+warranty. In no event will the authors be held liable for any damages
+arising from the use of this software.
+
+Permission is granted to anyone to use this software for any purpose,
+including commercial applications, and to alter it and redistribute it
+freely, subject to the following restrictions:
+
+   1. The origin of this software must not be misrepresented; you must not
+   claim that you wrote the original software. If you use this software
+   in a product, an acknowledgment in the product documentation would be
+   appreciated but is not required.
+
+   2. Altered source versions must be plainly marked as such, and must not be
+   misrepresented as being the original software.
+
+   3. This notice may not be removed or altered from any source
+   distribution.

data/README.md

@@ -0,0 +1,75 @@
+# Json::Schema::Serializer
+
+JSON Schema based serializer
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'json-schema-serializer'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install json-schema-serializer
+
+## Usage
+
+```ruby
+require "json/schema/serializer"
+
+schema = {
+  type: "object",
+  properties: {
+    id: { type: "integer" },
+    name: { type: "string" },
+  },
+}
+
+serializer = JSON::Schema::Serializer.new(schema)
+serializer.serialize({id: 42, name: "me", foo: "bar"})
+# => {"id"=>42, "name"=>"me"}
+```
+
+### Caution
+
+`JSON::Schema::Serializer` does not resolve `$ref` so use external resolver.
+
+with `json_refs` gem example:
+
+```ruby
+require "json_refs"
+require "json/schema/serializer"
+
+
+schema = {
+  "type" => "object",
+  "properties" => {
+    "foo" => { "type" => "integer" },
+    "bar" => { "$ref" => "#/properties/foo" },
+  },
+}
+
+serializer = JSON::Schema::Serializer.new(JsonRefs.(schema))
+serializer.serialize({foo: 0, bar: "42"})
+# => {"foo"=>0, "bar"=>42}
+```
+
+## License
+
+Zlib License
+
+## 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.
+
+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/Narazaka/json-schema-serializer.

data/Rakefile

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

data/bin/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "json/schema/serializer"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require "pry"
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/json-schema-serializer.gemspec

@@ -0,0 +1,41 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "json/schema/serializer/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "json-schema-serializer"
+  spec.version       = Json::Schema::Serializer::VERSION
+  spec.authors       = ["Narazaka"]
+  spec.email         = ["info@narazaka.net"]
+  spec.licenses      = ['Zlib']
+
+  spec.summary       = %q{JSON Schema based serializer}
+  spec.homepage      = "https://github.com/Narazaka/json-schema-serializer"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/Narazaka/json-schema-serializer.git"
+    spec.metadata["changelog_uri"] = "https://github.com/Narazaka/json-schema-serializer/blob/master/CHANGELOG.md"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.5"
+  spec.add_development_dependency "rspec", "~> 3.9"
+  spec.add_development_dependency "rspec-power_assert", "~> 1.1"
+  spec.add_development_dependency "pry-byebug", "~> 3.7"
+end

data/lib/json/schema/serializer.rb

@@ -0,0 +1,178 @@
+require "json/schema/serializer/version"
+require "date"
+require "set"
+
+module JSON
+  class Schema
+    class Serializer
+      def initialize(obj)
+        @schema = obj
+      end
+
+      def serialize(obj)
+        Walker.walk(@schema, obj, true)
+      end
+
+      class Walker
+        class << self
+          TimeWithZone = defined?(ActiveSupport::TimeWithZone) ? ActiveSupport::TimeWithZone : nil
+
+          def walk(schema, obj, required)
+            type = try_hash(schema, :type)
+            format = try_hash(schema, :format)
+            type_coerce(schema, detect_type(type, obj), format, obj, required)
+          end
+
+          def detect_type(type, obj)
+            return type unless type.is_a?(Array)
+            type = Set.new(type.map(&:to_s))
+
+            case obj
+            when nil
+              case
+              when type.include?("null")
+                "null"
+              else
+                type.first
+              end
+            when DateTime, Date, Time, TimeWithZone
+              case
+              when type.include?("string")
+                "string"
+              when type.include?("number")
+                "number"
+              when type.include?("integer")
+                "integer"
+              else
+                type.first
+              end
+            when String
+              case
+              when type.include?("string")
+                "string"
+              else
+                type.first
+              end
+            when Integer
+              case
+              when type.include?("integer")
+                "integer"
+              when type.include?("number")
+                "number"
+              when type.include?("string")
+                "string"
+              when type.include?("boolean")
+                "boolean"
+              else
+                type.first
+              end
+            when Float
+              case
+              when type.include?("number")
+                "number"
+              when type.include?("string")
+                "string"
+              when type.include?("integer")
+                "integer"
+              when type.include?("boolean")
+                "boolean"
+              else
+                type.first
+              end
+            when true, false
+              case
+              when type.include?("boolean")
+                "boolean"
+              else
+                type.first
+              end
+            when Array
+              case
+              when type.include?("array")
+                "array"
+              else
+                type.first
+              end
+            else
+              case
+              when type.include?("object")
+                "object"
+              else
+                type.first
+              end
+            end
+          end
+
+          def type_coerce(schema, type, format, obj, required)
+            return nil if !required && obj.nil?
+
+            case type.to_s
+            when "null"
+              nil
+            when "string"
+              case obj
+              when nil
+                ""
+              when DateTime, Date, Time, TimeWithZone
+                case format.to_s
+                when "date-time"
+                  obj.strftime("%FT%T%:z")
+                when "date"
+                  obj.strftime("%F")
+                when "time"
+                  obj.strftime("%T%:z")
+                else
+                  obj.to_s
+                end
+              else
+                obj.to_s
+              end
+            when "integer"
+              case obj
+              when true
+                1
+              when false
+                0
+              else
+                obj.to_i
+              end
+            when "number"
+              case obj
+              when true
+                1.0
+              when false
+                0.0
+              else
+                obj.to_f
+              end
+            when "boolean"
+              obj == true
+            when "array"
+              items_schema = try_hash(schema, :items)
+              obj.nil? ? [] : obj.map {|item| walk(items_schema, item, true) }
+            when "object"
+              properties_schema = try_hash(schema, :properties)
+              required_schema = Set.new(try_hash(schema, :required)&.map(&:to_s))
+              properties_schema.map {|name, property_schema|
+                [
+                  name.to_s,
+                  walk(property_schema, try_hash(obj, name), required_schema.include?(name.to_s)),
+                ]
+              }.to_h
+            end
+          end
+
+          private
+
+          def try_hash(obj, name)
+            if obj.respond_to?(:"[]")
+              obj[name] || obj[name.is_a?(Symbol) ? name.to_s : name.to_sym]
+            elsif obj.respond_to?(name)
+              obj.send(name)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/json/schema/serializer/version.rb

@@ -0,0 +1,7 @@
+module Json
+  module Schema
+    module Serializer
+      VERSION = "0.1.0"
+    end
+  end
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: json-schema-serializer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Narazaka
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-11-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.5'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rspec-power_assert
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+description: 
+email:
+- info@narazaka.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- json-schema-serializer.gemspec
+- lib/json/schema/serializer.rb
+- lib/json/schema/serializer/version.rb
+homepage: https://github.com/Narazaka/json-schema-serializer
+licenses:
+- Zlib
+metadata:
+  homepage_uri: https://github.com/Narazaka/json-schema-serializer
+  source_code_uri: https://github.com/Narazaka/json-schema-serializer.git
+  changelog_uri: https://github.com/Narazaka/json-schema-serializer/blob/master/CHANGELOG.md
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: JSON Schema based serializer
+test_files: []