json-schema-subset-dsl 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fb5013ebaff6df3b177c3aa955acadd4d3ebb6f163effa1945482f43c6ef659c
+  data.tar.gz: 300c9272d2771a22df0bc753b902597d2a45376bc9ba6d487dbed936c3d06ec1
+SHA512:
+  metadata.gz: 31e72cb5f90d0db5460b396b0efca43164f2ce097e2cf9a5930fd20e8334e1595df3e6d1cf97a9636623d9653615d953d5cea8b8202f957ce0187ca760782687
+  data.tar.gz: b7193dc88e2e8d5f8efdb2fff2a1e545556ad6c55a63b980345005a1a097d107fdb550c41ec6dcd69f777056a312910a9336b326d58b64334e114b62747ffdb5

data/.github/workflows/ruby.yml

@@ -0,0 +1,20 @@
+name: Ruby
+
+on: [push]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v1
+    - name: Set up Ruby 2.x
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.x
+    - name: Build and test with Rake
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+        bundle exec rake

data/.gitignore

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

data/.prettierrc

@@ -0,0 +1,3 @@
+printWidth: 120
+addTrailingCommas: true
+preferSingleQuotes: false

data/.rspec

@@ -0,0 +1,4 @@
+--format documentation
+--color
+--require rspec-power_assert
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,25 @@
+inherit_from:
+  - .rubocop_airbnb.yml
+inherit_gem:
+  rubocop-config-prettier: config/rubocop.yml
+# prettier
+Style/PercentLiteralDelimiters:
+  Description: Use `%`-literal delimiters consistently
+  StyleGuide: https://github.com/rubocop-hq/ruby-style-guide#percent-literal-braces
+  Enabled: false
+  PreferredDelimiters:
+    ! '%': ()
+    ! '%i': ()
+    ! '%q': ()
+    ! '%Q': ()
+    ! '%r': ! '{}'
+    ! '%s': ()
+    ! '%w': ()
+    ! '%W': ()
+    ! '%x': ()
+Airbnb/SimpleModifierConditional:
+  Enabled: false
+Airbnb/OptArgParameters:
+  Enabled: false
+RSpec/EmptyExampleGroup:
+  Enabled: false

data/.rubocop_airbnb.yml

@@ -0,0 +1,2 @@
+require:
+  - rubocop-airbnb

data/.travis.yml

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2019 Narazaka
+
+This software is provided 'as-is', without any express or implied
+warranty. In no event will the authors be held liable for any damages
+arising from the use of this software.
+
+Permission is granted to anyone to use this software for any purpose,
+including commercial applications, and to alter it and redistribute it
+freely, subject to the following restrictions:
+
+   1. The origin of this software must not be misrepresented; you must not
+   claim that you wrote the original software. If you use this software
+   in a product, an acknowledgment in the product documentation would be
+   appreciated but is not required.
+
+   2. Altered source versions must be plainly marked as such, and must not be
+   misrepresented as being the original software.
+
+   3. This notice may not be removed or altered from any source
+   distribution.

data/README.md

@@ -0,0 +1,79 @@
+# Json::Schema::Subset::DSL
+
+Yet another JSON Schema subset DSL.
+
+Useful when writing a simple JSON schema.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'json-schema-subset-dsl'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install json-schema-subset-dsl
+
+## Usage
+
+```ruby
+dsl = Json::Schema::Subset::DSL.new do
+  title! "Example"
+  id :integer
+  name :string, minLength: 1, optional: true
+  items :array, optional: true do
+  end
+  other_names :array, optional: true do
+    string!
+    null!
+  end
+  meta :object do
+    description :string
+    params :array do
+      ref! "#/components/Param"
+    end
+    opt_params :array do
+      cref! "OptParam"
+    end
+    uuid :ref, "#/UUID", optional: true
+  end
+end
+
+dsl.compile! == {
+  "type" => "object",
+  "properties" => {
+    "id" => { "type" => "integer" },
+    "name" => { "minLength" => 1, "type" => "string" },
+    "items" => { "items" => { "type" => "object", "properties" => {} }, "type" => "array" },
+    "other_names" => { "items" => { "type" => %w[string null] }, "type" => "array" },
+    "meta" => {
+      "type" => "object",
+      "properties" => {
+        "description" => { "type" => "string" },
+        "params" => { "items" => { "$ref" => "#/components/Param" }, "type" => "array" },
+        "opt_params" => { "items" => { "$ref" => "#/components/OptParam" }, "type" => "array" },
+        "uuid" => { "$ref" => "#/UUID" },
+      },
+      "required" => %w[description params opt_params],
+    },
+  },
+  "required" => %w[id meta],
+  "title" => "Example",
+}
+```
+
+## 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/Narazaka/json-schema-subset-dsl.

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "yard"
+require "yard/rake/yardoc_task"
+
+RSpec::Core::RakeTask.new(:spec)
+YARD::Rake::YardocTask.new
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "json/schema/subset/dsl"
+
+# 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/fmt

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle exec rubocop -a
+bundle exec rbprettier --write "**/*.rb" "**/*.rake" "**/*.gemspec"
+
+# Do any other automated setup that you need to do here

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-subset-dsl.gemspec

