schemify 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 724bc405129806d3b2b2a7352411872fc854b5f0ad3d40de776a72fafdaa4d47
+  data.tar.gz: be7110cd810966dd210e3dd837ba46548a59b37d4889d310176eab829fc786c9
+SHA512:
+  metadata.gz: df0112b2810b83f3ec3c011db058dea4f7cc8957a979e2c59e3b5a8f66d97f0f66bd8eefe80b576e42a0f7dfb26d586ea2f0da3023d7dae0469c8944a59b9fa4
+  data.tar.gz: 9e89af9042ec0aab4fa67cca985833adf5cf243e1e5745acbc0d49e3838e961fe2bff302bcd2bb38371a3c9bc2c3ea2b6330e8a01b6e62cdec1f0d57236c4fea

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,14 @@
+plugins:
+  - rubocop-performance
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 3.1
+  NewCops: enable
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-06-16
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders 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, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Rylan Polster
+
+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,85 @@
+# Schemify
+
+Use Ruby code to generate JSON schemas with intelligent defaults, validation, and versioning.
+
+> [!WARNING]
+> This gem is in the _very_ early stages of development, and is not yet ready for general use.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+```
+
+## Usage
+
+More elegant usage will be added in the future. For now, a schema can be created using:
+
+```ruby
+schema = Schemify::Schema.new do
+  schema "https://json-schema.org/draft/2020-12/schema"
+  id "https://example.com/product.schema.json"
+
+  title "Product"
+  description "A product from Acme's catalog"
+
+  type "object"
+  properties({
+               "productId" => {
+                 "description" => "The unique identifier for a product",
+                 "type" => "integer"
+               },
+               "productName" => {
+                 "description" => "Name of the product",
+                 "type" => "string"
+               },
+               "price" => {
+                 "description" => "The price of the product",
+                 "type" => "number",
+                 "exclusiveMinimum" => 0
+               },
+               "tags" => {
+                 "description" => "Tags for the product",
+                 "type" => "array",
+                 "items" => {
+                   "type" => "string"
+                 },
+                 "minItems" => 1,
+                 "uniqueItems" => true
+               }
+             })
+  required %w[productId productName price]
+end
+
+# Ruby hash representation of the schema
+schema.to_h
+
+# JSON representation of the schema
+JSON.generate(schema.to_h)
+```
+
+## 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 the created tag, 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/Rylan12/schemify. 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/Rylan12/schemify/blob/main/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 Schemify project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/Rylan12/schemify/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/schemify/keyword.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require_relative "naming"
+
+module Schemify
+  # Represents a keyword in a schema, which can be used to define metadata or properties
+  class Keyword
+    def initialize(value)
+      @value = value
+    end
+
+    def to_h
+      { self.class.json_name => @value }
+    end
+
+    class << self
+      def json_name(value = nil, dollar_prefix: false)
+        return @json_name if value.nil?
+
+        @json_name = if dollar_prefix
+                       "$#{Naming.json_name(value)}"
+                     else
+                       Naming.json_name(value)
+                     end
+      end
+    end
+
+    # Dynamically create Keyword subclasses and methods
+    module Builder
+      def setup_vocabulary(keyword_names, dollar_prefix: false)
+        setup_keyword_classes keyword_names, dollar_prefix: dollar_prefix
+        setup_keyword_methods_module keyword_names
+      end
+
+      private
+
+      def setup_keyword_classes(names, dollar_prefix: false)
+        names.each do |name|
+          klass = Class.new(Keyword) do
+            json_name name, dollar_prefix: dollar_prefix
+          end
+          const_name = Naming.class_name(name)
+          const_set(const_name, klass)
+        end
+      end
+
+      def setup_keyword_methods_module(names)
+        namespace = self
+        mod = create_module(names, namespace)
+        const_set(:KeywordMethods, mod)
+      end
+
+      def create_module(names, namespace)
+        Module.new do
+          names.each do |name|
+            klass = namespace.const_get(Naming.class_name(name))
+            define_method(name) do |value|
+              @keywords[name] = klass.new(value)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/schemify/naming.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Schemify
+  # Methods for converting between different naming conventions
+  module Naming
+    module_function
+
+    def json_name(name)
+      parts = name.to_s.split("_")
+      parts[0].downcase + parts[1..].map(&:capitalize).join
+    end
+
+    def class_name(name)
+      name.to_s.split("_").map(&:capitalize).join
+    end
+  end
+end

data/lib/schemify/schema.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative "vocabularies"
+
+module Schemify
+  # A JSON Schema representation
+  class Schema
+    include Vocabularies::Core::KeywordMethods
+    include Vocabularies::Applicator::KeywordMethods
+    include Vocabularies::Unevaluated::KeywordMethods
+    include Vocabularies::Validation::KeywordMethods
+    include Vocabularies::MetaData::KeywordMethods
+    include Vocabularies::FormatAnnotation::KeywordMethods
+    include Vocabularies::Content::KeywordMethods
+
+    def initialize(&)
+      @keywords = {}
+      instance_eval(&) if block_given?
+    end
+
+    def to_h
+      schema = {}
+      @keywords.each_value do |keyword|
+        schema.merge!(keyword.to_h)
+      end
+      schema
+    end
+  end
+end

data/lib/schemify/version.rb

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

data/lib/schemify/vocabularies.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+require_relative "keyword"
+
+module Schemify
+  module Vocabularies
+    # The core vocabulary defined by the JSON Schema specification
+    module Core
+      extend Keyword::Builder
+
+      # See https://json-schema.org/draft/2020-12/meta/core
+      KEYWORDS = %i[id schema ref anchor dynamic_ref dynamic_anchor vocabulary comment defs].freeze
+
+      setup_vocabulary KEYWORDS, dollar_prefix: true
+    end
+
+    # The applicator vocabulary defined by the JSON Schema specification
+    module Applicator
+      extend Keyword::Builder
+
+      # See https://json-schema.org/draft/2020-12/meta/applicator
+      KEYWORDS = %i[prefix_items items contains additional_properties properties pattern_properties dependent_schemas
+                    property_names if then else all_of any_of one_of not].freeze
+
+      setup_vocabulary KEYWORDS
+    end
+
+    # The unevaluated vocabulary defined by the JSON Schema specification
+    module Unevaluated
+      extend Keyword::Builder
+
+      # See https://json-schema.org/draft/2020-12/meta/unevaluated
+      KEYWORDS = %i[unevaluated_items unevaluated_properties].freeze
+
+      setup_vocabulary KEYWORDS
+    end
+
+    # The validation vocabulary defined by the JSON Schema specification
+    module Validation
+      extend Keyword::Builder
+
+      # See https://json-schema.org/draft/2020-12/meta/validation
+      KEYWORDS = %i[type const enum multiple_of maximum exclusive_maximum minimum exclusive_minimum
+                    max_length min_length pattern max_items min_items unique_items max_contains
+                    min_contains max_properties min_properties required dependent_required].freeze
+
+      setup_vocabulary KEYWORDS
+    end
+
+    # The meta-data vocabulary defined by the JSON Schema specification
+    module MetaData
+      extend Keyword::Builder
+
+      # See https://json-schema.org/draft/2020-12/meta/meta-data
+      KEYWORDS = %i[title description default deprecated read_only write_only examples].freeze
+
+      setup_vocabulary KEYWORDS
+    end
+
+    # The unevaluated vocabulary defined by the JSON Schema specification
+    module FormatAnnotation
+      extend Keyword::Builder
+
+      # See https://json-schema.org/draft/2020-12/meta/format-annotation
+      KEYWORDS = %i[format].freeze
+
+      setup_vocabulary KEYWORDS
+    end
+
+    # The unevaluated vocabulary defined by the JSON Schema specification
+    module Content
+      extend Keyword::Builder
+
+      # See https://json-schema.org/draft/2020-12/meta/content
+      KEYWORDS = %i[content_encoding content_media_type content_schema].freeze
+
+      setup_vocabulary KEYWORDS
+    end
+  end
+end

data/lib/schemify.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative "schemify/version"
+require_relative "schemify/schema"
+
+module Schemify
+  class Error < StandardError; end
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: schemify
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rylan Polster
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: Use Ruby code to generate JSON schemas with intelligent defaults, validation,
+  and versioning.
+email:
+- rslpolster@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/schemify.rb
+- lib/schemify/keyword.rb
+- lib/schemify/naming.rb
+- lib/schemify/schema.rb
+- lib/schemify/version.rb
+- lib/schemify/vocabularies.rb
+homepage: https://github.com/Rylan12/schemify
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Rylan12/schemify
+  source_code_uri: https://github.com/Rylan12/schemify
+  changelog_uri: https://github.com/Rylan12/schemify/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: Generate JSON schemas with code
+test_files: []