yaml_ext 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5c50a167ebcd2e16535c639ffb075f669e5460f36f1529f115c0ed9da5147b51
+  data.tar.gz: 12bdbf3f9ee69f5dbdd331c013b2708c585a4de4ab692399fad4821fabef1ec0
+SHA512:
+  metadata.gz: 34340ea31a332e792426961325dc2312dc6c2e643d0aea00f9bed21a0f12fba20823282af5181f205ea92991d407caba692c2dfbc26afaf8921f489e82b4ec7c
+  data.tar.gz: 9f5561dd431c156a93a71326e275f37458d25915c18d448b2611edcad207ab4dab83ed9a67fd1a121b6b9db9e0e90120e239b07c8da79a1019909f291334083c

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 yaml_ext.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,71 @@
+# YamlExt
+
+Multiple YAML Loader.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "yaml_ext"
+```
+
+And then execute:
+
+```bash
+$ bundle install
+```
+
+## Usage
+
+```ruby
+pry(main)> YamlExt.load("example/schema.yml")
+=> {"openapi"=>"3.0.0",
+ "info"=>{"version"=>"1.0.0", "title"=>"Example API"},
+ "servers"=>[{"url"=>"http://example.com/v1"}],
+ "paths"=>
+  {"/users"=>
+    {"get"=>
+      {"summary"=>"List all users",
+       "operationId"=>"listUsers",
+       "tags"=>["users"],
+       "parameters"=>[{"name"=>"limit", "in"=>"query", "description"=>"How many items to return at one time (max 100)", "required"=>false, "schema"=>{"type"=>"integer"}}],
+       "responses"=>
+        {"200"=>
+          {"description"=>"A paged array of users",
+           "headers"=>{"x-next"=>{"description"=>"A link to the next page of responses", "schema"=>{"type"=>"string"}}},
+           "content"=>{"application/json"=>{"schema"=>{"type"=>"array", "items"=>{"$ref"=>"#/components/schemas/User"}}}}},
+         "default"=>{"description"=>"unexpected error", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "required"=>["code", "message"], "properties"=>{"code"=>{"type"=>"integer"}, "message"=>{"type"=>"string"}}}}}}}},
+     "post"=>
+      {"summary"=>"Create a user",
+       "operationId"=>"createUsers",
+       "tags"=>["users"],
+       "responses"=>
+        {"201"=>{"description"=>"Null response"},
+         "default"=>{"description"=>"unexpected error", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "required"=>["code", "message"], "properties"=>{"code"=>{"type"=>"integer"}, "message"=>{"type"=>"string"}}}}}}}}},
+   "/users/{userId}"=>
+    {"get"=>
+      {"get"=>
+        {"summary"=>"Info for a specific user",
+         "operationId"=>"showUserById",
+         "tags"=>["users"],
+         "parameters"=>[{"name"=>"userId", "in"=>"path", "description"=>"The id of the user", "required"=>true, "schema"=>{"type"=>"integer"}}],
+         "responses"=>
+          {"200"=>{"description"=>"Expected response to a valid request", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "required"=>["id", "name"], "properties"=>{"id"=>{"type"=>"integer"}, "name"=>{"type"=>"string"}, "tag"=>{"type"=>"string"}}}}}},
+           "default"=>{"description"=>"unexpected error", "content"=>{"application/json"=>{"schema"=>{"type"=>"object", "required"=>["code", "message"], "properties"=>{"code"=>{"type"=>"integer"}, "message"=>{"type"=>"string"}}}}}}}}}}},
+ "components"=>
+  {"schemas"=>
+    {"User"=>{"type"=>"object", "required"=>["id", "name"], "properties"=>{"id"=>{"type"=>"integer"}, "name"=>{"type"=>"string"}, "tag"=>{"type"=>"string"}}},
+     "Users"=>{"type"=>"array", "items"=>{"type"=>"object", "required"=>["id", "name"], "properties"=>{"id"=>{"type"=>"integer"}, "name"=>{"type"=>"string"}, "tag"=>{"type"=>"string"}}}},
+     "Error"=>{"type"=>"object", "required"=>["code", "message"], "properties"=>{"code"=>{"type"=>"integer"}, "message"=>{"type"=>"string"}}}}}}
+```
+
+## 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/yaml_ext.

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 "yaml_ext"
+
+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/example/components/index.yml

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

data/example/components/schemas/Error.yml

@@ -0,0 +1,9 @@
+type: object
+required:
+  - code
+  - message
+properties:
+  code:
+    type: integer
+  message:
+    type: string

data/example/components/schemas/User.yml

@@ -0,0 +1,11 @@
+type: object
+required:
+  - id
+  - name
+properties:
+  id:
+    type: integer
+  name:
+    type: string
+  tag:
+    type: string

data/example/components/schemas/Users.yml

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

data/example/components/schemas/index.yml

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

data/example/paths/index.yml

@@ -0,0 +1,8 @@
+/users:
+  get:
+    $ref: ./users/list_users.yml
+  post:
+    $ref: ./users/create_users.yml
+/users/{userId}:
+  get:
+    $ref: ./users/show_user_by_id.yml

data/example/paths/users/create_users.yml

@@ -0,0 +1,13 @@
+summary: Create a user
+operationId: createUsers
+tags:
+  - users
+responses:
+  '201':
+    description: Null response
+  default:
+    description: unexpected error
+    content:
+      application/json:
+        schema:
+          $ref: "#/components/schemas/Error"

data/example/paths/users/list_users.yml

@@ -0,0 +1,29 @@
+summary: List all users
+operationId: listUsers
+tags:
+  - users
+parameters:
+  - name: limit
+    in: query
+    description: How many items to return at one time (max 100)
+    required: false
+    schema:
+      type: integer
+responses:
+  '200':
+    description: A paged array of users
+    headers:
+      x-next:
+        description: A link to the next page of responses
+        schema:
+          type: string
+    content:
+      application/json:
+        schema:
+          $ref: "#/components/schemas/Users"
+  default:
+    description: unexpected error
+    content:
+      application/json:
+        schema:
+          $ref: "#/components/schemas/Error"

data/example/paths/users/show_user_by_id.yml

@@ -0,0 +1,25 @@
+get:
+  summary: Info for a specific user
+  operationId: showUserById
+  tags:
+    - users
+  parameters:
+    - name: userId
+      in: path
+      description: The id of the user
+      required: true
+      schema:
+        type: integer
+  responses:
+    '200':
+      description: Expected response to a valid request
+      content:
+        application/json:
+          schema:
+            $ref: "#/components/schemas/User"
+    default:
+      description: unexpected error
+      content:
+        application/json:
+          schema:
+            $ref: "#/components/schemas/Error"

data/example/schema.yml

@@ -0,0 +1,10 @@
+openapi: "3.0.0"
+info:
+  version: 1.0.0
+  title: Example API
+servers:
+  - url: http://example.com/v1
+paths:
+  $ref: ./paths/index.yml
+components:
+  $ref: ./components/index.yml

data/lib/yaml_ext.rb

@@ -0,0 +1,79 @@
+require "erb"
+require "yaml"
+require "yaml_ext/version"
+
+module YamlExt
+  class << self
+    def load(path)
+      resolve_ref_inner_json(load_file(path))
+    end
+
+    def load_file(path)
+      parse_extended_node(load_yaml_file(path), path)
+    end
+
+    private
+
+      def load_yaml_file(path)
+        YAML.load(ERB.new(File.read(path), nil, "-").result)
+      end
+
+      def parse_extended_node(node, path)
+        case node
+        when Hash
+          node.each_with_object({}) { |(k, v), obj|
+            if k == "$ref" && v.is_a?(String) && !v.start_with?("#/")
+              value = load_file(File.expand_path(v, File.dirname(path)))
+              case value
+              when Hash
+                obj = {} unless obj.is_a?(Hash)
+                obj.merge!(value)
+              when Array
+                obj = [] unless obj.is_a?(Array)
+                obj.concat(value)
+              else
+                obj = value
+              end
+            else
+              obj = {} unless obj.is_a?(Hash)
+              obj[k] = parse_extended_node(v, path)
+            end
+          }
+        when Array
+          node.map { |n| parse_extended_node(n, path) }
+        else
+          node
+        end
+      end
+
+      def resolve_ref_inner_json(node, node_tree = nil)
+        node_tree ||= node
+
+        case node
+        when Hash
+          node.each_with_object({}) { |(k, v), obj|
+            if k == "$ref" && v.is_a?(String) && v.start_with?("#/")
+              value = v.split("/")[1..-1].inject(node_tree) { |nodes, key| nodes.fetch(key) }
+              case value
+              when Hash
+                obj = {} unless obj.is_a?(Hash)
+                obj.merge!(value)
+              when Array
+                obj = [] unless obj.is_a?(Array)
+                obj.concat(value)
+              else
+                obj = value
+              end
+            else
+              obj = {} unless obj.is_a?(Hash)
+              obj[k] = resolve_ref_inner_json(v, node_tree)
+            end
+          }
+        when Array
+          node.map { |n| resolve_ref_inner_json(n, node_tree) }
+        else
+          node
+        end
+      end
+  end
+end

data/lib/yaml_ext/version.rb

@@ -0,0 +1,3 @@
+module YamlExt
+  VERSION = "0.1.0"
+end

data/yaml_ext.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "yaml_ext/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "yaml_ext"
+  spec.version       = YamlExt::VERSION
+  spec.authors       = ["i2bskn"]
+  spec.email         = ["i2bskn@gmail.com"]
+
+  spec.summary       = %q{Multiple YAML Loader.}
+  spec.description   = %q{Multiple YAML Loader.}
+  spec.homepage      = "https://github.com/i2bskn/yaml_ext"
+
+  # 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"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "pry"
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: yaml_ext
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- i2bskn
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-04-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  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: minitest
+  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: 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'
+description: Multiple YAML Loader.
+email:
+- i2bskn@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- example/components/index.yml
+- example/components/schemas/Error.yml
+- example/components/schemas/User.yml
+- example/components/schemas/Users.yml
+- example/components/schemas/index.yml
+- example/paths/index.yml
+- example/paths/users/create_users.yml
+- example/paths/users/list_users.yml
+- example/paths/users/show_user_by_id.yml
+- example/schema.yml
+- lib/yaml_ext.rb
+- lib/yaml_ext/version.rb
+- yaml_ext.gemspec
+homepage: https://github.com/i2bskn/yaml_ext
+licenses: []
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Multiple YAML Loader.
+test_files: []