json_schema_helper 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1fdc09fb1ad0a5dc4da0d733aafee82e09bfd08c5357f7ab30f42568e2498921
+  data.tar.gz: 0cefa93036d94aa306e96ce48e327a806e3b85e8b6715d62cf44be1fa311a9f9
+SHA512:
+  metadata.gz: 5a1f34c20b2a031e4dd49394b47bb6e8e77d6ab98b9af4c0879ff0b5cb41bb8fdc98bdc6103949bb944ce62155baa0659568db75c079d4e9da449b29d01b6575
+  data.tar.gz: 618e2d19e0564cd71dc2992bf57943cb166c33530bb2d81b85c0b9fd1af49a6fe9fc2c8693628c2b5441d26e8e84a2122887508c4910f2321729102e5b551f2c

data/.gitignore

@@ -0,0 +1,11 @@
+/.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/.rubocop.yml

@@ -0,0 +1,18 @@
+# The behavior of RuboCop can be controlled via the .rubocop.yml
+# configuration file. It makes it possible to enable/disable
+# certain cops (checks) and to alter their behavior if they accept
+# any parameters. The file can be placed either in your home
+# directory or in some project directory.
+#
+# RuboCop will start looking for the configuration file in the directory
+# where the inspected file is and continue its way up to the root directory.
+#
+# See https://github.com/rubocop-hq/rubocop/blob/master/manual/configuration.md
+AllCops:
+  TargetRubyVersion: 2.6
+
+Metrics:
+  Enabled: false
+
+Naming/FileName:
+  Enabled: false

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in json_schema_helper.gemspec
+gemspec
+
+gem 'rubocop'

data/Gemfile.lock