@@ -0,0 +1,41 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "json/schema/subset/dsl/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "json-schema-subset-dsl"
+  spec.version = Json::Schema::Subset::DSL::VERSION
+  spec.authors = %w[Narazaka]
+  spec.email = %w[info@narazaka.net]
+  spec.licenses = %w[Zlib]
+
+  spec.summary = "Yet another JSON Schema subset DSL"
+  spec.description = "Useful when writing a simple JSON schema."
+  spec.homepage = "https://github.com/#{spec.authors.first}/#{spec.name}"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "#{spec.homepage}.git"
+  spec.metadata["changelog_uri"] = "#{spec.homepage}/blob/master/CHANGELOG.md"
+  spec.metadata["documentation_uri"] = "https://www.rubydoc.info/gems/#{spec.name}/#{spec.version}"
+
+  # 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 = %w[lib]
+
+  spec.add_development_dependency "bundler", "~> 2"
+  spec.add_development_dependency "rake", "~> 10.5"
+  spec.add_development_dependency "rspec", "~> 3.9"
+  spec.add_development_dependency "rspec-power_assert", "~> 1.1"
+  spec.add_development_dependency "rubocop", "~> 0.76"
+  spec.add_development_dependency "rubocop-airbnb", "~> 3"
+  spec.add_development_dependency "prettier", ">= 0.16"
+  spec.add_development_dependency "rubocop-config-prettier", "~> 0.1"
+  spec.add_development_dependency "pry-byebug", "~> 3.7"
+  spec.add_development_dependency "yard", "~> 0.9"
+end

data/lib/json/schema/subset/dsl.rb

@@ -0,0 +1,120 @@
+require "json/schema/subset/dsl/version"
+
+module Json
+  module Schema
+    module Subset
+      class DSL
+        def initialize(type: "object", schema: {}, params: {}, ref: nil, &block)
+          @type = type
+          @schema = schema
+          @params = params
+          @ref = ref
+          @optionals = []
+          set!(&block) if block_given?
+        end
+
+        def set!(&block)
+          instance_eval(&block)
+        end
+
+        def compile!
+          return { "$ref" => @ref } if @ref
+
+          case
+          when Array(@type).include?("array")
+            ret = @schema.dup
+            ret["type"] = @type
+            ret["items"] = ret["items"].compile!
+            ret.merge(@params)
+          when Array(@type).include?("object")
+            required = @schema.keys - @optionals
+            ret = { "type" => @type, "properties" => @schema.map { |k, v| [k, v.compile!] }.to_h }
+            ret["required"] = required unless required.empty?
+            ret.merge(@params)
+          else
+            @schema.merge("type" => @type).map { |k, v| [k.to_s, v] }.to_h.merge(@params)
+          end
+        end
+
+        # toplevel
+
+        %w[string integer number boolean null].each do |type|
+          define_method(:"#{type}!") do |args = {}|
+            change_type!(type)
+            @schema.merge!(args)
+          end
+        end
+
+        def ref!(name)
+          @ref = name.to_s
+        end
+
+        def cref!(name)
+          ref! components!(name)
+        end
+
+        def dref!(name)
+          ref! definitions!(name)
+        end
+
+        def components!(name)
+          "#/components/#{name}"
+        end
+
+        def definitions!(name)
+          "#/definitions/#{name}"
+        end
+
+        def array!(&block)
+          change_type!("array")
+          @schema["items"] = DSL.new(&block)
+        end
+
+        def respond_to_missing?(name, include_private)
+          true
+        end
+
+        def method_missing(name, *args, &block)
+          if name.to_s.end_with?("!")
+            @params[name[0...-1]] = args[0]
+            return
+          end
+
+          type = args.first
+          opts = args.count > 1 && args.last.is_a?(Hash) ? args.last || {} : {}
+
+          optional = opts.delete(:optional)
+          @optionals << name.to_s if optional
+          type = type.is_a?(Array) ? type.map(&:to_s) : type.to_s
+          case
+          when type == "ref"
+            @schema[name.to_s] = DSL.new(ref: args[1])
+          when type == "cref"
+            @schema[name.to_s] = DSL.new(ref: components!(args[1]))
+          when type == "dref"
+            @schema[name.to_s] = DSL.new(ref: definitions!(args[1]))
+          when Array(type).include?("array")
+            @schema[name.to_s] = DSL.new(type: type, params: opts, schema: { "items" => DSL.new(&block) })
+          when Array(type).include?("object")
+            @schema[name.to_s] = DSL.new(type: type, params: opts, &block)
+          else
+            @schema[name.to_s] = DSL.new(type: type, schema: opts)
+          end
+        end
+
+        def change_type!(type)
+          case @type
+          when "object"
+            if type == "null"
+              @type = %w[object null]
+            else
+              @type = type
+            end
+          else
+            @type = Array(@type) + [type]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/json/schema/subset/dsl/version.rb

@@ -0,0 +1,9 @@
+module Json
+  module Schema
+    module Subset
+      class DSL
+        VERSION = "1.0.0".freeze
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,204 @@
+--- !ruby/object:Gem::Specification
+name: json-schema-subset-dsl
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Narazaka
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-11-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.5'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rspec-power_assert
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.76'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.76'
+- !ruby/object:Gem::Dependency
+  name: rubocop-airbnb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: prettier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.16'
+- !ruby/object:Gem::Dependency
+  name: rubocop-config-prettier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: Useful when writing a simple JSON schema.
+email:
+- info@narazaka.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".prettierrc"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_airbnb.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/fmt
+- bin/setup
+- json-schema-subset-dsl.gemspec
+- lib/json/schema/subset/dsl.rb
+- lib/json/schema/subset/dsl/version.rb
+homepage: https://github.com/Narazaka/json-schema-subset-dsl
+licenses:
+- Zlib
+metadata:
+  homepage_uri: https://github.com/Narazaka/json-schema-subset-dsl
+  source_code_uri: https://github.com/Narazaka/json-schema-subset-dsl.git
+  changelog_uri: https://github.com/Narazaka/json-schema-subset-dsl/blob/master/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/json-schema-subset-dsl/1.0.0
+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: Yet another JSON Schema subset DSL
+test_files: []