json-schema_dsl 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a4440ff6f54f529a109585c1730238dc271eea973943de58eec898d3584436ab
+  data.tar.gz: ef8d143006c60e320b8fd31b07128362be8bdc9c1c481f611519f02d386b1f17
+SHA512:
+  metadata.gz: 4d260d9c2eb4ac92256a1c8d3408fc2d197d8f21cf224c1fc517605d2cc19fd611d92d5e2822d20c596d1ef428e6e3276de8f8527b7e5ccb3035a331caa5efff
+  data.tar.gz: fa581ea3eefe8ec1633fc465360168f7350c879409824d45748ca6d5ad7a7a818198f13394b768892e1c83de231a5f29478b25e7d4e6fbb53bc9598471c3c1b9

data/.gitignore

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

data/.gitlab-ci.yml

@@ -0,0 +1,30 @@
+# This file is a template, and might need editing before it works on your project.
+# Official language image. Look for the different tagged releases at:
+# https://hub.docker.com/r/library/ruby/tags/
+image: "ruby:2.6"
+
+include:
+  - template: Code-Quality.gitlab-ci.yml
+
+# Cache gems in between builds
+cache:
+  paths:
+    - vendor/ruby
+
+# This is a basic example for a gem or script which doesn't use
+# services such as redis or postgres
+before_script:
+  - ruby -v  # Print out ruby version for debugging
+  # Uncomment next line if your rails app needs a JS runtime:
+  # - apt-get update -q && apt-get install nodejs -yqq
+  - gem install bundler -v '2.0.2'
+  - bundle install -j $(nproc) --path vendor  # Install dependencies into ./vendor/ruby
+
+# Optional - Delete if not using `rubocop`
+rubocop:
+  script:
+    - bundle exec rubocop
+
+rspec:
+  script:
+    - bundle exec rspec spec

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,19 @@
+inherit_from: .rubocop_todo.yml
+require: rubocop-rspec
+
+Metrics/BlockLength:
+  ExcludedMethods: ['describe', 'context', 'let']
+
+RSpec/NestedGroups:
+  Max: 8
+
+RSpec/ContextWording:
+  Prefixes:
+    - when
+    - with
+    - without
+    - and
+    - while
+
+RSpec/DescribeClass:
+  Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,13 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2019-04-26 19:48:42 +0200 using RuboCop version 0.65.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 4
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 96

data/.solargraph.yml

@@ -0,0 +1,15 @@
+---
+include:
+- "**/*.rb"
+exclude:
+- spec/**/*
+- test/**/*
+- vendor/**/*
+- ".bundle/**/*"
+require: []
+domains: []
+reporters:
+- rubocop
+- require_not_found
+require_paths: []
+max_files: 5000

