schema_serializer 0.0.10 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b6bc2cff5526334dace598f45ed47da1f0d8f317ee0f975dedcd40d27608d77
-  data.tar.gz: 50669a20d59a8b6a981fbeb10a4511cf8df415ef38d681635113f5771fef341a
+  metadata.gz: ce8b784d53825c2ff0a5f82ac095857c27d44114c4323643d80007584ec91b5b
+  data.tar.gz: 82c3df51ee031ad3467921f36f1b99084b720ad4600d884f33bfc125b9b28dd1
 SHA512:
-  metadata.gz: 2d492f118474bedb29c1a2b495de2a06342385240d72c88bd640cdf55e34f0def671022f1fe801bb408af71c6c96ecf7e668ebc87eafb984c04498eeda723ec6
-  data.tar.gz: 159d83ee1b6b638b6c9f0c5f5fa8944e1cbb022f04ee0902a060fd27f5fc6ce902de3b0ef92f635330b8905291ef8b27919f0970802a8ab76f994febed35b9a4
+  metadata.gz: 775feba8344022256123867edf0f94eb08c0b8912ab43e079962c60cca0f32d31145cd50e7d1bba5c50e9cb5cad675f0ea011b40ecd8d60191dff58426c93639
+  data.tar.gz: 1e48cce1a7b7bd4856eaa218239213a4864bc17969376b1aad55dc9bb30e1764af96ce75155f2fdbf9bdc4c455572325dc60c4f040fe26b4390bf67ee23f6815

data/.gitignore

@@ -7,3 +7,5 @@
 /spec/reports/
 /tmp/
 /Gemfile.lock
+
+.rspec_status

data/.rubocop.yml

@@ -1,29 +1,21 @@
 AllCops:
+  TargetRubyVersion: 2.6
   Exclude:
     - "node_modules/**/*"
     - "vendor/**/*"
-    - "db/schema.rb"
 
-Layout/ExtraSpacing:
-  Exclude:
-    - "db/migrate/*.rb"
-
-Layout/IndentArray:
+Layout/IndentFirstArrayElement:
   EnforcedStyle: consistent
 
-Layout/IndentHash:
+Layout/IndentFirstHashElement:
   EnforcedStyle: consistent
 
 Layout/IndentationConsistency:
-  Enabled: true
-  EnforcedStyle: rails
+  EnforcedStyle: indented_internal_methods
 
 Layout/MultilineMethodCallIndentation:
   EnforcedStyle: indented_relative_to_receiver
 
-Layout/SpaceInsideBlockBraces:
-  SpaceBeforeBlockParameters: false
-
 Lint/AmbiguousBlockAssociation:
   Exclude:
     - "spec/**/*_spec.rb"
@@ -38,17 +30,12 @@ Lint/UnusedMethodArgument:
   Enabled: false
 
 Metrics/AbcSize:
-  Max: 25
+  Max: 24
 
 Metrics/BlockLength:
   Exclude:
-    - "Rakefile"
-    - "**/*.rake"
     - "spec/**/*.rb"
     - "Gemfile"
-    - "config/environments/*.rb"
-    - "config/routes.rb"
-    - "config/routes/**/*.rb"
     - "*.gemspec"
 
 CyclomaticComplexity:
@@ -56,20 +43,13 @@ CyclomaticComplexity:
 
 Metrics/LineLength:
   Max: 120
-  Exclude:
-    - "db/migrate/*.rb"
 
 Metrics/MethodLength:
   Max: 20
-  Exclude:
-    - "db/migrate/*.rb"
 
 Naming/UncommunicativeMethodParamName:
   Enabled: false
 
-Performance/Casecmp:
-  Enabled: false
-
 Security/YAMLLoad:
   Enabled: false
 
@@ -121,7 +101,6 @@ Style/FrozenStringLiteralComment:
 
 Style/HashSyntax:
   Exclude:
-    - "**/*.rake"
     - "Rakefile"
 
 Style/MultilineBlockChain:
@@ -130,7 +109,6 @@ Style/MultilineBlockChain:
 Style/MixinUsage:
   Exclude:
     - "bin/setup"
-    - "bin/update"
 
 Style/NumericLiterals:
   MinDigits: 7
@@ -142,6 +120,9 @@ Style/NumericPredicate:
 Style/OrAssignment:
   Enabled: false
 
+Style/PercentLiteralDelimiters:
+  Enabled: false
+
 Style/PreferredHashMethods:
   EnforcedStyle: verbose
 