@@ -0,0 +1,51 @@
+PATH
+  remote: .
+  specs:
+    json_schema_helper (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    diff-lcs (1.3)
+    jaro_winkler (1.5.3)
+    parallel (1.17.0)
+    parser (2.6.3.0)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    rubocop (0.74.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  json_schema_helper!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Yoshiyuki Hirano
+
+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,11 @@
+# JsonSchemaHelper
+
+JsonSchemaHelper is rake tasks for openapi3.
+
+## Usage
+
+See at `rake -T`
+
+## License
+
+MIT License

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'json_schema_helper'
+
+# 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/json_schema_helper.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('./lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'json_schema_helper/version'
+
+Gem::Specification.new do |s|
+  s.name          = 'json_schema_helper'
+  s.version       = JsonSchemaHelper::VERSION
+  s.authors       = ['Yoshiyuki Hirano']
+  s.email         = ['yhirano@me.com']
+  s.homepage      = 'https://github.com/yhirano55/json_schema_helper'
+  s.summary       = %(json schema helper)
+  s.description   = s.summary
+  s.license       = 'MIT'
+  s.files         = Dir.chdir(File.expand_path('.', __dir__)) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{^(test|spec|features)/})
+    end
+  end
+
+  s.bindir        = 'exe'
+  s.executables   = s.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  s.require_paths = ['lib']
+
+  s.required_rubygems_version = '>= 1.8.11'
+
+  s.add_development_dependency 'bundler', '~> 2.0'
+  s.add_development_dependency 'rake', '~> 10.0'
+  s.add_development_dependency 'rspec', '~> 3.0'
+end

data/lib/json_schema_helper.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'json_schema_helper/version'
+
+begin
+  require 'rails'
+  require 'json_schema_helper/railtie'
+rescue LoadError
+  nil
+end

data/lib/json_schema_helper/railtie.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module JsonSchemaHelper
+  class Railtie < ::Rails::Railtie # :nodoc:
+    rake_tasks do
+      load 'json_schema_helper/tasks/init.rake'
+      load 'json_schema_helper/tasks/update.rake'
+    end
+  end
+end

data/lib/json_schema_helper/tasks/init.rake

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+require 'fileutils'
+
+namespace :openapi3 do
+  desc 'init'
+  task init: :environment do
+    FileUtils.mkdir_p Rails.root.join('docs', 'openapi3', 'paths')
+    FileUtils.mkdir_p Rails.root.join('docs', 'openapi3', 'components', 'parameters')
+    FileUtils.mkdir_p Rails.root.join('docs', 'openapi3', 'components', 'schemas')
+
+    unless File.exist?('docs/openapi3/meta.yaml')
+      File.open('docs/openapi3/meta.yaml', 'wb+') do |io|
+        io.write <<~YAML
+          openapi: 3.0.0
+
+          info:
+            version: 1.0.0
+            title: #{Rails.application.class.to_s.deconstantize.titleize}
+
+          servers:
+          - url: http://localhost:3000
+        YAML
+      end
+    end
+
+    if Dir['./docs/openapi3/paths/**/*.yaml'].empty?
+      File.open('docs/openapi3/paths/v1.yaml', 'wb+') do |io|
+        io.write <<~YAML
+          # "/v1/admin_users":
+          #   get:
+          #     responses:
+          #       '200':
+          #         content:
+          #           application/json:
+          #             schema:
+          #               type: array
+          #               items:
+          #                 "$ref": "#/components/schemas/admin_user/properties/admin_user"
+          #     parameters:
+          #     - name: access_token
+          #       in: query
+          #       schema:
+          #         "$ref": "#/components/schemas/access_token"
+        YAML
+      end
+    end
+
+    if Dir['./docs/openapi3/components/parameters/**/*.yaml'].empty?
+      File.open('docs/openapi3/components/parameters/v1.yaml', 'wb+') do |io|
+        io.write <<~YAML
+          # v1_something__cursor:
+          #   name: cursor
+          #   in: query
+          #   schema:
+          #     nullable: true
+          #     type: string
+          #     format: date-time
+        YAML
+      end
+    end
+
+    if Dir['./docs/openapi3/components/schemas/**/*.yaml'].empty?
+      File.open('docs/openapi3/components/schemas/v1.yaml', 'wb+') do |io|
+        io.write <<~YAML
+          # access_token:
+          #   type: string
+          #
+          # user_id:
+          #   type: integer
+          #
+          # datetime:
+          #   description: datetime
+          #   type: string
+          #   format: date-time
+          #
+          # nullable_datetime:
+          #   description: datetime
+          #   type: string
+          #   format: date-time
+          #   nullable: true
+        YAML
+      end
+    end
+  end
+end

data/lib/json_schema_helper/tasks/update.rake

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+namespace :openapi3 do
+  desc 'combine YAML files'
+  task combine: :environment do
+    schema = {}
+    schema.merge! YAML.load_file(Rails.root.join('docs', 'openapi3', 'meta.yaml'))
+
+    schema['paths'] = {}
+
+    Dir[Rails.root.join('docs', 'openapi3', 'paths', '**', '*.yaml')].sort.each do |path|
+      $stdout.puts "merge #{path}"
+      schema['paths'].merge!(YAML.load_file(path) || {})
+    rescue StandardError => e
+      $stdout.puts "error #{path}: #{e.message}"
+      exit
+    end
+
+    schema['components'] = {}
+
+    schema['components']['parameters'] = {}
+    Dir[Rails.root.join('docs', 'openapi3', 'components', 'parameters', '**', '*.yaml')].sort.each do |path|
+      $stdout.puts "merge #{path}"
+      schema['components']['parameters'].merge!(YAML.load_file(path) || {})
+    rescue StandardError => e
+      $stdout.puts "error #{path}: #{e.message}"
+      exit
+    end
+
+    schema['components']['schemas'] = {}
+    Dir[Rails.root.join('docs', 'openapi3', 'components', 'schemas', '**', '*.yaml')].sort.each do |path|
+      $stdout.puts "merge #{path}"
+      schema['components']['schemas'].merge!(YAML.load_file(path) || {})
+    rescue StandardError => e
+      $stdout.puts "error #{path}: #{e.message}"
+      exit
+    end
+
+    schema['paths'] = Hash[schema['paths'].sort_by { |k, _| k }]
+    schema['components']['parameters'] = Hash[schema['components']['parameters'].sort_by { |k, _| k }]
+    schema['components']['schemas'] = Hash[schema['components']['schemas'].sort_by { |k, _| k }]
+
+    dest = Rails.root.join('docs', 'schema.yaml')
+
+    File.open(dest, 'wb+') do |io|
+      io.write YAML.dump(schema)
+    end
+
+    $stdout.puts "Update file: #{dest}"
+  end
+
+  desc 'verify YAML files'
+  task verify: :environment do
+    # implement later
+  end
+
+  desc 'update schema'
+  task update: %w[openapi3:verify openapi3:combine]
+end

data/lib/json_schema_helper/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module JsonSchemaHelper
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: json_schema_helper
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yoshiyuki Hirano
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-08-06 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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.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: json schema helper
+email:
+- yhirano@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- json_schema_helper.gemspec
+- lib/json_schema_helper.rb
+- lib/json_schema_helper/railtie.rb
+- lib/json_schema_helper/tasks/init.rake
+- lib/json_schema_helper/tasks/update.rake
+- lib/json_schema_helper/version.rb
+homepage: https://github.com/yhirano55/json_schema_helper
+licenses:
+- MIT
+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: 1.8.11
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: json schema helper
+test_files: []