data/.travis.yml

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

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 paul.martensen@gmx.de. 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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,114 @@
+PATH
+  remote: .
+  specs:
+    json-schema_dsl (1.0.0)
+      activesupport (< 6.0)
+      docile (< 2)
+      dry-struct (~> 1.0)
+      dry-types (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    ast (2.4.0)
+    byebug (11.0.1)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.3)
+    docile (1.3.2)
+    dry-configurable (0.8.3)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.4, >= 0.4.7)
+    dry-container (0.7.2)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.1, >= 0.1.3)
+    dry-core (0.4.9)
+      concurrent-ruby (~> 1.0)
+    dry-equalizer (0.2.2)
+    dry-inflector (0.2.0)
+    dry-logic (1.0.3)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.2)
+      dry-equalizer (~> 0.2)
+    dry-struct (1.0.0)
+      dry-core (~> 0.4, >= 0.4.3)
+      dry-equalizer (~> 0.2)
+      dry-types (~> 1.0)
+      ice_nine (~> 0.11)
+    dry-types (1.2.0)
+      concurrent-ruby (~> 1.0)
+      dry-container (~> 0.3)
+      dry-core (~> 0.4, >= 0.4.4)
+      dry-equalizer (~> 0.2, >= 0.2.2)
+      dry-inflector (~> 0.1, >= 0.1.2)
+      dry-logic (~> 1.0, >= 1.0.2)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    ice_nine (0.11.2)
+    jaro_winkler (1.5.3)
+    method_source (0.9.2)
+    minitest (5.11.3)
+    parallel (1.18.0)
+    parser (2.6.5.0)
+      ast (~> 2.4.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.7.0)
+      byebug (~> 11.0)
+      pry (~> 0.10)
+    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.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    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)
+    rubocop-rspec (1.36.0)
+      rubocop (>= 0.68.1)
+    ruby-progressbar (1.10.1)
+    spring (2.0.2)
+      activesupport (>= 4.2)
+    stackprof (0.2.13)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  json-schema_dsl!
+  pry
+  pry-byebug
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  rubocop (= 0.74.0)
+  rubocop-rspec (= 1.36.0)
+  spring
+  stackprof
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Paul Martensen
+
+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,215 @@
+# Json::SchemaDsl
+
+`JSON::SchemaDsl` is a gem that gives you the ability to simply and comfortably
+define json-schemas in ruby. It will type-check and coerce the attributes of
+your definitions and gives you an easy to extend and performant way to generate
+schemas.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'json-schema_dsl'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install json-schema_dsl
+
+## Usage
+
+To use the gem include the main module into a class of yours:
+
+```rb
+class Builder
+  include JSON::SchemaDsl
+end
+```
+
+Now that class has the ability to define new schemas for you.
+
+```rb
+Builder.new.object do
+  object :meta do
+    string :response_code
+    integer :returned_count
+  end
+
+  array :data do
+    items do
+      object do
+        string :name, required: true
+        integer :id, minimum: 0
+      end
+    end
+  end
+end.as_json
+```
+
+Will generate
+
+```js
+{
+  type: object,
+  properties: {
+    meta: {
+      type: object,
+      properties: {
+        response_code: {
+          type: string
+        },
+        returned_count: {
+          type: integer
+        }
+      }
+    },
+    data: {
+      type: array,
+      items: {
+        type: object,
+        required: [
+          name
+        ],
+        properties: {
+          name: {
+            type: string
+          },
+          id: {
+            type: integer,
+            minimum: 0
+          }
+        }
+      }
+    }
+  }
+}
+```
+
+### Helper methods
+
+You can define helper methods on your builder to dry up your definitions.
+```rb
+class Builder
+  include JSON::SchemaDsl
+
+  def book
+    object do
+      string :author
+      string :title
+    end
+  end
+end
+
+Builder.new.array do
+  items { book }
+end
+```
+Note that to attach the object to the definition that calls the helper method,
+it has to return a `JSON::Schema::Entity`. If the return value is used to
+construct another entity, this is not necessary.
+```js
+{
+  type: array,
+  items: {
+    type: object,
+    properties: {
+      author: {
+        type: string
+      },
+      title: {
+        type: string
+      }
+    }
+  }
+}
+```
+
+### Defaults
+
+In an initializer, you can change default values for certain types of entities:
+```rb
+# Adding new defaults for object
+JSON::SchemaDsl.add_defaults_for(:object, {additional_properties: false})
+
+Builder.new.object
+```
+This will give the object the property `additionalProperties` with the value
+`false`.
+```js
+{
+  type: object,
+  additionalProperties: false
+}
+```
+
+## Extending the gem
+
+You an add additional types and renderers to the gem by registering them:
+```rb
+# For now, types have to subclass Entity
+# For this example we can define an email type
+class Email < JSON::SchemaDsl::String
+  def self.type_method_name
+    'email'
+  end
+
+  def self.infer_type
+    'string'
+  end
+
+  attribute(:format, JSON::SchemaDsl::Types::String.default('e-mail'))
+end
+JSON::SchemaDsl.register_type(Email)
+```
+Now you can use email in all your builders using the method name:
+```rb
+Builder.new.object do
+  email :address
+end
+```
+Will generate
+```js
+{
+  type: object,
+  properties: {
+    address: {
+      type: string,
+      format: e-mail
+    }
+  }
+}
+```
+
+To just build schemas on the fly without setting up a new class, use
+`JSON::SchemaDsl.proxy` which will return a new proxy-builder that enables
+access to the DSL.
+
+```ruby
+JSON::SchemaDsl.proxy.object do
+  string :author
+  string :title
+end
+```
+
+## 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]/json-schema_dsl. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## 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 Json::SchemaDsl project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/json-schema_dsl/blob/master/CODE_OF_CONDUCT.md).