@@ -160,6 +141,9 @@ Style/StringLiterals:
 Style/StringLiteralsInInterpolation:
   EnforcedStyle: double_quotes
 
+Style/SymbolArray:
+  Enabled: false
+
 Style/TernaryParentheses:
   EnforcedStyle: require_parentheses_when_complex
 
@@ -172,5 +156,5 @@ Style/TrailingCommaInArrayLiteral:
 Style/TrailingCommaInHashLiteral:
   EnforcedStyleForMultiline: comma
 
-Style/YodaCondition:
-  EnforcedStyle: equality_operators_only
+Style/WordArray:
+  Enabled: false

data/.travis.yml

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

data/Gemfile

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

data/README.md

@@ -1,5 +1,8 @@
 # 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)
+
 SchemaSerializer is provide serialization from schema definition to JSON.
 
 ## Installation
@@ -12,32 +15,58 @@ gem "schema_serializer"
 
 And then execute:
 
+```bash
+$ bundle install
 ```
-$ bundle
+
+Create config file(Only Rails) with:
+
+```bash
+$ bundle exec rails generate schema_serializer:install
 ```
 
+The following file will be created.
+
+- `config/initializers/schema_serializer.rb`
+- `doc/schema.yml`
+
 ## Usage
 
+### Create a serializer template with Rails Generator
+
+Create a serializer template in `app/serializers/user_serializer.rb`.
+
+```bash
+$ bundle exec rails g schema_serializer:serializer User
 ```
-SchemaSerializer.definition = {
-  "User" => {
-    "required" => ["id", "name"],
-    "properties" => {
-      "id" => {
-        "type" => "integer",
-      },
-      "name" => {
-        "type" => "string",
-      },
-      "age" => {
-        "type" => "number",
-        "nullable" => true,
-      },
-    }
-  }
-}
-
-User.take.as_json
+
+### Serializer Definitions
+
+Serializer Definitions are describe in the `doc/schema.yml`.
+
+```yaml
+User:
+  required:
+    - id
+    - name
+  properties:
+    id:
+      type: integer
+    name:
+      type: string
+    age:
+      type: integer
+      nullable: true
+```
+
+### Serialization
+
+```ruby
+user = User.take
+SchemaSerializer.new(user).as_json.to_json
+
+# Only ActiveRecord Object
+user.serializer.as_json.to_json
 ```
 
 ## Development

data/Rakefile

@@ -1,10 +1,6 @@
 require "bundler/gem_tasks"
-require "rake/testtask"
+require "rspec/core/rake_task"
 
-Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
-end
+RSpec::Core::RakeTask.new(:spec)
 
-task default: :test
+task default: :spec

data/bin/profile

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "schema_serializer"
+
+User = Struct.new(:id, :name, :age, :gender, :email, :created_at)
+User.include SchemaSerializer::Serializable
+users = Array.new(10000) { |i|
+  User.new(i.to_s, "abcdefg", rand(80).to_s, rand(2).to_s, "user#{i}@example.com", Time.now)
+}
+SchemaSerializer.definition = {
+  "User" => {
+    "required" => %w(id name),
+    "properties" => {
+      "id" => { "type" => "integer" },
+      "name" => { "type" => "string" },
+      "age" => { "type" => "integer" },
+      "gender" => { "type" => "integer" },
+      "email" => { "type" => "string" },
+      "created_at" => { "type" => "string" },
+    },
+  },
+}
+
+start_at = Time.now
+users.each do |user|
+  user.serializer.as_json
+end
+elapsed = Time.now - start_at
+puts elapsed

data/bin/setup

@@ -3,4 +3,4 @@ set -euo pipefail
 IFS=$'\n\t'
 set -vx
 
-bundle install --path .bundle
+bundle install --path .bundle -j 4

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

@@ -1,7 +1 @@
-# Uncomment following if use OpenAPI 3 specification.
-# require "schema_serializer/definition/from_openapi3_parser"
-# SchemaSerializer.definition = SchemaSerializer::Definition::FromOpenapi3Parser.build(
-#   Openapi3Parser.load_file(Rails.root.join("doc/schema.yml"))
-# )
-
-SchemaSerializer.definition = YAML.load_file(Rails.root.join("doc/schema.yml"))
+SchemaSerializer.load_definition(Rails.root.join("doc/schema.yml"))

data/lib/schema_serializer/definition/from_openapi3_parser.rb

