oas_divider 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: daefa07bc1b005749456c534967daf3c586886c32f6976cae06cd1da46553541
+  data.tar.gz: 2f815a695d9e5198f896197892c347b1209886856e2c57d16f1c0a6efd94373e
+SHA512:
+  metadata.gz: 55b8728fa5947dd49e518d3278dc3cadca05ee754cf6053481a90498cffc3d04b33984fa32d0b9be7eec54aee13dc0faa4288b02003781172d62b28442b2b1c9
+  data.tar.gz: 6d834f629c96d5b416e9b76a3b892068c249745cac53a6c3503a67c743e68d77049620e3a78de27ae26fbc7255ad22425110be25f88bc45268f95f3be80791af

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.0
+before_install: gem install bundler -v 2.1.4

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 hikalin8686@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,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in oas_divider.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 lighty
+
+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,44 @@
+# OasDivider
+
+Divides the OpenAPI format schema definition file described in one file into multiple files.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'oas_divider'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install oas_divider
+
+## Usage
+
+```shell
+bundle exec exe/oas_divider
+```
+
+## 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]/oas_divider. 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]/oas_divider/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 OasDivider project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/oas_divider/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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "oas_divider"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

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/exe/oas_divider

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'oas_divider'
+
+OasDivider::Cli.new('swagger_original.yml').divide

data/lib/oas_divider.rb

@@ -0,0 +1,69 @@
+require "oas_divider/version"
+require 'yaml'
+require 'fileutils'
+
+require 'oas_divider/components_object_field_object'
+require 'oas_divider/paths_object'
+require 'oas_divider/relative_document_referencer'
+require 'oas_divider/schema_object'
+
+module OasDivider
+  class Cli
+
+    def initialize(file_name)
+      @file_name = file_name
+    end
+
+    def divide
+      load_file_as_open_api_object
+      save_divided_files
+      save_open_api_object_as_root_file
+    end
+
+    private
+
+    def save_divided_files
+      open_api_object.keys.each do |open_api_object_field|
+        if open_api_object_field === "paths" 
+          FileUtils.mkdir_p('paths')
+          paths_objects = open_api_object[open_api_object_field]
+          paths_objects.keys.each do |path|
+            path_object = PathsObject.new(path, paths_objects[path]) # 一つのpathオブジェクト。postなどがキー
+            path_object.to_file
+            open_api_object[open_api_object_field][path] = { "$ref" => path_object.ref }
+          end
+        end
+
+        if open_api_object_field === "components" 
+          FileUtils.mkdir_p('components')
+          components_objects = open_api_object[open_api_object_field]
+          components_objects.keys.each do |components_object_field|
+            if components_object_field === 'schemas'
+              FileUtils.mkdir_p('components/schemas')
+              schmas = components_objects[components_object_field]
+              schmas.keys.each do |schema_name|
+                schema_object = SchemaObject.new(schema_name, schmas[schema_name])
+                schema_object.to_file
+                open_api_object[open_api_object_field][components_object_field][schema_name] = { "$ref" => schema_object.ref }
+              end
+            else
+              field_object = ComponentsObjectFieldObject.new(components_object_field, components_objects[components_object_field])
+              field_object.to_file
+              open_api_object[open_api_object_field][components_object_field] = { "$ref" => field_object.ref }
+            end
+          end
+        end
+      end
+    end
+
+    def load_file_as_open_api_object
+      self.open_api_object = YAML.load_file(file_name)
+    end
+
+    def save_open_api_object_as_root_file
+      YAML.dump(open_api_object, File.open('swagger_root.yml', 'w'))
+    end
+
+    attr_accessor :file_name, :open_api_object
+  end
+end

data/lib/oas_divider/components_object_field_object.rb

@@ -0,0 +1,31 @@
+module OasDivider
+  class ComponentsObjectFieldObject
+    attr_accessor :field_name, :field_object
+
+    def initialize(field_name, field_object)
+      @field_name = field_name
+      @field_object = field_object
+    end
+
+    def to_file
+      convert_ref
+      YAML.dump(field_object, File.open( File.join(directory, file_name) , 'w') )
+    end
+
+    def directory
+      'components'
+    end
+
+    def file_name
+      "#{field_name}.yml"
+    end
+
+    def ref
+      File.join(directory, file_name)
+    end
+
+    def convert_ref
+      RelativeDocumentReferencer.execute(field_object, 1)
+    end
+  end
+end

data/lib/oas_divider/paths_object.rb

