yaml_ref 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ad52297c8836ced1bb7313a83cf608d79de8a441d624cecb3c15ee415040c73b
+  data.tar.gz: 7aa1fd3d1bc58b4e7a785d5995ec8047feb14835c4fe1d8d32376b8502a91045
+SHA512:
+  metadata.gz: f11e54c4c6937f0451f2d8c4cf722552d9c85e2383e54177da055334823ed9e9b8f01fd44edaf9b18160694f39c84490793e8da84874182ccd20a57df1dea9ee
+  data.tar.gz: 17e0633f6956ad24aaf0939a2e1f619a2677b53d9955b87b5305b0645b69aa52b0460e4cc2d4a4ea1c5f14a01916908434957f5eed78741ba42e5872f50680f5

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,8 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.0
+before_install: gem install bundler -v 2.1.2
+script:
+  - bundle exec rspec

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at tomisuker16@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in yaml_ref.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    yaml_ref (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (11.1.1)
+    coderay (1.1.2)
+    diff-lcs (1.3)
+    method_source (0.9.2)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.8.0)
+      byebug (~> 11.0)
+      pry (~> 0.10)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.1)
+      rspec-support (~> 3.9.1)
+    rspec-expectations (3.9.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  pry
+  pry-byebug
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  yaml_ref!
+
+BUNDLED WITH
+   2.1.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 atomiyama
+
+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,97 @@
+[![Build Status](https://travis-ci.org/atomiyama/yaml_ref.svg?branch=master)](https://travis-ci.org/atomiyama/yaml_ref)
+
+# YamlRef
+
+YamlRef allows you to define $ref that refers file with relative path.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'yaml_ref'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install yaml_ref
+
+## Usage
+
+```ruby
+require 'yaml_ref'
+
+YamlRef.load_file("/path/to/yaml")
+```
+
+It has the following effects:
+
+```yaml
+gem:
+  name: YamlRef
+  information:
+    $ref: '../information.yml'
+  license:
+    $ref: '#/schema/MIT'
+  releases:
+    - $ref: '../releases/0_0_1.yml'
+```
+
+```yaml
+gem:
+  name: YamlRef
+  information:
+    # contents of information.yaml
+    summary: "YAML file ref resolver"
+    description: "Expand the $ref that refers to the file in the yaml file."
+  license:
+    $ref: '#/schema/MIT'
+  releases:
+    # contents of realeases/0_0_1.yaml
+    - version: "0.0.1"
+      features:
+        vision: 'Allow file $ref with relative path.'
+      authors:
+        - 'atomiyama'
+
+```
+
+### Relative path home.
+If ref path(e.g. `$ref: 'path/to/file/from/specific/location'`) is defined as a relative path from a specific location.
+Pass `ref_home` keyword argument or define ref_home on root level in YAML file it works fine.
+
+```ruby
+# ref_home argument
+YamlRef.load_file("/path/to/yaml", ref_home: "/path/to/ref_home")
+```
+
+```yaml
+# ~/home.yml
+ref_home: "~"
+yaml_ref:
+  # This $ref will expand ~/reference.yml
+  $ref: 'reference.yml'
+```
+
+## 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/[USERNAME]/yaml_ref_resolver. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/yaml_ref_resolver/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the YamlRefResolver project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/yaml_ref_resolver/blob/master/CODE_OF_CONDUCT.md).

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 "yaml_ref"
+
+# 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/lib/yaml_ref/version.rb

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

data/lib/yaml_ref.rb

@@ -0,0 +1,94 @@
+require "yaml_ref/version"
+require "yaml"
+
+module YamlRef
+  class Error < StandardError; end
+
+  class << self
+    #
+    # @params [String] path
+    # @return [Object]
+    #
+    # If ref path is defined as a relative path from a specific location,
+    # pass ref_home argument or define ref_home on root level in YAML file.
+    #
+    def load_file(path, ref_home: nil)
+      schema = YAML.load_file(path)
+      @ref_home = ref_home || schema["ref_home"]
+      parse_schema(schema, path)
+    end
+
+    private
+
+    #
+    # @private
+    #
+    # @params [Array | Hash] schema
+    # @params [String] path]
+    #
+    # @return [Array | hash]
+    #
+    def parse_schema(schema, path)
+      case
+      when schema.is_a?(Hash)
+        parse_hash_schema(schema, path)
+      when schema.is_a?(Array)
+        parse_array_schema(schema, path)
+      else
+        schema
+      end
+    end
+
+    #
+    # @private
+    #
+    # @params [Hash] schema
+    # @params [String] path
+    #
+    # @return [hash]
+    #
+    def parse_hash_schema(schema, path)
+      schema.inject({}) do |hash, (key, value)|
+        # in this case, value must be String.
+        if key == "$ref"
+          if value.start_with?("#")
+            # It does not be resolved because
+            # Most Services, such as swaggerUI,
+            # provide the feature to resolve json key references.
+            # e.g.
+            #   $ref: "#/components/schemas/User"
+            break { key => value }
+          else
+            # Value can be file path.
+            # e.g.
+            #   $ref: "../reference.yml"
+            break parse_schema(*file_ref(path, value))
+          end
+        else
+          hash[key] = parse_schema(value, path)
+          hash
+        end
+      end
+    end
+
+    #
+    # @private
+    #
+    # @params [Array] schema
+    # @params [String] path
+    #
+    # @return [Array]
+    #
+    def parse_array_schema(schema, path)
+      schema.inject([]) do |array, element|
+        array << parse_schema(element, path)
+        array
+      end
+    end
+
+    def file_ref(filepath, refpath)
+      path = File.expand_path(File.join(@ref_home || filepath, refpath))
+      [YAML.load_file(path), path]
+    end
+  end
+end

data/yaml_ref.gemspec

@@ -0,0 +1,28 @@
+require_relative 'lib/yaml_ref/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "yaml_ref"
+  spec.version       = YamlRef::VERSION
+  spec.authors       = ["atomiyama"]
+  spec.email         = ["tomisuker16@gmail.com"]
+
+  spec.summary       = "YAML file ref resolver"
+  spec.description   = "Allow file $ref with relative path"
+  spec.homepage      = "https://github.com/atomiyama/yaml_ref"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  # 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 "pry"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "rake", "~> 12.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: yaml_ref
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- atomiyama
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-02-08 00:00:00.000000000 Z
+dependencies:
+- !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: pry-byebug
+  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: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Allow file $ref with relative path
+email:
+- tomisuker16@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/yaml_ref.rb
+- lib/yaml_ref/version.rb
+- yaml_ref.gemspec
+homepage: https://github.com/atomiyama/yaml_ref
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: YAML file ref resolver
+test_files: []