@@ -10,7 +10,7 @@ class SchemaSerializer::Definition
       private
 
         def schemas_to_hash(schemas)
-          schemas.each_with_object({}) {|(name, node), obj|
+          schemas.each_with_object({}) { |(name, node), obj|
             obj[name.to_s] = node_to_hash(node)
           }
         end
@@ -22,7 +22,7 @@ class SchemaSerializer::Definition
             obj["items"] = node_to_hash(node.items)
           when "object", nil
             obj["required"] = node.required&.node_data || []
-            obj["properties"] = node.properties.each_with_object({}) {|(name, property), properties|
+            obj["properties"] = node.properties.each_with_object({}) { |(name, property), properties|
               properties[name.to_s] = node_to_hash(property)
             }
           end

data/lib/schema_serializer/definition.rb

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

data/lib/schema_serializer/schema.rb

@@ -11,7 +11,7 @@ class SchemaSerializer
         @items = self.class.new(hash.fetch("items"))
       when "object", nil
         @required = hash["required"] || []
-        @properties = hash.fetch("properties").each_with_object({}) {|(column, property), obj|
+        @properties = hash.fetch("properties").each_with_object({}) { |(column, property), obj|
           obj[column] = self.class.new(property)
         }
       end
@@ -30,11 +30,12 @@ class SchemaSerializer
       when "boolean"
         !object.nil?
       when "array"
-        object.map {|item| items.serialize(item) }
+        object.map { |item| items.serialize(item) }
       else
         not_enough_columns = required - properties.keys
         raise RequiredNotDefined, not_enough_columns.join(", ") unless not_enough_columns.empty?
-        properties.each_with_object({}) {|(column, schema), obj|
+
+        properties.each_with_object({}) { |(column, schema), obj|
           obj[column] = schema.serialize(get_value(object, column))
         }
       end

data/lib/schema_serializer/version.rb

@@ -1,3 +1,3 @@
 class SchemaSerializer
-  VERSION = "0.0.10".freeze
+  VERSION = "0.1.0".freeze
 end

data/lib/schema_serializer.rb

@@ -14,6 +14,10 @@ class SchemaSerializer
   class << self
     attr_reader :definition
 
+    def load_definition(path)
+      self.definition = YamlExt.load(path)
+    end
+
     def definition=(define)
       @definition = define.is_a?(SchemaSerializer::Definition) ? define : SchemaSerializer::Definition.new(define)
     end

data/schema_serializer.gemspec

@@ -17,17 +17,20 @@ Gem::Specification.new do |spec|
     f.match(%r{^(test|spec|features)/})
   end
   spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) {|f| File.basename(f) }
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "activesupport"
+  spec.add_dependency "activesupport", ">= 5.2.0"
+  spec.add_dependency "yaml_ext", "0.1.0"
 
-  spec.add_development_dependency "activerecord"
-  spec.add_development_dependency "bundler", "~> 1.16"
-  spec.add_development_dependency "minitest", "~> 5.0"
-  spec.add_development_dependency "openapi3_parser"
-  spec.add_development_dependency "pry"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rubocop"
-  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "activerecord", ">= 5.2.0"
+  spec.add_development_dependency "bundler", "~> 2.0.2"
+  spec.add_development_dependency "pry", "~> 0.12.2"
+  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"
+
+  # optional
+  spec.add_development_dependency "openapi3_parser", "~> 0.5.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: schema_serializer
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.1.0
 platform: ruby
 authors:
 - i2bskn
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-05 00:00:00.000000000 Z
+date: 2019-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,58 +16,72 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.2.0
+- !ruby/object:Gem::Dependency
+  name: yaml_ext
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.0
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.2.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: 2.0.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: 2.0.2
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 0.12.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 0.12.2
 - !ruby/object:Gem::Dependency
-  name: openapi3_parser
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,61 +95,61 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.8.0
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 0.74.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 0.74.0
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.4.0
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: openapi3_parser
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.5.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.5.2
 description: SchemaSerializer is provide serialization from schema definition to JSON.
 email:
 - i2bskn@gmail.com
@@ -151,6 +165,7 @@ files:
 - README.md
 - Rakefile
 - bin/console
+- bin/profile
 - bin/setup
 - lib/generators/schema_serializer/install/USAGE
 - lib/generators/schema_serializer/install/install_generator.rb
@@ -187,8 +202,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: SchemaSerializer is provide serialization from schema definition to JSON.