@@ -0,0 +1,43 @@
+module OasDivider
+  class PathsObject
+    attr_accessor :path, :path_item_objects
+
+    def initialize(path, path_item_objects)
+      @path = path
+      @path_item_objects = path_item_objects
+    end
+
+    def to_file
+      make_directory
+      convert_ref
+      YAML.dump(path_item_objects, File.open( File.join(directory, file_name) , 'w') )
+    end
+
+    def make_directory
+      FileUtils.mkdir_p( directory )
+    rescue => e
+      puts "path: #{@path}"
+      throw e
+    end
+
+    def interlevel_directory
+      @path.split('/').length > 2 ? @path.split('/')[1..-2].map {|dir| dir.gsub(/[{}]/,"")} : ''
+    end
+
+    def directory
+      File.join( 'paths' , interlevel_directory)
+    end
+
+    def file_name
+      "#{@path.split('/').pop.gsub(/[{}]/,"")}.yml"
+    end
+
+    def ref
+      File.join(directory, file_name)
+    end
+
+    def convert_ref
+      RelativeDocumentReferencer.execute(path_item_objects, 1 + interlevel_directory.size)
+    end
+  end
+end

data/lib/oas_divider/relative_document_referencer.rb

@@ -0,0 +1,47 @@
+module OasDivider
+  class RelativeDocumentReferencer
+    def self.execute(root, depth)
+      new(root, depth).execute
+    end
+
+    def initialize(root, depth)
+      @root = root
+      @depth = depth
+    end
+
+    def execute
+      lookup(root)
+      root
+    end
+
+    # hashで、keyが$refならconvert
+    # hashかarrayならlookup
+    # そうでないならなにもしない
+    def lookup(object)
+      if object.is_a? Array
+        object.each { |value| lookup(value) if value.is_a?(Hash) || value.is_a?(Array) }
+      else
+        object.each do |key, value|
+          set_converted_value(object, key, value) if key === "$ref"
+          lookup(value) if value.is_a?(Hash) || value.is_a?(Array)
+        end
+      end
+    end
+
+    def set_converted_value(object, key, value)
+      object[key] = convert(value)
+    end
+    
+    def convert(ref)
+      # componentから取得することしか考えない
+      if ref.split('/')[2] === 'schemas'
+        "../" * depth + "#{ref.split('/')[1..3].join('/')}.yml"
+      else
+        "../" * depth + "#{ref.split('/')[1..2].join('/')}.yml#/#{ref.split('/')[3]}"
+      end
+    end
+
+  private
+    attr :root, :depth
+  end
+end

data/lib/oas_divider/schema_object.rb

@@ -0,0 +1,31 @@
+module OasDivider
+  class SchemaObject
+    attr_accessor :schema_name, :schema_object
+
+    def initialize(schema_name, schema_object)
+      @schema_name = schema_name
+      @schema_object = schema_object
+    end
+
+    def to_file
+      convert_ref
+      YAML.dump(schema_object, File.open( File.join(directory, file_name) , 'w') )
+    end
+
+    def directory
+      'components/schemas'
+    end
+
+    def file_name
+      "#{schema_name}.yml"
+    end
+
+    def ref
+      File.join(directory, file_name)
+    end
+
+    def convert_ref
+      RelativeDocumentReferencer.execute(schema_object, 2)
+    end
+  end
+end

data/lib/oas_divider/version.rb

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

data/oas_divider.gemspec

@@ -0,0 +1,27 @@
+require_relative 'lib/oas_divider/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "oas_divider"
+  spec.version       = OasDivider::VERSION
+  spec.authors       = ["lighty"]
+  spec.email         = ["hikalin8686@gmail.com"]
+
+  spec.summary       = %q{Divides the OpenAPI format schema definition file described in one file into multiple files.}
+  spec.description   = %q{Divides the OpenAPI format schema definition file described in one file into multiple files.}
+  spec.homepage      = "https://twitter.com/hikalin8686"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/lighty/oas_divider"
+  spec.metadata["changelog_uri"] = "https://github.com/lighty/oas_divider"
+
+  # 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"]
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: oas_divider
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- lighty
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-03-15 00:00:00.000000000 Z
+dependencies: []
+description: Divides the OpenAPI format schema definition file described in one file
+  into multiple files.
+email:
+- hikalin8686@gmail.com
+executables:
+- oas_divider
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/oas_divider
+- lib/oas_divider.rb
+- lib/oas_divider/components_object_field_object.rb
+- lib/oas_divider/paths_object.rb
+- lib/oas_divider/relative_document_referencer.rb
+- lib/oas_divider/schema_object.rb
+- lib/oas_divider/version.rb
+- oas_divider.gemspec
+homepage: https://twitter.com/hikalin8686
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://twitter.com/hikalin8686
+  source_code_uri: https://github.com/lighty/oas_divider
+  changelog_uri: https://github.com/lighty/oas_divider
+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.0.3
+signing_key:
+specification_version: 4
+summary: Divides the OpenAPI format schema definition file described in one file into
+  multiple files.
+test_files: []