simple_json_schema_builder 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA256:
3
+ metadata.gz: e007353b4f32e8f76ef3cc0914939fcffeaef49499cd5c96dcd6b443a80b435c
4
+ data.tar.gz: 5385a0965b5d1e18eb888b18fb3c50b6587fd618bdb472cdc62b5c30e2a64565
5
+ SHA512:
6
+ metadata.gz: '08baab95d4660c0edeb074da049d54a659745e1cdd778c161394e8e80b404ead2cd3ec99c0c6d9373365d350d276aca3667e462a7aa45d63016e473f9f94d88f'
7
+ data.tar.gz: 99b14030c752ef914c7c732b2682f75bdac0631513bc1e1ebc76406aa09eef002f86d1abc417b3e5b89e7a2bed2e50f79420d2f65e8e276af40d6ac424d4307d
data/.rspec ADDED
@@ -0,0 +1,3 @@
1
+ --format documentation
2
+ --color
3
+ --require spec_helper
data/.rubocop.yml ADDED
@@ -0,0 +1,34 @@
1
+ AllCops:
2
+ TargetRubyVersion: 3.0
3
+ SuggestExtensions: false
4
+ NewCops: enable
5
+
6
+ Style/StringLiterals:
7
+ EnforcedStyle: double_quotes
8
+
9
+ Style/StringLiteralsInInterpolation:
10
+ EnforcedStyle: double_quotes
11
+
12
+ Style/TrailingCommaInHashLiteral:
13
+ EnforcedStyleForMultiline: comma
14
+
15
+ Style/TrailingCommaInArrayLiteral:
16
+ EnforcedStyleForMultiline: comma
17
+
18
+ Style/TrailingCommaInArguments:
19
+ EnforcedStyleForMultiline: comma
20
+
21
+ Metrics/BlockLength:
22
+ Enabled: false
23
+
24
+ Metrics/ParameterLists:
25
+ Enabled: false
26
+
27
+ Metrics/MethodLength:
28
+ Enabled: false
29
+
30
+ Style/Documentation:
31
+ Enabled: false
32
+
33
+ Metrics/AbcSize:
34
+ Enabled: false
data/CHANGELOG.md ADDED
@@ -0,0 +1,5 @@
1
+ ## [Unreleased]
2
+
3
+ ## [0.1.0] - 2024-09-20
4
+
5
+ - Initial release
@@ -0,0 +1,132 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ We as members, contributors, and leaders pledge to make participation in our
6
+ community a harassment-free experience for everyone, regardless of age, body
7
+ size, visible or invisible disability, ethnicity, sex characteristics, gender
8
+ identity and expression, level of experience, education, socio-economic status,
9
+ nationality, personal appearance, race, caste, color, religion, or sexual
10
+ identity and orientation.
11
+
12
+ We pledge to act and interact in ways that contribute to an open, welcoming,
13
+ diverse, inclusive, and healthy community.
14
+
15
+ ## Our Standards
16
+
17
+ Examples of behavior that contributes to a positive environment for our
18
+ community include:
19
+
20
+ * Demonstrating empathy and kindness toward other people
21
+ * Being respectful of differing opinions, viewpoints, and experiences
22
+ * Giving and gracefully accepting constructive feedback
23
+ * Accepting responsibility and apologizing to those affected by our mistakes,
24
+ and learning from the experience
25
+ * Focusing on what is best not just for us as individuals, but for the overall
26
+ community
27
+
28
+ Examples of unacceptable behavior include:
29
+
30
+ * The use of sexualized language or imagery, and sexual attention or advances of
31
+ any kind
32
+ * Trolling, insulting or derogatory comments, and personal or political attacks
33
+ * Public or private harassment
34
+ * Publishing others' private information, such as a physical or email address,
35
+ without their explicit permission
36
+ * Other conduct which could reasonably be considered inappropriate in a
37
+ professional setting
38
+
39
+ ## Enforcement Responsibilities
40
+
41
+ Community leaders are responsible for clarifying and enforcing our standards of
42
+ acceptable behavior and will take appropriate and fair corrective action in
43
+ response to any behavior that they deem inappropriate, threatening, offensive,
44
+ or harmful.
45
+
46
+ Community leaders have the right and responsibility to remove, edit, or reject
47
+ comments, commits, code, wiki edits, issues, and other contributions that are
48
+ not aligned to this Code of Conduct, and will communicate reasons for moderation
49
+ decisions when appropriate.
50
+
51
+ ## Scope
52
+
53
+ This Code of Conduct applies within all community spaces, and also applies when
54
+ an individual is officially representing the community in public spaces.
55
+ Examples of representing our community include using an official email address,
56
+ posting via an official social media account, or acting as an appointed
57
+ representative at an online or offline event.
58
+
59
+ ## Enforcement
60
+
61
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
62
+ reported to the community leaders responsible for enforcement at
63
+ [INSERT CONTACT METHOD].
64
+ All complaints will be reviewed and investigated promptly and fairly.
65
+
66
+ All community leaders are obligated to respect the privacy and security of the
67
+ reporter of any incident.
68
+
69
+ ## Enforcement Guidelines
70
+
71
+ Community leaders will follow these Community Impact Guidelines in determining
72
+ the consequences for any action they deem in violation of this Code of Conduct:
73
+
74
+ ### 1. Correction
75
+
76
+ **Community Impact**: Use of inappropriate language or other behavior deemed
77
+ unprofessional or unwelcome in the community.
78
+
79
+ **Consequence**: A private, written warning from community leaders, providing
80
+ clarity around the nature of the violation and an explanation of why the
81
+ behavior was inappropriate. A public apology may be requested.
82
+
83
+ ### 2. Warning
84
+
85
+ **Community Impact**: A violation through a single incident or series of
86
+ actions.
87
+
88
+ **Consequence**: A warning with consequences for continued behavior. No
89
+ interaction with the people involved, including unsolicited interaction with
90
+ those enforcing the Code of Conduct, for a specified period of time. This
91
+ includes avoiding interactions in community spaces as well as external channels
92
+ like social media. Violating these terms may lead to a temporary or permanent
93
+ ban.
94
+
95
+ ### 3. Temporary Ban
96
+
97
+ **Community Impact**: A serious violation of community standards, including
98
+ sustained inappropriate behavior.
99
+
100
+ **Consequence**: A temporary ban from any sort of interaction or public
101
+ communication with the community for a specified period of time. No public or
102
+ private interaction with the people involved, including unsolicited interaction
103
+ with those enforcing the Code of Conduct, is allowed during this period.
104
+ Violating these terms may lead to a permanent ban.
105
+
106
+ ### 4. Permanent Ban
107
+
108
+ **Community Impact**: Demonstrating a pattern of violation of community
109
+ standards, including sustained inappropriate behavior, harassment of an
110
+ individual, or aggression toward or disparagement of classes of individuals.
111
+
112
+ **Consequence**: A permanent ban from any sort of public interaction within the
113
+ community.
114
+
115
+ ## Attribution
116
+
117
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118
+ version 2.1, available at
119
+ [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
120
+
121
+ Community Impact Guidelines were inspired by
122
+ [Mozilla's code of conduct enforcement ladder][Mozilla CoC].
123
+
124
+ For answers to common questions about this code of conduct, see the FAQ at
125
+ [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
126
+ [https://www.contributor-covenant.org/translations][translations].
127
+
128
+ [homepage]: https://www.contributor-covenant.org
129
+ [v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
130
+ [Mozilla CoC]: https://github.com/mozilla/diversity
131
+ [FAQ]: https://www.contributor-covenant.org/faq
132
+ [translations]: https://www.contributor-covenant.org/translations
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2024 Mooktakim Ahmed
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md ADDED
@@ -0,0 +1,169 @@
1
+ # SimpleJsonSchemaBuilder
2
+
3
+ A simple DSL to help you write JSON Schema in ruby.
4
+
5
+ ## Installation
6
+
7
+ Add this line to your application's Gemfile:
8
+
9
+ ```ruby
10
+ gem 'simple_json_schema_builder'
11
+ ```
12
+
13
+ And then execute:
14
+
15
+ ```bash
16
+ bundle
17
+ ```
18
+
19
+ Or install it yourself as:
20
+
21
+ ```bash
22
+ gem install simple_json_schema_builder
23
+ ```
24
+
25
+ `simple_json_schema_builder` depends on [multi_json](https://github.com/intridea/multi_json) to serialize to JSON, which allows you to pick your favourite JSON library, `oj` is recommended as its fast.
26
+
27
+ ## Usage
28
+
29
+ ```ruby
30
+ class MySchema < SimpleJsonSchemaBuilder::Base
31
+ object do
32
+ string :string_test, required: false, examples: "blue while"
33
+ boolean :boolean_test, examples: [ "blah", "bleh" ]
34
+ string :str_array_test, array: true
35
+ string :string_enums, enum: [ "test1", "test2" ]
36
+ string :string_enum_arrays, array: true, enum: [ "test1", "test2" ]
37
+
38
+ object :other_info, required: true do
39
+ string :string_test, required: true
40
+ boolean :boolean_test
41
+ end
42
+
43
+ object :other_info_arr, array: true do
44
+ string :string_test, required: true
45
+ boolean :boolean_test
46
+ end
47
+
48
+ object :subschema_arr, array: true, schema: Subschema
49
+ object :subschema, schema: Subschema
50
+ end
51
+ end
52
+
53
+ class Subschema < SimpleJsonSchemaBuilder::Base
54
+ object do
55
+ string :test1
56
+ integer :test2, required: true
57
+ end
58
+ end
59
+ ```
60
+
61
+ Will serialize to:
62
+
63
+ ```json
64
+ {
65
+ "type": "object",
66
+ "required": ["other_info"],
67
+ "properties": {
68
+ "string_test": {
69
+ "type": "string",
70
+ "examples": ["blue while"]
71
+ },
72
+ "boolean_test": {
73
+ "type": "boolean",
74
+ "examples": ["blah", "bleh"]
75
+ },
76
+ "str_array_test": {
77
+ "type": "array",
78
+ "items": {
79
+ "type": "string"
80
+ }
81
+ },
82
+ "string_enums": {
83
+ "type": "string",
84
+ "enum": ["test1", "test2"]
85
+ },
86
+ "string_enum_arrays": {
87
+ "type": "array",
88
+ "items": {
89
+ "type": "string",
90
+ "enum": ["test1", "test2"]
91
+ }
92
+ },
93
+ "other_info": {
94
+ "type": "object",
95
+ "required": ["string_test"],
96
+ "properties": {
97
+ "string_test": {
98
+ "type": "string"
99
+ },
100
+ "boolean_test": {
101
+ "type": "boolean"
102
+ }
103
+ }
104
+ },
105
+ "other_info_arr": {
106
+ "type": "array",
107
+ "items": {
108
+ "type": "object",
109
+ "required": ["string_test"],
110
+ "properties": {
111
+ "string_test": {
112
+ "type": "string"
113
+ },
114
+ "boolean_test": {
115
+ "type": "boolean"
116
+ }
117
+ }
118
+ }
119
+ },
120
+ "subschema_arr": {
121
+ "type": "array",
122
+ "items": {
123
+ "type": "object",
124
+ "required": ["test2"],
125
+ "properties": {
126
+ "test1": {
127
+ "type": "string"
128
+ },
129
+ "test2": {
130
+ "type": "integer"
131
+ }
132
+ }
133
+ }
134
+ },
135
+ "subschema": {
136
+ "type": "object",
137
+ "required": ["test2"],
138
+ "properties": {
139
+ "test1": {
140
+ "type": "string"
141
+ },
142
+ "test2": {
143
+ "type": "integer"
144
+ }
145
+ }
146
+ }
147
+ }
148
+ }
149
+ ```
150
+
151
+ TODO: needs sensible examples
152
+
153
+ ## Development
154
+
155
+ 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.
156
+
157
+ 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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
158
+
159
+ ## Contributing
160
+
161
+ Bug reports and pull requests are welcome on GitHub at <https://github.com/mooktakim/simple_json_schema_builder>. 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/mooktakim/simple_json_schema_builder/blob/main/CODE_OF_CONDUCT.md).
162
+
163
+ ## License
164
+
165
+ The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
166
+
167
+ ## Code of Conduct
168
+
169
+ Everyone interacting in the SimpleJsonSchemaBuilder project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/mooktakim/simple_json_schema_builder/blob/main/CODE_OF_CONDUCT.md).
data/Rakefile ADDED
@@ -0,0 +1,12 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "bundler/gem_tasks"
4
+ require "rspec/core/rake_task"
5
+
6
+ RSpec::Core::RakeTask.new(:spec)
7
+
8
+ require "rubocop/rake_task"
9
+
10
+ RuboCop::RakeTask.new
11
+
12
+ task default: %i[spec rubocop]
@@ -0,0 +1,106 @@
1
+ # frozen_string_literal: true
2
+
3
+ require "multi_json"
4
+
5
+ module SimpleJsonSchemaBuilder
6
+ class Base
7
+ def self.object(&block)
8
+ @schema ||= Base.new
9
+ @schema.instance_eval(&block)
10
+ end
11
+
12
+ def self.schema
13
+ @schema.schema
14
+ end
15
+
16
+ def self.to_json
17
+ MultiJson.dump(schema)
18
+ end
19
+
20
+ def initialize
21
+ @properties = {}
22
+ @required_key_names = []
23
+ end
24
+
25
+ def string(key_name, required: false, title: nil, description: nil, array: false, examples: [], enum: nil)
26
+ add_required(key_name, required)
27
+ add_property("string", key_name, title: title, description: description, examples: examples, enum: enum)
28
+ add_array(key_name, array)
29
+ end
30
+
31
+ def integer(key_name, required: false, title: nil, description: nil, array: false, examples: [], enum: nil)
32
+ add_required(key_name, required)
33
+ add_property("integer", key_name, title: title, description: description, examples: examples, enum: enum)
34
+ add_array(key_name, array)
35
+ end
36
+
37
+ def number(key_name, required: false, title: nil, description: nil, array: false, examples: [], enum: nil)
38
+ add_required(key_name, required)
39
+ add_property("number", key_name, title: title, description: description, examples: examples, enum: enum)
40
+ add_array(key_name, array)
41
+ end
42
+
43
+ def boolean(key_name, required: false, title: nil, description: nil, array: false, examples: [])
44
+ add_required(key_name, required)
45
+ add_property("boolean", key_name, title: title, description: description, examples: examples, enum: nil)
46
+ add_array(key_name, array)
47
+ end
48
+
49
+ def object(key_name = nil, required: false, array: false, schema: nil, &block)
50
+ add_required(key_name, required)
51
+
52
+ if schema
53
+ nested_object = schema
54
+ else
55
+ nested_object = Base.new
56
+ nested_object.instance_eval(&block)
57
+ end
58
+
59
+ if key_name
60
+ @properties[key_name] = nested_object.schema
61
+ add_array(key_name, array)
62
+ else
63
+ @properties = nested_object.schema
64
+ end
65
+ end
66
+
67
+ def schema
68
+ {
69
+ type: "object",
70
+ required: (required_key_names unless required_key_names.empty?),
71
+ properties: properties,
72
+ }.compact
73
+ end
74
+
75
+ private
76
+
77
+ attr_reader :properties, :required_key_names
78
+
79
+ def add_required(key_name, required)
80
+ return unless required
81
+
82
+ @required_key_names << key_name
83
+ end
84
+
85
+ def add_property(type, key_name, title:, description:, examples:, enum:)
86
+ enum = [enum].flatten.compact
87
+ examples = [examples].flatten.compact
88
+
89
+ @properties[key_name] = { type: type }
90
+ @properties[key_name][:description] = description if description
91
+ @properties[key_name][:title] = title if title
92
+ @properties[key_name][:examples] = examples unless examples.empty?
93
+ @properties[key_name][:enum] = enum unless enum.empty?
94
+ end
95
+
96
+ def add_array(key_name, array)
97
+ return unless array
98
+
99
+ array_obj = @properties[key_name]
100
+ @properties[key_name] = {
101
+ type: "array",
102
+ items: array_obj,
103
+ }
104
+ end
105
+ end
106
+ end
@@ -0,0 +1,5 @@
1
+ # frozen_string_literal: true
2
+
3
+ module SimpleJsonSchemaBuilder
4
+ VERSION = "0.1.0"
5
+ end
@@ -0,0 +1,8 @@
1
+ # frozen_string_literal: true
2
+
3
+ module SimpleJsonSchemaBuilder
4
+ autoload :Base, "simple_json_schema_builder/base"
5
+
6
+ class Error < StandardError; end
7
+ # Your code goes here...
8
+ end
@@ -0,0 +1,4 @@
1
+ module SimpleJsonSchemaBuilder
2
+ VERSION: String
3
+ # See the writing guide of rbs: https://github.com/ruby/rbs#guides
4
+ end
metadata ADDED
@@ -0,0 +1,71 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: simple_json_schema_builder
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - Mooktakim Ahmed
8
+ autorequire:
9
+ bindir: exe
10
+ cert_chain: []
11
+ date: 2024-09-20 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: multi_json
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - "~>"
18
+ - !ruby/object:Gem::Version
19
+ version: '1.0'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - "~>"
25
+ - !ruby/object:Gem::Version
26
+ version: '1.0'
27
+ description: Build JSON Schema with simple ruby code, with objects and clean DSL.
28
+ email:
29
+ - mooktakim@fluxter.co.uk
30
+ executables: []
31
+ extensions: []
32
+ extra_rdoc_files: []
33
+ files:
34
+ - ".rspec"
35
+ - ".rubocop.yml"
36
+ - CHANGELOG.md
37
+ - CODE_OF_CONDUCT.md
38
+ - LICENSE.txt
39
+ - README.md
40
+ - Rakefile
41
+ - lib/simple_json_schema_builder.rb
42
+ - lib/simple_json_schema_builder/base.rb
43
+ - lib/simple_json_schema_builder/version.rb
44
+ - sig/simple_json_schema_builder.rbs
45
+ homepage: https://github.com/mooktakim/simple_json_schema_builder
46
+ licenses:
47
+ - MIT
48
+ metadata:
49
+ homepage_uri: https://github.com/mooktakim/simple_json_schema_builder
50
+ source_code_uri: https://github.com/mooktakim/simple_json_schema_builder
51
+ rubygems_mfa_required: 'true'
52
+ post_install_message:
53
+ rdoc_options: []
54
+ require_paths:
55
+ - lib
56
+ required_ruby_version: !ruby/object:Gem::Requirement
57
+ requirements:
58
+ - - ">="
59
+ - !ruby/object:Gem::Version
60
+ version: 3.0.0
61
+ required_rubygems_version: !ruby/object:Gem::Requirement
62
+ requirements:
63
+ - - ">="
64
+ - !ruby/object:Gem::Version
65
+ version: '0'
66
+ requirements: []
67
+ rubygems_version: 3.5.18
68
+ signing_key:
69
+ specification_version: 4
70
+ summary: JSON Schema builder with simple DSL.
71
+ test_files: []